Input 

Document

• Min: 0

• Max: 1

• Mapper

• Script

• Router

Each input document offers details associated with the data required from the target Oracle HCM instance.

Output

Document

• Min: 0

• Max: 1

• JSON Splitter

• JSON Formatter

• Join

Each output document contains data retrieved from the Oracle HCM instance.

If the Snap fails during the operation, it sends an error document to the error view containing the fields error, reason, resolution, and stacktrace. However, you must enable the Error view to view the error document.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

• Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

• Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

• Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Field Name

Label*

Default Value: Oracle HCM Read
Example: Get Details

String

Specify a unique name for the Snap.

Version*

Default Value: N/A
Example: 11.13.18.05

String/Expression/Suggestions

Specify the Oracle HCM instance version. The suggestions list retrieves all available versions.

Resources name

Default Value: N/A
Example: absences, elementEntries, workers

String/Expression/Suggestions

Specify or select the Oracle HCM resources (Tasks). The suggestions list retrieves all available resources based on the selected version.

Endpoint*

Default Value: N/A
Example: /workers

String/Expression/Suggestions

Specify or select the Oracle HCM endpoint. The suggestions list retrieves all available endpoints based on the selected resources. For example if “worker” resource is selected, the suggestions that populate are:

• /workers

• /workers/{id}

• /workers/{id}/child/addresses/{id}

Query parameters

Use this field set to add query parameters to your request.

Query parameter

Default Value: N/A
Example: id

String

Specify the name of the query parameter.

Query parameter value

Default Value: N/A
Example: $widget.id

String/Expression

Specify the value that you want to assign to the parameter.

Header parameters

Use this field set to create the HTTP header key-value pairs.

Header parameter

Default Value: N/A
Example: content-type

String

Specify the name of the HTTP header.

Header parameter value

Default Value: N/A
Example: application/json

String/Expression

Specify the value to assign to the HTTP header.

Use pagination

Default Value: Deselected

Checkbox

Select this checkbox to enable pagination. If you deselect this checkbox the pagination settings are hidden.

Start page

Default Value: 1
Example: 5

Integer

Appears when you select the Use pagination checkbox.

Specify the value of the page from which the pagination must start.

Records per page

Default Value: 100
Example: 50

Integer

Appears when you select the Use pagination checkbox.

Specify the number of records you want on a page.

Number of pages

Default Value: 0
Example: 50

Integer

Appears when you select the Use pagination checkbox.

Specify the number of pages you want to retrieve.

• If this value is 0, then all records are retrieved from the starting page.

• if this value is greater than 0, then it retrieves all consecutive pages from the starting page to the entered value. Records per page are controlled by the Records per page field.

Snap Execution

Default Value: Validate & Execute
Example: Validate & Execute

Dropdown list

Select one of the following three modes in which the Snap executes:

• Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

• Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

• Disabled: Disables the Snap and all Snaps that are downstream from it.