Thursday, May 21, 2020

How to automate value sets values load using Web Service in Oracle HCM Cloud environment

How to automate value sets values load using ESS job process :
--------------------------------------------------------------------------------------------------------------------------

Step 1 : Create a value set value load file (ABC_Value_Set_Value_Load.txt) as below :
--------------------------------------------------------------------------------------------------------------------------

ValueSerCode|Value|TranslatedValue|Description|EnabledFlag|StartDateActive|EndDateActive|SortOrder
ABC|9999 9999 9999 9999||Test ABC1|N|1901-01-01|4712-12-31|1
ABC|9999 9999 9999 9998||Test ABC2|N|1901-01-01|4712-12-31|2
ABC|9999 9999 9999 9997||Test ABC3|N|1901-01-01|4712-12-31|3


Step 2 : Convert the values of the input file (ABC_Value_Set_Value_Load.txt) into Base64 encoding.
--------------------------------------------------------------------------------------------------------------------------

(For testing purpose I have used "https://www.base64encode.org/"). Once the conversion is done, the Base64 value will be looking like below.

VmFsdWVTZXJDb2RlfFZhbHVlfFRyYW5zbGF0ZWRWYWx1ZXxEZXNjcmlwdGlvbnxFbmFibGVkRmxhZ3xTdGFydERhdGVBY3RpdmV8RW5kRGF0ZUFjdGl2ZXxTb3J0T3JkZXIKQUJDfDk5OTkgOTk5OSA5OTk5IDk5OTl8fFRl
c3QgQUJDMXxOfDE5MDEtMDEtMDF8NDcxMi0xMi0zMXwxCkFCQ3w5OTk5IDk5OTkgOTk5OSA5OTk4fHxUZXN0IEFCQzJ8TnwxOTAxLTAxLTAxfDQ3MTItMTItMzF8MgpBQkN8OTk5OSA5OTk5IDk5OTkgOTk5N3x8VGVzdCBB
QkMzfE58MTkwMS0wMS0wMXw0NzEyLTEyLTMxfDM=


Step 3 : Upload the file details in UCM. We get the Document Id in response. This will also upload the file into UCM.
--------------------------------------------------------------------------------------------------------------------------

Web Service details below :

WSDL Url : https://************************.com/publicFinancialCommonErpIntegration/ErpIntegrationService?WSDL
Action    : POST
Method Name : uploadFileToUcm
Description : The method uploads a file to the UCM server based on the document specified.

Request Payload :

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
  <ns1:uploadFileToUcm xmlns:ns1="http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationService/types/">
<ns1:document xmlns:ns2="http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationService/">
<ns2:Content>VmFsdWVTZXJDb2RlfFZhbHVlfFRyYW5zbGF0ZWRWYWx1ZXxEZXNjcmlwdGlvbnxFbmFibGVkRmxhZ3xTdGFydERhdGVBY3RpdmV8RW5kRGF0ZUFjdGl2ZXxTb3J0T3JkZXIKQUJDfDk5OTkgOTk5OSA5OTk5IDk5OTl8fFRlc3QgQUJDMXxOfDE5MDEtMDEtMDF8NDcxMi0xMi0zMXwxCkFCQ3w5OTk5IDk5OTkgOTk5OSA5OTk4fHxUZXN0IEFCQzJ8TnwxOTAxLTAxLTAxfDQ3MTItMTItMzF8MgpBQkN8OTk5OSA5OTk5IDk5OTkgOTk5N3x8VGVzdCBBQkMzfE58MTkwMS0wMS0wMXw0NzEyLTEyLTMxfDM=</ns2:Content>
<ns2:FileName>ABC_Value_Set_Value_Load.txt</ns2:FileName>
<ns2:ContentType>txt</ns2:ContentType>
<ns2:DocumentTitle>ABC_Value_Set_Value_Load.txt</ns2:DocumentTitle>
<ns2:DocumentAuthor>Sourav</ns2:DocumentAuthor>
<ns2:DocumentSecurityGroup>FAFusionImportExport</ns2:DocumentSecurityGroup>
  <ns2:DocumentAccount>hcm$/dataloader$/import$</ns2:DocumentAccount>
  </ns1:document>
  </ns1:uploadFileToUcm>
 </soap:Body>
</soap:Envelope>


--------------------------------------------------------------------------------------------------------------------------
*** Note : Please navigate to "https://************************.com/cs" in UCM and check for the file whether the upload is successful or not for testing.
--------------------------------------------------------------------------------------------------------------------------


Step 4 : Submit the ESS Job Request. We get the Request Id in response.
--------------------------------------------------------------------------------------------------------------------------

Web Service details below :

WSDL Url : https://************************.com/publicFinancialCommonErpIntegration/ErpIntegrationService?WSDL
Action    : POST
Method Name : submitESSJobRequest
Description : Submits an ESS job request for the specified job definition

Request Payload :
<soap: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/fnd/applcore</typ:jobPackageName>
<typ:jobDefinitionName>FndValueSetUploadServiceJob</typ:jobDefinitionName>
<typ:paramList>ABC_Value_Set_Value_Load.txt</typ:paramList>
<typ:paramList>hcm/dataloader/import</typ:paramList>
</typ:submitESSJobRequest>
</soapenv:Body>
</soap:Envelope>


Step 5 : Get the status of the ESS Job submit. We get the Job status in response. Pass the request id here what was received in web service response from step 4.
--------------------------------------------------------------------------------------------------------------------------

Web Service details below :

WSDL Url : https://************************.com/publicFinancialCommonErpIntegration/ErpIntegrationService?WSDL
Action    : POST
Method Name : getEssJobStatus
Description : Obtains the execution status of the submitted ESS job.

Request Payload :

<soap: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:getEssJobStatus>
<typ:requestId>181036</typ:requestId>
</typ:getEssJobStatus>
</soapenv:Body>
</soap:Envelope>


Step 6 : Downloads the ESS job output and the logs as a zip file : We get the log file details in response (in binary format)
--------------------------------------------------------------------------------------------------------------------------

Web Service details below :

WSDL Url : https://************************.com/publicFinancialCommonErpIntegration/ErpIntegrationService?WSDL
Action    : POST
Method Name : downloadESSJobExecutionDetails
Description : Downloads the ESS job output and the logs as a zip file.

Request Payload :

<soap: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:downloadESSJobExecutionDetails>
<typ:requestId>181036</typ:requestId>
</typ:downloadESSJobExecutionDetails>
</soapenv:Body>
</soap:Envelope>


--------------------------------------------------------------------------------------------------------------------------
*** Note : To get the successful insert,update and error details (feedback), the log file should be read. Log file will be having the details of summary.
--------------------------------------------------------------------------------------------------------------------------


Step 7 (Optional): To get the details of the input file below web service can be used. Pass the Document Id what was received from the response of web service in step 3.
--------------------------------------------------------------------------------------------------------------------------

Web Service details below :

WSDL Url : https://************************.com/publicFinancialCommonErpIntegration/ErpIntegrationService?WSDL
Action    : POST
Method Name : getDocumentForDocumentId
Description : Downloads the job output file generated by the importBulkData operation.

Request Payload :

<soap: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:getDocumentForDocumentId>
<typ:DocumentId>132324</typ:DocumentId>
</typ:getDocumentForDocumentId>
</soapenv:Body>
</soap:Envelope>

No comments:

Post a Comment

How to get rid of "Exception during RestAction" error from Employee Self Service functionality while submitting Absence

 After RedWood is being applied, while navigating to Add Absence functionality under Me tab, if it is throwing an Rest error, then follow th...