0% found this document useful (0 votes)
150 views

How To Submit ESS Process Using Web Services in Fusion Applications (Doc ID 2261832.1)

Uploaded by

renga.thiru19
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
150 views

How To Submit ESS Process Using Web Services in Fusion Applications (Doc ID 2261832.1)

Uploaded by

renga.thiru19
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 9

3/11/2021 Document 2261832.

1
Copyright (c) 2021, Oracle. All rights reserved. Oracle Confidential.

How to Submit ESS Process Using Web Services in Fusion Applications? (Doc ID 2261832.1)

In this Document

Goal
Solution
Collect Information about the ESS process
Run the process from Scheduled Processes
Run SQLs to get ESS runtime information
Submit ESS process using ESS Web Services
Identify the WSDL URL
Create the Payload to invoke submitRequest operation
Payload to invoke submitRequest operation with Notification
More information
Possible Issues in SOAP UI
Submit ESS process using ERP Integration Service
Identify the WSDL URL
Create the Payload to invoke submitESSJobRequest operation
More information
Summary

APPLIES TO:

Oracle Fusion Inventory Management Cloud Service - Version 11.13.19.01.0 to 11.13.19.01.0 [Release 1.0]
Oracle Fusion Payables Cloud Service - Version 11.12.1.0.0 to 11.12.1.0.0 [Release 1.0]
Oracle Fusion Application Toolkit - Version 11.1.9.2.0 and later
Oracle Fusion Payments Cloud Service - Version 11.13.20.04.0 to 11.13.20.04.0 [Release 1.0]
Oracle Fusion Financials Common Module Cloud Service - Version 11.1.10.0.0 and later
Information in this document applies to any platform.

GOAL

How to submit an ESS process using web services in Fusion Applications?

SOLUTION

In this article will be showing two ways of submitting an ESS process using web services:

Using ESS Web Services


Using Financials ERP Integration Service

Collect Information about the ESS process

Run the process from Scheduled Processes

As a best practice first run the ESS process from the standard UI of Scheduled Processes. This will help to gather information
regarding the job that need to be invoked.

https://mosemp.us.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=5ft1iw1ss_8466&id=2261832.1 1/9
3/11/2021 Document 2261832.1

Will take as an example running Generate Cloud Usage Metrics (Metadata Name = CloudMetricsNumberOfNamedUsers)

Process ID: 44626

Parameters

argument1: NAMED_USERS_FUN
argument2: M

Run SQLs to get ESS runtime information

Use the following SQLs to gather information that will be needed when running the Web Service:

SQL to gather job definition and application runtime details:

select DEFINITION, APPLICATION


from FUSION.ESS_REQUEST_HISTORY
where requestid=44626

DEFINITION APPLICATION
JobDefinition://oracle/apps/ess/hcm/users/CloudMetricsNumberOfNamedUsers EarHcmEss

SQL to gather runtime job parameters details:

select NAME,DATATYPE,VALUE
from FUSION.ESS_REQUEST_PROPERTY
where requestid=44626
and name like 'submit%'

NAME DATATYPE VALUE


submit.argument1 String NAMED_USERS_FUN
submit.argument2 String M

https://mosemp.us.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=5ft1iw1ss_8466&id=2261832.1 2/9
3/11/2021 Document 2261832.1

SQL to gather notification parameter details

select NAME, DATATYPE, VALUE


from FUSION.ESS_REQUEST_PROPERTY
where requestid=44626
and name like 'pp%'

NAME DATATYPE VALUE


pp.1.argument1 String USER
pp.1.argument2 String MyRecipientUserToBeNotified
pp.1.description String Notify
pp.1.on_error String Y
pp.1.on_success String Y
pp.1.on_warning String Y
pp.1.status String C
pp.action.1 String Notify

Submit ESS process using ESS Web Services

Identify the WSDL URL

ESS Web Services are exposed in multiple product domains. In order the job to be submitted correctly it should be invoked
from the domain and the server where the application of the job reside.

Since the job that have been taken as example is a HCM job will use the HCM domain ESS WSDL URL:

https://myPOD.hcm.myDC.oraclecloud.com/ess/esswebservice?wsdl

Similar for other domains like Financials can be used: https://myPOD.fin.myDC.oraclecloud.com/ess/esswebservice?wsdl

For Rel13 onward the ESS WSDL URL is:

https://myPOD.fa.myDC.oraclecloud.com/ess/esswebservice?wsdl

for BI Cloud Adaptor Job which is defined in the BICCC application in the BI Domain the URL would be:

https://myPOD.fa.myDC.oraclecloud.com/bi/ess/esswebservice?wsdl

For more details see http://aseng-


wiki.us.oracle.com/asengwiki/display/ASAnalyticApps/ESS+Web+service+invocation+of+BI+Cloud+Adaptor+Job

BUG 25661096 - Rel 13 SMC: ESS Web service URL from OHS redirects to ESS_SOAServer

[This section is not visible to customers.]

Create the Payload to invoke submitRequest operation

Using the results from the 2 above SQLs create the payload. Here is an example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://xmlns.oracle.com/scheduler"


xmlns:typ="http://xmlns.oracle.com/scheduler/types">
<soapenv:Header/>
<soapenv:Body>
<sch:submitRequest>
<sch:description>Running Cloud Usage Metrics As Web Service</sch:description>

https://mosemp.us.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=5ft1iw1ss_8466&id=2261832.1 3/9
3/11/2021 Document 2261832.1
<sch:jobDefinitionId>
<typ:name>CloudMetricsNumberOfNamedUsers</typ:name>
<typ:packageName>/oracle/apps/ess/hcm/users</typ:packageName>
<typ:type>JOB_DEFINITION</typ:type>
</sch:jobDefinitionId>
<sch:application>EarHcmEss</sch:application>
<sch:requestedStartTime>2017-05-03T12:30:00</sch:requestedStartTime>
<sch:requestParameters>
<typ:parameter>
<typ:dataType>STRING</typ:dataType>
<typ:name>submit.argument1</typ:name>
<typ:value>NAMED_USERS_FUN</typ:value>
</typ:parameter>
<typ:parameter>
<typ:dataType>STRING</typ:dataType>
<typ:name>submit.argument2</typ:name>
<typ:value>M</typ:value>
</typ:parameter>
</sch:requestParameters>
</sch:submitRequest>
</soapenv:Body>
</soapenv:Envelope>

The response will include the process ID of the submitted job and message will look like:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://www.w3.org/2005/08/addressing">


<env:Header>
<wsa:Action>submitRequest</wsa:Action>
<wsa:MessageID>urn:uuid:f1d875e4-d718-40ba-9a8e-65733cf0733f</wsa:MessageID>
<wsa:RelatesTo>uuid:d0e80ef4-acb2-451a-84fb-b2bd2d31bec0</wsa:RelatesTo>
</env:Header>
<env:Body>
<ns0:submitRequestResponse xmlns:ns0="http://xmlns.oracle.com/scheduler">
<requestId xmlns:ns2="http://xmlns.oracle.com/scheduler/types">44627</requestId>
</ns0:submitRequestResponse>
</env:Body>
</env:Envelope>

Payload to invoke submitRequest operation with Notification

Using the above SQL to collect the notification properties the following payload can be built:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://xmlns.oracle.com/scheduler"


xmlns:typ="http://xmlns.oracle.com/scheduler/types">
<soapenv:Header/>
<soapenv:Body>
<sch:submitRequest>
<sch:description>Running Cloud Usage Metrics As Web Service With Notification</sch:description>
<sch:jobDefinitionId>
<!--Optional:-->
<typ:name>CloudMetricsNumberOfNamedUsers</typ:name>
<!--Optional:-->
<typ:packageName>/oracle/apps/ess/hcm/users</typ:packageName>
<!--Optional:-->
<typ:type>JOB_DEFINITION</typ:type>
</sch:jobDefinitionId>
<sch:application>EarHcmEss</sch:application>
<sch:requestedStartTime>2017-05-18T13:37:00</sch:requestedStartTime>
<sch:requestParameters>
<typ:parameter>
<typ:dataType>STRING</typ:dataType>
<typ:name>submit.argument1</typ:name>
<typ:scope/>
<typ:value>NAMED_USERS_FUN</typ:value>
</typ:parameter>
<typ:parameter>
<typ:dataType>STRING</typ:dataType>
<typ:name>submit.argument2</typ:name>
<typ:scope/>
<typ:value>M</typ:value>
</typ:parameter>
<typ:parameter>
<typ:dataType>STRING</typ:dataType>
<typ:name>pp.1.argument1</typ:name>
<typ:scope/>
<typ:value>USER</typ:value>
</typ:parameter>
<typ:parameter>
<typ:dataType>STRING</typ:dataType>
<typ:name>pp.1.argument2</typ:name>
<typ:scope/>
<typ:value>MyRecipientUserToBeNotified</typ:value>
</typ:parameter>
https://mosemp.us.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=5ft1iw1ss_8466&id=2261832.1 4/9
3/11/2021 Document 2261832.1
<typ:parameter>
<typ:dataType>STRING</typ:dataType>
<typ:name>pp.action.1</typ:name>
<typ:scope/>
<typ:value>Notify</typ:value>
</typ:parameter>
<typ:parameter>
<typ:dataType>STRING</typ:dataType>
<typ:name>pp.1.description</typ:name>
<typ:scope/>
<typ:value>Notify</typ:value>
</typ:parameter>
<typ:parameter>
<typ:dataType>STRING</typ:dataType>
<typ:name>pp.1.on_error</typ:name>
<typ:scope/>
<typ:value>Y</typ:value>
</typ:parameter>
<typ:parameter>
<typ:dataType>STRING</typ:dataType>
<typ:name>pp.1.on_success</typ:name>
<typ:scope/>
<typ:value>Y</typ:value>
</typ:parameter>
<typ:parameter>
<typ:dataType>STRING</typ:dataType>
<typ:name>pp.1.on_warning</typ:name>
<typ:scope/>
<typ:value>Y</typ:value>
</typ:parameter>
<typ:parameter>
<typ:dataType>STRING</typ:dataType>
<typ:name>pp.1.status</typ:name>
<typ:scope/>
<typ:value>C</typ:value>
</typ:parameter>
</sch:requestParameters>
</sch:submitRequest>
</soapenv:Body>
</soapenv:Envelope>

The response will include the process ID of the submitted job and message will look like:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://www.w3.org/2005/08/addressing">


<env:Header>
<wsa:Action>submitRequest</wsa:Action>
<wsa:MessageID>urn:uuid:e36565c7-dc9e-44cf-9fa3-30ed8a9cbfee</wsa:MessageID>
<wsa:RelatesTo>uuid:c9fa10ce-85ef-4077-aa15-c634c6ab69c8</wsa:RelatesTo>
</env:Header>
<env:Body>
<ns0:submitRequestResponse xmlns:ns0="http://xmlns.oracle.com/scheduler">
<requestId xmlns:ns2="http://xmlns.oracle.com/scheduler/types">45355</requestId>
</ns0:submitRequestResponse>
</env:Body>
</env:Envelope>

The parameter details to create the payload can also be obtain if running the getRequestDetail operation:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sch="http://xmlns.oracle.com/scheduler">
<soapenv:Header/>
<soapenv:Body>
<sch:getRequestDetail>
<sch:requestId>44626</sch:requestId>
</sch:getRequestDetail>
</soapenv:Body>
</soapenv:Envelope>

More information

https://mosemp.us.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=5ft1iw1ss_8466&id=2261832.1 5/9
3/11/2021 Document 2261832.1
For more details refer to ESS Web Services documentation: Oracle Fusion Middleware Developer's Guide for Oracle Enterprise Scheduler 11g Release
1 (11.1.1.7) - Using the Oracle Enterprise Scheduler Web Service

Possible Issues in SOAP UI

In WS-Addressing tab settings ensure to check the Generate MessageID: Randomly generate MessageID:

https://mosemp.us.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=5ft1iw1ss_8466&id=2261832.1 6/9
3/11/2021 Document 2261832.1

Otherwise the following error may occur:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://www.w3.org/2005/08/addressing">


<env:Header>
<FaultDetail xmlns="http://www.w3.org/2005/08/addressing">
<ProblemHeaderQName>wsa:MessageID</ProblemHeaderQName>
</FaultDetail>
<wsa:Action>http://www.w3.org/2005/08/addressing/fault</wsa:Action>

https://mosemp.us.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=5ft1iw1ss_8466&id=2261832.1 7/9
3/11/2021 Document 2261832.1
</env:Header>
<env:Body>
<env:Fault>
<faultcode>wsa:MessageAddressingHeaderRequired</faultcode>
<faultstring>A required header representing a Message Addressing Property is not present</faultstring>
</env:Fault>
</env:Body>
</env:Envelope>

Submit ESS process using ERP Integration Service

Identify the WSDL URL

ERP Integration Service is part of Financials web services. The WSDL URL will be in the following format:

https://myPOD.fin.myDC.oraclecloud.com/publicFinancialCommonErpIntegration/ErpIntegrationService?wsdl

For Rel13 onward the ESS WSDL URL is:

https://myPOD.fa.myDC.oraclecloud.com/fscmService/ErpIntegrationService?WSDL

Create the Payload to invoke submitESSJobRequest operation

Using the results from the 2 above SQLs create the payload. Here is an example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:typ="http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationService/types/">
<soapenv:Header/>
<soapenv:Body>
<typ:submitESSJobRequest>
<typ:jobPackageName>/oracle/apps/ess/hcm/users</typ:jobPackageName>
<typ:jobDefinitionName>CloudMetricsNumberOfNamedUsers</typ:jobDefinitionName>
<typ:paramList>NAMED_USERS_FUN</typ:paramList>
<typ:paramList>M</typ:paramList>
</typ:submitESSJobRequest>
</soapenv:Body>
</soapenv:Envelope>

The response will include the process ID of the submitted job and message will look like:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://www.w3.org/2005/08/addressing">


<env:Header>

<wsa:Action>http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationService//ErpIntegrationServic
<wsa:MessageID>urn:uuid:4630539c-3a8c-4a61-904d-f3d7e6cac1e9</wsa:MessageID>
</env:Header>
<env:Body>
<ns0:submitESSJobRequestResponse
xmlns:ns0="http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationService/types/">
<result
xmlns="http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationService/types/">44632</result>
</ns0:submitESSJobRequestResponse>
</env:Body>
</env:Envelope>

More information

For more details refer to ERP Integration Service documentation: Oracle Financials Cloud - SOAP Web Services for Oracle Financials Cloud - ERP
Integration Service

Using External Data Integration Services

Since the ERP Integration Service is built by Financials, support and assistance is done by the Financials Support Team.

Summary

Users do not need to pass all the parameters and values. Some jobs have more than 40 parameters. Developers can omit parameters where NULL is
the value.

https://mosemp.us.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=5ft1iw1ss_8466&id=2261832.1 8/9
3/11/2021 Document 2261832.1

Didn't find what you are looking for?

Document Attributes
Author: SCIOBANU.RO; Status: PUBLISHED(EXTERNAL)
Owner: WHOROWIT.US Publisher: WHOROWIT.US
Alias: Content Type: TEXT/X-HTML
Distribution: EXTERNAL Visibility: EXTERNAL
Created By: SCIOBANU.RO Created: May 3, 2017
Modified By: GNOLIVOS.US Modified: Jan 14, 2021
Reviewed By: WHOROWIT.US Reviewed: Mar 10, 2021
Source: AWIZ Exception: No
Priority: 3

https://mosemp.us.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=5ft1iw1ss_8466&id=2261832.1 9/9

You might also like