2Overview of File-Based Data Import

This chapter contains the following:

About File-Based Import Documentation

This topic provides an overview of the types of help available for importing legacy and other data into Sales and B2B Service using File-Based Data Import.

The main sources of information for import are:

  • CX Sales and B2B Service documentation on the Cloud Help Center (https://docs.oracle.com/en/cloud/saas/index.html).

    • Explore the latest critical reference content supporting Sales and B2B Service.

    • Download PDF versions of guides, find links to reference materials and white papers, and search for specific topics.

    • Browse import data topics on the Administer tab that provide key file-based data import information.

  • Click the Help icon in Sales and B2B Service, and browse general topics on import or search on individual import objects for examples, attributes, and other information.

  • 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)

    • Find reference files with detailed information about individual attributes.

To understand what attributes are available for import for each object, follow these steps:

  1. Start by searching help using the keyword importing and the name of the object you're importing.

    For example, to get help on importing contacts, enter importing contacts.

    Depending on the complexity of the import, your search returns one or more of the following help topic types:

    Help Topic Title Description

    Importing <import object name>

    This type of topic informs the user how each business object is structured and explains its relationship to the import object.

    <import object name> Import Objects: How They Work Together

    This type of topic lists the target import objects associated with each import object and provides the names of reference files that describe the attributes for those target objects. Target objects are the objects from which you select attributes when you create an import activity mapping.

    How You Import <import object name>

    This type of topic provides a list of attributes that are required or conditionally required to be included in the import file when importing records for the object.

    Importing <import object name>: Conceptual Example

    This type of topic provides an example of how to import the object without detailed steps.

    Importing <import object name>: Worked Example

    This type of topic walks you through an example step-by-step.

  2. See the reference files that are listed in the <import object name> Import Objects: How They Work Together topics that are linked in the File-Based Data Import for CX Sales and B2B Service guide, which is available on the Help Center (https://docs.oracle.com/en/cloud/saas/index.html). The reference files include detailed descriptions of attributes and permitted values.

Data Import Options

You can import your data from an external application into Oracle Applications Cloud in several different ways, including using public web services. Which import method you use depends on the type of data you're importing, the volume of data, and technical requirements. If you're integrating one cloud service with other cloud services, then you must use additional import methods as described in the appropriate guides.

When you're importing data for a particular object, you must make sure that any prerequisite objects already exist in the application. For example, if you're importing contacts for an account, then the account must already exist in the application. If one import job depends on the contents of another import job, then complete the prerequisite job before starting the dependent job. For example, if you're importing both accounts and opportunities, then import accounts before importing opportunities.

The following table lists the import methods and references to further information.

Import Method Description When to Use How to Access For More Information

Quick Import Excel Macros

You can use the import macros to speed up and simplify the import of up to 5000 records at a time for some objects. They validate your data entries, provide list of values, and automatically populate constant values.

The macros create data files that are automatically imported using Import Management.

You can import the following objects using import macros:

  • Sales Users

  • Products and product groups

  • Accounts

  • Contacts

  • Account Hierarchy

  • Leads

  • Opportunities

These are best to import data in your initial deployment.

The macros are targeted to the simple proof of concept sales automation use case covered in the Importing Sales Users chapter of the Getting Started with Your Sales Implementation guide. For example, the import macros assume that you're importing account, contact, and lead records for one country at a time.

The macros generate log files with information about the File Import job, and these log files can also serve as a learning tool for more complex import.

You can download the Excel macros and any required mapping files from the Getting Started with Your Implementation: Quick Import Macros (Document ID 2229503.1) article on My Oracle Support.

The chapters in the Getting Started with Your Sales Implementation guide provide detailed instructions and video tutorials for using the macros.

For instructions on how to add your own fields to the macros, see. How to Configure Quick Import Macro for importing Employee Resources (Doc ID 2364229.1) article on My Oracle Support.

Import Management

Import Management improves definition, error handling, and performance for importing flat files (.CSV). For example, Import Management has drag and drop mapping capabilities and validates the first ten records in your data file before you import to ensure the data meets the import constraints of the various attributes.

Import Management is available for importing data for the following application objects:

  • Account

  • Action

  • Action Plan

  • Activity

  • Address

  • Asset

  • Attachment

  • Business Plan

  • Campaign

  • Classification

  • Consumer

  • Contact

  • Deal Registration

  • Hierarchy

  • Hierarchy Member

  • Household

  • Inbound Message

  • Interaction

  • MDF Budget

  • MDF Claim

  • MDF Request

  • Message

  • Note

  • Opportunity

  • Partner

  • Partner Program

  • Product

  • Product Group

  • Program Enrollment

  • Promotion

  • Relationship

  • Resource

  • Resource Capacity

  • Sales Lead

  • Sales Objective

  • Sales Order

  • Sales Territory

  • Self-Service Role

  • Service Request

  • Standard Text

  • Standard Text Folder

  • Standard Text User Variable

  • Subscription

  • Template

  • Any additional objects you create

Use Import Management for importing outside the scope of the Getting Started with Your Implementation guide.

Oracle plans to discontinue File-Based Data Import support with the 20D Update.

Click Import Management in the Navigator.

See the Understanding Import and Export Management guide for instructions on using the import.

File-Based Data Import

File-Based Data Import supports the import of data files with up to 100,000 records each for the broadest range of objects, including custom objects.

Use File-Based Data Import only for any objects not yet covered by Import Management.

Oracle plans to discontinue File-Based Data Import support with the 20D Update.

You can access File-Based Data Import tasks by navigating to the following in the Setup and Maintenance work area:

  • Offering: Sales

  • Functional Area: Data Import and Export

You can learn how to import in the Understanding File-Based Data Import and Export guide.

The File-Based Data Import for CX Sales and B2B Service guide provides information about the import attributes, including valid values and validations.

External Data Loader Client

Command-line tool that's used to import high-volume flat source data files into CX Sales and B2B Service. This tool splits a large data file into multiple smaller files to adhere to import volume limits, and enables the tracking of import status.

The client supports the same objects as Import Management.

Use this import method for importing very large data files for the objects supported by Import Management.

You can download the client from Oracle Support Document 2325249.1 (External Data Loader Client) on My Oracle Support.

Instructions for using the client are available in the document and in the client itself.

For REST API documentation, see the REST API for CX Sales and B2B Service guide.

Web Services

Web services are available for external client applications to start and monitor import jobs. You can manage Import Management jobs using REST web services, and File Import jobs using SOAP web services.

Use web services to manage import jobs to import directly from an external application.

Public APIs are available for both the Import Management/REST services and the File Import/SOAP services.

The following REST APIs are available for import:

  • Import Activities

  • Import Activity Maps

  • Import Export Objects Metadata

The SOAP service is called the File Import Activity Service.

For REST API documentation, see the REST API for CX Sales and B2B Service guide.

For SOAP API documentation, see the SOAP Web Services for CX Sales and B2B Service guide.

High-Volume Import

The high-volume import mode is designed to import millions of records at once. This mode doesn't trigger any custom logic configured through the application composer. For a list of supported objects, see the topic Import Data in the related topics section.

Use this import mode for importing very large number of records for the objects supported.

You can access High-Volume Import either using REST services or using External Data Loader Client.

When importing using REST, set the "High-volume" attribute to enable this mode of import.

When importing using the External Data Loader Client, set the command-line parameter "-high-volume" to enable this mode of import.

For REST API documentation, see the REST API for CX Sales and B2B Service guide.

The chapter Importing Data Using External Data Loader Client in the guide File-Based Data Import for CX Sales and B2B Service provides information about using the External Data Loader Client.

The following figure provides an architectural overview of the different import methods:

  • File Import uses the SOA architecture to import data into Oracle CX Sales.

  • Quick Import uses the REST Web services to import data into Oracle CX Sales. When you import data using the quick import Excel macros, you're creating an import activity in Import Management using the REST web services. The macro import creates the same import activity and uses the same mapping as you do when you initiate the import from the application. You can monitor each import in the macro or in the application itself.

  • Both Import Management and the External Data Loader Client use the same scheduled processes for import. When you import very large files using the client, the REST APIs create multiple processes to respect the Import Management file size limit.

  • To import from an external application, use the SOAP and REST web services directly.

Architecture of the different import methods and their

How File-Based Data Import Works

The Define File Import group of tasks relies on integration with different architecture components, such as interface tables and application base tables. This topic provides an overview of these components to help you understand the import process and the different import activity statuses.

The following figure provides an overview of the major application components used when you import data from a file. These components include:

  • Import object

  • Import mapping

  • Import activity

  • File repository

  • Application Composer

  • Interface tables

  • Base tables

You select the import object during setup. The import mapping is used in the import mapping step. The import file you upload is stored in a file repository. The additional attributes that you create in the Application Composer are stored in a separate extensions repository and are available for import and in the import mapping.

File-based data import overview showing how the
different components relate.
Note: If you change the NLS_LANG and the DATE_FORMAT environment variables, you must restart the Oracle Fusion applications.

Import Objects, Import Mapping, and Import Activity

When you create an import activity, the import objects you select are provided by Oracle. You manage these import objects using the Manage File Import Objects task.

Note: Avoid concurrent submission of File Import jobs for the same import object. Concurrent submission of multiple import jobs with same content results in creation of duplicate object records.

When you create an import activity, you must specify a mapping of the fields in your file to the attributes of the import object. You can create the mapping while creating an import activity or separately using the Manage File Import Mappings task. The mapping is stored and managed as a separate object.

File Repository

The text or XML data file that you upload during import is stored in a file repository. If you upload any attachments, they're also stored in the same repository.

Application Composer Extensions

When you create additional attributes for data import using the Application Composer, the extensions are stored in a separate repository and are available for import and export.

Interface Tables

The import activity populates the application interface tables with your data.

Base Tables

The import activity loads your data into the base tables to complete the import.

You import data from text or XML files using the tasks in the Define File Import task group, available from the Setup and Maintenance work area. This topic provides information about each task during the data import.

This image provides an overview of the File-Based Data Import group of tasks and their relationships. Each task is explained in the sections that follow.

Tasks in the File-Based Data Import task group.

Manage File Import Activities

Use this task to import your data by creating import activities and monitoring their progress. To create an import activity, follow these steps:

  1. Set up the import options.

    You select the object you're importing, specify the file format and different import options, and upload the file with your data. The options available depend on the object you're importing. For example, some import objects permit you to upload a ZIP or Java archive (JAR) file of attachments that will be attached to the records in the application after the data file import is complete.

    There are three levels of complexity for data loads:

    • No dependency loads - As there are no data dependencies between the objects being imported, you can import multiple objects at a time. For example, loading geography, industry classification, units of measure information, and so on.

    • Simple dependency loads- You use the primary key to refer to the parent object. You load the parent objects before loading the child objects. For example, loading notes, activities, attachments and so on requires that you need to import the parent objects before importing the notes, activities, attachments and so on.

    • Complex dependency loads- You must import multiple related objects before you can import the required object. For example, loading opportunity requires that you need to import multiple objects before loading the opportunities. You must import products related to every revenue line, accounts, and contacts before importing opportunities.

  2. Map the fields.

    You create a mapping of the data in your file and the attributes in the application. You can also reuse a mapping that you have created in past import activities or use the Manage File Import Mappings task. Any mapping you create in an activity is automatically saved and can be reused in subsequent imports and managed using the Manage File Import Mappings task.

  3. Schedule the import.

    You can schedule to run the import at a time you specify or run it immediately.

  4. Review and activate the import activity.

    You activate the import activity by clicking Activate. Groovy scripts and workflows are triggered only during import activities on the Deal Registration object.

Manage File Import Mappings

This task permits you to do the following:

  • Manage existing mappings between the data in your import file and the application attributes. For example, you can lock a mapping so that it can't be modified or edit the mapping to skip attributes during import.

  • Create mappings without a data file.

    Creating a mapping using the Manage File Import Mappings task is equivalent to creating it in the import activity, but you must enter any import file column names manually. When you create a mapping as part of the import activity, you upload the file, and the column headings in your file are populated automatically.

Manage File Import Objects

This task lets you view all the import objects that have been created. As all the objects you can import are already created, you don't need to create more import objects. You need to be a programmer to create objects.