Extract Actions

Service to submit an extract process and obtain the extracted XML output. Recommended only for smaller extract processes.

Life Cycle Status: Active

QName: {http://xmlns.oracle.com/apps/hcm/batchProcesses/core/batchProcessesCoreService/}PayrollProcessingActionService

Service WSDL URL: https://servername/hcmService/PayrollProcessingActionService?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	Extract Parameter

fetchExtractOutput

Retrieves the archived XML output produced by an extract process. Recommended only for smaller extract processes.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
instanceName	string	Name of the archived flow instance.
taskName	string	Name of the flow task.
mode	string	Name of the running mode, either ARCHIVER or FLOW. If mode is ARCHIVER, the output is returned based on flow instance name. If mode is FLOW, the output is returned based on flow instance name and flow task name.

Response Payload

Element Name	Type	Description
result	string	The XML output.

processExtract

Executes an extract process without ESS or flow instance. Recommended only for smaller extract processes.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
extractParameter	Extract Parameter	Attribute list of extract parameters.

Response Payload

Element Name	Type	Description
result	string	The XML output.

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
fetchExtractOutput	PAY_SUBMIT_PAYROLL_FLOW_PRIV	Submit Payroll Flow	Submit Payroll Flow
fetchExtractOutput	PAY_MANAGE_PAYROLL_GENERIC_PARAMETERS_PRIV	Manage Payroll Process Configuration	Manage Payroll Process Configuration
processExtract	PAY_SUBMIT_PAYROLL_FLOW_PRIV	Submit Payroll Flow	Submit Payroll Flow
processExtract	PAY_MANAGE_PAYROLL_GENERIC_PARAMETERS_PRIV	Manage Payroll Process Configuration	Manage Payroll Process Configuration

Privileges to Duty Roles Mapping

Privilege Code	Granted to Duty Role Code	Granted to Duty Role Name	Granted To Duty Role Description
PAY_SUBMIT_PAYROLL_FLOW_PRIV	ORA_PAY_PAYROLL_FLOW_SUBMISSION_DUTY	Submit a Payroll Flow	Allows users to run scheduled processes that are included in payroll flows. When granting this aggregate privilege to a custom role you should also grant the Submit a Payroll Process or Report aggregate privilege, ORA_PAY_PROCESS_AND_REPORT_SUBMISSION_DUTY.
PAY_MANAGE_PAYROLL_GENERIC_PARAMETERS_PRIV	ORA_PAY_PAYROLL_IMPLEMENTATION_VIEW_DUTY	Payroll Implementation View	Views complete payroll setup.
PAY_MANAGE_PAYROLL_GENERIC_PARAMETERS_PRIV	ORA_PAY_PAYROLL_IMPLEMENTATION_DUTY	Payroll Implementation	Manages complete payroll setup and maintenance.

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_PAY_PAYROLL_IMPLEMENTATION_DUTY	ORA_IBY_EMPLOYEE_BANK_ACCOUNT_MANAGEMENT_DUTY_HCM	Employee Bank Account Management	Manages employee bank accounts and other payment details.
ORA_PAY_PAYROLL_IMPLEMENTATION_DUTY	ORA_PAY_MANAGE_LOCATION_COSTING	Manage Costing of Location	Allows user to manage location costing.
ORA_PAY_PAYROLL_IMPLEMENTATION_DUTY	ORA_PAY_FAST_FORMULA_MANAGEMENT_DUTY	Manage Fast Formula	Manages formula definitions used for validation and calculations.
ORA_PAY_PAYROLL_IMPLEMENTATION_VIEW_DUTY	ORA_PAY_FAST_FORMULA_MANAGEMENT_DUTY	Manage Fast Formula	Manages formula definitions used for validation and calculations.
ORA_PAY_PAYROLL_IMPLEMENTATION_DUTY	ORA_PAY_MANAGE_RATE_DEFINITION_DUTY	Manage HCM Rates	Manages derived rates and values defined by criteria.
ORA_PAY_PAYROLL_IMPLEMENTATION_DUTY	ORA_PAY_MANAGE_PAYMENT_METHOD_PREFERENCES	Manage Payment Method Preferences	Allows management of payment method preferences.
ORA_PAY_PAYROLL_IMPLEMENTATION_DUTY	ORA_PAY_ELEMENT_ENTRY_MANAGEMENT_DUTY	Manage Payroll Element Entry	Manages the allocation and data entry of earnings and deduction elements to a person.
ORA_PAY_PAYROLL_IMPLEMENTATION_DUTY	ORA_PAY_MANAGE_VALUE_BY_CRITERIA_DUTY	Manage Value Defined by Criteria	Manages values defined by criteria.
ORA_PAY_PAYROLL_IMPLEMENTATION_DUTY	ORA_PAY_COMMON_HCM_IMPLEMENTION_DUTY	Payroll Common HCM Implementation	Manages all payroll setup definitions required by other HCM products.
ORA_PAY_PAYROLL_IMPLEMENTATION_VIEW_DUTY	ORA_PAY_VIEW_LOCATION_COSTING	View Costing of Location	Allows user to view location costing.