Incentive Compensation Credit Rule
Service to create, retrieve, delete, and update credit rules. This includes credit rule criteria and credit receivers.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/incentiveCompensation/cn/creditSetup/creditRule/creditRuleService/}CreditRuleService
Service WSDL URL: https://servername/fscmService/CreditRuleService?WSDL
Logical Business Objects
-
IC : Incentive Compensation : Incentive Compensation Credit Rule
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
getRuleStats
Method to analyze and gather the overall statistics of all Rule related data such as, Rule, Rule Attributes, Rule Attribute Values and Rule Assignments
Life Cycle Status: Active
Request Payload
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
No return object |
getRuleAttribute
Gets a single rule attribute that matches the specified unique rule attribute identifier.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
ruleAttributeId |
long |
The unique identifier of the rule attribute. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The rule attribute that matches the specified criteria. |
createRuleAttribute
Creates a single rule attribute.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
ruleAttribute |
Incentive Compensation Credit Rule Attribute |
The input payload for the rule attribute to be created. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The created rule attribute. |
updateRuleAttribute
Updates a single rule attribute.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
ruleAttribute |
Incentive Compensation Credit Rule Attribute |
The input payload for the rule attribute to be updated. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The updated rule attribute. |
deleteRuleAttribute
Deletes a single rule attribute.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
ruleAttribute |
Incentive Compensation Credit Rule Attribute |
The input payload for the rule attribute to be deleted. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
No return object. |
findRuleAttribute
Finds and returns a list of rule attributes based on a query statement.
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 rule attributes. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The control object used as a placeholder for finding credit rules. Not currently used. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The list of rule attributes that match the specified criteria. |
processRuleAttribute
Performs a create, update, delete or merge operation on a list of rule attributes. 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. |
|
ruleAttribute |
Incentive Compensation Credit Rule Attribute |
The list of rule attributes for which the specified operation was applied. |
|
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 list of rule attributes for which the specified operation was applied. |
getRuleAssignment
Gets a single rule assignment that matches the specified unique rule assignment identifier.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
ruleAssignmentId |
long |
The unique identifier of the rule assignment. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The rule assignment that matches the specified criteria. |
createRuleAssignment
Creates a single rule assignment.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
ruleAssignment |
Incentive Compensation Credit Rule Participant |
The input payload for the rule assignment to be created. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The created rule assignment. |
updateRuleAssignment
Updates a single rule assignment.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
ruleAssignment |
Incentive Compensation Credit Rule Participant |
The input payload for the rule assignment to be updated. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The updated rule assignment. |
deleteRuleAssignment
Deletes a single rule assignment.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
ruleAssignment |
Incentive Compensation Credit Rule Participant |
The input payload for the rule assignment to be deleted. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
No return object. |
findRuleAssignment
Finds and returns a list of rule assignments based on a query statement.
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 rule assignments. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The control object used as a placeholder for finding credit rules. Not currently used. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The list of rule assignments that match the specified criteria. |
processRuleAssignment
Performs a create, update, delete or merge operation on a list of rule assignments. 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. |
|
ruleAssignment |
Incentive Compensation Credit Rule Participant |
The list of rule assignments for which the specified operation was applied. |
|
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 list of rule assignments for which the specified operation was applied. |
getRuleAttributeValue
Gets a single rule attribute value that matches the specified unique rule attribute value identifier.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
ruleAttrValueId |
long |
The unique identifier of the attribute value. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The rule attribute value that matches the specified criteria. |
createRuleAttributeValue
Creates a single rule attribute value.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
ruleAttributeValue |
Incentive Compensation Credit Rule Attribute Value |
The input payload for the rule attribute value to be created. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The created rule attribute value. |
updateRuleAttributeValue
Updates a single rule attribute value.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
ruleAttributeValue |
Incentive Compensation Credit Rule Attribute Value |
The input payload for the rule attribute value to be updated. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The updated rule attribute value. |
deleteRuleAttributeValue
Deletes a single rule attribute value.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
ruleAttributeValue |
Incentive Compensation Credit Rule Attribute Value |
The input payload for the rule attribute value to be deleted. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
No return object. |
findRuleAttributeValue
Finds and returns a list of rule attribute values based on a query statement.
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 rule attribute values. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The control object used as a placeholder for finding credit rules. Not currently used. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The list of rule attribute values that match the specified criteria. |
processRuleAttributeValue
Performs a create, update, delete or merge operation on a list of rule attribute values. 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. |
|
ruleAttributeValue |
Incentive Compensation Credit Rule Attribute Value |
The list of rule attribute values for which the specified operation was applied. |
|
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 list of rule attribute values for which the specified operation was applied. |
getRule
Gets a single rule that matches the specified unique rule identifier.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
ruleId |
long |
The unique identifier of the rule. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The rule that matches the specified criteria. |
createRule
Creates a single rule.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
rule |
Incentive Compensation Credit Rule |
The input payload for the rule to be created. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The created rule. |
updateRule
Updates a single rule.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
rule |
Incentive Compensation Credit Rule |
The input payload for the rule to be updated. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The updated rule. |
deleteRule
Deletes a single rule.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
rule |
Incentive Compensation Credit Rule |
The input payload for the rule to be deleted. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
No return object. |
findRule
Finds and returns a list of rules based on a query statement.
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 rules. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The control object used as a placeholder for finding credit rules. Not currently used. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The list of rules that match the specified criteria. |
findRuleByRuleName
Finds a rule by the rule name.
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 a rule by the rule name. |
|
RuleName |
string |
The rule name. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The control object used as a placeholder for finding credit rules. Not currently used. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The list of rules that match the specified criteria. |
processRule
Performs a create, update, delete or merge operations on a list of rules. 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. |
|
rule |
Incentive Compensation Credit Rule |
The list of rules for which the specified operation was applied. |
|
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 list of rules 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 the 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_REVIEW_INCENTIVE_COMPENSATION_CLASSIFICATION_RULE_HIERARCHY_PRIV |
Review Incentive Compensation Classification Rule Hierarchy |
Allows review of rule hierarchy used by incentive compensation to classify sales transactions into user-defined credit categories. |
|
All Operations |
CN_MANAGE_INCENTIVE_COMPENSATION_TEAM_PRIV |
Manage Incentive Compensation Team |
Allows maintenance of incentive compensation teams used in determining incentive compensation credit receivers. |
|
All Operations |
CN_MANAGE_INCENTIVE_COMPENSATION_CLASSIFICATION_RULE_HIERARCHY_PRIV |
Manage Incentive Compensation Classification Rule Hierarchy |
Allows maintenance of rule hierarchy used to classify sales transactions into user-defined credit categories of business revenue. |
|
All Operations |
CN_MANAGE_INCENTIVE_COMP_ROLLUP_GROUP_PRIV |
Manage Incentive Compensation Rollup Group |
Allows maintenance of incentive compensation groups used to determine who receives rollup credits. |
|
All Operations |
CN_MANAGE_INCENTIVE_COMPENSATION_CREDIT_RULE_PRIV |
Manage Incentive Compensation Credit Rule |
Allows maintenance of rule criteria used to determine who receives incentive compensation credit. |
|
All Operations |
CN_REVIEW_INCENTIVE_COMPENSATION_ROLLUP_GROUP_PRIV |
Review Incentive Compensation Rollup Group |
Allows review of rollup group hierarchy used to determine who receives incentive compensation rollup credits. |
|
All Operations |
CN_REVIEW_INCENTIVE_COMPENSATION_CREDIT_RULE_PRIV |
Review Incentive Compensation Credit Rule |
Allows maintenance of assignment to credit rules used to determine who receives incentive compensation credit. |
|
All Operations |
CN_CREATE_INCENTIVE_COMPENSATION_TEAM_PRIV |
Create Incentive Compensation Team |
Allows creation of teams used in determining incentive compensation credit receivers. |
Privileges to Duty Roles Mapping
| Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
|---|---|---|---|
|
CN_MANAGE_INCENTIVE_COMPENSATION_CLASSIFICATION_RULE_HIERARCHY_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_PLAN_ADMINISTRATOR_JOB |
Incentive Compensation Plan Administrator |
Configure and manage incentive plans, plan components, and classification rules |
|
CN_CREATE_INCENTIVE_COMPENSATION_TEAM_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_MANAGE_INCENTIVE_COMP_ROLLUP_GROUP_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_MANAGE_INCENTIVE_COMPENSATION_CREDIT_RULE_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_MANAGE_INCENTIVE_COMPENSATION_TEAM_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 |
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 |