Incentive Compensation Calendar Period Status
Service to retrieve the current status of an incentive compensation calendar period. You can also use the service to close the calendar period. To close the period, payment batches must be paid and prior periods must not have a status of Not Opened, Future Entry, or Open.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/incentiveCompensation/cn/systemSetup/calendarService/}PeriodStatusService
Service WSDL URL: https://servername/fscmService/IncentivePeriodStatusService?WSDL
Logical Business Objects
-
IC : Incentive Compensation : Incentive Compensation Calendar
Operations
getPeriodStatus
Gets the period status for a given calendar period and business unit.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
orgName |
string |
The business unit to which the calendar belongs. You assign a calendar to your business unit using the Setup and Maintenance, Manage Parameters task. |
|
periodName |
string |
The calendar period name. You define period names for your calendar using the Setup and Maintenance, Manage Calendars task. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
The status of the period. |
closePeriod
Closes the calendar period for a business unit.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
orgName |
string |
The business unit to which the calendar belongs. You assign a calendar to your business unit using the Setup and Maintenance, Manage Parameters task. |
|
periodName |
string |
The calendar period name. You define period names for your calendar using the Setup and Maintenance, Manage Calendars task. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
The request ID of the close period process. |
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 payload output date and time for when the schema files, referenced in the service definition, last changed. |
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_CONFIGURE_INCENTIVE_COMPENSATION_TABLES_AND_COLUMNS_PRIV |
Configure Incentive Compensation Tables and Columns |
Allows configuration of tables and columns required for incentive compensation processing. |
|
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_CONFIGURE_INCENTIVE_COMPENSATION_TABLES_AND_COLUMNS_PRIV |
ORA_CN_INCENTIVES_ADMINISTRATION_DUTY |
Incentive Compensation Administration |
Configure and maintain incentive compensation enterprise and business unit setup. |
|
CN_CONFIGURE_INCENTIVE_COMPENSATION_TABLES_AND_COLUMNS_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_ADMINISTRATOR_JOB |
Incentive Compensation Application Administrator |
Set up incentive compensation application |
|
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 |