Set Up the Oracle HCM Cloud Accelerator for Oracle Field Service
This topic shows you how you can set up the Oracle HCM Cloud accelerator for Oracle Field Service.
Step 1: Prerequisites for the Accelerator
- Create a custom property for the Resource entity in Oracle Fusion Field Service. The property name must be "HCM_Person_Id". The Person Id from Oracle HCM Cloud is persisted in Oracle Fusion Field Service to map the data between Oracle HCM Cloud and Oracle Fusion Field Service.
- Create buckets in Oracle Fusion Field Service under the org unit in which you're planning to add the resources from Oracle HCM Cloud. Also, update the same bucket ID in the Oracle Integration lookup table - "ORCL-BRT-HCM-OFS_RESOURCE_BUCKET_MAPPING". If there's no data in this lookup configuration, the accelerator creates all the employees under the business units configured as part of the integration.
- Make sure that the Oracle Enterprise Scheduler (ESS) job "Maintain Party and Location Current Record Information" is scheduled.
Details for Creating HCM_Person_Id in Oracle Fusion Field Service
You must create a String type of property from the page. Use these details:
| Property Name | Property Label | Property Type | Entity | GUI |
|---|---|---|---|---|
| HCM Person Id | HCM_Person_Id | String | Resource | Text Element |
Ensure that the property label and type match exactly. If they don't match, the integration flows show an error when trying to activate, as they try to map to a property that doesn't exist.
Step 2: Oracle HCM API Duty Roles, Privileges and Data Security
Assign the required roles mentioned in https://docs.oracle.com/en/cloud/paas/integration-cloud/hcm-adapter/prerequisites-creating-connection.html#GUID-F2FB3123-1413-4101-BB66-500215959084 to the integration user to use the Oracle HCM Cloud adapter.
You must configure more duties as given in this table.
| Duty Role | Description |
|---|---|
|
Use REST Service - Public Workers Read Only |
You can call the GET method associated with the Public Workers REST Service. |
|
Use REST Service - User Accounts Read Only |
You can call the GET method associated with the UserAccounts REST Service. |
|
Use REST Service - Worker Availability Read Only |
You can call the GET method associated with the worker availability REST service. |
|
Use REST Service - Talent Person Profiles Read Only |
You can call the GET method associated with the Talent Person Profile REST Service. |
|
SOA operator Role |
The SOA operator role. |
You must configure more data security policies as given in this table.
| Business Object | Policy Description | Policy Store Impelmentation |
|---|---|---|
|
Public Person |
This entity contains static biographical information about a person. |
Privilege: Search Person Deferred; View Worker Contact Portrait Card; View Public Skill; View Person Deferred Data; View Person Career Planning; View Person Skills and Qualifications; Resource: PER_PERSONS |
|
Public Assignment |
This is a view on the current PER_ALL_ASSIGNMENTS_M table |
Privilege: View Person Deferred Data; View Person Skills and Qualifications; View HCM Person Public Note; Search Person Deferred; Resource: PER_ASSIGNMENTS_V |
|
Person Work Terms Assignment |
This entity stores Work terms and Assignment records for Employee, Contingent Worker, Nonworkers, Pending Worker. Discriminator attribute for various types of records is Assignment Type. |
Privilege: View Worker Availability; View Worker Calendar; Resource: PER_ALL_ASSIGNMENTS_M |
|
User |
Defines the parent entity within the User business object and holds the current details of a user. Only one record is maintained per user. |
Privilege: View User Accounts; Resource: PER_USERS |
Step 3: Configure Accelerator Connections
You must configure the below connections before you use the accelerator.
- Oracle HCM Adapter Connection: Click the Connection Name
- Oracle HCM Adapter Connection and configure the connection as shown in the
screenshot:
- Oracle HCM OFS Adapter Connection: Click the Connection
Name - Oracle HCM OFS Adapter Connection and configure the connection as shown
in the screenshot:
- Oracle HCM OFS REST Connection: Click the Connection Name
- Oracle HCM OFS REST Connection and configure the connection as shown in the
screenshot:
- Oracle HCM REST Connection: Click the Connection Name -
Oracle HCM REST Connection and configure the connection as shown in the
screenshot:
Step 4: Configure the Integration Variables and Properties
You must edit some integration variables lookup based on your environment configuration.
| Integration Variable | Sample Value | Purpose |
|---|---|---|
| HCM_BusinessUnitNames | Supremo US Business Unit | Required. The business unit used to filter out the employees. Supports multiple business units separated by commas. |
| HCM_JobCodes | JOB0001 | Required. The job code used to filter out the mobile workers. Supports multiple job codes separated by commas. |
|
OFS_Default_Timezone |
Eastern |
Optional. Required only if OFS_SkipDefaultBucketCreation is false or empty or not provided. Time Zone value from Oracle Fusion Field Service that needs to be associated with the default bucket getting created. (for example, "America/New_York"). |
|
OFS_OrganisationTypeLabel |
OU |
Optional. Required only if OFS_SkipDefaultBucketCreation is false or empty or not provided. The organization type value from Oracle Fusion Field Service that needs to be associated with the default bucket getting created |
|
OFS_OrganisationID |
SUNRISE | Optional. Required only if OFS_SkipDefaultBucketCreation is
false or empty or not provided. The parent organization's external id under which the default bucket is created |
|
OFS_Default_Language |
en |
Optional. Required only if OFS_SkipDefaultBucketCreation is false or empty or not provided. The language for the default bucket. |
|
OFS_DefaultActivityType |
ResourceExceptions |
A new activity type is created if the value configured isn't already present in Oracle Fusion Field Service. Resource exceptions and half-day leaves from Oracle HCM Cloud are created as internal activities of type mapped under OFS_DefaultActivityType. |
|
OFS_SkipDefaultBucketCreation |
true |
true: It skips any default bucket creation in Oracle Fusion Field Service, thus halting employee syncing if no matching Oracle Fusion Field Service bucket is found in the lookup table ORCL-BRT-HCM-OFS_RESOURCE_BUCKET_MAPPING. false: If no matching Oracle Fusion Field Service bucket is found in the lookup table ORCL-BRT-HCM-OFS_RESOURCE_BUCKET_MAPPING, it creates default Oracle Fusion Field Service buckets with the name being the name of the HCM Business Unit and the external ID as the HCM Business Unit ID. Later, it syncs the corresponding employees to the new bucket. |
Integration Properties
| Integration | Property Name | Default Value | Purpose |
|---|---|---|---|
| Oracle HCM OFS Party Sync | noOfPastDays | 2 | New hires with start date >= current date - 'noOfPastDays' are synced to OFS. |
| Oracle HCM OFS Worker Availability Helper | noOfDays | 10 | Resource availability from current date to current date + 'noOfDays' is synced to OFS. |
You can modify the integration properties by following the navigation shown in these screenshots:
Step 5: Configure the Lookups
Lookups help you map similar entities of Oracle Fusion Field Service and Oracle HCM Cloud that have different values, for example the job code with "Field tech" can be treated as a "Mobile Worker" in Oracle Fusion Field Service. There are five lookups in the Oracle HCM Cloud-Oracle Fusion Field Service integration. Based on the nature of your businesses, the values can be different. You can configure these lookup tables according to your business needs and run them in Oracle Integration.
- Sign in to Oracle Integration.
- On the Home page, click Integrations > Lookups.
- Click the name of the lookup that you want to configure and click the '+' icon to add more values. These lookups are available in the accelerator:
| Oracle Integration Lookup | Oracle HCM Cloud Property | Oracle Fusion Field Service Property | Description |
|---|---|---|---|
| ORCL-BRT-HCM-OFS_EMPLOYEE_RESOURCE_MAPPING |
<<HCM Job Code>> For example: TECHNICIAN001 |
<<Resource Role>> (Required) For example: Field resource Manager/Dispatcher/Admin <<User Type>> (Required) For example: manager <<Resource Type>> (Optional, Only for syncing mobile workers) For example: TECH <<Visible Resource>> (Optional, Only for syncing Manager/Dispatcher/Admin) For example: DUMMYBUCKET |
Map the Oracle HCM Cloud job code with Oracle Fusion Field Service properties such as Resource Role, Resource Type, User Type, and Visible Resource. To sync a mobile worker, provide the Resource Role as 'Field Resource'. For syncing a non-mobile worker such as a manager or supervisor, provide the Resource Role as 'Manager/Dispatcher/Admin'. Visible Resource is applicable only for the 'Manager/Dispatcher/Admin' role. It expects the external ID of the default visible resource. |
| ORCL-BRT-HCM-OFS_NONWORKING_REASON |
<<Absence type in HCM >> For example: Sick |
<<Non working reason in OFS>> For example: illness |
Map the Oracle HCM Cloud absence type such as Sick Leave, Earned Leave, Casual Leave with Oracle Fusion Field Service non-working reasons. For calendar events or holidays from Oracle HCM Cloud, the Oracle HCM Cloud value to be configured in the lookup is 'CAL' and the corresponding Oracle Fusion Field Service non-working reason can be mapped. |
| ORCL-BRT-HCM-OFS_RESOURCE_BUCKET_MAPPING |
<<HCM BU and Department in the format of BusinessUnit#DepartmentName>> For example: Supremo US Business Unit#JOB001 |
<<External ID of OFS Service Bucket>> For example: ServiceBucket |
Map the HCM BusinessUnit#DepartmentName (business unit name and the department name concatenated with a delimiter #) to the resource ID of the Oracle Fusion Field Service bucket. The prerequisite for this lookup is that the Oracle Fusion Field Service bucket mentioned in the lookup should be available in Oracle Fusion Field Service with the given resource ID and with the required timezone and language. For example: the Oracle HCM Cloud business unit name is "Supremo Business Unit" and the job code for the mobile workers is "JOB0001". If those mobile workers need to be sync'd to an Oracle Fusion Field Service bucket with resource ID "ServiceBucket", then the configuration will look like: HCM_BU_DEPARTMENT → Supremo US Business Unit#JOB0001 OFS_BUCKET_EXTERNAL_ID → ServiceBucket Depending on the value of the lookup variable OFS_SkipDefaultBucketCreation from the lookup table ORCL-BRT-HCM-OFS-CONFIG, it will either create a default bucket or skip the employee if no match is found in this lookup. If OFS_SkipDefaultBucketCreation is set to false and there is no match available in the lookup for an employee's business unit and department, then an organization unit will be created. The resource ID will be set as the Oracle HCM Cloud business unit ID, and the name will be the Oracle HCM Cloud business unit name. All resources will be placed under the newly created organization unit/bucket. |
| ORCL-BRT-HCM-OFS-CONFIG | This lookup holds the criteria and default values used in Oracle HCM Cloud to Oracle Fusion Field Service integrations. | ||
|
ORCL-BRT-HCM-OFS_SUBINT_VERSION |
This integration provides the capability to call a different version of a sub-integration that isn't part of the current package. It accepts the integration identifier as the key and version of the sub integration to be mapped as the value. If nothing is given, it will take the sub-integration from the same package. | ||
| OFS_Enable_HCM_Eligibility_Profile_Flag | Allows the accelerator to use the criteria which is defined in the HCM eligibility profile. By default, the standard accelerator sets the 'OFS_Enable_HCM_Eligibility_Profile_Flag' value to empty/false, which turns off the Eligibility Profile criteria and fall back to the earlier functionality where HCM_BusinessUnitNames and HCM_JobCodes were considered as the filter criteria. |