Details and Examples: Property Fields Data Set
The 'Property Fields' data set contains details of all fields and custom properties available in the application by the end of extraction period.
Property Fields are exported in the Daily Extract file for which 'Property Fields' is selected as the entity. Any property fields available in Oracle Field Service (for example, 'Property ID', 'Property Name', 'Property Label'.) 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 'properties' root element that contains 'property' elements. 'property' elements are sets of 'Field' elements whose attributes are names of fields and custom properties defined for the property and whose contents are their corresponding values.
This table provides the label and description for those fields that can be configured:
Field | Label | Description |
---|---|---|
Entity Type to Which Property Refers |
property_desc.pdentity |
Integer value that corresponds to the type of entity to which the property belongs to. |
ID |
property_desc.propertyid |
Unique internal identifier of the property in the system |
Property ID |
property_name.pn_propertyid |
Unique internal identifier that corresponds to the property identifier |
Property Label |
property_desc.pdlabel |
Unique external identifier of the property |
Property Language |
property_name.pn_lid |
Integer that corresponds to the language defined for the property name. |
Property Name |
property_name.pntext |
Name of the property |
Text Entry Identifier |
property_name.pnindex |
Internal property name identifier (0-property name, -1 = property hint, other integer of string value - identifier of enumeration value) |
Custom activity, inventory, resource, user and service request properties (except file properties) can be configured and extracted for the Property 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 Property Fields that can be configured:
Type | Configurable |
---|---|
String |
Yes |
Integer |
Yes |
Enumeration |
Yes |
File |
No |
Example: Property Fields file
The following data is collected. Provide a meaningful name to the report.
Unique internal identifier of the property, for example, Property ID
name of the property, for example, Property Name
Unique external identifier of the field/property, for example, Property label
Integer that corresponds to the type of entity to which the property belongs, for example, Property Type, with the following possible values
1: Activity
2: Inventory
3: Resource
5: Service request
9: User
10: Required inventory
Details for Properties 154897, 248961, 356894, 568743, 657456 are exported. 154897 is 'Activity ID' labeled as 'a_id' and related to an activity. 248961 is 'Credence' labeled as 'credence' and related to a resource. 356894 is 'Inventory Pool' labeled as 'i_pool' and related to inventory and 568743 is 'Request Date' labeled 'sreq_date' and related to a service request. 657456 is 'Logged-in Last', labeled as 'last_login_date' and related to a user.
<?xml version="1.0" encoding="UTF-8"?>
<properties>
<property>
<Field name=”Property ID”>154897</Field>
<Field name=”Property Name”>Activity ID</Field>
<Field name=”Property Label”>a_id</Field>
<Field name=”Property Type”>1</Field>
</property>
<property>
<Field name=”Property ID”>248961</Field>
<Field name=”Property Name”>Credence/Field>
<Field name=”Property Label”>credence</Field>
<Field name=”Property Type”>3</Field>
</property>
<property>
<Field name=”Property ID”>356894</Field>
<Field name=”Property Name”>Inventory Pool</Field>
<Field name=”Property Label”>i_pool</Field>
<Field name=”Property Type”>2</Field>
</property>
<property>
<Field name=”Property ID”>568743</Field>
<Field name=”Property Name”>Request Date</Field>
<Field name=”Property Label”>sreq_date</Field>
<Field name=”Property Type”>5</Field>
</property>
<property>
<Field name=”Property ID”>657456</Field>
<Field name=”Property Name”>Logged-in Last</Field>
<Field name=”Property Label”>last_login_date</Field>
<Field name=”Property Type”>9</Field>
</property>
</properties>