Oracle HCM Read

This Snap reads records from the Oracle HCM instance.

Supported Accounts

Snap views

Type Description Examples of upstream and downstream Snaps
Input Each input document offers details associated with the data required from the target Oracle HCM instance.
Output Each output document contains data retrieved from the Oracle HCM instance.
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description
Label*

String

Specify a unique name for the Snap.

Default value: Oracle HCM Read

Example: Get Details

Version*

String/Expression/ Suggestion

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

Default value: N/A

Example: 11.13.18.05

Resources name

String/Expression

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

Default value: N/A

Example: absences, elementEntries, workers

Endpoint*

String/Expression/ Suggestion

Specify or select the Oracle HCM endpoint. The suggestions list retrieves all available endpoints based on the selected resources.

Default value: N/A

Example: /workers

Query parameter

String

Specify the name of the query parameter.

Default value: N/A

Example: id

Query parameter value

String/Expression

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

Default value: N/A

Example: $widget.id

Header parameter

String

Specify the name of the HTTP header.

Default value: N/A

Example: content-type

Header parameter value

String/Expression

Specify the value to assign to the HTTP header.

Default value: N/A

Example: application/json

Use pagination

Checkbox

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

Default value: Deselected

Start page

Integer

Appears when you select the Use pagination checkbox. Specify the value of the page from which the pagination must start.

Default value: 1

Example: 5

Records per page

Integer

Appears when you select the Use pagination checkbox. Specify the number of records you want on a page.

Default value: 100

Example: 50

Number of pages

Integer

Appears when you select the Use pagination checkbox. Specify the number of pages you want to retrieve. If this value is 0, all records are retrieved from the starting page. If this value is greater than 0, the specified number of consecutive pages is retrieved beginning with the starting page. Records per page are controlled by the Records per page field. Negative values are not allowed.

Default value: 0

Example: 50

Snap execution

Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • 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.