Oracle Human Capital Management Request node
Use the Oracle Human Capital Management Request node to connect to Oracle Human Capital Management and issue requests to create, retrieve, update, or delete objects such as absence records, candidates, job requisitions, payrolls, and time records.
The Oracle Human Capital Management Request node is available on Windows, AIX®, and Linux® systems.
This topic contains the following sections:
Purpose
- Absence plan balances
- Retrieve absence plan balances
- Absence records
- Create, retrieve, or update absence records
- Candidates
- Create, retrieve, update, or delete candidates
- Direct reports
- Retrieve direct reports
- Job requisitions
- Create, retrieve, update, or delete job requisitions
- Payrolls
- Create assigned payroll
- Performance evaluations
- Retrieve performance evaluations
- Performance goals
- Retrieve performance goals
- Talent person profiles
- Create, retrieve, or update talent person profiles
- Time records
- Retrieve time records
- Worker reports
- Retrieve work reports
- Workers
- Create, retrieve, or update workers
The Oracle Human Capital Management Request node operations are synchronous and non-transactional, which means that, if a message flow fails and rolls back after the Oracle Human Capital Management Request node, the operation on the data source will still complete.
Using the Oracle Human Capital Management Request node in a message flow
For information about using the Oracle Human Capital Management Request node, see Using Oracle Human Capital Management with IBM App Connect Enterprise.
Terminals and properties
When you have put an instance of the Oracle Human Capital Management Request node into a message flow, you can configure it. For more information, see Configuring a message flow node. The properties of the node are displayed in the Properties view. All mandatory properties for which you must enter a value (those without a default value) are marked with an asterisk.
The Oracle Human Capital Management Request node terminals are described in the following table.
Terminal | Description |
---|---|
In | The input terminal that accepts a message for processing by the node. The Oracle Human Capital Management Request node is driven by a message arriving on the In terminal. |
Out | The output terminal from which the message tree is propagated. The output message tree contains the object that is returned from the Oracle Human Capital Management connector. |
No Data | If the Oracle Human Capital Management connector is invoked successfully but the action returns no data (as no records were found), the message is sent to the No Data terminal. If an action returns no data and the No Data terminal is not wired, an exception is thrown. |
Failure | If an error occurs in the Oracle Human Capital Management Request node, the message is sent to the Failure terminal. |
The following tables describe the node properties. The columns headed M indicate whether the property is mandatory (marked with an asterisk on the panel if you must enter a value when no default is defined); the columns headed C indicate whether the property is configurable (you can change the value when you add the message flow to the BAR file to deploy it).
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | Yes | No | The node type, Oracle Human Capital Management Request | The name of the node. |
Short description | No | No | A brief description of the node. | |
Long description | No | No | Text that describes the purpose of the node in the message flow. |
Property | M | C | Default | Description |
---|---|---|---|---|
Action | Yes | No | This property shows the action to be performed by the Oracle Human Capital Management Request node. The action is defined
through the Connector Discovery wizard, and is then displayed in the Action
property in read-only format. Click Launch Connector Discovery to start the Connector Discovery wizard for the Oracle Human Capital Management connector, and define the action that you require. |
|
Object | Yes | No | This property shows the object on which the specified action is to be performed. The object is defined through the Connector Discovery wizard, and is then displayed in the Object property in read-only format. | |
Schema base name | Yes | No | The name of the schema files that describe the format of the request message
and response message that are sent and received from the Oracle Human Capital Management connector. The schema files can
be used by a Mapping node to map the data values. You can
open the schema by clicking the Open request schema or Open
response schema buttons. A request schema is generated only if the selected action
and object require a request message. If the action that is selected is of type
|
|
Connector properties | No | No | Depending on the object and action specified for the Oracle Human Capital Management connector during discovery, the Connector properties section shows the properties that have been set for the connector through the Connector Discovery wizard. If no connector properties were set during discovery, this section is not displayed in the Basic tab. |
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Policy | Yes | Yes | This property specifies the name of the policy that contains the details of
the security identity used for the connection. The policy has a type of Oracle Human Capital
Management and is defined in a policy project. |
policyUrl | |
Timeout (seconds) | No | Yes | 60 | This property specifies the time (in seconds) that the node waits for Oracle Human Capital Management to process the operation. The default is 60 seconds. | timeout |
Property | M | C | Default | Description |
---|---|---|---|---|
Filter options | No | Yes | The properties in the Filter options section control
which objects are to be operated upon when the Oracle Human Capital Management Request node executes. The filter
options are defined in the Connector Discovery wizard during discovery, but you can modify the
values afterwards by using the Edit button in the Filter tab of the node. If
no filter conditions were set during connector discovery, no properties are shown in the
Filter options section of the tab. The property value can be either a text value or an ESQL or XPATH expression that is resolved from the contents of the message passed to the Oracle Human Capital Management Request node as it executes. |
|
Maximum number of items to retrieve | No | Yes | 15 | The Maximum number of items to retrieve property
specifies the maximum number of items that can be retrieved from the Oracle Human Capital Management connector. This property
applies only to the Retrieve action.This property is defined in the Connector Discovery wizard during discovery, but you can modify the values afterwards in the Filter limit section of the Oracle Human Capital Management Request node. If no filter conditions were set in the Connector Discovery wizard during connector discovery, this property is not shown in the Filter tab of the node. |
If the limit is exceeded | No | The If the limit is exceeded property specifies the
action to be taken if the number of items retrieved from the connector exceeds the specified
maximum. This property applies only to the Retrieve action. You can choose one
of the following actions:
This property is defined in the Connector Discovery wizard during discovery, but you can modify the values afterwards in the Filter limit section of the Oracle Human Capital Management Request node. If no filter conditions were set in the Connector Discovery wizard during connector discovery, this property is not shown in the Filter tab of the node. |
The Oracle Human Capital Management Request node Request properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Request mode | No | No | None | This property determines the message that is sent to the connector when the
selected action (specified during connector discovery) is performed. The Request
mode is set during connector discovery, by using the Connector Discovery wizard. If you
want to edit this property, start the Connector Discovery wizard by clicking Launch
Connector Discovery in the node property editor. This property can be set to either of
the following values:
|
Map inputs | No | No | The Map inputs table is used to define the input that
is available for use when building the message to be sent to the connector, and for defining the
filter values for operations that require a filter. The entries in the Map
inputs table describe specific parts of the message assembly and the schemas that define
them:
By default, the table contains data that describes a generic input message and the structured parts of the local environment tree. You can add an entry to the Map inputs table to specify the location of a message in the message assembly that is described by an associated JSON schema. If there is a preceding message flow node that defines the structure of a JSON message arriving on this node's input terminal, the schema is located and suggested as an option that you can use. For more information about using JSONata mapping, see Configuring mapping for discovery connector request nodes and JSONata mapping example. |
|
Data location | Yes | No | $Body | This property specifies the location in the incoming message tree from which
data is retrieved to form the request that is sent from the request node. The default value,
$Body, represents the incoming message body. You can enter any XPath or ESQL
expression that defines the location of the message tree to serialize and send. This property applies only when the Request mode property is set to Using Data location. |
Property | M | C | Default | Description |
---|---|---|---|---|
Result data location | Yes | No | $ResultRoot | This property specifies the location in the message that is copied to the
Output data location field in the output message. For example,
For more information, see Combining a result message with an input message when fetching data from external systems. |
Output data location | Yes | No | $OutputRoot | This property specifies the message tree location to which the Oracle Human Capital Management Request node sends output. The part
of the message that is copied is specified by the Result data location
property. The default value specifies that the retrieved message is copied to the root of the
outgoing message. See Combining a result message with an input message when fetching data from external systems. |
Copy local environment | No | No | Selected | This property controls whether to copy the incoming local environment or propagate the incoming local environment. By default, this check box is selected, which specifies that the local environment is copied so that the incoming local environment is preserved. The additions to the local environment are visible only to nodes downstream of this node. If this check box is cleared, the incoming local environment is used for the outgoing message. Any modifications that are made to the local environment by this node are visible to both downstream and upstream nodes after this node has completed. |
Property | M | C | Default | Description |
---|---|---|---|---|
Message domain | Yes | No | JSON | The domain that is used to parse the response message. By default, the message that is propagated is in the JSON domain. You cannot specify a different domain. |
Message model | No | No | The name or location of the message model schema file in which the incoming message is defined. You cannot set this property. | |
Message | No | No | The name of the response message. The node detects the message type automatically; you cannot set this property. | |
Physical format | No | No | The name of the physical format of the response message. You cannot set this property. |
The Oracle Human Capital Management Request node Validation properties are described in the following table.
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Validate | No | Yes | Content and value | This property controls whether request messages are validated against the
request schema that is discovered during connector discovery, and is enabled by default. You can set
this property to one of the following values:
|
validateRequestMaster |
Failure action | No | No | Exception list | This property controls the action that is taken when a validation failure
occurs. You can set it to one of the following values:
|
|
Response validation options | No | No | Validation of the response message is not controlled by this node. The discovery connector builds the response message and produces a valid message that matches the schema. |
Property | M | C | Default | Description |
---|---|---|---|---|
Events | No | No | None | Events that you have defined for the node are displayed on this tab. By
default, no monitoring events are defined on any node in a message flow. Use
Add, Edit, and Delete to
create, change or delete monitoring events for the node; see Configuring monitoring event sources by using monitoring properties for
details. You can enable and disable events that are shown here by selecting or clearing the Enabled check box. |