Incentive Compensation Rate Table
This is a service to create/Update Rate Table Value. This service can be used to update either Compensation Plan - Rate Table Value or Participant - Rate Table Value
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/incentiveCompensation/cn/compensationPlanSetup/rateTables/rateTableService/}RateTableServiceService
Service WSDL URL: https://servername/fscmService/RateTableServiceService?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 |
Operations
createUpdateRate
Method used to Create/Update Rate Table Value. The user who has Plan Adminstrator Role can update the base rate table value The user who has Compensation Manager/Analyst role can update the rate table value for a participant
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
buName |
string |
Business Unit Name. The parameter is case sensitive. Exact name as per as the UI has to be given |
|
participantId |
long |
Participant Id It is mandatory for updating the Participant - Rate Table Value by the user with Compensation Manager/Analyst role. The Participant Id is not mandatory for update the Compensation Plan - Rate Table Value by the user with Plan Administator role. It should be -9999 in case 'null' has to be passed |
|
rateTableName |
string |
Rate Table Name. The parameter is case sensitive. Exact name as per as the UI has to be given |
|
rateList |
Incentive Compensation Rate List |
List Containing 1) Rate Dimension Name 2) Rate Tier Value The parameters are case sensitive. Exact name as per as the UI has to be given Rate Tier Value Example Type: Amount 0-200 Type: String Test Type: Percent 0-25 Type: Expression Exp1-/$Exp2 (Note : -/$ is being used as the delimiter as the expression name could itself contain a hyphen ) |
|
value |
decimal |
The Commission Value to be updated. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Returns a message if the rate table value is created/updated successfully |
createUpdatePlanComponentRate
Updates the individualized rate table values for a participant. This covers rate tables associated with plan components only.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
buName |
string |
The unique identifier of the business unit. It is a mandatory parameter and is case sensitive. |
|
participantId |
long |
The unique identifier of the participant. It is mandatory for updating the participant rate table value. |
|
compensationPlanName |
string |
The name of the compensation plan which defines the participant earnings based on performance. It is a mandatory parameter and is case sensitive. |
|
planAssignmentStartDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The date when the compensation plan becomes active. The format is 'YYYY-MM-DD'. You need to pass the value only if the same compensation plan is assigned multiple times to the participant for different date ranges. In other cases, you need to pass the value as '4712-12-31'. |
|
planAssignmentEndDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The date when the compensation plan becomes inactive. The format is 'YYYY-MM-DD'. You need to pass the value only if the same compensation plan is assigned multiple times to the participant for different date ranges. In other cases, you need to pass the value as '4712-12-31'. |
|
planComponentName |
string |
The name of the plan component which defines the earnings of a participant based on performance. It is a mandatory parameter and is case sensitive. |
|
rateTableName |
string |
The name of a rate table which is used to establish compensation percentage rates or fixed amounts for different performance levels. It is a mandatory parameter and is case sensitive. |
|
rateAssignmentStartDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The date when the rate table becomes active for the plan component. The format is 'YYYY-MM-DD'. You need to pass the value only if the same rate table is assigned multiple times to the plan component for different date ranges. In other cases, you need to pass the value as '4712-12-31'. |
|
rateAssignmentEndDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The date when the rate table becomes inactive for that plan component. The format is 'YYYY-MM-DD'. You need to pass the value only if the same rate table is assigned multiple times to the plan component for different date ranges. In other cases, you need to pass the value as '4712-12-31'. |
|
rateList |
Incentive Compensation Rate List |
The list containing the rate dimension name and the rate tier value. It is a mandatory parameter and is case sensitive. Examples of the rate tier value for different types are: Type: Amount, "0-200" Type: String, "Test" Type: Percent, "0-25" Type: Expression, "Exp1-/$Exp2" Note - In Type: Expression, "-/$" is being used as the delimiter for hyphen to distinguish between the from/to values. This is done because the expression could itself contain a hyphen. |
|
value |
decimal |
The commission value to be updated. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
A message if the rate table value is created/updated successfully. |
createUpdatePerformanceMeasureRate
Updates the individualized rate table values for a participant. This covers rate tables associated with performance measures only.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
buName |
string |
The unique identifier of the business unit. It is a mandatory parameter and is case sensitive. |
|
participantId |
long |
The unique identifier of the participant. It is mandatory for updating the participant rate table value. |
|
compensationPlanName |
string |
The name of the compensation plan which defines the participant earnings based on performance. It is a mandatory parameter and is case sensitive. |
|
planAssignmentStartDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The date when the compensation plan becomes active. The format is 'YYYY-MM-DD'. You need to pass the value only if the same compensation plan is assigned multiple times to the participant for different date ranges. In other cases, you need to pass the value as '4712-12-31'. |
|
planAssignmentEndDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The date when the compensation plan becomes inactive. The format is 'YYYY-MM-DD'. You need to pass the value only if the same compensation plan is assigned multiple times to the participant for different date ranges. In other cases, you need to pass the value as '4712-12-31'. |
|
planComponentName |
string |
The name of the plan component which defines the earnings of a participant based on performance. It is a mandatory parameter and is case sensitive. |
|
measureName |
string |
The name of a performance measure which defines the performance or accomplishment of a participant. It is a mandatory parameter and is case sensitive. |
|
rateTableName |
string |
The name of a rate table which is used to establish compensation percentage rates or fixed amounts for different performance levels. It is a mandatory parameter and is case sensitive. |
|
rateAssignmentStartDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The date when the rate table becomes active for the performance measure. The format is 'YYYY-MM-DD'. You need to pass the value only if the same rate table is assigned multiple times to the performance measure for different date ranges. In other cases, you need to pass the value as '4712-12-31'. |
|
rateAssignmentEndDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The date when the rate table becomes inactive for that performance measure. The format is 'YYYY-MM-DD'. You need to pass the value only if the same rate table is assigned multiple times to the performance measure for different date ranges. In other cases, you need to pass the value as '4712-12-31'. |
|
rateList |
Incentive Compensation Rate List |
The list containing the rate dimension name and the rate tier value. It is a mandatory parameter and is case sensitive. Examples of the rate tier value for different types are: Type: Amount, "0-200" Type: String, "Test" Type: Percent, "0-25" Type: Expression, "Exp1-/$Exp2" Note - In Type: Expression, "-/$" is being used as the delimiter for hyphen to distinguish between the from and to values. This is done because the expression could itself contain a hyphen. |
|
value |
decimal |
The commission value to be updated. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
A message if the rate table value is created/updated successfully. |
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_REVIEW_INCENTIVE_COMPENSATION_RATE_TABLE_PRIV |
Review Incentive Compensation Rate Table |
Allows review of incentive compensation rate table, which enables establishment of compensation percentage rates or fixed amounts for different performance levels. |
|
All Operations |
CN_MANAGE_INCENTIVE_COMPENSATION_RATE_TABLE_PRIV |
Manage Incentive Compensation Rate Table |
Allows maintenance of incentive compensation rate table, which enables establishment of compensation percentage rates or fixed amounts for different performance levels. |
Privileges to Duty Roles Mapping
| Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
|---|---|---|---|
|
CN_REVIEW_INCENTIVE_COMPENSATION_RATE_TABLE_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_ASSIGNMENT_ADMISTRATION_DUTY |
Incentive Compensation Participant Assignments |
Create and maintain the assignments of analyst to participant, participants and roles to compensation and payment plans as well as pay groups |
|
CN_REVIEW_INCENTIVE_COMPENSATION_RATE_TABLE_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_PARTICIPANT_PLAN_MANAGEMENT_DUTY |
Incentive Compensation Participant Snapshot Management |
Assign and maintain incentive plans and transactions for participants |
|
CN_MANAGE_INCENTIVE_COMPENSATION_RATE_TABLE_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_PLAN_ADMINISTRATOR_JOB |
Incentive Compensation Plan Administrator |
Configure and manage incentive plans, plan components, and classification rules |
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_CN_INCENTIVE_COMPENSATION_PLAN_ADMINISTRATOR_JOB |
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. |
|
ORA_CN_INCENTIVE_COMPENSATION_PLAN_ADMINISTRATOR_JOB |
ORA_CN_INCENTIVE_COMPENSATION_ASSIGNMENT_ADMISTRATION_DUTY |
Incentive Compensation Participant Assignments |
Create and maintain the assignments of analyst to participant, participants and roles to compensation and payment plans as well as pay groups |