Award (Deprecated)
Service to operate on a financial instrument granted by a sponsor to a grantee for conducting research. For example, funding a university department to study cell biology or funding a hospital for cancer research.
Life Cycle Status: Deprecated
QName: {http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardService/}AwardService
Service WSDL URL: https://servername/fscmService/AwardService?WSDL
Logical Business Objects
-
Projects : Grants Management : Award
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 |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
Operations
createAward
Creates an award and its details.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
awardHeader |
Award |
Attribute required to create an award. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Created award and child objects. |
updateAward
Updates an award and its details.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
awardHeader |
Award Update |
Award attributes that can be updated, such as award purpose or type. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Updated award and child objects. |
mergeAward
Updates an award and its details. If the award does not exist, a new one is created.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
awardHeader |
Award |
This service data object contains attributes that are specific in creating an award. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Merged award and child objects. |
deleteAwardOrganizationCredit
Deletes the organization credit for the award or award project.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
awardOrganizationCredit |
Award Organization Credit Delete |
Attribute required to delete an organization credit for the award. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
void |
Deleted organization credit. If the method fails, the award organization credit is not deleted. |
deleteAwardReference
Deletes a reference type for the award or award project.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
awardReference |
Award Reference Type Delete |
Attribute required to delete a reference type for the award. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
void |
Deleted award reference. If the method fails, the award reference is not deleted. |
deleteAwardCertification
Deletes a certification for the award or award project.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
awardCertification |
Award Certification Delete |
Attribute required to delete a certification for the award. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
void |
Deleted award certification. If the method fails, the award certification is not deleted. |
deleteAwardBudgetPeriod
Deletes a budget period for the award.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
awardBudgetPeriod |
Award Budget Period Delete |
Attribute required to delete a budget period for the award. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
void |
Deleted budget period. If the method fails, the award budget period is not deleted. |
deleteAwardKeyword
Deletes a keyword for the award or award project.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
awardKeyword |
Award Keyword Delete |
Attribute required to delete a keyword for the award. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
void |
Deleted award keyword. If the method fails, the award keyword is not deleted. |
deleteAwardPersonnel
Deletes a person assigned to the award or award project.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
awardPersonnel |
Award Personnel Delete |
Attribute required to delete a personnel for the award. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
void |
Deleted award personnel. If the method fails, the award personnel is not deleted. |
deleteAwardTerms
Deletes terms and conditions for the award.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
awardTerms |
Award Terms and Conditions Delete |
Attribute required to delete the terms and conditions for the award. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
void |
Deleted award terms and conditions. If the method fails, the award terms and conditions are not deleted. |
getAwardAttachments
Retrieves a specific award attachment.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
awardId |
long |
The unique internal identifier of the award. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Award attachments that match the specified criteria. |
deleteAwardAttachment
Deletes an attachment for the award.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
attachmentId |
long |
The unique internal identifier of the award attachment. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
void |
Deleted award attachment. If the method fails, the award attachment is not deleted. |
deleteAwardCfda
Deletes a federal domestic assistance program for the award.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
awardCfda |
Award Federal Domestic Assistance Program Delete |
Attribute required to delete a federal domestic assistance program for the award. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
void |
Deleted federal assistance program. If the method fails, the award federal domestic assistance program is not deleted. |
validateAward
Operation to validate an award.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
awardId |
long |
The unique internal identifier of the award. |
awardNumber |
string |
Service data object for award number to uniquely identify an award. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Validated award and child objects. |
getAward
Retrieves a specific award and its details.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
awardId |
long |
The unique internal identifier of the award. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
{http://xmlns.oracle.com/apps/projects/grantsManagement/award/service/awardService/}AwardHeaderForCreateResult |
Award and child objects that match the specified criteria. |
findAward
Finds awards.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
findCriteria |
{http://xmlns.oracle.com/adf/svc/types/}FindCriteria |
The filter criteria for the query. |
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
The control properties for the query. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Award and the child objects that match the specified criteria. |
getDfltObjAttrHints
Retrieves 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
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, in ISO 8601 format, when the service definition was last changed,. |
getEntityList
Retrieves 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 |
GMS_RUN_IMPORT_AWARD_PROCESS_PRIV |
Run Import Award Process |
Allows the import of awards, award projects, and award funding from external application using the Awards open interface. |
All Operations |
GMS_MANAGE_AWARD_SERVICE_PRIV |
Manage Award Service |
Allows access to award service for management of award information such as keywords, funding sources, and budget periods. |
Privileges to Duty Roles Mapping
Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
---|---|---|---|
GMS_RUN_IMPORT_AWARD_PROCESS_PRIV |
ORA_PJF_PROJECT_INTEGRATION_SPECIALIST_JOB |
Project Integration Specialist |
Individual responsible for planning, coordinating, and supervising all activities related to the integration of project management information systems. |
GMS_RUN_IMPORT_AWARD_PROCESS_PRIV |
ORA_PJF_PROJECTS_APPLICATION_ADMINISTRATOR_JOB |
Project Application Administrator |
Collaborates with project application users to maintain consistent project application configuration, rules, and access. |
GMS_MANAGE_AWARD_SERVICE_PRIV |
ORA_PJF_GRANTS_ADMINISTRATOR_JOB |
Grants Administrator |
Assists the principal investigator with the administrative functions of an award and its related projects, particularly with data collection and data entry tasks. |
GMS_MANAGE_AWARD_SERVICE_PRIV |
ORA_PJF_PRINCIPAL_INVESTIGATOR_JOB |
Principal Investigator |
Controls and monitors the technical direction and academic quality of research projects such as laboratory studies or clinical trials. Ensures that projects comply with the terms, conditions, and policies defined by the sponsor and the institution. Owns ultimate responsibility for the management of the sponsored research award, especially in cases where funding is obtained from federal agencies such as the NIH or NSF. |
GMS_MANAGE_AWARD_SERVICE_PRIV |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
Grants Department Administrator |
Assists the principal investigator with the administrative functions of an award and its related projects, particularly with data collection and data entry tasks for one or more departments within the enterprise. |
GMS_MANAGE_AWARD_SERVICE_PRIV |
ORA_GMS_GRANTS_MANAGEMENT_ADMINISTRATION_DUTY |
Grants Management Administration |
Configures business unit implementation options, reference types, grants personnel, keywords, institutions, and other setup objects. |
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_PJF_PRINCIPAL_INVESTIGATOR_JOB |
ORA_GMS_AWARD_MANAGEMENT_DUTY |
Award Management |
Creates awards and related contract information. Manages award information such as keywords, funding sources, and budget periods. Manages projects associated with awards. Manages funding assigned to the award and allocated to projects and tasks. Submits process to update financial performance data for awards and award projects and views the financial data. Generates reports for submission to federal agencies. |
ORA_PJF_GRANTS_ADMINISTRATOR_JOB |
ORA_GMS_AWARD_MANAGEMENT_DUTY |
Award Management |
Creates awards and related contract information. Manages award information such as keywords, funding sources, and budget periods. Manages projects associated with awards. Manages funding assigned to the award and allocated to projects and tasks. Submits process to update financial performance data for awards and award projects and views the financial data. Generates reports for submission to federal agencies. |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_GMS_AWARD_MANAGEMENT_DUTY |
Award Management |
Creates awards and related contract information. Manages award information such as keywords, funding sources, and budget periods. Manages projects associated with awards. Manages funding assigned to the award and allocated to projects and tasks. Submits process to update financial performance data for awards and award projects and views the financial data. Generates reports for submission to federal agencies. |
ORA_PJF_GRANTS_ADMINISTRATOR_JOB |
ORA_OKC_CONTRACT_AMENDMENT_DUTY |
Contract Amendment |
Amends approved contracts. This includes initiating an amendment, reverting the contract to the previous signed version, updating all allowable attributes, and submitting the amendment for approval. |
ORA_PJF_PRINCIPAL_INVESTIGATOR_JOB |
ORA_OKC_CONTRACT_AMENDMENT_TEAM_DUTY |
Contract Amendment Team |
Amends approved contracts honoring team access. This includes initiating an amendment, reverting the contract to the previous signed version, updating all allowable attributes, and submitting the amendment for approval. |
ORA_PJF_GRANTS_ADMINISTRATOR_JOB |
ORA_OKC_CONTRACT_AUTHORING_DUTY |
Contract Authoring |
Authors contracts, including terms and conditions, interactions, and customer account information. |
ORA_PJF_PRINCIPAL_INVESTIGATOR_JOB |
ORA_OKC_CONTRACT_AUTHORING_TEAM_DUTY |
Contract Authoring Team |
Authors contracts, including terms and conditions, interactions, and customer account information honoring team access. |
ORA_PJF_GRANTS_ADMINISTRATOR_JOB |
ORA_OKC_CONTRACT_SEARCH_VIEW_DUTY |
Contract Search and View Access |
Searches and views contracts for the assigned business units. |
ORA_PJF_PRINCIPAL_INVESTIGATOR_JOB |
ORA_OKC_CONTRACT_SEARCH_VIEW_TEAM_DUTY |
Contract Search and View Access Team |
Searches and views contracts for the assigned business units by honoring team access. |
ORA_PJF_GRANTS_ADMINISTRATOR_JOB |
ORA_OKC_CONTRACT_SETUP_DUTY |
Contract Setup |
Contract Setup |
ORA_PJF_PROJECTS_APPLICATION_ADMINISTRATOR_JOB |
ORA_OKC_CONTRACT_SETUP_DUTY |
Contract Setup |
Contract Setup |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_OKC_CONTRACT_SETUP_DUTY |
Contract Setup |
Contract Setup |
ORA_PJF_GRANTS_ADMINISTRATOR_JOB |
ORA_OKC_CONTRACT_TERMS_AUTHORING_OVERRIDE_DUTY |
Contract Terms and Conditions Override Controls |
Edits protected clauses, and deletes mandatory clauses and sections in addition to authoring nonstandard terms and conditions. |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_OKC_CONTRACT_TERMS_AUTHORING_OVERRIDE_DUTY |
Contract Terms and Conditions Override Controls |
Edits protected clauses, and deletes mandatory clauses and sections in addition to authoring nonstandard terms and conditions. |
ORA_PJF_PRINCIPAL_INVESTIGATOR_JOB |
ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY |
FSCM Load Interface Administration |
Manages load interface file for import |
ORA_PJF_GRANTS_ADMINISTRATOR_JOB |
ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY |
FSCM Load Interface Administration |
Manages load interface file for import |
ORA_PJF_PROJECTS_APPLICATION_ADMINISTRATOR_JOB |
ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY |
FSCM Load Interface Administration |
Manages load interface file for import |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY |
FSCM Load Interface Administration |
Manages load interface file for import |
ORA_PJF_PROJECT_INTEGRATION_SPECIALIST_JOB |
ORA_FUN_FSCM_LOAD_INTERFACE_ADMIN_DUTY |
FSCM Load Interface Administration |
Manages load interface file for import |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_OKC_GRANT_CONTRACT_AMENDMENT_DUTY |
Grant Contract Amendment |
Amends approved grant contracts. This includes initiating an amendment, reverting the contract to the previous signed version, updating all allowable attributes, and submitting the amendment for approval. |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_OKC_GRANT_CONTRACT_AUTHORING_DUTY |
Grant Contract Authoring |
Authors grant contracts, including terms and conditions, interactions, and customer account information. |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_OKC_GRANT_CONTRACT_SEARCH_VIEW_DUTY |
Grant Contract Search and View Access |
Searches and views grant contracts for the assigned business units. |
ORA_PJF_PROJECTS_APPLICATION_ADMINISTRATOR_JOB |
ORA_GMS_GRANTS_MANAGEMENT_ADMINISTRATION_DUTY |
Grants Management Administration |
Configures business unit implementation options, reference types, grants personnel, keywords, institutions, and other setup objects. |
ORA_PJF_PROJECTS_APPLICATION_ADMINISTRATOR_JOB |
ORA_GL_PROJECTS_PERIOD_STATUS_MANAGEMENT_DUTY |
Manage Projects Accounting Period Status |
Manages Oracle Fusion Projects period status. |
ORA_PJF_GRANTS_ADMINISTRATOR_JOB |
ORA_PER_MANAGE_USER_AND_ROLES_DUTY_FSCM |
Manage Users |
Creates and updates users and assigns roles to users. |
ORA_PJF_PROJECTS_APPLICATION_ADMINISTRATOR_JOB |
ORA_PER_MANAGE_USER_AND_ROLES_DUTY_FSCM |
Manage Users |
Creates and updates users and assigns roles to users. |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_PER_MANAGE_USER_AND_ROLES_DUTY_FSCM |
Manage Users |
Creates and updates users and assigns roles to users. |
ORA_PJF_PRINCIPAL_INVESTIGATOR_JOB |
ORA_OKC_CONTRACT_TERMS_AUTHORING_NON_STANDARD_DUTY |
Nonstandard Contract Terms and Conditions Authoring |
Authors nonstandard terms and conditions in addition to standard terms and conditions. Nonstandard terms authoring includes editing standard clauses, creating nonstandard clauses, deleting nonstandard clauses and sections, and removing contract terms. |
ORA_PJF_GRANTS_ADMINISTRATOR_JOB |
ORA_OKC_CONTRACT_TERMS_AUTHORING_NON_STANDARD_DUTY |
Nonstandard Contract Terms and Conditions Authoring |
Authors nonstandard terms and conditions in addition to standard terms and conditions. Nonstandard terms authoring includes editing standard clauses, creating nonstandard clauses, deleting nonstandard clauses and sections, and removing contract terms. |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_OKC_CONTRACT_TERMS_AUTHORING_NON_STANDARD_DUTY |
Nonstandard Contract Terms and Conditions Authoring |
Authors nonstandard terms and conditions in addition to standard terms and conditions. Nonstandard terms authoring includes editing standard clauses, creating nonstandard clauses, deleting nonstandard clauses and sections, and removing contract terms. |
ORA_PJF_GRANTS_ADMINISTRATOR_JOB |
ORA_PJF_PROJECT_ADMINISTRATOR_JOB |
Project Administrator |
Assists the project manager with the administrative functions of a project, particularly the functions related to collecting and entering information into the project application. |
ORA_PJF_GRANTS_ADMINISTRATOR_JOB |
ORA_PJO_PROJECT_BUDGET_BASELINE_CREATION_DUTY |
Project Budget Baseline Creation |
Allows creation of baseline version of project budget. |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_PJO_PROJECT_BUDGET_BASELINE_CREATION_DUTY |
Project Budget Baseline Creation |
Allows creation of baseline version of project budget. |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_PJO_PROJECT_BUDGET_MANAGEMENT_DUTY |
Project Budget Management |
Creates, edits, and deletes working budget versions. Edits versions in Excel. Submits versions for baseline creation. |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_PJF_PROJECT_DEFINITION_DUTY |
Project Definition |
Edits project and task attributes. |
ORA_PJF_PROJECTS_APPLICATION_ADMINISTRATOR_JOB |
ORA_PJT_PROJECT_EXECUTION_APPLICATION_ADMINISTRATION_DUTY |
Project Execution Application Administration |
Performs setup tasks such as defining progress thresholds, default calendar options for projects and resources, enterprise codes for projects and tasks, and calendars to establish work schedules for projects and resources. Manages project enterprise resources, project roles, resource pools, target utilization percentages, and project enterprise resource maintenance conditions. Initiates processes to maintain the project resource search index. |
ORA_PJF_PROJECTS_APPLICATION_ADMINISTRATOR_JOB |
ORA_PJF_PROJECT_FINANCIAL_APPLICATION_ADMINISTRATION_DUTY |
Project Financial Application Administration |
Performs setup tasks for project costing and manages project costing business objects such as expenditure type, expenditure categories, rate schedules, and burden schedules. Performs setup tasks for contract billing and project performance reporting. Configures project plan types, financial plan types, spread curves, and period profiles. Configures setup options for integrating with external scheduling applications. |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_PJO_PROJECT_PLAN_MANAGEMENT_DUTY |
Project Plan Management |
Creates, edits, and deletes task assignments and views project progress. |
ORA_PJF_PROJECTS_APPLICATION_ADMINISTRATOR_JOB |
ORA_PJT_PROJECT_RESOURCE_ASSIGNMENT_DUTY |
Project Resource Assignment |
Directly assigns a resource to a project without approval from the resource manager. Edits project resource assignment attributes such as from and to dates, effort, allocation percentage, and cost and bill rates. |
ORA_PJF_PROJECTS_APPLICATION_ADMINISTRATOR_JOB |
ORA_PRJ_REVIEW_APPROVAL_TRANSACTIONS_DUTY |
Project Transaction Approval Reviewing |
Allows viewing the status of project transactions due for approval and taking appropriate action to expedite the approval process. |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_PJF_PROJECTS_REPORTING_ANALYSIS_DUTY |
Projects Reporting Analysis |
Access project Business Intelligence Applications data. |
ORA_PJF_PRINCIPAL_INVESTIGATOR_JOB |
ORA_XCC_TRANSACTIONAL_DUTY |
Transaction Entry with Budgetary Control |
Manages the budgetary control tasks by job roles who perform transactions that are subject to budgetary control, such as accounts payable manager. |
ORA_PJF_GRANTS_ADMINISTRATOR_JOB |
ORA_XCC_TRANSACTIONAL_DUTY |
Transaction Entry with Budgetary Control |
Manages the budgetary control tasks by job roles who perform transactions that are subject to budgetary control, such as accounts payable manager. |
ORA_PJF_GRANTS_DEPARTMENT_ADMINISTRATOR_JOB |
ORA_XCC_TRANSACTIONAL_DUTY |
Transaction Entry with Budgetary Control |
Manages the budgetary control tasks by job roles who perform transactions that are subject to budgetary control, such as accounts payable manager. |