Incentive Compensation Participant Version 2

Logical Business Objects

IC : Incentive Compensation : Incentive Compensation Participant

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	Incentive Compensation Participant Detail SDO
Handles	Incentive Compensation Participant Plan Search SDO
Handles	Incentive Compensation Participant Plan SDO
Handles	Incentive Compensation Terminate Participant SDO
Handles	Incentive Compensation Participant Plan Additional Attributes SDO
Handles	Incentive Compensation Participant Plan Target SDO
Handles	Incentive Compensation Participant Detail Flexfield SDO
Handles	Incentive Compensation Participant Role SDO

holdParticipantPayment

Set the participant's (header) Hold Payment to Y to exclude the participant from the Payment process. This method requires one of the first three parameters; pass 0 for unknow or null values.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
personId	string	Unique identifier for the person
partyId	long	Unique identifier for the party
participantId	long	Unique identifier for the participant
orgId	long	Unique identifier for the business unit
holdReason	string	Reason for the payment hold

Response Payload

Element Name	Type	Description
result	int	Number of participants for whom to hold payment

terminateParticipant

End date the participant. The Payment process looks at the compensation end date first. If that value is Null, it uses the active end date. Paysheets do not include payments processed after the participant's end date. This method requires one of the first three parameters; pass 0 for unknown or null values.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
personId	string	Unique identifier for the person
partyId	long	Unique identifier for the party
participantId	long	Unique identifier for the participant
orgId	long	Unique identifier for the business unit
activeEndDate	{http://xmlns.oracle.com/adf/svc/types/}date-Date	Format for dates is YYYY-MM-DD
compensationEndDate	{http://xmlns.oracle.com/adf/svc/types/}date-Date	Format for dates is YYYY-MM-DD

Response Payload

Element Name	Type	Description
result	int	List of participants who were end dated

assignCOMPRoleToParticipant

Assigns a compensation role to a participant. If the role is assigned to a compensation plan, payment plan, or pay group, assign the participant to these entities through the role. This method requires one of the first three parameters; pass 0 for unknown or null values.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
personId	string	Unique identifier for the person
partyId	long	Unique identifier for the party
participantId	long	Unique identifier for the participant
orgId	long	Unique identifier for the business unit
roleId	long	Unique identifier for the role
assignmentStartDate	{http://xmlns.oracle.com/adf/svc/types/}date-Date	Format for dates is YYYY-MM-DD
assignmentEndDate	{http://xmlns.oracle.com/adf/svc/types/}date-Date	Format for dates is YYYY-MM-DD

Response Payload

Element Name	Type	Description
result	int	Number of compensation role assignment records created for given participant.

processParticipantTargetIncentive

Modify the target incentive amount of participant to comp plan assingment. Business Unit Name,Participant Name,Plan Name and Target Incentive Amount are mandatory.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
participantTargetIncentive	Incentive Compensation Participant Plan Target SDO	Input List of Service data object for Participant Target Incentive

Response Payload

Element Name	Type	Description
result	Incentive Compensation Participant Plan Target SDO	Returns List of Service data object for Participant Target Incentive modified

automaticTerminateParticipant

This process automatically terminates participant along with, terminating Participants Compensation Plan and Payment Plan, with respect to the system parameters.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
terminateParticipant	Incentive Compensation Terminate Participant	The Input List of Service data objects for Automatic Terminate Participant.

Response Payload

Element Name	Type	Description
result	string	Returns a list of errors, if any, in the Automated participant termination function.

assignRoleToParticipant

Assigns Role to a Participant

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
participantRole	Incentive Compensation Participant Role SDO	Input Service data object for Participant Role assignment

Response Payload

Element Name	Type	Description
result	Incentive Compensation Participant Role SDO	Output Service data object for Participant Role assigned

mergeParticipantDetail

Merge a new Participant Detail Record.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
participantDetail	Incentive Compensation Participant Detail	Input Service data object for Participant Detail

Response Payload

Element Name	Type	Description
result	Incentive Compensation Participant Detail	Returns Service data object for Participant Detail merged

terminateActiveParticipant

Terminate an active Participant.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
terminateParticipant	Incentive Compensation Terminate Participant	Input Service data object for Terminate Participant

Response Payload

Element Name	Type	Description
result	Incentive Compensation Terminate Participant	Returns Service data object for Terminated Participant

findParticipantPlan

Operation used to search participant comp plan.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
findCriteria	{http://xmlns.oracle.com/adf/svc/types/}FindCriteria	Criteria to find Participant Plan
BusinessUnitName	string	Business Unit Name
PlanName	string	Compensation Plan Name
ParticipantName	string	Participant Name
PartyNumber	string	Party Number
PartyId	long	Party Identifier
ParticipantEmail	string	Participant Email Address
PersonNumber	string	Person Number
findControl	{http://xmlns.oracle.com/adf/svc/types/}FindControl	Common Data Object to retrieve all translations in response

Response Payload

Element Name	Type	Description
result	Incentive Compensation Participant Plan Search SDO	List of Participant plans matching the criteria

updateParticipantPlan

Operation used to update the Participant comp plan details.

Life Cycle Status: Active

Request Payload

Element Name	Type	Description
srpCompensationPlanDetail	Incentive Compensation Participant Plan SDO	The service data object for updating the participant plan.

Response Payload

Element Name	Type	Description
result	Incentive Compensation Participant Plan SDO	Returns updated participant plan

getDfltObjAttrHints

An operation to retrieve 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 locale-based user interface hints. The localeName is in 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

An operation that returns the date and time 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

An operation to get 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 on 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_PARTICIPANT_DETAIL_PRIV	Maintain Incentive Compensation Participant Detail	Allows assignment of participants to analysts, who manage incentive compensation details for a person or organization whose credits, attainment, earnings, disputes, and payments the incentive compensation application computes and manages. A person or organization can be an employee, salesperson, party, supplier contract, partner, or third party resale contractor.

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_PARTICIPANT_DETAIL_PRIV	ORA_CN_INCENTIVE_COMPENSATION_PARTICIPANT_PLAN_MANAGEMENT_DUTY	Incentive Compensation Participant Snapshot Management	Assign and maintain incentive plans and transactions for participants