Details and Examples: Inventory Fields Data Set

The 'Inventory Fields' data set contains all fields and properties assigned to all inventory items, except inventory in resources' pools, available in the application by the end of extraction period.

Important: This information only applies to Oracle Field Service environments. You can verify whether you've Oracle Field Service or Oracle Fusion Field Service, by signing in and checking on the About page.

Inventory Fields are exported in the Daily Extract file for which 'Inventory Fields' is selected as the entity. Any inventory properties and fields available in Oracle Field Service (for example, 'Inventory ID', 'Model', 'Quantity'.) can be included in the Daily Extract by adding them to the file structure. Depending on the requirements of the company, the list of exported properties and fields can be changed at any time by removing or adding certain fields.

Data can be retrieved as one or more XML files consisting of 'inventories' root element that contains 'inventory' elements. 'inventory' elements are sets of 'Field' elements whose attributes are names of fields and custom properties defined for the inventory and whose contents are their corresponding values.

Example: Inventory Fields file

The following data is collected. Provide a meaningful name to the report.

  • Unique internal identifier of the inventory item, for example, Inventory ID

  • Pool to which the inventory item belongs, for example, Inventory Pool, with the following possible values

    • Customer: inventory was at the customer's site before the activity performance

    • Install: inventory was installed in the course of the activity

    • Deinstall: inventory was deinstalled in the course of the activity

  • Unique internal identifier of the activity, to which the inventory item is assigned, for example, Activity ID

  • Inventory type, for example, Inventory Type

  • Serial number, for example, Serial No

  • Quantity of non-serialized inventory, for example, Quantity

This table provides the label and description of those fields in the Inventory Fields data set that can be configured:

Field Label Description

Activity ID

inventory.inv_aid

Unique internal identifier of the activity, to which the inventory item is assigned.

Changed Inventory ID

inventory.inv_change_invid

Unique internal identifier of the inventory, to which the current inventory exchanged with.

Inventory ID

inventory.invid

Unique internal identifier of the inventory item.

Inventory Pool

inventory.invpool

Pool to which the inventory item belongs.

Inventory Properties

inventory.properties

List of all custom inventory properties with values

Inventory Type

inventory.invtype

Type of the inventory item; one of customer specific values.

Quantity

inventory.quantity

Quantity of non-serialized inventory

Resource ID

inventory.inv_pid

Unique internal identifier of the resource, to which the inventory item is assigned.

Serial Number

inventory.invsn

Serial number of the inventory item.

Note: No changes for this data set.

Custom properties

Inventory custom properties (except file properties) can be configured and extracted for the Inventory Fields data set. File properties are extracted according to configuration defined in the Property File Fields data set.

This table provides the custom properties of those types that can be configured:

Type Configurable

Type

Configurable

String

Yes

Integer

Yes

Enumeration

Yes

File

No

The example also includes a custom property, Manufacturer Name, which corresponds to the inventory manufacturer’s name.

The example file collects data for two inventory items: customer inventory 456890 of inventory type Cable Video, serial number PTI1234789 assigned to activity 100067 manufactured by Sample Manufacturer Ltd. and install inventory 908764, of inventory type Ethernet Cable, quantity 300 ft, used in the same activity.

<?xml version="1.0" encoding="UTF-8"?>
<inventories>
   <inventory>
      <Field name=”Inventory ID”>456890</Field>
      <Field name=”Inventory Pool”>customer</Field>
      <Field name=”Activity ID”>100067</Field>
      <Field name=”Inventory Type”>Cable Video</Field>
      <Field name=”Serial No”>PTI1234789</Field>
      <Field name=”Quantity”>1</Field>
      <Field name=”Manufacturer Name”>Sample Manufacturer ltd.</Field>
   </inventory>
   <inventory>
      <Field name=”Inventory ID”>908764</Field>
      <Field name=”Inventory Pool”>install</Field>
      <Field name=”Activity ID”>100067</Field>
      <Field name=”Inventory Type”>Ethernet Cable</Field>
      <Field name=”Serial No”/>
      <Field name=”Quantity”>300</Field>
      <Field name=”Manufacturer Name”/>
   </inventory>
</inventories>