Financial Utilities Service (Deprecated)
Provides external operations for ERP integration scenarios to execute basic inbound and outbound data flows. The ERP Integration Service supersedes the Financial Utilities Service. In addition to other operations, it supports all the Financial Utilities Service operations.
Life Cycle Status: Deprecated. This service is deprecated and replaced by .
QName: {http://xmlns.oracle.com/apps/financials/commonModules/shared/financialUtilService/}FinancialUtilService
Service WSDL URL: https://servername/fscmService/FinancialUtilService?WSDL
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 |
|---|---|
|
Next version is |
|
|
Handles |
Operations
submitESSJobRequest
Submits an Enterprise Scheduling Service job request for the specified job definition.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
jobPackageName |
string |
The Enterprise Scheduling Service job package name for the job that must be submitted. |
|
jobDefinitionName |
string |
The Enterprise Scheduling Service job definition name for the job that must be submitted. |
|
paramList |
string |
List of parameters used to invoke the Enterprise Scheduling Service job. The order of the parameters is maintained as per the list. The corresponding entry in the list should be blank when a given parameter is not passed. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
long |
Returns the request ID of the submitted Enterprise Scheduling Service job. |
submitJobWithOutput
Submits an Enterprise Scheduling Service job to export and uploads the job output to the Universal Content Management server.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
jobPackageName |
string |
The Enterprise Scheduling Service job package name for the job that must be submitted. |
|
jobDefinitionName |
string |
The Enterprise Scheduling Service job definition name for the job that must be submitted. |
|
callbackURL |
string |
The callback URL of the service implemented by the customers to receive the Enterprise Scheduling Service job status on completion of the job. |
|
paramList |
string |
List of parameters used to invoke the Enterprise Scheduling Service job. The order of the parameters is maintained per the list. The corresponding entry in the list should be blank when a given parameter is not passed. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
long |
Returns the request ID of the submitted Enterprise Scheduling Service job. |
getESSJobStatus
Obtains the request status of the submitted Enterprise Scheduling Service job.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
requestId |
long |
The request ID of the submitted Enterprise Scheduling Service job. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Returns the current status of the Enterprise Scheduling Service job. |
getDocumentsForFilePrefix
Retrieves the files that match the file prefix and specified account. These files do not contain the specified comments.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
prefix |
string |
The file prefix to search for the files that start with a specified prefix. |
|
account |
string |
The account parameter to search for the files that belongs to a specified security account. |
|
comments |
string |
The comments that are not present in the files. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Returns a list of elements, each containing the details of the downloaded files. The details include the document ID, file content, file name, content type, file title, author, security group, and account. |
getDocumentIdsForFilePrefix
Gets the document identifiers for files that match the file prefix and specified account. These files do not contain the specified comments.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
prefix |
string |
The file prefix to search for the files that start with a specified prefix. |
|
account |
string |
The account parameter to search for the files that belongs to a specified security account. |
|
comments |
string |
The parameter to pass the comments. Files that do not have the comments are retrieved. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Returns a list of document Identifiers. |
getDocumentForDocumentId
The operation is used to get the document that matches the given Document Identifier.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
DocumentId |
string |
The numeric document identifier of a file. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Returns a list of elements, each containing the details of the downloaded files. The details include the document ID, file content, file name, content type, file title, author, security group, and account. |
appendFileComment
Appends the specified comments to a file.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
documentId |
string |
The numeric document identifier of a file. |
|
comments |
string |
Appends the specified comments to a file. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
Appends the specified comments to a file. |
uploadFileToUcm
Uploads a file to the Universal Content Management server based on the document specified.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
document |
Document Information |
List of elements, each containing the details of the file to be uploaded. The details include the file content, file name, content type, file title, author, security group, and account. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Returns the document ID of the uploaded file. |
downloadESSJobExecutionDetails
Downloads the Enterprise Scheduling Service job output and the logs as a zip file.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
requestId |
string |
The request ID of the submitted Enterprise Scheduling Service job. |
|
fileType |
string |
The file type to determine the execution details to download. Specify the file type as log to download the log and output file. Specify the file type as out to download the output file. When no file type is specified, both the log files and output files are downloaded. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Returns a list of elements, each containing the details of the downloaded files. The details include the document ID, file content, file name, content type, file title, author, security group, and account. |
downloadExportOutput
The method downloads the output of the Enterprise Scheduling Service job.
Life Cycle Status: Deprecated
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
requestId |
string |
The parameter to pass the request ID of the Enterprise Scheduling Service job. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The list of document details is returned. |
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 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
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 the 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, or delete operations can be performed on the object. |