ERP Integration Service

Provides external operations for ERP integration scenarios to execute end-to-end inbound and outbound data flows. It also tracks the status of inbound and outbound data processes.

Life Cycle Status: Active

QName: {http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationService/}ErpIntegrationService

Service WSDL URL: https://servername/fscmService/ErpIntegrationService?WSDL

Relationships

The following table describes how this business object service is related to service data objects or other business object services.

Relationship Type Object or Service

Handles

Document Information SDO

Handles

Process Details SDO

Handles

Document Information

Operations

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.

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 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 upload 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 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.

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 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

Document Information

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.

getDocumentsForFilePrefix

Gets 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

Document Information

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.

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 output of Enterprise Scheduling Service job and logs.

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

Document Information

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

Returns the status code for the operation.

downloadExportOutput

The operation that downloads the output of an 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

Document Information

The output associated with a particular Enterprise Scheduling Service job that was executed.

loadAndImportData

Uploads a file to the Oracle Universal Content Management server based on the document specified and submits the Enterprise Scheduling Service jobs to import and process the uploaded file.

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.

jobList

Process Details

List of elements, each containing the details of the Enterprise Scheduling Service job to be submitted to import and process the uploaded file. The details include the job definition name, job package name, and list of parameters.

interfaceDetails

string

The interface whose data is to be loaded.

notificationCode

string

A two-digit number that represents the manner and timing in which a notification is sent.

callbackURL

string

The callback URL of the service implemented by customers to receive the Enterprise Scheduling Service job status on completion of the job.

Response Payload

Element Name Type Description

result

long

Returns the response code containing error details.

confirmExtractConsumption

Retrieves the comment for a file from the Universal Content Management Server using a document identifier to retrieve the incremental date.

Life Cycle Status: Active

Request Payload

Element Name Type Description

jobName

string

Contains a combination of the job package name and job definition name, separated by a comma.

documentIDs

string

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 status code for the operation.

updateInterfaceData

This method updates error data in interface tables pertaining to the specified import process and load request ID.

Life Cycle Status: Active

Request Payload

Element Name Type Description

processName

string

ERP Interface options import job name.

loadRequestId

string

Load Request ID.

document

{http://xmlns.oracle.com/adf/svc/types/}base64Binary-DataHandler

User uploaded blobDomain with corrected interface table data.

Response Payload

Element Name Type Description

result

void

importBulkData

Uploads a file to the Oracle Universal Content Management server based on the document specified and submits the ESS jobs to import and process the uploaded file with multiple options.

Life Cycle Status: Active

Request Payload

Element Name Type Description

document

Document Information SDO

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.

jobDetails

Process Details

List of elements, each containing the details of the ESS job to be submitted to import and process the uploaded file. The details include the job definition name, job package name, and list of parameters.

notificationCode

string

Two digit code representing the type and when a notification is to be sent.

callbackURL

string

The callback URL of the service implemented by the customers to receive the ESS job status on job completion.

jobOptions

string

A web service operation input parameter. It designates the specific inbound bulk data processing variation selected and the output file type that will be generated upon completion of the data processing.

Response Payload

Element Name Type Description

result

long

Returns response code containing error details

extractAndPurge

Submits ESS jobs to upload the load and import job output to the Universal Content Management server and purge interface tables with callback and notification.

Life Cycle Status: Active

Request Payload

Element Name Type Description

requestIds

string

The request Ids of load job and import jobs.

notificationCode

string

Two digit code representing the type and when a notification is to be sent.

callbackURL

string

The callback URL of the service implemented by the customers to receive the ESS job status on job completion.

jobOptions

string

A web service operation input parameter which will allow new attributes to be used for future enhancements to ensure data model flexibility.

Response Payload

Element Name Type Description

result

long

Returns the request ID of the first submitted ESS job.

exportBulkData

Submits an ESS job to export and uploads the job output to the Universal Content Management server with callback and notification.

Life Cycle Status: Active

Request Payload

Element Name Type Description

jobName

string

The ESS job package name and definition name for the ESS job that must be submitted.

parameterList

string

Parameters used to invoke the ESS job.

jobOptions

string

A web service operation input parameter which will allow new attributes to be used for future enhancements to ensure data model flexibility.

callbackURL

string

The callback URL of the service implemented by the customers to receive the ESS job status on job completion.

notificationCode

string

Two digit code representing the type and when a notification is to be sent.

Response Payload

Element Name Type Description

result

long

Returns the request ID of the submitted ESS job.

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, call 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 and value paired format.

getServiceLastUpdateTime

An operation that returns the date and time when the schema files last changed.

Life Cycle Status: Active

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 that retrieves the list of service data objects associated with the ERP Integration Service.

Life Cycle Status: Active

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.