Flow Actions
Service to perform task actions included in payroll flows. Task actions include actions such as submit, retry, and roll back.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/hcm/processFlows/core/flowActionsService/}FlowActionsService
Service WSDL URL: https://servername/hcmService/FlowActionsService?WSDL
Relationships
The following table describes how this service data object is related to other service data objects or business object services.
| Relationship Type | Object or Service |
|---|---|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
Operations
getFlowTaskInstanceStatus
Retrieves the flow task instance status.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
flowInstanceName |
string |
Name of the flow instance. |
|
flowTaskInstanceName |
string |
Name of the flow task. |
|
legislativeDataGroupName |
string |
Name of the legislative data group. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Flow task instance status. |
getAvailableActions
Retrieves a list of all the actions that can be performed on the task instance.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
flowInstanceName |
string |
Name of the flow instance. |
|
flowTaskInstanceName |
string |
Name of the flow task. |
|
legislativeDataGroupName |
string |
Name of the legislative data group. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
A list of task actions. |
performAction
Performs a specified action on a flow task instance.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
flowInstanceName |
string |
Name of the flow instance. |
|
flowTaskInstanceName |
string |
Name of the flow task. |
|
actionName |
string |
Name of the flow task action as returned by getAvailableActions. |
|
legislativeDataGroupName |
string |
Name of the legislative data group. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
boolean |
Returns true if the operation is successful, otherwise returns false. |
submitFlow
Submits a flow instance.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
flowName |
string |
Name of the flow pattern. |
|
parameterValues |
Flow Parameter Name Value |
List of flow parameter values. |
|
flowInstanceName |
string |
Name of the flow instance. |
|
legislativeDataGroupName |
string |
Name of the legislative data group. |
|
crossFlowInteractionList |
Flow Interactions Name Value |
List of flow interactions. |
|
scheduleFormulaTypeName |
string |
Name of formula type for the specified formula, such as Flow Schedule. |
|
scheduleFormulaName |
string |
Name of the formula used for scheduling. |
|
scheduledDate |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
Timestamp of the scheduled submission date. |
|
recurringFlag |
boolean |
Boolean indicating whether the flow instance is recurring (true) or nonrecurring (false). |
|
endDate |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
Timestamp of the end date of the schedule. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
boolean |
Returns true if the operation is successful, otherwise returns false. |
submitAndGetFlowInstanceId
Submits a flow instance and returns the flow instance ID.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
flowName |
string |
Name of the flow pattern. |
|
parameterValues |
long |
List of flow parameter values. |
|
flowInstanceName |
string |
Name of the flow instance. |
|
legislativeDataGroupName |
string |
Name of the legislative data group. |
|
crossFlowInteractionList |
Flow Interactions Name Value |
List of flow interactions. |
|
scheduleFormulaTypeName |
string |
Name of formula type for the specified formula, such as Flow Schedule. |
|
scheduleFormulaName |
string |
Name of the formula used for scheduling. |
|
scheduledDate |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
Timestamp of the scheduled submission date. |
|
recurringFlag |
boolean |
Boolean indicating whether the flow instance is recurring (true) or nonrecurring (false). |
|
endDate |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
Timestamp of the end date the schedule. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
long |
The flow instance ID. |
getFlowTaskRequestIdAndStatus
Method that retrieves the flow task instance status and the ess request id.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
flowInstanceName |
string |
Flow Instance Name. |
|
flowTaskInstanceName |
string |
Flow Task instance name. |
|
legislativeDataGroupName |
string |
Legislative data group name. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Ess request and task status |
getIntegrationContentId
Method return the integration name and ucm content details
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
flowInstanceName |
string |
Flow Instance Name. |
|
flowTaskInstanceName |
string |
Flow Task instance name. |
|
legislativeDataGroupName |
string |
Legislative data group name. |
|
integrationName |
string |
Integration Name |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Process and content details |
Security
The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.
Service Operations to Privileges Mapping
| Operation Name | Privilege Code | Privilege Name | Privilege Description |
|---|---|---|---|
|
All Operations |
PAY_SUBMIT_A_PAYROLL_PROCESS_OR_REPORT_PRIV |
Submit a Payroll Process or Report |
Submit a Payroll Process or Report |
|
All Operations |
HRC_ADAPTIVE_INTELLIGENCE_APPLICATIONS_INTEGRATION_WITH_HCM_PRIV |
Adaptive Intelligence Applications Integration with HCM |
This privilege is for internal use only. It has permissions to facilitate integration between Adaptive Intelligence Applications and Human Capital Management. |
Privileges to Duty Roles Mapping
| Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
|---|---|---|---|
|
HRC_ADAPTIVE_INTELLIGENCE_APPLICATIONS_INTEGRATION_WITH_HCM_PRIV |
ORA_HRC_ADAPTIVE_INTELLIGENCE_APPLICATIONS_INTEGRATION_WITH_HCM_DISCRETIONARY |
Adaptive Intelligence Applications Integration with HCM |
This discretionary role is for internal use only. It is used to facilitate integration between Adaptive Intelligence Applications and Human Capital Management. |
|
PAY_SUBMIT_A_PAYROLL_PROCESS_OR_REPORT_PRIV |
ORA_PAY_PROCESS_AND_REPORT_SUBMISSION_DUTY |
Submit a Payroll Process or Report |
Allows users to access the Submit a Flow action. When granting this aggregate privilege to a custom role you should also grant the Submit a Payroll Flow aggregate privilege, ORA_PAY_PAYROLL_FLOW_SUBMISSION_DUTY. |
Duty Roles to Duty or Job Roles Mapping
| Duty Role Code | Granted to Duty or Job Role Code | Granted to Duty or Job Role Name | Granted To Duty or Job Role Description |
|---|---|---|---|
|
ORA_HRC_ADAPTIVE_INTELLIGENCE_APPLICATIONS_INTEGRATION_WITH_HCM_DISCRETIONARY |
ORA_PER_REST_SERVICE_ACCESS_PUBLIC_WORKERS_RO |
Use REST Service - Public Workers Read Only |
Allows the user to call the GET method associated with the Public Workers REST Service. |