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 |
---|---|---|
05 NOV 2018 |
Oracle Field Service Cloud - Oracle Analytical Cloud Service (OAC) Integration |
Updated document. Revised feature information. |
09 AUG 2018 | Reports and Dashboards Usability Improvements | Updated document. Revised feature information. |
09 AUG 2018 | Oracle Field Service Cloud - Oracle Analytical Cloud Service (OAC) Integration | Updated document. Revised feature information. |
23 JUL 2018 | Created initial document. |
This guide outlines the information you need to know about new and improved functionality in Oracle Field Service Cloud, 18C 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.
You will notice that a few 18C features reference Oracle Field Service Cloud Professional Cloud Service and Oracle Field Service Cloud Enterprise Cloud Service. These are new base product offerings that are planned for availability by the end of September 2018. Once available, you will be able to transition to one of these offerings with ease. If you have decided to transition, Oracle Field Service Cloud will look and operate just like it does today but with additional functionality and services. Additional details will be available closer to September 2018. Here is a preview:
- Oracle Field Service Cloud Professional Cloud Service will be a single, unified offering consisting of what is currently known as Core Manage, Mobility, Routing, Collaboration, Customer Communication, and Smart Location.
- Oracle Field Service Cloud Enterprise Cloud Service will be a single unified offering consisting of what is currently known as Core Manage, Mobility, Routing, Collaboration, Customer Communication, Smart Location, Capacity, and Forecasting.
Give Us Feedback
We welcome your comments and suggestions to improve the content. Please send us your feedback at https://documentation.custhelp.com/ci/documents/detail/5/4/12.
Action Required to Enable Feature |
||||
---|---|---|---|---|
Feature |
Automatically Available |
End User Action Required |
Administrator Action Required |
Oracle Service Request Required |
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
Booking Based on Planned Capacity and Limited by Time Intervals |
![]() |
|||
![]() |
||||
![]() |
||||
Use Temporary Assigned Resources in Quota and Capacity Calculations |
![]() |
|||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
![]() |
||||
Oracle Field Service Cloud - Oracle Analytical Cloud Service (OAC) Integration |
![]() |
|||
![]() |
Save the User Name on the Login Screen
With release 18C, you can provide users with the ability to save their user name on the Login screen when they login from the same device and browser. This is a global setting and when enabled, the Remember my username check box is displayed on the Login screen. This feature is available to login policies that are Internal or LDAP but it is not supported for SAML or OpenIDConnect login policies.
Steps to Enable
- Navigate to the Configuration page and select Display.
- In the Display page, select the Remember User Name on Login Screen check box.
Save User Name
- Click Save. The next time you try logging into the application, you will see the Remember my username check box displayed on the Login screen.
Key Resources
Support Oracle IDCS as OAuth2 Identity Provider
You can now configure Oracle Identity Cloud Service (IDCS) as the OAuth2 Token Service for Oracle Field Service Cloud REST APIs on the Applications screen.
The Support of Oracle IDCS as OAuth2 Identity Provider simplifies the configuration of Oracle Identity Cloud Service as the OAuth2 Token Service for Oracle Field Service Cloud REST APIs. The Configuration, Applications screen now includes the new option Oracle Identity Cloud Service for the Token Service drop-down list. When you select the Oracle Identity Cloud Service option, you can upload the signing certificate for Oracle Identity Cloud Service. After uploading the signing certificate, you can configure Oracle Identity Cloud Service to issue OAuth2 Access Tokens that the REST APIs will accept. See the Oracle Identity Cloud Service documentation for information about where to get the signing certificate: https://docs.oracle.com/en/cloud/paas/identity-cloud/index.html.
The Applications screen shows Oracle Identity Cloud as the new option for Token Service.
Glossary:
- Oracle Identity Cloud Service - is a next-generation security and identity management platform is cloud native and designed to be an integral part of the enterprise security fabric.
- OAuth2 Token Service - a service which can issue access tokens, which can be used when authenticating requests, such as authentication in REST API calls. Oracle Identity Cloud Service contains a Token Service that can be used to authenticate in Oracle Field Service REST API.
- OAuth2 Access Token - a token issued by a Token Service, which can be sent along with an API request, in order to authenticate the client.
Steps to Enable
To set the token service:
- Navigate to the Configuration page and select Applications.
The Applications page is displayed.
- In the Token service field, select Oracle Identity Cloud from the drop-down list.
Application Screen showing Token Service Field
- Click Upload to browse and select the signing certificate for Oracle Identity Cloud Service.
- See the Oracle Identity Cloud Service documentation for information about where to get the signing certificate:https://docs.oracle.com/en/cloud/paas/identity-cloud/index.html.
- In the API Access, enable a REST API you wish to use. Following is an example to add access to Read-write activity to Core API.
- Click Add New.
- In the Add New dialog, select Core API and click Submit.
- Core API is displayed under API access field.
- Click the Properties icon, and select Available entities.
- In the Available entities dialog, select ReadWrite from the Activity drop-down list.
- Save the application
- After uploading the signing certificate, you can configure Oracle Identity Cloud Service to issue OAuth2 Access Tokens that the REST APIs will accept.
To configure Oracle Identity Cloud Service:
- Log in to Oracle Identity Cloud service as administrator
- Go to the 'Applications' screen
- Create a new application for example "Oracle Field Service"
- Configure the application as a Resource Server ('Application ? Configuration ? Resources')
- In the Primary audience field, set the primary audience as <your Oracle Field Service Cloud instance name>. For example, 'ofsc-x1111'
- In the Allowed scopes field, add a scope. The scope name must begin with a slash ( / ), followed by the application ID that you created in Oracle Field Service Cloud. For example, if the application ID is 'new_app' then the Scope is '/new_app'.
- Note down the client_id and client_secret of the application.
- Save changes.
- Activate the application.
To issue the access token and authenticate the REST API calls,
- Get the access token for your newly created application by submitting the relevant REST API calls.
- See the Oracle Identity Cloud Service documentation for information to get access token from Oracle IDCS:https://docs.oracle.com/en/cloud/paas/identity-cloud/index.html.
Get the access token for your newly created application, as follows:
Get Access Token
Tips And Considerations
Key Resources
- Administering Oracle Field Service Cloud
Support for Supplementary Characters
Starting with release 18C, the special characters used in some of the Chinese, Japanese, and Korean language surnames and geographical names are supported. This also includes support for emoticons, pictographs, and certain symbols. These characters are supported across the application, including daily extract, search, parts catalog, and API functions.
Supported supplementary characters can be found at:
- Emoticons: https://en.wikipedia.org/wiki/List_of_emoticons
- Pictographs and miscellaneous symbols: https://en.wikibooks.org/wiki/Unicode/Character_reference/1F000-1FFFF, https://en.wikibooks.org/wiki/Unicode/Character_reference/2F000-2FFFF
- Supplementary characters: http://i18nguy.com/unicode/supplementary-test.html#utf8
Steps to Enable
This feature is available automatically when a new instance is created, or when a database is recreated with an empty data set.
Key Resources
Earlier, you could not configure the duration of unpaid travel time while traveling to the first activity and from the last activity. With the 18C release new travel options have been added to the Resource Type. These options are visible for Field resource, Tool, and Vehicle resource types and found in a new “Working time” section replacing the previously available “Working time includes first travel to activity” and “Working time includes travel to final location” options.
To configure the travel allowance, the Add Resource Type and Edit Resource Type screens include the following options:
- Start of day travel:
- Travel time to the first activity is not included from the Working Time Start
- Travel time to the first activity is included from the Working Time Start
- Resource is allotted up to <insert number> minutes of travel time prior to the Working Time Start
- Final travel:
- Travel time from the last activity to the Resources End Location is not included from the Working Time End
- Travel time from the last activity to the Resources End Location is included from the Working Time End
- Resource is allotted up to <insert number> minutes of travel time after the Working Time End
Routing also takes into account the duration of unpaid travel for resource types while routing activities under immediate, urgent, and bulk routing. The following figure shows the Time View with travel durations:
Example:
Roger’s assigned Resource Type has the following Work Time configurations:
- Travel time to the first activity is included from the Working Time Start
- Travel time from the last activity to the Resources End Location is included from the Working Time End
Jane and John’s assigned Resource Type has the following Working Time configurations:
- Resource is allotted up to 30 minutes of travel time prior to the Working Time Start
- Resource is allotted up to 30 minutes of travel time after the Working Time End
Consider Roger, Jane, and John, who have their work shift from 9:00 am to 6:00 pm.
- Roger lives 30 minutes from his first and last job. So, for both jobs, 30 minutes of travel is included as part of his workday.
- Jane lives 45 minutes away from the first and last job. So, for both of her jobs only 15 minutes of the travel is counted as part of her workday and the additional 30 minutes is beyond her workday.
- John lives 20 minutes away from his first and last job. So, no travel is part of his workday and the 20 minutes travel for the last job is done beyond his workday.
Using the example, if a new activity is created that is estimated to finish by 5:45 pm and overtime is no allowed, routing will not assign this activity to Roger. If it was assigned, Roger would incur overtime, because his shift ends at 6:00 pm. The routing engine would look for a more suitable resource.
Migration: During the upgrade if the “Working time includes first travel to activity” was enabled, “Travel time to the first activity is included from the Working Time Start” will be enabled. If “Working time includes travel to final location” was enabled then “Travel time from the last activity to the Resources End Location is included from the Working Time End” will be enabled. If these were not selected, the “Travel time to the first activity is not included from the Working Time Start” and “Travel time from the last activity to the Resources End Location is not included from the Working Time End” will be selected.
Steps to Enable
No steps are required to enable this feature.
Tips And Considerations
Key Resources
Currently, users have to contact their administrator or someone in the backoffice to reset a forgotten password. With the 18C release, users can reset their passwords without any assistance from the administrator. To enable this feature, the "Enable password reset on Login screen" check box on the Display Settings screen should be checked. Once enabled, a ‘Can’t sign in?’ link will be displayed on the Login screen. This is a global feature and is available for users with an Internal login policy. It is not available for users that are assigned a login policy using LDAP, SAML, or OpenID Connect.
Here are some screenshots:
Login Screen Showing Password Reset Link
Login Screen Showing Password Reset Notification
Login Screen Showing Password Reset Fields
Steps to use this feature:
- Click ‘Can’t sign in’ on the Login screen. The ‘Let’s find your account’ screen is displayed.
- Enter your username.
- If your username is valid, the password recovery details are sent to your email address, with the following email:
Subject: Password request for Oracle Field Service Cloud:
Body:
Your password reset request has been received. Please reset your password by clicking this secure link: <link>
If you did not request a password reset, you can ignore this email an continue logging in with your current password.
Thanks,
The Oracle Field Service Cloud Team
- If you do not get the email, click ‘Resend email’ on the login page.
- Open the email and click the link to recover the password. The Reset your password screen appears.
- Type the new password twice and click Submit. A confirmation that your password is reset appears.
- Click Back to sign in. The Login screen appears, where you can log in using the new password.
Steps to Enable
To enable the feature:
- Navigate to the From Configuration click Display
- Select the "Enable password reset on Login screen" check box.
- The ‘Email for password reset’ field appears. This field includes custom properties that can be selected as the source of the users email address where the recovery email will be sent. Custom properties are displayed if the following conditions are satisfied:
- Entity = User
- Type = String
- GUI = Text or Email
- Select the source from which you want to get the email address. Each user will require a valid email address in the selected property in order to receive the password reset email.
Key Resources
The REST Capacity API has been enhanced now that quota can be defined per booking interval per capacity category. The following REST APIs have been updated:
- GET Quota operation is updated and provides information regarding quota limits per booking intervals, if the quota is set based on planned capacity.
- PATCH Quota operation is updated and updates information regarding quota limits per booking intervals, if the quota is set based on planned capacity.
EXAMPLE FOR GET QUOTA OPERATION
Following is an example for GET QUOTA operation:
GET QUOTA Example
EXAMPLE FOR PATCH QUOTA OPERATION
Following is an example for PATCH QUOTA operation:
PATCH QUOTA Example
Steps to Enable
No steps are required to enable this feature.
Key Resources
API Updates in Resource Management
The following enhancements have been made for this feature in Oracle Field Service Cloud:
- The optional field, ‘organizationalUnit’ has been added as a user's field in ‘Create user’ operation.
- The field ‘organizationalUnit’ will be returned as a user's field in ‘Get user’ and ‘Get users’ methods.
- The field ‘organizationalUnit’ can be updated using the ‘Update user’ method.
Examples:
- PUT /rest/ofscCore/v1/users/{login}
Example
- Get user (GET /rest/ofscCore/v1/users/{login}) and Get users (GET /rest/ofscCore/v1/users)
- PATCH /rest/ofscCore/v1/users/{user_login}
Example
- Core API: Unset users (DELETE /rest/ofscCore/v1/resources/{resourceId}/users)
- No changes
- Core API: Set users (PUT /rest/ofscCore/v1/resources/{resourceId}/users)
- No changes
- Core API: Get resource users (GET /rest/ofscCore/v1/resources/{resourceId}/users)
- No changes
Steps to Enable
No steps are required to enable this feature.
Key Resources
Activity and Travel Duration Statistics
18C introduces new functionality around managing Activity and Travel Duration Statistics for subscribers to Oracle Field Service Cloud Professional Cloud Service and Oracle Field Service Cloud Enterprise Cloud Service. This features will enable users to:
- Use a new Statistics API to:
- Get details about Activity duration and Travel duration Statistics via REST API
- Override statistically calculated Activity durations and Travel durations via REST API
- View Override values within Statistics Report
- View the number of records updated after each Override operation in the Configuration Log History report
GET ACTIVITY DURATION STATISTICS
The following Activity Statistic details can be retrieved:
- Resource ID
- Activity Duration stats key
- Average Estimated duration
- Override
- Deviation
- Count
- Level
There will be an option to include children in the API. When set to true, the details of all Buckets/Resources within the specified resourceId will also be retrieved. For details for the Company level, the resourceId should be set to single quotes ('').
NOTE: The number of records that can be retrieved in a single response is 10,000. If there are more records, the remaining ones can be accessed using the 'next' link at the bottom of the response.
The following REST API path can be used to obtain the activity statistics:
- GET /rest/ofscStatistics/v1/activityDurationStats?resourceId=<externalId>&akey=<akey>&includeChildren=<true|false>&limit=<limit>&offset=<offset>
Description:
Name |
Required |
Type |
Description |
---|---|---|---|
resourceId | No | string | The external id of the resource. For Company level details use '' (single quotes) |
akey | No | string | The value of the Activity Duration Stats Field (Activity key value) |
includeChildren | No | string | Specifies if the details of child resources of the selected resource should be included or not. Takes values true/false. The default value is true. |
NOTE: If either the resourceId or akey is not sent as a parameter, the system will not filter the results based on that parameter and will return records for all applicable values.
Example of Response:
Get Activity Duration Statistics
GET TRAVEL DURATION STATISTICS
The following Travel Statistics details can be retrieved:
- From
- To
- Override
- Average Travel Estimation
- Deviation
- Count
- Region
The Travel statistics can be received only at the Company level and not at lower levels.
NOTE: The number of records that can be retrieved in a single response is 10,000. If there are more records, the remaining ones can be accessed using the 'next' link at the bottom of the response.
Users can get Activity Travel Statistics using the following REST API path:
- GET /rest/ofscStatistics/v1/activityTravelStats?fkey=<fkey>&tkey=<tkey>®ion=<region>&limit=<limit>&offset=<offset>
Description:
Name |
Required |
Type |
Description |
---|---|---|---|
fkey | No | string | From key value |
tkey | No | string | To key value |
region | No | string | Value of the Region |
NOTE: If any of the above parameters are not specified, all available entries will be retrieved.
Example of Response
Get Travel Duration Statistics
OVERRIDE ACTIVITY DURATIONS
Activity Durations can be overridden at either the Company level or the individual Resource level. When Overriding durations at the Company level, the 'resourceId' field should be left blank. Overrides can also be done for each Activity Duration Key value at the Company level or the Technician level.
In case there are multiple Activity duration keys configured in the system, the overrides will be applicable only for the currently Active Activity key. If the Key is modified, the overrides will be deleted from the system. However, the overrides will persist if only the Active key is changed, with the old key still being present in the system as Inactive. If an Inactive key is Activated, the Overrides that were set corresponding to that key will be applicable for estimations.
The Override will be stored in the system in addition to the learned statistical value against the currently active Activity key. For duration estimations, if there was an override specified by the user, the overridden value will be used instead of the statistically learned value. However, the statistically learned value will continue to get updated based on new reported durations as currently done. At any point of time users may choose to stop using the overrides, by importing the data again with 0 value in the override field. In such cases, the system will restart using the learned statistic values for duration estimations.
Once triggered, the changes will be reflected only after the next Stats script run and durations for all future Activities will reflect the overridden values where applicable.
NOTE: Each API request is limited to 10,000 records. Additional requests can be used if more updates are needed.
Overrides for Activity Duration estimation can be added for an Activity key value only if that kind of Activity was earlier performed by any Technician. Similarly, overrides for a Technician can be added only if that particular Technician has performed at least one Activity of any type.
Activity can be Overridden sing the following REST API path: PATCH rest/ofscStatistics/v1/activityDurationStats/
Request Fields:
Name |
Required |
Type |
Description |
---|---|---|---|
resourceId | Yes | string | The external id of the resource. If left blank, it will be considered as Company level. |
akey | Yes | string | The value of the Activity Duration Stats Field (Activity key value). Length cannot exceed 50 characters |
override | Yes | integer | The override value that needs to be set for resouceId and akey combination |
Response Fields:
Name |
Type |
Description |
---|---|---|
status | string | Status of the request |
updatedrecords | integer | Number of records updated |
OVERRIDE VALUES IN REPORTS
The Work Statistics and Travel Statistics reports will contain an additional column showing the 'Override'. If an override was added via API, the value of the override will be displayed in this column.
Here is an example:
Work Statistics Screen
CONFIGURATION LOG HISTORY
Whenever a PATCH API is used to update a value for an Activity Duration or Travel Duration, the Configuration Log History report will have an entry showing the number of records that were updated in addition to the Activity duration or Travel duration key. that was updated.
Configuration Log History
Steps to Enable
To get API access, you must enable the 'Statistics API' check box.
Once checked, permissions can be set separately for Activity Duration and Travel duration as Hidden, Read-only and Read-write.
- If the Read-only permission is selected, the profile can access only the GET APIs.
- Read-write permission will allow access to GET and PATCH APIs.
Key Resources
Application Entities Support for Metadata API
18C brings a new set of Metadata API functions providing the ability to export and import configuration settings for Application entities. The APIs can be used to maintain configuration backups and transfer configurations between instances. The following set of operations implemented:
- Create/Update application API: Creates an application with the configuration settings or updates the configuration settings of an existing application.
- Get Application: Returns information about a single application entity.
- GET Applications: Returns information about a collection of applications.
- Update applications API access: Updates the API configuration of an application based on the application ID specified while creating an application and the API label.
- Get applications API access: Allows you to access an application and read the access levels of a specific API.
- Get API access for applications: Allows you to access a collection of application APIs and returns a list of APIs that can be allowed or disallowed for an application.
NOTE: Certificate files and Client Secret values cannot be obtained or uploaded using the API and you need to manually configure the certificate files and client secret values for each application.
API permissions as a part of API Access entity can have different variants of structure for different API's.
- Access level based on Oracle Field Service Cloud entities, for example, Metadata API can be configured with Read-only access to Work Skill entity and Read-write access to Work Zone entity.
- Access level based on API methods and field visibility layouts. For example, Activity management API can be configured with access to specific methods or can have Read-Only or Read Write access to specific activity fields.
The application that will be used to work with these methods should be set with appropriate permissions for Metadata API.
NOTE: The application should not have restrictions for Oracle Field Service Cloud resources and should have access to the company root resource.
Steps to Enable
CREATE/UPDATE APPLICATION
The operation creates a new application with configuration settings or updates the configuration settings of an existing application.
The following path and request parameters are supported:
- Label: This parameter when used in the request URL creates a new application with the specified application ID or considers the specified ID to update an existing application.
- IPAddressesToAllow: This parameter specifies the IP addresses that can be accessed by the application. If no IP address is specified, all IP addresses are accessible.
- Label: The unique identifier of the application.
- Name: The name of the application.
- resourcesToAllow: This parameter is used to specify the resourceInternalIds and resourceIds (External IDs) of resources that can be accessed by the application. The parameter includes all the children of a specified resource. By default, if the resourceInternalIds and resourceIds (External IDs) of resources are not specified, the parameter allows the application to access the root resource. If both values, resourceId and resourceInternalId are used in the create/update request parameter, the resourceID has the priority (unless it is empty).
- Status: The status that is set for the application.
- tokenService: The token service that needs to be used by the application.
The following information is returned in the 200 and 201 response if an existing application is updated or created:
- IPAddressesToAllow: The IP addresses to which the application has access are returned. If no IP address is specified, all IP addresses that the application can access are returned.
- Label: The unique identifier of the application.
- Name: The name of the application.
- resourcesToAllow: The specified resourceInternalIds and resourceIds (External IDs) of resources that can be accessed by the application are returned. Also, all the children of the specified resource are returned. By default, if the resourceInternalIds and resourceIds (External IDs) of resources are not specified, the resourceInternalId and resourceId (External ID) of the root resource are returned. If both values, resourceId and resourceInternalId are used in the create/update request parameter, the resourceID is returned (unless it is empty).
- Status: The application status is returned.
- tokenService: The token service of the application is returned.
Following is an example:
Example
GET APPLICATION
This operation returns information about a single application entity.
The following request parameter is supported:
Label: The unique identifier of the application.
The following information is returned in the response:
- IPAddressesToAllow: The IP addresses to which the application has access are returned. If no IP address is specified, all IP addresses that the application can access are returned.
- Label: The unique identifier of the application.
- Name: The name of the application.
- resourcesToAllow: The specified resourceInternalIds and resourceIds (External IDs) of resources that can be accessed by the application are returned. Also, all the children of the specified resource are returned. By default, if the resourceInternalIds and resourceIds (External IDs) of resources are not specified, the resourceInternalId and resourceId (External ID) of the root resource are returned. If both values, resourceId and resourceInternalId are used in the create/update request parameter, the resourceID is returned (unless it is empty).
- Status: The application status is returned.
- tokenService: The token service of the application is returned.
Following is an example:
Example
GET APPLICATIONS
This operation returns information about a collection of applications.
The following request parameters are supported:
- Limit: Specifies the number of applications to be returned in the response. The minimum value that can be provided is 1. The maximum value that can be provided is 100. If value is greater than 100, it defaults to 100. Also, if no value or zero is provided, it defaults to 100.
- Offset: Specifies the record number from which to start retrieval. The default value is zero. If no value is specified, it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
The following information is returned in the response:
- hasMore: Indicates whether there are more results that can be retrieved with successive paging requests. If the value is true, it indicates that there are more results that can be retrieved with successive paging requests. If the value is false or is absent, it indicates there are no more results or this is the final page.
- resourcesToAllow: The specified resourceInternalIds and resourceIds (External IDs) of resources that can be accessed by the application are returned. Also, all the children of the specified resource are returned. By default, if the resourceInternalIds and resourceIds (External IDs) of resources are not specified, the resourceInternalId and resourceId (External ID) of the root resource are returned. If both values, resourceId and resourceInternalId are used in the create/update request parameter, the resourceID is returned (unless it is empty).
- Status: The application status is returned.
- tokenService: The token service of the application is returned.
- Limit: The limit value specified in the request or the value displays as 100 if the limit was not specified or not accepted.
- Offset: The offset value specified in the request.
- totalResults: The total number of the applications in the collection.
Following is an example:
Example
UPDATE APPLICATIONS API ACCESS
This operation updates the API configuration of an application based on the application ID specified while creating an application and the API label. For example, you can use this method to enable Core API for a specific application.
The following path and request parameters are supported:
- Apilabel: This parameter specifies the label that is used to identify the API.
- Label: This parameter updates the application with the specified application ID.
- activityFields: The activity fields of API that you want to specify for the application. Only available for Activity Management and Inbound API.
- apiEntities: The entities of the API that you want to specify for the application. Only available for Core and Metadata API.
- apiMethods: The methods of the API that you want to specify for the application. Only available for Activity Management, Resource Management, and Capacity API.
- inventoryFields: The inventory fields of API that you want to specify for the application. Only available for Activity Management API and Inbound Interface API.
- providerFields: The provider fields of API that you want to specify for the application. Only available for Resource Management and Inbound Interface API.
- Request fields: The request fields of API that you want to specify for the application. Only available for Activity Management API.
- Activity Management API
- Status: The status that you want to specify for the API method.
- userFields: The user fields of Resource Management API that you want to specify for the application. Only available for Resource Management API.
The following information is returned in the response:
- activityFields: The activity fields of a API that is returned for the application.
- Api Entities: The specified entities of the API that is returned for the application.
- Inventory Fields: The inventory fields of API that is returned for the application.
- Request fields: The request fields of API that is returned for the application.
- Provider Fields: The provider fields of API that is returned for the application.
- Status: The status that is returned for the application.
- User Fields: The user fields of Resource Management API that is returned for the application.
Following is an example:
UPDATE APPLICATIONS API ACCESS Example
GET APPLICATIONS API ACCESS
This operation obtains the API configuration of an application based on the application ID specified while creating an application and the API label.
The following path parameters are supported:
- Apilabel: This parameter specifies the label that is used to identify the API.
- Label: This parameter is used to obtain the API configurationapplication with the specified application ID.
The following information is returned in the response:
- activityFields: The activity fields of a API that is returned for the application.
- Api Entities: The specified entities of the API that is returned for the application.
- Inventory Fields: The inventory fields of API that is returned for the application.
- Request fields: The request fields of API that is returned for the application.
- Provider Fields: The provider fields of API that is returned for the application.
- Status: The status that is returned for the application.
- User Fields: The user fields of Resource Management API that is returned for the application.
Examples:
Following is an example for GET API PERMISSIONS (based on entity fields visibilities)
GET API PERMISSIONS Example 1
Following is an example for GET API PERMISSIONS (based on entities)
GET API PERMISSIONS Example 2
GET APPLICATIONS API ACCESSES
This operation obtains the API configuration for a collection of applications based on the application ID specified while creating an application.
The following path parameter is supported:
- Label: This parameter returns the application API access object based on the specified application ID.
The following information is returned in the response:Label: The label of the API access object is returned.
- Name: The name of the API access object is returned.
- Status: The status of the API access object is returned.
Following is an example
GET APPLICATIONS API ACCESSES Example
Key Resources
The maximum size of the decoded HTTP request has been increased to 5MB (previously 2MB) for bulk activity updates and maximum number of activities per request of 20 has been removed.
Steps to Enable
No steps are required to enable this feature.
Key Resources
With the 18C release, the following Core API operations have been added to improve and simplify integrations:
- Get calendars for multiple resources and multiple dates
- Set work schedules for multiple resources and multiple dates
- Set work skills for multiple resources and multiple dates
- Set work zones for multiple resources and multiple dates
Other improvements include:
- get resource(s) operations - parameter 'expand' is improved
- get route operation - specify a list of activity fields
GET CALENDARS
This operation returns a list of work schedules for the specified resource for the specified interval of days. This operation can be used to render work schedules on a calendar view control, such as a month or week view. Work schedules are a representation of the resources work calendar, which includes working hours, working and nonworking days, reasons for absence, and so on.
NOTE: Work schedules configured for parent resources are returned only if Oracle Field Service Cloud supports them.
The following are the request parameters:
- dateFrom (string) - This parameter specifies the date from which the calendar is retrieved. The format is YYYY-MM-DD. This is an optional parameter.
- dateTo (string) - This parameter specifies the date till when the calendar is retrieved. The format is YYYY-MM-DD.
- includeChildren (optional, string) - This parameter specifies if the subordinate resources should be returned.
- If the value is none, only the calendars of the specified resource are returned.
- If the value is immediate, the calendars of the specified resource and ones that are directly below it (first level descendants) are returned.
- If the value is all or not specified, the calendars of the specified resource and it’s descendants in the hierarchy tree are returned. The allowed values are “none”, “immediate”, “all”.
- includeInactive (optional, string) - This parameter specifies if the calendars of the inactive resources should be returned.
- If the value is true, calendars of the inactive resources will be returned.
- If the value is false, calendars of the inactive resources will not be returned.
- resources (array) - This parameter is used to specify comma-separated list of resource IDs, which are to be returned in the response. It works in conjunction with the includeChildren parameter.
The response body is a json object containing the following fields:
- Items - an array of object containing the following:
- resourceId (string) - The external identifier of the resource.
- date (string) - The date when this schedule takes effect. The format is YYYY-MM-DD.
- regular/on-call (object)
- comments (string) - The text that will be displayed in the OFSC application as the description of this calendar item.
- nonWorkingReason (string) - The reason why this is a non-working day (for example, holiday, vacation). These reasons are pre-configured in the Oracle Field Service Cloud User Interface.
- recordType (string) - The type of this calendar item. Allowed Values: schedule, shift, extra_shift, working, extra_working, non-working.
- workTimeEnd (string) - The end time of a work day when this calendar item is in effect. The format is HH:MM.
- workTimeStart (string) - The start time of a work day when this calendar item is in effect. The format is HH:MM.
Error Handling:
- If the swagger validation fails, the entire request will fail with http status '400 Bad Request' error. The following is an example of such condition:
A required field is not specified.
- In all other cases, the operation will return '200 OK'.
For this API to work:
- Permission: The permission ‘core_api_resource’ must be set to ‘ReadWrite’
- Limit: The date range in a request should not exceed 31 days, otherwise the an error is returned.
Example:
Following is an example for calendars request and response:
Example for calendars Operation Request and Response
Error Matrix:
- Returns error 404 if any of the resources do not exist.
- Returns error 400 if any of the following parameters are in an incorrect format:
- dateFrom
- dateTo
- includeChildren
- includeInactive
- Returns error 400 if dateFrom > dateTo.
- Returns error 400 if the date range dateFrom-dateTo is greater than 31 days.
- Returns error 409 if the dates specified in the request are too far in the past, or in the future.
BULK UPDATE RESOURCE WORK SCHEDULES
This operation creates, updates, or deletes work schedules of multiple resources at once.
The request body is a json object containing the following fields:
- resourceId (string) - The resource identifier in the external system. Only one of the following properties must be set:
- resourceId
- resourceInternalId
- resourceInternalId (integer) – The internal resource identifier. Only one of the following properties must be set:
- resourceId
- resourceInternalId
- workSchedules – An array of objects.
The response body is a json object containing the following fields:
- resourcesUpdated (integer) – The total number of resources updated.
- results (array of objects) – The result of updating the work schedules.
Error Handling:
- If the request size is greater than 5 MB then the API will fail with the http status '413 Request entity too large' error.
- If the body of the request in json is invalid in terms of swagger shema, the entire request will fail with the http status '400 Bad Request' error. The error details are as follows:
- Invalid property value. Path: 'path_in_swagger_shema'. Value: 'error_value'. Valid values: 'some_valid_value_1','some_valid_value_N'
- If resourceId and resourceInternalId are requested together, the request will fail with the http status '400 Bad Request' error. The error details are as follows:
- Only one of the parameters 'resourceId' or 'resourceInternalId' can be specified at one item of request.
- If resourceId and resourceInternalId are missing in the request item, the request will fail with the http status '400 Bad Request' error. The error details are as follows:
- Mandatory property is absent: 'resourceId' or 'resourceInternalId' must be defined.
- If the swagger validation fails, the entire request will fail with the http status '400 Bad Request' error. The following are the examples of such conditions:
- A required field is not specified.
- The request is not a valid JSON.
- In all other cases the operation will return '200 OK'. Verify the response to identify the operations that succeeded and the operations that failed. For example, the operation will return ‘200 OK’ when resourceId does not exist.
For this API to work, the permission ‘core_api_resource’ must be set to ‘ReadWrite’.
Example:
Following is an example for bulkUpdateWorkSchedules request and response
Example for bulkUpdateWorkSchedules Request and Response
BULK UPDATE RESOURCE WORK SKILLS
This operation creates, updates, or deletes work skills of multiple resources at once.
The request body is a json object containing the following fields:
- resourceId (string) - The resource identifier in the external system
- resourceInternalId (integer) – The internal resource identifier. Only one of the following properties must be set:
- resourceId
- resourceInternalId
- workSkills – An array of objects.
The response body is a json object containing the following fields:
- resourcesUpdated (integer) – The total number of resources updated.
- results (array of objects) – The result of updating the work schedules.
Error Handling:
- If the request size is greater than 5 MB then the API will fail with the http status '413 Request entity too large' error.
- If the swagger validation fails, the entire request will fail with the http status '400 Bad Request' error. The following are the examples of such conditions:
- Required field is not specified.
- Request is not in a valid JSON format
- In all other cases the operation will return '200 OK', even if some work skills cannot be added or some resources specified in request are invalid. Verify the response to identify the operations that succeeded and the operations that failed. Examples of such conditions are:
- If resourceId does not exist
- If workSkill does not exist or is invalid
- If startDate or endDate not set or invalid
- If ratio is not set or is invalid
Generated Error Messages:
The generated error messages are as follows:
- Cannot set work skills for resource: 'resource2'
- Resource not found: resourceId='resource2'
- Only one of the parameters 'resourceId' or 'resourceInternalId' can be specified at one item of request.
- Mandatory property is absent: 'resourceId' or 'resourceInternalId' must be defined.
- Invalid property value. Path: '0/resourceId'. String is too long. Length: '%%'. Maximum valid length: '32'
- Invalid property value. Path: '0/resourceId'. String is too short. Length: '0'. Minimum valid length: '1'
- Invalid property value. Path: '0/workSkills/0/ratio'. Value: '%%'. Value is greater than maximum: '100'
- Invalid property value. Path: '%%%/workSkills/0/ratio'. Value: '-%%'. Value is less than minimum: '0'
- Invalid property value. Property: 'resourceId'. Value: '%%'
- Required property is not specified: '0/workSkills'
Permissions
The permission ‘core_api_resource’ has to be set to ‘ReadWrite’ for this API to work.
Example
Following is an example for bulkUpdateWorkSkills request and response
Example for bulkUpdateWorkSkills Request and Response
BULK UPDATE RESOURCE WORK ZONES
This operation creates, updates, or deletes work zones of multiple resources at once.
The request body is a json object containing the following fields:
- resourceId (string) - The resource identifier in the external system
- resourceInternalId (integer) – The internal resource identifier. Only one of the following properties must be set:
- resourceId
- resourceInternalId
- workZones – An array of objects.
The response body is a json object containing the following fields:
- resourcesUpdated (integer) – The total number of resources updated.
- results (array of objects) – The result of updating the work schedules.
Error Handling:
- If the request size is greater than 5 MB then the API will fail with the http status '413 Request entity too large' error.
- If the swagger validation fails, the entire request will fail with the http status '400 Bad Request' error. The following are the examples of such conditions:
- Required field is not specified.
- Request is not in a valid JSON format
- In all other cases the operation will return '200 OK'. Verify the response to identify the operations that succeeded and the operations that failed. Examples of such conditions are:
- If resourceId does not exist
- If workZone does not exist or is invalid
- If startDate or endDate not set or invalid
Permissions:
The permission ‘core_api_resource’ has to be set to ‘ReadWrite’ for this API to work.
Example:
Following is an example for bulkUpdateWorkZones request and response:
Example for bulkUpdateWorkZones Request and Response
OTHER IMPROVEMENTS
GET RESOURCE - EXPAND
The get resource(s) operations - parameter 'expand' is improved.
Functions to expand inner entities (inventories, workZones, workSkills, workSchedules) when getting information about a resource or list of resources has been available since 18A. With this update, query parameter "expand" supports any combination of valid parameters in the request, provided as a comma-separated list.
By default (if the expand parameter is absent) no additional sub-entities are returned (allowing for backward compatibility). If the parameter is empty or contains one or more unknown values the response returns error 400 Allowed values: [inventories, workZones, workSkills, workSchedules]
Example:
Following is an example showing the expand parameter:
GET Resource -Expand Example
GET ROUTE - SPECIFY FIELDS
The get route operation - specify a list of activity fields
A new optional parameter "activityFields" is supported in the request of the function GET /resources/{resourceId}/routes/{date} The parameter allows you to specify which activity fields/properties should be returned for each activity in the response. If the parameter is not specified in the request all information about the activities is returned (allowing for backward compatibility). If the parameter is used, only specified fields/properties of activities are returned.
The activityId field is always returned even if was not specified in the 'activityFields'
Following is an example:
GET Route Example
Steps to Enable
No steps are required to enable this feature.
Key Resources
Core API Support for Service Requests
The following operations have been added for service requests in Oracle Field Service Cloud:
- Create Service Request operation
- Get Service Request operation
CREATE SERVICE REQUEST
The Create Service Request operation allows integrated systems to create a new service request in Oracle Field Service Cloud.
A service request is a data container, which can be used to collect information about activities, resources, or inventories when used by integrated systems. After a service request is created in Oracle Field Service Cloud, it cannot be modified.
An existing entity ID (resourceId, activityId, or inventoryId) must be provided with the request. If no entity ID is provided, a bad request error is returned as follows:
‘Required property not set. One of the property: 'activityId' or 'inventoryId' or 'resourceId' must be specified.’
If more than one entity ID is provided in the request then a bad request error is returned as follows: ‘Only one of the parameters 'activityId', 'inventoryId', 'resourceId' can be specified at one request.’
The user must at least have read-write access to the service request entity of the Core API; else, the function will return a 403 error.
You can also specify service request custom properties while creating a service request.
A new event, resourceRequestCreated, inventoryRequestCreated, customerRequestCreated in Events API will be generated depending on the specified entity field (resourceId, inventoryId, activityId) in the request.
Only one entity ID can be specified in the request, but Oracle Field Service Cloud will populate related IDs (if any).
For example, when an inventoryId is specified when creating a service request, Oracle Field Service Cloud finds the activity or resource that is linked with the specified inventory ID and adds the activityId and resourceId to the service request.
The response of POST or GET methods will return the saved entity IDs.
The response also contains the date and time when the service request is created in Oracle Field Service Cloud and is returned in ‘YYYY-MM-DD HH:MM’ format (UTC time zone).
The following query parameters are supported:
- Activity Id: ID of the activity for which the service request is created. This parameter is mandatory for customer service requests. If the activity ID of a non-scheduled activity is specified, the following error is displayed:
- 404 The activity doesn't exist. Parameter 'activityId':'{activityId}'.
- Inventory ID: ID of the inventory for which the service request is created. This parameter is mandatory for inventory service requests. If the inventory does not have a provider ID and if the activity ID of a non-scheduled activity is specified then the following error is displayed:
- 404 The inventory doesn't exist. Parameter 'inventoryId':'{inventoryId}'.
- Request type: This parameter is used to specify the request type that must be assigned to a service request. Allowed Values: Activity Type, Resource Type, Inventory Type. This is an optional parameter.
- Resource Id: ID of the resource for which the service request is created. This parameter is mandatory for resource service requests. If the resource does not have a resource ID and if the activity ID of a non-scheduled activity is specified then the following error is displayed:
- 404 The resource doesn't exist. Parameter 'resourceId':'{resourceId}'.
- Date: This parameter specifies the date (in YYYY-MM-DD format) and time (in resource time zone) for creating the service request in Oracle Field Service Cloud. This is an optional parameter. If the date parameter is not specified, it is defaulted to the following dates:
- Date of activity for activity service requests.
- Current date of provider (in provider time zone) for resource service requests.
- Current date of provider (in provider time zone) if inventory provider is known, else date of appointment is used for inventory service requests.
The following information is displayed in the response:
- Activity Id: The unique identifier of an activity in Oracle Field Service Cloud.
- Created Time: The date and time when the service request is created in Oracle Field Service Cloud returned in ‘YYYY-MM-DD HH:MM:SS’ format.
- Date: The date that is specified when the service request is created.
- Inventory ID: The unique identifier of an inventory in Oracle Field Service Cloud.
- Request ID: The identifier of the service request that is created.
- Resource ID: The resource ID of the resource in external system.
- Resource Internal ID: The resource ID in Oracle Field Service Cloud. This field is read-only.
- Type: The service request type specified in the request.
Following is an example using inventory:
Example
GET SERVICE REQUEST
This operation returns information about the specified service request.
The following query parameter is supported:
- requestId: The identifier of the service request.
The following information is displayed in the response:
- Activity Id: The unique identifier of an activity in Oracle Field Service Cloud.
- Created Time: The date and time when the service request is created in Oracle Field Service Cloud returned in ‘YYYY-MM-DD HH:MM:SS’ format.
- Date: The date that is specified when the service request is created.
- Inventory Id: The unique identifier of an inventory in Oracle Field Service Cloud.
- Request Id: The specified identifier of the service request.
- Resource Id: The resource ID of the resource in external system.
- Resource Internal Id: The resource ID in Oracle Field Service Cloud. This field is read-only.
- Type: The service request type specified in the request.
Following is an example for GET SERVICE REQUEST:
Example
DIFFERENCES FROM SOAP VERSION:
The Core API function has the following differences:
- Core API function does not support user_id and uname fields, where, user_id is the ID and uname is the login of the user who created the request.
- Core API function does not support property_filter parameter. The request will always return all related fields and service request properties.
- Error codes and messages are not returned as part of response body, instead they are returned as HTTP statuses.
- Only one linked entity ID can be specified when a service request is created. However, Oracle Field Service Cloud populates the other linked entity IDs (if needed).
Steps to Enable
No steps are required to enable this feature.
Key Resources
REST API for Resource Inventory Bulk Upload
With 18C, a new operation bulkUpdateInventories has been added in Oracle Field Service Cloud. This operation creates or updates resource inventory in bulk for the specified resources with the inventory specified in the request.
Only inventories with status as 'resource' are created, deleted, or updated. Inventories with status as 'installed' or 'deinstalled' are not touched.
The request body is a json object containing the following fields:
- resources (required) - An array of objects. Each object in the array contains the following fields.
- resourceId (required, string 1-32 characters) - The resource ID in the external system.
- identifySerializedInventoryBy (optional, string, enum) - This field determines the key for identifying serialized inventory. The possible values of this field are:
- serialNumber – When serialNumber is the only field required for identifying serialized inventories for a particular resource. This is the default value.
- typeAndSerial – When two fields (inventoryType + serialNumber) are used as the key for identifying serialized inventories for a particular resource.
- operationType (optional, string, enum) - The type of the operation. The possible values of this field are:
- 'replace' - Existing inventories that are not specified in the request will be deleted. Inventories that are specified in the request and exist in OFSC are updated. Inventories that are specified in the request but do not exist in OFSC are added. This is the default value.
- 'update' - Existing inventories that are not specified in the request are not deleted. Inventories that are specified in the request and exist in OFSC are updated. Inventories that are specified in the request but do not exist in OFSC are added.
- inventories (required) - An array containing inventory objects. If this array is empty and the ‘operationType’ is 'replace' then all existing inventories for the specified resource will be erased.
- inventoryType (optional, string) - The label of inventory type as defined in Oracle Field Service Cloud.
- For serialized inventories, this field is not specified.
- For non-serialized inventories, this field, along with the model acts as the key to determine the existing inventory that will be replaced.
- serialNumber (optional, string 0-128 characters) - The serial number of the inventory.
- For serialized inventories, this is the unique key (or a part of the unique key along with ‘inventoryType’) of an inventory for a particular resource. This key is determined by the value of the ‘identifySerializedInventoryBy’ field.
- For non-serialized inventories, this field can be set but it does not hold any meaning.
- quantity (optional, integer, default: 1) - The quantity of the non-serialized inventory. The default value is 1.
- For serialized inventories, this field is ignored, and quantity is set to 1
- For non-serialized inventories, this field is saved. The value can be positive, negative, or zero.
- <any inventory custom properties> (optional) - The custom properties of an inventory will be added/updated, except file properties.
- <model custom property> (optional) - For non-serialized inventories which have a model custom property set, this property will be part of the key, which is used to determine which existing non-serialized inventory to replace. If model property is absent, it is treated as an empty string.
- inventoryType (optional, string) - The label of inventory type as defined in Oracle Field Service Cloud.
The response body is a json object containing the following fields:
- created (integer) - The number of inventories created by the API call.
- updated (integer) - The number of inventories updated by the API call.
- deleted (integer) - The number of inventories deleted by the API call.
- itemsFailed (integer) - The number of items of the ‘resources’ array in the request that failed.
- results - The array of results. Each item from the 'resources' array in the request will have a corresponding item in the 'results' array. The 'results' array items are in the same order as 'resources' array items in the request. Each item is an object containing the following fields:
- resourceId (string) - The resource ID for which the inventories were updated, created, or deleted.
- created (integer) – The number of inventories created for this resource.
- updated (integer) – The number of inventories updated for this resource.
- deleted (integer) – The number of inventories deleted for this resource.
- errors (object) – This field is returned only if the item fails. It contains human-readable description of the error such as type, title, HTTP status, and so on.
Error Handling:
- If the request size is greater than 5 MB then the API will fail with HTTP status 413 ‘Request entity too large' error.
- If the swagger validation fails, the entire request will fail with HTTP status '400 Bad Request' error. Examples of such cases are:
- Some required field is not specified.
- The request is not a valid JSON.
- The operation will return HTTP status '200 OK', even if individual inventories cannot be created for some reason. The response needs to be checked to see which operations succeeded and which failed. Examples of such cases are:
- resourceId does not exist
- resource cannot have inventories (not a technician)
- ‘inventoryType’ does not exist
- invalid value of an 'enum' custom property
- string value is specified for a custom property that is of data type integer
Permissions:
The permissions ‘core_api_resource’ and ‘core_api_inventory’ have to be set to ‘ReadWrite’ for this API to work.
Following is an example for bulkUpdateInventories request and response:
Example Request
Example Response
Steps to Enable
- The permissions ‘core_api_resource’ and ‘core_api_inventory’ have to be set to ‘ReadWrite’ for this API to work.
Key Resources
With the 18C release, the following Smart Location REST API operations have been added to Oracle Field Service Cloud:
- Get last known positions of resources
- Get position history for resource for certain date
- Get resources in area
- Set positions for resources
GET LAST KNOWN POSITIONS OF RESOURCES
This operation retrieves the last known position of the specified resources.
Example: GET /rest/ofscCore/v1/resources/custom-actions/lastKnownPositions
The request parameter is as follows:
- resources (required) - Comma-separated string of resource IDs as per swagger CSV format. For example, ‘john.smith,scott.tiger’.
The response body is a json object containing the following fields:
- totalResults (integer) – The total number of items returned by the operation. A maximum number of resources in one request is 100.
- items - The array of resource IDs with their last known position information. Each last known position response item consists of:
- resourceId - The external resource ID.
- time (string|integer) - The date and time when the coordinates were captured in Internet Date-Time format. For example, 2016-09-20T11:37:29Z.
- lat (float) - The latitude coordinate (in degrees) of the position. A maximum of five digits after decimal point are returned. Range: -90; 90
- lng (float) - The longitude coordinate (in degrees) of the position. A maximum of five digits after decimal point are returned. range: -180; 180
- errorMessage - The error message corresponding to resource IDs for which some error occurred during the operation.
Following are some examples:
Example 1: Multiple resources
Multiple Resources Example
Example 2: Error messages for some resources
Error messages Example
GET RESOURCES POSITION HISTORY
This operation retrieves the last known position of the specified resources.used to query resource track data.
This operation is available to subscribers of Oracle Field Service Cloud Smart Location, Oracle Field Service Professional Cloud Service and Oracle Field Service Enterprise Cloud Service.
Example: GET /rest/ofscCore/v1/resources/{resourceID}/positionHistory
The request parameter is as follows:
- resourceID - required. The resource's external id or pid
- date - string, required. Requested date in "YYYY-MM-DD" format (e.g. "2016-09-01"). Set of points is returned for day that was activated on specified date, including overnight period.
The response body contains the following fields:
- totalResults (integer) – The total number of items returned by the operation. A maximum number of resources in one request is 100.
- items - The array of resource IDs with their last known position information. Each last known position response item consists of:
- resourceId - The external resource ID.
- time (string|integer) - The date and time when the coordinates were captured in Internet Date-Time format. For example, 2016-09-20T11:37:29Z.
- lat (float) - The latitude coordinate (in degrees) of the position. A maximum of five digits after decimal point are returned. Range: -90; 90
- lng (float) - The longitude coordinate (in degrees) of the position. A maximum of five digits after decimal point are returned. range: -180; 180
- errorMessage - The error message corresponding to resource IDs for which some error occurred during the operation.
- totalResults - integer, number of resource positions returned.
- items - array of positions with the following fields and attributes:
- time (string|integer) - The date and time when the coordinates were captured in Internet Date-Time format or integer UNIX timestamp. (e.g. either "2016-09-20T11:37:29Z" or 1476267764)
- lat (float) - The latitude coordinate (in degrees) of the position. A maximum of five digits after decimal point are returned. Range: -90; 90
- lng (float) - The longitude coordinate (in degrees) of the position. A maximum of five digits after decimal point are returned. range: -180; 180
- alt (integer) - Omitted if is not set for point. Meters above the WGS 84 reference ellipsoid.
- dir (float) - Omitted if is not set for point. Vehicle heading in degrees
- spd (float) - Omitted if is not set for point. Vehicle speed in meters per second
- acc (integer) - Omitted if is not set for point. accuracy of this location in meters
- s - sting, enum. Status of the point. Optional. If omitted then point status is normal (blue color on map). Possible values:
- "earlyStart" - activity was started far from its location (red color on map)
- "lateFinish" - activity was completed far from its location (red color on map)
- "leftLocation" - resource left activity location during working time (red color on map)
- "idle" - resource was idle (yellow color on map)
- i - integer. Duration of the point in minutes.Omitted if duration is 0. Point has duration when several positions in close proximity are grouped into one point.
Following is an example:
Example
GET RESOURCES IN AREA
This operation retrieves information about the resources location within a certain area, specified by longitude, latitude, and radius parameters. Points are sorted by distance to center point of requested area. Pagination is supported within this method.
This operation is available to subscribers of Oracle Field Service Cloud Smart Location, Oracle Field Service Professional Cloud Service and Oracle Field Service Enterprise Cloud Service.
Example: GET /rest/ofscCore/v1/resources/custom-actions/resourcesInArea
The request parameter is as follows:
- lat (Double) - Required. Latitude of the center of requested area
- lng (Double) - Required. Longitude of the center of requested area
- radius (integer) - optional (in m). Distance from center point to the edge of area, in meters. Default value is 10,000 m. Maximum is 100,000 m. Setting it to a higher value has no effect.
- timeDiff (integer) - optional (in min). Time parameter that represents how long (in minutes) location of resource is considered actual. Default value is 60 min. Maximum value is 24h (1440 min)
- limit (integer) - optional. Number of items to return in response on one page. Default value is 100 items. Maximum is 100 items. Setting it to a higher value has no effect.
- offset (integer) - optional. Number of items to skip from the beginning of the result set
The response body containing the following fields:
- totalResults (integer) – The total number of results in therequest
- limit - Number of items returned in response
- offset - Number of items skipped from the beginning of the result set
- items - array of resources in area
- resourceId - The external resource ID.
- time (string|integer) - The date and time when the coordinates were captured in Internet Date-Time format or integer UNIX timestamp. (e.g. either "2016-09-20T11:37:29Z" or 1476267764)
- lat (float) - The latitude coordinate (in degrees) of the position. A maximum of five digits after decimal point are returned. Range: -90; 90
- lng (float) - The longitude coordinate (in degrees) of the position. A maximum of five digits after decimal point are returned. range: -180; 180
- dis (integer) - Distance to center (in meters).
Besides, response contains pagination links that contain next and/or previous result set.
Following is an example:
Example
Following is an example with pagination parameters:
Example with Pagination Parameters
Steps to Enable
No steps are required to enable this feature.
Booking Based on Planned Capacity and Limited by Time Intervals
As of 18C, the following new options are available in availability-based quota and booking:
- Booking based on planned capacity, either from Day 1 or after pre-configured number of days
- Configure quota per booking interval per capacity category
The options allow using available capacity based booking for short term and switch to planned capacity for mid to long-term.
We recommend using quota management in the following way:
- If your calendars are accurate up to 3+ months period, use available capacity based quota.
- If your calendars are accurate only for few days, use available capacity for this period and then switch to planned capacity.
- For planned capacity, use quota per capacity category to imitate distribution of your work force work skills.
- For planned capacity, close unwanted booking intervals in advance to imitate distribution of your work force schedules. When possible, total length of open booking intervals close to work day length to avoid unnecessary over or under booking.
- Try to avoid limiting quota on booking intervals level until it is ultimately necessary as in this case you should manage the quota manually via UI/API on full scope.
WHATS NEW IN QUOTA MANAGEMENT
The Quota configuration screen layout is updated to include new quota management options.
The new Planned Max Available column has been added to Quota matrix next to Max Available one (visible only if quota is entered in percent of planned capacity).
The new editor to manage quota on booking intervals level is also added to Quota page.
Note that planned capacity is an equivalent of the "working time plans" that you can enter through corresponding API or set on the Available Capacity screen. Also, working time plans are accessible through Admin interface.
NOTE: Quota based on working time plans is only supported if quota is managed based on booking intervals. Working time plans is not supported for the quota managed based on time slots.
HOW TO CONFIGURE QUOTA
You can decide on how to manage your quota for the given capacity area, either based on time intervals or on booking intervals using the Quota, Configuration screen.
To enter daily quota values for booking intervals based quota management, you can select one of the following options:
- Enter quota in absolute time units (that is, minutes).
- Enter quota as percent of available capacity.
- Enter quota as percent of planned capacity.
- Enter quota as percent of available capacity for the given amount of days and then switch to enter quota as percent of planned capacity.
NOTE: During the upgrade, if available capacity based quota management has been selected, the application will migrate to booking intervals based quota with either quota in absolute time units or quota in percent of available capacity based on the quota by day settings.
To change the number of hours per day (used to recalculate working time plans (number of resources) to Max Available (hours/minutes) or vice versa), use the Business Rules page, select "man-days" as the "Measurement units for Quota and Available Capacity:" and change the value of "Number of hours per man-day:"
HOW TO USE
To allow booking by planned capacity, ensure that Quota is managed by booking intervals.
- To enter quota as a percent of planned capacity from day 1 (that is, today), select "Enter quota as a percent of planned capacity" for daily quota configuration.
- To use a combined approach, select "Enter quota as percent of available capacity for the given amount of days” and then select enter quota as percent of planned capacity option and enter the number of days for which you want to manage available capacity.
- The option "Enter quota as a percent of planned capacity" is an equivalent of "0" value and is used to determine the day from which you want to use planned capacity.
- The value 1 in this field indicates that during the first day (that is, today), available capacity would be used, and starting from tomorrow it would switch to planned capacity. "2" means "today and tomorrow".
In such a case, booking would use planned capacity for the Day #"number of days + 1" up until the overnight time setting value. After this time booking for this day starts using available capacity, which may lead to over or under booking in case of the number of available resources is different from the working time plan ones.
If no working time plans are set, the available capacity is used as working time plans.
NOTE: Working time plans could be set in absolute time units (minutes/hours/days) or in number of resources. In case of plans are set in resources, the value "Number of hours per man-day:" is used to convert the resources number into hours (and then to minutes if needed).
Note that while available capacity is distributed between capacity categories and booking intervals according to real schedules, it is not true with the planned capacity. Planned capacity is proportionally distributed between available booking intervals and copied for all the capacity categories.
EXAMPLE 1
Assume you plan for 10 resources tomorrow. The following list of categories are available: Install, Uninstall, Trouble Calls. The booking intervals defined in the system are: [8-12], [13-17].
In this case, the total amount of planned working time is 80 man hours (assuming 8 h working day). It distributes like the following:
Capacity Category | 8-12 | 13-17 |
---|---|---|
Install | 40 | 40 |
Uninstall | 40 | 40 |
Trouble Call | 40 | 40 |
Note that the total working time plans are distributed proportionally on all and every intervals for which booking is not closed on the interval level in advance. So if we include the intervals [0-8] and [17-24]*, the table would transform to:
Capacity Category | -8 | 8-12 | 13-17 | 17- |
---|---|---|---|---|
Install | 28 | 14 | 14 | 24 |
Uninstall | 28 | 14 | 14 | 24 |
Trouble Call | 28 | 14 | 14 | 24 |
About 2/3rd of the overall time is reserved for the morning and evening intervals and there will be no resources working assuming the overnight setting in the Business Rules page is set to 0.
If the overnight settings are set to non-zero value, the -8 interval will still have the length of 8 hours (i.e. starting at BOD), but the 17- interval prolongs till overnight end, so the length of the interval is increased with the overnight settings value.
To address the last example, two strategies could be used:
- Delete the non-working intervals from the overall intervals list. This can be applied for the companies/buckets having stable work hours.
- Close booking on the non-working intervals far in advance (over the period defined for quota calculation in the business rules).
Another possibility is to manage quota on booking intervals level. To manage quota on booking intervals level, select the corresponding option on the capacity category level.
Note that you could either manage all quota on the booking intervals level or none, that is, if the corresponding option is turned on, you should enter all the quota values for all the capacity categories and all the booking intervals.
Any non-entered entry is assumed to be "zero", that is, booking for such a combination of capacity category and booking interval is prohibited.
By default, if no values were entered for quota on booking intervals level, all the values are "0", so booking is prohibited for the entire area and to allow it, one should enter the values (either manually or via API) after the "Manage quota on booking intervals level" is selected.
To enter quota limits on booking intervals level, open the Quota page and open the intervals editor using (>) button. You can enter all the values in the absolute time units (minutes/hours/days) according to ones set on the Business Rules page. The values can also be entered via Quota API.
NOTE: Mass populate and auto-fill quota values on the booking intervals level are not available in this release.
Quota values on the booking intervals lever editor is accessible in RO mode in case of managing of quota on booking intervals level is turned off.
In this case the auto-populated values could be reviewed by means of RO editor.
Despite the fact that Quota values on the booking intervals lever editor may be visible in RO mode for all the days, those quota limits are not applied for the days when quota is not entered as percent of planned capacity.
The editor could be closed by clicking on (<) button.
The quota values on the booking intervals level would be used in the following way by corresponding SOAP or REST booking functions:
- If either the remaining daily level quota or capacity category level quota is less then estimated duration of the activity to be booked, the booking for given day/capacity category/capacity area is not possible. Otherwise, all the combinations of time slots and booking intervals are checked.
- If there is such time slot that activity could be started in this time slot and the remaining quota for each booking interval (for either automatically calculated or manually defined quota values) is enough to handle the part of the activity fitting to this booking interval, booking function returns such a time slot as a possible time slot.
EXAMPLE 2
Consider that there are two possible time slots: (8-12) and (12-16) and two possible time intervals (8-12) and (12-16). For each time interval, the quotas for booking intervals for Install CC are entered as 4 hours and 4 hours (and have 1 resource only).
If we have already booked an activity in (8-12) time slot for 3 hours, the remaining quotas are 1 hour and 4 hours.
When we try to book another activity for 2 hours, both (8-12) and (12-16) time slots are returned, and the second activity can be started after the first one that is before 12.
But if the second activity is booked into the (8-12) time slot, 3rd activity of the same length could be booked only into (12-16) time slot as the (8-12) time slot is exhausted.
SCREENSHOTS
Planned Max Available column:
Manually editing the quota limits per time interval:
Automatically distributed quota limits per time interval:
Steps to Enable
To enable quota by booking interval:
Prerequisite: Based on booking intervals must be used.
- Go to Quota Screen
- Select Configuration Icon
- Check the 'Manage quota on the level of booking intervals' option
Key Resources
Prior to 18C mobile users were able to see the planned amount of resources/working time for a Mobility Group. The planned resource information was loaded using the Core API. With 18C, the Capacity screen has been updated with a Planned Capacity editor on the Available Capacity screen. This editor allows capacity managers to view and manage working time plans of resources for capacity areas and organization units on a day level.
The editor displays either on the Resources or Capacity column based on the option selected from the Unit of working time plans drop-down list. See Configure Quota Options for more details.
Working time plans are values that are defined in the Capacity or Resources column of the Available Capacity screen for configuring capacity for the capacity area and its organization units.
As a quota or capacity manager, you can perform the following actions:
- Enter the capacity plan either on resource basis (in resource units) or on capacity basis (in man-hours, days, minutes) to cater to the business needs.
- View previously entered plans for capacity area.
NOTE: The users who have access to the Available Capacity screen can view and edit the working time plans.
Steps to Enable
To add, edit, or view working time plans:
- Select Quota
- Select a capacity area from the left-hand pane.
- Select the Available Capacity icon.
- Click on the value that is displayed on the Capacity or the Resources column for the capacity area.
The Planned Capacity editor displays an empty field for the capacity area and for each organization unit within the capacity area.
Available Capacity Screen
The following columns are displayed for both Capacity and Resources column:
- Available: Represents the available capacity for the capacity area and its organization units.
- Planned: Represents the working time plans that is defined for the capacity area and its organization units. You can enter or edit the values (must be whole numbers within the range of 0 to 65535) and the difference between planned and available capacity is recalculated automatically. When you click Save planned values, only the value of the Variance column for the capacity area is displayed on the Capacity or Resources column.
- Variance: Represents the difference between the values of the Available and Planned columns.
- The difference between available and planned capacity is displayed in the colored bubble in either Resources or Capacity columns on day level depending on the configuration settings. If planned capacity is not equal to available capacity then variance shown in orange color like "+123" or "-456" value with a "+" or "-" mark before the working time planned difference figure. A "-" means that available capacity is less then planned, and "+" means there is more capacity then was planned. For example, "-5" means that there are still 5 resources to be found and added to the capacity area, and "+5" means that we have excessive resources under the capacity area. When planned and available capacity are the same, a green 0 is displayed. The difference between planned and available capacity is recalculated automatically.
- Enter the Planned values in the Planned column
- Selected Save planned values when each update is made
You can select a previous date to view the previously entered plans for the capacity area or future day to made updates in the future.
The planned capacity editor has the same functionality if you select multiple days. You can view the planned values in mobility. See the About Resource Calendars section in Using Mobility Cloud Service Guide for more details.
EXAMPLES
Example 1:
Assume that the available capacity for a capacity area in the Available column is set as 853 hours. You estimate 850 hours for the capacity area and enter the planned value as 850 in the Planned column.
As the available capacity for the capacity area is more than the planned value, the Variance column displays +3 in orange color which means there is enough capacity available.
If the planned value is entered as 856 hours, the Variance column displays –3 in orange color which means there is not enough capacity available. If the values in the planned and available capacity are the same then 0 is displayed in the Variance column.
Similarly, the above logic applies for all the organization units within the capacity area. If the planned and the available capacity are the same then a green check mark is displayed on the Capacity column.
However, the difference between the planned values for the capacity area and its organization units are displayed on the bottom of the editor. For example, consider the following scenario:
- The available capacity for the capacity area is 853 hours and you enter a value as 852 hours. The Variance column displays +1.
- The available capacity for the organizations units, for example, Organization A and Organization B is 351 and 279 hours respectively and you enter values of 350 and 278 hours respectively. The Variance column displays +1 for both the organization units.
However, a message “The difference between plans for capacity area and its Organization Units is -1” displays on the editor which means that there is not enough capacity available for the organization units.
Example 2:
Assume that the available capacity for a capacity area in the Resources column is set as 97. You estimate 96 resources for the capacity area and enter the planned value as 96 in the Planned column. Since the available resources for the capacity area is more than the planned value, the Variance column displays +1 in orange color which means there are enough resources for the capacity area.
If a negative value displays in the Variance column then it means that there are not enough resources for the capacity area. Similarly, the above logic applies for all the organization units within the capacity area. If the planned and the available capacity are the same then a green check mark is displayed in the Resources column.
However, the difference between the planned values for the capacity area and its organization units are displayed on the bottom of the editor. For example, consider the following scenario:
- The available capacity for the capacity area is 97 resources and you enter a value as 96. The Variance column displays +1.
- The available capacity for the organizations units, for example, Organization A and Organization B is 75 and 65 resources respectively and you enter values of 74 and 64 respectively. The Variance column displays +1 for both the organization units.
However, a message “The difference between plans for capacity area and its Organization Units is -1” displays on the editor which means that there are not enough resources available for the organization units.
For more details, see the Oracle Field Service Cloud Using Capacity Cloud Service Guide.
Key Resources
Quota Screen Navigation Improvements
The following changes have been made to the Quota Management/Capacity module to align them with the other system screens and provide improved navigation. These include:
- Grouping actions Close Time history, Quota history and Mass populate are grouped under the Actions button.
- Removing the View button from all the screens except Quota/Quota by day/Quota by time slot/Quota by capacity category
- Making filtering by capacity category only available on the Quota by capacity category screens.
BOOKING STATUS SCREEN CHANGES
- Navigate to Quota and select the icon to view the Booking Status screen.
Check Icon
- The View button is not available on the Booking Status screen and all categories are always shown on the screen only for the Booking Interval based quota.
Booking Status Screen
- Map displays on the top of Booking Status screen only if a single day is selected on the calendar and time slot based quota is enabled.
QUOTA SCREEN CHANGES
- Navigate to Quota and select the icon to view the Quota screen.
Capacity Icon
- The Quota screen is displayed.
Quota Screen
- No navigation in the View button menu. If the Time Slot based quota is enabled, only the following views are available:
- Quota
- Time Slot based
- Quota by day
- Quota by time slot
- Quota by capacity categories
- All categories are always shown on the screen only for the Booking Interval based quota.
MASS POPULATE FEATURE
For availability based quota, you can mass populate all categories simultaneously and if you do not want to change the values in some categories then you need to manually reset their values after mass populate.
AVAILABLE CAPACITY SCREEN CHANGES
- Navigate to Quota and select the following icon to view the Available Capacity screen.
Available Capacity Icon
-
The Available Capacity screen is displayed:
Available Capacity Screen
- In the Available Capacity screen, note:
- No navigation in the View button menu.
- Max Available column is always visible.
NOTE: The term, "capacity bucket" is changed to "capacity area" throughout the product
CONFIGURATION SCREEN CHANGES
The configuration screen has been improved to provide better and clearer navigation.
- Navigate to Quota and select the tools icon to view the Configuration screen.
Tools Icon
Example Availability Based Booking Options:
Example Time Slot Booking Options:
MIGRATION: During the Oracle Field Service Cloud upgrade, a unnamed group is created and all the action links (Close Time history, Quota history and Mass populate) are moved to this group. if a user type has none of those actions, the migration does not add them. If some of them exists in layout, they will be added to the new group. If a group or groups exist before migration, they will be removed and all existing actions along with their visibility are added to new unnamed group. You could edit the access rights for this group using standard configuration options.
For more details, see the Oracle Field Service Cloud Using Capacity Cloud Service Guide.
Steps to Enable
No steps are required to enable this feature.
Key Resources
Use Temporary Assigned Resources in Quota and Capacity Calculations
Support for temporary available resources (that is, resources assigned to a given capacity area by direct assignment of a work zone to the resource) is added to quota and capacity calculations for both time slot and available capacity-based quotas to support related routing capabilities.
New fields have been added to Downloadable resource and activity lists to enable the identification of temporary resources and their activities.
When you select the Use resources outside the capacity area check box from the Business Rules, Quota Management section
- Resources may contribute capacity to another capacity area, provided the capacity area workzones are compatible with the workzones of resources
- Any configuration changes or changes to directly assigned work zones of resources are applied as per the recalculation period
The additional capacity of the resources is added to available capacity values on the Available Capacity screen and to the Max Available value on the Quota screen for multiple capacity areas.
Also, if the quota is configured as a percentage of Max Available value, the additional capacity is added to the quota calculations on the Booking screen and the booking APIs (GET AvailableBookingOptions and get_capacity operations) use the quota to determine the activity booking preferences.
The following items needs to be taken into consideration:
- To use temporary resources in quota calculations, you must assign the work zone(s) directly to the resources because inherited work zones of the resources is not used in calculations.
- Capacity areas with both inherited and directly assigned workzones are matched with resources that have workzones that are compatible and are directly assigned to resources.
- When a resource has a temporary work zone assigned, all other work zones (directly assigned or inherited workzones) are ignored during the defined start and end date of the temporary work zone.
- Resources that are not placed under the capacity area (either directly or indirectly) are not included in the quota calculations.
- Temporary available resources are added to quota and capacity calculations for both time slot and time interval (available capacity based) quotas to support related routing capabilities.
Downloaded Lists Updates:
To identify temporary resources, you can download the activity or resources list and search for non-empty values in the Capacity Area column.
If a value displays in the Capacity Area column, it indicates that the activity belongs to another capacity area but consumes capacity from the capacity area that it belongs. The displayed value of the capacity area is due to the following conditions:
- Assignment of the temporary available resource to the capacity area.
- Assignment of the activity to the temporary assigned resource.
Following fields are added to the downloadable resource and activity lists to improve the usability of the temporary assigned resources:
Resource List:
- Capacity Area: The original capacity area of the activity. Empty value means that the capacity area of an activity and the capacity area to which the activity belongs are same.
- Workzones: The inherited or directly assigned workzones of a resource.
Activity List:
- Capacity Area: The original capacity area of the activity. Empty value means that the capacity area of an activity and the capacity area to which the activity belongs are same.
- Assigned to: The resource or capacity area of the activity.
NOTE: Capacity Area and Assigned to fields are not filled and available for mass repeating activities.
Other:
When this feature is enabled a resource may contribute to capacity of two (or more) areas - e.g. one are is the one resource directly belongs to and another area (or areas) are ones resource is temporary assigned by means of same workzone(s). In such a case the sum of available capacities for the capacity areas under the same capacity group may exceed the capacity group available capacity due to double counted hours. However, the used activities will also be calculated for all the compatible areas, so the total figures are right.
EXAMPLES:
Example 1: Using temporary work zones
When a resource has a temporary work zone assigned, all other work zones will be ignored during the defined start and end date of the temporary work zone.
Bucket A [assigned WX A]
- Tech 1 [assigned WZ A,WZ B and Temporary WZ C from 7/1/18-7/8/18]
Bucket C [assigned WZ C]
- Tech 2 [assigned WZ C]
When "Use resources outside the capacity area" is checked, Tech 1 will be counted in quota calculations for Bucket C only between 7/1/18-7/8/18 because of the temporary workzone assignment.
Example 2: Using assigned work zones
Bucket and Tech Setup:
Bucket A [assigned WX A] - Tech 1 [assigned WZ A and WZ B] Bucket B [assigned WZ B] - Tech 2 [assigned WZ B]
When "Use resources outside the capacity area" is checked, Tech 1 will be counted in quota calculations for Bucket A and B.
Steps to Enable
By default, the "Use temporary assigned resources" functionality is turned off. We enabled this is global setting.
- Click Business Rules
- Go to the Quota Management section
- Check the Use resources outside the capacity area checkbox.
To disable, follow the step and uncheck the Use resources outside the capacity area checkbox.
Key Resources
As part of the 18C release, the Helpdesk functionality is available for mobile users when the assigned as a helpdesk operator.
The following features are supported for the helpdesk operator:
- When a helpdesk operator logs in to a mobile device, both the collaboration and helpdesk icons are visible.
- An operator can accept incoming requests from the helpdesk window. See the Accept a Helpdesk Request section in the Using Collaboration Cloud Service Guide for more details.
- An operator can transfer a request to another helpdesk operator. See the Transfer a Helpdesk Conversation section in the Using Collaboration Cloud Service Guide for more details.
- An operator can start or end or leave a chat. See the Start a Chat or End a Chat or Conference section in the Using Collaboration Cloud Service Guide for more details.
- An operator can use the Invite User option to add other users to a conversation. See About Collaborating with Other Team Members section in the Using Mobility Cloud Service Guide for more details.
- An operator can turn off the helpdesk. See Use the TurnOff Helpdesk Option for Status Change section in the Using Collaboration Cloud Service Guide for more details.
Example screenshot:
Steps to Enable
No steps are required to enable this feature.
Key Resources
Unified Core Manage and Mobility
The 18C release introduces the Oracle Field Service Cloud Core Application (Core Application). This is the initial iteration that unifies what was known as Core Manage and Mobility into a single application. In addition to new functionality, the Core Application adds functionality that was previously only accessible using Core Manage including Routing, Capacity, Forecasting, and Configuration.
SUMMARY OF CHANGES
Module | Screen/Functionality | Before 18C | 18C |
---|---|---|---|
Activities | Dispatcher view was available only in Manage (called Activities). There was a separate Supervisor view in Mobility (called Manage). | Core Application will include both Dispatcher view (Activities) and Supervisor view (Manage). Landing pages - List View/Time View/Map View - will behave exactly as it used to in Core Manage. Internal screens like Create Activity, Activity Details, Start Activity, Directions, Activate Route etc. will be displayed using the screens that were present earlier in Mobility (with added functionality, in some cases). This functionality will be called 'Dispatch Console' in the Core Application |
|
List view/Time View/Map View | Available only in Core Manage | Available in Core Application - same functionality as Legacy Core Manage | |
Delete activity | Available only in Core Manage |
Available in Core Application - same functionality as Legacy Core Manage. Field resources will be able to delete activities. |
|
Reopen activity | Available only in Core Manage |
Available in Core Application - same functionality as Legacy Core Manage. Field resources will be able to reopen activities. |
|
Create non-scheduled activity | Available only in Core Manage |
Available in Core Application - same functionality as Legacy Core Manage. Field resources will be able to add non-scheduled activities. |
|
Create Mass/Repeating activity | Available only in Core Manage |
Available in Core Application - same functionality as Legacy Core Manage. Field resources will be able to add repeating activities. |
|
Teamwork creation | Available in Manage and Mobility. Ability to create teamwork as repeating was available only in Manage. | Available in Core Application - same functionality as Legacy Core Manage. It will be possible to create teamwork as repeating activity. |
|
Cancel Mass/Repeating activity | Available only in Core Manage |
Available in Core Application - same functionality as Legacy Core Manage. |
|
Add Multi-day activity | Available only in Core Manage |
Available in Core Application - same functionality as Legacy Core Manage. |
|
Reopen Multi-day activity | Available only in Core Manage |
Available in Core Application - same functionality as Legacy Core Manage. |
|
Quota | Available only in Core Manage |
Available in Core Application - same functionality as Legacy Core Manage. |
|
Routing | Available only in Core Manage |
Available in Core Application - same functionality as Legacy Core Manage. |
|
Configuration | Available only in Core Manage |
Available in Core Application - same functionality as Legacy Core Manage. |
|
User Types | Labels will be changed to reflect the new approach. The older Manage will be referred to as 'Legacy Manage'. The new unified app (earlier Mobility) will be referred to as the OFSC App. A checkbox will be present to enable users to have access to the Legacy Manage interface. Unchecking this will direct all users to the new OFSC App. |
||
Forecasting | Available only in Core Manage |
Available in Core Application - same functionality as Legacy Core Manage. |
|
Resources | Please refer to 'RESOURCE MANAGEMENT CHANGES' section below | ||
Reports & Dashboards | Available only in Core Manage. Reports and Dashboards were separate menu items in Manage. |
New Dashboard functionality in the Core Application with below functionalities 1) Single menu to access Oracle Field Service Cloud dashboards, Oracle Field Service Cloud reports or any embedded dashboards. 2) Personalization options in reports & dashboards
3) Predefined dashboards for users - Admin user can create pre-defined dashboard pages for a user types this can act as a reference for all the users in that user type. 4) New Configuration UI for admin users. - A new configuration UI will be available for admin users to add available reports and predefined dashboards for user types. |
|
Collaboration | Available only in Core Manage and Mobility, except for Helpdesk functionality that was present only in Manage |
Available in Core Application including the Helpdesk functionality |
|
Search | Activity Search from header was available only in Core Manage. Search by Inventory was available in the Technician view in Mobility |
Activity Search will be available in the Core Application for all Dispatcher and Supervisor screens. For Field resource screens, users will continue to be able to Search by Inventory |
|
Login Screen | Screens looked very different in Core Manage and Mobility. | Unified screen for Core Application and Legacy Core Manage. |
RESOURCE MANAGEMENT CHANGES
Manage till 18C | Mobility till 18C | Core Application since 18C | Behavior after upgrade | |
---|---|---|---|---|
Changes of creating /updating resource /user | ||||
Used screens | Resource info - list of available resources (Org unit, buckets, field resources, vehicle, tool), possible open particular resource to view details Add child resource - allows to create new resource Users - allows to create new user and specify resource for user on the Add user screen. |
Resources - list of available resources (Field resources, vehicle, tool) , possible to go to resource info screen. The "+" button available to create new resource Resource info - allows to view info about resource and update it according to set permissions. |
Resources - list of available resources (Org unit, buckets, field resources, vehicle, tool), possible to go to Resource info screen. The "+" button available to create resource and user on the Add resource screen. Resource info - allows to view info about resource and update it on the Edit resource screen according to set permissions. |
For all users who can create Field Resources the action "Create resource/user" will be added to new context "Resources" after upgrade. All settings from the "Resource info" context will be copied to "Resource/user edit" context with visibility as well (excluding predefined tabs). For all users who can create resources the field "Organization unit" will be added with RW visibility to Resource/User edit context after "Resource Type" [ptype] field. It means that all users' permissions will be saved as well. For other users the behavior won't have any changes. New options:
Should be configured according to the feature manual. |
Context layouts | Context layouts Resource info ? Add resource ? Add user to resource |
Context layouts Resource info |
Context layouts Resources ? Resource/user info ? Resource/user edit |
See above description for Changes of creating/updating resource/user section |
Create resource /user - options | Ability to create resources:
Ability to create separate user Resource has to be associated with a corresponding user account Ability to move resources through the resource tree via drag and drop No ability to set permission for User type who can change for particular resource Visible resources (There is no such field on the context layout) |
Ability to create resources:
No ability to create user without resource Resource associated with a corresponding user account automatically No ability to move resources through the resource tree No ability to set permission for User type who can change for particular resource Visible resources (There is no such field on the context layout) |
Ability to create resources:
New ability to create user without resource (Dispatcher/ Manager/Admin) Resource associated with a corresponding user account automatically New ability to move resources between Org units and Buckets and set RO/RW access for Org unit field New ability to set access for User type who can change for resource visible resources. (There is new field "Visible resources" on the context layout) |
See above description for Changes of creating/updating resource/user section |
Permissions to create /update resource /user |
|
|
|
See above description for Changes of creating/updating resource/user section |
Available fields on context layout | All resources and users fields No ability to add these fields to context layout and set RW/RO access:
|
All resources and users fields: No ability to add these fields to context layout and set RW/RO access:
|
Both resources and users fields and properties. New ability to set RW/RO access for fields:
|
See above description for Changes of creating/updating resource/user section |
Changes of resources calendars | ||||
Used screens | Resource calendars - allows to switch between resources via resource tree and view their added schedules (schedule, shifts, working time, etc) Daily - show the calculated calendar for particular day |
Calendar - allows to see calculated schedule for particular month and change calendar via tap on the particular day. | Calendar - allows to see calculated schedule for particular month and change calendar via tap on the particular day. | The new option "Schedule" will be available for all users who have access to the Core Application and can change calendars. |
Context layouts | Main menu ? Resource Calendar
|
Main menu ? Calendar | Main menu ? Calendar | See above description for Changes of resources calendars section |
Create schedule | Ability to create schedule on the Configuration screen:
|
Ability to create schedule on the Configuration screen:
|
Ability to create schedule on the Configuration screen:
|
See above description for Changes of resources calendars section |
Update calendar | Possible to add to resource:
The final schedule calculates according to priority for mentioned schedules. Sometimes it is not clear for end user why such final schedule shows on the Daily screen and how it was calculated. If a resource has not own schedule then a schedule from bucket is inherits for such resource. |
Possible to add to resource:
The final schedule calculated according to priorities which work for Manage. If Shift, Custom working time or Non-working time set via Mobility then the last will be applied on the resource calendar. If a resource has not own schedule then a schedule from bucket is inherits for such resource. |
Possible to add to resource:
The schedule which selected via Mobility is applies for selected period of time including Schedule and will be shown on the Calendar screen immediately. Clear option for user. The last selected option(Schedule, Shift or On-call shift, Custom working time or Non working time) will be applied on the Calendar immediately. No need to use priorities like "override" in oder to cover existed schedule. If a resource has not own schedule then a schedule from bucket is inherits for such resource. |
See above description for Changes of resources calendars section |
Permissions to update resources calendar |
|
|
|
See above description for Changes of resources calendars section |
Warning message when set Non-working time for resource | If a resource has activities for this day, the following warning message appear: "Resource with pending activities should not be set non-working or inactive" |
No warning messages | If a resource has activities for this day, the following warning message appear: "Resource with pending activities should not be set non-working or inactive" |
See above description for Changes of resources calendars section |
Ability to change inventory in the resource pool | ||||
Options | It is possible to Add/Edit and Delete inventory from the resource pool | It is possible to view inventories in the resource pool. Not possible to add or delete. |
New ability to add inventory to the Resource pool via action "Add to resource" and delete inventory via "Delete" action link. |
The action links are available on the context layout and can be added for User type if need be. |
ACCESS AND AUTHENTICATION
Unified Login Screen
Authentication to Oracle Field Service Cloud app will start from the unified login screen - this replaces the legacy Core Manage and Mobility login pages. By default all users will login to Oracle Field Service Cloud application regardless of URLs they use.
Here are some common example URLs that would open the Core Application login screen:
- https://login.etadirect.com/{instance_name}
- https://login.etadirect.com/{instance_name}/m
- https://login.etadirect.com/{instance_name}/mobility
- https://{instance_name}.etadirect.com/
- https://{instance_name}.etadirect.com//m
- https://{instance_name}.etadirect.com/mobility
SUPPORT OF LEGACY TYPE OF AUTHENTICATION
To provide backward compatibility upon upgrade, Oracle Field Service Cloud will support legacy type of authentication.
To enable this support:
- Navigate to the Configuration page and select User types.
- In the User Types page, enable the "Allow access to Legacy Manage" check box. When the setting is checked, users of that user type will be redirected to the legacy Manage and Mobility interfaces as it used to be in prior versions. Even those users will be presented with the unified login screen from which they log in to the system.
UNIFIED ORACLE FIELD SERVICE CLOUD CORE APPLICATION
With the unified Oracle Field Service Cloud app, all major functionalities that were previously present only in the Manage interface will also be available in the Mobility interface now. With this change, the earlier Mobility interface will be referred as the Oracle Field Service Cloud Core Application.
The following modules that were only available in Core Manage interface previously will now be available in the new Core Application and will work exactly the same way:
- Routing
- Quota
- Forecasting
- Configuration
Activities will also be available in the Core Application; however, some screens that were already present in the Mobility interface will now replace those screens from Core Manage. This module will be called 'Dispatch Console' in the Core Application.
- Main Menu:
In addition to the Main Menu items that were present in Mobility, the Core Application will provide the ability to configure the following items in the Main Menu:
- Dispatch Console
- Dashboards
- Routing
- Quota
- Forecasting
- Configuration
Clicking the navigation icon displays the Main Menu as follows:
Main Menu Items
- Dispatch Console
The landing page, sometime referred to as the Time/List and Map View, displays information as it did in the legacy Core Manage Activities screen.
Display Console
Internal screens like Add Activity, Activity Details, Start Activity, Directions, Activate Route etc. will be displayed using the screens that were present earlier in Mobility. For example:
Add Activity Dialog
Activity Details Dialog
ENHANCED ACTIVITY MANAGEMENT
Following are some enhancements with activity management:
Roles:
There are two main roles for activity management that can be defined basing on visibility that they have on resources:
- Field resource - is a user that can view and manage only one resource.
- Dispatcher - is a user that can view and manage more then one resource.
These roles are not strictly limited to those short descriptions, there could be a mix (i.e. some user can perform work as a field resource but manage other resources as dispatcher) with Oracle Field Service Cloud distinguishing functionality as follows:
- A field resource performs activities
- A dispatcher manages the workforce in the field.
Delete Activity
Availability: Available for Dispatchers and Field resources. The functionality is presented online and offline.
Changes: Functionality is available for Field resources. The "Allow activity deletion in Manage" configuration setting is renamed to "Allow activity deletion"
A checkbox to delete activity is displayed on the "Cancel" screen when "Allow activity deletion" configuration setting is checked for a User type associated with the user. The checkbox is displayed for activities placed in inactive route.
Cancel activity Dialog
Reopen Activity
Availability: Available for Dispatchers and Field resources. The "Reopen activity" functionality works online and offline.
Changes: Functionality is available for Field resources.
The "Reopen activity" can be configured on the User type -> "Reopen Activity" configuration screen. From this version "Reopen activity" becomes a "shared" context layout hence changes applied to it are reflected in the Core Application and Legacy Core Manage.
Reopen Activity Action Link
The "Reopen" action link is available in the Core Application and Legacy Core Manage. It will be displayed for activities in "Canceled", "Completed", "Not Done" statuses.
Activity details Page
When clicking Reopen, the "reopen Activity" screen opens.
Values of all configured on the screen product fields and custom properties with enabled "Clone on reopen/prework" setting will be copied from initial activity and populated on the "Reopen activity" screen. Similarly to other screen intended to create new essences (such as "Add activity", "Add inventory" etc.) the "Reopen activity" screen will display fields/properties configured as R/W or Mandatory and amend R/O fields/properties.
Create Non-Scheduled Activity
Availability: Available for Dispatchers and Field resources. The functionality is available online and offline.
Changes: Functionality is available for Field resources.
The "Add activity" screen has the ability to create a non-scheduled activity. If "Allow access to non-scheduled pool" is enabled for a User type associated with the user, they will be presented with two options: add activity for a specific date or add non-scheduled activity. When "Submit" is pressed, the activity will be created as scheduled or non-scheduled depending on selected option.
Add activity Dialog
Create Mass/Repeating activity
Availability: Available for Dispatchers and Field resources. The functionality is presented in online only.
Changes: The functionality is available for Field resources.
It's possible to create mass and/or repeating activity under the following conditions:
- Activity type supports mass and repeating options
- "Allow repeating / mass activity creation" is checked for a User type associated with the user
Dispatchers will be able to create mass and repeating activities while Field resources will create only repeating activities regardless of configured activity type options as they cannot manage other resources.
Repeating activity Dialog
Teamwork Creation Activity
Availability: Available for Dispatchers and Field resources. Teamwork creation is an online operation.
Changes: Field resource can add teamwork activity as "repeating".
The screen to create teamwork is displayed by clicking "Assign to team" action link from resource hint or cogwheel on time view or by drag-n-drop the resource to another on the resource tree. The teamwork screen shows up like in Legacy Core Manage when following conditions are met:
- Resource type supports participation of teamwork
- Activity type supports teamwork as well
Teamwork creation screen displays "Repeating activity" section if the activity type supports this functionality. Teamwork creation screen does not display "Mass activity" section even if the activity type supports this functionality.
Add activity Dialog
Cancel Repeating / Mass Activity
Availability: Available for Dispatchers. The functionality is presented online and offline as follows:
- Works online when canceling repeating / mass for all participants for today and activity series entirely
- Works offline when canceling mass / repeating activity for a specific field resource for a single date.
Changes: Dispatchers can cancel Repeating / Mass activities regardless of the screen from which this operation is executed.
Same options that are available for repeating and mass activities in the Dispatch Console are reflected on the "Cancel activity" screen from Mobility.
Cancel Activity Dialog
Add Multi-day Activity
Availability: Available for Dispatchers and Field resources. The functionality works online and not presented offline.
Changes: Field resource can add multi-day activity on the "Add activity".
Multi-day activities can be created for activity types that support the "Multi-day activity" option. Field resource can add multi-day activities as either scheduled or non-scheduled if allowed for their assigned user type.
"Duration" is a mandatory field on the screen so it is important to have this property and its respective visibility configured.
Reopen Multi-Day Activity
Availability: Available for Dispatchers. The functionality works online and not presented offline.
Changes: Dispatchers can reopen Multi-day activity regardless of the screen from which this operation is executed.
The functionality of reopening a multi-day activity is similar to reopening a single day activity. There are two differences that should be taken into account:
- The screen opens up by clicking the "Reopen Multi-Day Activity" action link.
- The link is displayed when the entire multi-day activity is finished and all of the segments are in "Completed", "Cancel" or "Not done" status.
Additional Action Links in Activity Details
The following Action links will be available for configuration within the Activity Details screen in the Core Application:
- Links
- Resource Preferences
- Messages
These links will open up a new screen that will have the same content as the tabs with the same names in the Legacy Manage interface.
Activity Links Dialog
Resource Preferences Dialog
Messages Dialog
Search
The search functionality that was present in Legacy Core Manage is also available in the Core Application in the "Dispatch Console".
Display Console
Routing, Quota, Forecasting and Configuration
Routing, Quota, Forecasting and Configuration will display similar to Legacy Core Manage and can be accessed from the Main menu, if configured for the User Type.
Routing Screen
Configuration Page
CHANGES TO USER TYPES CONFIGURATION
Within the User Types Configuration screen, all references to Core Manage and Mobility will be removed or changed to "Use Legacy Manage for Dispatch operations." and "Allow access via web application" respectively.
User Types Configuration Screen - Access Settings
The 'Allow access via installed application for Android' and 'Allow access via installed application for iOS' checkboxes specify whether the users assigned to this User Type, should have access to the native Android and/or iOS Oracle Field Service Cloud applications. If checked, users can access the Oracle Field Service Cloud application via the installed app on Android or iOS devices.
The Allow access via Mobility check box is removed, since the Core Application will be the default interface. The Allow access via Manage check box is renamed to Use Legacy Manage for Dispatch operations. If this checkbox is enabled, users will be redirected based on the URL to Legacy Core Manage or the new Core Application. If unchecked, users will have access to only the new Core Application.
The following table provides the URL redirection logic:
Optional service Mobility is enabled |
Access to Legacy Manage is allowed (on User Type screen) |
Used URL | Before 18C | 18C> |
---|---|---|---|---|
YES | YES | https://login.etadirect.com/{instance_name}/ | Manage Login screen Redirect to Manage |
Unified Login screen Redirect to Legacy Manage |
YES |
YES | https://login.etadirect.com/{instance_name}/mobility https://login.etadirect.com/{instance_name}/mob https://login.etadirect.com/{instance_name}/m/ |
Mobility Login screen Redirect to Mobility |
Unified Login screen Redirect to the Core Application |
YES | NO | https://login.etadirect.com/{instance_name}/ | Manage Login screen Logout |
Unified Login screen Redirect to the Core Application |
YES | NO | https://login.etadirect.com/{instance_name}/mobility https://login.etadirect.com/{instance_name}/mob https://login.etadirect.com/{instance_name}/m/ |
Mobility Login screen Redirect to Mobility |
Unified Login screen Redirect to the Core Application |
NO | YES | https://login.etadirect.com/{instance_name}/ | Manage Login screen Redirect to Manage |
Unified Login screen Redirect to Legacy Manage |
NO | YES | https://login.etadirect.com/{instance_name}/mobility https://login.etadirect.com/{instance_name}/mob https://login.etadirect.com/{instance_name}/m/ |
Mobility Login screen Logout |
Unified Login screen Redirect to the Core Application without Offline functionality |
NO | NO | https://login.etadirect.com/{instance_name}/ | Manage Login screen Logout |
Unified Login screen Redirect to the Core Application |
NO | NO | https://login.etadirect.com/{instance_name}/mobility https://login.etadirect.com/{instance_name}/mob https://login.etadirect.com/{instance_name}/m/ |
Mobility Login screen Logout |
Unified Login screen Redirect to the Core Application without Offline functionality |
MIGRATION
Existing customers will not experience changes after the upgrade with the Core Application. The admin or individual responsible for configuration will have to configure Main menu items for each user type in order to make the screens visible for the Core Application. The Main Menu items will be visible only to those users who currently can view the Main menu. Since the Main menu is currently displayed to users who have at least 2 resources associated with them, even after the upgrade, only these users will be able to access the new screens that have been merged from the earlier Core Manage service.
Steps to Enable
No steps are required to enable this feature.
Key Resources
Activity Management - Month View
With the 18C release, the Time View automatically includes a new Month view, in addition to the existing Day, 2 Days, 3 Days, and 1 Week views. Another minor update involved changing the 1 Week view name to Week.
NOTE: Accessing all 30 days in a single view requires a 4K display or multi-monitor configuration. When smaller screens are used, it is expected behavior that users will have to scroll for the Week or Month views.
The Month view is available when you click the Calendar and select Month. It displays the activities scheduled for 30 or 31 days, depending on the month, starting from the selected day. The shape and colors of activities are the same as in the Week view. In the Month view, the daily activities are shown at the work day/work schedule level, instead of the time level. So, if two resources have different start times, their starting activities are shown at the same level. The following figure shows the Month view with an activity hint:
Activities that are shorter than 1/4th of the resource schedule length, or those that don’t fit to either 1/4th, ½, or 3/4th of the resource schedule length are shown in the condensed activity view as striped bars. Clicking the condensed activity view shows the activity details and the activity hint. A multi-day activity that ends at the end of the previous day and starts at the beginning of the next day is shown as a single activity over multiple days. You can move activities in the Month view, by dragging and dropping them. If the activity is hidden inside the stripped bar, open the hint and then drag the activity to the required place.
Displaying the Month view for large buckets or where routes have more than 20 activities per resource per day may take additional time to render. It is recommended that you use this view when there are fewer then 20 resources to be presented.
The rules for displaying activities in the Month view are:
- Mass repeating activities (for example, lunches) are not shown.
- Non-ordered activities are not shown.
- Multi-day activities that end at the end of the work day and continue from the next day are shown as a single activity over multiple days.
- If there are more then 10 activities, "and ‘n’ more" link is displayed.
- When a resource has non-working days, they're shown as dotted pattern.
- When you split the panels, it is possible to configure each panel with a different start date for the Month view.
- When the period covers different months, the month names are shown at the very top row.
- Activities that do not fit into ¼, ½, or ¾ of the workday length are shown as a multi-activity (striped bar) using the following rules:
- If there is a single activity that has a duration between 70% and 100% of 1/4th of the day, it is shown as 1/4th of the day activity, as a solid bar.
- If there is a single activity that has a duration between 70% and 100% of ½ of the day, it is shown as ½ of the day activity, as a solid bar.
- If there is a single activity that has a duration between 70% and 100% of ¾ of the day, it is shown as 3/4th of the day activity, as a solid bar.
- If there is a single activity that has a duration between 70% and 100% of the day, it is shown as the whole day activity, as a solid bar.
- Otherwise the activity is shown as a part of a striped bar.
For example: Suppose that a work day for a technician starts at 8:00 AM and the work day duration is 8 hours. In this case, the activities starting at 8:00 AM and finishing at 10:00 AM (2h = 1/4 of the work day duration), starting at 10:00 AM and finishing at 2:00 PM (4h = 1/2 of the work day duration), or starting at 10:00 AM and finishing at 4:00 PM (6h = 3/4 of the work day duration) are shown as single activities. But the activities starting at 9:00 AM and finishing at 10:00 AM (1h = 50% of 1/4th of 8h work day) and starting at 11:00 AM and finishing at 1:30 PM (2.5h is more than 100% of 1/4th of 8h work day, but less than 70% of 1/2nd of 8h work day) are shown as a multi-activity.
Steps to Enable
- No steps are required to enable this feature.
Key Resources
Processing Activities of Non-Working Technicians
Currently, when a resource has non-working time or an inactive schedule, the activities assigned to the resource’s route are not included in bulk routing optimization. With the 18C release, when a technician has a non-working calendar or an inactive schedule, the activities in their route will be reoptimized using bulk routing when following conditions are met:
- The routing plan has the Enable reoptimization check box selected.
- The resources meet the routing plan filter conditions.
The activities that are not routed to other resources during reoptimization will be moved to the routing bucket. This behavior applies even when the reoptimization goal = "resources route" is used or if the activity was directly assigned to the resource of the resource preference is “required”. Mass and repeating activities are not considered for reoptimization. This feature decreases the number of activities that are moved manually to adjust non-working time.
Steps to Enable
No steps are required to enable this feature.
Key Resources
With the 18C release, a new Contingent (or Infrequent) Workforce service is being introduced. A Contingent (or Infrequent) Workforce is one where the workers do not work directly for the company. They are contractors that may not have a dedicated or an assigned route every day. Typically, they will be assigned work infrequently, on an ad-hoc basis. This new offering provides businesses with additional configuration capabilities to support mixed usage models where there are in-house resources, dedicated contractors and/or Contingent Workers.
To accommodate contingent workers, this release includes the new option, Resource is a contingent worker on the Add resource type and Edit resource type screens. This option lets you identify a resource as a contingent worker.
A new read-only field, User classification field is added to the Users screen. This field indicates whether the user is a contingent worker. The values are: “contingent worker” and “regular”.
HOW TO USE THE OPTION
First, enable the Contingent Worker service, so that it is available as part of your Oracle Field Service Cloud subscription.
NOTE: The Contingent Worker service is being targeted for availability and provisioning by the end of September 2018. Once provisioned, the functionality will be available for use and configuration. It will require either Oracle Field Service Cloud Professional Cloud Service and Oracle Field Service Enterprise Cloud Service.
To use the functionality, create a resource type for Contingent Workers. In other words, select the Resource is a contingent worker check box when creating a resource type on the Add resource type screen.
NOTE: The Resource is a contingent worker check box is grayed out on the Edit resource type screen. This means, after you create a contingent worker resource type, you cannot change it back to a normal resource. Further, a contingent worker resource can only be a field resource and this resource must have only one corresponding contingent worker user.
When you select the Resource is a contingent worker check box, the following fields are grayed out on the Add resource type screen:
- Resource can participate in team
- Resource can be a teamholder
- Share inventory in teamwork
- Share geolocation in teamwork
- Share work skills in teamwork (team-member only)
- Used for Quota management
- Routing can assign activities
- Working time includes travel to first activity
- Working time includes travel to final location (if defined)
- Enable 'Not activated in time' alert and trigger
- Personalize the estimation of activity duration
- Use data reported to enhance company-wide estimations
Add Resource Type Screen
The following rules apply to contingent worker resources:
- When the Resource is a contingent worker check box is selected, the Role cannot be anything other than "Field Resource".
- This resource cannot participate in teamwork.
- This resource cannot access resources other than themselves.
- This resource cannot access the Video Chat service if provisioned.
- Quota does not consider contingent workers while calculating the available capacity.
- Routing will not assign activities to this resource.
- The alert regarding route activation does not display for this resource.
- Travel and Activity durations from these resources are not included in the Company-wide statistics.
- Contingent workers are automatically removed from the application, if they have not activated their route in twelve (12) continuous months.
VIEW CONTINGENT WORKFORCE
Use the following options to view whether a resource is a regular or a contingent user:
- User classification: “Contingent worker” for contingent workforce and “Regular” for regular users.
- Resource type: The Resource Type filter option on the Users screen.
As only a field resource can be linked to a user as a main resource, only field resource types are listed in the Resource type filter. The Resource type field is empty for users without a main resource.
Steps to Enable
Requires Oracle Field Service Cloud Contingent Worker to be added to your subscription.
Key Resources
Starting with the 18C release, a new option ‘Schedule’ is available on the Calendar screen in the Unified Manage and Mobility Application, making it possible to assign a schedule to a resource using the Calendar. The supervisor can also set Non-Working Time for a resource in case the resource needs a day off. However, the supervisor gets a warning message if the resource has some tasks assigned for the Non-Working Time allotted day.
This feature provides the following functionalities:
- Assign schedule for a resource:
With 18C release, it is possible to assign an existing in the system schedule and select a point period of time for the schedule. The update will be visible once Submit is selected.
Assigning Schedule for a Resource
- Get an alert about existing activities during set a Non-working time for a resource.
It is not possible to apply non-working time if the resource has a status other than repeating, shift, or mass type of activities assigned to thier route. If non-working time cannot be applied, a warning message appears. When you click Confirm, the non-working time is applied.
These are the warning conditions:
Not Activated route and at least one activity in status:
- pending - warning about pending activity presence
- started - situation is not possible
- suspended - situation is not possible
- completed - situation is not possible
- not done - situation is not possible
- cancelled - no warning
Activated Route and at least one activity in status:
- pending - warning about pending activity presence
- started - warning about activated route
- suspended - warning about activated route
- completed - warning about activated route
- not done - warning about activated route
- cancelled - no warning
Deactivated route and at least one activity in status:
- pending - situation is not possible
- started - situation is not possible
- suspended - warning about activated route
- completed - warning about activated route
- not done - warning about activated route
- canceled - no warning
Steps to Enable
To use this option:
- Go to the Calendar screen.
- Click any calendar cell to open the Calendar Edit dialog.
- Click the down arrow and select the start date for the schedule.
- Set the End Date so that schedule applies for a period of time.
- (Optional) Select No date specified if you want the schedule to be applied indefinitely.
- Click Submit.
NOTE: Access to modifying of calendar depends on a configuration for User type.
Key Resources
Improved Inventory in Resource and Customer Pools
Starting release 18C, you can add inventory in the resource and customer pools and delete inventory from any pool using Oracle Field Service Cloud Core Application.
With this feature, you can:
- Add inventory to the provider pool:using the new "Add to resource" screen.
- Improve required inventory management (Currently required inventory are not related with particular date so in the morning it is not possible to plan required inventory for the next day)
Steps to Enable
No steps are required to enable this feature.
Tips And Considerations
Displaying Traffic Layer in Maps
A Traffic Layer will be available to users of Oracle Field Service Cloud Enterprise Cloud Service and Oracle Field Service Standard Map Cloud Service with Google Maps or Baidu Maps. The layer is available when the ‘Traffic’ option is selected from the following maps:
- Route map in mobility
- Team map in mobility
- Dispatch map in Core Manage
- Dispatch Console map in the Core Application
Route Map example:
Dispatch or Dispatch Console example:
This layer is not available for soon to be available Oracle Field Service Cloud Contingent Workers add-on service that will be available to subscribers of Oracle Field Service Cloud Professional Cloud Service and Oracle Field Service Cloud Enterprise Cloud Service.
NOTE: Traffic information will vary based on the map providers data availability which may not be available in all countries/areas/states/provinces/localities. Please check the map providers website for data availability. When traffic data is available the system will use the most recent information available from the map provider which may not always be current.
Steps to Enable
To enable this option:
- From the Configuration page, click User Types.
- Select the User Type
- Under Permissions, select Use Real-time Traffic Data option.
- Click Save
Key Resources
Starting with the release 18C, the “Add Resource” screen in Oracle Field Service Cloud Core Application has a new option to create “Organization Unit”, “Bucket” and users with the role “Admin/Manager/Dispatcher”. All the resources of the Organization are displayed in the “Resources” section with flexible filters allowing resources to be allocated to a particular Org unit.
FUNCTIONAL IMPROVEMENTS
"Resources" screen extended roles
In the previous version of Oracle Field Service Cloud Mobility Resource Management only displayed "Field resource", "Vehicle" or "Tool". The "Resources" screen has been extended to show the resources with the role "Dispatcher/Manager/Admin", "Organization unit" and "Bucket". Organization Units and Buckets are always shown at the top of the list and sorted alphabetically. Field Resources, "Dispatcher/Manager/Admins", Vehicles and Tools are shown below and also sorted alphabetically.
A "Dispatcher/Manager/Admin" is a new role and these are individuals that work in offices and have access to the system but are not assigned a route. They can manage users, the field resource, capacity, system configuration, etc.
WORKING WITH RESOURCES iN MOBILITY
Creation of organizational structure - organization units and buckets
The steps to create a new Organization units or Buckets are the same.
- From the Resources screen, Click the via "+" button to open the "Add resource" screen.
- Select the appropriate Resource Type = "Organization unit" or "Bucket" depending on what you want to create
- Complete the necessary fields including:
- The Org Unit/Bucket. to which the new organization unit belongs to. Note: Each instance has at least one "top level" organization unit which represents the organization.
- Resource name that will be used to identify the Organization unit or Bucket
- Other fields such as Time zone, Time format, Date format, Long Date format, Message language and Status are filled automatically based. They are set based on the configuration of the User who is creating the new resource/user. These fields can be changed if required.
- Other properties may be need to be filled depending on the configuration of your instance.
- Click Submit
Creation of a "Dispatcher, Admin or Manager" resource
Users are created the same way a Field Resource was created in past releases.
- From the Resources screen, Click the via "+" button to open the "Add resource" screen.
- Select the appropriate Resource Type = "Dispatcher/Manager/Admin"
- Complete the necessary fields including:
- Resource name - identifies the resource in system
- User Type - select the User Type from the drop-down list
- Login - login that will be used by the resource to access the system
- Password - the password that will be used to access the system (when the User Type has the internal login policy)
- The Org Unit/Bucket. to which the new organization unit belongs to.
NOTE: Each instance has at least one "top level" organization unit which represents the organization.
- Other fields such as Time zone, Time format, Date format, Long Date format, Message language and Status are filled automatically based. They are set based on the configuration of the User who is creating the new resource/user. These fields can be changed if required.
- Other properties may be need to be filled depending on the configuration of your instance.
- Click Submit
If Organization unit field is not specified for the Manager/Dispatcher/Admin user then such user will be treated as 'Unassigned" to any organization.
There are several cases when an Organizational unit field will not be specified:
- if the Organizational unit can't be determined from the existing visibility settings during the migration (Note: we encourage you to check the structure in your TEST instance and make any updates if necessary)
- if the user is created via API
Users also belong to Organization units
For companies which have org structure, it is important to see which employees and where they are located (office or department). In the previous version in OFSC, it is possible to see just Field Resources, but it is not possible to see users who arrange their work, because just "field resources" assigned to only one organization unit or bucket. Thus it is not possible to see the general hierarchy and determine how many users like managers, admins or dispatchers works and where they are located hierarchically.
Since 18C version the users, who are actually "Dispatchers/Managers/Admins" (see above), are also organized in the hierarchical structure in the same way as "field resources". It means that it possible to see all resources in the one place, understand which resources are there in particular office or department and quickly navigate needed of them using a filter on the screen.
How to move resource from one Org Unit/Bucket to another one
- Be sure that User type has access to the Edit Resource screen and can change the field "Organization unit".
- Go to Resource Edit screen
- Click or tap on the Org Unit/Bucket field, select required organization unit and press "Select".
- The resource will be moved to another Organization unit
How to change a Field Resource to a Dispatcher, Admin or Manager
- Be sure that User type has access to the Edit Resource screen and can change the field Resource type.
- Go to Resource Edit screen
- Click or tap on the Resource type field, select required resource type which is Manager/Dispatcher/Admin.
- Click Submit
How to find resources who are assigned to a particular organization unit
- Go to the Resources screen
- Select the Organization unit where the resource belongs to
- Scroll to locate the resource or type the resources name in the search field to locate that individual
NOTE: The user should have visibility into the Org unit or Bucket where the resource is located.
How to find resources who are not assigned to a particular organization unit
- Go to the Resources screen
- Choose "Unassigned" from the "Organization" filter
- Scroll to locate the user or type their name in the search field in the to locate that individual
NOTE: The user should have visibility into the Org unit or Bucket where the resource is located.
How to find resources who are assigned a "Dispatcher/Manager/Admin" role
- Go to the Resources screen
- Select the "Manager/Dispatcher/Admin" checkbox
NOTE: This resource type is only available on the filter panel if it is configured on the "Resource type" screen context.
How to see the user count for particular organization unit
- Go to the Resources screen
- Select an Organization unit
- Select the Active option in the Status section
In the example below the FL, USA Org Unit has 5 active Manage/Dispatcher/Admin users.
CONFIGURATION ACCESS FOR RESOURCE MANAGEMENT
How to restrict functionality of new resource creation
- Go to Configuration -> User type -> General -> Can create users of the following user type
- Go to Screen configuration -> Context layout Resources and add action "Create resource/users". If context Resources is not configured the button "+" is hidden on the Resources screen.
- Go to Context layout Resource/user edit. The following fields should be configured with a RW visibility:
- Organization Unit (label: parent)
- Resource Type (label: ptype)
- Status (label: pactive)
- Resource Name (label: pname)
- Language (label: planguage)
- Date Format (label: pdate_fid)
- Time Format (label: ptime_fid)
- Time Zone (label: time_zone)
- Long Date Format (label: sulong_date_fid)
- User Type (label: user_type_id)
- Login (label: ulogin)
- Password (label: password) - mandatory for User Type which has the internal login policy
- Visible Resources (label: resources) Other properties may be need to be configured and filled depending on the configuration of your instance.
NOTE: If mandatory properties are not configured on the screen for particular User Type or are empty, the message "Form is mis-configured" will be shown when attempting to submit "Add resource" and you will not be able to create a new resource/user until the mandatory properties are added to the screen layout.
How to restrict functionality of moving resources between Org Units
It is possible to restrict access of moving resources by:
- Go to Configuration screen
- Select appropriate User type and go to the General tab
- Check the option Allow to move resources between Organization Units
- Go to Configuration screen
- Select appropriate User type and go to the Screen configuration
- Go to the Edit Resource/User context and set RW/RO visibility for the field Org Unit/Bucket
SCREEN CONFIGURATION UPDATES:
Here are other updates to the screen configurations:
- The existing context layout Resource info is renamed to Resource/User Info.
- A new context Resource/user Edit was added. This enables the "Resource/User edit" to be set so users and resources can be created and modified. RO/RW visibility settings will determine access to resources/users fields.
- A new context Resources is added to the Application screens section and is used for the existing "Resources". This context lets users configure the "Create resource/user" action link that is used to control access for adding new resource/users.
- A RW/RO visibility are added to the "Org Unit/Bucket" field making it possible to control who can move resources by hierarchy (between offices or departments).
- A RW/RO visibility are added to the "Visible resources" field making it is possible to control who has access to change visible resources for particular resource.
Steps to Enable
- No steps are required to enable this feature.
Key Resources
Real-Time Traffic Updates for Travel Time Estimation
Starting with 18C, travel time between activities will be updated with current travel and traffic conditions (i.e. real-time traffic data) when a field resource activates their route or when the end/complete an activity.
Use of this feature requires a subscription to Oracle Field Service Cloud Enterprise Cloud Service and Oracle Field Service Standard Map Cloud Service with Google Maps or Oracle Field Service Standard Map Cloud Service with Baidu Maps.
This feature is configurable by user type and when enabled, the travel time will be updated with current travel and traffic conditions at:
ROUTE ACTIVATION
When a user activates their route from the Oracle Field Service Cloud Mobility app or the Core Application, the real-time travel data from the map data provider (e.g. Google Maps) will be used to update the travel time between activities on the current days route. In order to use this option while activating the route, the following conditions must be satisfied:
- Previous and Next activities have resolved coordinates that were provided with the activity creation
- ‘Calculate Travel’ parameter must be enabled for both the activities in Configuration page -> Activity Types -> Features
- Distance between the activities must be more than 1km (0.62 miles)
ACTIVITY COMPLETION
When an activity is completed using the Oracle Field Service Cloud Mobility app or the Core Application, the real-time travel data from the map data provider (e.g. Google Maps) will be used to update the travel time to next activity on the route. In order to use this option after completing the activity, the following conditions must be satisfied:
- ‘Calculate Travel’ parameter must be enabled for the activity type of next activity in Configuration Page-> Activity Types-> Features
- Next activity has resolved coordinates that were provided with the activity creation
- Distance from the current resource position to the next activity must be more than 1km (0.62 miles). If the resource position is not gathered until the last minute, then the coordinates of the current activity are used (if available).
If the 'Allow next activity selection on Complete' is enabled for the user where it is possible to select next activity on the route, the travel time to those activities will be updated with current, real-time conditions when another activity is selected.
NOTE: Traffic information will vary based on the map providers data availability which may not be available in all countries/areas/states/provinces/localities. Please check the map providers website for data availability. When traffic data is available the system will use the most recent information available from the map provider which may not always be current.
Steps to Enable
To set up real-time traffic updates:
- Log into Oracle Field Service Cloud Application.
- Navigate to the Configuration page.
- From the Configuration page, click User Types.
- Select the User Type.
- Under Permissions, select Use Real-time Traffic Data option.Click Save.
Key Resources
Currently, you can define resource start, end and home locations for each weekday. With the release 18C, you can define start, end and home zone locations for a specific day using the new "Override daily locations" section on the Mobility resource management screen. When configured, the Override Daily Locations will be used across the entire system including bulk, immediate, and urgent routing. Temporary locations older than 90 days are automatically deleted from the system.
Example of the Override Daily Location screen:
You can add, edit, and cancel daily location overrides. To do this, follow these steps:
- In Mobility, click the navigation menu and click Resources.
- Select the Resource for which you want to update the locations.
- Click the Locations tile.
- Go to the Override Daily Locations section.
- To add an override, click the plus icon. The Override Daily Location dialog appears.
- Select the start location, end location, and home location.
- Select the date for which you want to override. You can select any date up to 1085 days in the future.
- Click Submit.
- To edit an override, click on it and change the details in the popup screen.
- To cancel an override, click the minus icon.
NOTE: Location Override updates are not available using an API in the release.
Steps to Enable
No steps are required to enable this feature.
Key Resources
Reports and Dashboards Usability Improvements
With 18C, the functional flow of reports and dashboards has been enhanced to improve the usability experience for Oracle Field Service Cloud Core Application users (see Unified Core Manage and Mobility).
This feature allows you to perform the following:
- Configure dashboards in the Oracle Field Service Cloud Mobile app. The Main menu Dashboards in the mobile app serves as the single location to access Oracle Field Service Cloud reports, Oracle Field Service Cloud dashboards, and other application dashboards embedded in Oracle Field Service Cloud.
- Add Dashboard pages. You can now customize dashboard pages by arranging the available reports and dashboard in multiple tabs based on your preferences
- Configure predefined dashboards. Predefined dashboards are ready to use dashboards for a user configured by another user. You can now configure predefined dashboards for a specific user type so that all the users in that user type can view this dashboard pages by default in dashboards.
- Configure available reports for a user type: You can now configure available reports or dashboards for a user type. Based on the configuration users in that user type will be able to see reports and dashboards in their available reports.
About Dashboard Charts and Reports in Core Application
Dashboard Charts:
Dashboard charts are graphical representation of a report. A user can configure a dashboard tab and drag the required chart icon from the Available reports menu and drop it inside a dashboard tab then the chart will display the details of the report accordingly.
Users will be able to remove a chart from a dashboard page using the X button in the upper right hand corner of the report.
Users can click the Options icon to display the configurable parameters for the Dashboard. In case of predefined dashboards charts, these settings are configured at the time of creation and users who view these predefined dashboards cannot modify these settings.
Standard Reports:
Standard reports are represented as a tile in a dashboard tab as shown below. User can configure a dashboard tab and drag the report icon from the Available reports menu and drop it inside a dashboard tab. Reports will be represented with standard report icon and name in Available reports menu.
The report will be displayed with a description of that report in the dashboard tab along with a standard icon as follows:
Standard Report
While configuring a dashboard tab, user can add or remove the report tile from a tab. The Close button will be available while configuring a dashboard. Clicking this button will remove the report from dashboard tab. If the Available reports menu is hidden then the user cannot remove or add reports to the dashboard tab.
Note that the following functionality is not available in the Core Application Dashboards:
- Reports export option
- Print the route option
- Schedule report option
- Report Resource-User association
Steps to Enable
SET UP DASHBOARDS AS A MENU ITEM FOR A USER TYPE
Access to configure available reports in Dashboards in the Core Application is controlled by user types. The user (preferably, Administrator with configuration permission) can grant permissions to access dashboards for a particular user type so that all users in that user type can access the Dashboards menu.
To set up Dashboards as a menu item for a user type:
- Click the Navigation button and select Configuration.
- In the Configuration page, select User Types.
- In the User Types page, select Screen Configuration.
- From the Application screens section, select the Main menu item:
- In the Main Menu context layout, click Add action. The Add menu item dialog is displayed.
- In the Add menu item dialog, select the Dashboard check box and click OK.
- The Dashboards menu item is now added to the Navigation pane. Users can access dashboards and reports from this Dashboards page.
- To navigate to the Dashboards page, click the Navigation button and select Dashboards.
ADD DASHBOARD
You can set up custom dashboards from the Dashboards page. Such dashboards are shown as tabbed pages in the Dashboards page. In this document, the Dashboards tabbed page is referred as dashboard.
NOTE: The Add dashboard action will work only if the Available Reports pane is open.
To add a dashboard:
- Log into Oracle Field Service Cloud Mobile App.
- Navigate to the Dashboards page.
- Click the properties icon.
Properties Pane
-
Select Add dashboard from the drop-down menu.
The Add Dashboard dialog opens:
Add Dashboard Dialog
- Select the New Dashboard option.
- Enter the dashboard tab name to add.
- Click OK.
The Dashboards page shows the newly added dashboard.
Dashboards Page Showing New Dashboard Tab
The Dashboard will be in configure mode by default you can drag & drop reports or dashboard charts from the available reports.
CONFIGURE A DASHBOARD PAGE
You can configure a dashboard tab by selecting the configure current dashboard from the menu.
To configure a dashboard tab page:
- Navigate to the Dashboards page.
- Click the properties icon and select Configure current dashboard from the drop-down menu.
The Available reports pane opens.
You can perform the following tasks:
- Add reports or dashboard charts from the available reports using drag & drop action.
- Remove the reports or dashboard charts already configured by clicking the Close button on the reports or dashboard charts tile.
- Reorder the position of reports or dashboard charts in the dashboard. To do this, select the dashboard item (chart or report) and then drag and drop it to the new location.
NOTE: You cannot add reports or dashboard charts into any dashboard tab once you close the Available reports pane. Similarly, you cannot remove a dashboard chart from a dashboard tab after closing the Available reports pane.
RENAME A DASHBOARD
You may rename a dashboard to any name you wish to use.
To rename a dashboard:
- Navigate to the Dashboards page.
- Click the properties icon and select Rename Dashboard from the drop-down menu.
The Rename Dashboard dialog is displayed:
Rename Dashboard Dialog
- Edit the Name field to the dashboard name you wish to use..
- Click OK.
The Dashboards page refreshes to display the modified dashboard name.
DELETE CURRENT DASHBOARD
You can delete dashboards or reports on the Dashboard.
NOTE: Apply caution when deleting dashboards; once they are deleted, dashboards cannot be retrieved from Oracle Field Service Cloud.
To delete a dashboard tab:
- Navigate to the Dashboards page.
- Select the tab corresponding to the dashboard to delete.
- Click the properties icon and select Delete current dashboardf rom the drop-down menu. The Delete Dashboard dialog appears:
- Click OK to confirm deletion.
The deleted dashboard will not be available in the Dashboards page.
REARRANGE DASHBOARDS
You may want to set the arrangement of how custom tab pages appear in the Dashboards page. You can choose how to display a selected dashboard in the Dashboards page in mobile devices.
To rearrange dashboard tabs in the Dashboards page:
- Navigate to the Dashboards page.
- Click the properties icon and select Rearrange dashboard from the drop-down menu.
The Rearrange Dashboard dialog displays a list of available dashboards.
Rearrange Dashboard Dialog
- Select the tab corresponding to the dashboard you want to move.
- Drag and drop the selected object as needed. The selected object can be moved up or down.
- Click OK.
The Dashboards page shows the selected object in its new position.
CONFIGURE AVAILABLE REPORTS FOR A USER TYPE
Access to configure available reports for a user type in the Core Application is controlled by user types. The user (preferably, Administrator with configuration permission) can grant permissions to add Dashboards as a menu item. To configure available reports for a user type, you would require permissions to access Dashboards from the Configuration page.
To set up Dashboards as a menu item in configuration page for a user type:
- Click the Navigation button and select Configuration.
- In the Configuration page, select User Types.
- In the User Types page, select Screen Configuration.
- From the Application screens section, select the configuration menu item.
- In the configuration menu context layout, click Add action. The Add menu item dialog is displayed.
- In the Add menu item dialog, select the Dashboards check box and click OK.
- The Dashboards menu item is now added in the Configuration page. Users can access dashboards and configure available reports for a user type.
To configure available reports for a user type, navigate to the Dashboards page from the Configuration menu.
When the user opens the Dashboards page for the first time, reports or dashboard charts will not be available for the selected user type as follows:
Default Dashboards Page
You can set the Available reports configuration option to enable reports.
To set the necessary permissions for a list of reports:
- Navigate to the Dashboards page.
- Click the properties icon and select Configure current dashboard from the drop-down menu.
- The Available Reports pane appears as follows:
Available Reports Pane Before Setting Permissions
- Select the progress icon placed next to each report under the Available reports pane to enable it.
Available Reports Pane After Setting Permissions
The selected reports or dashboard charts will be added to the available reports list of that user type.
CONFIGURING PREDEFINED REPORTS
Predefined dashboards are dashboards created by a user for a specific user type - all the users in that user type will be able to see this dashboard tab by default. Access to configure predefined dashboards in the core application is controlled by user types. The user (preferably, Administrator with configuration permission) can grant permissions to configure predefined dashboards for a user type.
To configure predefined dashboards in the Oracle Field Service Cloud core application:
- Make sure that the user has permission to access dashboards from configuration page.
- Navigate to the Dashboards page.
- If the Available Reports pane is not displayed, click the properties icon and select Configure current dashboard from the drop-down menu. When you open the Dashboards page for the first time, no dashboards will be configured.
- You can either click the New Dashboard button or select the menu item to add a predefined dashboard to create a new predefined dashboard.
- You can select the user type from the page header and add relevant reports or dashboard charts to the dashboard to create a predefined dashboard for that user type.
Default Dashboard
Users in that user type will be able to view the predefined dashboard now:
Predefined Dashboard
Only those users that have permission to create predefined dashboard will be able to configure, rearrange, rename or delete predefined dashboards. With predefined dashboards configured for that user type, users can view the dashboard. To view the parameters configured for a dashboard chart, you can click the options icon.
Options Icon
Options configured while creating the predefined dashboard will remain the same for all the users in that user type.
SET A DATE OR RESOURCE FILTER
You can view date and resource as a generic filter for all the charts or reports configured in a dashboard page.
Date filter:
You can select a date from the calendar. The selected date will be applicable for all the dashboards on the Dashboards page. You can choose to see the data for the selected day or for the day before selected from the dashboard.
To select a specific date from the calendar:
- Click the Calendar icon and select a date.
- Charts will display data for the selected month / month before selected/ selected day/ Day before selected.
- When the user drills down a report from the Dashboard page, report details page will displayed based on the selected date. Report details page will display both From date and To date as the date selected from this page by default. You can change these dates from the filter in the Report details page.
Resource filters:
Resource filter can be used for displaying the data of charts at buckets or organizations or at individual resource level. When the user drills down a report tile, the Report Details page will be displayed based on the resource or resource group selected in this page.
My Dashboard:
Existing Dashboard charts selected in the legacy Manage application will be displayed as a new tab "My Dashboard" in Oracle Field Service Cloud application:
- My Dashboard tab will display only existing charts available in legacy Manage application. New charts added to legacy Manage application after upgrade will not be displayed in the My Dashboard tab.
- The user can configure more charts or reports into this tab from the Core application.
Key Resources
ICS as a Channel in Outbound Integration Page
With release 18C, you can view your existing ICS channel configurations from Outbound delivery channels earlier this was available in the configuration page under Users, Security section.You can perform the following tasks:
- You can add, delete and modify ICS channel configurations from Outbound Integration configuration page.
- With release 18C, you can also delete BICS /DBaaS/ICS Channels from Outbound Integration configuration pages.
- View Data transfer success rate, Last updated hour and current configured channels in the Outbound delivery channel
NOTE: To add, delete and modify ICS configurations, you should have the permission to access Outbound Integration.
Steps to Enable
VIEW THE INTEGRATION CLOUD SERVICE CHANNEL
You can view the available channels using the Outbound Integration Channels page.
To view the ICS channel configurations, navigate to the Configuration page and Click Outbound Integration Channels.
Outbound Integration Channels Page
The Outbound Integration Channels page displays a list of available channels.
CREATE AN INTEGRATION CLOUD SERVICE CHANNEL
You can create a new Integration Cloud Service (ICS) channel by using the add channel option on the page.
- Navigate to the Configuration page and Click Outbound Integration Channels.
- In the Outbound Integration Channels page, click Add Channel.
- In the Add Channel dialog, provide the following details to create an ICS channel.
- Channel Type – Select Integration Cloud Service from the drop down list. This field provides the following channel types to add:
- Business Intelligence Cloud Service Access (BICS)
- Database as a Service Access (DBaaS)
- Integration Cloud Service (ICS)
- Name – Enter the channel name to be displayed
- Host – Provide the address of the database server or the name of the host
- User Name– Enter the name of the ICS User
- Password– Provide the password associated with the ICS User
Add Channel Dialog
- Click OK.
The new ICS channel appears in the Outbound Integration Channels page.
New ICS Channel
MODIFY THE CONNECTION DETAILS OF AN ICS CHANNEL
You can add or modify the connection details of an Integration Cloud Service (ICS) channel from the Outbound Integration Channels page.
NOTE: Users who have permission to access ICS channel should be allowed to access Outbound delivery channels to access ICS channel.
- In the Outbound Integration Channels page, select the Integration Cloud Service (ICS) channel to edit.
- Click the Properties icon.
Properties Icon
NOTE: The Properties icon will not be available for Daily Extract Configuration.
- Click Modify.
Modify Options for ICS Channel
- In the edit dialog, modify the values in the following fields as necessary and click OK:
- Name – Enter the channel name to be displayed
- Host – Provide the address of the database server or the name of the host
- User Name– Enter the name of the ICS User
- Password– Provide the password associated with the ICS User
- Confirm Password– Retype the password.
- The updated details for the ICS channel are displayed in the Outbound Integration Channels page.
DELETE AN INTEGRATION CLOUD SERVICE CHANNEL
You can delete Integration Cloud Service (ICS) channels from the Outbound Integration Channels page.
- In the Outbound Integration Channels page, select the Integration Cloud Service (ICS) channel to delete.
- Click the Properties icon.
- Click Delete.
- In the delete confirmation dialog, click OK.
- Deleting ICS channel will delete the ICS configurations from Oracle Field Service Cloud.
You can also delete BICS, DBaaS or OAC channels using the Outbound Integration Channels page. Deleting the channel will delete the channel configurations from Oracle Field Service Cloud.
When BICS / DBaaS channel are deleted from Oracle Field Service Cloud Outbound Integration Channels page, all the entities corresponding to that channel configuration will be deleted. This includes deletion of all the configurations in Oracle Field Service Cloud including the tables and columns. However, corresponding tables and columns created in BICS / DBaaS will not get deleted as part of this action. You must manually delete these tables and columns from BICS or DBaaS. If you create a table/column in OFSC with the same name as in BICS /DBaaS then the data transfer from OFSC to BICS /DBaaS will fail.
ICS CHANNEL DETAILS
You can configure Integration Cloud Service (ICS) channels using the Outbound Integration Channels page.
- In the Outbound Integration Channels page, a newly created Integration Cloud Service (ICS) channel appears as follows:
ICS Channel - Data Transfer Not Started
- The status shows that the data transfer has not yet started.
- After data transfer starts for the selected channel, the status displays the time when the last update occurred.
ICS Channel - Data Transfer Details
- Data Transmission Success Rate is the Percentage of successfully transferred data. Data transmission success rate = (total.number of events successfully transferred / total.events selected).
Integration with IoTCS Using OIC
With the release 18C, integration with IoTCS using OIC feature has been introduced to automate the process of dispatching a Technician to a job that needs the attention, for an IoT enabled device.
Earlier, there was a need for certain amount of manual effort whenever a Technician has to attend to an asset. With 18C, wherever a Technician has to attend to the asset, this feature enables capturing the alerts triggered by the asset and creates an Oracle Field Service Cloud (OFSC) activity automatically with the appropriate details. Therefore, the process of scheduling a Technician appointment can be completed with little or no user interference.
This integration includes the following scenarios:
PREVENTIVE MAINTENANCE
- The monitored Asset triggers an alert that it needs to be serviced (for example, regular annual maintenance). The asset also stores information about the SLA (the amount of days after the alert is triggered by which the technician should come).
- The application sends the alert to Oracle Field Service Cloud via OIC.
- The application creates a new activity with asset related information received from IoTCS. It assigns the activity to a predefined "bucket" from where it can be routed to a suitable Technician as and when required.
- The created activity will have the following fields populated from IoTCS:
- Asset Name – Displays the name of the Asset as available in IoTCS
- Asset Description – Displays the description of the Asset as available in IoTCS
- Summary – Displays the summary of the Alert as available in IoTCS
- Severity – Displays the priority of the Activity. For a Maintenance activity, this value is set to 'Low'. For an Outage, it will be set as 'Critical'
- Address– Displays the address of the Activity
- City– Displays the city name as in the Activity address
- Zip/Postal Code– Displays the postal code
- State– Displays the state name as in the Activity address
- SLA End– Displays the SLA end value calculated based on the current date and the value received from IoTCS
- Activity Type – Specifies the Activity type. The default value is Asset Maintenance. You may modify this value if needed
- Resource ID – Specifies the Bucket where the Activity will be created. This is set to the Bucket 'Routing' for this integration; it can be modified as per customer preference.
- Appt Number - Specifies the external Id of the Activity
- Customer Number – Displays the customer number as received from IoTCS
OUTAGE
- If a critical event occurs (for example, an outage), the monitored Asset triggers an alert that it needs to be serviced immediately.
- The critical alert is sent to Oracle Field Service Cloud via OIC.
- The application creates an activity with high severity and asset related information received from IoTCS. It routes the activity to the most appropriate technician immediately. The technician receives a notification that there is a critical activity.
- The created activity will have the fields populated from IoTCS in similar manner as it would be for Preventive Maintenance
- The severity of this activity is set as 'CRITICAL'. Within Oracle Field Service Cloud, Activities with CRITICAL severity will be routed immediately to a suitable Technician on priority.
Critical Severity
ASSET DETAILS SCREEN
Whenever the application assigns an activity, based on alert received from IoTCS, to a technician, the technician can view the device information and key indicators in real time data in Mobility. This information will also be available in the Dispatcher view of Activity details.
Asset Details Screen
This is a point to point integration between IoTCS and Oracle Field Service Cloud and would not involve OIC.
Integration between IoTCS and Oracle Field Service Cloud through OIC configuration is discussed next.
IOT AND OFSC INTEGRATION VIA OIC CONFIGURATION
Process flow during iOT and Oracle Field Service Cloud Integration:
- IoT invokes OIC and sends the alert message with the array of alerts.
- For each alert the information about the asset is retrieved from IoT.
- The integration package for OIC can be imported from the OFSC-OSvC par file.
- The image shows a flow diagram of how the integration between iOT and Oracle Field Service Cloud happens:
OFSC and IOT Integration Process
In the integration flow diagram:
- REST connection name: IoT connection for OFSC
- OFSC connection name: OFSC connection for IoT
- Name of the integration: IoT to OFSC Orchestration
- URL of the REST adapter connection point is: <OIC host>/assetMonitoring/clientapi/v2
- Using alert and asset information OIC creates or updates activity in OFSC.
MAPPED FIELDS IN INTEGRATION
This section discusses the details about the mapped fields in the integration:
- bulkUpdate.updateParameters.identifyActivityBy = "apptNumberPlusCustomerNumber"
- bulkUpdate.updateParameters.ifInFinalStatusThen = "createNew"
- ‘bulkUpdate.updateParameters.ifExistsThenDoNotUpdateFields = resourceId’
- bulkUpdate.activities.resourceId = "routing" (Note: you must configure this value based on the unassigned bucket in OFSC.)
- bulkUpdate.activities.apptNumber = ruleId
- bulkUpdate.activities.activityType = "asset"
- bulkUpdate.activities.customerNumber = affectedObjectId
- bulkUpdate.activities.streetAddress = street
- bulkUpdate.activities.city = city
- bulkUpdate.activities.postalCode = zip
- bulkUpdate.activities.stateProvince = state
- bulkUpdate.activities.slaWindowEnd = newly created activity’s timeOfBooking + amount of days stored in asset's service_delta
- bulkUpdate.activities.severity = severity
- bulkUpdate.activities.summary = description
- bulkUpdate.activities.asset_name = name
- bulkUpdate.activities.asset_description = description
Steps to Enable
You can configure IoTCS Integration using the following procedures:
- Set Up IoT to Enable the Integration:
- Create the device model in the IoT platform
- Set Up the IoT data simulator
- Create and configure assets
- Configure rules
- Set up the application settings in the IoT platform
- Create a new integration cloud service integration in the IoT platform
- Show asset details in Oracle Field Service Cloud by enabling widgets in IoT
- Set Up Oracle Field Service Cloud to Enable the Integration
- Create new activity type for this integration
- Create properties for the new activity type
- Mobility configuration for new activity
SET UP IoT ENABLE THE INTEGRATION
1. Create the Device Model in the IoT Platform:
- Navigate to Devices, Model and create a new Model named "Cell tower" with the following details:
- Name – Enter the value “Cell tower”
- Description – Enter the value “Cell tower model”
- URN – Enter the value “urn:com:oracle:iot:cellTower”
-
Define the attributes for the model:
- signalLevel – Indicates the level of the GSM signal produced by the cell tower. Set the following values:
- Type: Number
- Range: -120.0, -30.0
- Access: No
- Voltage – Specifies the voltage in the power network to which the tower is connected. Set the following values:
- Type: Number
- Range: 0.0, 160.0
- Access: No
- Provide the details for the alert "serviceNeeded". Set the following values:
- Name: serviceNeeded
- Description: Routine service is needed
- Type: Alert
- URN: urn:com:oracle:iot:cellTower:serviceNeeded
- Fields:
- Name: service_needed
- Type: Boolean
- Navigate to Application, Oracle IoT Asset Monitoring Cloud Service, Device Models.
- Select the "Cell tower" by clicking Hand button to use it with the assets.
- Select the "Device Model for System Alerts" by clicking the Hand button to perform the integration between IoT and OFSC with the help of "Alert" object.
- Navigate to Application, Oracle IoT Asset Monitoring Cloud Service, Device Selection and select "Include All"
2. Set Up the IoT Data Simulator:
- Obtain the IoT Data Simulator URL, for example: <your_host>/ds/.
- Define the attributes for the Cell tower simulation model based on the Cell tower device model as follows:
- signalLevel – Indicates the level of the GSM signal produced by the cell tower. The initial value is -70 dB. The function to automatically change signalLevel is: randomInRange(-80.0,-60.0)
- Voltage – Indicates the voltage in the power network to which the tower is connected. The initial value is 110 V. The function to automatically change Voltage is: sinInRange(108.0,112.0)
- Define the configuration for the alert "urn:com:oracle:iot:cellTower:serviceNeeded" supported by a simulation model as follows:
- Name: SEND:serviceNeeded
- Time: 0ms
- Field "service_needed" = true
-
Add one event to the configuration of the simulation model. When the event is triggered, it changes the behavior of the attributes of the virtual device:
- Event name: "EVENT:powerOutage"
- Description: Power Outage
- Voltage = 0.0
- signalLevel = -120.00
- Create three instances of the virtual device based on the simulation model. See the following sample:
Sample Instances of Virtual Device Based on Simulation Model
- After devices are created switch them on.
- Open the IoT platform (URL: <your_host>/ui/) in a Web Browser.
- Navigate to the Devices page, Management and enter the values of Name, Description and GPS coordinates for each of three devices you have created.
3. Configure the Asset
- Navigate to IoT Asset Monitoring CS service, URL: <your_host>/am/), configure asset type and create several assets.
- Open the Assets screen and select the Asset types tab:
Asset Types Tab Icon
- Add a new asset type
- Create a new asset type with the name: cell_tower_type
- Set the default value or specify the allowed values in the following attributes. Define the attributes in the following format <name>: <type>.
- city: Text
- state: Text
- street: Text
- zip: Text
- service_delta: Number
- Address related fields are automatically populated into the Oracle Field Service Cloud Activity when the maintenance is required or an outage occurred.
- service_delta is used to calculate the Service Level Agreement (SLA) for Oracle Field Service Cloud activity. SLA will be set to <timeofbooking of the activity created > + service_delta.
- service_delta is defined in days.
-
Edit an asset type:
- Select the asset type with the name: cell_tower_type and select Modify.
- In the Edit Asset Type dialog, specify the options:
Edit Asset Type Dialog
-
Specify that there should be one device attached to the asset of this type. The name of the device is: cell_tower. The device model is: Cell Tower (the same as defined in step a).
- Create three assets based on the "cell_tower_type one for each virtual device created before.
- Edit an asset:
- Navigate to the Edit Asset dialog.
- In the Edit Asset dialog, specify arbitrary Name and Description. Example for a serial number would be CT389283009823.
NOTE: The only limitation that Name cannot contain any spaces.
Edit Asset Dialog
- Select one device from the menu. The selected device will be linked with the asset.
- Specify the address details for example street, city, state and zip. The address should be located in the same GPS coordinate as the device linked to the asset.
- Navigate to the Map screen and check if you can see the assets on the Map.
- The coordinates of each asset are taken from the coordinates of the corresponding device and not from the asset address.
4. Configure Rules
- Navigate to the IoT Asset Monitoring CS service (URL: <your_host>/am/).
- Open the Assets screen.
- Requirements to create rules:
- Rules set conditions on asset sensor or KPI values.
- When a rule condition is met, the associated alert, warning, or incident is triggered.
- Only alerts can be sent to the integrated system. Hence, alerts are triggered.
- Create two rules as follows:
Rule 1: The first rule will trigger an alert with low severity when an asset notifies that it needs service. When the device that is linked with the asset generates Alert message with urn:com:oracle:iot:cellTower:serviceNeeded then a system alert should be send to the integrated system. This resulting alert is generated by a system build-in device of model "Device Model for System Alerts". To configure the first rule, set the following values:
- Name: Service needed
- Apply to: Asset Type is cell_tower_type
- Condition: Alert = "service Needed - urn:com:oracle:iot:cellTower:serviceNeeded"
- Fulfill when: "All condition apply"
- Generate: "Alert"
- Alert Details:
- Summary: Service is needed for the tower
- Suppression (minutes): 1
- Severity: Low
- Inclusions:
- Source attributes: unchecked
- Context information: unchecked
- Message payload: unchecked
Rule 1 specifies that when a device linked with the asset generates an alert message with urn:com:oracle:iot:cellTower:serviceNeeded then the Device Model for System Alerts model generates an alert and sends it to the integrated system.
Rule 2: The second rule will trigger and alert with critical severity when an outage is identified. For example the outage is reported when the "Voltage" reported by the cell tower is less than 90 Volts. It is possible to set more complex rules. To configure this rule, use the following attributes:
- Name: Outage
- Apply to: Asset Type is cell_tower_type
- Condition: "sensor/cell_tower/Voltage" Less Than 90
- Fulfill when: "All condition apply"
- Generate: "Alert"
- Alert Details:
- Summary: Power outage on cell tower
- Suppression (minutes): 1
- Severity: Critical
- Inclusions:
- Source attributes: unchecked
- Context information: unchecked
- Message payload: unchecked
5. Set up the Application Settings in the IoT Platform
- Navigate to the IoT platform (URL: <your_host>/ui/).
- Open the Settings page.
- In the Trusted CN field, enter the domain of the Oracle Integrated Cloud Services that you use. This value is mandatory to connect from IoT to OIC and it should be provided to configure the integration.
6. Create a New Integration Cloud Service Integration in the iOT Platform
- Navigate to the IoT platform (URL: <your_host>/ui/).
- Open Applications, Oracle IoT Asset Monitoring Cloud Service, Integration.
- In the Create new Integration Cloud Service Integration page, complete the following fields:
- Select the Overview tab and enter OFSC in the Name field.
- Select the Connection tab and enter the following values.
- URL: <OIC host>/integration/flowapi/rest ( e.g. https://icsappspod-icsapplications.integration.dc1.c9dev2.oraclecorp.com/integration/flowapi/rest)
- Authentication: BASIC
- Username: your user name from OIC
- Password: your password from OIC
- Select the Streams tab and enter the following values.
- Message Format: RESystemAlert
- Integration resource URL: /IOT_TO_OFSC_ORCHESTR/v01/createActivity
7. Enable Widgets in IoT Platform to Populate Asset Details Page in Oracle Field Service Cloud
- Navigate to the IoT platform.
- Open the Settings page and navigate to the Security section.
- Under Security section, fill the following fields:
- Allowed Hosts for Syndicated Widgets – Enter the name of your OFSC host in format: https://some_host.com(Put the manage URL of your OFSC instance)
- Allowed Hosts for Cross-Origin Resource Sharing–Enter the same OFSC host as provided in the Allowed Hosts for Syndicated Widgets field.
- The Settings page appears as follows:
IoTSettings Page Showing Security Section
- Save your settings.
SET UP ORACLE FIELD SERVICE CLOUD TO ENABLE THE INTEGRATION
1. Create a New Activity Type for this Integration in Oracle Field Service Cloud
- Navigate to the Configuration page and click Activity Types.
- In the Activity Types page, click Add Group to add a new group.
- In the Add Group dialog, enter the following values:
- Label: asset_gr
- Name: Asset
The Add group dialog shows the values for the new group Asset.
Add Group Dialog
- Click Add.
- Click Add Activity Type to create a new activity type with the following parameters:
- Label: asset
- Name: Asset Maintenance
- Active: checked
- Group: Asset
- Default duration: 48
- Color scheme - copy from other activity
- Under Features, enable the check boxes next to the following fields:
- Teamwork: unchecked
- Multi-day activity: unchecked
- Allow move between resources: checked
- Allow creation in buckets: checked
- Allow reschedule: checked
- Support of not-ordered activities: checked
- Allow non-scheduled: checked
- Allow mass activities: unchecked
- Allow repeating activities: unchecked
The Add activity dialog shows the values for the new activity type Asset Maintenance.
Add Activity Type Dialog
- Click Add to create the new activity type.
2. Set Up Properties for the New Activity Type
- Navigate to the Configuration page and click Properties.
- In the Properties page, add the following properties:
- Properties that hold asset information
- Asset Name
- Property type: String
- Property name: Asset Name
- Property label: asset_name
- Lines count: 1
- GUI: Text
- Asset Description
- Property type: String
- Property name: Asset Description
- Property label: asset_description
- Lines count: 1
- GUI: Text
- Asset Name
- Properties that hold information about the alert
- Summary
- Property type: String
- Property name: Summary
- Property label: summary
- Lines count: 1
- GUI: Text
- Severity
- Property type: Enumeration
- Property name: Severity
- Property label: severity
- GUI: Combobox
- Enumeration values:-
- Critical , CRITICAL
- Low , LOW
- Normal , NORMAL
- Significant , SIGNIFICANT
- Summary
- Properties that hold asset information
- Close the Properties page.
3. Configure Mobility for the New Activity Type
NOTE: The action links will only work on Oracle Field Service Cloud release 18A or greater platforms.
- Navigate to the Configuration page and click Action Management.
- In the Action Management page, create an action link with the following details:
- General tab options:
Edit Action Link Dialog Showing General Tab
- Plugin tab options
- URL: https://<your_iot_host>/commonui/indexWidget.html?app=AM&root=assetDetail&assetDetail={asset_name}
Edit Action Link Dialog Showing Plugin Details Tab
- In the Configuration page, click User Types.
- In the User Types page, select the Screen Configuration tab:
- Add the above created action link Asset details to the context Edit/View Activity in Mobility section.
Screen Configuration Tab Showing Edit/View Activity Action Link
- Drag and drop the actions named Asset details to the palette and give visibility condition as Activity type[aworktype] equals to Asset Maintenance.
- Drag and drop the field Asset Name to the palette. This is a mandatory field. The plug-in will work only if this field has a value.
- Other fields like Asset ID, Asset Description, Summary, Severity are also can be added to this context with visibility flag as Activity type[aworktype] equals to Asset Maintenance.
Define Urgent Activity Condition for the New Activity Type
- Navigate to the Configuration page and click Business Rules.
- In the Business Rules page, locate the Activity priority field.
- In the Activity priority field, enter the following field values:
- Property to define priority: Severity[severity]
- Urgent activities have the following values for the property: Critical
- Normal activities have the following values for the property: Low,Normal,Significant
- Create a routing plan with Run schedule Immediately for Urgent activities. This is used to assign the activities meeting the defined criteria as they appear in the bucket. Once immediately is selected, two options of activity selection appear.
Create Routing Plan Screen Showing Run Schedule Immediately With Urgent Activities
Select the for Urgent Activities option. (Routing will assign the activities matching the 'property+value' combination defined in the Activity Priority field).
- Activate the Routing plan.
Tips And Considerations
Oracle Field Service Cloud - Oracle Analytical Cloud Service (OAC) Integration
The 18C release provides Oracle Analytical Cloud Service (OAC) users capabilities to explore and perform collaborative analytics for users and their enterprises, built on a high-performance platform with flexible data storage. With Oracle Field Service Cloud and OAC integration, you need not navigate between applications to access data; you can use Oracle Field Service Cloud as the single location to make use of Oracle Field Service Cloud data and create analytical reports in OAC. You can also embed any OAC report or dashboard in Oracle Field Service Cloud pages so that user who has access privileges can see such reports/dashboards in Oracle Field Service Cloud directly.
NOTE: You must have a subscription to Oracle Analytical Cloud Service to use this integration.
You can add any parameter values to the reports/dashboards embedded into Oracle Field Service Cloud. The reports / dashboards will be refreshed based on these parameter values.
Steps to Enable
Following are the steps to configure Oracle Field Service Cloud - Oracle Analytical Cloud Service (OAC) integration:
To add a new channel for OAC in Oracle Field Service Cloud
- Navigate to the Configuration page and select Outbound Integration Channels.
- In the Outbound Integration Channels page, click Add Channel.
- In the Add Channel dialog, select Oracle Analytical Cloud Service from the Channel Type drop-down list.
- In the Name field, enter the channel name to be displayed.
- In the URL field, specify your Oracle Analytics Cloud URL without the /analytics or /va URL extension. For example, https://<My OAC>.oraclecloud.com.
- In the Service Name field, provide the network service name of the database.
- In the User Name field, enter the name of the OAC User.
- In the Password field, provide the password associated with the OAC User.
- In the Confirm Password field, retype the same password.
- Click OK.
The Outbound Integration Channels page displays the newly added OAC channel:
OAC Channel
Users can transfer data in near real-time or daily once based on the configuration set against an entity. All the fields supported for Oracle Business Intelligence Cloud Service (BICS) transmissions will be available for Oracle Analytical Cloud Service (OAC) data transfer. Steps to add fields into the OAC channel are similar to that of BICS/ DBaaS channel.
EMBED OAC URLS INTO ORACLE FIELD SERVICE CLOUD
Oracle Field Service Cloud users can embed OAC reports, visualizations, and dashboards that they created in Oracle Analytical Cloud Service.
To embed reports or Dashboards:
- Whitelist the Oracle Field Service Cloud domain in OAC.
- Find the OAC URL of the object you want to embed.
- Sign in to Oracle Field Service Cloud. Embed the Oracle Analytical Cloud Service content inside action link and use the copied URL.
EMBED ORACLE ANALYTICAL CLOUD REPORTS OR DASHBOARD INTO ORACLE FIELD SERVICE CLOUD
To get access for the Oracle Analytical Cloud Service reports or Dashboard, users must whitelist the Oracle Field Service Cloud: domain name in OAC.
NOTE: Only administrators have the privilege to add safe domains to the whitelist.
Users can log into Oracle Analytical Cloud Service and add the domain name associated with Oracle Field Service Cloud to the “Allow embedding in” whitelist for OAC.
To allow embedding in Oracle Analytical Cloud Service:
- Click Console.
- Click Safe Domains.
- Click Add Domain under Allow embedding in.
- Type the name of Oracle Field Service Cloud domain. For example, allow embedding in *.etadirect.com.
FIND THE URL OF THE OBJECT FROM OAC INSTANCE YOU WANT TO EMBED.
The user will have to select the URL of the dashboards which he wishes to embed into Oracle Field Service Cloud
- Go to the Catalog and open the object.
- Copy the URL displayed in the browser. The URL will look similar to this
http://example.com/analytics/saw.dll?Dashboard&PortalPath=%2Fshared%2FSales%2F_portal%2FQuickStart&page=Top%20Products
EMBED ORACLE ANALYTICAL CLOUD CONTENT INTO ORACLE FIELD SERVICE CLOUD
- Make sure user have permission to access dashboards in Oracle Field Service Cloud app. Details are available here
- Log in to Oracle Field Service Cloud app
- Click the Navigation button and select Dashboards.
- Click the properties icon and select Add Dashboard from the drop-down menu.
The Add dashboard dialog opens.
Add Dashboard Dialog Showing Embedded Dashboard Option
- Select the Embedded dashboard option.
- Complete the following fields and click OK.
- Name - Enter the name of the tab to be displayed on the Dashboards page.
- URL - Provide the URL that to be embedded in the Dashboard tab. Once added this URL will be added as a new tab in the Dashboards page. You can now add dashboard URL of any other analytical applications in this page. Data will be displayed in dashboards as a new tab with the name provided. You will not be able to add or remove charts or reports into this page.
ADD PARAMETER VALUES IN EMBEDDED REPORTS
You can add parameter values in the embedded reports and display the same in the Oracle Field Service Cloud page created. To achieve this, you must
- Add parameter values as placeholders in the plugin URL.
- Create the corresponding filter in OAC reports/dashboards.
For example, a user wants to add a resource tree into the embedded OAC reports:
- Add resource tree parameters {pid} in the OAC URL as follows:
https://example.com/analytics/saw.dll?Go&Path=%2Fcompany_shared%2FOFSC-DEMO%2F_portal%2FOFSC%20Sample%20Dashboard&p0=1&p1=eq&p2="provider"."pid"&p3="{pid}" https://example.com/analytics/saw.dll?Go&Path=%2Fcompany_shared%2FOFSC-DEMO%2F_portal%2FOFSC%20Sample%20Dashboard - OAC dashboard URL
- p0 represents the no of parameters included in the URL.
- p1 indicates the operators, for example eq.
- p2 stands for the column name in OAC
- p3 indicates the value of the attribute to be passed.
- Create a filter in the OAC report / dashboard with PID. Note, for displaying the dashboard for both parent and leaf nodes, the URI requires two PID placeholders as follows:
https://testbi723-usoracle11148.analytics.us9.mycloud.oraclecorp.com/analytics/saw.dll?Dashboard&PortalPath=%2Fcompany_shared%2FOFSC-DEMO%2F_portal%2FOFSC%20DEMO%20Dashboard&Action=Navigate&P0=2&P1=eq&P2=PROVIDER.RESOURCE_ID&P3={pid}&P4=eq&P5=PROVIDER.PARENT_RESOURCE_ID&P6={pid}&options=mdr
- P0- No.of parameters to pass, in this case, two,
- P1- Operation btw first parameter set, "eq" stands for equal to
- P2- Column name in the format of table name column name, PROVIDER.RESOURCE_ID - for considering resource owned activity in reports
- P3- Value , the placeholder {pid}
- P4 - Operation btw Second parameter set,
- P5 - PROVIDER.PARENT_RESOURCE_ID - for aggregating child resources owned activities in reports
- P6- Value, the placeholder {pid}
SSO CONFIGURATION
To avoid the administration overhead of multiple logins in Oracle Field Service Cloud and Oracle Analytical Cloud Service cross-domain SSO for Oracle Field Service Cloud and Oracle Analytical Cloud Service can be configured.
To configure SSO in Oracle Field Service Cloud, use these steps
- Log into Oracle Field service Manage interface.
- Click Configuration.
- Click Login Policies.
- Click Add New button. The Add Policy dialog is displayed.
- Complete the following fields and click Add:
- In the Authenticate using field, enter the SAML value.
- In the IdP Metadata XML field, enter the name of the Metadata file provided by IdP.
- In the label field, enter the unique identifier label. This will be used for the SSO login screen.
- In the Oracle Field Service Cloud Metadata XML field, download and update the SAML Idp metadata file.
- In the Policy name field, enter the policy name assigned to this policy.
- In the Specify SAML IdP field, enter the Upload metadata XML.
To configure SSO in Oracle Analytical Cloud Service, use these steps:
- You must be logged onto Oracle Analytical Cloud Service as an administrator
NOTE: Ensure that the username in Oracle Field Service Cloud matches the username in Oracle Analytical Cloud Service. Otherwise, update the user which want enable SSO to keep in that way under User.
- To enable SSO, click SSO Configuration and then click Configure SSO.
- Select Import IP metadata option. Browse and select the same SSO file that was used for Oracle Field Service Cloud from SAML IDP Provider.
- In SSO protocol field, enter HTTP POST.
- In the User Identifier, custom attribute field, enter uid.
- Export Oracle Analytical Cloud Service Provider metadata and update the SAML IDP provider in Oracle Field Service Cloud.
- Click Test and then select Start SSO. When you enter the administrator user name and password, you should see the successful login session message.
- Once it is successful, click Enable SSO.
NOTE: Oracle Analytical Cloud Service instance should be active while accessing the embedded reports in Oracle Field Service Cloud. If not active, a blank page will be displayed with error details.
- Users can add any parameter value to the reports/ and dashboards embedded into Oracle Field Service Cloud. The reports or dashboards will be refreshed based on these parameter values.
Key Resources
Using Street Level Routing (SLR) Data in Routing
The 18C release adds the Street Level Routing (SLR) capabilities to routing. This new functionality can be configured per routing plan and when enabled, it will obtain Street Level travel data from the map provider (for example, Google Maps) and use that data during optimization.
HOW TO USE
Prerequisite: Requires a subscription to Oracle Field Service Cloud Enterprise and Oracle Field Service Standard Map Cloud Service with Google Maps or Oracle Field Service Standard Map Cloud Service with Baidu Maps. Oracle Maps availability is planned for a future release.
To enable SLR functionality for a routing plan:
- Go to Routing, Routing Plans.
- Choose a Routing Plan.
- Select Modify from the menu.
- Under the Run Schedule tab choose "Use SLR to obtain travel data" and adjust the time limit if needed.
When SLR is enabled in the routing plan:
- Two additional time limit options are available: 40 minutes and 60 minutes. These new times enable the SLR data to be obtained for use in the routing engine.
- The selected time limit is the maximum time that will be spent on obtaining the SLR data and running the routing plan.
- New Travel Time options will be available. One of the optimization goals should be selected.
- Optimize by time (that is, generally prefer fastest routes for every travel and minimal overall travel time) or
- Optimize by distance (that is, generally prefer shortest routes for every travel and minimal overall travel distance).
Regardless of the optimization goal that is used, you could also limit the maximum travel time and travel distance for every travel (either to first activity or from last activity or between two activities). The maximum values for the Avoid travel longer than field are 1440 minutes and 900 miles.
Routing Summary Screen:
A new line shows the Average Mileage per route for travel-enabled activities (either Average Mileage or Average Kilometer, depending of the units chosen) in the routing summary screen.
Routing Report:
A new line shows the method of distance and/or time estimation for travel to each activity in the routing report. The following methods of travel estimation are available:
Travel Estimation Method |
Description |
---|---|
Not estimated | No travel estimation was done; this it a rare outcome to be seen in the report. |
Using Defaults | Using company defaults (see Default travel average time in minutes under Configuration -> Statistics) |
Statistics | Estimated using company travel statistics |
Airline Distance | Estimated as airline distance using Airline distance speed in km/h parameter from Configuration -> Statistics) |
Airline Distance and Statistics | Estimated as weighted average of value from company travel statistics and airline distance (see Coordinate calculation weight under Configuration -> Statistics) |
Manual Adjustment | Manually adjusted via interface |
Street Level Routing | Time and distance were obtained from the Street Level Routing provided |
External Adjustment | Adjusted via API |
Same Location | No travel is needed as both activities takes place in the same location |
Routing Comparison:
A new line shows the Average Mileage per route for travel-enabled activities (either Average Mileage or Average Kilometer, depending on the units chosen) in the routing comparison screen.
Steps to Enable
No steps are required to enable this feature.
---

Copyright © 2018, Oracle and/or its affiliates. All rights reserved.
This document is provided for information purposes only, and the contents hereof are subject to change without notice.This document is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or fitness for a particular purpose. We specifically disclaim any liability with respect to this document, and no contractual obligations are formed either directly or indirectly by this document. This document may not be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without our prior written permission.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation.All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
