Incentive Compensation Participant Export Web Service
Service to retrieve participant identifiers from the Oracle HCM Cloud person, Oracle Sales Cloud Customer Data Management party, and Oracle Sales Cloud Incentive Compensation participant. For example, you can retrieve the party identifier, person identifier, person number, and business unit. You can also retrieve the participant identifier, which you can add to relevant transaction data for collection and processing.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/incentiveCompensation/cn/participants/participantSetup/participantSetupService/}ParticipantExportService
Service WSDL URL: https://servername/fscmService/ParticipantExportService?WSDL
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 |
Operations
recoverParticipantInformation
Finds participant records with values that match the specified input criteria.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
businessUnit |
string |
The name of the business unit. |
|
|
string |
The participant email. |
|
name |
string |
The name of the participant. |
|
partyOriginalSystemId |
string |
The unique identifier of the participant originating system. |
|
partyOriginalSystem |
string |
The originating system of the participant. |
|
creationDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The date when the participant record was created. |
|
startDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The participant active start date. |
|
partyType |
string |
The participant type. Valid values are Participant and Analyst. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
List of participants that match the specified criteria. |
findParticipantInformation
Finds and returns a list of participants that match the specified input criteria.
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 participants. |
|
partyId |
long |
The unique identifier of the participant party in the Trading Community Model. |
|
personId |
string |
The unique identifier of the participant in Oracle HCM Cloud. |
|
emailAddress |
string |
The participant email. |
|
partySystemIdentifier |
string |
The unique identifier of the participant party originating system. |
|
personNumber |
string |
The participant person number. |
|
orgId |
long |
The unique identifier of the business unit to which the participant belongs. You can view the business unit identifier for a business unit from the Setup and Maintenance, Define Business Units task. |
|
creationDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The date when the participant record was created. |
|
originatingSystem |
string |
The originating system of the participant party. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The control object used as a placeholder for finding participants. Not currently used. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The list of participants that match the specified criteria. |
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_REGISTER_INCENTIVE_COMPENSATION_PARTICIPANT_PRIV |
Register Incentive Compensation Participant |
Allows import of incentive compensation participant, a person or organization. For example, an employee, salesperson, party, supplier contract, partner, or third party resale contractor whose data and payments the incentive compensation application computes and manages. |
Privileges to Duty Roles Mapping
| Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
|---|---|---|---|
|
CN_REGISTER_INCENTIVE_COMPENSATION_PARTICIPANT_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_REGISTER_INCENTIVE_COMPENSATION_PARTICIPANT_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_ADMINISTRATOR_JOB |
Incentive Compensation Application Administrator |
Set up incentive compensation application |