How do I install the Debrief plug-in?

Debrief is available as a Standard plug-in in Oracle Field Service. You can install it from the Forms & Plugins page.

You can add additional secure parameters to the plug-in, but you can't change the label, or available properties.

  1. Click Configuration > Forms & Plugins.
    The Forms & Plugins page appears and displays the existing forms and plug-ins.
  2. Click Add Plugin.
  3. Click Standard Plugin and then click Next.
  4. Click Debriefing.
    These sections are displayed:
    • Properties will be installed. These are the properties that are automatically installed with the plug-in. These properties will be available on the Configuration > Properties page. If you de-install this plug-in in the future, these properties will still remain on the Properties page.
    • Existing properties will be used. These are the properties that are required for the plug-in and are currently present in Oracle Field Service.

      Note: If a property has an incorrect configuration (for example, for property type or entity), then you'll see a corresponding message. Open the plug-in's documentation, find the property requirements, and change the property settings accordingly.
  5. Click Install and confirm the installation.
    A message similar to, 'Debriefing Successfully installed.' is displayed on the Forms and Plugins page after the installation You can install a Standard plug-in only once. The Install button is disabled when you install the plug-in. Be aware that plug-ins are supported only in the English language. Further, the Debrief plug-in doesn't work in offline mode.

    Oracle Field Service creates the required properties automatically or notifies you that some existing properties will be used by the plug-in, if they're already configured. If you've created the properties in the application with the corresponding names and labels, but with the improper configuration, you must change the property settings and install the plug-in again. Here are the properties for resource, activity, and inventory entities that the plug-in uses:

    Resource entity properties
    Name Label Type GUI Description
    ID pid Internal ID of the resource.
    Name pname Name of the resource.
    Activity entity properties
    Name Label Type GUI Description

    Invoice

    invoice

    File

    File

    PDF file of the generated invoice. For example, mime_types =”application/pdf”

    Company name

    ccompany

    String

    Text

    Customer’s company name, displayed as the title of the invoice.

    Activity ID

    aid

    Internal ID of the activity.

    Name

    cname

    Name of activity used in the PDF invoice.

    Address

    caddress

    Activity address used in the invoice.

    City

    ccity

    Activity city used in the invoice.

    State

    cstate

    Activity state used in the invoice.

    ZIP/Postal Code

    czip

    Postal code used in the invoice.

    Work Order

    appt_number

    Work order used in the invoice.

    Signature

    csign

    Customer signature, required prior to saving the invoice as PDF.

    Inventory entity properties
    Name Label Type GUI Description

    Expense

    expense_amount

    String

    Text

    Amount of expense.

    Expense Currency

    expense_currency_code

    Enumeration

    Combobox

    Value of each enumeration item is separated with the “|” character.

    Index Value
    USD $|US Dollars
    EUR €|Euro

    Part Disposition

    part_disposition_code

    Enumeration

    Combobox

    The value that identifies whether the inventory is consumable by the customer and there is no need to track it anymore, or whether the inventory is returnable. If the inventory is returnable, the Inventory Management system of Oracle SCM Cloud must track the part until it is returned by the customer.

    Part Unit of Measure

    part_uom_code

    Enumeration

    Combobox

    The unit of measurement (UOM) of parts (inventories).

    Part Item Description

    part_item_desc

    String

    Text

    The description of the part. For example, 'Magnetic hard drive'. It is used to search for inventory in the catalog.

    Part Item Number

    part_item_number

    String

    Text

    The number of the part that has been installed or taken from the customer. It is specified as a code. For example, FS908765.

    Part Item Revision

    part_item_revision

    String

    Text

    A single-letter code, for example, "A" or "B". Also, it is possible to have a single digit like "1" or "2". Usually, the inventory is identified by Part Item + Part Item Revision, but Item Revision is optional.

    Part Item Number + Revision

    part_item_number_rev

    String

    Text

    The Part Item number concatenated with the Part Item Revision. For example, FS908765A, where "FS908765" is a Part Item Number and "A" is a Part Item Revision. It is used to search for inventory in the catalog.

    Expense Activity

    expense_service_activity

    Enumeration

    Combobox

    Type of expense.

    Expense Item

    expense_item_ number

    Enumeration

    Combobox

    The subtype of expense.

    Expense Item Description

    expense_item_ desc

    Enumeration

    Combobox

    The description of expense subtypes. The indices must be the same as in the expense_item_numb er property.

    The values must describe the corresponding expense_item_numb er element.

    Labor End Time

    labor_end_time

    String

    Text

    The time when a mobile worker stops working on particular service activity. It must be not later than the end time of the work order (Oracle Field Service activity). Also, there must be no overlap between the items in the labor list. The format is T24:59:59.

    Labor Start Time

    labor_start_time

    String

    Text

    The time when a mobile worker starts working on a particular service activity. It must be not be earlier than the start time of the work order (Oracle Field Service activity). Also, there must be no overlap between the items in the labor list. The format is T24:59:59.

    Labor Activity

    labor_service_activity

    Enumeration

    Combobox

    The type of labor.

    Labor Item

    labor_item_number

    Enumeration

    Combobox

    The subtype of labor.

    Labor Item Description

    labor_item_desc

    Enumeration

    Combobox

    The description of labor subtype. The indices must be the same as in labor_item_number property. The values must describe the corresponding labor_item_number element.

    Inventory ID

    invid

    Internal ID of the inventory.

    Activity ID

    inv_aid

    Internal ID of the activity to which the inventory is assigned.

    Resource ID

    inv_pid

    Internal ID of the resource to which the inventory is assigned.

    Inventory Pool

    invpool

    The inventory pool (Resource, Customer, Installed, De- installed).

    Inventory Type

    invtype

    Type of inventory. See Add Inventory Types for the Plug-In.

    Quantity

    quantity

    The installed parts or the parts taken from the customer. It can be either counted or specified in inches, feet, and so on. The quantity is defined as an integer number.

    Serial Number

    invsn

    Field

    Text

    The serial number of the inventory.

  6. To add your company logo in the Time & Labour Report, add a new secure parameter with the name "logoUrl" with the value "url of the company logo".
    Logo only supports .jpeg images and the recommended size of the image is less than "150X60 ".