Revision History

This document will continue to evolve as existing sections change and new information is added. All updates appear in the following table:

Date Feature Notes
20 APR 2018   Created initial document.

Overview

This guide outlines the information you need to know about new or improved functionality in Oracle Field Service Cloud, 18B Release. Each section includes a brief description of the feature, the steps you need to take to enable or begin using the feature, any tips or considerations that you should keep in mind, and the resources available to help you. For a listing of browsers supported by Oracle Field Service Cloud, log in to our support site and access Answer ID 8215.

Give Us Feedback

We welcome your comments and suggestions to improve the content. Please send us your feedback at http://documentation.custhelp.com/ci/documents/detail/5/4/12.

Feature Summary

Action Required to Enable Feature

Feature

Automatically Available

End User Action Required

Administrator Action Required

Oracle Service Request Required

Core Manage

Highlight Selected Part of a Resource Track

Support for Norwegian

APIs

Bulk Operations Performance and Booking Improvements for Capacity API

Dynamic Scope Support for API Calls

Find Matching Resources Improvements

Find Resources for Urgent Assignment

Metadata API

Collaboration

Usability Improvements

Events API for Routing Execution

Routing

Bulk Routing Bundling Improvements

Trigger Immediate Routing When Multi-Day Activities are Moved to Bucket

Core Manage

Highlight Selected Part of a Resource Track

There is another way to analyze the resource track in the Map View. Hovering over a breadcrumb on the map highlights the part of the track that contains the selected breadcrumb. When hovered over any activity marker on the map, the track between the previous and selected activities is highlighted and the non-related tracks are muted. This lets you see the track between two locations.

The tracks are highlighted as described below:

The following figure shows a highlighted track between points B and C highlighted in red:

Highlighted Track

The following rules are followed while highlighting:

HINT FOR A CLUSTERED POINT

When you click a clustered breadcrumb (resource track point) the hint 'Zoom in' appears near it. Upon clicking Zoom in, the map is zoomed in to the area with breadcrumbs.

If the clustered point contains 5 and more points, they are represented in the following way:

1st point timestamp

2nd point timestamp

3rd point timestamp

...

n point timestamp

The following figure shows a clustered breadcrumb with the hint:

Clustered Point

Steps to Enable

No steps are required to enable this feature.

Key Resources

Support for Norwegian

Now you can use Norwegian as a language in Manage, Mobility, Mobile, and APIs. For now the application supports Bokmål (literally "book tongue"), as it is an official written standard for the Norwegian language. The two-digit language code is ‘no’ and the five-digit code is ‘nb-NO’.

Steps to Enable

Steps to enable the language:

  1. Click Configure, Display and navigate to the Company language section.
  2. Click the pencil icon. The Languages dialog appears.
  3. Click the plus icon.
  4. Select Norwegian from the list and click Add.
  5. Click OK.
  6. To use Norwegian on the Login screen, select Norwegian in the Login Screen Language field.
  7. Click Save on the Display screen.

Key Resources

APIs

Bulk Operations Performance and Booking Improvements for Capacity API

The following enhancements have been made to improve the performance of Capacity and Quota Management REST APIs:

REST API IMPROVEMENTS

A new parameter has been added to the GET Activity Booking Options operation. The includePartiallyDefinedCategories parameter when set to true and if more than one category is defined, the operation returns capacity areas for which at least one category is defined. By default, the option is set to false.

The returned response contains the following fields:

Request Examples

Response Example

Response Example

SOAP get_capacity IMPROVEMENT

The following request parameter has been added to the get_capacity function:

include_partially_defined_categories (bool): If this option is set to true and more than one category is defined, the function returns capacity areas for which at least one category is defined. By default, the option is set to false.

Request Example

SOAP Request Example

Response Example

SOAP Response Example

Steps to Enable

No steps are required to enable this feature.

Key Resources

Dynamic Scope Support for API Calls

Oracle Field Service Cloud customers may need to grant Oracle Field Service Cloud Public API access to their own customers (end-customers) without creating specific accounts in Oracle Field Service Cloud or in other Oracle applications. In such cases, the scope of the end-customer's access must be restricted to a particular claim so that it prevents the end-customer from viewing data related to other Oracle Field Service Cloud customers.

Example Use Case

You can restrict the end-customer's access by using the 'ofsc_dynamic_scope' parameter on the 'Get access token' function to specify a custom claim. The 'ofsc_dynamic_scope' claim has the format of a URL with optional query parameters. It allows you to specify several URLs at once using the space character as a separator, for example, different API function URLs or same function URL with different set of parameters.

In the following cURL command example, the 'ofsc_dynamic_scope' is set to 'https://api.etadirect.com/rest/ofscCore/v1/whereIsMyTech?activityId=12345' (value is URL-encoded in the command):

Request for Dynamic Scope Support

The response contains the OAuth2 access token as follows:

Response with OAuth2 Token

The following is a sample of the decoded OAuth2 token containing the 'ofsc_dynamic_scope' claim:

Sample of the Decoded OAuth2 Token

If 'ofsc_dynamic_scope' claim is present in OAuth2 access token, then the following restrictions apply to the token:

Oracle Field Service Cloud customers can use the Oracle Field Service Cloud token service or any external token service for implementing dynamic scope support for API calls.

Following is the flow when the customer uses the Oracle Field Service Cloud token service:

  1. Customer's backend uses its application credentials with broad restrictions to get an access token for specific request(s).
  2. Customer's backend transfers the restricted access token to insecure web/mobile app of the end-customer.
  3. The web/mobile app can only query Oracle Field Service Cloud for the specific request(s). All other requests will be rejected by Oracle Field Service Cloud.

Following is the flow when the customer uses an external token service:

Prerequisites:

  1. Customer's backend uses its OAuth client credentials to request an access token with external token service, specifying the custom claim in request.
  2. The token service returns the access token with custom claim.
  3. Customer's backend passes the token to insecure web/mobile app of the end-customer.
  4. The web/mobile app may call Oracle Field Service Cloud REST API using this token, but will only be able to access the request(s) specified in the custom claim. All other requests will be rejected.

Steps to Enable

No steps are required to enable this feature.

Find Matching Resources Improvements

The Core API operation, findMatchingResources has been enhanced with the ability to return additional information that is useful for booking activities using a new parameter. The additional information includes:

schedulesFields PARAMETER

The new request parameter allows to control the information required within the response. This parameter must be specified with the existing parameter schedulesToReturn since that parameter determines if the schedules object should be returned in the response. Only those fields/sub-objects specified in the schedulesFields parameter are returned in the schedules object for each date in the response.

The schedulesFields parameter has the following properties:

arrivalTimeOptions OBJECT

If the value of schedulesFields  parameter is set to 'arrivalTimeOptions' then the arrivalTimeOptions object is included in the response. The arrivalTimeOptions object contains the following fields:

REQUEST/RESPONSE EXAMPLE

Here is an example of a request:

Example - Request for Find Matching Resources

Here is the example of a response:

Example - Response for Find Matching Resources

Steps to Enable

No steps are required to enable this feature.

Find Resources for Urgent Assignment

The new operation, findResourcesForUrgentAssignment in Core API allows you to retrieve a list of resources that can perform an activity based on distance. You must provide the required activity fields in the request, but only those resources that match the work skills and work zones of the activity are considered. The response contains a list of resources that can perform the activity.

The following query parameters are supported:

The following information is displayed in the response:

EXAMPLES

The following example shows how to find resources for urgent activity assignments by submitting a POST request on the REST resource:

cURL Command Example

cURL Command Example

Example for the Response Header

The following shows an example of the response header.

Response Header Example 1

Example of Response Body in JSON Format

The following shows an example of the response body in JSON format.

Response Body Example

Steps to Enable

No steps are required to enable this feature.

Metadata API

The Get activity types and Get Non-working Reasons resources have been added to the Metadata API.GET

GET ACTIVITY TYPES

This is a new operation in Metadata API that allows you to obtain collection of activity types.

The following query parameters are supported:

Based on this value, the translation for the name of the activity type is returned in the ‘name’ field. If the parameter is specified then the translated value is returned in the ‘name’ field and the ‘translations’ field is not returned.

If translation to the specified language does not exist, then the value in the ‘name’ field is returned in English. If the 'language' parameter is not specified, then the 'translations' field is returned in response, and contains the translations to every language in the system.

The following information is displayed in the response:

EXAMPLES

Following are some examples to understand this feature in a better way:

Example 1

The following example shows how to obtain a collection of activity types by submitting a GET request on the REST resource using cURL.

Use the cURL command with the following syntax:

cURL Command Example

The following shows an example of the response header:

Response Header Example

Response Body Example

The following shows an example of the response body in JSON format:

Example Response Body

Example 2

The following example shows how to obtain a collection of activity types by using the language parameter with the GET request on the REST resource.

Use the cURL command with the following syntax:

cURL Command Example -2

Response Header Example

Example for Response Header

Response Body Example

The following shows an example of the response body in JSON format:

Example of Response Body

GET NON WORKING REASONS

This is a new operation in Metadata API that allows you to obtain collection of non-working reasons.

The following query parameters are supported:

Based on this value, the translation for the name of the non-working reason is returned in the ‘name’ field. If the parameter is specified then the translated value is returned in the ‘name’ field and the ‘translations’ field is not returned.

If translation to the specified language does not exist, then the value in the ‘name’ field is returned in English. If the 'language' parameter is not specified, then the 'translations' field is returned in response, and contains the translations to every language in the system.

The following information is displayed in the response:

EXAMPLES

Use the cURL command with the following syntax to obtain the collection of non-working reasons:

cURL Command Example

Response Header Example

The following shows an example of the response header:

Response Header Example

Response Body Example

The following shows an example of the response body in JSON format:

Response Body Example

Steps to Enable

No steps are required to enable this feature.

Collaboration

Usability Improvements

Usability improvements have been made to the following Collaboration features:

COLLABORATION EVENTS

The Events API in Collaboration is updated with automatic broadcasting and the reason for transfer in helpdesk chats. You can use the user interface to obtain the routing execution details. The following events have been updated:

NOTE: The 'chatUpdated' event is triggered for chats from automatic broadcasting only when the chats are automatically cleaned up by the system. The user does not have an option to leave and end the chat.

Steps to Enable

No steps are required to enable this feature.

Key Resources

Events API for Routing Execution

The new 'routingRun' event type allows integrators to build flows depending on the routing execution stages and reduces the necessity to watch and monitor routing execution processes in the Manage interface. An external system can subscribe to the new event type using the 'Create subscription' function. Additionally, the subscribing application can use the 'filterExpression' field to narrow the event scope depending on the flow.

NOTE: The 'fields' parameter for the 'Create subscription' function for this event type will not affect the response of the 'Get events' function.

The routing event contains the following fields:

EXAMPLES

The following is an example for creating subscription with event type 'routingRun' using a cURL command:

Create a Subscription with Routing Run

Response to Create a Subscription with routingRun Event Type

The response of the cURL command is as follows:

Response to Create a Subscription with routingRun Event Type

get events Call Example

The following is an example of 'Get events' call for an event subscription that has event type as 'routingRun':

GET https://api.etadirect.com/rest/ofscCore/v1/events/?subscriptionId=50bb8eb8f0cf12145f325a31b40cc15906a67bd2&page=180404-706,0

The response is as follows:

Response to Get Events Event Call

Steps to Enable

No steps are required to enable this feature.

Key Resources

Routing

Bulk Routing Bundling Improvements

With 18B release, bulk routing supports visits and bundling the activities having the same visit key in the similar way as Immediate routing.

Steps to Enable

No steps are required to enable this feature.

Trigger Immediate Routing When Multi-Day Activities are Moved to Bucket

Multi-day activities are available for Immediate Routing both at the time of creating an activity and when a multi-day activity is moved to the bucket.

For the multi-day activities, immediate routing is triggered both when the activity is created on bucket or moved to it. When created, multi-day activities are divided into segments. Immediate routing will process only those activities when all the segments are not yet finished.

EXAMPLES

Following are some examples that discuss how Immediate Routing processes multi-day activities.

Example 1:

Example 2:

Steps to Enable

No steps are required to enable this feature.

Key Resources