What is the appropriate date format for appending to the daily extract to ensure consistency with the activity delivery window extract?
The 'Activity Fields' data set contains values of the fields and custom properties assigned to activities processed in the application during the extraction period.
Activity Fields are exported in the Daily Extract file for which 'Activity Fields' is selected as the entity. Most activity properties and fields available in Oracle Field Service (for example, 'Activity ID', 'Activity status', and 'Name'.) 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 the 'appointments' root element which contains 'appointment' elements. The 'appointment' elements are sets of 'Field' elements whose attributes are names of the fields and custom properties defined for the activities and whose contents are their corresponding values.
All out-of-the box fields and custom properties get extracted to the ‘Activity Fields’ file from Daily Extract when the appt.properties field is configured.
This table provides the label and description of those fields in the Activity Fields data set that can be configured:
Field | Label | Description |
---|---|---|
Access Hours |
appt.access_hours |
Formatted string. Contains set of hours the activity is accessible at the day it is scheduled for (including overnight) |
Access Schedule |
appt.access_schedule |
Formatted string. Contains schedule of access hours for the place where activity must be done. |
Account Number |
appt.customer_number |
String with name of customer account in external system |
Activity Features |
appt.afeatures |
Bitmask field that defines active features for this activity. This value is copied from selected activity type |
Activity ID |
appt.aid |
Unique numeric identifier of the activity |
Activity Location ID |
appt.a_locationid |
Activity location ID |
Activity Number |
appt.number |
Identifier of the activity (string, value of DB field "number") |
Activity Properties |
appt.properties |
List of all custom activity properties with their values |
Activity Time of Assignment |
appt.atime_of_assignment |
Date/Time when the last move/reschedule/assign to resource operation was performed for the activity. |
Activity Time of Booking |
appt.atime_of_booking |
Date/time when the activity was booked. |
Activity Traveling Time |
appt.continuous_traveling_time |
Travel time between activities/locations with addresses/coordinates |
Activity Type |
appt.atype |
Primary type of the activity (prework, reopened, regular...) |
Activity Update Flag |
appt.aupdate_flags |
Bitmask field. Displays bit flags after updating the activity. |
Activity Work Type |
appt.aworktype |
Identifier of the activity type defined for the activity. |
Activity Workflow | appt.activity_flow | Activity workflow assigned to the activity |
Activity Work Zone |
appt.aworkzone |
Work zone which is defined for the activity |
Activity status |
appt.astatus |
Status of the activity |
Auto-routed to Date |
appt.auto_routed_to_date |
The date the activity was scheduled for during the latest Routing run. |
Auto-routed to Resource |
appt.auto_routed_to_provider_id |
ID of resource the activity was assigned to during the latest Routing run. |
Auto-routed to Resource (Name) |
appt.auto_routed_to_provider_name |
Name of resource the activity was assigned to during the latest Routing run. |
Capacity Bucket |
provider.pcapacity_bucket |
ID of capacity bucket for the resource for whom the activity is provided. |
City |
appt.ccity |
City name, part of Customer address |
Coordinate X |
appt.acoord_x |
X coordinate received from geocoding module for the activity |
Coordinate Y |
appt.acoord_y |
Y coordinate received from geocoding module for the activity |
Coordinate accuracy |
appt.acoord_accuracy |
Accuracy level of coordinates for the activity |
Coordinate status |
appt.acoord_status |
Coordinate status for the activity |
Country |
appt.country_code |
Country code for the activity |
Customer Email |
appt.cemail |
Email of the customer for whom the activity is provided. |
Customer Language |
appt.clanguage |
Message language of the customer for whom the activity is provided. |
Customer Name |
appt.cname |
Name of the customer for whom the activity is provided. |
Customer Phone |
appt.cphone |
Phone number of the customer for whom the activity is provided. |
Customer Time Zone |
appt.c_zid |
Time Zone ID of the customer for whom the activity is provided. |
Date format (Resource) |
provider.pdate_fid |
ID of date format for the resource for whom the activity is provided. |
Day before |
appt.cdaybefore_flag |
Value of custom property "Day before". Present in the Initial DB, but may be removed. Flag indicates if 'Day Before' Notification must be used. |
Delivery Window End |
appt.delivery_window_end |
End time for activity Delivery Window in 'HH:MM' format |
Delivery Window start |
appt.delivery_window_start |
Start time for activity Delivery Window in 'HH:MM' format |
Delivery address |
appt.caddress |
Customer address (except City, Zip/Postal code, State) |
Duration |
appt.length |
Activity length in minutes. Filled when activity is finished. Value = end time - start time. |
Email address |
provider.email |
Email address for the resource for whom the activity is provided. |
Estimated time of arrival |
appt.ETA |
ETA date/time. Can be empty for Regular and Reopen activities if status is Pending or Suspended. For Started and Ended - time when activity is started. For Canceled can be empty or set, if set - it is time when provider started an activity before it was Canceled |
First Manual Operation |
appt.first_manual_operation |
The code of the first manual reschedule/move/reorder operation performed after an automatic one. The list of possible codes:
Points to
note:
|
First Manual Operation (Interface) |
appt.first_manual_operation_interface |
The interface in which the code for the first manual reschedule/move/reorder operation was performed from after an automatic one. The list of possible interfaces:
Differences between values 'API' and 'Inbound Interface':
|
First Manual Operation (User ID) |
appt.first_manual_operation_user_id |
ID of the user who performed the first manual reschedule/move/reorder operation after an automatic one. |
Initial Ratio for Activity Duration |
provider.pinitial_ratio |
Initial ratio for activity duration for the resource the activity belongs to. |
Master Activity ID |
appt.amaster_aid |
ID of main activity for prework, reassigned and reopened activities |
Message Language |
provider.planguage |
Language for resource the activity is assigned to. |
Mobile Phone |
appt.ccell |
Mobile phone number of the customer for whom the activity is provided. |
Organization |
provider.organization_id |
ID of organization for the resource the activity is assigned to. |
Points |
appt.apoints |
Number of points that represent efforts required to perform the activity. |
Position in Route |
appt.position_in_route |
Calculated field. Contains position of activity in the route. |
Postal Code |
appt.czip |
ZIP/Postal code of customer for whom the activity is provided. |
Reminder |
appt.cmessagetime |
Number of minutes before Delivery Window/ETA when reminder notification is sent. |
Reported End Time of Activity Delivery |
appt.ctime_delivered_end |
End date/time of activity which is delivered to the customer. |
Reported Start Time of Activity Delivery |
appt.ctime_delivered_start |
Start date/time of activity which is delivered to the customer. |
Resource External ID |
provider.external_id |
External system identifier for the resource the activity is assigned to. |
Resource ID |
provider.pid |
ID of resource the activity is assigned to. |
Resource Name |
provider.pname |
Name (text identifier) of resource for whom the activity is provided.. |
Resource Parent |
provider.parent |
ID of parent resource for the resource the activity is assigned to. |
Resource Phone |
provider.pphone |
Phone number of the resource for whom the activity is provided. |
Resource Time Zone |
time_zone.name |
Standard Oracle Time zone name |
Resource Time Zone Name |
time_zone.zoneinfo_name |
Standard IANA Time zone name |
Resource status |
provider.pactive |
Resource status (active or inactive) for whom the activity is provided. |
Resource type |
provider.ptype |
Resource type ID for the resource for whom the activity is provided. |
Route Activation Time |
queue.activated |
Date and time of route activation for resource for whom the activity is provided. |
Route Date |
queue.date |
Date of the route the activity is assigned to. |
Route Deactivation Time |
queue.deactivated |
Date and time of route deactivation (for already activated route) for resource for whom the activity is provided. |
Route ID |
queue.qid |
Unique internal identifier of the route the activity is assigned to. |
Route Reactivation Time |
queue.reactivated |
Date and time of route reactivation (for already deactivated route) for resource for whom the activity is provided. |
Routing profile |
provider.p_rprid |
ID of routing plan assigned to the resource for whom the activity is provided. |
SLA End |
appt.sla_window_end |
End date and time of Service Level Agreement in 'YYYY-MM-DD HH:MM:SS' format |
SLA Start |
appt.sla_window_start |
Start date and time of Service Level Agreement in 'YYYY-MM-DD HH:MM:SS' format |
Service Window End |
appt.service_window_end |
End time of Service Window in 'HH:MM' format |
Service Window Start |
appt.service_window_start |
Start time of Service Window in 'HH:MM' format |
State |
appt.cstate |
State (Geographic area) of the customer for whom the activity is provided. |
Teamwork ID |
appt.a_teamid |
ID of team for teamwork activities |
Template ID |
appt.a_templateid |
ID of activity template for mass/repeating activities |
Time Slot ID |
appt.a_tsid |
ID of Time Slot assigned to the activity |
Time Zone (Resource) |
provider.time_zone |
ID of time zone assigned to the resource for whom the activity is provided. |
Time format (Resource) |
provider.ptime_fid |
ID of time format for the resource for whom the activity is provided. |
Travel Area |
appt.atravelarea |
ID of travel area the activity is belongs to. |
Travel estimation method |
appt.travel_estimation_method |
Method that was used to make current traveling time estimation.Applicable for the activity. |
Travel estimation method (final location) |
queue.final_travel_estimation_method |
Method that was used to make current traveling time estimation. Applicable for the final location. |
Travel time adjustment: ID of previous activity |
appt.travel_from_aid |
ID of previous activity adjustment is entered for. Applicable for the activity. |
Travel time adjustment: ID of previous activity (final location) |
queue.final_travel_from_aid |
ID of previous activity adjustment is entered for. Applicable for the final location. |
Traveling Time |
appt.travel |
Time of travel from a previous activity/location. |
Traveling time (final location) |
queue.final_travel |
Travel to the final location of resource for whom the activity is provided. |
Visit ID |
appt.a_visitid |
ID of Visit for the activity. |
Work Order |
appt.appt_number |
Identifier of the activity (string, value of field "Work Order") |
Working Day End |
queue.calendar_time_to |
End of working day (Date and time) for the resource for whom the activity is provided. |
Working Day Start |
queue.calendar_time_from |
Start of working day (Date and time) for the resource for whom the activity is provided. |
appt.first_manual_operation_user_name |
First Manual Operation (User name) |
Name of the user performing the first manual reschedule/move/reorder operation after an automatic one. |
appt.first_manual_operation_user_login |
First Manual Operation (User login) |
Login of the user performing the first manual reschedule/move/reorder operation after an automatic one. |
appt.eta_end_time |
Start - End |
Real start time - end time for the activity |
end_time |
End |
Estimated or real end time of activity. Calculated as ETA (Start time)+activity duration. |
activity_workskills |
Activity Work Skills |
List of ID for Work Skills and Work Skill Groups for the activity |
activity_capacity_categories |
Capacity Categories |
List of ID for Capacity Categories for the activity |
position_in_route |
Activity order |
Order (sequence number) of the activity in the route for specified date |
Custom activity and resource properties (except file properties) can be configured and extracted for the Activity Fields data set. File properties are extracted according to configuration defined in the Property File Fields data set.
Type | Configurable |
---|---|
String |
Yes |
Integer |
Yes |
Enumeration |
Yes |
File |
No |
Example: Activity Fields file
Unique internal identifier of the activity, for example, Activity ID
Date of the route the activity is assigned to, for example, Activity Date
Unique internal identifier of the route the activity is assigned to, for example, Queue ID
Status of the activity, for example, Activity Status
Name of the customer for whom the activity is provided, for example, Customer name
This example also includes a custom property called Is a VIP that has two values:
1: The customer for whom the activity is provided is a VIP customer
2: The customer for whom the activity is provided is not a VIP customer
The example files below contain data for two activities, 541118 and 56214, assigned on 2013-11-08 to the same route, 546278. Activity 54118 was provided for John Smith, who is not a VIP customer, and the activity was cancelled. Activity 56214 was provided for an unidentified VIP customer, and the activity was completed.
<?xml version="1.0" encoding="UTF-8"?>
<appointments>
<appointment>
<Field name=”Activity ID”>54118</Field>
<Field name=”Activity Date”>2013-11-08</Field>
<Field name=”Activity Queue”>546278</Field>
<Field name=”Activity Status”>cancelled</Field>
<Field name=”Customer Name”>John Smith</Field>
<Field name=”Is a VIP”>1</Field>
</appointment>
<appointment>
<Field name=”Activity ID”>56214</Field>
<Field name=”Activity Date”>2013-11-08</Field>
<Field name=”Activity Queue”>546278</Field>
<Field name=”Activity Status”>completed</Field>
<Field name=”Customer Name” />
<Field name=”Is a VIP”>2</Field>
</appointment>
</appointments>