Skip to content

Schema Reference

The application schema is used to configure the objects returned from a connector.

Note

  • The Account Schema tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as Entitlement or Multi-Valued. Refer to Managing Source Account Schemas for more information.

  • The schema attributes that are not present by default must be defined as strings if not specified.

The Oracle HCM Cloud connector uses the following default correlation and object configurations.

Default Account Schema

Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location.

The set of account attributes each source stores and how they're organized is known as the account's schema. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to Managing Source Account Schemas for more information.

Default Account ID

SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as account IDs.

Caution

Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts.

To resolve issues caused by changing account IDs, reconfigure them to their default values.

The following table lists the default account IDs for this connector:

Account ID Schema Object Type
PERSON_NUMBER Account

Default Account Attributes

The Oracle HCM Cloud connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.

Attribute Name Description
PERSON_NUMBER Unique identifier for the person. This is an Account ID which must not be changed.
HIRE_DATE The hiring date of the person.
TERMINATION_DATE Termination date of the person.
PERIOD_OF_SERVICE_ID Unique identifier for the person WorkRelationship.
WORKER_TYPE Type of the person, for example Employee/Contingent.
WORKRELATIONSHIP_PRIMARY_FLAG Flag indicating whether WorkRelationship is primary or not.
ASSIGNMENT_ACTION_CODE Primary assignment's action code of the person. For example, HIRE
ASSIGNMENT_EFFECTIVE_START_DATE Primary assignment effective start date of the person.
ASSIGNMENT_EFFECTIVE_END_DATE Primary assignment effective end date of the person.
ASSIGNMENT_PRIMARY_FLAG Flag indicating whether assignment is primary or not.
ASSIGNMENT_STATUS Primary assignment status of the person.
WORK_EMAIL Work Email for the person

Note

The connector internally generates a JSON path for the above attributes where the PrimaryFlag is set to true. If a customer wants to aggregate data where the PrimaryFlag is false, they should add a JSON path mapping for that specific attribute.

Additional Account Attributes

Note

These attributes are calculated attributes based on the mandatory account schema and should not be part of the HCM Export Files.

Attribute Name Description
FUTURE_WORKRELATIONSHIP_START_DATE The future hire date of the person.
FUTURE_ASSIGNMENT_START_DATE The future assignment start date of the person. This attribute is only supported as part of full aggregation.
FUTURE_WORKRELATIONSHIP_END_DATE The future termination date of the person.
FUTURE_ASSIGNMENT_ACTION The future action of the person. This attribute is only supported as part of full aggregation.

Note

You must manually add these attributes in the account schema.

Additional Attributes of REST API

The Oracle HCM Cloud connector supports aggregation of additional attributes from the Oracle Fusion HCM Workers API during get object operation.

Complete the following steps to add additional attributes of rest API:

  1. Add the attribute name in the Account Schema.
  2. Apply the appropriate JSON path query for the attribute. Refer to JSON Path Mapping to add JSON path for attribute mapping.

  3. Using REST, ensure the attributes are also added in the Workers API Additional Fields.

    Key: connector_workersAPIAdditionalFields

    Note

    Values should be valid JSON path.

    Case 1: Suppose you want to aggregate AssignmentName using the JSON path given below:

    workRelationships..assignments[?(@.PrimaryAssignmentFlag==true && @.AssignmentType=='E' && @.PrimaryFlag==true)].AssignmentName

    In this scenario, you need to mention AssignmentName as well as those attributes on which JSON path conditions are applied, (such as PrimaryAssignmentFlag, AssignmentType, and PrimaryFlag) in the Workers API Additional Fields as shown below:

    workRelationships.assignments:AssignmentName,PrimaryAssignmentFlag,AssignmentType,PrimaryFlag

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.