Details and Examples: Route Fields Data Set

The 'Route Fields' data set contains values of the fields and properties assigned by the end of the extraction period to routes processed in the application during the extraction period, and fields and properties of the resources, to which each route is directly assigned by the end of the 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.

Route Fields are exported in the Daily Extract file for which 'Route Fields' is selected as the entity. Any route properties and fields available in Oracle Field Service (for example, 'Queue ID', 'Resource ID', 'Status'.) can be included in the Daily Extract by adding them to the file structure.

Note: Route identifiers are unique within the single extraction, except identifier '0' which can be used more than once. Route identifier '0' is used to extract properties of buckets and organizations that is, resources having no own queues. In this case, the resource is identified by its ID, and the same file can have multiple 'queue' elements containing queue identifier '0'. In all cases, the 'queue identifier' + 'resource identifier' combination is unique per extraction.

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 'queues' root element that contains 'queue' elements. 'queue' elements are sets of 'Field' elements whose attributes are names of fields and custom properties defined for the route and resource executing the route and whose contents are their corresponding values.

Note: Date and time values in the 'Route Fields' file are exported in the resource time zone.

Example: Route Fields file

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

Date of the route, for example Queue Date
Unique internal identifier of the route, for example Queue ID
Unique internal identifier of the resource executing the route, for example Resource ID
Name of the resource executing the route, for example Resource Name
Scheduled work day start for the resource executing the route, for example Day Start
Scheduled work day end for the resource executing the route, for example Day End

This example also includes a custom property called Credence that corresponds to credence of the resource executing the route.

The data is collected for two routes of November 8, 2013; Route 546279 is assigned to resource 500001, Walter Ambriz, whose working day by the calendar is from 1 to 8 pm, and Route 535788 is assigned to resource 500123, Jennifer White, whose working day is actually an overnight from 10 pm to 8 am of the next day. No credence is provided for Jennifer.

<?xml version="1.0" encoding="UTF-8"?>
<queues>
   <queue>
      <Field name=”Queue Date”>2013-11-08</Field>
      <Field name=”Queue ID”>546279</Field>
      <Field name=”Resource ID”>500001</Field>
      <Field name=”Resource Name”> Walter Ambriz</Field>
      <Field name=”Day Start”>13:00</Field>
      <Field name=”Day End”>20:00</Field>
      <Field name=”Credence”>Walter Ambriz, an install technician with our
company, will be arriving at your requested location to meet your digital
cable and internet needs. Walter has successfully completed our extensive
certification program and has passed all given motor vehicle, drug and
background screenings.</Field>
   </queue>
   <queue>
      <Field name=”Queue Date”>2013-11-08</Field>
      <Field name=”Queue ID”>535788</Field>
      <Field name=”Resource ID”>500123</Field>
      <Field name=”Resource Name”>Jennifer White</Field>
      <Field name=”Day Start”>22:00</Field>
      <Field name=”Day End”>08:00</Field>
      </Field name=”Credence”/>
   </queue>
</queues>