Incentive Compensation Transaction
Service to create, retrieve, delete, and update staging table transactions. You can also use this service to place and release holds for uncredited transactions.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/incentiveCompensation/cn/transactionProcessing/transactionManagement/publicService/}TransactionService
Service WSDL URL: https://servername/fscmService/IncentiveTransactionService?WSDL
Logical Business Objects
-
IC : Incentive Compensation : Incentive Compensation Transaction
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 |
Operations
holdTransaction
Holds the transaction. Applicable to transactions that are not credited.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
sourceTrxNumber |
string |
The transaction number. |
|
transactionType |
string |
The lookup code that represents the transaction type. For example, Invoice and Order. The value must be a valid lookup code for lookup type CN_TP_TRANSACTION_TYPE. You can view the CN_TP_TRANSACTION_TYPE lookup using the Setup and Maintenance, Manage Incentive Compensation Lookups task. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
boolean |
Indicates if the transaction was held successfully. |
getIncentiveTransactionStaging
Gets a single staging transaction that matches the transaction number, transaction type and credited participant identifier.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
creditedParticipantId |
long |
The unique identifier of the credited participant. |
|
sourceTrxNumber |
string |
The transaction number for the staging transaction. |
|
transactionType |
string |
The transaction type code for the staging transaction. For example, Invoice or Order. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The staging transaction that matches the specified criteria. |
createIncentiveTransactionStaging
Creates a single transaction in the staging table.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
incentiveTransactionStaging |
Incentive Compensation Staging Transaction |
The input payload for the staging transaction to be created. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The created staging transaction. |
updateIncentiveTransactionStaging
Updates a single transaction in the staging table.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
incentiveTransactionStaging |
Incentive Compensation Staging Transaction |
The input payload for the staging transaction to be updated. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The updated staging transaction. |
deleteIncentiveTransactionStaging
Deletes a single transaction in the staging table.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
incentiveTransactionStaging |
Incentive Compensation Staging Transaction |
The input payload for the staging transaction to be deleted. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
No return object. |
mergeIncentiveTransactionStaging
Updates a transaction in the staging table if it exists, otherwise it creates a new one.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
incentiveTransactionStaging |
Incentive Compensation Staging Transaction |
The input payload for the staging transactions to be merged. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The updated or created staging transaction. |
findIncentiveTransactionStaging
Finds and returns a list of transactions in the staging table.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
findCriteria |
{http://xmlns.oracle.com/adf/svc/types/}FindCriteria |
The criteria to find the staging transactions. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The control object used as a placeholder for finding staging transactions. Not currently used. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The list of staging transactions that match the specified criteria. |
processIncentiveTransactionStaging
Performs a create, update, delete or merge operation on a list of transactions in the staging table. The specified operation is applied to all objects in the given list.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
changeOperation |
string |
The create, update, delete, or merge operation to perform. |
|
incentiveTransactionStaging |
Incentive Compensation Staging Transaction |
The input payload for the staging transactions to be processed. |
|
processControl |
{http://xmlns.oracle.com/adf/svc/types/}ProcessControl |
The object of type ProcessControl, which provides optional process control. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The staging transactions for which the specified operation was applied. |
processCSIncentiveTransactionStaging
Performs a create, update, delete or merge operation on a list of transactions in the staging table. Different options may be applied to different objects depending on what is specified in the Change Summary object.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
processData |
{http://xmlns.oracle.com/adf/svc/types/}ProcessData |
The input payload for the staging transactions. |
|
processControl |
{http://xmlns.oracle.com/adf/svc/types/}ProcessControl |
The object of type ProcessControl, which provides optional process control. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ProcessData |
The staging transactions for which the specified operation was applied. |
getDfltObjAttrHints
Gets user interface hints, such as the service data object label and object attribute labels, for the specified service data object and locale. As a prerequisite, invoke the getEntityList operation defined on this service to get the list of possible values for the viewName request payload element.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
viewName |
string |
The service view usage name, an internal name for the service data object. Specify the value of the name element from the getEntityList operation response payload. |
|
localeName |
string |
The locale to use when evaluating the locale-based user interface hints. The locale name is in the ISO 639-1 format. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints |
The label and user interface hints for the specified service data object and its attributes in a name-value pair format. |
getServiceLastUpdateTime
Gets the date and time for when the schema files, referenced in the service definition, last changed.
Life Cycle Status: Active
Request Payload
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The date and time when the service definition last changed in ISO 8601 format. |
getEntityList
Gets the list of service data objects defined on this service.
Life Cycle Status: Active
Request Payload
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo |
A list of service data objects defined for this service. For each service data object, the result includes the QName, internal name, and Boolean values indicating whether create, update, merge, and delete operations can be performed on the object. |
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 |
CN_MAINTAIN_INCENTIVE_COMPENSATION_TRANSACTION_PRIV |
Maintain Incentive Compensation Transaction |
Allows verification of earning transaction detail for which the application calculated incentive compensation commission, bonus, or nonmonetary incentive. |
Privileges to Duty Roles Mapping
| Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
|---|---|---|---|
|
CN_MAINTAIN_INCENTIVE_COMPENSATION_TRANSACTION_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_PARTICIPANT_PLAN_MANAGEMENT_DUTY |
Incentive Compensation Participant Snapshot Management |
Assign and maintain incentive plans and transactions for participants |
|
CN_MAINTAIN_INCENTIVE_COMPENSATION_TRANSACTION_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_CREDITS_EARNINGS_MANAGEMENT_DUTY |
Incentive Compensation Credits and Earnings |
Create, review, and adjust incentive compensation transactions, credits and earnings. Create and manage requests to calculate the incentive compensation for a set of participants. |