Documente Academic
Documente Profesional
Documente Cultură
Introduction 1
Security 2
Invoking WebCenter Content Generic SOAP Web Service with Inline Content 4
Parameters 6
Security 7
HCM Extracts 21
For general guidelines on the use of HCM Data Loader, see the Integrating with Oracle HCM Cloud
guide on the Oracle Help Center at https://docs.oracle.com/en/.
Files to be loaded with HCM Data Loader must first be uploaded to the Oracle WebCenter Content
server. This document covers three topics:
Revisions
Date Description
13 October 2017 New section on the Get Data Set Status Method
This document reviews methods of staging a file for HCM Data Loader on the WebCenter Content server. Once a
file is staged, it can be processed by invoking an externally available web service, details of which are also provided
in this document.
Security
In order to upload files to the WebCenter Content server, your user must have the following duty role:
http://www.oracle.com/technetwork/middleware/webcenter/content/downloads/wcc-11g-downloads-2734036.html
Open the Individual Component Downloads section on the Downloads tab, accept the license agreement, and
download the WebCenter Content Document Transfer Utility. Once the component zip file is downloaded, extract its
contents.
For example:
Figure 1. Example Invocation Command for the WebCenter Content Document Transfer Utility
Sample Output:
Obtain the URL for Setup and Maintenance from the Service Details section in the cloud environments provisioning
email that your service administrator received.
https://fs-xxxxxxxxxxx.oracleoutsourcing.com/setup/faces/TaskListManagerTop
Modify this URL by removing from /setup/faces/Task… and replacing it with /idcws.
https://fs-xxxxxxxxxxx.oracleoutsourcing.com/idcws
This method of defining the WebCenter Content URL applies to all examples given in this document.
Review the readme file downloaded with the WebCenter Content Document Transfer Utility for a list of all
parameters, including advanced networking options for resolving proxy issues.
https://fs-xxxxxxxxxxx.oracleoutsourcing.com/idcws/GenericSoapPort?wsdl
Note: Oracle WebCenter Content web services are protected by Oracle Web Services Manager (OWSM) security
policies. Refer to the Oracle Fusion Middleware Security and Administrator's Guide for Web Services for further
details.
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.
http://{host}/idcws/GenericSoapPort
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ucm="http://www.oracle.com/UCM"
xmlns:wsse="http://schemas.xmlsoap.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.zip</ucm:Field>
<ucm:File href="HRDataFile.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>
Figure 2. Invoking WebCenter Content Generic SOAP Web Service with Inline Content
However, as HCM Data Loader files are typically large, it is recommended to call the web service using Message
Transmission Optimization Mechanism (MTOM) with XML-binary Optimized Packaging (XOP).
------=_Part_7_163289738.1476693003095
Content-Type: application/xop+xml; charset=UTF-8; type="text/xml"
Content-Transfer-Encoding: 8bit
Content-ID: <rootpart@example.com>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ucm="http://www.oracle.com/UCM"
xmlns:wsse="http://schemas.xmlsoap.org/ws/2003/06/secext">
<soapenv:Header>
<wsse:Security
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-E7F52CF4494885176F147669300309413">
<wsse:Username>HCM_USER10</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-
profile-1.0#PasswordText">Welcome1</wsse:Password>
<wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-
security-1.0#Base64Binary">ckNXKVpwBU01PD2ENXg5nw==</wsse:Nonce>
<wsu:Created>2016-10-17T08:30:03.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>
------=_Part_7_163289738.1476693003095--
Figure 3. Invoking WebCenter Content Generic SOAP Web Service with MTOM/XOP
This table shows the parameters used in the generic SOAP web service invocation example.
Parameters
dDocName The Content ID for the content item Value passed to HcmDataLoader
dDocTitle The content item title The title of the file as it appears in Import/Export
UI
dDocAccount The account for the content item. This value is required only if hcm$/dataloader$/import$
accounts are enabled.
primaryFile The absolute path to the location of the file as seen from the
server
As in the case of Document Transfer Utility, 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.
Note: The ProcessId is the request ID for the concurrent process that initiates HCM Data Loader processing. If you
wish to review the progress of your data set via the user interface, then this value is available in the Data Sets table
on the Import and Load Data page, but is hidden by default.
This table shows the parameters for the HcmDataLoader web service importAndLoadData method.
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. The following parameter names are available. None of these parameters is mandatory. For values
that you do not supply, the default values specified on the Configure HCM Data Loader page are used.
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. Multiple parameters must be comma delimited.
Parameter Description
Parameters Name and value pairs. The following parameter names are available.
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. Multiple parameters must be comma delimited.
Examples:
ProcessId=1213
ProcessId=1231,ContentId=UCMFA23411
You can supply either one or both of these parameters, but ProcessId is recommended.
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
CONTENT_ID The content ID assigned to the file when it was uploaded to the
WebCenter Content server
PROCESS_ID The process ID assigned to the data set when the HCM Data Loader
processing is initiated
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
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
Status Description
DATA_SET_UNPROCESSED The process is running, but the data set has not been processed yet.
CANCELLED Either data set load or data set import was cancelled.
Status Description
NOT_READY Load is not ready yet, usually because import is still in progress.
Note: Oracle HCM Cloud web services are protected by Oracle Web Services Manager (OWSM) security policies.
Refer to the Oracle Fusion Middleware Security and Administrator's Guide for Web Services for further details.
http://{host}/hcmCommonDataLoader/HCMDataLoader
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:importAndLoadData
xmlns:ns1="http://xmlns.oracle.com/apps/hcm/common/dataLoader/core/dataLoaderIntegrationService/types/">
<ns1:ContentId></ns1:ContentId>
<ns1:Parameters></ns1:Parameters>
</ns1:importAndLoadData>
</soap:Body>
</soap:Envelope>
The method for resolving the URL is slightly different from the method outlined for WebCenter Content (given
earlier). Use the domain name given for the Service Home URL, which is shown in the Service Details section of
your service provision email. Using the same example given earlier, the above URL will be:
https://hcm-xxxxxxxxxxx.oracleoutsourcing.com/hcmCommonDataLoader/HCMDataLoader?wsdl
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:wsa="http://www.w3.org/2005/08/addressing">
<env:Header>
<wsa:To>http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
<wsa:Action>http://xmlns.oracle.com/apps/hcm/common/dataLoader/core/dataLoaderIntegrationService//HCMDataLoa
der/importAndLoadDataResponse</wsa:Action>
<wsa:MessageID>urn:uuid:ab36195f-775b-4688-a0e4-8a4e531e904c</wsa:MessageID>
oracle/wss11_saml_or_username_token_with_message_protection_service_policy
Therefore, when a client calls the service, it must satisfy the message-protection policy to ensure that the payload is
transported encrypted or sent over the SSL transport layer.
If payload encryption is desirable or otherwise required, 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, the message must be encrypted using a public key provided by the server. When the message
reaches the server, it can be decrypted by the server's private key. A KeyStore is used to import the certificate and it
is referenced in the subsequent client code.
The public key can be obtained from the certificate provided in the service WSDL file. See Figure 5 (the certificate is
Base64 encoded).
To use the key contained in this certificate, you need to create a local KeyStore and import the certificate into it:
2. Using a text editor, open the file you just created and enter "-----BEGIN CERTIFICATE-----" on the first line.
3. On the next line, copy the Base64 encoded certificate from the service WSDL file to the newly created
certificate file.
4. Add "-----END CERTIFICATE-----" on a new line and save the file. Now you have a certificate containing the
public key from the server.
5. Open the command line and change the directory to $JAVA_HOME/bin. Use the following command to create
a KeyStore and import the public key from the certificate.
keytool -import -file <Provide the path of the certification.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. You can find the KeyStore file in the KeyStore path you set.
Once the client KeyStore has been created, you can call the service using the proxy classes. The following
parameters are used by the proxy class to encrypt and decrypt the message.
Parameter Description
WSBindingProvider.USERNAME_PROPERTY User name of the application user who has relevant privileges for importing and
processing HDL data files
ClientConstants.WSSEC_KEYSTORE_TYPE Type of the KeyStore you created. JKS (Java KeyStore) is widely used and is
the most common type.
ClientConstants.WSSEC_ENC_KEY_ALIAS Alias of the key you use to decrypt the SOAP message from the server
ClientConstants.WSSEC_ENC_KEY_PASSWORD Password of the key you use to decrypt the SOAP message
ClientConstants.WSSEC_RECIPIENT_KEY_ALIAS Alias of the key you use to encrypt the SOAP message to the server
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:
zip loaderIntegrationProxy.jar -r * -
com/oracle/xmlns/apps/hcm/common/dataloader/core/dataloaderintegrationservice
package com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice;
import com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice.HCMDataLoader;
import com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice.HCMDataLoader_Service;
import com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice.ServiceException;
import java.util.Map;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.WebServiceRef;
import weblogic.wsee.jws.jaxws.owsm.SecurityPolicyFeature;
try {
response = hcmLoaderService.importAndLoadData(contentId,parameters);
System.out.println("The response received from the server is ...");
System.out.println(response);
e.printStackTrace();
}
}
}
To generate the class file you need the following JAR file:
ws.api_1.1.0.0.jar
$MIDDLEWARE_HOME/modules
If you do not have the JAR file, it can be can be downloaded as part of JDeveloper. The JAR file is available at the
following location in the JDeveloper installation:
modules/ ws.api_1.1.0.0.jar
javac -classpath <Provide the path of the folder where the JAX-WS files are generated>;<Provide the location of
the ws.api_1.1.0.0.jar> HCMDataLoaderServiceSoapHttpPortClient.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>;<Provide the location of
the weblogic.jar>;<Provide the location of the jrf.jar>
com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice.HCMDataLoaderServiceSoapHttpPortCli
ent <ContentId> <Parameters>
com/oracle/xmlns/apps/hcm/common/dataloader/core/dataloaderintegrationservice
package com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice;
import com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice.HCMDataLoader;
import com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice.HCMDataLoader_Service;
import com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice.ServiceException;
import java.util.Map;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.WebServiceRef;
import weblogic.wsee.jws.jaxws.owsm.SecurityPolicyFeature;
try {
response = hcmLoaderService.getDataSetStatus(parameters);
System.out.println("The latest Data Set Status ....\n\n\n\n\n");
System.out.println(response);
} catch (ServiceException e) {
System.out.println("Error occurred during the invocation of the service ...");
e.printStackTrace();
}
}
}
Provide the necessary values in the above java file and compile.
javac -classpath <Provide the path of the folder where the JAX-WS files are generated>;<Provide the location of
the ws.api_1.1.0.0.jar> HCMDataLoaderServiceGetDataSetStatus.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>;<Provide the location of
the weblogic.jar>;<Provide the location of the jrf.jar>
com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice.HCMDataLoaderServiceGetDataSetStatu
s <ProcessId=nnnn,ContentId=xxxx>
getDataSetStatus Example
Figure 7: Example of the Output of the HCM Data Loader getDataSetStatus Method
package com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice;
import com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice.HCMDataLoader;
import com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice.HCMDataLoader_Service;
import com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice.ServiceException;
import java.util.Map;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.WebServiceRef;
import weblogic.wsee.jws.jaxws.owsm.SecurityPolicyFeature;
import java.io.IOException;
import java.io.StringReader;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
public HCMDataLoaderServiceAutomation() {
super();
}
HCMDataLoader hcmLoaderService =
hcmDataLoader_Service.getHCMDataLoaderSoapHttpPort(securityFeatures);
BindingProvider wsbp = (BindingProvider)hcmLoaderService;
Map<String, Object> requestContext = wsbp.getRequestContext();
requestContext.put(BindingProvider.USERNAME_PROPERTY,"Provide the applications username");
requestContext.put(BindingProvider.PASSWORD_PROPERTY, "Provide the password");
requestContext.put("oracle.webservices.security.keystore.type", "JKS");
requestContext.put("oracle.webservices.security.keystore.location", "Provide the location of the default-
keystore.jks (including the file name)");
requestContext.put("oracle.webservices.security.keystore.password", "welcome");
requestContext.put("oracle.webservices.security.encryption.key.alias", "orakey");
if (array.length == 2) {
ucmContentId = array[0];
parameters = array[1];
} else if (array.length == 1) {
ucmContentId = array[0];
parameters = "";
}
try {
System.out.println("\n\n\n\n\n\n");
System.out.println("Invoking importAndLoad() method for ucmContentId " + ucmContentId);
response = hcmLoaderService.importAndLoadData(ucmContentId, parameters);
processId = Long.valueOf(response);
System.out.println("\n\nImportAndLoad() method invocation for UcmContentId " + ucmContentId +
" is Successful, ProcessId generated is : " + processId);
invokeGetDataSetStatus(hcmLoaderService, processId);
System.out.println("\n\n Load Completed for Data Set with UCM Content Id " + ucmContentId);
} catch (Exception e) {
System.out.println(response);
NodeList childList;
for (int i = 0; i < flowList.getLength(); i++) {
childList = flowList.item(i).getChildNodes();
for (int j = 0; j < childList.getLength(); j++) {
Node childNode = childList.item(j);
if ("DATA_SET".equals(childNode.getNodeName())) {
NodeList dataSeteChildNodes = childNode.getChildNodes();
{
for (int k = 0; k < dataSeteChildNodes.getLength();
k++) {
{
Node childDSNode = dataSeteChildNodes.item(k);
if ("STATUS".equals(childDSNode.getNodeName())) {
} catch (InterruptedException e) {
System.out.println("\n\nException while thread waiting....Program Exit");
}
}
}
}
}
}
}
}
}
return false;
}
}
The above automation code checks the status of the data set based on the time_interval value provided. By default,
the value is 60 seconds. Make sure to edit the time_interval variable based on the file size.
javac -classpath <Provide the path of the folder where the JAX-WS files are generated>;<Provide the location of
the ws.api_1.1.0.0.jar> HCMDataLoaderServiceAutomation.java
java -classpath <Provide the path of the folder where the JAX-WS files are generated>;<Provide the location of
the weblogic.jar>;<Provide the location of the jrf.jar>
com.oracle.xmlns.apps.hcm.common.dataloader.core.dataloaderintegrationservice.HCMDataLoaderServiceAutomation
<ContentId=xxxx;DeleteSourceFile=N|ContentId=xxxx>
The list of WebCenter Content server IDs for each file to be processed should be delimited using pipe (|) characters.
You can optionally provide HCM Data Loader service parameters for each file by delimiting the parameter name and
value pairs with semi-colons (;). For example:
ContentId=UCMFA131235;DeleteSourceFile=N,LoadConcurrentThreads=4|ContentId=UCMFA131236;Loa
dConcurrentThreads=4
HCMDataLoaderServiceAutomation Example
Figure 8 shows the sample command to invoke HCM Data Loader Automation method.
Figure 9 shows the sample response of 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. 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.
When you use HCM Extracts as part of an integrated process, you may need to invoke it automatically as part of an
automated flow. In addition, once the extract is complete, it is likely that the output needs to be retrieved for
subsequent processing.
When an HCM extract is defined, it generates a flow object in the payroll flow data model with the same name as the
HCM extract itself. This flow is used to control the processing of the HCM extract, including setting any parameters
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, 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.
Before either can be used, it is recommended that you make a copy of the predefined extract and edit the default
definition to suit your requirements. This may involve generating an Oracle BI Publisher layout. Further details
about these two extracts and how to copy them are available from the HCM Data Loader Extracts document (MOS
Doc ID: 1664133.1).
When you save a copy of an HCM extract, you also create a payroll flow of type EXTRACT with the same name as
the saved extract, for example, HDL Data Set Summary.
The method to invoke the HCM extract is FlowActionsService.submitFlow. This method has the following
parameters:
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
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:typ="http://xmlns.oracle.com/apps/hcm/processFlows/core/flowActionsService/types/"
xmlns:flow="http://xmlns.oracle.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>
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
COMPLETED Complete
ERROR0 Error
IN_PROGRESS In progress
PUBLISHED Published
SCHEDULED Scheduled
SKIPPED Skipped
Example:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:typ="http://xmlns.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>
The payrollProcessingActionService.fetchExtractOutput method can be used to download the raw XML. The
parameters for this method are as follows:
Flow Instance Name The identifier of the particular instance of the extract to be run
This service call returns a String result attribute that contains the full XML generated by the extract.
The payroll action parameter BI_OUTPUT_SIZE determines whether the generated Oracle BI report is written as an
attachment to the WebCenter Content server. The action parameter value is the maximum size in bytes of the file.
Files larger than this value cannot be stored on the WebCenter Content server. If the file is stored on the WebCenter
Content server, then it appears in the Payroll Checklist Results UI and can be viewed and downloaded from this
location. Otherwise, a link to the location of the file on the Oracle BI server is shown in the Payroll Checklist Results
UI.
If the BI_OUTPUT_SIZE action parameter is not present, a default of 10MB is applied. In this case, files of 10MB or
less are stored on the WebCenter Content server and rendered in the Payroll Checklist Results UI. For files that are
larger than 10MB, links are provided to the relevant location on the Oracle BI server.
CONNECT W ITH US
blogs.oracle.com/oracle
Copyright © 2017, Oracle and/or its affiliates. All rights reserved. This document is provided for information purposes only, and the
contents hereof are subject to change without notice. This document is not warranted to be error-free, nor subject to any other
facebook.com/oracle warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or
fitness for a particular purpose. We specifically disclaim any liability with respect to this document, and no contractual obligations are
formed either directly or indirectly by this document. This document may not be reproduced or transmitted in any form or by any
twitter.com/oracle means, electronic or mechanical, for any purpose, without our prior written permission.
oracle.com Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and
are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are
trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. 1017