49Use Web Services to Import and Export Data

This chapter contains the following:

Overview of Import and Export Web Services

You can use Web services to implement file-based data import and export.

Import Web Services

These Web services are available for importing your data into Oracle Applications Cloud:

  • File Import Activity Service (ImportPublicService): Service related to file-based import activity. You use this service to submit an import activity and monitor its status.

  • Metadata Public Service (MetadataPublicService): Service used to retrieve the object descriptions. This service provides the getObjectDefinitions method that retrieves the object descriptions.

For more information about using import Web services in Oracle Applications Cloud, see the topic Using Web Services for File-Based Data Import.

Export Web Service

You can use the Bulk Export Service V2 (BulkExportService) to export your data from Oracle Applications Cloud. This service is used to extract data in a batch process. You do one of the following to use this service:

  • Web Service proxy clients

  • Business Process Execution Language

  • Connections architecture

For more information about using Bulk Export Service V2 (BulkExportService), see the topic Using Web Services for File-Based Data Export.

Use Web Services for File-Based Data Import

You can use Web services to import data into Oracle Applications Cloud.

Process Flow for Import Using Web Services

To import data using Web services:

  1. The client application calls the MetadataPublicService to retrieve a description of the object to be imported.

  2. CX Sales and B2B Service user maps the attributes in the source system to the corresponding CX Sales and B2B Service attributes.

  3. The client application generates an input data file using a predefined set of column headers (values provided in the MetadataPublicService response).

  4. The client creates and activates an import activity using a simple web service request.

  5. CX Sales and B2B Service processes the input data file performing the mapping between the columns in the input file and the object attributes without any need for manual intervention.

  6. The import activity is processed with parallel batches to improve the overall throughput of the process.

  7. The import activity generates success, exception, and error log files containing messages to assist the user in resolving any data issues in the input data files.

  8. In case of any errors or exceptions, the user corrects any data issues and resubmits the records for data import.

Access the WSDL URL

To use ImportPublicService and MetadataPublicService, you must determine the endpoints to which SOAP requests are sent. The following sections describe the steps to get the logical and physical endpoints.

Logical Endpoint for ImportPublicService

To determine the logical endpoint for ImportPublicService, see the File-Based Data Import forCX Sales and B2B Service guide available on the Help Center (https://docs.oracle.com/en/cloud/saas/index.html).

Physical Endpoint of an Instance

To determine the physical endpoint of any given instance:

  1. Launch the CX Sales and B2B Service home page and sign in as a user.

  2. Navigate to an application's dashboard/work area page that belongs to CX Sales and B2B Service account. For example: In the case of CX Sales and B2B Service account navigate to the Customers work area.

  3. You see a URL similar to https://<domainname>/customer/faces/CustomerCtrWorkarea in the browser's address bar. The <domainname> might be similar to https://<pod-name>.<lba>.xxx.oraclecloud.com.

  4. Build your physical endpoint by adding the static context root from the logical endpoint (in this example, /mktImport/ImportPublicService) to https://<domainname>/ that you derived in the application's dashboard/work area. For this example, the physical endpoint is https://<domainname>/mktImport/ImportPublicService. https://<domainname>/mktImport/ImportPublicService is the WSDL URL for ImportPublicService.

Logical Endpoint for MetadataPublicService

To determine the logical endpoint for MetadataPublicService, see the File-Based Data Import for CX Sales and B2B Service guide available on the Help Center (https://docs.oracle.com/en/cloud/saas/index.html).

Physical Endpoint of an Instance

To determine the physical endpoint of an instance:

  1. Launch the CX Sales and B2B Service home page and sign in as a user.

  2. Navigate to an application's dashboard/work area page that belongs to CX Sales and B2B Service account. For example: In the case of CX Sales and B2B Service account navigate to the Customers work area.

  3. You see a URL similar to https://<domainname>/customer/faces/CustomerCtrWorkarea in the browser's address bar. The <domainname> might be like https://<pod-name>.<lba>.xxx.oraclecloud.com.

  4. Build your physical endpoint by appending the static context root from the logical endpoint (in this example, /crmCommonMetadata/MetadataPublicService) to https://<domainname>/ that you derived in the application's dashboard/work area. For this example, the physical endpoint is https://<domainname>/crmCommonMetadata/MetadataPublicService. https://<domainname>/crmCommonMetadata/MetadataPublicService is the WSDL URL for Metadata Public Service.

Methods Supported by the ImportPublicService

ImportPublicService includes the following methods:

  • submitImportActivity: Submits the file import activity.

  • submitSimplifiedImportActivity: Submits the file import activity.

  • getImportActivityStatus: Gets the file import activity status.

  • getImportActivityLogFiles: Gets the file import activity logs for both ZIP and non-ZIP files.

  • getImportActivityLogs: Gets the file import activity logs. This operation isn't supported for multi-CSV ZIP files. This operation would be deprecated in future.

Use the SubmitImportActivity Web Service Operation

To perform file-based data import with the submitImportActivity web service operation:

  1. Create the data mapping and generate the mapping number

  2. Create and encode the input file

  3. Send the data to CX Sales and B2B Service

  4. Get the status of your import task

  5. Get the output log of your import task (Optional)

  6. Verify your work

Create Your Data Mapping and Generate the Mapping Number

To create your data mapping and generate the mapping number:

  1. Sign in to your CX Sales and B2B Service application.

  2. In the Setup and Maintenance work area, navigate to:

    • Offering: Sales

    • Functional Area: Data Import and Export

    • Task: Manage File Import Mappings

  3. In the Manage File Import Mappings page

    click Actions, and then click Create.

  4. In the Create Import Mapping dialog box, enter the following value in the Import Mapping field:

    GLD - Contact-map

  5. From the Object drop-down list, select the Contact object, and then click Save and Close.

    This figure shows the Create Import Mapping scenario.

    For this example, you create a simple mapping that references the Contact records (Target Object: PersonProfile) and that uses only the First name (Target Attribute: PersonFirstName) and Last name (Target Attribute: PersonLastName) fields of these records.

  6. In the Column Mappings section of the Edit Import Mapping page, click the Plus icon to create two mapping rows: the first to target object PersonProfile and target attribute PersonFirstName, and the second to PersonProfile and PersonLastName. Click Save.

  7. In the Name column, click GLD - Contact-map.

  8. In the Edit Import Mapping screen, select the mapping number value, right-click, and then click Copy.

    For this example, this number is 300100018631447. The Edit Import Mapping screen uses this number to uniquely identify this mapping.

Create and Encode the File

To create and encode your file:

  1. For this example, create a CSV file that includes the following header row and contacts:

    PersonFirstName,PersonLastName

    Antonia,Pinas

    Christina,Aamos

  2. Use an encoding tool of your choice, such as base64encode from Opinionated Geek, to encode your input file with Base64 encoding. For this example, the following Base64 encoding is used:

    UGVyc29uRmlyc3ROYW1lLFBlcnNvbkxhc3ROYW1lDQpHbGFuZG9uLExhdXJlbnQNCkdsYW5kb24sUGl lcnJl

Send Data to CX Sales and B2B Service

To send your data to CX Sales and B2B Service

  1. Open a SOAP tool that can send a SOAP envelope.

    For example, open SoapUI. SoapUI is a functional testing application. For more information, see http://www.soapui.org.

  2. Use the SOAP tool to send the following SOAP envelope:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:typ="http://xmlns.oracle.com/oracle/apps/marketing/commonMarketing/mktImport/model/types/"
    xmlns:mod="http://xmlns.oracle.com/oracle/apps/marketing/commonMarketing/mktImport/model/">
    <soapenv:Header/>
    <soapenv:Body>
    <typ:submitImportActivity>
    <typ:importJobSubmitParam>
    <mod:JobDescription>description</mod:JobDescription>
    <mod:HeaderRowIncluded>header_row</mod:HeaderRowIncluded>
    <mod:FileEcodingMode>encoding</mod:FileEcodingMode>
    <mod:MappingNumber>mapping_number</mod:MappingNumber>
    <mod:FileContent>import_content</mod:FileContent>
    <mod:ImportMode>CREATE_RECORD</mod:ImportMode>
    <mod:FileFormat>delimiter</mod:FileFormat>
    </typ:importJobSubmitParam>
    </typ:submitImportActivity>
    </soapenv:Body>
    </soapenv:Envelope>

    This table contains the parameters for the web service operation and their descriptions. :

    Parameter Description

    description

    String that describes the purpose of the job. You can use any string.

    header_row

    Value is Y if your input file includes a header row.

    Value is N if your input file doesn't include a header row.

    encoding

    Encoding that the Import web service uses when it converts your input file. For example, UTF-8.

    mapping_number

    The number that you identified in step 1.

    import_content

    The Base64 encoding that you prepared in step 2.

    delimiter

    The character that import_content uses to separate data elements. Your input file must use the delimiter that delimiter specifies. A data element is one part of a record. For example, PersonFirstName is one data element of a consumer record.

    For this example, use your SOAP tool to send the following SOAP envelope:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:typ="http://xmlns.oracle.com/oracle/apps/marketing/commonMarketing/mktImport/model/types/"
    xmlns:mod="http://xmlns.oracle.com/oracle/apps/marketing/commonMarketing/mktImport/model/">
    <soapenv:Header/>
    <soapenv:Body>
    <typ:submitImportActivity>
    <typ:importJobSubmitParam>
    <mod:JobDescription>GLD - Import Contact Demonstration</mod:JobDescription>
    <mod:HeaderRowIncluded>Y</mod:HeaderRowIncluded>
    <mod:FileEcodingMode>UTF-8</mod:FileEcodingMode>
    <mod:MappingNumber>300100018631447</mod:MappingNumber>
    <mod:FileContent>UGVyc29uRmlyc3ROYW1lLFBlcnNvbkxhc3ROYW1lDQpHbGFuZG9 uLExhdXJlbnQNCkdsYW5kb24sUGllcnJl</mod:FileContent>
    <mod:ImportMode>CREATE_RECORD</mod:ImportMode>
    <mod:FileFormat>COMMA_DELIMITER</mod:FileFormat>
    </typ:importJobSubmitParam>
    </typ:submitImportActivity>
    </soapenv:Body>
    </soapenv:Envelope>

    In your SOAP tool, add the user name and password.

  3. CX Sales and B2B Service sends the following reply:

    <ns0:submitImportActivityResponse>
    <ns0:result>
    <ns1:JobId>300100018636453</ns1:JobId>
    <ns1:Result>Success</ns1:Result>
    </ns0:result>
    </ns0:submitImportActivityResponse>
    

    where:

    • JobId identifies your job. Make a note of this number.

Get the Import Task Status

To get the status of your import task:

  1. Send the following request to CX Sales and B2B Service

    <typ:getImportActivityStatus>
    <typ:importJobId>300100018636453</typ:importJobId>
    </typ:getImportActivityStatus>

    where:

    importJobId specifies the number that you noted in step 3.

    CX Sales and B2B Service sends a reply. For example:

    <ns0:getImportActivityStatusResponse>
    <ns2:result>
    <ns1:BatchId>300100018636457</ns1:BatchId>
    <ns1:Status>status</ns1:Status>
    <ns1:LoadDate>2012-10-03</ns1:LoadDate>
    <ns1:RecordReadFromFile xsi:nil="true"/>
    <ns1:LoadErrors xsi:nil="true"/>
    <ns1:FormatErrors xsi:nil="true"/>
    <ns1:SuccessfullyLoaded xsi:nil="true"/>
    </ns2:result>
    </ns0:getImportActivityStatusResponse>

    where:

    Status indicates the status of your job.

  2. The import activity takes time to process. Resend the request periodically with a wait time, until a response is returned with a status that doesn’t indicate that the job is in progress. Repeat step 4 until CX Sales and B2B Service sends the following reply:

    <ns2:result>
    <ns1:BatchId>300100018636457</ns1:BatchId>
    <ns1:Status>COMPLETE</ns1:Status>
    <ns1:LoadDate>2012-10-03</ns1:LoadDate>
    <ns1:RecordReadFromFile>2</ns1:RecordReadFromFile>
    <ns1:LoadErrors>0</ns1:LoadErrors>
    <ns1:FormatErrors xsi:nil="true"/>
    <ns1:SuccessfullyLoaded>2</ns1:SuccessfullyLoaded>
    </ns2:result>

    This table contains the status and descriptions of the web service response.

    Status Description

    BASE_TABLE_UPLOAD

    Base table upload is in progress. The bulk import process is uploading data from the interface tables into the base tables.

    COMPLETE

    The import process completed without error.

    COMPLETE_WITH_ERRORS

    Completed with errors. While the process did complete, errors were found. Warnings may also have been found.

    COMPLETE_WITH_WARNINGS

    Completed with warnings. While the process did complete, warnings were found but no errors were found.

    RUNNING

    Interface table upload is in progress. The file import process is uploading data from the source file into the interface tables.

    NEW

    The import process wasn't scheduled.

    PROCESSING

    The import activity is currently being processed.

    SCHEDULED

    The process is scheduled to start at a later time.

    ERROR

    The import activity wasn't able to complete successfully.

    Don't reexecute the status request if the response status is complete, complete_with_error, complete_with_warnings, or error.

Get the Import Task Output Log

To get the output log of your import task:

You can check the log to determine if an error occurred. Alternatively, to get the PartyId for each record:

  1. In your SOAP tool, send the following request to CX Sales and B2B Service:

    <typ:getImportActivityLogs>
    <typ:importJobId>300100018636453</typ:importJobId>
    <typ:batchId>300100018636457</typ:batchId>
    </typ:getImportActivityLogs>

    where:

    • importJobId identifies the number that you noted in step 3. This identifies your job.

    • batchId identifies the number that CX Sales and B2B Service sent in the reply in step 4. This is sent as part of the response payload.

      Note: An import job can be submitted multiple times. Each execution of the same job is a batch. For each execution of the job, a unique batch ID is created.
    • You can also use the getImportActivityLogFiles method to get the log file details.

    CX Sales and B2B Service sends a reply. For example:

    <ns0:getImportActivityLogsResponse>
    <ns2:result>
    <ns1:LogFileName>log-Import Activity 1349272813558 Data File.csv</ns1:LogFileName>
    <ns1:LogFileContent>
    </ns1:LogFileContent>
    <ns1:ErrorLogFileName xsi:nil="true"/>
    <ns1:ExceptionLogFileName xsi:nil="true"/>
    <ns1:BatchId xsi:nil="true"/>
    </ns2:result>
    </ns0:getImportActivityLogsResponse>
  2. Locate and then open the file that CX Sales and B2B Service sent.

    For example, in SoapUI you can do the following:

    • Click the Raw tab. SoapUI displays the following reply:

      Content-ID:<24f39a91936b44eeb3d0c1d6f4db93d2>
              ObjectKey,PersonFirstName,PersonLastName
              100100028456712,Antonia, Pinas
              100100028456713,Christina,Aamos
              -=_Part_161_384756467.1349273628660
              
    • To open the log file, click Attachments, and then search the Name column for the Content-ID. In this example, you search for this value:

      24f39a91936b44eeb3d0c1d6f4db93d2

Verify Your Import

To verify your work, do one of the following:

  • In the SoapUI, use a web service to verify your work.

    For example, you can use the following getPerson operation of the foundationParties web service or the PersonService web service:

    <ns0:getPersonResponse>
    <ns2:result>
    <ns1:PartyId>100100028456713</ns1:PartyId>
    <ns1:PartyNumber>CDRM_1384311</ns1:PartyNumber>
    <ns1:PartyName>Christina Aamos</ns1:PartyName>
    <ns1:PartyType>PERSON</ns1:PartyType>
    <ns1:ValidatedFlag>false</ns1:ValidatedFlag>
    <ns1:LastUpdatedBy>BULK_IMPORT</ns1:LastUpdatedBy>
    <ns1:LastUpdateLogin>-1</ns1:LastUpdateLogin>
    <ns1:CreationDate>2012-10-03T07:04:18.577084-07:00<ns1:CreationDate>
    <ns1:RequestId>99999</ns1:RequestId>
    <ns1:LastUpdateDate>2012-10-03T07:04:18.577084-07:00<ns1:LastUpdateDate>
    <ns1:CreatedBy>BULK_IMPORT</ns1:CreatedBy>
    <ns1:OrigSystemReference>300100018636467</ns1:OrigSystemReference>
  • In CX Sales and B2B Service locate the data that you imported in step 3. You search for People in the Customer Data Management Dashboard.

Auto-Map the Lead Object in the Source File

To construct the CSV file so that the auto mapping of Lead object is supported:

  1. Name the CSV file as Lead.csv. The file should always be named after the object that's being imported.

  2. Open the file and structure the header row as per the attributes. The file should have a column for each of the consumer VO attributes. For example, the lead.csv file can have LeadName and DescTest as column names. The lead.zip multi-CSV file can have the files lead.csv and leadResource.csv.

Operations Supported by the Import Web Service

You can use the web service operations supported by the Import public Web service. These operations are supported by the Import web service:

  • submitImportActivity

  • getImportActivityStatus

  • getImportActivityLogs

submitImportActivity

This operation creates and schedules a new file import job.

Input Parameters

These input parameters are used for this operation:

  • JobName

  • JobDescription

  • HeaderRowIncluded

  • ErrorThreshold

  • Notification

  • Delimiter

  • DateFormat

  • TimestampFormat

  • FileEncodingMode

  • ImportMode

  • LookbackDays

  • MappingNumber

  • CallListCode

  • FileName

  • FileContent

  • FileFormat

  • ContentId

Mandatory Attributes

This table describes the parameters that are mandatory for this operation:

Parameter Name Description

MappingNumber

The mapping number value associated with the import mapping definition to be used. This value can be retrieved in the Manage Import mappings task.

FileContent

The base-64 encoded source file containing the set of records to be imported. You must specify either the FileContent or the ContentId.

ContentId

The UCM file import Content ID. You must specify either the FileContent or the ContentId. For more details about retrieving the ContentId, refer to the topic Using Import Web Services to Upload Data on a Recurring Basis in the related topics section.

Default Values for Non-Mandatory Attributes

This table lists the parameters that are set to a default value in the operation if not specified in the service request:

Parameter Name Default Value

JobName

Import Activity + current time in milliseconds For example: Import Activity 1399463887250

HeaderRowIncluded

Y

ImportMode

CREATE_RECORD

FileEncodingMode

base-64

TimeStampFormat

yyyy-MM-dd'T'HH:mm:ss.SSSZ

DateFormat

M/d/yy

FileFormat

COMMA_DELIMITER

FileName

JobName + " Data File".CSV/ JobName + " Data File".xml/ JobName + " Data File".txt/

Output Parameters:

These are the output parameters:

  • JobId - Newly submitted import job's ID.

  • Result - Success/Failure.

getImportActivityStatus

This operation gets the status for the given job.

Input Parameters:

The input parameter is:

  • ImportJobId

Output Parameters:

These are the output parameters:

  • BatchID - System TaskID of the given import job's latest run.

  • Status - COMPLETE/COMPLETE WITH ERRORS/ERRORS

  • LoadDate - Date of the given import job's latest run.

  • RecordsReadFromFile - Total record count.

  • LoadErrors - Load errors record count.

  • FormatErrors - Format errors record count.

  • SuccessfullyLoaded - Success record count.

getImportActivityLogs

This operation gets the success, error, and the exception logs for a job.

Input Parameters:

The input parameters are:

  • ImportJobId

  • batchID

Output Parameters:

The output parameters are:

  • LogFileName - Success log file name if one or more records are processed successfully.

  • LogFileContent - Success records if the success log is generated.

  • ErrorLogFileName - Error log file name if one or more records are processed with errors.

  • ErrorLogFileContent - Error records if the error log generated.

  • ExceptionLogFileName - Exception log file name if the error log is generated.

  • ExceptionLogFileContent - Error records with complete error messages.

  • BatchID - Given Batch ID

Import Web Services Reference Information

You use web services reference information to import your data into CX Sales and B2B Service.

Syntax for the SubmitImportActivity Method

The submitImportActivity method uses this syntax:

<typ:submitImportActivity>
  <typ:importJobSubmitParam>
    <mod:JobName>descriptive_name</mod:JobName>
    <mod:JobDescription>description</mod:JobDescription>
    <mod:HeaderRowIncluded>header_row</mod:HeaderRowIncluded>
    <mod:ErrorThreshold>number</mod:ErrorThreshold>
    <mod:Notification>email_address</mod:Notification>
    <mod:DateFormat>format</mod:DateFormat>
    <mod:TimestampFormat>format</mod:TimestampFormat>
    <mod:FileEcodingMode>encoding</mod:FileEcodingMode>
    <mod:MappingNumber>mapping_number</mod:MappingNumber>
    <mod:FileFormat>delimiter</mod:FileFormat>
    <mod:FileContent>import_content</mod:FileContent>
    <mod:ImportMode>import_mode</mod:ImportMode>
    <mod:LookbackDays>number</mod:LookbackDays>
    <mod:CallListCode>number</mod:CallListCode>
    <mod:FileName>name</mod:FileName>
    <mod:FileFormat>format</mod:FileFormat>
    <mod:ContentId>content_ID</mod:ContentId>
  </typ:importJobSubmitParam>
</typ:submitImportActivity>  

For more information about the parameters that this syntax uses, see the section Parameters That You Can Use With the submitImportActivity Method.

Parameters for the SubmitImportActivity Method

This table describes the parameters that you can use with the submitImportActivity method. The FileContent and MappingNumber parameters are required. All other parameters are optional.

Parameter Description

CallListCode

Specify the Call List Code. The Call List Code is a marketing code that identifies a group of records.

DateFormat

Specify the date format that your source file uses.

ErrorThreshold

Specify the error threshold. The import runs until the number of errors is less than the value that you specify for ErrorThreshold.

FileContent

Include the base64-encoded content of the import file.

FileEncodingMode

For more information, see Character Encoding That Your Source File Can Use.

FileFormat

Specify the file format that the import file uses. You can use one of these values:

  • TEXT_FILE. Specifies that the source file is a text file.

  • XML_FILE. Specifies that the source file is an XML file.

FileName

Specify the file name of the import file.

HeaderRowIncluded

Specify whether or not your source file includes a header row. You can use one of these values:

  • Y. Your source file includes a header row.

  • N. Your source file doesn't include a header row.

ImportMode

Specify the import mode. You can use one of these values:

  • CREATE_RECORD. Creates records.

  • UPDATE_RECORD. Updates records that the CX Sales and B2B Service database already contains.

JobDescription

Describe the import job. You can include any description. You can include this description as a string. It's not necessary to use quotation marks to enclose this string.

JobName

Specify the name of the import job. You can specify any name. You can include this name as a string. It's not necessary to use quotation marks to enclose this string.

LookbackDays

Specify the review period, which is the number of days that the Import web service searches for duplicates, starting with the most recent day. For example, if today is Thursday and you set the LookbackDays parameter to 3, then the import searches for duplicate records dating back to Monday, Tuesday, and Wednesday. Note the following:

  • You can use the LookbackDays parameter only for the Lead import object.

  • The Import web service searches only for leads that were created during the review period defined by the LookbackDays parameter. The Import web service evaluates these leads for duplicates according to the attributes that the predefined import mapping specifies. If the Import web service finds a duplicate lead, then it doesn't import the duplicate, but it does report this duplicate in the Exception report.

  • The Import web service considers each duplicate that it finds as an error when it determines the allowable error count threshold.

MappingNumber

Specify the mapping number. The Edit Import Mapping screen uses this number to uniquely identify a mapping.

Notification

The email of the individual who receives import processing notifications. By default the email is sent to your registered email address. You can also provide multiple email addresses separated by commas.

TimestampFormat

For more information, see Time Stamp Formats That Your Source File Can Use.

ContentId

Specify the file import Content ID. This is indicated with the dDocName parameter in the Document Transfer utility tool.

Statuses of the SubmitImportActivity Method

This table describes the statuses used by the submitImportActivity method.
Status Description

BASE_TABLE_UPLOAD

Indicates that the bulk import process is uploading data from the interface tables to the base tables.

COMPLETE

Indicates that the import finished without error.

COMPLETE_WITH_ERRORS

Indicates that the import finished, but with errors.

ERROR

Indicates that the import failed to finish.

COMPLETE_WITH_WARNINGS

Indicates that the import finished, but with warnings.

NEW

Indicates that CX Sales and B2B Service hasn't yet scheduled the import.

RUNNING

Indicates that the import is uploading data from the source file to the interface tables.

SCHEDULED

Indicates that CX Sales and B2B Service has set a start time for the import, but hasn't yet started this import.

Delimiters for the Source File

This table describes the delimiters that can be used in your source file.

Delimiter Description

COMMA_DELIMITER

Specifies that the source file uses a comma to separate each data element.

FIXED_WIDTH_DELIMITER

Specifies that the source file uses a fixed width to separate each data element.

OTHER_DELIMITER

Specifies that the source file uses a nonstandard delimiter to separate each data element.

TAB_DELIMITER

Specifies that the source file uses a tab to separate each data element.

XML_DELIMITER

Specifies that the source file uses an XML tag to separate each data element.

Time Stamp Formats for the Source File

This table describes the time stamp formats that can be used by your source file.

Format Example

EEE, d MMM yyyy HH:mm:ss Z

Wed, 4 Jul 2001 12:08:56 -0700

yyMMddHHmmssZ

010704120856-0700

yyyy.MM.dd G 'at' HH:mm:ss z

2001.07.04 at 12:08:56 PDT

yyyy.MMMMM.dd GGG hh:mm aaa

2001.July.04 12:08 PM

yyyy-MM-dd'T'HH:mm:ss.SSSZ

2001-07-04T12:08:56.235-0700

Character Encoding for the Source File

This table describes the character encoding that's used by your source file.

Character Encoding Description

Big5

Specifies that Chinese traditional Big5 character encoding needs to be used for Taiwan, Hong Kong, and Macau. This encoding displays traditional Chinese characters.

GB2312

Specifies that Chinese simplified GB2312 character encoding needs to be used for the People's Republic of China. This encoding displays simplified Chinese characters.

Shift_JIS

Specifies that Shift-JIS character encoding needs to be used for the Japanese language. This encoding displays the Japanese Industrial Standard characters.

UTF-16

Specifies that UTF-16 character encoding needs to be used. This encoding uses the 16bit, variable-width Unicode Transformation Format.

UTF-16BE

Specifies that UTF-16BE character encoding needs to be used. This encoding uses the 16-bit, variable-width Unicode Transformation Format.

UTF-16LE

Specifies that UTF-16LE character encoding needs to be used. This encoding uses the 16-bit, variable-width Unicode Transformation Format.

UTF-8

Specifies that UTF-8 character encoding needs to be used. This encoding uses the 8-bit, variable-width Unicode Transformation Format.

windows-1250

Specifies that Microsoft Windows 1250 character encoding for European languages that are based on the Latin language needs to be used. For example, Polish, Czech, Slovakian, Hungarian, Slovene, Serbian, Croatian, Romanian or Albanian.

windows-1252

Specifies that Microsoft Windows 1252 character encoding needs to be used for Western European languages.

windows-1253

Specifies that Microsoft Windows 1253 character encoding needs to be used for the Greek language.

Syntax for the SubmitSimplifiedImportActivity Method

The submitSimplifiedImportActivity method uses this syntax:
<typ:submitSimplifiedImportActivity>
<mod:ObjectCode>objectCode</mod:ObjectCode>
<mod:InputFileContent>inputFileContent</mod:InputFileContent>
</typ:submitSimplifiedImportActivity>  
Currently this operation is only supported for File Type=ZIP. A ZIP file contains one or more CSV files representing a parent or child object being imported.
Note: Currently the submitSimplifiedImportActivity method is only supported for the Lead and Deal Registration objects. Importing data using this method will also trigger Oracle Workflow and Groovy Scripts for the object.
For more information about the parameters that this syntax uses, see the section Parameters That You Can Use With the submitSimplifiedImportActivity Method.

Parameters for the SubmitSimplifiedImportActivity Method

This table describes the parameters that you can use with the submitSimplifiedImportActivity method. The ObjectCode and InputFileContent parameters are required.
Parameter Description

ObjectCode

Specify the code of the object that's to be imported.

InputFileContent

Include the content of the import file that's encoded in Base-64 format.

Default Values Passed to the SubmitSimplifiedImportActivity Method

To reduce the service request to this level, some configuration options will not be available in the service. A set of default values for these attributes are used when this service is called. This table describes the default values used by the submitSimplifiedImportActivity method.
Attribute Name Default Value

JobName

<OBJECT>_<JOBCREATEDDATETIME>

JobDescription

NULL

HeaderRowIncluded

TRUE

ErrorThreshold

NULL

Notification

NULL

File Format

COMMA_DELIMITER

DateFormat

YYYYMMDD

TimestampFormat

YYYYMMDD hh:mm:ssZ

FileEncodingMode

UTF-8

ImportMode

CREATE_RECORD

LookbackDays

NULL

MappingNumber

NULL

CallListCode

NULL

SubmitSimplifiedImportActivity Method Errors

This table describes the different error scenarios that might occur when the SubmitSimplifiedImportActivity method is called.

Error Scenario Description

Source file content is blank

This error occurs when the source file is blank. The error message, "You must submit the import data using a file of type ZIP_FILE. (ZCA-210065)" is displayed to the user.

Object code is NULL

This error occurs when the object code parameter supplied is blank. The error message, "The attribute Object Code is required" is displayed to the user.

File type is other than ZIP file

This error occurs when an source file of type other than ZIP is supplied. The error message, "You must submit the import data using a file of type ZIP_FILE. (ZCA-210065)" is displayed to the user.

Object code is other than LEAD or DEAL REGISTRATION

This error occurs when the object code parameter supplied isn't LEAD or DEAL REGISTRATION. Currently, only LEAD and DEAL REGISTRATION objects are supported by the method.

Statuses of the SubmitSimplifiedImportActivity Method

This table describes the statuses used by the submitSimplifiedImportActivity method.
Status Description

BASE_TABLE_UPLOAD

Indicates that the bulk import process is uploading data from the interface tables to the base tables.

COMPLETE

Indicates that the import finished without any error.

COMPLETE_WITH_ERRORS

Indicates that the import finished with errors.

ERROR

Indicates that the import failed to finish.

COMPLETE_WITH_WARNINGS

Indicates that the import finished with warnings.

NEW

Indicates that CX Sales and B2B Service hasn't yet scheduled the data import.

RUNNING

Indicates that the import is uploading data from the source file to the interface tables.

SCHEDULED

Indicates that CX Sales and B2B Service has set a start time for the import, but hasn't yet started this data import.

Syntax for the GetImportActivityLogFiles Method

The getImportActivityLogFiles method uses this syntax:
<Files>
<File>
<Name>- Single CSV/XML:success log;Multi-CSV:ACCEPTED log Name</Name>
<Content>-Single CSV/XML: success log; Multi-CSV: ACCEPTED log File Content
<Type>SUCCESS/ERROR/EXCEPTION</Type>
<Extension>CSV/ZIP </Extension>
</Content>
</File>
<File>
<Name>-Single CSV/XML: error log; multi-CSV: ERROR log Name</Name>
<Content>-Single CSV/XML: error log; multi-CSV: ERROR log File Content 
<Type>SUCCESS/ERROR/EXCEPTION <Type> 
<Extension>CSV/ZIP</Extension> 
</Content>
</File>
<File>
<Name>-Single CSV/XML: exception log; multi-CSV: REJECTED log Name</Name>
<Content>-Single CSV/XML: exception log; multi-CSV: REJECTED log file Content  
<Type>SUCCESS/ERROR/EXCEPTION <Type>
<Extension>CSV/ZIP</Extension> 
</Content> 
</File>
</Files>                
For more information about the parameters that this syntax uses, see the section Parameters That You Can Use With the getImportActivityLogFiles Method.

Parameters for the GetImportActivityLogFiles Method

This table describes the parameters that you can use with the getImportActivityLogFiles method. The ImportJobId and BatchId parameters are required.
Parameter Description

ImportJobId

Specify the job ID of the last run import activity.

BatchId

Specify the batch ID of the last run import activity.

Use the MetadataPublicService to Retrieve Object Description

You use the GetObjectDefinitions web service method to retrieve the object description.

Retrieve Object Description

To retrieve object description using the getObjectDefinitions Web service method:

  1. Navigate to the web service located at the URL https://<domainname>/crmCommonMetadata/MetadataPublicService.

  2. From the operation drop-down list, select the operation getObjectDefinitions.

  3. Provide the values for the parameters GroupCode and ObjectName (optional parameter).Valid values for GroupCode and ObjectName are provided in the appendix.

  4. GroupCode is the code of the object whose metadata is to be imported. ObjectName is the child object within the group code whose metadata is to be retrieved.

  5. If you don't pass the ObjectName parameter, it retrieves metadata for all the child objects under the group code.

  6. This is a sample payload that can be sent to the method:

    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
    <ns1:getObjectDefinitions xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/metadata/publicService/types/">
    <ns1:Group xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/metadata/publicService/">
    <ns2:GroupCode>LEAD</ns2:GroupCode>
    <ns2:Objects>
    <ns2:ObjectName></ns2:ObjectName>
    </ns2:Objects>
    </ns1:Group>
    </ns1:getObjectDefinitions>
    </soap:Body>
    </soap:Envelope>      

    This is the sample response received:

    <ns0:getObjectDefinitionsAsyncResponse xmlns="" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns0="http://xmlns.oracle.com/apps/crmCommon/metadata/publicService/types/" xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    <ns1:Group xmlns:ns0="http://xmlns.oracle.com/apps/crmCommon/metadata/publicService/" xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/metadata/publicService/types/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns0:ObjectResponse">
    <ns0:GroupCode>LEAD</ns0:GroupCode>
    <ns0:Object>
    <ns0:Name>AccountWithoutPartyNumber_cWBIT</ns0:Name>
    <ns0:ImportFileName>AccountWithoutPartyNumber_c.csv</ns0:ImportFileName>
    <ns0:ParentObjectName>OrganizationProfileExtn</ns0:ParentObjectName>
    <ns0:ServiceObjectName xsi:nil="true"/>
    <ns0:DisplayLabel xsi:nil="true"/>
    <ns0:Field>
    <ns0:APIName>AcountWithoutPartyNumberText_c</ns0:APIName>
    <ns0:DataType>java.lang.String</ns0:DataType>
    <ns0:Length>80</ns0:Length>
    <ns0:DisplayLabel>AcountWithoutPartyNumberText_c</ns0:DisplayLabel>
    <ns0:ImportAttributeName>AcountWithoutPartyNumberText_c</ns0:ImportAttributeName>
    </ns0:Field>
    <ns0:Field>
    <ns0:APIName>CurcyConvRateType</ns0:APIName>
    <ns0:DataType>java.lang.String</ns0:DataType>
    <ns0:Length>15</ns0:Length>
    <ns0:DisplayLabel>CurcyConvRateType</ns0:DisplayLabel>
    <ns0:ImportAttributeName>CurcyConvRateType</ns0:ImportAttributeName>
    </ns0:Field>
    </ns0:Object>
    </ns1:Group>
    </ns0:getObjectDefinitionsAsyncResponse>

    where

    • Name is the name of the object to be used in the describe service.

    • DisplayLabel is the UI display label of the object.

    • ParentObjectName is the name of the parent object (if the object isn't a top-level object).

    • ServiceObjectName is the name used to refer to the object in WS.

    • Fields[] is the set of all external fields available in the object.

    • ImportFileName is the name of the file to be imported.

    Note that the response payload is indicative and not exhaustive.

Syntax and Parameters for the GetObjectDefinitions Method of the MetadataPublicService

You use the reference information to build the client application to call the MetadataPublicService.

Syntax Used by the GetObjectDefinitions Method

The getObjectDefinitions method uses this syntax:
<typ:getObjectDefinitions>
<mod:Group>
<mod:GroupCode> </mod: GroupCode>
<mod:Objects>
<mod:ObjectName> </mod: ObjectName>
</mod:Objects>
</mod:Group
</typ:getObjectDefinitions>      

For more information about the parameters that this syntax uses, see Parameters That You Can Use With the getObjectDefinitions Method.

Parameters for the GetObjectDefinitions Method

This table describes the parameters that you can use with the getObjectDefinitions method. The GroupCode parameter is required.

Parameter Description

GroupCode

Specify the group code of the high level object that's to be retrieved.

ObjectName

Specify the child object names under the Group Code object that should be retrieved.

A list of supported values for GroupCode, Group code description, and ObjectName can be found in the topic GroupCode and ObjectName Values for the GetObjectDefinitions Method.

Automate a Recurring Import Activity

You may require the ability to regularly import new business data. Usually, business data originates from an external system, such as, a customer portal that allows your customers to enter their contact information. However, this business data must also be uploaded in CX Sales and B2B Service for further processing. You can upload your business data on a recurring basis to CX Sales and B2B Service by implementing an automated recurring file-based data import. To implement automated recurring file-based data import, you need to:

  1. Prepare your source data file

  2. Define an import mapping

  3. Upload the data to be imported

  4. Define an import activity

  5. Monitor the status of an import activity

  6. Retrieve the log file for a completed import activity

Recurring Import Activity Options

To automate a recurring import activity:

  • Configure the Recurring Import Activity to Source Data from Your WebCenter Content Repository.

  • Configure the Recurring Import Activity to Source Data from the Import Web services.

Each approach has its unique benefits. It's important to evaluate each approach to ensure that you select the appropriate solution to meet your business needs.

Use the WebCenter Content Repository to Configure a Recurring Import Activity

You use the User Interface (UI) to configure a recurring import activity. While defining the import activity on the UI, you can select to upload the source file from the WebCenter Content Repository. You can then monitor the import activity using the available import Web services.

To configure the recurring import activity using the WebCenter content repository:

  1. Create a source data file in the format you plan to use for each data import.

  2. Define an import mapping using the Manage File Import Mappings task.

  3. Note the import mapping number value.

  4. Upload your source data file to the WebCenter Content Repository using one of these mechanisms:

    • Upload the file using the File Import and Export link in the Navigator.

    • Upload the file using the WebCenter Document Transfer Utility.

    You can download the latest version of the Oracle WebCenter Content Document Transfer Utility applicable for Applications use-cases from My Oracle Support (support.oracle.com) document Oracle WebCenter Content Document Transfer Utility Readme (document ID 1624063.1). You can run the tool by navigating to the ridc folder after extraction.

  5. Define a recurring import activity using the uploaded source data file.

    Optional Steps

    It's possible to monitor the status of the import activity and retrieve log files using the User Interface (UI). To automate this process:

  6. Note the Job ID value of the import activity in the Manage File Import Activities page.

  7. Create a Web service client that can use File Import Activity Service to monitor the import activities and retrieve the log files for completed activities using the Job ID value.

    1. You can monitor the status of an import activity using the getImportActivityStatus method.

    2. After the import activity status indicates that the import has completed, you can use the getImportActivityLogs method to retrieve the generated log files.

    Note: You can get more details on the available Web services in the Oracle Enterprise Repository by searching for File Import Activity Service and selecting a Type value of ADF Service and the appropriate value for the version field.

Use Web Services to Configure a Recurring Import Activity

You use the Web services interface to configure a recurring import activity. To configure the recurring import activity using Web services:

  1. Create a source data file in the format you plan to use for each import.

  2. Define an import mapping using the Manage File Import Mappings task.

  3. Note the import mapping number value.

  4. Base64 encode the source data file.

  5. Create a Web service client that can use the File Import Activity Service to submit import activities including the Base64 encoded version of the source data file. You can use the submitImportActivity method to create and activate your import activity. The Batch ID value of the import activity is returned in the response.

    Note: You can get more details on the available Web services in the Oracle Enterprise Repository by searching for File Import Activity Service and selecting a Type value of ADF Service and the appropriate version value.

    Optional Steps

    It's possible to monitor the status of the import activity and retrieve log files from the User Interface (UI). To automate this process:

  6. Use your Web service client to monitor the status of your import activity by passing the Batch ID value in the request.

  7. After you receive a status value indicating that the import activity has completed, use the web service client to retrieve log files for completed activities using the BatchID value.

  8. When you execute the import activity again, send a new Web service request with the same mapping number but a new base64 encoded source data file.

How You Prepare Your Source Data File for Recurring Import

You can prepare your source data file for recurring data import. This topic provides guidelines to split a large data file into multiple smaller files and considerations for the format of your source data file.

Source Data File Format Considerations

The source data file contains the set of records to be imported during file-based data import. You must ensure that your source data file contains the appropriate set of attributes to import data. You must consider the following when determining the format of your source data file:

  • Required attributes: Ensure that all the required attributes are included in the file and that each record has a value for all the required attributes. For more information about file-based data import object attributes, see the File-Based Data Import for CX Sales and B2B Service guide.

  • Conditionally required attributes: In some cases, the value of one attribute may be constrained based on the value of another attribute on the record. In these cases, a value must be provided for the conditionally required attribute.

  • File Size: The source data file can't exceed 250 megabytes (MB). Data sets larger than 250 megabytes (MB) must be split into multiple source data files.

    Note:

    Don't import more than 100,000 records in a single import or perform more than 5 concurrent import activities.

  • Attribute constraints: The value provided for an attribute must be within the constraints defined for the attribute (such as, the value must match the attribute type and must not exceed the attribute length).

  • Attachments: Consider whether you have file attachments that must be imported.

  • Custom objects and attributes: Create all custom objects and attributes and publish the sandbox. After you publish the sandbox, generate the Import and Export artifacts in the Application Composer before you can import values using File-Based Data Import.

The quality of the data set to be imported is important for a robust and efficient implementation of file-based data import. When you encounter an error in an import activity, review and fix the error and re-import the record. This process impacts the overall throughput in two ways:

  • When you process records with errors, it lowers the throughput of the initial import activity.

  • The time required to fix errors and re-import records increases the overall time required to import all records in a batch.

The time required to fix errors and re-import records increases the overall time required to import all records in a batch.

Guidelines to Split a Large Data Set Into Multiple Smaller Source Files

When automating an import activity, it's important to assess the requirements with respect to the volume of data that's imported for both the initial import and for recurring imports. When the total data imported exceeds the maximum source file size limit (250MB), you need to split the source data file into multiple source files.

Split Source Data into Multiple CSV Files

The File Size limit applies to the size of the ZIP file within which the multiple CSV files are contained. When generating data files within this size limit, follow these guidelines for multiple CSV file format:

  • Ensure that all the child records for a parent record are contained within the child CSV ZIP to avoid having to duplicate the parent record across multiple parent CSV files. Don't split child records for a parent record across files, as this reduces the overall size of your source data set.

  • While the file limit's 250 megabytes (MB), Oracle recommends that the actual file size should be less than 250 MB to provide some buffer for update of data within the files or addition of new columns or values to the data file.

Split Source Data into a Single CSV File

When generating data files within this size limit, follow these guidelines for single CSV file format:

  • Ensure all rows for a single parent record are contained in the same CSV file.

  • While the file size limit's 250 megabytes (MB), Oracle recommends that the actual file size should be less than 250 MB to provide some buffer for update of data within the files or addition of new columns or values to the data file.

Define an Import Mapping

To automate an import activity, you must create an import mapping that can be used for each recurrence of the import activity. There are two ways to define an import mapping:

  • When you map the fields during the creation of an import activity in the Manage File Import Activities task, a mapping definition is generated automatically. When it's defined, this mapping can be used by other import activities that you configure in future.

  • Use the Manage File Import Mappings task to define an import mapping that can be referenced before an import activity is defined.

Additionally, it's possible to leverage a predefined mapping. A predefined mapping can be used as is, or can be copied and edited using the Manage File Import Mappings task and then referenced during the creation of an import activity either using the Manage File Import Activities task or using Web services.

An import mapping should include the mapping for all columns within the source data file. Any columns that are contained in the source data file but that aren't to be imported should be marked with the Ignore option in the import mapping.

Note: When submitting an import activity using Web services, the mapping number value is required. This value can be retrieved from the edit page for an import mapping definition.

How You Import Data on a Recurring Basis

You can define a recurring import activity and configure the import activities.

You can upload source data files to CX Sales and B2B Service in one of these ways:

  • Manually update the import activity using the Manage File Import Activities task to replace the file that currently exists.

  • Upload the file to WebCenter Content Repository using the data transfer utility.

Define a Recurring Import Activity

A recurring import activity can be configured using the Manage File Import Activities task. You can define a recurring import activity to repeat at different frequencies such as, 12pm each day, every 2 hours, or every Friday.

The file to be imported must be uploaded to CX Sales and B2B Service in advance of the scheduled start time of the import activity. If the file isn't uploaded before the scheduled start time of the import activity, then an error occurs. The import activity is configured with a file name that can't change. The application marks imported files as processed. New data import operations don't import files that are marked as processed.

If you're planning to use Web services to monitor the status of a recurring import activity, then you must retrieve the BatchID (from the Import Activity Identifier column) value of the import activity from the Manage File Import Activities page and provide that value to the Web services client that's issuing the request. There's currently no method available to programmatically retrieve the batch ID for an import activity that has been configured using the User Interface (UI).

Note: It's required to upload files to the WebCenter Content Repository when configuring a recurring import activity as it's not possible to programmatically replace a file that has been uploaded from the desktop.

Guidelines to Configure Multiple Import Activities to Handle Multiple Source Files

Consider the volume of data that's imported using the recurring activity configured from the UI. If the volume of data exceeds the file size limit for File-Based Data Import, you need to define multiple import activities. If the number of files to be uploaded exceeds the number of recurring import activities scheduled, you need to manually import the remaining files.

Use Import Web Services to Upload Data on a Recurring Basis

You use import web services to upload data on a recurring basis and monitor the status of the import activity.

You can use the submitImportActivity method to trigger a new import activity every time a source data file is generated. This method must include a Base64 encoded file, the file name, the file type as well as the mapping number of the import mapping to be used. One advantage of this approach is that the correct number of import activities required to import the data can vary dynamically.

Use Oracle Web Center Content Document Transfer Utility to Upload a Source Data File

You use the transfer utility for Oracle WebCenter Content Repository to transfer a file from a local system to the content repository in CX Sales and B2B Service. You can import the files that have been uploaded to CX Sales and B2B Service using a recurring import activity definition. After executing a recurring data import, you can upload the source file for the next execution of the recurring import. To upload the new version of the file to the WebCenter Content Repository using the Document Transfer Utility, use this command:

java -classpath "oracle.ucm.fa_client_11.1.1.jar" oracle.ucm.client.UploadTool --url=URL --username=USERNAME --password=PASSWORD --primaryFile="PATH/FILENAME.csv" --ddocTitle="INPUTFILENAME" --k0=xComments --v0="" -dDocAccount=crm/OBJECTNAME/import/ --proxyPort=80 --checkout=true --dDocName=UCMFA000656

where

  • classpath indicates the path of the jar file

  • url indicates the URL of Web Center Content Management server

  • username and password indicate the credentials used to sign in to the server

  • primaryFile indicates the path of the CSV file

  • dDocTitle indicates the filename

  • k0=xComments indicates to clear the user comments

  • dDocAccount indicates the name of the import object

  • proxyHost indicates the host name of the proxy server

  • proxyPort indicates the port number used

  • dDocName is generated when you upload the file for the first time. This is the Content name of the file on UCM and is used during file-based web-service import.

You can download the latest version of the Oracle WebCenter Content Document Transfer Utility applicable for Applications use-cases from My Oracle Support (support.oracle.com) document Oracle WebCenter Content Document Transfer Utility Readme (document ID 1624063.1). You can run the tool by navigating to the ridc folder after extraction.

Account Folders for CX Sales and B2B Service Objects

When you upload a file to CX Sales and B2B Service, save the file in the appropriate WebCenter Content Repository account folder for each importable object. If the file is saved in the wrong account folder, the Webcenter Content Repository option doesn't show the file while browsing. You specify the account folder value in the upload tool command link using the —dDocAccount parameter.

This table lists the account folder for each importable object.

Object Name Account Folder Name

Appointment

crm/appointment/import/

Asset

crm/asset/import/

Budget

crm/mktBudget/import/

Campaign Members

crm/mktCampMembers/import/

Campaigns

crm/mktCampaigns/import/

Contact

crm/contact/import

Contract

crm/contract/import/

Country Structure

crm/countryStructure/import/

Employee Resource

crm/employeeResource/import/

Geography

crm/geography/import/

Incentive Compensation Transaction

ic/incentiveCompensationTransaction/import/

Interaction

crm/interaction/import/

Legal Entity

crm/legalEntity/import/

Marketing List

crm/mktList/import/

MCT_AGENT_CONN_PARAMS

crm/mctAgentConnParams/import/

MCT_CTD_AGENT

crm/mctCtdAgent/import/

MKT_ACT_ADVERTISING

crm/mktActAdvertising/import/

MKT_ACT_EVENT

crm/mktActEvent/import/

MKT_ACT_INTERACTION

crm/mktActInteraction/import/

Note

crm/note/import/

Opportunity

crm/opportunity/import/

Promotion

crm/promotion/import/

Resource Team

crm/resourceTeam/import/

Response

crm/response/import/

Sales Account Resource Team

crm/salesAccountResourceTeam/import/

Task

crm/task/import/

ZCA_TOP_EXTN

crm/zcaTopExtn/export/

Use Web Services to Upload a File

You can upload a file to WebCenter Content Repository using the Document Transfer Utility.

Use the File Import and Export Page to Upload a File

As an administrator, you can manage the files uploaded for file-based data import using the File Import and Export link in the navigator. This UI lets you view the set of files in each account folder, delete files that are no longer needed, or upload new files for import at a later time.

Monitor the Status of an Import Activity

You can monitor the import activities using the getImportActivityStatus method in the File Import Activity Service. This method returns the status of the specified import activity allowing a client application to programmatically monitor an activity and trigger an appropriate action based on the activity status. For example, the client may initiate a new import activity when the current activity completes or send a notification to the company administrator if an import activity completes with errors. This table provides the description and source for the getImportActivityLogs and getImportActivityStatus methods.

Method Description Source

getImportActivityLogs

Method to get the file import activity logs

Import Job Identifier

getImportActivityStatus

Method to get the file import activity status

Import Job Identifier

The getImportActivityStatus method returns the following parameters:

  • BatchID — System TaskID of the import job’s latest run.

  • Status — COMPLETE/COMPLETE WITH ERRORS/ERRORS

  • LoadDate — Date of the import job's latest run.

  • RecordReadFromFile — Total record count.

  • LoadErrors — Load errors record count.

  • FormatErrors — Format errors record count.

  • SuccessfullyLoaded — Success record count.

import

Retrieve the JobID Value for an Import Activity

To check the status or retrieve the logs for an import activity, you must provide the import job identifier value for the import activity you're checking. If the import activity is created using web services, then the Job ID is returned in the SOAP response when the activity was created. For import activities configured using the User Interface (UI), you can retrieve the jobID using the Manage File Import Activities page (refer to the Import Activity Identifier column) and provided it to the Web services client.

Retrieve Log Files

The getImportActivityLogs method takes the JobID value of the import activity as source. This method retrieves the log files for the specified import activity. The log files can be used to identify which records in the source data file have errors. The client application can then either resubmit the records with errors or alert the company administrator (or other users) so that they can resolve the issues in the source file. Log files retrieved using this method are base 64 encoded.

Use Web Services for File-Based Data Export

You use the Bulk Export Service Version 2 to export user-defined data. To use the Bulk Export Service Version 2, you must determine the endpoint to which SOAP requests are sent.

Access the WSDL URL

To determine the logical endpoint for Bulk Export Service Version 2, see the File-Based Data Import for CX Sales and B2B Service guide available on the Help Center (https://docs.oracle.com/en/cloud/saas/index.html).

To determine the physical endpoint:

  1. Launch the home page and sign in as a user.

  2. Navigate to an application's dashboard/work area page that belongs to CX Sales and B2B Service Account. For example, in the case of CX Sales and B2B Service account navigate to the Customers work area.

  3. You see a URL similar to https://<domainname>/customer/faces/CustomerCtrWorkarea in the browser's address bar. The <domainname> might be like https://<pod-name>.<lba>.xxx.oraclecloud.com.

  4. Build your physical endpoint by adding the static context root from the logical endpoint (in this example, /crmCommonBulkExport/BulkExportService) to https://<domainname>/ that you derived in the application's dashboard/work area. For this example, the physical endpoint is https://<domainname>/crmCommonBulkExport/BulkExportService. https://<domainname>/crmCommonBulkExport/BulkExportService is the WSDL URL for Bulk Export Service Version 2.

Operations Supported by the Bulk Export Service

An export job must be activated for extracting all the data.

You can activate two types of export jobs.

  • Generic Export-Exports data for individual objects to CSV files. You create jobs for generic export using the Schedule Export Processes task flow.

  • Hierarchy Export-For a parent object, exports all related object's data into ZIP files. You can create jobs for hierarchy export using the Manage File Export Activities task flow.

To represent export for each job, an export batch is created which is an instance of job execution. Before using the web service operations, create a generic export job from UI using the Schedule Export Processes task flow. After creating the UI job with the export map and schedule status, you can get the export job ID. When you run the export job, the batch ID representing the export run is returned. You use this batch ID as a parameter for the getAttachmentsForBatch web method.

The Bulk Export web service supports these operations :

  • runExportJob-Activates an existing generic export job.

  • getAttachmentsForBatch-Retrieves attachment information for a successful export batch.

  • getJob-Retrieves export job information.

  • findJobs-Queries export jobs and retrieves the corresponding export job information.

  • getBatch-Retrieves export batch information.

  • deleteBatch-Deletes export batch.

  • findBatches-Queries export batches and retrieves the corresponding export batch information.

  • findExportBatchesByJobId-Queries export batch for an export job.

runExportJob

Description: Runs the specified preexisting export job with an optionally specified time stamp range. A new export batch record is created for every export job run. After successful completion, this job returns an export batch ID which represents the export job run instance.

If you specify beginTm , then the records exported by the bulk export job will only contain those who's LastUpdateDate is on or after the specified beginTm parameter. If you specify endTm, the records exported by the bulk export job contain only those who's LastUpdateDate is on or before the specified endTm parameter. If the view being exported doesn't contain a column named LastUpdateDate, then all records are exported. If a ViewCriteria is already added in the export map while creating the export job, the DateTime filter, if defined in this web method, is applied along with the filters defined in the UI.

Asynchronous Name: runExportJobAsync

Asynchronous Callback: runExportJobAsyncResponse

Schema

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns1:runExportJob xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/"><ns1:jobId>export_job_id></ns1:jobId><ns1:beginTm xmlns:ns2="http://www.w3.org/2001/XMLSchema-instance" ns2:nil="true"/><ns1:endTm xmlns:ns2="http://www.w3.org/2001/XMLSchema-instance" ns2:nil="true"/></ns1:runExportJob></soap:Body></soap:Envelope>

Parameters

This table lists the details of the parameters for the runExportJob operation.

Parameter Description Is Required? Type

jobId

Unique number that identifies the bulk export job. A Job ID from an existing export job created from the Schedule Export Process UI has to be used.

Yes

Java.lang.Long

beginTm

The date and time that the runExportJob method uses as the beginning of the export interval. The export interval is the period of time that occurs from the first record update to the last record update that the Bulk Export service exports. For example, if you specify June 4, 2013 12:00 pm for the begin_time argument, then the Bulk Export service exports records that include a lastupdatedate value of June 4, 2013 12:00 pm or later. If you specify records that don't contain the lastupdatedate field, then the bulk export service exports all records. Format: YYYY-MM-DTHH:mm:ss.SSS

No

Java.lang.TimeStamp

endTm

The date and time that the runexportjob method uses as the end of the export interval. For example, if you specify June 4, 2013 12:00 pm for the end_time argument, then the Bulk Export service exports records that include a lastupdatedate value of June 4, 2013 12:00 pm or earlier. If you specify records that don't contain the LastUpdateDate field, then the Bulk Export service exports all records. Format: YYYY-MM-DTHH:mm:ss.SSS

No

Java.lang.TimeStamp

Output Schema

<ns0:runExportJobResponse xmlns:ns0="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/"><result xmlns="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">export_batch_id</result></ns0:runExportJobResponse>

Output Parameters

This table lists the details of the output parameters for the runExportJob operation.

Parameter Description Type

result

A unique batch ID created for the export job run is returned or null if export fails to activate or didn't create a batch number that identifies the export job.

Java.lang.Long

Example Cases

You can run the export job with time-based filters; however, you can't specify view criteria filter as in the case of UI.

To run an export job without any filter:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:runExportJob xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns1:jobId>export_job_idns1:jobId>export_job_id>
<ns1:beginTm xmlns:ns2="http://www.w3.org/2001/XMLSchema-instance" ns2:nil="true"/>
<ns1:endTm xmlns:ns2="http://www.w3.org/2001/XMLSchema-instance" ns2:nil="true"/>
</ns1:runExportJob>
</soap:Body>
</soap:Envelope> 

To run an export job which filters records that are last updated after begintm:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:runExportJob xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns1:jobId> export_job_id </ns1:jobId>
<ns1:beginTm xmlns:ns2="http://www.w3.org/2001/XMLSchema-instance" ns2:nil="true">begin_tm(2015-04-21T08:46:00.000)</ns1:beginTm>
<ns1:endTm xmlns:ns2="http://www.w3.org/2001/XMLSchema-instance" ns2:nil="true"/>
</ns1:runExportJob>
</soap:Body>
</soap:Envelope> 

To run an export job which filters records that are last updated before endTm:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:runExportJob xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns1:jobId>export_job_id ns1:jobId>export_job_id>
<ns1:beginTm xmlns:ns2="http://www.w3.org/2001/XMLSchema-instance" ns2:nil="true"/>
<ns1:endTm xmlns:ns2="http://www.w3.org/2001/XMLSchema-instance" ns2:nil="true">end_tm(2015-04-27T08:46:00.000)ns1:endTm xmlns:ns2="http://www.w3.org/2001/XMLSchema-instance" ns2:nil="true">end_tm(2015-04-27T08:46:00.000)</ns1:endTm>
</ns1:runExportJob>
</soap:Body>
</soap:Envelope>

To run an export job which filters records that are last updated after beginTm and before endTm:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:runExportJob xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns1:jobId>export_job_id</ns1:jobId>
<ns1:beginTm xmlns:ns2="http://www.w3.org/2001/XMLSchema-instance" ns2:nil="true">begin_tm(2015-04-21T08:46:00.000)</ns1:beginTm>
<ns1:endTm xmlns:ns2="http://www.w3.org/2001/XMLSchema-instance" ns2:nil="true">end_tm(2015-04-27T08:46:00.000)</ns1:endTm>
</ns1:runExportJob>
</soap:Body>
</soap:Envelope>

getAttachmentsForBatch

Description: For a successful export batch run, this web method returns a list of attachment details.

Asynchronous Name: getAttachmentsForBatchAsync

Asynchronous Callback: getAttachmentsForBatchAsyncResponse

Schema:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getAttachmentsForBatch xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns1:batchId>export_batch_idns1:batchId>export_batch_id>
</ns1:getAttachmentsForBatch>
</soap:Body>
</soap:Envelope>

Parameters:

This table lists the details of the parameters for the getAttachmentsForBatch operation.

Parameter Description Is Required? Type

batchId

Represents a unique export batch ID for a successful export job run.

Yes

Java.lang.Long

Output Schema:

<ns0:getAttachmentsForBatchResponse xmlns:ns0="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<ns2:result xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/" xmlns:ns0="http://xmlns.oracle.com/adf/svc/types/" xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:BulkExportAttachment">
<ns1:Filename>exported_file_name</ns1:Filename>
<ns1:Size>exported_file_size</ns1:Size>
<ns1:URL>exported_file_url</ns1:URL>
<ns1:creationDate>exported_file_creationDate</ns1:creationDate>
<ns1:ContentId>exported_file_Content_Id</ns1:ContentId>
</ns2:result>
</ns0:getAttachmentsForBatchResponse>

Output Parameters:

This table lists the details of the output parameters for the getAttachmentsForBatch operation.

Parameter Description Type

filename

The file name of the exported file which is uploaded to the UCM when the export batch is successful.

String

size

The size of the uploaded file that's present in UCM.

String

URL

A URL which is session-specific and expires in five minutes (based on the FND_EXPIRES value in the output).

String

creationDate

The date time of the file exported to UCM.

Date time

contentId

A unique string to identify a file in UCM.

String

Example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getAttachmentsForBatch xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns1:batchId>Export_batch_id</ns1:batchId>
</ns1:getAttachmentsForBatch>
</soap:Body>
</soap:Envelope>

Sample Output:

<ns0:getAttachmentsForBatchResponse xmlns="" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns0="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/" xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<ns2:result xmlns:ns0="http://xmlns.oracle.com/adf/svc/types/" xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/" xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:BulkExportAttachment">
<ns1:Filename>export_file_name.csv</ns1:Filename>
<ns1:Size>1020</ns1:Size>
<ns1:URL>/content/conn/FusionAppsContentRepository/uuid/dDocID%3a5376?XFND_SCHEME_ID=1&XFND_CERT_FP=A1B338F6583E91F6394AEF4AEDDB0DDF5959019F&XFND_RANDOM=7577923950069222936&XFND_EXPIRES=1430282354939&XFND_SIGNATURE=ZukeZjxpzKub`fbSfmUrTxmgmTjFtIylDw9Pdb3Jdcr9G32f7PJYcnSg9ZWYQ-nWDvtbH8LZCBoJWXs32Sq6qVypUiycLhXjz-C50RtDRQ0JqtJOL35MqTnD22u7q2fC8EYvT9xuyZhfnxOOt-5PwSdHG4dSvrAbiySVHQClL8Q_&Id=46395&download</ns1:URL>
<ns1:creationDate>2015-04-28T21:18:02.325-07:00</ns1:creationDate>
<ns1:ContentId>UCMFA046146</ns1:ContentId>
</ns2:result>
</ns0:getAttachmentsForBatchResponse>

getJob

Retrieves export job information for a given file export job ID.

Asynchronous Name: getJobAsync

Asynchronous Callback: getJobAsyncResponse

Schema:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getJob xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns1:exportJobId>export_job_id</ns1:exportJobId>
</ns1:getJob>
</soap:Body>
</soap:Envelope>

Parameters:

This table lists the details of the parameters for the getJob operation.

Parameter Description Is Required? Type

exportJobId

Export job ID created from the export UI.

Yes

Java.lang.Long

Output Schema:

<ns0:getJobResponse xmlns:ns0="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns2:result xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/" xmlns:ns0="http://xmlns.oracle.com/adf/svc/types/" xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:BulkExportJobs">
<ns1:ExportJobId>export_job_id</ns1:ExportJobId>
<ns1:Name>export_job_name</ns1:Name>
<ns1:DescriptionText xsi:nil="true"/>
...
...
</ns2:result>
</ns0:getJobResponse>

Output Parameters:

Export Job details (See Service Data Objects That the Bulk Export Service Version 2 Uses referenced in Related Topics section).

findJobs

This operation finds the jobs that are created and are available in the export schema.

Asynchronous Name: findJobsAsync

Asynchronous Callback: findJobsAsyncResponse

Schema:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:findJobs xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns1:findCriteria xmlns:ns2="http://xmlns.oracle.com/adf/svc/types/">
<ns2:fetchStart/>
<ns2:fetchSize/>
<ns2:filter>
<ns2:conjunction/>
</ns2:filter>
<ns2:sortOrder/>
<ns2:excludeAttribute/>
</ns1:findCriteria>
<ns1:findControl xmlns:ns2="http://xmlns.oracle.com/adf/svc/types/">
<ns2:retrieveAllTranslations/>
</ns1:findControl>
</ns1:findJobs>
</soap:Body>
</soap:Envelope>

Parameters:

This table lists the details of the parameters for the findJobs operation.

Parameter Description Type

exportJobId

The criteria used to limit your query result based on the values provided for Export Batch row values, such as the filter (where clause), the retrieve size.

FindCriteria

findControl

The filter to retrieve all translations.

FindControl

Output Parameters:

Export Job details (See Service Data Objects That the Bulk Export Service Version 2 Uses referenced in Related Topics section).

Example:

To find the latest export job created, check this example:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:findJobs xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns1:findCriteria xmlns:ns2="http://xmlns.oracle.com/adf/svc/types/">
<ns2:fetchStart>0</ns2:fetchStart>
<ns2:fetchSize>1</ns2:fetchSize>
<ns2:sortOrder>
<ns2:sortAttribute>
<ns2:name>CreationDate</ns2:name>
<ns2:descending>true</ns2:descending>
</ns2:sortAttribute>
</ns2:sortOrder>
</ns1:findCriteria>
</ns1:findJobs>
</soap:Body>
</soap:Envelope>

getBatch

This operation retrieves export batch information based on the export batch ID.

Asynchronous Name: getBatchAsync

Asynchronous Callback: getBatchAsyncResponse

Schema:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getBatch xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns1:exportBatchId>export_batch_id</ns1:exportBatchId>
</ns1:getBatch>
</soap:Body>
</soap:Envelope>

Parameters:

This table lists the details of the parameters for the getBatch operation.

Parameter Description Type

exportBatchId

The export batch ID of an executed export job.

Java.lang.Long

Output Parameters:

Export Job details (See Service Data Objects That the Bulk Export Service Version 2 Uses referenced in Related Topics section).

deleteBatch

This operation deletes a file export batch based on the export batch record details.

Asynchronous Name: deleteBatchAsync

Asynchronous Callback: deleteBatchAsyncResponse

Schema:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:deleteBatch xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns1:bulkExportBatches1 xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/">
<ns2:ExportBatchId>export_batch_id</ns2:ExportBatchId>
<ns2:ExportJobId>export_job_id</ns2:ExportJobId>
...
</ns1:bulkExportBatches1>
</ns1:deleteBatch>
</soap:Body>
</soap:Envelope>

Parameters:

Export batch details

Output Parameters: Returns void.

findBatches

This operation finds the export batches that are created and available in the environment.

Asynchronous Name: findBatchesAsync

Asynchronous Callback: findBatchesAsyncResponse

Schema:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:findBatches xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns1:findCriteria xmlns:ns2="http://xmlns.oracle.com/adf/svc/types/">
<ns2:fetchStart />
<ns2:fetchSize />
<ns2:filter>
<ns2:conjunction />
</ns2:filter>
<ns2:sortOrder/>
<ns2:excludeAttribute/>
</ns1:findCriteria>
<ns1:findControl xmlns:ns2="http://xmlns.oracle.com/adf/svc/types/">
<ns2:retrieveAllTranslations/>
</ns1:findControl>
</ns1:findBatches>
</soap:Body>
</soap:Envelope>

Parameters:

This table lists the details of the parameters for the findBatches operation.

Parameter Description Type

findCriteria

The criteria used to limit your query result based on the values provided for Export Batch row values, such as the filter (where clause), the retrieve size.

FindCriteria

findControl

The filter to retrieve all translations.

FindControl

Output Parameters:

Export Job details (See Service Data Objects That the Bulk Export Service Version 2 Uses referenced in Related Topics section).

Example:

Returns the latest export batch record order by ExportBatchId.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:findBatches xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns1:findCriteria xmlns:ns2="http://xmlns.oracle.com/adf/svc/types/">
<ns2:fetchStart>0</ns2:fetchStart>
<ns2:fetchSize>1</ns2:fetchSize>
<ns2:sortOrder>
<ns2:sortAttribute>
<ns2:name>ExportBatchId</ns2:name>
<ns2:descending>true</ns2:descending>
</ns2:sortAttribute>
</ns2:sortOrder>
</findCriteria>
</findBatches>
</soap:Body>
</soap:Envelope> 

findExportBatchesByJobId: - This operation finds file export batches which are specific to an export JobId.

Asynchronous Name: findExportBatchesByJobIdAsync

Asynchronous Callback: findExportBatchesByJobIdAsyncResponse

Schema:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:findExportBatchesByJobId xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
<ns1:findCriteria xmlns:ns2="http://xmlns.oracle.com/adf/svc/types/">
<ns2:fetchStart />
<ns2:fetchSize />
<ns2:filter>
<ns2:conjunction />
</ns2:filter>
<ns2:sortOrder />
<ns2:excludeAttribute />
</ns1:findCriteria>
<ns1:jobId />
<ns1:findControl xmlns:ns2="http://xmlns.oracle.com/adf/svc/types/" >
<ns2:retrieveAllTranslations />
</ns1:findControl>
</ns1:findExportBatchesByJobId >
</soap:Body>
</soap:Envelope>

Parameters

This table lists the details of the parameters for the findExportBatchesByJobId operation.

Parameter Description Type

findCriteria

The criteria used to limit your query result based on the values provided for Export Batch row values, such as the filter (where clause), the retrieve size.

FindCriteria

jobId

Export job ID

Java.lang.Long

findControl

The filter to retrieve all translations.

FindControl

Output Parameters:

Export Job details (See Service Data Objects That the Bulk Export Service Version 2 Uses referenced in Related Topics section).

Example:

Returns latest export batch ID for an export job ID.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:findExportBatchesByJobId xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/" >
<ns1:findCriteria xmlns:ns2="http://xmlns.oracle.com/adf/svc/types/" >
<ns2:fetchStart>0</ns2:fetchStart>
<ns2:fetchSize>1</ns2:fetchSize>
<ns2:sortOrder>
<ns2:sortAttribute>
<ns2:name>CreationDate</ns2:name>
<ns2:descending>true</ns2:descending>
</ns2:sortAttribute> 
</ns2:sortOrder>
</ns1:findCriteria>
<ns1:jobId>export_job_id</ns1:jobId>
</ns1:findExportBatchesByJobId>
</soap:Body>
</soap:Envelope> 

Developer Connect Web Methods

These Developer Connect web methods aren't specific to export and are available across all web services.

  • getDfltObjAttrHints - An operation to retrieve user interface hints, such as the service data object label and object attribute labels, for the specified service data object and locale. As a prerequisite, call the getEntityList operation defined on this service to get the list of possible values for the viewName request payload element.

  • getServiceLastUpdateTime - An operation that returns the date and time when the schema files referenced in the service definition last changed.

  • getEntityList - An operation to get the list of service data objects defined on this service.

Service Data Objects Used By the Bulk Export Web service

This topic describes the Service Data Objects (SDO) that the Bulk Export Version 2 web service uses. It includes the following information:

  • File Export Batch Version 2 Service Data Object.

  • File Export Job Version 2 Service Data Object.

File Export Batch Version 2 Service Data Object

This table lists the attributes that you can use with the File Export Batch Version 2 service data object. The ExportBatchId attribute is the only unique attribute.

Attribute Description Type

AttachmentEntityName

The attachment associated with the export batch record.

String

CreatedBy

The user who created the export batch row.

String

CreationDate

The date on which the export batch record was created.

Time stamp

EndFilterTm

The end time filter based on the last updated date for that exported object.

Time stamp

EndTm

The end time of the scheduled export batch.

Time stamp

ExportBatchId

The unique identifier of the export batch run.

Java.lang.Long

ExportJobId

Export job identifier.

Java.lang.Long

LastUpdateDate

The last updated date of the current export batch record.

Time stamp

LastUpdatedBy

The user who last updated the current export batch record.

String

LastUpdateLogin

The session login associated with the user who last updated the export batch.

String

ObjectVersionNumber

The optimistic locking value which is modified when the export job is updated.

Integer

StartFilterTm

The start time filter based on the last updated date for the exported object.

Time stamp

StartTm

The start time of the scheduled export batch.

Time stamp

Status

The status of the export batch record.

String

File Export Job Version 2 Service Data Object

This table lists the attributes that you can use with the File Export Job Version 2 service data object. The ExportJobId attribute is the only key attribute.

Attribute Description Type

ActiveFlag

Indicates if the export job is currently active.

Boolean

Compression

The file compression type for the export file:

  • CSV - No Compression

  • ZIP - ZIP Compression

String

CreatedBy

The user who created the export batch job.

String

CreationDate

The time at which the export job was created.

Time stamp

DateFormat

The date format that can be selected when creating the export job:

  • dd/MM/yyyy

  • dd.MON.yyyy

String

DecimalSeparator

The decimal separator used in the fields while exporting data:

  • Period -.

  • Comma -,

String

Delimiter

The delimiter used between fields while exporting data:

  • Comma

  • Tab

String

DescriptionText

The job description that can be entered while creating export jobs.

String

EndDateTm

The end date time for a repeating export job.

Time stamp

EndOfLine

The end of line character that's exported after reading every record:

  • Line Feed

  • Carriage Return

  • Carriage Return and Line Feed

String

ExportJobId

The unique value for an export job.

Java.lang.Long

ExportMapId

The export map identifier that's associated with the current export job.

Java.lang.Long

FileCharset

The character set of the data that's exported.

String

FileType

The type of file that's exported:

  • CSV

  • ZIP

String

HeaderRowIncluded

Indicates whether a header is exported before data in the exported file:

  • Y - Header exported

  • N - Header not exported

String

LastBatchId

The last executed export batch identifier.

Java.lang.Long

LastBatchStartTm

The start time of the last executed export batch.

Time stamp

Name

The name of the export job.

String

NextScheduleTm

The next scheduled batch time for a scheduled export job.

Time stamp

NullValue

The value used in export fields in case of NULL value. The default value is NULL.

String

LastUpdateDate

The last updated date of the current export batch record.

Time stamp

LastUpdatedBy

The user who last updated the current export batch record.

String

LastUpdateLogin

The session login associated with the user who last updated the export batch.

String

ObjectVersionNumber

The optimistic locking value which is modified when the export job is updated.

Integer

RepeatFrequency

The frequency with which a scheduled export job is run.

Java.lang.Long

StartTm

The start time of the scheduled export batch.

Time stamp

RepeatUnitCd

The status of the export batch record.

String

ParentRequestId

The parent ESS request identifier for repeating export jobs.

Java.lang.Long

QuoteChar

The repeat unit code (hours, days, weeks, months) for a scheduled export job.

String

RequestId

The ESS request identifier activated by the export job.

Java.lang.Long

ScheduleModeCd

The mode of the scheduled export job

  • Repeating

  • One time

  • Incremental

String

ScheduleStatusCd

Indicates whether an export job is scheduled.

String

ScheduleTypeCd

The schedule type of an export job.

  • Immediate

  • Scheduled

String

TimestampFormat

The time stamp format used by export for time stamp fields.

String

ExportJobNumber

The unique string representing an export job.

String

Automate a Recurring Export Activity

You automate an export using the BulkExport web service. To automate an export activity:

  1. Configure the export in the User Interface (UI).

  2. Retrieve the details of export using the getJob (ExportProcessID) web service method.

  3. Retrieve the list of attachments for the export using the getAttachmentsForBatch (LastBatchID) web service method.

  4. Retrieve the attachment file using the document transfer utility.

This image shows the process flow involved in automating a recurring export activity.

This figure shows the process flow involved in
automating a recurring export activity.
Note: All web service methods referenced in this topic are available at http://<host_name>:<port>/crmCommonBulkExport/BulkExportService. The credentials used for retrieving data using web services must match the credentials used by the user who submitted the export activity.

Configure the Export Activity in the UI

You can configure either a bulk export or a file-based data export. The primary difference is that file-based data exports maintain the parent-child relationships while bulk exports retrieve all child records matching the filter criteria, regardless of whether the parent record is included in the export. You can also select child objects without exporting parent objects using Bulk Export. File-Based Data Export delivers your exported data in a format which can later be imported back into CX Sales and B2B Service without having to change the file structure. For more information see the topic File-Based Data Export: Explained referenced in the Related Topics section. To start the export activity:

  1. In the Setup and Maintenance work area, navigate to:

    • Offering: Sales

    • Functional Area: Data Import and Export

  2. To run bulk export, search for the task Schedule Export Processes. To run file-based data export, search for the task Manage File Export Activity.

  3. Navigate to the task and configure a recurring export activity.

    Note the Export Process ID value.

Retrieve the Batch Details for the Export Activity

You must retrieve the detailed information for your export periodically. You can get this information using either of these methods:

  • Retrieve the last batch ID for an export activity using the getJob method.

  • Retrieve the details of all batches for your export using the findExportBatchesByJobId method.

Retrieve the Last Batch ID for an Export Activity

To retrieve the last batch ID for an export activity:

  1. Execute the getJob web method passing the ExportProcessId as parameter, which is the value you noted in step 4 of the previous section, Configuring the Export in the UI.

  2. This is a sample SOAP request:

    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
    <ns1:getJob xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/publicModel/types/">
    <ns1:exportJobId>300100093214372</ns1:exportJobId>
    </ns1:getJob>
    </soap:Body>
    </soap:Envelope>
  3. This is the sample response received:

    <ns0:getJobResponse xmlns:ns0="http://xmlns.oracle.com/apps/crmCommon/bulkExport/publicModel/types/">
    <ns0:result xmlns:ns1="http://xmlns.oracle.com/adf/svc/types/" xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/bulkExport/publicModel/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:CrmCommonExportJobsSvcSDO">
    <ns2:ActiveFlag>N</ns2:ActiveFlag>
    <ns2:Compression>N</ns2:Compression>
    <ns2:CreatedBy>MHoope</ns2:CreatedBy>
    <ns2:CreationDate>2016-06-22T14:00:00.377-07:00</ns2:CreationDate>
    <ns2:DateFormat>dd/MM/yyyy</ns2:DateFormat>
    <ns2:DecimalSeparator>.</ns2:DecimalSeparator>
    <ns2:Delimiter>COMMA</ns2:Delimiter>
    <ns2:DescText xsi:nil="true"/>
    <ns2:EndDateTm>2016-06-22T15:03:00.0-07:00</ns2:EndDateTm>
    <ns2:EndOfLine>LF</ns2:EndOfLine>
    <ns2:ErrorThreshold>0</ns2:ErrorThreshold>
    <ns2:ExportJobId>300100093214372</ns2:ExportJobId>
    <ns2:ExportMapId>300100093214376</ns2:ExportMapId>
    <ns2:FileCharset>UTF-8</ns2:FileCharset>
    <ns2:FileType>CSV</ns2:FileType>
    <ns2:HeaderRowIncluded>Y</ns2:HeaderRowIncluded>
    <ns2:LastBatchId>300100093219930</ns2:LastBatchId>
    <ns2:LastBatchStartTm>2016-06-22T14:54:00.0-07:00</ns2:LastBatchStartTm>
    <ns2:LastUpdateDate>2016-06-22T14:54:08.009-07:00</ns2:LastUpdateDate>
    <ns2:LastUpdateLogin>35E535D7A354519BE053ECC1F20A71A2</ns2:LastUpdateLogin>
    <ns2:LastUpdatedBy>MHoope</ns2:LastUpdatedBy>
    <ns2:Name>PMWG Recurring</ns2:Name>
    <ns2:NextScheduleTm xsi:nil="true"/>
    <ns2:NullValue xsi:nil="true"/>
    <ns2:ObjectVersionNumber>7</ns2:ObjectVersionNumber>
    <ns2:ParentRequestId xsi:nil="true"/>
    <ns2:QuoteChar>"</ns2:QuoteChar>
    <ns2:RepeatFrequency>10</ns2:RepeatFrequency>
    <ns2:RepeatUnitCd>MINUTES</ns2:RepeatUnitCd>
    <ns2:RequestId>14007</ns2:RequestId>
    <ns2:ScheduleModeCd>REPEATING</ns2:ScheduleModeCd>
    <ns2:ScheduleStatusCd>SCHEDULED</ns2:ScheduleStatusCd>
    <ns2:StartTm>2016-06-22T14:04:00.0-07:00</ns2:StartTm>
    <ns2:TimestampFormat>yyyy-MM-dd'T'HH:mm:ss.SSSZ</ns2:TimestampFormat>
    <ns2:ExportJobNumber xsi:nil="true"/>
    <ns2:InitialExtractFilterTm xsi:nil="true"/>
    <ns2:MassUpdateDtlId xsi:nil="true"/>
    </ns0:result>
    </env:Body>
    </env:Envelope>

Retrieve All Batches for an Export Activity

You can use the findExportBatchesByJobId method to retrieve the details of all batches for your export. To retrieve all batches for an export activity:

  1. Execute the findExportBatchesByJobId web method passing the ExportProcessId as parameter, which is the value you noted in step 4 of the previous section, Configuring the Export in the UI.

  2. This is a sample SOAP request:

    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
    <ns1:findCriteria xmlns:ns2="http://xmlns.oracle.com/adf/svc/types/">
    <ns2:fetchStart>1</ns2:fetchStart>
    <ns2:fetchSize>100</ns2:fetchSize>
    <ns2:filter> 
    <ns2:conjunction></ns2:conjunction>
    </ns2:filter>
    <ns2:sortOrder></ns2:sortOrder>
    <ns2:excludeAttribute>FALSE</ns2:excludeAttribute>
    </ns1:findCriteria>
    <ns1:jobId>300100093214372</ns1:jobId>
    <ns1:findControl xmlns:ns2="http://xmlns.oracle.com/adf/svc/types/">
    <ns2:retrieveAllTranslations>FALSE</ns2:retrieveAllTranslations>
    </ns1:findControl>
    </ns1:findExportBatchesByJobId>
    </soap:Body>
    </soap:Envelope>
  3. This is the sample response received

    <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/crmCommon/bulkExport/bulkExportServiceV2//BulkExportService/findExportBatchesByJobIdResponse</wsa:Action>
    ...
    </env:Header>
    <env:Body xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="Body-TriGfXzuy66Iir5EoAAYBQ22">
    <ns0:findExportBatchesByJobIdResponse xmlns:ns0="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
    <ns2:result xmlns:ns0="http://xmlns.oracle.com/adf/svc/types/" xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/" xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:BulkExportBatches">
    <ns1:ExportBatchId>300100093219841</ns1:ExportBatchId>
    <ns1:ExportJobId>300100093214372</ns1:ExportJobId>
    <ns1:Status>SUCCEEDED</ns1:Status>
    <ns1:StartTm>2016-06-22T14:34:00.0-07:00</ns1:StartTm>
    <ns1:EndTm>2016-06-22T14:42:00.0-07:00</ns1:EndTm>
    <ns1:CreationDate>2016-06-22T14:34:07.0-07:00</ns1:CreationDate>
    <ns1:CreatedBy>MHoope</ns1:CreatedBy>
    <ns1:LastUpdateDate>2016-06-22T14:42:00.635-07:00</ns1:LastUpdateDate>
    <ns1:LastUpdatedBy>MHoope</ns1:LastUpdatedBy>
    <ns1:LastUpdateLogin>35DCC47A70780952E053ECC1F20A7A75</ns1:LastUpdateLogin>
    <ns1:ObjectVersionNumber>3</ns1:ObjectVersionNumber>
    <ns1:AttachmentEntityName>ZCA_EXP_BATCHES</ns1:AttachmentEntityName>
    <ns1:StartFilterTm xsi:nil="true"/>
    <ns1:EndFilterTm xsi:nil="true"/>
    </ns2:result>
    <ns2:result xmlns:ns0="http://xmlns.oracle.com/adf/svc/types/" xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/" xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:BulkExportBatches">
    <ns1:ExportBatchId>300100093219902</ns1:ExportBatchId>
    <ns1:ExportJobId>300100093214372</ns1:ExportJobId>
    <ns1:Status>SUCCEEDED</ns1:Status>
    <ns1:StartTm>2016-06-22T14:44:00.0-07:00</ns1:StartTm>
    <ns1:EndTm>2016-06-22T14:44:00.0-07:00</ns1:EndTm>
    <ns1:CreationDate>2016-06-22T14:44:03.0-07:00</ns1:CreationDate>
    <ns1:CreatedBy>MHoope</ns1:CreatedBy>
    <ns1:LastUpdateDate>2016-06-22T14:44:45.016-07:00</ns1:LastUpdateDate>
    <ns1:LastUpdatedBy>MHoope</ns1:LastUpdatedBy>
    <ns1:LastUpdateLogin>35DCC47A70810952E053ECC1F20A7A75</ns1:LastUpdateLogin>
    <ns1:ObjectVersionNumber>3</ns1:ObjectVersionNumber>
    <ns1:AttachmentEntityName>ZCA_EXP_BATCHES</ns1:AttachmentEntityName>
    <ns1:StartFilterTm xsi:nil="true"/>
    <ns1:EndFilterTm xsi:nil="true"/>
    </ns2:result>
    <ns2:result xmlns:ns0="http://xmlns.oracle.com/adf/svc/types/" xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/" xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:BulkExportBatches">
    <ns1:ExportBatchId>300100093219930</ns1:ExportBatchId>
    <ns1:ExportJobId>300100093214372</ns1:ExportJobId>
    <ns1:Status>SUCCEEDED</ns1:Status>
    <ns1:StartTm>2016-06-22T14:54:00.0-07:00</ns1:StartTm>
    <ns1:EndTm>2016-06-22T14:54:00.0-07:00</ns1:EndTm>
    <ns1:CreationDate>2016-06-22T14:54:08.0-07:00</ns1:CreationDate>
    <ns1:CreatedBy>MHoope</ns1:CreatedBy>
    <ns1:LastUpdateDate>2016-06-22T14:54:50.055-07:00</ns1:LastUpdateDate>
    <ns1:LastUpdatedBy>MHoope</ns1:LastUpdatedBy>
    <ns1:LastUpdateLogin>35E535D7A354519BE053ECC1F20A71A2</ns1:LastUpdateLogin>
    <ns1:ObjectVersionNumber>3</ns1:ObjectVersionNumber>
    <ns1:AttachmentEntityName>ZCA_EXP_BATCHES</ns1:AttachmentEntityName>
    <ns1:StartFilterTm xsi:nil="true"/>
    <ns1:EndFilterTm xsi:nil="true"/>
    </ns2:result>
    <ns2:result xmlns:ns0="http://xmlns.oracle.com/adf/svc/types/" xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/" xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:BulkExportBatches">
    <ns1:ExportBatchId>300100093219795</ns1:ExportBatchId>
    <ns1:ExportJobId>300100093214372</ns1:ExportJobId>
    <ns1:Status>SUCCEEDED</ns1:Status>
    <ns1:StartTm>2016-06-22T14:14:00.0-07:00</ns1:StartTm>
    <ns1:EndTm>2016-06-22T14:41:00.0-07:00</ns1:EndTm>
    <ns1:CreationDate>2016-06-22T14:14:17.0-07:00</ns1:CreationDate>
    <ns1:CreatedBy>MHoope</ns1:CreatedBy>
    <ns1:LastUpdateDate>2016-06-22T14:41:58.811-07:00</ns1:LastUpdateDate>
    <ns1:LastUpdatedBy>MHoope</ns1:LastUpdatedBy>
    <ns1:LastUpdateLogin>35DCC47A70660952E053ECC1F20A7A75</ns1:LastUpdateLogin>
    <ns1:ObjectVersionNumber>3</ns1:ObjectVersionNumber>
    <ns1:AttachmentEntityName>ZCA_EXP_BATCHES</ns1:AttachmentEntityName>
    <ns1:StartFilterTm xsi:nil="true"/>
     <ns1:EndFilterTm xsi:nil="true"/>
    </ns2:result>
    </ns0:findExportBatchesByJobIdResponse>
    </env:Body>
    </env:Envelope>
  4. Note the batch ID in the payload received from last step. You will need it to retrieve the list of attachments in the next section.

Retrieve the List of Attachments

To retrieve the list of attachments for the export activity using the getAttachmentsForBatch Web service method:

  1. Navigate to the Bulk Export web and execute the operation getAttachmentsForBatch.

  2. Provide appropriate values for the batch ID for which you want to download the list of attachments. For more information about web services, see the SOAP Web Services for CX Sales and B2B Service guide at Help Center(https://docs.oracle.com/en/cloud/saas/index.html).

  3. You can send this sample payload to the method:

    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
    <ns1:getAttachmentsForBatch xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/">
    <ns1:batchId>(batch_id)</ns1:batchId>
    </ns1:getAttachmentsForBatch>
    </soap:Body>
    </soap:Envelope>
  4. This is the sample response received:

    <ns0:getAttachmentsForBatchResponse xmlns="" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns0="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/" xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:wsu="http://docs.oasis- open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    <ns2:result xmlns:ns0="http://xmlns.oracle.com/adf/svc/types/" xmlns:ns1="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/" xmlns:ns2="http://xmlns.oracle.com/apps/crmCommon/bulkExport/bulkExportServiceV2/types/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns1:BulkExportAttachment">
    <ns1:Filename>ActivityAssigneeExpVO.csv</ns1:Filename>
    <ns1:Size>492</ns1:Size>
    <ns1:URL>/content/conn/FusionAppsContentRepository/uuid/dDocID%3a5376?XFND_SCHEME_ID=1&XFND_CERT_FP=7BEBDBA4E82216E20CE0541BEEC8EC1BC18F3FA6&XFND_RANDOM=4791870370786509250&XFND_EXPIRES=Oga3Acxpqp2uDT-TGwIyxPeJ1m-7SCPKYR5BnXqWI681NRudJATK572-
    81nv672c6aPZPl~nmzeWfyol41DxTLevlKO4RqlxZRa1O9mjBAJrshKTjCGiVgg_&Id=3107</ns1:URL>
    <ns1:creationDate>2013-11-18T23:42:52.906-08:00</ns1:creationDate>
    <ns1:ContentId>UCMFA001926</ns1:ContentId>
    </ns2:result>
    </ns0:getAttachmentsForBatchResponse>
  5. Note the URL and ContentId values in the payload received from the last step. You will need them to retrieve the attachment file in the next section.

Use the Document Transfer Utility to Retrieve the Attachments File

To download the export file using the Document Transfer Utility:

  1. Download the latest version of the Oracle WebCenter Content Document Transfer Utility applicable for Applications use-cases from My Oracle Support (support.oracle.com) document Oracle WebCenter Content Document Transfer Utility Readme (document ID 1624063.1). You can run the tool by navigating to the ridc folder after extraction. For more information, see the topic Using Import Web Services to Upload Data on a Recurring Basis.

  2. Execute this command to download the export file to the specific location mentioned in the outputFile parameter: dDocName value is the ContentId that you noted in the last step of the previous section.

    java -classpath "oracle.ucm.fa_client_11.1.1.jar" oracle.ucm.client.DownloadTool --url="http://<host_name>:<port>/cs/idcplg" --username=USERNAME --password=PASSWORD --dDocName=UCMFA001926 --k0=XFND_SCHEME_ID --v0=1 --k1=XFND_CERT_FP --v1=7BEBDBA4E82216E20CE0541BEEC8EC1BC18F3FA6 --k2=XFND_RANDOM --v2=4791870370786509250 --k3=XFND_EXPIRES --v3=1384848657611 --k4=XFND_SIGNATURE --v4="U4Uif0bAVdMrR6h-jhqccAQWwEUdPMxFtNmH3Y9SyFEpP8Z3V6-Oga3Acxpqp2uDT-TGwIyxPeJ1m-7SCP-KYR5BnXqWI681NRudJATK572-81nv672c6aPZPl~nmzeWfyol41DxTLevlKO4RqlxZRa1O9mjBAJrshKTjCGiVgg_"  --simpleRIDCLogging --verbose --outputFile="/tmp/aa_output_d1.csv"

GroupCode and ObjectName Values for the GetObjectDefinitions Method

You can pass the supported values for GroupCode and ObjectName to the getObjectDefinitions method.

Supported Parameter Values for the GetObjectDefinitions Method

This table lists the supported values for GroupCode and ObjectName. Note that the ObjectName for custom child of Ready to Use objects would be "API Name of custom object added with WBIT".

GroupCode GroupCode Description ObjectName

ACTIVITY

Activity

ActivityImport

ACTIVITY

Activity

ActivityAssigneeImport

ACTIVITY

Activity

ActivityContactImport

APPOINTMENT

Appointment

NoteImport

APPOINTMENT

Appointment

ActivityAssociationImport

APPOINTMENT

Appointment

ActivityAssigneeImport

APPOINTMENT

Appointment

AppointmentImport

APPOINTMENT

Appointment

ActivityContactImport

ASSET

Asset

Assets

CLASSIFICATION_CODE

Classification Code

ClassificationCode

CN_TRANSACTION

Incentive Compensation Transactions

TransactionStaging

CONSUMER

Consumer

PrimaryPhoneContactPreference

CONSUMER

Consumer

MobileContactPreference

CONSUMER

Consumer

FaxContactPreference

CONSUMER

Consumer

EmailContactPreference

CONSUMER

Consumer

AdditionalName

CONSUMER

Consumer

Relationship

CONSUMER

Consumer

InstantMessenger

CONSUMER

Consumer

Classification

CONSUMER

Consumer

PersonProfile

CONSUMER

Consumer

SellToAddress

CONSUMER

Consumer

PrimaryPhone

CONSUMER

Consumer

Mobile

CONSUMER

Consumer

Fax

CONSUMER

Consumer

Email

CONSUMER

Consumer

PersonProfileExtn

CONSUMER

Consumer

SalesAccountProfile

CONSUMER

Consumer

AdditionalIdentifier

CONTACT

Contact

SalesProfile

CONTACT

Contact

FaxContactPreference

CONTACT

Contact

ContactJob

CONTACT

Contact

ContactAddressPurpose

CONTACT

Contact

ContactAddressContactPreference

CONTACT

Contact

ContactAddress

CONTACT

Contact

PersonProfile

CONTACT

Contact

Fax

CONTACT

Contact

PersonProfileExtn

CONTACT

Contact

Phone

CONTACT

Contact

PhoneContactPreference

CONTACT

Contact

Email

CONTACT

Contact

EmailContactPreference

CONTACT

Contact

InstantMessenger

CONTACT

Contact

Mobile

CONTACT

Contact

MobileContactPreference

CONTACT

Contact

Classification

CONTACT

Contact

Address

CONTACT

Contact

AddressPurpose

CONTACT

Contact

AddressContactPreference

CONTACT

Contact

AdditionalName

CONTACT

Contact

AdditionalIdentifier

CONTACT

Contact

ContactRelationship

CONTACT

Contact

ContactEmail

CONTACT

Contact

ContactEmailContactPreference

CONTACT

Contact

ContactFax

CONTACT

Contact

ContactFaxContactPreference

CONTACT

Contact

ContactInstantMessenger

CONTACT

Contact

ContactMobile

CONTACT

Contact

ContactMobileContactPreference

CONTACT

Contact

ContactPhone

CONTACT

Contact

ContactPhoneContactPreference

CONTRACT

Contract

ImportContractParty1

CONTRACT

Contract

ImportContractPartyContact1

CONTRACT

Contract

ImportContractLine1

CONTRACT

Contract

ImportContractHeader1

COUNTRY_STRUCTURE

Country Structure

ImpGeoStructureLevel

CUSTOMER

Customer

PersonProfileExtn

CUSTOMER

Customer

OrganizationProfileExtn

CUSTOMER

Customer

Address

CUSTOMER

Customer

PrimaryPhoneContactPreference

CUSTOMER

Customer

FaxContactPreference

CUSTOMER

Customer

ContactEmailContactPreference

CUSTOMER

Customer

ContactFaxContactPreference

CUSTOMER

Customer

ContactMobileContactPreference

CUSTOMER

Customer

ContactPrimaryAddressContactPreference

CUSTOMER

Customer

ContactPrimaryPhoneContactPreference

CUSTOMER

Customer

AddressContactPreference

CUSTOMER

Customer

AddressPurpose

CUSTOMER

Customer

Email

CUSTOMER

Customer

Classification

CUSTOMER

Customer

AdditionalName

CUSTOMER

Customer

ContactAdditionalName

CUSTOMER

Customer

OrganizationProfile

CUSTOMER

Customer

PrimaryPhone

CUSTOMER

Customer

Fax

CUSTOMER

Customer

Url

CUSTOMER

Customer

ContactPersonProfile

CUSTOMER

Customer

ContactEmail

CUSTOMER

Customer

ContactFax

CUSTOMER

Customer

ContactInstantMessenger

CUSTOMER

Customer

ContactJob

CUSTOMER

Customer

ContactMobile

CUSTOMER

Customer

ContactPrimaryAddress

CUSTOMER

Customer

ContactPrimaryPhone

CUSTOMER

Customer

SalesProfile

CUSTOMER

Customer

SellToAddress

CUSTOMER

Customer

AdditionalIdentifier

CUSTOMER

Customer

Relationship

CUSTOMER_HIERARCHY

Customer Hierarchy

CustomerHierarchy

CUSTOMER_HIERARCHY_MEMBER

Customer Hierarchy Member

CustomerHierarchyMember

EMPLOYEE_RESOURCE

Employee Resource

WorkerProfile

EMPLOYEE_RESOURCE

Employee Resource

ResourceProfile

EMPLOYEE_RESOURCE

Employee Resource

ResourceTeamMembership

EMPLOYEE_RESOURCE

Employee Resource

PrimaryAddress

EMPLOYEE_RESOURCE

Employee Resource

ResourceOrganizationMembership

GEOGRAPHY

Geography

ImpGeography

GROUP_CUSTOMER

Group Customer

Fax

GROUP_CUSTOMER

Group Customer

FaxContactPreference

GROUP_CUSTOMER

Group Customer

Mobile

GROUP_CUSTOMER

Group Customer

MobileContactPreference

GROUP_CUSTOMER

Group Customer

Phone

GROUP_CUSTOMER

Group Customer

PhoneContactPreference

GROUP_CUSTOMER

Group Customer

Url

GROUP_CUSTOMER

Group Customer

Email

GROUP_CUSTOMER

Group Customer

EmailContactPreference

GROUP_CUSTOMER

Group Customer

InstantMessenger

GROUP_CUSTOMER

Group Customer

Relationship

GROUP_CUSTOMER

Group Customer

Member

GROUP_CUSTOMER

Group Customer

Address

GROUP_CUSTOMER

Group Customer

AddressPurpose

GROUP_CUSTOMER

Group Customer

AddressContactPreference

GROUP_CUSTOMER

Group Customer

Classification

GROUP_CUSTOMER

Group Customer

AdditionalName

GROUP_CUSTOMER

Group Customer

AdditionalIdentifier

GROUP_CUSTOMER

Group Customer

GroupProfileExtn

GROUP_CUSTOMER

Group Customer

SalesProfile

GROUP_CUSTOMER

Group Customer

GroupProfile

INTERACTION

Interaction

InteractionParticipantImport

INTERACTION

Interaction

InteractionImport

INTERACTION

Interaction

InteractionAssociationImport

INTERACTION

Interaction

InteractionAssociationImport

LEAD

Lead

Lead

LEAD

Lead

ContactPersonProfileExtn

LEAD

Lead

Response

LEAD

Lead

ResponseProduct

LEAD

Lead

ResponseSurvey

LEAD

Lead

OrganizationProfile

LEAD

Lead

OrganizationAddress

LEAD

Lead

ContactPersonProfile

LEAD

Lead

ContactPrimaryAddress

LEAD

Lead

ContactEmail

LEAD

Lead

ContactFax

LEAD

Lead

ContactInstantMessenger

LEAD

Lead

ContactJob

LEAD

Lead

ContactMobile

LEAD

Lead

ContactPrimaryPhone

LEAD

Lead

OrganizationProfileFax

LEAD

Lead

OrganizationProfilePrimaryPhone

LEAD

Lead

Url

LEAD

Lead

PersonProfile

LEAD

Lead

PersonAddress

LEAD

Lead

Email

LEAD

Lead

PersonProfileFax

LEAD

Lead

InstantMessenger

LEAD

Lead

Mobile

LEAD

Lead

PersonProfilePrimaryPhone

LEAD

Lead

LeadProduct

LEAD

Lead

GroupProfileExtn

LEAD

Lead

PersonProfileExtn

LEAD

Lead

OrganizationProfileExtn

LEAD

Lead

ContactPersonProfileExtn

LEAD

Lead

GroupProfileExtn

LEAD

Lead

PersonProfileExtn

LEAD

Lead

OrganizationProfileExtn

LEAD

Lead

LeadContact

LEAD

Lead

GroupContact

LEAD

Lead

GroupProfile

LEAD

Lead

LeadResource

LEGAL_ENTITY

Legal Entity

ContactJob

LEGAL_ENTITY

Legal Entity

ContactAdditionalName

LEGAL_ENTITY

Legal Entity

ContactPrimaryAddress

LEGAL_ENTITY

Legal Entity

ContactPrimaryPhone

LEGAL_ENTITY

Legal Entity

ContactPrimaryAddressContactPreference

LEGAL_ENTITY

Legal Entity

ContactPrimaryPhoneContactPreference

LEGAL_ENTITY

Legal Entity

PersonProfileExtn

LEGAL_ENTITY

Legal Entity

OrganizationProfileExtn

LEGAL_ENTITY

Legal Entity

ContactMobileContactPreference

LEGAL_ENTITY

Legal Entity

PrimaryAddressContactPreference

LEGAL_ENTITY

Legal Entity

PrimaryPhoneContactPreference

LEGAL_ENTITY

Legal Entity

FaxContactPreference

LEGAL_ENTITY

Legal Entity

ContactEmailContactPreference

LEGAL_ENTITY

Legal Entity

ContactFaxContactPreference

LEGAL_ENTITY

Legal Entity

ContactInstantMessenger

LEGAL_ENTITY

Legal Entity

ContactFax

LEGAL_ENTITY

Legal Entity

ContactEmail

LEGAL_ENTITY

Legal Entity

ContactPersonProfile

LEGAL_ENTITY

Legal Entity

Url

LEGAL_ENTITY

Legal Entity

Fax

LEGAL_ENTITY

Legal Entity

PrimaryPhone

LEGAL_ENTITY

Legal Entity

PrimaryAddress

LEGAL_ENTITY

Legal Entity

OrganizationProfile

LEGAL_ENTITY

Legal Entity

AdditionalName

LEGAL_ENTITY

Legal Entity

Classification

LEGAL_ENTITY

Legal Entity

ContactMobile

MCT_AGENT_CONN_PARAMS

Click To Dial Agents Connector Parameters

ImpConnector

MCT_AGENT_CONN_PARAMS

Click To Dial Agents Connector Parameters

ImpDevice

MCT_AGENT_CONN_PARAMS

Click To Dial Agents Connector Parameters

ImpConnParamValue

MCT_AGENT_CONN_PARAMS

Click To Dial Agents Connector Parameters

ImpCommUser

MCT_CTD_AGENT

Click To Dial Agents

ImpConnUserParamValue

MCT_CTD_AGENT

Click To Dial Agents

ImpConnector

MCT_CTD_AGENT

Click To Dial Agents

ImpCommUserDevice

MCT_CTD_AGENT

Click To Dial Agents

ImpCommUser

MKT_ACT_ADVERTISING

Advertising Marketing Activity

AdvertisingStage

MKT_ACT_ADVERTISING

Advertising Marketing Activity

AdvertisingActivity

MKT_ACT_EVENT

Event Marketing Activity

EventStage

MKT_ACT_EVENT

Event Marketing Activity

EventActivity

MKT_ACT_INTERACTION

Outbound Marketing Activity

AllocationActivity

MKT_ACT_INTERACTION

Outbound Marketing Activity

InteractionStage

MKT_BUDGET

Marketing Budget

ImportBudgets1

MKT_CAMPAIGNS

Campaign

CampaignTeam

MKT_CAMPAIGNS

Campaign

Campaigns

MKT_CAMP_MEMBERS

Campaign Members

StageMembers

MKT_LIST

Marketing List

MarketingList

NOTE

Note

NoteImport

OPPORTUNITY

Opportunity

Opportunity

OPPORTUNITY

Opportunity

OpportunityCompetitor

OPPORTUNITY

Opportunity

OpportunityContact

OPPORTUNITY

Opportunity

OpportunityLead

OPPORTUNITY

Opportunity

OpportunityReference

OPPORTUNITY

Opportunity

OpportunityResponse

OPPORTUNITY

Opportunity

OpportunitySource

OPPORTUNITY

Opportunity

OpportunityRevenue

OPPORTUNITY

Opportunity

OpportunityRevenuePartner

PARTNER

Partner

FaxContactPreference

PARTNER

Partner

ImpPartnerP

PARTNER

Partner

PrimaryPhoneContactPreference

PARTNER

Partner

OrganizationProfileExtn

PARTNER

Partner

Url

PARTNER

Partner

ImpPartnerDimSChnlP

PARTNER

Partner

ImpPartnerDimProdP

PARTNER

Partner

ImpPartnerDimIndstP

PARTNER

Partner

Classification

PARTNER

Partner

ImpPartnerDimGeoP

PARTNER

Partner

ImpPartnerCertP

PARTNER

Partner

ImpPartnerExpertP

PARTNER

Partner

ImpPartnerAcctResP

PARTNER

Partner

PartnerHierarchy

PARTNER

Partner

PartnerInterface

PARTNER

Partner

Fax

PARTNER

Partner

PrimaryAddress

PARTNER

Partner

PrimaryPhone

PARTNER

Partner

PrimaryAddressContactPreference

PARTNER_CONTACT

Partner Contact

PrimaryAddress

PARTNER_CONTACT

Partner Contact

ResourceTeamMembership

PARTNER_CONTACT

Partner Contact

ResourceOrganizationMembership

PARTNER_CONTACT

Partner Contact

Job

PARTNER_CONTACT

Partner Contact

Partner

PARTNER_CONTACT

Partner Contact

PrimaryPhone

PARTNER_CONTACT

Partner Contact

Mobile

PARTNER_CONTACT

Partner Contact

InstantMessenger

PARTNER_CONTACT

Partner Contact

Fax

PARTNER_CONTACT

Partner Contact

Email

PARTNER_CONTACT

Partner Contact

PersonProfile

PARTNER_CONTACT

Partner Contact

ResourceProfile

PARTNER_CONTACT

Partner Contact

PersonProfileExtn

PARTNER_CONTACT

Partner Contact

PrimaryAddressContactPreference

PARTNER_CONTACT

Partner Contact

PrimaryPhoneContactPreference

PARTNER_CONTACT

Partner Contact

MobileContactPreference

PARTNER_CONTACT

Partner Contact

FaxContactPreference

PARTNER_CONTACT

Partner Contact

EmailContactPreference

PRODUCT_GROUP

Product Group

ProductGroupBulkImport

PRODUCT_GROUP

Product Group

ProductGroupItemBulkImport

PRODUCT_GROUP

Product Group

ProductGroupRelationBulkImport

PROGRAMENROLLMENTS

Program Enrollments

ImpProgramEnrollmentsPVO2

PROMOTION

Promotion

PromotionBulkImport

PROMOTION

Promotion

PromotionCouponBulkImport

QUOTA

Territory Quota Management

TerritoryQuotaImport

QUOTA

Territory Quota Management

ResourcePeriodQuotaImport

QUOTA

Territory Quota Management

ResourceQuotaImport

QUOTA

Territory Quota Management

TerrPeriodQuotaImport

RESOURCE_TEAM

Resource Team

ResourceTeamUsage

RESOURCE_TEAM

Resource Team

ResourceTeam

RESPONSE

Response

ResponseSurvey

RESPONSE

Response

OrganizationProfile

RESPONSE

Response

OrganizationAddress

RESPONSE

Response

ContactPersonProfile

RESPONSE

Response

ContactPrimaryAddress

RESPONSE

Response

ContactEmail

RESPONSE

Response

ContactFax

RESPONSE

Response

ContactInstantMessenger

RESPONSE

Response

PersonProfilePrimaryPhone

RESPONSE

Response

ContactMobile

RESPONSE

Response

ContactPrimaryPhone

RESPONSE

Response

OrganizationProfileFax

RESPONSE

Response

OrganizationProfilePrimaryPhone

RESPONSE

Response

Url

RESPONSE

Response

PersonProfile

RESPONSE

Response

PersonAddress

RESPONSE

Response

Email

RESPONSE

Response

PersonProfileFax

RESPONSE

Response

InstantMessenger

RESPONSE

Response

Mobile

RESPONSE

Response

ResponseProduct

RESPONSE

Response

Response

RESPONSE

Response

ContactJob

SALES_ACCOUNT_RESOURCE_TEAM

Sales Account Resource

SalesAccountResourceInterface

SOURCE_SYSTEM_REFERENCE

Source System Reference

SourceSystemReference

TASK

Task

TaskImport

TASK

Task

TaskAssigneeImport

TASK

Task

TaskContactImport

TASK

Task

NoteImport

TERRITORY

Sales Territories

TerritoryLOBImport

TERRITORY

Sales Territories

TerritoryResourceImport

TERRITORY

Sales Territories

TerritoryImport

TERRITORY

Sales Territories

TerritoryCoverageImport

TERRITORY_GEOGRAPHIES

Territory Geographies

ImpGeoTerritory

HZ_TOP_EXTN

Custom Object

API Name of custom object appended with WBIT

FAQs

What happens if a column header can't be resolved?

If a column header can't be resolved (it doesn't match any known column header value), then the import activity isn't processed. A valid error message is returned in the SOAP response to convey the submit import activity error.

What happens if you try to import a non-ZIP file type?

If a non-ZIP file type is provided in the simplified service, then an error message is returned to the client application, indicating that the source file must be of File Type ZIP. Submit a ZIP file.