Incentive Compensation Estimated Compensation
Service to estimate compensation. Estimation includes potential earnings and attainment for a participant based on a set of future transactions.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/incentiveCompensation/cn/transactionProcessing/estimatedCompensation/publicService/}EstimatedCompensationServiceService
Service WSDL URL: https://servername/fscmService/EstimatedCompensationServiceService?WSDL
Logical Business Objects
-
IC : Incentive Compensation : Incentive Compensation Deal
Relationships
The following table describes how this service data object is related to other service data objects or business object services.
Operations
estimateCompensation
Estimates compensation for a participant based on a set of transactions.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
personInformation |
Incentive Compensation Estimated Compensation Participant |
The input payload for the participant for which the compensation was estimated. Uses the Incentive Compensation Estimated Compensation Participant service data object for this parameter. |
|
transactionList |
Incentive Compensation Est. Compensation Transactions |
The input payload for the transactions to be estimated. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
long |
The scenario identifier created after estimation of earnings. |
createEstimatedTransactions
Method to create transactions for estimation
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
personInformation |
Incentive Compensation Estimated Compensation Participant |
Personal information object |
|
transactionList |
Incentive Compensation Est. Compensation Transactions |
List of transactions to be created for estimation |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Incentive Compensation Estimated Compensation Transaction Response SDO |
Status for each record requested via create operation |
updateEstimatedTransactions
Method to update transactions for estimation
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
personInformation |
Incentive Compensation Estimated Compensation Participant |
Personal information object |
|
transactionList |
Incentive Compensation Est. Compensation Transactions |
List of transactions to be updated for estimation |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Incentive Compensation Estimated Compensation Transaction Response SDO |
Status for each record requested via update operation |
deleteEstimatedTransactions
Method to delete existing transactions from estimation
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
personInformation |
Incentive Compensation Estimated Compensation Participant |
Personal information object |
|
transactionReferenceList |
Incentive Compensation Estimated Compensation Transaction Reference SDO |
Transaction attributes to identify the records to delete, such as transaction name, transaction , line number. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Incentive Compensation Estimated Compensation Transaction Response SDO |
Status for each record requested via delete operation |
getAttainmentSummary
Gets the aggregated attainment for each compensation plan, for each plan component within the plan, for each performance measure within the plan component, and for each interval for the performance measure.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
findCriteria |
{http://xmlns.oracle.com/adf/svc/types/}FindCriteria |
The input payload criteria used to find the attainment summary. |
|
scenarioId |
long |
The unique identifier of the estimated compensation scenario. The scenario identifier is provided in response to the estimateCompensation operation. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The control object used as a placeholder for finding the attainment summary. Not currently used. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The attainment summary. |
getEarningSummary
Gets the aggregated earnings for each compensation plan, for each plan component within the plan, and for each interval for the plan component. Applicable for plan components that calculate individually and per interval.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
findCriteria |
{http://xmlns.oracle.com/adf/svc/types/}FindCriteria |
The input payload criteria used to find the earning summary. |
|
scenarioId |
long |
The unique identifier of the estimated compensation scenario. The scenario identifier is provided in response to the estimateCompensation operation. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The control object used as a placeholder for finding the earnings summary. Not currently used. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The earning summary. |
getIndividualEarnings
Gets the individual earnings for each transaction and participant. Applicable only for plan components that calculate individually.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
findCriteria |
{http://xmlns.oracle.com/adf/svc/types/}FindCriteria |
The input payload criteria used to find the individual earnings. |
|
scenarioId |
string |
The unique identifier of the estimated compensation scenario. The scenario identifier is provided in response to the estimateCompensation operation. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The control object used as a placeholder for finding individual earnings. Not currently used. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Incentive Compensation Est. Compensation Individual Earnings |
The individual earnings. |
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_PROJECT_INCENTIVE_COMPENSATION_COMMISSION_LINE_PRIV |
Project Incentive Compensation Commission Line |
Allows projection of incentive compensation earning. |
Privileges to Duty Roles Mapping
| Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
|---|---|---|---|
|
CN_PROJECT_INCENTIVE_COMPENSATION_COMMISSION_LINE_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_PARTICIPANT_MANAGER_ABSTRACT |
Incentive Compensation Participant Manager |
Manage participants who receive incentive compensation and review reports |
|
CN_PROJECT_INCENTIVE_COMPENSATION_COMMISSION_LINE_PRIV |
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
Sales Restricted User |
Has the same scope of visibility as the Sales Manager role to application data but can only view or read most of that data. The ability to create, update or delete data is restricted to notes, activities, attachments and reports. |
|
CN_PROJECT_INCENTIVE_COMPENSATION_COMMISSION_LINE_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_PARTICIPANT_ABSTRACT |
Incentive Compensation Participant |
Receive incentive compensation computed by the application and review reports |
|
CN_PROJECT_INCENTIVE_COMPENSATION_COMMISSION_LINE_PRIV |
ORA_ZBS_SALES_VP_JOB |
Sales VP |
Manages sales managers within the organization. Responsible for account planning, territory and quota management, and managing sales forecasts for the territory. |
|
CN_PROJECT_INCENTIVE_COMPENSATION_COMMISSION_LINE_PRIV |
ORA_ZBS_SALES_REPRESENTATIVE_JOB |
Sales Representative |
Represents the business to sell its products. Maintains relationships with customers and contacts, builds pipeline, manages leads and opportunities and performs sales forecasting. |
|
CN_PROJECT_INCENTIVE_COMPENSATION_COMMISSION_LINE_PRIV |
ORA_ZBS_SALES_MANAGER_JOB |
Sales Manager |
Manages salespersons within the organization. Generates revenue within a territory, builds pipeline, manages territory forecasts, and assists salespersons in closing deals. |
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_PARTICIPANT_MANAGER_ABSTRACT |
ORA_CN_INCENTIVE_COMPENSATION_PARTICIPANT_ABSTRACT |
Incentive Compensation Participant |
Receive incentive compensation computed by the application and review reports |
|
ORA_ZBS_SALES_VP_JOB |
ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY_FSCM |
Sales Party Management |
Manages creation and maintenance of the sales organizations and consumers for internal sales users. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts. |
|
ORA_ZBS_SALES_MANAGER_JOB |
ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY_FSCM |
Sales Party Management |
Manages creation and maintenance of the sales organizations and consumers for internal sales users. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts. |
|
ORA_ZBS_SALES_REPRESENTATIVE_JOB |
ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY_FSCM |
Sales Party Management |
Manages creation and maintenance of the sales organizations and consumers for internal sales users. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts. |
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_ZCM_SALES_PARTY_MANAGEMENT_READ_ONLY_DUTY_FSCM |
Sales Party Management Read Only |
Read Only role for Sales Party Management Duty. |
|
ORA_ZBS_SALES_REPRESENTATIVE_JOB |
ORA_ZCM_SALES_PARTY_REVIEW_DUTY_FSCM |
Sales Party Review |
Allows resources read-only access to sales parties information such as manage customer work area and all sales party duties. Additional duties include view access to other customer and sales lead features. |
|
ORA_ZBS_SALES_VP_JOB |
ORA_SVC_SR_CONTRIBUTOR_FSCM |
Service Request Contributor |
Can create Service Requests and help with resolution of the Service Request. Has basic Service Request Management capabilities. Would not be able to respond to customer, assign SR to a user or change the status of a SR. |
|
ORA_ZBS_SALES_MANAGER_JOB |
ORA_SVC_SR_CONTRIBUTOR_FSCM |
Service Request Contributor |
Can create Service Requests and help with resolution of the Service Request. Has basic Service Request Management capabilities. Would not be able to respond to customer, assign SR to a user or change the status of a SR. |
|
ORA_ZBS_SALES_RESTRICTED_USER_JOB |
ORA_SVC_SR_CONTRIBUTOR_FSCM |
Service Request Contributor |
Can create Service Requests and help with resolution of the Service Request. Has basic Service Request Management capabilities. Would not be able to respond to customer, assign SR to a user or change the status of a SR. |
|
ORA_ZBS_SALES_REPRESENTATIVE_JOB |
ORA_SVC_SR_CONTRIBUTOR_FSCM |
Service Request Contributor |
Can create Service Requests and help with resolution of the Service Request. Has basic Service Request Management capabilities. Would not be able to respond to customer, assign SR to a user or change the status of a SR. |
|
ORA_ZBS_SALES_VP_JOB |
ORA_OSS_SUBSCRIPTION_SALES_VIEW_DUTY_FSCM |
Subscription Sales View |
Searches and views subscriptions for the assigned business units. This duty role is specifically applicable for sales job roles. |
|
ORA_ZBS_SALES_MANAGER_JOB |
ORA_OSS_SUBSCRIPTION_SALES_VIEW_DUTY_FSCM |
Subscription Sales View |
Searches and views subscriptions for the assigned business units. This duty role is specifically applicable for sales job roles. |
|
ORA_ZBS_SALES_REPRESENTATIVE_JOB |
ORA_OSS_SUBSCRIPTION_SALES_VIEW_DUTY_FSCM |
Subscription Sales View |
Searches and views subscriptions for the assigned business units. This duty role is specifically applicable for sales job roles. |
|
ORA_ZBS_SALES_VP_JOB |
ORA_MOT_TERRITORY_MANAGEMENT_DUTY_FSCM |
Territory Management |
Manages sales territories, territory proposals, and quotas. |
|
ORA_ZBS_SALES_MANAGER_JOB |
ORA_MOT_TERRITORY_MANAGEMENT_DUTY_FSCM |
Territory Management |
Manages sales territories, territory proposals, and quotas. |