Scribd
Upload
102 views

ExportBulkData ExtractFileType

Uploaded by

Anuj Singhal
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
102 views

ExportBulkData ExtractFileType

Uploaded by

Anuj Singhal
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 3

ErpIntegrationService: ExportBulkData Operation

ExtractFileType Support
Introduction
Steps to Enable ExtractFileType Support
Configure Opt In
Pass ExtractFileType in Request Payload
Oracle Recommendation
Supported ExtractFileType Combinations
References

Introduction
ERP Integration Service can extract data from Oracle ERP Cloud through Business Intelligence Publisher (BIP) tool using the ExportBulkData operation.

ExportBulkData supports extraction of .CSV, .XML & .TEXT type OUT files and .LOG files as a single ZIP named as
ExportBulkData_<JobName>_<RequestIdReceivedInExportBulkDataResponse>.zip.

Till 22A users has no choice over the type of files that ExportBulkData extracts i.e. the ZIP contains all supported files (.CSV, .XML, .TEXT, & .LOG), if
present. This inability to extract precise output file was leading unnecessary extraction of unwanted OUT/LOG files consuming additional runtime and
download time. For example even if user needs only CSV OUT file , TEXT and XML OUT files and LOG file are extracted(If Present).

Starting 22B, users will be able to specify a precise ExtractFileType from the list of supported file types and extract only those files.

This will provide more flexibility to the user and reduce significant runtime of integration by skipping download of files that are not needed.

Steps to Enable ExtractFileType Support


Configure Opt In
To enable the ExtractFileType support users have to configure the following Lookups via Manage Standard Lookup UI.

Lookup Type: FUN_OPTIN_WS_CONTROL


Lookup Code: ADVANCE_FILE_TYPES

Pass ExtractFileType in Request Payload

Once the Dev Opt In FUN_OPTIN_WS_CONTROL/ADVANCE_FILE_TYPES is configured user can pass the required ExtractFileType in the JobOption
tag in the request payload as ExtractFileType=<RequiredFileTypes>

Providing the ExtractFileType in JobOption tag is not mandatory. If ExtractFileType is not provided both OUT(.CSV, .XML, .TEXT) and LOG
files will be extracted.
If the Dev Opt In FUN_OPTIN_WS_CONTROL/ADVANCE_FILE_TYPES is not configured both OUT(.CSV, .XML, .TEXT) and LOG files will be
extracted even if ExtractFileType is passed in JobOption tag. The provided ExtractFileType is ignored.
A combination of more than one valid ExtractFileType is also supported. Please pass ExtractFileType as semi-colon separated valid file type
value.

Providing an optimum and precise ExtractFileType combination is recommended for best performance .
ExportBulkData Operation Payload

<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:exportBulkData>
<typ:jobName>JOB_PATH,JOB_NAME</typ:jobName>
<typ:jobOptions>ExtractFileType=PASS_SUPPORTED_FILE_TYPES_HERE</typ:jobOptions>
<typ:callbackURL>#NULL</typ:callbackURL>
<typ:notificationCode>#NULL</typ:notificationCode>
</typ:exportBulkData>
</soapenv:Body>
</soapenv:Envelope>

ExportBulkData Operation Payload: 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:exportBulkData>
<typ:jobName>/oracle/apps/ess/custom/shared/Custom/Financials/,TaxReportEssJob</typ:jobName>
<typ:jobOptions>ExtractFileType=CSV;ZIP_ONLY</typ:jobOptions>
<typ:callbackURL>#NULL</typ:callbackURL>
<typ:notificationCode>#NULL</typ:notificationCode>
</typ:exportBulkData>
</soapenv:Body>
</soapenv:Envelope>

Oracle Recommendation
Oracle recommend to use CSV format for the downstream processing and extracted output must be zipped.

It will ensure optimal performance and seamless integration.

Recommended ExtractFileType = CSV;ZIP_ONLY

Supported ExtractFileType Combinations


User must either pass valid combination of supported ExtractFileType in Job Option or not pass ExtractFileType at all.

exportBulkData operation returns an exception for any invalid ExtractFileType combination.

Sl. No. Valid ExtractFileType Combinations

1 CSV

2 XML

3 TEXT

4 LOG

5 OUT

6 ALL

7 CSV;XML

8 CSV;TEXT

9 CSV;LOG
10 CSV;ZIP_ONLY (Recommended)

11 XML;TEXT

12 XML;LOG

13 XML;ZIP_ONLY

14 TEXT;LOG

15 TEXT;ZIP_ONLY

16 OUT;ZIP_ONLY

17 ALL;ZIP_ONLY

18 CSV;XML;TEXT

19 CSV;XML;LOG

20 CSV;XML;ZIP_ONLY

21 CSV;TEXT;LOG

22 CSV;TEXT;ZIP_ONLY

23 CSV;LOG;ZIP_ONLY

24 XML;TEXT;LOG

25 XML;TEXT;ZIP_ONLY

26 XML;LOG;ZIP_ONLY

27 TEXT;LOG;ZIP_ONLY

28 CSV;XML;TEXT;LOG

29 CSV;XML;TEXT;ZIP_ONLY

30 CSV;XML;LOG;ZIP_ONLY

31 CSV;TEXT;LOG;ZIP_ONLY

32 XML;TEXT;LOG;ZIP_ONLY

33 CSV;XML;TEXT;LOG;ZIP_ONLY

Notes:

ExtractFileTypes CSV, XML, TEXT and LOG refers to .CSV, .XML, .TEXT and .LOG files respectively .
ExtractFileTypes ALL refers to a combination of all OUT files and LOG file (.CSV + .XML + .TEXT + .LOG)
ExtractFileTypes OUT refers to a combination of all OUT files (.CSV + .XML + .TEXT )
ExtractFileTypes ZIP_ONLY optimises the performance by skipping the raw file upload to UCM

References
1. ERP Integration Service Release 13
2. ERP Integration Services - Export Data
3. ERP Integration REST Service

You might also like