1. Configuring Applications
  2. Details and Examples: Message Fields Data Set

Details and Examples: Message Fields Data Set

Message Fields are basic details on all messages that were sent or were to be sent by the application during the extraction period, including messages that were blocked with message blocking conditions and/or firewalls.

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.

Message Fields are exported in the Daily Extract file for which Message Fields is selected as the entity. Any message properties and fields available in Oracle Field Service (for example, 'Message ID', 'Message Address', 'Time of Message Sending'.) can be included in the Daily Extract by adding them to the file structure.

This table provides the label and description of fields in the Message Fields data set:

Field Label Description

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

Message Activity ID

message_log.mq_aid

Unique internal identifier of the activity for which the message was created.

Activity ID

appt.aid

Unique numerical identifier of the activity

Activity Location ID

appt.a_locationid

Activity location ID

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 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.

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

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.

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.

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:
  • 0 - Not Defined
  • 1 - Assigned
  • 2 - Bucket Changed
  • 3 - Reordered
  • 4 - Unscheduled
  • 5 - Unassigned
  • 6 - Rescheduled
  • 7 - Reassigned
  • 8 - Assigned by resource
  • 9 - Bucket changed by resource
  • 10- Unscheduled by resource
  • 11- Unassigned by resource
  • 12- Rescheduled by resource
  • 13- Reassigned by resource
Points to note:
  • Difference between values 'Assigned & Assigned by resource'
  • Difference between values 'Bucket changed & Bucket changed by resource'
  • Difference between values 'Reordered & Reordered by resource' and so on:

    If a resource/mobile worker has permission to move activities between resources/buckets or reorder within the route, thus such actions will be logged as by resource, for example, "Assigned by resource" means that the resources assigned the activity by themselves.

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:

  • 1 - Legacy Manage
  • 2 - API
  • 3 - Core Application
  • 5 - Inbound API
  • 7 - Configuration Interface

Differences between values 'API' and 'Inbound Interface':

  • API corresponds to API SOAP + REST APIs.
  • Inbound interface corresponds to 'file_upload' and Inbound API uploads data from external system to Oracle Field Service.

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.

Free-Format Message Notes

message_log.mqdata

Notes for the message (for example filled by the external message system)

Local Time of Message Sending

message_log.mqsent_local

Date/time when the message was sent to customer (Local time zone)

Master Activity ID

appt.amaster_aid

ID of main activity for prework, reassigned and reopened activities

Message Address

message_log.mqaddress

Message notification address.

Message External ID

message_log.mqexternalid

Identifier of the message in the external system

Message ID

message_log.mqid

Internal unique identifier of the message,

Message Route ID

message_log.mq_qid

Internal unique identifier of the route for which the message was created.

Message Recipient

message_step.msrecipient

Recipient of the message.

Message Scenario ID

message_flow.mfid

Unique internal identifier of the message scenario

Message Scenario Name

message_flow.mfname

Name of the message scenario.

Message Scenario Step: Duration

message_log.mqduration

Time spent on message sending until receiving the final message status for the message scenario step.

Message Scenario Step: ID

message_log.mq_msid

Internal unique identifier of the message scenario.

Message Scenario Step: Name

message_step.msname

Name of the scenario step

Message Scenario Step: Type

message_step.mstype

Type of the message scenario step ("start" or "inner")

Message Sending Method

message_log.mqmethod

Method of notification

Start of Message Sending Interval

message_log.mqsendfrom

Planned start date/time of message sending range (UTC)

End of Message Sending Interval

message_log.mqsendto

Planned end date/time of message sending range (UTC)

Message Sending Result

message_log.mqstatus

Final status of the message

Description of Message Sending Result

message_log.mqdesc

Description, complementing the message final status

Message Step Purpose

message_step.msfunction

Message step type: "PAS" (survey message) or "regular" (regular message)

Mobile Phone

appt.ccell

Mobile phone number of the customer for whom the activity is provided.

Launch Condition Name

message_log.mqtrigger

Message launch condition

Points

appt.apoints

Number of points that represent efforts required to perform the activity.

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.

Start Time of Activity Reported in Message

message_log.mqtime_delivered_start

Start date/time of activity which is delivered to the customer with the message.

Reported Start Time of Activity Delivery

appt.ctime_delivered_start

Start date/time of activity which is delivered to the customer.

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 of Message Sending

message_log.mqsent

Date/time when the message was sent to recipient (UTC)

Travel estimation method

appt.travel_estimation_method

Method that was used to make current traveling time estimation.Applicable for the activity.

Travel time adjustment: ID of previous activity

appt.travel_from_aid

ID of previous activity adjustment is entered for. Applicable for the activity.

Traveling Time

appt.travel

Time of travel from a previous activity/location.

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")

appt.properties

Activity Properties

List of all custom activity properties with their values

message_log.mq_invid

Message Inventory ID

Unique internal identifier of the inventory item for which the message was created.

message_log.mqtime_delivered_end

End Time of Activity Reported in Message

End date/time of activity which is delivered to the customer with the message.

message_log.mq_uid

Message User ID

Internal unique identifier of the user who sent the message.

appt.access_hours

Access Hours

Formatted string. Contains set of hours the activity is accessible at the day it is scheduled for (including overnight)

appt.country_code

Country

Country code for the activity

appt.cdaybefore_flag

Day before

Value of custom property "Day before". Present in the Initial DB, but may be removed. Flag indicates if 'Day Before' Notification must be used.

provider.planguage

Message Language

Language of the resource.

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

appt.end_time

End

Estimated or real end time of activity. Calculated as ETA (Start time)+activity duration.

appt.activity_workskills

Activity Work Skills

List of ID for Work Skills and Work Skill Groups for the activity

appt.activity_capacity_categories

Capacity Categories

List of ID for Capacity Categories for the activity

message_log.mq_pid

Resource ID

Unique internal identifier of the resource for which the message was created.

message_log.mq_srid

Service Request ID

Unique internal identifier of the service request for which the message was created.

Custom activity properties (except file properties) can be configured and extracted for the Message Fields data set. File properties are extracted according to configuration defined in the Property File Fields data set. Custom properties of the following types can be configured:

Type Can configure?

String

Yes

Integer

Yes

Enumeration

Yes

File

No

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 'messages' root element that contains 'message' elements. 'message' elements are sets of 'Field' elements whose attributes are names of fields and custom properties defined for the message and whose contents are their corresponding values.
Note: Date and time values in the 'Message Fields' file are exported in GMT time zone.

Example: Message Fields file

The following data is collected, but because the message detail fields are extensive, only some of the fields are used in the example files. Provide a meaningful name to the report.

  • Internal unique string identifier of the message, for example, Message ID

  • Unique internal identifier of the queue, for example, Queue ID

  • Unique internal identifier of the activity, for example, Activity ID

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

  • Recipient of the message, for example, Message Recipient

  • Unique identifier of the customer, for example, Customer ID

  • UTC date and time when the message was sent, for example, Date Time (UTC)

  • Name of the message scenario, for example, Message Scenario

  • Name of the scenario step, for example, Scenario Step

  • Method of notification, for example, Notification Method

  • Final status of the message, for example, Final Status

  • Description, complementing the final status, for example, Status Description

In the example data is provided for message 7224. The message was created within the queue with ID 5352 for activity with ID 3949. The message is not related to inventory and had to be sent to customer with external ID 019980. The message was attempted to be sent on 08-11-2013 at 17:09:24 and was created with the 'Day_before' message scenario at its start step – 'day_before'. Method of notification was an outbound voice call (voice). The message could not be delivered (falsemethod) as customer phone was not available.

<?xml version="1.0" encoding="UTF-8"?>
<messages>
   <message>
      <Field name=”Int Message ID”>7224</Field>
      <Field name=”Queue ID”>5352</Field>
      <Field name=”Activity ID”>3949</Field>
      <Field name=”Inventory ID”/>
      <Field name=”Message Recipient”>customer</Field>
      <Field name=”Customer ID”>019980</Field>
      <Field name=”Date Time (UTC)”>08-11-2013 17:09:24</Field>
      <Field name=”Message Scenario”>Day_before</Field>
      <Field name=”Scenario Step”>day_before</Field>
      <Field name=”Notification Method”>voice</Field>
      <Field name=”Final Status”>falsemethod</Field>
      <Field name=”Status Description”>'CUSTOMER_PHONE_IS_NOT_AVAILABLE'</Field>
   </message>
</messages>