Automating HCM Data Loader R11 (October 2017) White Paper

Automating HCM Data LoaderOracle Fusion Human Capital Management 11g Release 11 (11.1.11) ORACLE WHITE PAPER | OCTOBER 2017 Table of Contents Introduction 1 Oracle WebCenter Content 2 Security 2 Methods of Staging Files on the WebCenter Content Server 2 File Import and Export Interface 2 WebCenter Content Document Transfer Utility Interface 2 How to Define the WebCenter Content URL 3 Other Command Line Parameters 4 WebCenter Content Generic SOAP Web Service 4 Invoking WebCenter Content Generic SOAP Web Service with Inline Content 4 Invoking WebCenter Content Generic SOAP Web Service with MTOM/XOP 5 Parameters 6 HCM Data Loader 6 Security 7 Methods of Initiating HCM Data Loader 7 Import and Load Data Interface 7 HCM Data Loader Integration Service 7 Import and Load Data Method 7 Get Data Set Status Method 8 Sample Code to Invoke and Monitor HCM Data Loader 10 Invoking HCM Data Loader 10 Implications of Security Policy on the HCMDataLoader Web Service 11 0 | AUTOMATING HCM DATA LOADER How to Create a Proxy Class 12 How to Invoke the importAndLoadData Web Service 13 How to Invoke the getDataSetStatus Web Service 14 Automating the Initiation of Multiple Files with HCM Data Loader 16 HCM Extracts 21 HCM Extracts in the Payroll Flow Engine 21 Invoking HCM Extracts 22 Monitoring the Extract 23 Retrieving HCM Extracts XML 24 HCM Extract Oracle BI Report Output Location 25 1 | AUTOMATING HCM DATA LOADER ....................................................................... Invoking WebCenter Content Generic SOAP Web Service with Inline Content .................. 10 Figure 5........... 16 Figure 8: Example .......... 20 Figure 9: Example of the Output of the HCM Data Loader Automation Method ................ Example Invocation Command for the WebCenter Content Document Transfer Utility ......................... Invoking HCM Data Loader ............ 11 Figure 6: Example of Invoking the HCM Data Loader getDataSetStatus Method .............. 6 Figure 4............. 3 Figure 2................................................................................................................................ 22 2 | AUTOMATING HCM DATA LOADER ..Invoking the HCM Data Loader Automation Method ................ 5 Figure 3...................................... 16 Figure 7: Example of the Output of the HCM Data Loader getDataSetStatus Method ..................Table of Figures Figure 1.............................................. Invoking WebCenter Content Generic SOAP Web Service with MTOM/XOP ........................................................... 21 Figure 10: Flow Pattern for an HCM Extract .................................................................... Example of a Certificate in a Service WWSDL File .......................................................................... see the Integrating with Oracle HCM Cloud guide on the Oracle Help Center at https://docs.com/en/.Introduction This document describes how to automate the HCM Data Loader processes to load your data successfully into Oracle HCM Cloud and extract both status information and error details. Files to be loaded with HCM Data Loader must first be uploaded to the Oracle WebCenter Content server.oracle. This document covers three topics: » Oracle WebCenter Content How to automate the upload of your file » HCM Data Loader How to automate the submission of your file » HCM Extracts How to automate and retrieve output from the HCM Data Loader Data Set Summary Revisions Date Description 13 October 2017 New section on the Get Data Set Status Method 1 | AUTOMATING HCM DATA LOADER . For general guidelines on the use of HCM Data Loader. 1. Once a file is staged.jar) which requires the Oracle JRF Web Service supporting libraries and uses JAX/WS over HTTPS to communicate with the Oracle WebCenter Content Server. 2 | AUTOMATING HCM DATA LOADER .ucm.1. The Document Transfer Utility currently comes in two forms: 1. It offers secure file-management capabilities and is used by many Oracle Fusion applications. 2.com/technetwork/middleware/webcenter/content/downloads/wcc-11g-downloads-2734036. Security In order to upload files to the WebCenter Content server.Oracle WebCenter Content Oracle WebCenter Content is the infrastructure for the staging of data files for processing by HCM Data Loader.fa_genericclient_11. Once the component zip file is downloaded.ucm. extract its contents. which is a feature-rich Java library that encapsulates Oracle WebCenter Content RIDC and uses standard HTTPS to communicate with the Oracle WebCenter Content server. The preferred generic SOAP-based transfer utility (oracle. WebCenter Content Document Transfer Utility Interface The WebCenter Content Document Transfer Utility for Oracle Fusion Applications is a feature-rich Java library that provides content export and import capabilities. details of which are also provided in this document. The utility can be evaluated from the Individual Component Downloads section of the Oracle WebCenter Content 11gR1 Downloads tab on Oracle Technology Network (OTN): http://www.oracle. This document reviews methods of staging a file for HCM Data Loader on the WebCenter Content server. Open the Individual Component Downloads section on the Downloads tab. This form of the tool might not work in the Oracle Fusion Applications environment because of authentication obstacles that currently cannot be handled universally and programmatically.html Note: Current customers download from Oracle Software Delivery Cloud. The original RIDC-based transfer utility (oracle. and download the WebCenter Content Document Transfer Utility.1). accept the license agreement.fa_client_11. it can be processed by invoking an externally available web service. your user must have the following duty role: » File Import and Export Management Duty (FND_FILE_IMPORT_AND_EXPORT_MANAGEMENT_DUTY) Methods of Staging Files on the WebCenter Content Server You can stage a zip file on the WebCenter Content server using: » The Oracle Applications Cloud File Import and Export interface » The WebCenter Content Document Transfer Utility » WebCenter Content Generic SOAP Web Service File Import and Export Interface This method of loading files to the WebCenter Content server is fully documented in the HCM Data Loader User’s Guide on My Oracle Support (document ID 1664133.1.jar).1. com/setup/faces/TaskListManagerTop Modify this URL by removing from /setup/faces/Task… and replacing it with /idcws.fa_genericclient_11.jar UploadTool --url=https://{host}/idcws --policy=oracle/wss_username_token_over_ssl_client_policy --username=<provide_user_name> --password=<provide_password> --primaryFile="<provide_file_path_with_filename>" --dDocTitle="<provide_zip_filename>" --dSecurityGroup=FAFusionImportExport --dDocAccount=hcm/dataloader/import For example: java -jar oracle.com/idcws This method of defining the WebCenter Content URL applies to all examples given in this document.. Upload successful.oracleoutsourcing.1.zip" --dDocTitle="Department Load File" --dSecurityGroup=FAFusionImportExport --dDocAccount=hcm/dataloader/import Figure 1.In addition. the zip file contains Java code samples for programmatic invocation and a useful readme file describing required library dependencies for the generic client as well as the sample invocation command shown in Figure 1. It should look like the following example: https://fs-xxxxxxxxxxx. java -jar oracle.1. Example Invocation Command for the WebCenter Content Document Transfer Utility Sample Output: Oracle WebCenter Content Document Transfer Utility Oracle Fusion Applications Copyright (c) 2013-2014.1. Oracle. 3 | AUTOMATING HCM DATA LOADER . Performing upload (CHECKIN_UNIVERSAL) .jar UploadTool --url=https://{host}/idcws --policy=oracle/wss_username_token_over_ssl_client_policy --username=HCM_IMPL --password=Welcome1 --primaryFile="/scratch/HRDataFile. The above URL would now be as follows: https://fs-xxxxxxxxxxx.oracleoutsourcing.ucm. All rights reserved. Obtain the URL for Setup and Maintenance from the Service Details section in the cloud environments provisioning email that your service administrator received.ucm. [dID=21537 | dDocName=UCMFA021487] How to Define the WebCenter Content URL The URL in the command line uses the same domain name as your service..fa_genericclient_11.1. zip</ucm:Field> <ucm:File href="HRDataFile. Refer to the Oracle Fusion Middleware Security and Administrator's Guide for Web Services for further details.Other Command Line Parameters The dDocName value (which is equivalent to the content ID) returned when executing the above statement is required for the HCMDataLoader call described later in this document. Invoking WebCenter Content Generic SOAP Web Service with Inline Content Figure 2 shows the sample request payload for uploading an HCM Data Loader zip file with inline content.xmlsoap. The WSDL for the web service is available at the following location: https://fs-xxxxxxxxxxx. http://{host}/idcws/GenericSoapPort <soapenv:Envelope xmlns:soapenv="http://schemas. Review the readme file downloaded with the WebCenter Content Document Transfer Utility for a list of all parameters.org/soap/envelope/" xmlns:ucm="http://www.xmlsoap.zip" name="primaryFile"> <ucm:Contents>hQEMA+8YN513c6VEAQf9EstURU0V2erP9hNIP34P6cvwdi2G8hmtTY4dj+jpjSBiBwF28SzOGO5Q T/S6LDM1lAd9fHDFO4CFTEUkiMiAfa4jCpkh2kjvrV05GYiy9rlYGbgjRa38t0Boj0G8dkZia4kw lD5zloegTb4k9dp2ZXtAkJjVPTlmaVs7wPjqHJOk1Dtj+zUL/Dvq/X+rcmBtnvZ6+gX1r/PSBYsI ANiUK36pUac916p1wrYbePtmLs9rLB8dZTIdKE3pbi3aIKECnqnfXN3Rx8BT3afI2kWA9xEsEBwL XSgD4EUlYY2lWKM0wQrSCIfz1jit4zK+vs1Jp3zP3kSFfMH9h5b70ATYCNLpAXTmolmJxhvg9nPN RbgWGM0jWuVE7tXEVL66s2XJuV6HCyJ+3QDTSS/hEzUorpbaH7gOPdd2d9uIJayseWmgkCLhpgNM Ml4dGGDEL7ISZNKbu39MWvptFC5wrFX/VyB0E3kZF3xJ9dHz5UzVN3hiji6/ZLnUKRI+mpY41gEQ BdLm/WehWRLkF9yWhdkKOK1imBa+oLCeZg2YcCPNVqMaf42atoix9kSR+PCdB46SGnyQ2kvx0z9V t+4A/70psaMEOgPmUciQ/CNoC3vPdDs/G+p8Run/9MHoZoW5o2KpGC1M4j593BulKnfE7JZdYopG b1MS9Vrd6e4Oj3ZD7ISyrf8gEsEhvRu4se0CnAA8W2Fj2u88TOBn/rX+9NMffGwwO040a00N4upV 70xY0I0mvMzPKh4u4kHHQLaV7+fChTHIRCXFjvN2ziyGdSCYxiZ9tfhms39jPp2LxJKPnsV5GgC8 XSqpzxipYjbZjpqvKAu0k9VhIF4vHlGjTbzZuhz/CETs5Aj2LXvJksIBpDq6whUK7/LKR3hmfKXi e4xng6B4TwSEvhvRDY0+V2np1RMxzlqW0W3XNpKYqkS2kjO7vQM65CBAqeQjYAW9p1tE1k1S5G2N 1whW46eYIQvN68SzkCQIsafzoAtgKKYClEwJuxGE004i6AluJ0keWx+ZzXohyIxx8eTiw7vp5PIS tm2WTriBJ/x0gMB9CWfdymOFK9Mf</ucm:Contents> </ucm:File> 4 | AUTOMATING HCM DATA LOADER . including file upload.com/idcws/GenericSoapPort?wsdl Note: Oracle WebCenter Content web services are protected by Oracle Web Services Manager (OWSM) security policies. including advanced networking options for resolving proxy issues.com/UCM" xmlns:wsse="http://schemas.oracle.oracleoutsourcing. WebCenter Content Generic SOAP Web Service WebCenter Content exposes a SOAP web service interface (GenericSoapPort) that allows performing various operations.org/ws/2003/06/secext"> <soapenv:Header /> <soapenv:Body> <ucm:GenericRequest webKey="cs"> <ucm:Service IdcService="CHECKIN_UNIVERSAL"> <ucm:User /> <ucm:Document> <ucm:Field name="dDocTitle">Department Load File</ucm:Field> <ucm:Field name="dDocType">Document</ucm:Field> <ucm:Field name="dDocAuthor">HCM_IMPL</ucm:Field> <ucm:Field name="dSecurityGroup">FAFusionImportExport</ucm:Field> <ucm:Field name="dDocAccount">hcm$/dataloader$/import$</ucm:Field> <ucm:Field name="primaryFile">HRDataFile. 5) Connection: close ------=_Part_7_163289738. boundary="----=_Part_7_163289738. type="text/xml" Content-Transfer-Encoding: 8bit Content-ID: <[email protected]/wss/2004/01/oasis-200401-wss-username-token- profile-1.org/soap/envelope/" xmlns:ucm="http://www.0 Content-Length: 4030385 Host: {host} User-Agent: Apache-HttpClient/4.com>".org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.1476693003095" SOAPAction: "urn:GenericSoap/GenericSoapOperation" Authorization: Basic SENNX1VTRVIxMDpXZWxjb21lMQ== MIME-Version: 1.1 Accept-Encoding: gzip.0#PasswordText">Welcome1</wsse:Password> <wsse:Nonce EncodingType="http://docs.org/ws/2003/06/secext"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs. Invoking WebCenter Content Generic SOAP Web Service with Inline Content However.xmlsoap. </ucm:Document> </ucm:Service> </ucm:GenericRequest> </soapenv:Body> </soapenv:Envelope> Figure 2.0. it is recommended to call the web service using Message Transmission Optimization Mechanism (MTOM) with XML-binary Optimized Packaging (XOP). POST http://{host}/idcws/GenericSoapPort HTTP/1. charset=UTF-8.oasis-open.xsd"> <wsse:UsernameToken wsu:Id="UsernameToken-E7F52CF4494885176F147669300309413"> <wsse:Username>HCM_USER10</wsse:Username> <wsse:Password Type="http://docs.oasis-open. start="<[email protected] (java 1.oasis-open.0.094Z</wsu:Created> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <ucm:GenericRequest webKey="cs"> <ucm:Service IdcService="CHECKIN_UNIVERSAL"> <ucm:User/> <ucm:Document> <ucm:Field name="dDocTitle">Department Load File</ucm:Field> <ucm:Field name="dDocType">Document</ucm:Field> <ucm:Field name="dDocAuthor">HCM_IMPL</ucm:Field> 5 | AUTOMATING HCM DATA LOADER .0#Base64Binary">ckNXKVpwBU01PD2ENXg5nw==</wsse:Nonce> <wsu:Created>2016-10-17T08:30:03. start- info="text/xml".org/wss/2004/01/oasis-200401-wss-soap-message- security-1.xsd" xmlns:wsu="http://docs.xmlsoap. Invoking WebCenter Content Generic SOAP Web Service with MTOM/XOP Figure 3 shows the sample request payload for uploading an HCM Data Loader zip file with MTOM/XOP.1.oasis-open. as HCM Data Loader files are typically large.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.1476693003095 Content-Type: application/xop+xml.com> <soapenv:Envelope xmlns:soapenv="http://schemas.com/UCM" xmlns:wsse="http://schemas.deflate Content-Type: multipart/related. type="application/xop+xml". zip" <<< binary content ommitted for brevity >>> ------=_Part_7_163289738.zip Content-Transfer-Encoding: binary Content-ID: <HRDataFile. name="HRDataFile. name=HRDataFile. HCM Data Loader HCM Data Loader accepts only compressed zip files that have been staged on the Oracle WebCenter Content server and secured with the hcm/dataloader/import account. 6 | AUTOMATING HCM DATA LOADER .zip> Content-Disposition: attachment. This value is required only if hcm$/dataloader$/import$ accounts are enabled.1476693003095-- Figure 3. <ucm:Field name="dSecurityGroup">FAFusionImportExport</ucm:Field> <ucm:Field name="dDocAccount">hcm$/dataloader$/import$</ucm:Field> <ucm:Field name="primaryFile">HRDataFile.zip" xmlns:inc="http://www. primaryFile The absolute path to the location of the file as seen from the server As in the case of Document Transfer Utility. Parameters Parameter Meaning Comment for HCM Data Loader IdcService The service to invoke CHECKIN_UNIVERSAL for uploading files dDocName The Content ID for the content item Value passed to HcmDataLoader dDocAuthor The content item author (contributor) dDocTitle The content item title The title of the file as it appears in Import/Export UI dDocType The content item type Document dSecurityGroup The security group. such as Public or Secure FAFusionImportExport dDocAccount The account for the content item.w3.1476693003095 Content-Type: application/zip.zip" name="primaryFile"> <ucm:Contents><inc:Include href="cid:HRDataFile. the dDocName value that is a part of the response to the above calls is the content ID to be used for further HCM Data Loader processing.zip</ucm:Field> <ucm:File href="HRDataFile. filename="HRDataFile.org/2004/08/xop/include"/></ucm:Contents> </ucm:File> </ucm:Document> </ucm:Service> </ucm:GenericRequest> </soapenv:Body> </soapenv:Envelope> ------=_Part_7_163289738. Invoking WebCenter Content Generic SOAP Web Service with MTOM/XOP This table shows the parameters used in the generic SOAP web service invocation example.zip". ImportMaximumErrors The percentage of file lines in error that can occur in a business object before the import process stops ImportConcurrentThreads The number of concurrent threads when importing LoadMaximumErrors The percentage of business object instances in error that can occur for a business object before the validation and load processes stop LoadConcurrentThreads The number of concurrent threads when validating or loading LoadGroupSize The number of business objects processed as a single unit of work by a concurrent thread FileEncryption The type of file encryption DeleteSourceFile Y to purge the source file from the WebCenter Content server after processing it Name and value are paired with an equals (=) sign. Note: The ProcessId is the request ID for the concurrent process that initiates HCM Data Loader processing. None of these parameters is mandatory. the default values specified on the Configure HCM Data Loader page are used. your user must have the following role: » Human Capital Management Integration Specialist (ORA_HRC_HUMAN_CAPITAL_MANAGEMENT_INTEGRATION_SPECIALIST_JOB) Methods of Initiating HCM Data Loader You can initiate Oracle WebCenter Content staged files using: » The HCM Data Loader Import and Load Data interface » The HCM Data Loader Integration Service Import and Load Data Interface This method of initiating files for bulk load into Oracle HCM Cloud is fully documented in the HCM Data Loader User’s Guide on My Oracle Support (document ID 1664133. The following parameter names are available.Security In order to process files using HCM Data Loader. » importAndLoadData Initiates the processing of a data file. then this value is available in the Data Sets table on the Import and Load Data page. If you wish to review the progress of your data set via the user interface. For values that you do not supply. but is hidden by default. This table shows the parameters for the HcmDataLoader web service importAndLoadData method. 7 | AUTOMATING HCM DATA LOADER . It is an asynchronous job returning only the ProcessId of the submitted process. HCM Data Loader Integration Service HCM Data Loader implements a web service that can be used to initiate the import and load of data files staged on the WebCenter Content server and monitor the progress of a data file.1). Import and Load Data Method The importAndLoadData method initiates the processing of a data file hosted on the WebCenter Content server. » getDataSetStatus Returns the current status of a data file. IMPORT AND LOAD DATA PARAMETERS Parameter Description ContentId Content ID of the file on the WebCenter Content server (the same value as dDocName in the WebCenter Content Java call) Parameters Name and value pairs. Multiple parameters must be comma delimited. LoadConcurrentThreads=4. The result of the getDataSetStatus method call is an XML document with details about load and import processes: Element Description RESULTS_COUNT The total number of data sets found for the specified parameters plus the total number of processes found where no data set exists for the specified parameters DATA_SET Grouping tag DATA_SET_NAME The name of the data set CONTENT_ID The content ID assigned to the file when it was uploaded to the WebCenter Content server CREATION_DATE The date on which the data set was created STATUS The overall status of the data set ERROR_CODE Optional code of the error ERROR_MESSAGE Optional error message PROCESS Grouping tag PROCESS_ID The process ID assigned to the data set when the HCM Data Loader processing is initiated SUBMISSION_DATE The process submission date IMPORT Grouping tag STATUS The current imported status PERCENTAGE_COMPLETE The percentage of data lines processed by import 8 | AUTOMATING HCM DATA LOADER . GET DATA SET STATUS PARAMETERS Parameter Description Parameters Name and value pairs. but ProcessId is recommended.ContentId=UCMFA23411 You can supply either one or both of these parameters. Multiple parameters must be comma delimited. Examples:  ProcessId=1213  ProcessId=1231. Examples:  ImportMaximumErrors=100. The following parameter names are available.LoadMaximumErrors=100. This table shows the parameters for the HcmDataLoader web service getDataSetStatus method. DeleteSourceFile=Y  FileEncryption=PGPSIGNED Get Data Set Status Method The getDataSetStatus method returns the current status of the specified data file. ProcessId The ID of the process initiated and returned by the importAndLoadData method ContentId Content ID of the file on the WebCenter Content server (the same value as dDocName in the WebCenter Content Java call) Name and value are paired with an equals (=) sign. WARNING Import has finished with warnings. ERROR The data set or process is in error. IN_PROGRESS Import is running. DATA_SET_UNPROCESSED The process is running. CANCELLED Either data set load or data set import was cancelled. but the data set has not been processed yet. COMPLETED The data set completed successfully. ORA_CANCELLED Import was cancelled. ERROR Import has finished with errors. The import status can be one of following values: Status Description SUCCESS Import has finished successfully. UNPROCESSED Import has not been processed.Element Description DATA_LINE_COUNTS Grouping tag TOTAL The total number of data lines in the data set SUCCESS The total number of data lines in the data set successfully imported FAILED The total number of data lines in the data set with errors reported at import UNPROCESSED The total number of data lines in the data set that have yet to be imported LOAD Grouping tag STATUS The current load status PERCENTAGE_COMPLETE The percentage of objects processed by load OBJECT_COUNT Grouping tag TOTAL The total number of objects in the data set SUCCESS The total number of objects in the data set that have successfully loaded FAILED The total number of objects in the data set that failed either import or load UNPROCESSED The total number of objects in the data set that have yet to be loaded The overall data set status can be one of following values: Status Description NOT_STARTED The process has not started yet. IN_PROGRESS The process is running. The load status can be one of following values: 9 | AUTOMATING HCM DATA LOADER . It is waiting or ready. You can generate your own proxy classes by providing the URL of the service WSDL file to your generator of choice.w3. which is shown in the Service Details section of your service provision email.xmlsoap. Use the domain name given for the Service Home URL.org/2005/08/addressing"> <env:Header> <wsa:To>http://www.xmlsoap.com/apps/hcm/common/dataLoader/core/dataLoaderIntegrationService/types/"> <ns1:ContentId></ns1:ContentId> <ns1:Parameters></ns1:Parameters> </ns1:importAndLoadData> </soap:Body> </soap:Envelope> Figure 4.oracle.w3. Using the same example given earlier.org/soap/envelope/"> <soap:Body> <ns1:importAndLoadData xmlns:ns1="http://xmlns. Sample Code to Invoke and Monitor HCM Data Loader You can invoke Oracle HCM Cloud web services in several ways.com/apps/hcm/common/dataLoader/core/dataLoaderIntegrationService//HCMDataLoa der/importAndLoadDataResponse</wsa:Action> <wsa:MessageID>urn:uuid:ab36195f-775b-4688-a0e4-8a4e531e904c</wsa:MessageID> 10 | AUTOMATING HCM DATA LOADER . Refer to the Oracle Fusion Middleware Security and Administrator's Guide for Web Services for further details.com/hcmCommonDataLoader/HCMDataLoader?wsdl <env:Envelope xmlns:env="http://schemas. the above URL will be: https://hcm-xxxxxxxxxxx. ERROR Load has finished with errors. usually because import is still in progress.oracleoutsourcing. ORA_CANCELLED Load was cancelled. Invoking HCM Data Loader Figure 4 shows the request for invoking HCM Data Loader.oracle. WARNING Load has finished with warnings. http://{host}/hcmCommonDataLoader/HCMDataLoader <soap:Envelope xmlns:soap="http://schemas. Note: Oracle HCM Cloud web services are protected by Oracle Web Services Manager (OWSM) security policies. These proxy classes are then used to invoke the web service. This section explains how to invoke web services using generated proxy classes. UNPROCESSED Load has not been processed.org/soap/envelope/" xmlns:wsa="http://www. Invoking HCM Data Loader The method for resolving the URL is slightly different from the method outlined for WebCenter Content (given earlier).org/2005/08/addressing/anonymous</wsa:To> <wsa:Action>http://xmlns.Status Description SUCCESS Load has finished successfully. NOT_READY Load is not ready yet. IN_PROGRESS Load is running. When the message reaches the server.com/apps/hcm/common/dataLoader/core/dataLoaderIntegrationService/types/">7958</resul t> </ns0:importAndLoadDataResponse> </env:Body> </env:Envelope> Implications of Security Policy on the HCMDataLoader Web Service The HCMDataLoader web service is secured using the following policy: oracle/wss11_saml_or_username_token_with_message_protection_service_policy Therefore. The public key can be obtained from the certificate provided in the service WSDL file. <wsa:RelatesTo>urn:uuid:74c7b631-c20a-4d49-bf36-1f483f3dc43e</wsa:RelatesTo> </env:Header> <env:Body> <ns0:importAndLoadDataResponse xmlns:ns0="http://xmlns.com/apps/hcm/common/dataLoader/core/dataLoaderIntegrationService/types/"> <result xmlns="http://xmlns. A KeyStore is used to import the certificate and it is referenced in the subsequent client code. you need to create a local KeyStore and import the certificate into it: 11 | AUTOMATING HCM DATA LOADER . If payload encryption is desirable or otherwise required. Figure 5. then a client policy that can be used to meet this requirement is: oracle/wss11_username_token_with_message_protection_client_policy To use this policy. Example of a Certificate in a Service WWSDL File To use the key contained in this certificate.oracle. the message must be encrypted using a public key provided by the server. it can be decrypted by the server's private key.oracle. See Figure 5 (the certificate is Base64 encoded). it must satisfy the message-protection policy to ensure that the payload is transported encrypted or sent over the SSL transport layer. when a client calls the service. 3. Now you have a certificate containing the public key from the server. Using a text editor. which is available at JAVA_HOME/bin: wsimport -s <Provide the folder where the generated files need to be placed> -d <Provide the folder where the generated files need to be placed> <The HCM Data Loader Integration Service URL> Example: wsimport -s "D:\HCMDataLoader" -d "D:\ HCMDataLoader" https://{host}/hcmCommonDataLoader/HCMDataLoader?wsdl The generated files are placed in the following two folders: 12 | AUTOMATING HCM DATA LOADER .WSSEC_KEYSTORE_PASSWORD Password of your client KeyStore ClientConstants. 2.cer file> -alias orakey -keypass welcome -keystore <Provide the path where the jks file needs to be created(including the file name)> -storepass welcome 6.WSSEC_RECIPIENT_KEY_ALIAS Alias of the key you use to encrypt the SOAP message to the server How to Create a Proxy Class Generate the JAX-WS proxy class for the HCMDataLoader web service using the wsimport command.USERNAME_PROPERTY User name of the application user who has relevant privileges for importing and processing HDL data files WSBindingProvider. The following parameters are used by the proxy class to encrypt and decrypt the message. Create a new file with any name you like. 5. Open the command line and change the directory to $JAVA_HOME/bin. On the next line. JKS (Java KeyStore) is widely used and is the most common type. open the file you just created and enter "-----BEGIN CERTIFICATE-----" on the first line. copy the Base64 encoded certificate from the service WSDL file to the newly created certificate file.WSSEC_KEYSTORE_LOCATION Path of the client KeyStore file ClientConstants. 4. ClientConstants.PASSWORD_PROPERTY The password of the above user ClientConstants. You can find the KeyStore file in the KeyStore path you set. you can call the service using the proxy classes. PROXY CLASS PARAMETERS Parameter Description WSBindingProvider.WSSEC_ENC_KEY_ALIAS Alias of the key you use to decrypt the SOAP message from the server ClientConstants. Use the following command to create a KeyStore and import the public key from the certificate.WSSEC_ENC_KEY_PASSWORD Password of the key you use to decrypt the SOAP message ClientConstants.1.cer to indicate that it is a certificate file.WSSEC_KEYSTORE_TYPE Type of the KeyStore you created. You must change the extension to . Once the client KeyStore has been created. Add "-----END CERTIFICATE-----" on a new line and save the file. keytool -import -file <Provide the path of the certification. import weblogic.oracle. public class HCMDataLoaderServiceSoapHttpPortClient { @WebServiceRef private static HCMDataLoader_Service hcmDataLoader_Service.put(BindingProvider.."Provide the applications username").owsm.location".common. 13 | AUTOMATING HCM DATA LOADER .encryption. String parameters = args[1]. SecurityPolicyFeature[] securityFeatures = new SecurityPolicyFeature[] { new SecurityPolicyFeature("oracle/wss11_username_token_with_message_protection_client_policy") }.put("oracle.println("The response received from the server is .security.put("oracle.recipient. String response.ServiceException. Object> requestContext = wsbp.xmlns.oracle. requestContext. import com.webservices.jaxws.dataloaderintegrationservice.jks (including the file name)").dataloader.keystore.xmlns. requestContext.webservices. import com.core.PASSWORD_PROPERTY. import javax.wsee. requestContext.common. "orakey"). "orakey"). import javax. import java.HCMDataLoader.dataloaderintegrationservice.dataloader.security.jar -r * - How to Invoke the importAndLoadData Web Service Create the client class HCMDataLoaderServiceSoapHttpPortClient for invoking the dataloaderintegrationservice..» com » sdo Add the generated code to a JAR file: zip loaderIntegrationProxy.common.security.BindingProvider.apps.put(BindingProvider. "Provide the location of the default-keystore.importAndLoadData(contentId.").apps.hcm. import com.webservices.put("oracle. "welcome"). String contentId = args[0].alias". The class must be created in the folder: com/oracle/xmlns/apps/hcm/common/dataloader/core/dataloaderintegrationservice package com.USERNAME_PROPERTY.key.println(response).xml. public HCMDataLoaderServiceSoapHttpPortClient() { super().keystore. Map<String.hcm.key. requestContext.webservices.dataloader. "Provide the password"). HCMDataLoader hcmLoaderService = hcmDataLoader_Service.put("oracle. "JKS").apps. } public static void main(String[] args) { hcmDataLoader_Service = new HCMDataLoader_Service().ws. requestContext.put("oracle.keystore.core.security.util.hcm.out.oracle.dataloader.webservices.Map.xmlns.getHCMDataLoaderSoapHttpPort(securityFeatures). requestContext.common.ws.apps.alias". "welcome").WebServiceRef. requestContext.getRequestContext().SecurityPolicyFeature.core.dataloaderintegrationservice.xml.oracle.security.parameters). BindingProvider wsbp = (BindingProvider)hcmLoaderService.out. System.encryption.security. try { response = hcmLoaderService. System.HCMDataLoader_Service.key. requestContext.core.password".password".hcm.xmlns.jws.type".put("oracle.webservices.dataloaderintegrationservice. xmlns.apps.SecurityPolicyFeature.1.dataloaderintegrationservice.core. import javax.jaxws. import java.common. 14 | AUTOMATING HCM DATA LOADER .0.jar> com.dataloader. } catch (ServiceException e) { System.0.api_1.ws.apps.1.0.xml. public HCMDataLoaderServiceGetDataSetStatus() { super(). public class HCMDataLoaderServiceGetDataSetStatus { @WebServiceRef private static HCMDataLoader_Service hcmDataLoader_Service. The JAR file is available at the following location in the JDeveloper installation: modules/ ws.jar This JAR file is available at the following location: $MIDDLEWARE_HOME/modules If you do not have the JAR file.Map.").out.api_1.common.0.common.jar Compile the Java code: javac -classpath <Provide the path of the folder where the JAX-WS files are generated>.oracle.WebServiceRef.<Provide the location of the weblogic..HCMDataLoader_Service.xmlns.java Run the class HCMDataLoaderServiceSoapHttpPortClient to invoke the HCM Data Loader Integration Service: java -classpath <Provide the path of the folder where the JAX-WS files are generated>.println("Error occurred during the invocation of the service .xmlns.printStackTrace(). import com.api_1.1. import weblogic.hcm.oracle.ws. } } } To generate the class file you need the following JAR file: ws.0.HCMDataLoaderServiceSoapHttpPortCli ent <ContentId> <Parameters> How to Invoke the getDataSetStatus Web Service Create the client class HCMDataLoaderServiceGetDataSetStatus in the following package for invoking the getDataSetStatus() method.jar> HCMDataLoaderServiceSoapHttpPortClient. it can be can be downloaded as part of JDeveloper.core.<Provide the location of the jrf.core.BindingProvider.wsee.ServiceException.jar>.<Provide the location of the ws.xmlns.dataloader. com/oracle/xmlns/apps/hcm/common/dataloader/core/dataloaderintegrationservice package com.oracle..xml. import javax.xmlns. e.dataloaderintegrationservice.owsm.core.hcm.oracle.dataloader.util.apps.dataloaderintegrationservice.common.jws.dataloader.hcm.dataloaderintegrationservice.apps.common.oracle.hcm.dataloaderintegrationservice.core. import com.HCMDataLoader. import com.apps.0.hcm.dataloader. password".put("oracle.security.webservices.0.apps.dataloader.jar> com.. Object> requestContext = wsbp.webservices.security.jar> HCMDataLoaderServiceGetDataSetStatus. requestContext.webservices.common. Map<String.PASSWORD_PROPERTY.1. requestContext.printStackTrace().type".. "orakey"). "Provide the password").jar>.webservices.out.security. "welcome").getHCMDataLoaderSoapHttpPort(securityFeatures).security.key.put("oracle.location". String response.<Provide the location of the jrf.security.security.USERNAME_PROPERTY. } catch (ServiceException e) { System. SecurityPolicyFeature[] securityFeatures = new SecurityPolicyFeature[] { new SecurityPolicyFeature("oracle/wss11_saml_token_with_message_protection_client_policy") }.println("Error occurred during the invocation of the service .getRequestContext().api_1.jks (including the file name)").HCMDataLoaderServiceGetDataSetStatu s <ProcessId=nnnn.encryption. } public static void main(String[] args) { hcmDataLoader_Service = new HCMDataLoader_Service(). "Provide the location of the default-keystore.keystore. requestContext. requestContext.webservices. e.keystore.core. String parameters = args[0]. BindingProvider wsbp = (BindingProvider)hcmLoaderService. requestContext. Compile the Java code: javac -classpath <Provide the path of the folder where the JAX-WS files are generated>.out.ContentId=xxxx> getDataSetStatus Example Invocation of the getDataSetStatus method: 15 | AUTOMATING HCM DATA LOADER .getDataSetStatus(parameters).alias".hcm.alias"..put("oracle."). } } } Provide the necessary values in the above java file and compile.<Provide the location of the ws.webservices.put(BindingProvider.put("oracle.recipient. "welcome").password". "JKS").println("The latest Data Set Status .\n\n\n\n\n").oracle. HCMDataLoader hcmLoaderService = hcmDataLoader_Service. requestContext..out.key.println(response).<Provide the location of the weblogic.put(BindingProvider.key. System.put("oracle. try { response = hcmLoaderService.dataloaderintegrationservice.keystore. System..java Run the class HCMDataLoaderServiceGetDataSetStatus to invoke the HCM Data Loader Integration Service: java -classpath <Provide the path of the folder where the JAX-WS files are generated>.put("oracle. requestContext. requestContext.encryption. "orakey").0.xmlns."Provide the applications username"). Create the client class HCMDataLoaderServiceAutomation in the following package: 16 | AUTOMATING HCM DATA LOADER . but do not want a file to be submitted until the completion of the previous file. retrieve the current status of the data set until complete. » At regular intervals. » Invoke the next data set.Figure 6: Example of Invoking the HCM Data Loader getDataSetStatus Method Figure 7 shows the sample response of getDataSetStatus method. Figure 7: Example of the Output of the HCM Data Loader getDataSetStatus Method Automating the Initiation of Multiple Files with HCM Data Loader You may have multiple files to process. » At regular intervals. The code example below provides the following functionality: » Invoke the first data set. retrieve the current status of the data set until complete. dataloader.InputSource. 17 | AUTOMATING HCM DATA LOADER . import weblogic. import javax.put(BindingProvider. sample here is 60 secs. BindingProvider wsbp = (BindingProvider)hcmLoaderService.jks (including the file name)").dataloader.PASSWORD_PROPERTY. "JKS").password".xmlns.dataloaderintegrationservice.DocumentBuilder.BindingProvider. import org.io. } public static final long time_interval = 60000L.core.type".encryption. import java.IOException.jws.put("oracle.dom.ws.dataloaderintegrationservice.core.xmlns.Document.getRequestContext().oracle.NodeList. requestContext.put("oracle.w3c.parsers. import org.oracle.wsee. public class HCMDataLoaderServiceAutomation { @WebServiceRef private static HCMDataLoader_Service hcmDataLoader_Service. import javax.util.put(BindingProvider. "Provide the password").webservices.dataloader.common.com/oracle/xmlns/apps/hcm/common/dataloader/core/dataloaderintegrationservice package com. import javax. Map<String.apps.common.oracle.keystore.sax. requestContext.key.getHCMDataLoaderSoapHttpPort(securityFeatures). import org.xml.hcm.keystore.dataloaderintegrationservice.WebServiceRef.ws. // Provide time in milli seconds. import org.apps.common. 60000/1000 = 60 sec."Provide the applications username"). import org. public HCMDataLoaderServiceAutomation() { super().put("oracle.DocumentBuilderFactory.dom.xml.webservices.dom. "Provide the location of the default- keystore.xml.StringReader. import com.SecurityPolicyFeature. requestContext.location".xmlns. "welcome").xml.webservices.hcm.core. HCMDataLoader hcmLoaderService = hcmDataLoader_Service.oracle. "orakey").apps.parsers. SecurityPolicyFeature[] securityFeatures = new SecurityPolicyFeature[] { new SecurityPolicyFeature("oracle/wss11_saml_token_with_message_protection_client_policy") }.security.io.alias".xmlns.parsers. import javax. Object> requestContext = wsbp.webservices.apps.security.ParserConfigurationException.security.USERNAME_PROPERTY. requestContext.w3c. import com.put("oracle. import java.common.owsm.core. import java. public static void main(String[] args) { hcmDataLoader_Service = new HCMDataLoader_Service(). import javax.hcm.security.dataloader.w3c.Map.HCMDataLoader_Service.ServiceException. import com.dataloaderintegrationservice.xml. requestContext.keystore.xml. requestContext.Node.xml.jaxws.sax.HCMDataLoader.hcm.SAXException. SAXException.security.recipient. "orakey").alias". System.split(". for (String ucmIdAndParameters: individualUcmArray) { String[] array = ucmIdAndParameters. } try { System.webservices. IOException. parameters = "". requestContext.. parameters = array[1].encryption. String response = "".out.password". requestContext.out. } else if (array.webservices.println("\n\n\n\n\n\n").println("\n\nNo further processing. String ucmContentId = "". String[] individualUcmArray = ucmContentIdList.put("oracle.key.security.println("\n\nImportAndLoad() method invocation for UcmContentId " + ucmContentId + " is Successful. System.println("Invoking importAndLoad() method for ucmContentId " + ucmContentId).DeleteSourceFile=N".getDataSetStatus("ProcessId=" + processId). } catch (Exception e) { System. break. ProcessId generated is : " + processId). } } } public static boolean invokeGetDataSetStatus(HCMDataLoader hcmLoaderService.out.println(response). Long processId) throws ParserConfigurationException. "welcome"). //Example : "UCMFA0123.importAndLoadData(ucmContentId. System. String ucmContentIdList = args[0]. parameters). processId = Long. 18 | AUTOMATING HCM DATA LOADER . processId).out. if (array.length == 1) { ucmContentId = array[0].").println("\n\nInvoking the getDataSetStatus() method for UCM File " + ucmContentId + " to verify the latest status").UCMFA01234. response = hcmLoaderService.valueOf(response)..key.DeleteSourceFile=Y.println("\n\n Load Completed for Data Set with UCM Content Id " + ucmContentId). String parameters = "". ServiceException { String response = hcmLoaderService.").put("oracle.Program Exit").out. Long processId.length == 2) { ucmContentId = array[0].out. System.out. invokeGetDataSetStatus(hcmLoaderService. DocumentBuilderFactory factory = DocumentBuilderFactory..newInstance().split(". System. k < dataSeteChildNodes.1..jar> HCMDataLoaderServiceAutomation.getLength(). System. if ("DATA_SET". NodeList childList. Make sure to edit the time_interval variable based on the file size.item(k).item(k).equals(status)) { return true.item(j).getElementsByTagName("DATA_SET_STATUS").0. i++) { childList = flowList.<Provide the location of the ws. Thread.getChildNodes()..item(i).out.out. j < childList. By default. } else { try { System. if ("STATUS".getNodeName())) { String status = dataSeteChildNodes.getTextContent(). the value is 60 seconds.parse(new InputSource(new StringReader(response))).println("\n\nException while thread waiting.item(k).getChildNodes()..trim()). "). to recalculate the status .getLength(). { for (int k = 0.out.getTextContent(). } } } } } } } } } return false. processId). if ("COMPLETED".equals(childDSNode..getNodeName())) { NodeList dataSeteChildNodes = childNode. } catch (InterruptedException e) { System.println("Current Status of the Data Set " + dataSeteChildNodes. for (int i = 0.println("Waiting for " + (time_interval / 1000) + " secs. invokeGetDataSetStatus(hcmLoaderService.sleep(time_interval).getLength().Program Exit"). for (int j = 0. Compile the Java code: javac -classpath <Provide the path of the folder where the JAX-WS files are generated>. i < flowList.0. Document document = builder.api_1. k++) { { Node childDSNode = dataSeteChildNodes. } } The above automation code checks the status of the data set based on the time_interval value provided.. j++) { Node childNode = childList.equals(status) || "ERROR".java 19 | AUTOMATING HCM DATA LOADER .newDocumentBuilder().trim(). NodeList flowList = document.equals(childNode. DocumentBuilder builder = factory. apps. 20 | AUTOMATING HCM DATA LOADER .<Provide the location of the jrf.oracle.HCMDataLoaderServiceAutomation <ContentId=xxxx.Run the class HCMDataLoaderServiceAutomation to invoke the HCM Data Loader Integration Service: java -classpath <Provide the path of the folder where the JAX-WS files are generated>.DeleteSourceFile=N.hcm. You can optionally provide HCM Data Loader service parameters for each file by delimiting the parameter name and value pairs with semi-colons (.LoadConcurrentThreads=4|ContentId=UCMFA131236. Figure 8: Example .common.dataloaderintegrationservice.).DeleteSourceFile=N|ContentId=xxxx> HCM Data Loader Service Automation Parameters The list of WebCenter Content server IDs for each file to be processed should be delimited using pipe (|) characters.core.jar>.<Provide the location of the weblogic.Invoking the HCM Data Loader Automation Method Figure 9 shows the sample response of HCM Data Loader Automation method.dataloader. For example: ContentId=UCMFA131235.Loa dConcurrentThreads=4 HCMDataLoaderServiceAutomation Example Figure 8 shows the sample command to invoke HCM Data Loader Automation method.xmlns.jar> com. When you use HCM Extracts as part of an integrated process. HCM Extracts in the Payroll Flow Engine The Payroll Flow Engine is a generic processing engine that has the capability to invoke a wide range of different types of processes. it generates a flow object in the payroll flow data model with the same name as the HCM extract itself. When an HCM extract is defined. once the extract is complete. It generates raw XML and provides the capability to integrate with Oracle Business Intelligence (BI) Publisher to generate formatted output in a variety of supported formats.Figure 9: Example of the Output of the HCM Data Loader Automation Method HCM Extracts HCM Extracts is a powerful tool in Oracle HCM Cloud that is used for reporting and outbound integrations. In addition. it is likely that the output needs to be retrieved for subsequent processing. It is the mechanism by which HCM Extracts are invoked. This flow is used to control the processing of the HCM extract. you may need to invoke it automatically as part of an automated flow. including setting any parameters 21 | AUTOMATING HCM DATA LOADER . The method to invoke the HCM extract is FlowActionsService. and hence the way in which an HCM extract can be automated. HCM Data Loader delivers the HCM Data Loader Data Set Summary and Compensation Changes extracts. The ability to manage the invocation of a flow and the tasks within it is the key to being able to automate a process through the Payroll Flow Engine.submitFlow. Figure 10: Flow Pattern for an HCM Extract Invoking HCM Extracts A payroll flow can be invoked from outside Oracle HCM Cloud using the FlowActionsService. but additional tasks can be added. Further details about these two extracts and how to copy them are available from the HCM Data Loader Extracts document (MOS Doc ID: 1664133. This method has the following parameters: Parameter Name Description Flow Name The name of the HCM extract Flow Instance Name The identifier of the particular instance of the extract to be run Legislative Data Group Name The name of the legislative data group Recurring Flag Set to false. there is just one step (or task) in the flow. it is recommended that you make a copy of the predefined extract and edit the default definition to suit your requirements.1). By default. HDL Data Set Summary. Parameters Name value pairs of parameters (see following example) 22 | AUTOMATING HCM DATA LOADER . When you save a copy of an HCM extract. which is the mechanism by which HCM Extracts can be automated.and handling the individual steps within the flow. This may involve generating an Oracle BI Publisher layout. for example. you also create a payroll flow of type EXTRACT with the same name as the saved extract. a flow instance is created. When a specific HCM extract flow is invoked. Before either can be used. oracle. there is only one task to perform.com/apps/hcm/processFlows/core/flowControllerService/"> <soapenv:Header/> <soapenv:Body> <typ:submitFlow> <typ:flowName>HDL Data Set Summary</typ:flowName> <typ:flowInstanceName>HDL_Summary_1</typ:flowInstanceName> <typ:legislativeDataGroupName>US Legislative Data Group extract</typ:legislativeDataGroupName> <typ:recurringFlag>false</typ:recurringFlag> <typ:parameterValues> <flow:ParameterName>Content ID</flow:ParameterName> <flow:ParameterValue>UCMFA23931</flow:ParameterValue> <flow:ParameterName>Show Messages</flow:ParameterName> <flow:ParameterValue>Y</flow:ParameterValue> <flow:ParameterName>Show StackTrace</flow:ParameterName> <flow:ParameterValue>N</flow:ParameterValue> </typ:parameterValues> </typ:submitFlow> </soapenv:Body> </soapenv:Envelope> Monitoring the Extract When the HCM extract is invoked.com/apps/hcm/processFlows/core/flowActionsService/types/" xmlns:flow="http://xmlns.Example <soapenv:Envelope xmlns:soapenv="http://schemas.getFlowTaskInstanceStatus method. While the task is being performed. The parameters for this method are as follows: Parameter Name Description Flow Instance Name The identifier of the particular instance of the extract to be run Flow Task Instance Name The name of the specific task to monitor Legislative Data Group The name of the legislative data group The status values that could be returned are: Status Returned Meaning COMPLETED Complete ERROR0 Error ESS_CHILD_JOB_COMPLETED ESS child job completed ESS_CHILD_JOB_NOT_FOUND ESS child job not found ESS_CHILD_JOB_SUBMITTED ESS child job has been submitted ESS_CHILD_JOB_SUB_ERROR ESS child job submission error ESS_MT_SERV_NOT_FOUND ESS Metadata service not found 23 | AUTOMATING HCM DATA LOADER . You can monitor status changes using the FlowActionsService.xmlsoap.org/soap/envelope/" xmlns:typ="http://xmlns. In this case.oracle. its status is maintained by the Payroll Flow Engine. it executes each of the tasks according to the flow task sequence. The parameters for this method are as follows: Parameter Name Description Flow Instance Name The identifier of the particular instance of the extract to be run Flow Task Name The name of the specific task to monitor Mode Set to FLOW.fetchExtractOutput method can be used to download the raw XML. the raw XML can be downloaded. 24 | AUTOMATING HCM DATA LOADER .ESS_PARENT_JOB_SUBMITTED ESS parent job submitted ESS_PARENT_JOB_SUB_ERROR ESS parent job submission error ESS_RT_SERV_NOT_FOUND ESS run time service not found EXECUTION_STARTED Flow task execution started FUNCTIONAL_ERROR Flow task functional error IN_PROGRESS In progress IN_PROGRESS_IDLE In progress with manual intervention required MARKED_FOR_RETRY Marked for recalculation NOT_STARTED Not started PUBLISHED Published ROLLEDBACK Rolled back SCHEDULED Scheduled SKIPPED Skipped Example: <soapenv:Envelope xmlns:soapenv="http://schemas. The payrollProcessingActionService.xmlsoap.oracle.com/apps/hcm/processFlows/core/flowActionsService/types/"> <soapenv:Header/> <soapenv:Body> <typ:getFlowTaskInstanceStatus> <typ:flowInstanceName> HDL_Summary_1</typ:flowInstanceName> <typ:flowTaskInstanceName> HDL Data Set Summary </typ:flowTaskInstanceName> <typ:legislativeDataGroupName>US Legislative Data Group</typ:legislativeDataGroupName> </typ:getFlowTaskInstanceStatus> </soapenv:Body> </soapenv:Envelope> Retrieving HCM Extracts XML Once the HCM extract flow reaches COMPLETED status.org/soap/envelope/" xmlns:typ="http://xmlns. 25 | AUTOMATING HCM DATA LOADER . If the file is stored on the WebCenter Content server. HCM Extract Oracle BI Report Output Location When an HCM extract is associated with an Oracle BI template. In this case. a default of 10MB is applied. The payroll action parameter BI_OUTPUT_SIZE determines whether the generated Oracle BI report is written as an attachment to the WebCenter Content server. files of 10MB or less are stored on the WebCenter Content server and rendered in the Payroll Checklist Results UI. a link to the location of the file on the Oracle BI server is shown in the Payroll Checklist Results UI.<soapenv:Envelope xmlns:soapenv="http://schemas. If the BI_OUTPUT_SIZE action parameter is not present. The action parameter value is the maximum size in bytes of the file. For files that are larger than 10MB. the payroll flow ensures that the Oracle BI report is generated and written to the Oracle BI server. links are provided to the relevant location on the Oracle BI server.oracle.org/soap/envelope/" xmlns:typ="http://xmlns. then it appears in the Payroll Checklist Results UI and can be viewed and downloaded from this location. Files larger than this value cannot be stored on the WebCenter Content server. Otherwise.xmlsoap.com/apps/hcm/processFlows/core/flowActionsService/types/"> <soapenv:Header/> <soapenv:Body> <typ:fetchExtractOutput > <typ:InstanceName>HDL_Summary_1</typ:InstanceName> <typ:taskName>HDL Data Set Summary</typ:taskName> <typ:mode>FLOW</typ:mode> </typ:fetchExtractOutput> </soapenv:Body> </soapenv:Envelope> This service call returns a String result attribute that contains the full XML generated by the extract. Oracle Corporation. the AMD logo. and no contractual obligations are formed either directly or indirectly by this document. USA Fax: +1. nor subject to any other facebook. oracle. This document may not be reproduced or transmitted in any form or by any twitter.506. whether expressed orally or implied in law.650.506.oracle. This document is provided for information purposes only. This document is not warranted to be error-free.650.7200 CONNECT W ITH US blogs. without our prior written permission. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International. Inc.com Oracle and Java are registered trademarks of Oracle and/or its affiliates. Oracle and/or its affiliates.com/oracle means. 1017 White Paper Title October 2017 . Opteron. and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. including implied warranties and conditions of merchantability or fitness for a particular purpose. CA 94065. electronic or mechanical.com/oracle warranties or conditions. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. Other names may be trademarks of their respective owners. All rights reserved. and the contents hereof are subject to change without notice. We specifically disclaim any liability with respect to this document. UNIX is a registered trademark of The Open Group.com/oracle Copyright © 2017. World Headquarters Worldwide Inquiries 500 Oracle Parkway Phone: +1.7000 Redwood Shores. AMD. for any purpose.