15Export Management

This chapter contains the following:

You can use Export Management to move data out of Oracle Applications Cloud in the form of CSV files. To export data, you start by creating an export activity. As part of the export activity, you select a parent object and its relevant child objects. You also must define filters on these objects to specify the records you want to export.

Scenarios for Export

You may want to export data in the following scenarios:

  • You might want to move data out of Oracle Applications Cloud into another application. To perform this activity you have to export the data into a ZIP file and import the exported data into the target application.

  • You might want to format the data as per your requirements.

  • You may want to identify the unique identifiers of an object such as Party ID or Party Number. You can use this information to update an object record.

You can schedule an export either immediately or at a future date. If you schedule it for a future date, then provide the start date and time while defining the export activity.

Note: Currently recurring export is not supported. You can however use the Export REST resource to schedule recurring export activities through REST API. For more information see REST API for CX Sales and B2B Service.

Using Export Filters

You can define the conditions for the records to export in the export filter. The exported data sets contain only those records that match the specified filter criteria on the parent/child object. It is recommended that you use multiple filters to reduce the number of records to export.

You can create a filter by navigating to Tools > Export Management > Export Objects and clicking on the Display Name link for the export object. On the Manage Filters page, click the Create Filter button to create a filter. On the Script Edit page, enter the filter name, filter parameters, and the order by clause if required. You can reuse an existing filter by selecting a value from the Existing Filters drop-down list. Once you're done with your changes, click Validate Script and then click Save and Close to save your new filter. You can also create a filter while creating an export activity, on the Map Fields page.

You can delete a filter on the Manage Filters page, by clicking the delete icon for your filter under the Delete Filter column. Note that you can delete only the filters created by you and those that aren't used in an active export job.

This topic shows you how to export data using the Export Management option from the Tools work area.

To export data:

  1. Click Tools > Export Management.

  2. On the Manage Exports page, click the Create Export Activity button.

  3. On the Enter Export Options page, enter values for each of the following fields:

    Field Description of the value

    Name

    The name of the export activity.

    Object

    The object to export. You must select the parent or child object from the drop-down list.

    If you can't find an object in the drop-down list, then click the Search link. In the Search and Select dialog box, enter the object name in the Object text box and click the Search button. Select your object from the result list and click OK.

    You can also use the advanced search option by clicking the Advanced button. Here you can search based on various filter criteria such as object name, attachment supported, creation date, and so on.

    Note: If the object you're exporting isn't listed then verify if you have the roles and privileges required to export the object. For information on the roles, see the topic Roles Required for Import and Export Management referenced in the Related Topics section.

    Description

    The optional description of the export activity.

    File Name

    The name of the export file to generate in ZIP format. This field is populated based on the object and date time stamp.

    Export Attachments

    Select to export the attachments related to the object. This option is enabled only if the selected object supports attachments.

  4. Optionally to set additional export configurations, click the Advanced Options section. Here you can configure settings in the Output File, Export Options, or Create Schedule sections.

    • Following are the options in the Output File and Export Options regions:

      Option Description Default Value

      Delimiter

      If your file doesn't use a comma to separate values, then select the correct delimiter in the Delimiter drop-down list. Possible values are:

      • Caret Symbol

      • Closing Curly Bracket

      • Closing Parenthesis

      • Closing Square Bracket

      • Colon

      • Comma

      • Exclamatory Mark

      • Minus

      • Opening Curly Bracket

      • Opening Parenthesis

      • Opening Square Bracket

      • Pipe Symbol

      • Plus

      • Question Mark

      • Semi-Colon

      • Star Symbol

      • Tilde Symbol

      Comma

      Escape Special Characters

      If selected, then RFC4180 format is used, and quotes are escaped with another set of quotes.

      Deselected

      Decimal Separator

      The decimal separator used in your export file. Possible values are Comma and Period.

      Period

      Date Format

      The format of the date fields in your file. Possible values are:

      • EU-YYYY/MM/DD

      • ISO 8601 - YYYY-MM-DD

      • UK/Canada - DD/MM/YYYY

      • US - MM/DD/YYYY

      US - MM/DD/YYYY

      Time Stamp Format

      The format of time fields in your file. Possible values are:

      • Canada - DD/MM/YYYY hh:mm:ss PM

      • EU - YYYY/MM/DD 24:mm:ss

      • ISO 8601 - YYYY-MM-DDThh:mm:ss sss+/-hh:mm

      • UK - DD/MM/YYYY 24:mm:ss

      • US - MM/DD/YYYY hh:mm:ss PM

      US - MM/DD/YYYY hh:mm:ss PM

      File Encoding

      The format in which the characters within your source file are encoded. Possible values are:

      • Chinese Simplified - GB, CP936

      • Chinese Traditional - CP950

      • Eastern European - Win, CP1250

      • Greek - MS Windows, CP1253

      • Japanese - Shift-JIS, CP932

      • Unicode - UTF - 8

      • Unicode - UTF - 16

      • Unicode - UTF - 16BE, Mac, Unix

      • Unicode - UTF - 16LE, MS Windows

      • Western European - Win, CP1252

      Unicode - UTF - 8

      End of Line

      The character used to indicate end of line in the export file. Possible values are:

      • Carriage Return

      • Carriage Return and Line Feed

      • Line Feed

      Line Feed

      Quote Character

      The character used to indicate a quote. This field is read-only.

      N/A

      Language Independent Header

      Select to export column headers. If you're modifying the exported data manually, then exporting column headers help in automatic mapping during the reimport process.

      N/A

      Notification Email

      The email to send export-processing notifications. The user submitting the export receives an email notification automatically. You use this field to specify any additional recipients. If you want to have more than one email recipient, separate the email addresses with a comma or semicolon. You can also specify a mailing list address so that a large number of recipients can be notified.

      N/A

      Enable Split

      Select to split the export data set based on a specified record count. On selecting this check box, you can see the Split Size drop-down list, with a default value of 100k. You can specify the split size in multiples of 100k records, ranging from 100k to 1000k.

      The exported data is split into multiple CSV files, and each file has a maximum of 50K records. You can further split the exported data into multiple ZIP files, based on the specified split size. For example, if your export job retrieves 300k records and split is enabled with a split size of 200k, then 2 export ZIP files are generated. The first ZIP file contains 200k records which is divided into 4 CSV files each with 50k records. The second ZIP file contains 100k records which is then divided into 2 CSV files each with 50k records.

      N/A

    • In the Create Schedule region, you can schedule the export to run either immediately or at a future date. If you select a future date, then provide the date and time to start the export.

  5. Click Next. On the Map Fields page you can see the exportable object, its child objects, and the associated attributes. The Export Mapping drop-down list shows the maps that were used in earlier export jobs. You can select an existing mapping from the drop-down list and click Apply.

  6. You can select the child objects to export by selecting the Enabled check box. Selecting the Enabled check box for a child object displays the associated attributes in the Available Fields section. You can select the attributes to export by double-clicking the attribute in the Available Fields list. Alternatively, you can move the attribute from Available Fields list to the Selected Fields list. If you select any formula fields for export, it might impact your export performance.

  7. You must provide a filter criterion for at least the top-level object. To filter the records to export using conditions, click the Filter Name icon. On the Filter Name dialog box, you can create the filter for the export attributes using the operators AND, OR, >, <, =, and !=. On the Fields tab select the attribute and click the Insert button. In the Script Edit window, provide the filter conditions for the selected attribute. After creating the filter criteria script, click Validate Script. Click Save and Close to save the filter.

  8. Click Next. On the Review and Submit page, review the export activity configuration. If you want to change any configuration, then click the Back button. Submit to activate the export activity. After the export activity completes, clicking the My Completed Exports infotile shows your export status. Click the ZIP file link in the Exported Data File column to download the exported file.

Note: CSV String Escape:

By default, the escape character is a " (double quote) for CSV-formatted files. If a value contains a comma, a newline character, or a double quote then the string must be enclosed in double quotes. For example: "Newline char in this field \n".

A double quote must be escaped with another double quote. For example: "The double quote character "" is offensive.".

Note: By default, you can't view the Personally Identifiable Information(PII) such as mobile numbers in the exported data. To view this information, follow these steps:
  1. Navigate to Tools > Security Console.

  2. Search for the role ORA_MOT_QUOTA_EXPORT_MANAGEMENT_DUTY.

  3. Edit role and click the Data Security Policies link.

  4. Click the Create Data Security Policy button, and add a new data security policy on the database resource Trading Community Contact Point with the following details.

    • Policy Name: Custom Grant on Person Contact and Mobile Phone Data (you can provide any name)

    • Database Resource: HZ_CONTACT_POINTS

    • Data Set: All Values

    • Actions: View Trading Community Person Contact, View Trading Community Mobile Phone Number

  5. Click OK to save and navigate to Summary step to review and save changes.

This topic describes the different infotiles displayed on the Manage Exports page of the Export Queue tab.

Export Queue

The following infotiles are displayed on the Manage Exports page:

  • All Exports: This infotile displays the count of active, completed, and unsuccessful exports submitted by all users. Click to see the exports created by all the users and in all possible statuses.

  • Active Exports: This infotile displays the count of exports submitted by all users that are either in progress or in queued status. Click to see the active exports created by all the users.

  • My Completed Exports: This infotile displays the count of exports submitted by the current user that are either successful or failed with warnings or errors. Click to see the completed exports created by the current user.

  • Unsuccessful Exports: This infotile displays the count of unsuccessful exports submitted by all users. Click to see the unsuccessful exports created by all users.

Note: The export activity records appear in the queue for thirty days, after which they're removed. The exported ZIP files and diagnostic files are removed from the server on the 7th day of the export.

Export Details

You can view more details about the exports on clicking the infotiles. The following details about the export are displayed:

Column Description

Name

The name of the export job. Click to go to the Export Status page.

Object

The object exported.

Status

The status of the export job. For more information about the statuses, see the topic How You Monitor Export Activity in the related topics section.

Start Time

The start date and time of the export.

End Time

The end date and time of the export.

Submitted By

The user who submitted the export.

Exported data file

The link to download the exported data file in ZIP format.

You can filter the export using any of the columns in the preceding table. You must select the filter value from the Search drop-down list and enter the criteria in the adjacent text box.

This topic explains how to monitor export activities and view their statuses.

View the Export Status

On the Manage Exports page, click the export activity name link to see additional information about the export activity. The Export Status page contains the following sections:

  • Status Bar

  • Details

  • Export Attachments

The Export Status Bar

The status bar shows the progress of the export activity in a graphical format. It shows the following stages during the export process:

  1. Queued for Export: The export request is queued for processing, and is waiting to begin execution.

  2. Preparing data for Export: The data are loaded in the temporary staging table for further processing.

  3. Exporting data: The data from the target objects are loaded into the export files (CSV).

  4. Completing export activity: The export data have been loaded in the source files, and cleanup tasks, such as the generation of log files, are in progress.

  5. Completed with errors: The export activity has completed with errors.

  6. Completed with warnings: The export activity has completed with warnings.

  7. Unsuccessful: The export activity was unsuccessful.

Activity and Record Details

The Activity Details section shows the name of the export activity, export job identifier, object exported, and the name of user who submitted the export. The section on date and time displays the start and end times, and the time taken to complete the export activity.

The Record Details section displays the number of records estimated, number of records exported, and the number of records with errors.

Export Attachments

You can generate the diagnostics and log files from the Action menu. The Export Attachments section displays the list of files associated with this export activity in tabular format. The Actions column in this section lets you either download the file or view more details. These files include the diagnostics and log files generated.