7Setup Data Export and Import

This chapter contains the following:

Any implementation of Oracle Applications Cloud usually requires migrating setup data from one environment to another at various points in the subscription lifecycle. For example, a subscribed offering is typically set up in the test environment first, and is moved to the production environment only after proper testing and verification. Setup export and import processes help you migrate setup data from test to production.

Two distinct methods are available for migrating setup data:

  • Export and import an entire offering or any of its functional areas. In this method, setup data of the business objects associated with the offering or the selected functional area is migrated.

  • Export and import an implementation project. In this method, setup data of the business objects associated with the implementation project is migrated.

Note: You can't combine the export and import processes of these different methods. When an offering or functional area is exported, that setup data can only be imported using the same offering or functional area. Similarly, when an implementation project is exported, that setup data can only be imported using implementation project-based import.

Key Information About Setup Data Export and Import Processes

Use the information in this topic to effectively manage the setup data export and import processes.

Here are the key components of the setup data export and import process.

  • Setup Business Objects

  • Configuration Packages

  • Scope to Filter Exported Setup Data

  • Importing Feature Opt-In

  • Setup Data Update Rules During Import

  • Import Sequence of Setup Data

  • Export and Import Process Results

Setup Business Objects

Setup business objects are the logical representations of setup data. The export and import processes use these business objects and their associated web services to read and write the appropriate set of setup data from source to the target environments respectively.

Configuration Packages

A configuration package is the medium used to move setup data from one environment to another. When you export setup, a configuration package is created which includes the following:

  • A list of setup tasks based on the offering, functional area or implementation project you used for the export process.

  • The business objects associated with those tasks.

  • Exported setup data of those business objects

After an export process runs successfully, you can download the configuration package as a .zip file. You can then move this configuration package to the environment where you plan to import the same setup, upload the file, and run the import.

This graphic describes the process of moving setup
data from one environment to another using configuration packages,
which is explained in the topic.

Scope to Filter Exported Setup Data

When a business object is exported, all its setup data is exported by default. You may optionally select one or more Scope values to filter setup data of the business objects and limit the exported data. The resulting configuration package from that export process contains only the setup data that matches the Scope criteria you specified.

Importing Feature Opt-In

When you export an offering or a functional area, the configuration package includes the opt-in configuration of all their dependent functional areas and features as they were set in the source environment at the time of export. However, the import of the same configuration package doesn't automatically import the opt-in configurations to the target environment.

You may choose to import the opt-in configuration from the source to the target when you import the configuration package. The import process enables the dependent functional areas and features that were enabled in the source but aren't enabled in the target. The opt-in configuration of any other dependents in the target remains unchanged.

Note: This option isn't available when you use an implementation project to export and import setup data.

Setup Data Update Rules During Import

When you import a configuration package to the target environment, setup data in the target is modified as follows:

  • If a record exists in the configuration package but doesn't exist in the target, then import creates the record.

  • If a record doesn't exist in the configuration package but exists in the target, then import doesn't modify the record in the target.

    Note: Import doesn't delete the records in the target that don't exist in the configuration package. You must delete these records or make them obsolete manually, if necessary.
  • If a record exists both in the configuration package and in the target, then:

    • If all attribute values are the same, import doesn't modify the record in the target.

    • If values of any attributes of the record are different, then import updates the record in the target with the values in the configuration package.

Import Sequence of Setup Data

Some setups are prerequisites for other setups and thus, have data dependencies. Therefore, the sequence in which setup data is imported from a configuration package is important to prevent any failure due to data dependency.

The sequence of the tasks within the offering, functional area or implementation project, which you used during export to create the configuration package, determines the sequence in which their related business objects, and consequently, the setup data are imported. The following business objects, on the other hand, are exceptions to the default task-based sequence rule. They're always exported and imported before any other business objects in the sequence specified in this table:

Business Object Name Business Object ID

Application Taxonomy

FND_APP_TAXONOMY

Application Reference Data Set

FND_APP_REFERENCE_DATA_SET

Application Reference Data Set Assignment

FND_APP_REFERENCE_DATA_SET_ASSIGNMENT

Application Lookup

FND_APP_SET_ENABLED_LOOKUP

Data Security Policy

FND_APP_DATA_SECURITY_POLICY

Application Tree Structure

FND_APP_TREE_STRUCTURE

Application Tree Label

FND_APP_TREE_LABEL

Application Tree

FND_APP_TREE

Application Flex Value Set

FND_APP_FLEX_VALUE_SET

Application Descriptive Flexfield

FND_APP_EXTENSIBLE_FLEXFIELD

Application Extensible Flexfield

FND_APP__FLEXFIELD

Application Key Flexfield

FND_APP_KEY_FLEXFIELD

Export and Import Process Results

You can review and analyze results of setup export and import processes. The results show what setup data was exported or imported, and are listed in the order in which the business objects were processed. The results also include information about any errors encountered during the export or import process to help you analyze and resolve those errors. You can download the information about the process results in a file to review them offline.

Review of Setup Data

You can review setup data prior to or after the export or import process using the Setup Data Reports and Comparison Reports.

Setup Data Report

After an export process completes successfully, you can download the setup data reports to review and analyze the data that was exported. You can also save the reports for future reference.

A separate report is generated for each business object processed during export, which shows the data that was exported from that business object. If you specified Scope values to filter exported data, the report shows only the data that matches those Scope values.

Comparison Report

You can use the comparison report to review the differences between setup data in two different environments, such as test and production. For example, before running an import process on your production environment, you may want to compare the setup data in your exported configuration package with that in your production environment to avoid any unwanted override.

The comparison report shows you the following:

  • Which data exists in the source only.

  • Which data exists in the target only.

  • Which data exists in both but is identical.

  • Which data exists in both but has differences, and what the differences are.

You can then determine how the production data changes after the import by applying the rules as stated in the section Setup Data Update Rules during Import in the Key Information About Setup Data Export and Import Processes topic.

Best Practices for Migrating Setup Data from Test to Production

The following best practices help you optimize setup data migration between your test and production environments.

Prepare Environments for Migration

When exporting and importing, the Oracle Cloud Applications revision of both source and target environments must be the same. Ensure that your test and production environments are at the same revision level before your export and import.

Some setup data may not be supported for automatic migration through export and import. Review the Setup Task Lists and Tasks report from the Offerings page to identify the setup tasks that don't have associated setup services. Setup data of these tasks require you to migrate them manually to production using an alternative method.

Manage Setup Data in Gold Environment

If you use a Gold environment to manage your setup data, follow these steps.

  1. Enter setup data in the Gold environment.

  2. When ready to verify, export the setup data from the Gold environment and import into test.

  3. Verify setup data in the test environment.

  4. If the setup data requires update, repeat the previous steps with the updates.

    Note: Always maintain setup data in the Gold environment, because this environment is used to record and manage your setup data. Never update data directly in the test environment. Otherwise, the Gold environment no longer remains the source of truth for your setup data.
  5. After setup data passes verification, export from the Gold and import into the production environment.

  6. In the next testing cycle, if the test environment requires a refresh from the production environment, use production to test (P2T) refresh cloud service.

  7. If the Gold environment requires refreshing setup data from the production environment, you can use production to test (P2T) refresh, and synchronize your Gold environment with your production environment.

    Note: If you follow the best practices, you may never require to refresh the Gold environment with the setup data in the production environment.
This graphic illustrates the steps to manage your
setup data in the Gold environment, which are explained in the topic.

Manage Setup Data in Test Environment

If you don't use a Gold environment, but use the test environment for both maintaining and verifying setup data, follow these steps.

  1. Enter and verify setup data in the test environment.

  2. After setup data passes verification, export from the test and import into the production environment.

  3. If the test environment requires refreshing with setup data from the production environment, use production to test (P2T) refresh cloud service.

This graphic illustrates the steps to manage your
setup data in the test environment, which are explained in the topic.

Additional Points to Consider

Here are some additional points to consider while exporting and importing setup data.

  1. Ensure that all setup data is thoroughly tested and verified before you import into the production environment. Similarly, if export and import processes aren't available for any setup data and you enter it manually into the production environment, ensure that you created and verified the same data in your gold and test environments first before entering it into the production environment.

  2. Don't enter setup data manually into the production environment unless it doesn't support export and import processes. If you enter any setup data manually in your source environment, Gold or test as applicable, as well as in the production environment, and later use export and import processes to migrate the same data from your source environment to your production environment, the import process might fail.

  3. When exporting setup data using an implementation project, export only one offering at a time. For more details, refer to the topic Setup Data Export and Import Using Implementation Project.

  4. Use the scope value to limit the volume of exported setup data. Scope is particularly useful when you're migrating only the incremental changes to setup data after you completed the initial deployment of an offering to the production environment.

  5. Source control the exported configuration package files to keep a history of setup changes that were applied to the production environment.

  6. Consider running comparison of the setup data in the configuration package file with that in the production environment before starting the import process. This lets you review how import changes the production data and help you to avoid making unwanted changes in production. For more details, refer to the topic Setup Data Comparison Results.

  7. Don't ignore the tasks you must perform before and after import. You must migrate their data manually. Otherwise, setup data in production remains incomplete, causing errors during transaction processing.

  8. If you're implementing multiple offerings at the same time and importing their setup data into production concurrently, then you must import those offerings in the same sequence as specified in the following section to avoid errors related to data dependencies.

Offering Import Sequence When Migrated Concurrently

This table lists the sequence in which you must import offerings when you implement multiple offerings at the same time and import their setup data into production concurrently:

Sequence Family Offering

1

HCM

Workforce Deployment

2

HCM

Compensation Management

3

HCM

Workforce Development

4

Financials

Financials

5

Financials

Oracle Fusion Accounting Hub

6

HCM

Incentive Compensation

7

CRM

Customer Data Management

8

CRM

Enterprise Contracts

9

CRM

Marketing

10

CRM

Sales

11

Procurement

Procurement

12

Projects

Project Financial Management

13

Projects

Project Execution Management

14

Projects

Grants Management

15

SCM

Materials Management and Logistics

16

SCM

Manufacturing and Supply Chain Materials Management

17

SCM

Order Management

18

SCM

Price Management

19

SCM

Product Management

20

SCM

Supply Chain Financial Orchestration

21

SCM

Supply Chain Managerial Accounting

22

SCM

Value Chain Planning

23

GRC

Risk and Controls

Setup Data Export and Import Using an Offering or a Functional Area

In this method, you may choose to export and import setup data of an entire offering, or limit the processes to one of its functional areas. This method is a simplified export and import process, which doesn't require understanding complexities of data dependencies and setup tasks.

By Offering

You typically export and import an entire offering when you migrate setup data of the offering to the target environment for the first time. Setup data related to all enabled functional areas and features of the offering is exported and imported.

By Functional Area

When setup data specific to a functional area changes over time, you might decide to export and import only the affected functional area. This helps to limit export and import of setup data to a smaller range and therefore, migration processes take less time to complete than that of the entire offering.

If you select a specific functional area to export, only the setup data related to that functional area and its enabled features is exported and imported.

Note: You must ensure that all prerequisite setup data needed by the setup data of the exported functional area is available in the target environment before you start import. Otherwise, the import process might fail.

Same Levels of Export and Import

You must start the import process from the same offering or the functional area that was used to create the configuration package file you want to import. Otherwise, you receive an error message until you upload the correct configuration package file. All setup data in the configuration package file is imported irrespective of whether or not the corresponding functional areas or features are enabled in the target environment.

Setup Data Comparison

You can compare setup data of an offering or functional area in an exported configuration package file with that of the same offering or functional area in an environment. Setup data comparison is integrated with the import process as an option to compare and analyze which setup data is imported. Alternatively, you can also use setup data comparison independent of an import process. For example, to compare how the setup data of an environment has changed over a certain period, you can start the comparison outside of an import process.

Export Setup Data Using Offering or Functional Area

This procedure shows you how to export setup data using offering or functional area. You need the Application Implementation Consultant role (ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOB) to export setup data. You also need access to additional roles if you're exporting certain business objects. For more information about these additional roles, refer to the topic Additional Access Required for Exporting and Importing Setup Data.

To export setup data using offering or functional area, follow these steps.

  1. Click Navigator > Setup and Maintenance work area.

  2. In the Setup page, select the offering you want to export from the Offering menu.

  3. To export setup data:

    • For an entire offering, select and open the Actions menu in the page header, and then select Export.

    • For a specific functional area, select and open the Actions menu corresponding to the functional area, and then select Export.

  4. Select Create New to create a new export process.

  5. Optionally, specify appropriate scope values to filter exported setup data. By default, all existing setup data is exported for each business object processed during export. However, if scope is supported by any of those business objects, you can select scope values to filter the exported setup data. To specify scope values for one or more of the business objects:

    1. Select the applicable business object from the Business Objects table and then click Add. If no related business object supports scope, then the table remains empty.

    2. Search and select the value you want to use as scope for the business object and click Apply.

    3. Repeat the previous step to add more scope values if needed. Click Done when finished.

  6. Click Submit to start the export process.

  7. Monitor the status of the export process until it completes by selecting Export from the Actions menu. Up to three most recent processes are listed, and are ordered from newest to oldest. Each process indicates its status at the time, and if it was completed already, then the time stamp when it was processed.

  8. While the process is still in progress, you may select the status to view how much progress the process has made at the time. A message shows you how many business objects were already processed out of the total number of objects to be processed. Click View Progress to review the details on the business objects that were already processed. Click the Refresh button to get the most recent information. Refer to the topic Review of Export and Import Process Results for detailed description of the process results.

  9. When the export process completes, select the status link to go to the Export Offering Data Results page.

    • If the process completes successfully, the status is set to Ready to download.

      1. Click Download File to download the configuration package .zip file and save it at an appropriate location. Use this file to import setup data in the target environment.

      2. In addition, review the list of post export tasks. If any tasks are listed, then those tasks aren't migrated by export and import process. You must migrate that data manually in the target environment.

    • On the other hand, if the process completes with errors, the status displays Ready for error review.

      1. The Business Objects table shows all business objects that had errors during processing. Refer to the topic Review of Export and Import Process Results for detailed description of the process results.

      2. Click Download Log File from the page header, which includes the error log of all business objects that experienced error. Alternatively, you can also click Actions > Download Log File corresponding to a specific business object to download error log specific to that business object.

      3. After correcting the cause of the errors, create a new export process.

Import Setup Data Using Offering or Functional Area

This procedure explains how to import setup data for an offering or functional area. You need the Application Implementation Consultant role (ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOB) to import setup data. You also need access to additional roles if you're importing certain business objects. For more information about additional roles to import these business objects, refer to the topic Additional Access Required for Exporting and Importing Setup Data.

To import setup data for an offering or functional area, follow these steps.

  1. Click Navigator > Setup and Maintenance work area to open the Setup page.

  2. Select the offering you want to import from the Offering menu.

  3. If the configuration package you want to import was created by exporting:

    • An offering, select Import from the Actions menu in the page header.

    • A functional area, select Import from the Actions menu corresponding to that functional area.

  4. Select Create New to create a new import process.

  5. Browse and select the configuration package file that contains the setup data you want to import. View the Configuration Package Details to verify that you selected the correct file.

    • If the offering or functional area selected during export doesn't match the offering or functional area you chose for the import process, an error message appears. Click the Update button to browse and select the correct file.

  6. Expand the Import option.

    • Best Practice is to select the Compare setup data prior to import option. If you select this option, the import process automatically runs a comparison of the setup data in the configuration package file with that in the target environment before importing the setup data.

      Note: Comparing setup data prior to import requires additional time. You may skip this step by not selecting the Compare setup data prior to import option. However, if you skip this step, you can't review how the setup data is similar or different in the source and target, and how the import process changes setup data in the target environment.
    • Optionally, select the Import feature selection option to import the opt-in configuration of the offering or functional area you're importing. This imports the enabled dependent functional areas and features of the offering or functional area.

  7. Click Submit to start the import process.

  8. If any setup data requires manual entry before the import can start, a warning message appears. This message shows you the tasks you must perform before submitting the process.

    • If you verified that the setup data for those tasks are already entered in the target environment, click Submit.

    • Otherwise, click Cancel. Create a new import process after you ensure that the setup data is entered in the target environment.

  9. Monitor the import process by clicking Actions > Import. Up to three most recent processes are listed and ordered from newest to oldest. Each process indicates its status at the time and, if the process is completed, the time stamp when it was processed.

  10. While the process is in progress, you can select the status to view how much progress the process made at the time. A message shows you how many business objects were already processed out of the total number of the objects to be processed. Click View Progress to review the details of the business objects that finished processing. Click the Refresh button to view the most recent information. Refer to the topic Review of Export and Import Process Results for detailed information about the process results.

  11. If you selected the Compare setup data prior to import option, once the comparison completes, the status reads Waiting for comparison review. Select the status to go to the Import Offering Data Results page to review the comparison results. Refer to the topic Compare Setup Data Using Offering or Functional Area for a detailed description of the comparison results.

  12. Click Continue to Import from the Import Offering Data Results page to start the import process if you're satisfied with the comparison results.

  13. Alternatively, if you didn't select the Compare setup data prior to import option, the import process starts automatically.

  14. Monitor the process as before, until it completes.

  15. If any setup data requires manual data entry during import, the process pauses, and the status reads Waiting for manual import.

    1. Select the status to go to the Import Offering Data Results page and review the details.

    2. A list displays the business objects that require manual data entry before import.

    3. For each of the listed business objects, click Go to task. This displays a list of related tasks. Select each task to enter the required data.

    4. After you enter the setup data for all the listed business objects, click Resume from the Import Offering Data Results page to restart the import process.

    5. Click Confirm in the confirmation message that appears to resume the import process.

  16. Continue to monitor the process until it completes.

  17. If the import process completes successfully:

    1. Review the results to verify successful completion.

    2. If any post import tasks are listed, ensure that their setup data is entered. Otherwise, the setup data remains incomplete, and you experience errors when processing transactions.

  18. If the import process completes with errors:

    1. The Business Objects table displays all business objects which encountered errors while processing. Refer to the topic Review of Export and Import Process Results for a detailed description of the process results.

    2. Click the Download Log File from the page header level. This includes the error log of all business objects that encountered errors. Alternatively, click Actions > Download Log File corresponding to a specific business object to download the error log specific to that business object.

    3. Create a new import process after correcting the errors.

Compare Offering Setup Data During Import

This procedure explains how to compare setup data for an offering or functional area during the import process. You need the Application Implementation Consultant role (ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOB) to import setup data. You also need access to additional roles if you're importing certain business objects. For more information about additional roles to import these business objects, refer to the topic Additional Access Required for Exporting and Importing Setup Data.

To compare setup data for an offering or functional area during an import process, follow these steps.

  1. Click Navigator > Setup and Maintenance work area to open the Setup page.

  2. Select the offering you want to import from the Offering menu.

  3. If the configuration package you want to import was created by exporting:

    • An offering, select Import from the Actions menu in the page header.

    • A functional area, select Import from the Actions menu corresponding to that functional area.

  4. Select Create New to create a new import process.

  5. Browse and select the configuration package file that contains the setup data you want to import. View the Configuration Package Details to verify that you selected the correct file.

    • If the offering or functional area selected during export doesn't match the offering or functional area you chose for the import process, an error message appears. Click the Update button to browse and select the correct file.

  6. Expand the Import option.

    • Best Practice is to select the Compare setup data prior to import option. If you select this option, the import process automatically runs a comparison of the setup data in the configuration package file with that in the target environment before importing the setup data.

      Note: Comparing setup data prior to import requires additional time. You may skip this step by not selecting the Compare setup data prior to import option. However, if you skip this step, you can't review how the setup data is similar or different in the source and target, and how the import process changes setup data in the target environment.
    • Optionally, select the Import feature selection option to import the opt-in configuration of the offering or functional area you're importing. This imports the enabled dependent functional areas and features of the offering or functional area.

  7. Click Submit to start the import process.

  8. If any setup data requires manual entry before the import can start, a warning message appears. This message shows you the tasks you must perform before submitting the process.

    • If you verified that the setup data for those tasks are already entered in the target environment, click Submit.

    • Otherwise, click Cancel. Create a new import process after you ensure that the setup data is entered in the target environment.

  9. Monitor the import process by clicking Actions > Import. Up to three most recent processes are listed and ordered from newest to oldest. Each process indicates its status at the time and, if the process is completed, the time stamp when it was processed.

  10. While the process is in progress, you can select the status to view how much progress the process made at the time. A message shows you how many business objects were already processed out of the total number of the objects to be processed. Click View Progress to review the details of the business objects that finished processing. Click the Refresh button to view the most recent information. Refer to the topic Review of Export and Import Process Results for detailed information about the process results.

  11. If you selected the Compare setup data prior to import option, once the comparison completes, the status reads Waiting for comparison review. Select the status to go to the Import Offering Data Results page to review the comparison results. Refer to the topic Compare Setup Data Using Offering or Functional Area for a detailed description of the comparison results.

  12. Click Continue to Import from the Import Offering Data Results page to start the import process if you're satisfied with the comparison results.

  13. Alternatively, if you didn't select the Compare setup data prior to import option, the import process starts automatically.

  14. Monitor the process as before, until it completes.

  15. If any setup data requires manual data entry during import, the process pauses, and the status reads Waiting for manual import.

    1. Select the status to go to the Import Offering Data Results page and review the details.

    2. A list displays the business objects that require manual data entry before import.

    3. For each of the listed business objects, click Go to task. This displays a list of related tasks. Select each task to enter the required data.

    4. After you enter the setup data for all the listed business objects, click Resume from the Import Offering Data Results page to restart the import process.

    5. Click Confirm in the confirmation message that appears to resume the import process.

  16. Continue to monitor the process until it completes.

  17. If the import process completes successfully:

    1. Review the results to verify successful completion.

    2. If any post import tasks are listed, ensure that their setup data is entered. Otherwise, the setup data remains incomplete, and you experience errors when processing transactions.

  18. If the import process completes with errors:

    1. The Business Objects table displays all business objects which encountered errors while processing. Refer to the topic Review of Export and Import Process Results for a detailed description of the process results.

    2. Click the Download Log File from the page header level. This includes the error log of all business objects that encountered errors. Alternatively, click Actions > Download Log File corresponding to a specific business object to download the error log specific to that business object.

    3. Create a new import process after correcting the errors.

Compare Setup Data Using Offering or Functional Area

This topic explains how to compare setup data outside of the import process. To compare setup data during import, refer to the topic Import Setup Data Using Offering or Functional Area.

You need the Application Implementation Consultant role (ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOB) to compare setup data. You also need access to additional roles to compare certain business objects. For more information about access to additional roles, refer to the topic Additional Access Required for Exporting and Importing Setup Data.

To compare setup data using offering or functional area, follow these steps.

  1. Click Navigator > Setup and Maintenance work area.

  2. In the Setup page, select the offering whose setup data you want to compare.

  3. If the configuration package you intend to compare was created by exporting:

    • An offering, then select and open the Actions menu in the page header, and then select Compare Setup Data > Create New.

    • A functional area, then select and open the Actions menu corresponding to the functional area, and then select Compare Setup Data > Create New.

  4. Upload the configuration package file whose data you want to compare with that in the environment. To upload the configuration package file, follow these steps.

    1. From the Configuration Package menu, select Upload new.

    2. Browse to find the configuration package file and open it.

    3. Optionally, expand Configuration Package Details to verify that you have selected the correct file. If it's not the correct file, then click Update to browse and select the correct file.

    4. Click Submit to upload the configuration package.

  5. Once the configuration package is uploaded, the process for setup data comparison is ready to be submitted. Optionally, you can change the default name that the process assigns.

  6. Click Submit to start the comparison process.

  7. Monitor the status of the process by selecting Action > Compare Setup Data. Up to three most recent processes are listed and are ordered from the newest to oldest. Each process indicates its status at the time and, if the process has completed, then the time stamp when it was processed.

  8. When the process completes, the status shows Ready for comparison review. Select the status to go to Comparison Process Results to review the details of the results. Refer to the topic Setup Data Comparison Results for detailed descriptions of the comparison results.

If you used an implementation project to enter setup data, then you can use your implementation project to export and import setup data. In this alternative method, the tasks in your implementation project and their sequence determine the list of setup business objects whose data is exported and imported, and in which order.

Note: Even if you used an implementation project to enter setup data, you can still use an offering or a functional area to export and import the same setup data, to ensure that all data dependencies are migrated properly.

Select your implementation project, and create a configuration package to generate the ordered list of business objects for export and import.

Exporting One Offering at a Time

The implementation project you use to create a configuration package must contain only one offering. The import process fails otherwise.

If you included multiple offerings in an implementation project to enter setup data, don't use it to create a configuration package for setup data export and import. Instead, create new implementation projects with only one offering in each, and use these to create separate configuration packages.

Partial Data Migration

Although best practice is to select an offering and its functional areas to create an implementation project, you may have created an implementation project by selecting specific tasks and task lists instead. Such implementation projects are often created to update and maintain a small set of setup data after the initial migration of an offering to a target environment has completed.

When using such implementation projects to create configuration packages for setup data export and import, consider the following requirements carefully to ensure the success of the process:

  • If any setup data in the configuration package has a dependency on any other setup data, then that prerequisite data must be available in your target environment before you start the import process using the configuration package. Otherwise, consider including the prerequisite task in the implementation project before you create the configuration package.

  • The sequence of the task list and tasks, and therefore the business objects, in your implementation project must align with the setup data dependency requirements. The import process may fail if you don't ensure the correct order of the task lists and tasks in the implementation project.

Comparing Setup Data Before Import

When using an implementation project to migrate setup data, the comparison report isn't integrated with the import process. However, best practice is still to compare the setup data in the exported configuration page with the data existing in the target environment before starting the import process.

Export Setup Data Using Implementation Project

This procedure explains how to export setup data for an implementation project that you already completed setting up. You need the Application Implementation Consultant role (ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOB) to export setup data. You also need access to additional roles if you're exporting certain business objects. For more information about access to the additional roles, refer to the topic Additional Access Required for Exporting and Importing Setup Data.

To export setup data using an implementation project, follow these steps.

  1. Click Navigator > Setup and Maintenance work area.

  2. In the Setup page, select Manage Configuration Packages from the Tasks panel tab.

  3. In the Manage Configuration Packages page, select Create from the Actions menu, or click the Create icon from the Search Results table in the Manage Configuration Packages page to go to the Create Configuration Package: Enter Basic Information page.

  4. In the Source Implementation Project,

    1. Select the implementation project you want to use for the setup data export from the Name menu.

    2. Leave the default selection for Export, Setup task list and setup data, unchanged.

  5. In Configuration Package Details, you can use the default field values for Name, Code and Description, or assign unique values.

  6. Click Next to go to the Create Configuration Packages: Select Objects for Export page.

  7. The first table displays the list of business objects whose setup data is exported. The implementation project you selected as the source of this configuration package in the previous step determines the business object list.

    • The Type column indicates the export and import behavior of the business object as follows:

      1. If export and import services are available for a business object then the type is business object service.

      2. If the type is specified as Scope, then the business object can be used to select a scope value to filter the exported data. However, the setup data of the business object itself in not exported.

      3. If the setup data of any business object must be migrated manually using alternative methods that are external to setup export and import processes, the type is Manual data loading.

    • All business objects whose type is Business object service have their Export column checked by default. You typically keep this selection unchanged.

      Note: If a business object has identical setup data in both source and target environments, then you can optionally exclude it from export, and consequently, from import, to reduce processing time. However, if any excluded setup data is prerequisite to import any other setup data in this configuration package, then your import process fails. Therefore, you should use this option cautiously and only when you're certain that the target environment contains the prerequisite data before you start your import process.
  8. When you select a business object in the first table, if it supports scope to filter exported setup data, you can select appropriate scope values in the second table.

    • If the business object you selected has predefined scope values, then scope table lists all of them by default. You could decide to remove one or more of the listed scope values but you can't add other values.

    • If the business object you selected supports scope but doesn't have predefined value, then you can add one or more scope values.

      1. Click the Create icon in the scope table.

      2. Search and select each of the values you want to use as scope to export data for and click Apply.

      3. Click Done when you finish selecting all desired scope values.

  9. Click Submit to submit the setup data export process and confirm when the confirmation message appears.

  10. Monitor the process from Manage Configuration Package until it completes.

  11. While the process is in progress, you may select the status to go to the Export and Import Process Results page to view how much progress the process has made at the time. Click the Refresh button to get the most recent information. Refer to the topic Review of Export and Import Process Results for detailed descriptions of the process results.

  12. Once the export process completes successfully, click Download to download the configuration package. Use this .zip file to import setup data in the target environment. Optionally, select the status to go to the Export and Import Process Results page to view the result details.

  13. If the export process completes with errors, then fix the errors according to the following instructions.

    1. Select the status to go to the Export and Import Process Result page to view the error details.

    2. Download the log file for the setup business objects with errors by clicking Actions > Download > Log file.

    3. Fix the errors as needed. To modify or enter any data to fix the error, click Go to Task to open the corresponding setup page.

  14. Create a new export process after the errors are corrected.

Import Setup Data Using Implementation Project

This procedure explains how to import setup data for an implementation project. You need the Application Implementation Consultant role (ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOB) to import setup data. You also need access to additional roles if you're importing certain business objects. For more information about additional role to import those business objects, refer to the topic Additional Access Required for Exporting and Importing Setup Data.

To import setup data from a configuration package, follow these steps.

  1. Click Navigator > Setup and Maintenance work area.

  2. In the Setup page, select Manage Configuration Packages from the Tasks panel tab.

  3. In the Manage Configuration Packages page, click the Upload button from the Search Results table to go to the Upload Configuration Package page.

  4. Click the Browse button to browse and select the configuration package you want to import.

  5. Click the Get Details button and review the information in Configuration Package Details and Implementation Project Details to verify that you uploaded the correct configuration package for import. If you didn't upload the correct configuration package file, click the Update button to upload the correct file and verify again.

  6. Click Submit to start the upload process.

  7. Your configuration package is listed in the Search Results table in the Manage Configuration Package page.

  8. Select the configuration package from the Search Results table to view its process details in the Export and Import Processes table.

  9. Monitor the upload process until it completes. Once the upload process completes successfully, your configuration package is ready for import.

  10. Select the upload process from the Export and Import Processes table and click Import Setup Data.

  11. In the Import Setup Data: Enter Basic Information page, click Submit to start the import process with the default settings.

  12. You can also make the following modifications before submitting the import process:

    • On the Import Setup Data: Basic Information page, you can change the default process name and description, to help you identify the process later.

    • On the Import Setup Data: Basic Information page, the Pause process each time an error occurs option is selected by default, to indicate that the import process pauses each time it encounters an error. This gives you an opportunity to take corrective action. You can deselect this option so that the import process continues despite the errors. A summary of all the errors is displayed after the process finishes.

      Note: If the import process doesn't pause for each error, it doesn't require your attention throughout the process. However, this also increases the possibility of additional business objects failing import due to dependencies.
    • The import process also pauses by default for each task that requires manual data loading. To override this pausing, follow these steps:

      • Click Next to go to the Import Setup Data: Select Pause for External Import page.

      • Select Manual data loading from the Type menu.

      • The Pause column displays a check mark for the tasks that require manual data loading before the import can resume. If manual data loading can be performed before or after the import process, this column doesn't display a check mark.

      • Review the list of tasks and deselect the Pause column corresponding to the tasks for which you don't want the import process to pause.

        Note: Use this option only when you're certain that the setup data for these tasks already exists in the target environment. Import of setup data whose prerequisite is the data that requires manual data loading may fail if this prerequisite data doesn't exist when the dependent data is imported.
    • The import process runs immediately when submitted. However, you can also schedule the import process to start at a certain time. To schedule a time, click Next to go to the Import Setup Data: Schedule and Notifications page. Select Use a schedule and specify a start time.

  13. Monitor the import process until it completes. The process status changes according to the state of the process. Select the status to go to the Export and Import Process Results page, and take the appropriate action as follows.

    • In Progress: While the process is still in progress, you may review how much progress the process made at the time. Click the Refresh button to get the most recent information.

    • Completed Successfully: Review the process results to determine if any setup tasks must be performed manually after the import to properly complete migration of the setup data. If yes, perform those tasks.

    • Waiting for Manual Import: If a setup task requires manual data entry before the import process can continue, the status reads Waiting for Manual Import. Click Go to Task for the corresponding business object to open the setup user interface. Alternatively, you can enter the setup data manually. After you enter the required setup data, click Resume from the Export and Import Process Results page, or from the Manage Configuration Packages page to restart the import process.

    • Waiting to review errors: If you selected the Pause process each time an error occurs option when you created the import process, this status displays when the import process encounters an error while running. Click Actions > Download log file corresponding to the specific business object to review the error details. Take appropriate corrective action and click Resume from the Export and Import Process Results page, or from the Manage Configuration Package page.

      Optionally, you may skip the business object that generated the error, and continue from the next object. However, skip these business objects only if you're certain that the error was fixed in the environment, and that the import process doesn't require reprocessing the business object.

    • Completed with errors: When the process completes with errors, click Actions > Download log file corresponding to the business objects with errors, to review the error details.

  14. Create a new import process after you correct the errors.

Compare Setup Data Using Implementation Project

This topic explains how to compare setup data using an implementation project. You need the Application Implementation Consultant role (ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOB) to compare setup data. You also need access to additional roles if you're comparing certain business objects. For more information about additional roles for these business objects, refer to the topic Additional Access Required for Exporting and Importing Setup Data.

To compare setup data using an implementation project, follow these steps:

  1. Click Navigator > Setup and Maintenance work area.

  2. In the Setup page, run an export process at the target environment to prepare for setup data comparison. Create an implementation project in the target environment that matches exactly the same task lists and tasks as the implementation project you used at your source environment to create the configuration package file you want to import. Use this implementation project to run the export process at the target environment.

  3. Once the export process completes, upload the configuration package file from your source environment into the target environment. Follow the same process as needed, to upload a configuration package for import. However, don't run the import process.

  4. Once the upload process completes successfully, select Manage Export and Import Processes from the Tasks panel tab.

  5. In the Manage Export and Import Processes page, click Compare.

  6. In the Comparison Processes page, select the Create new icon to create a new comparison process.

    1. Select the configuration package you uploaded from your source environment as Source 1. If you have multiple versions of the same configuration package available, then select the correct process date to identify the correct version of the file.

    2. Select the configuration package you created by running the export process at the target environment to prepare for comparison, as Source 2. Like Source 1, if the configuration package you selected for Source 2 has multiple versions available in the target environment, select the correct process date to identify the correct version.

    3. Change the default process name, if required and click Submit.

  7. Once the comparison process is submitted, the new process is listed in the Comparison Processes page.

  8. The Status column displays the status of the process. Monitor the status until the process completes.

  9. When the Status column reads Completed successfully, select the process name to go to the Configuration Package Comparison page to review the details of the results.

  10. If the comparison process doesn't complete successfully, select the status to go to the Comparison Process Results page and review the error details.

Setup Data Comparison Results

Setup data comparison results are listed in three sections:

  • Comparison Summary

  • Comparison Details

  • Failed Objects

Comparison Summary

This section provides an overview of the results from comparing the setup data, which includes:

  • Total number of business objects compared.

  • How many of them processed successfully.

  • How many of them failed, if any.

  • How many of them have records that exist only in the configuration package created from the source environment.

  • How many of them have records that exist only in the target environment.

  • How many of them have records that exist in both the configuration package and the target environment, but have some data mismatch.

Comparison Details

This section lists each of the business objects that were compared successfully between the source and target environments. For each business object, details of the records that have data mismatch between the source and target environments are displayed. By default, the list includes only the business objects that have data discrepancies. However, you can select All from the Show filter to also include the business objects that have identical setup data in both the source and target environments.

For each business object, a summary table displays the number of records it has in the following categories. The numbers which aren't zero are displayed as links. Select the numbers to open a detailed report.

  • Only in Configuration 1 displays the records that exist only in the exported configuration package file, but not in the target environment. Therefore, when you import this configuration package, these records are created in the target environment.

  • In Both with Mismatch displays the records that exist in both the source and target environments. but have different values in one or more of the attributes. Consequently, these records are updated in the target environment with their values in the configuration package when you import. The detailed report displays two rows for each record, with one row each representing the source and target environments.

  • Only in Configuration 2 displays the records that exist only in the target environment and not in the configuration package file. These records therefore, remain unchanged when the configuration package is imported in the target environment. You must use the manual process to remove these records from the target.

  • Identical in Both displays the records that exist in both the source and target environments, and have identical values in all of their attributes. This column is displayed only when the Show filter is set to All. In addition, this category doesn't provide any detailed reports on the records and therefore, the number in the summary table is always read-only.

Failed Objects

In case the comparison report failed to process any business objects due to errors, this section displays a list of those objects. For each object, you can use the Feature Details icon to view or save its error log file.

Downloading Reports

Optionally, click the Download button from the Comparison Details section to download and save the reports.

  • The Comparison Report provides .zip files that contain comparison reports for each of the business objects that were processed. For each business object, a report each for Only in Configuration 1, In Both With Mismatch, and Only In Configuration 2, as applicable is provided.

  • The Comparison Results report provides a summary of the comparison process and represents the table shown in the Comparison Details section of the user interface.

  • The Comparison Process Results Summary provides a summary of the process results, which displays a list of all the processed business objects, and whether their processing completed successfully, or with errors.

  • The Comparison Log File provides a detailed log of the entire comparison process.

Setup Data Reports

Setup data reports are generated automatically every time you run an export process by using an offering, functional area or implementation project.

You can also generate setup data reports for an offering or functional area without running an export process. However, this option isn't available for implementation projects.

You can download and use these reports to verify the setup data as it exists in the environment. You can also save the reports as documents of the state of your setup data at the time of export, for future reference.

Generate Setup Data Reports

This procedure explains how to generate setup data reports. You can download and review a consolidated report of setup data for all exported business objects, or for a specific business object.

To download and review setup data reports, follow these steps.

  1. If you ran an export process already and want to use the setup data reports that were generated as a result, then select the export process status to go to process results page once the process completes successfully.

  2. To generate setup data reports for an offering or a functional area without running an export process, follow these steps.

    1. Click Actions > Setup Data Reports > Create New for an offering or a functional area as applicable.

    2. Accept the confirmation message.

    3. Continue to monitor the process until it completes successfully.

    4. Select the status to go to the Export and Import Process Results page.

  3. Use Download Setup Data Reports:

    • At the page level to download a consolidated report of setup data from all exported business objects.

    • Or, at the individual business object level to download the report for that specific business object.

  4. Save and open the .zip file to review the details. If you download the consolidated report, then the .zip file contains one .zip file for each of the exported business object.

Review of Export and Import Process Results

Export and import process results help you monitor the progress of setup data export or import processes while they're running, and to review their results after the processes complete.

The results are shown in three sections:

  • Summary

  • Business Objects

  • Post-Export or Post-Import Tasks.

Summary

This section shows a summary of the export or import process, which includes:

  • The date and time of the export or import process, and its completion status.

  • Total number of business objects processed.

  • How many business objects were processed successfully.

  • How many business objects completed processing with errors.

  • How many business objects completed processing with warnings.

  • How many setup objects require manual export or import.

Business Objects

This section lists the business objects whose setup data was exported and imported. The sequence of the results is the same sequence in which the business objects were processed.

If the process completes successfully, all business objects are listed. If the process completes with errors or warnings, the list includes only those business objects that encountered errors or warnings.

Review the status details for each business object, which shows you how many records were processed. If the status details of a business object indicate that the object was already processed and references another object in the message, then locate the referenced object to review its status details.

If the business object encountered errors, the status details also include detailed information about the errors, and refer to the product which supports the business object. When you log bugs on this business object, use the referenced product and attach the corresponding log file with the bug.

Post-Export or Post-Import Tasks

Some of the setup data for a configuration can't be automatically exported and imported since export or import services may not be available for them. You must manually export or import this setup data to ensure that all the relevant setup data is migrated. This section shows you which setup data you must manually export or import after the export or import process completes. Oracle recommends that you follow the same method you used to enter the setup data for each of these tasks.

Note: When reviewing the results of export and import processes based on implementation projects, the Post-Export or Post-Import Tasks are available from the Export and Import Process Results page. Click the Review Tasks for External Import button from the Object Details table to access the Post-Export and Post-Import Tasks.

Export and Import Process Reports

Each time you run an export or import setup data process, a Process Results Summary, a Process Results report, and a Log File generate automatically.

  • Process Results Summary report is a text file that displays summary information and the status details of each setup business object processed by the export or import process.

  • Process Results report is a text file that displays the status of an export or import process, and detailed information about encountered during the process. These reports show the same information as the export and import results seen directly in the application.

  • Log File is a text file that displays detailed information for about each setup object processed by the export or import process.

You can download the export and import process results report from the Actions menu. Alternatively, you click the Download button from the Export and Import Process Results page, and select the report you want to download.

Additional Access Required for Exporting and Importing Setup Data

You must have the Application Implementation Consultant role (ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOB) to export or import setup data. However, you require additional roles to export and import certain business objects.

This table lists the business objects for which additional roles are required, and the role required for each business object.

Business Object Name Required Role Name

Corporate Card Expense Type Mapping Rule

Corporate Card Administrator

Corporate Card Company Account

Corporate Card Administrator

Corporate Card Program

Corporate Card Administrator

Corporate Card Transaction Download Parameter

Corporate Card Administrator

Corporate Card Transaction Upload Rule

Corporate Card Administrator

Corporate Card Usage Limit Rule

Corporate Card Administrator

Bank Statement Reconciliation Tolerance

Cash Manager

Bank Statement Automatic Reconciliation Matching Rule Set

Cash Manager

Bank Statement Automatic Reconciliation Matching Rule

Cash Manager

Bank Statement Transaction Creation Rule

Cash Manager

Cash Transaction Type

Cash Manager

Bank Transaction Code

Cash Manager

Bank Statement Parsing Rule

Cash Manager

Bank Account

Cash Manager

Bank Branch

Cash Manager

Bank

Cash Manager

Collections Aging Bucket

Collections Manager

Collections Dunning Configuration

Collections Manager

Collections Preference

Collections Manager

Collector

Collections Manager

Expense Audit Rule

Expense Manager

Expense Audit List Rule

Expense Manager

Expense Receipt Management Rule

Expense Manager

Incentive Compensation Participant

Incentive Compensation Application Administrator

Department

Human Capital Management Application Administrator

Legal Employer

Human Capital Management Application Administrator

Payroll Statutory Unit

Human Capital Management Application Administrator

Division

Human Capital Management Application Administrator

Job

Human Capital Management Application Administrator

Location

Human Capital Management Application Administrator

Enterprise Information

Human Capital Management Application Administrator

Legislative Data Group

Human Capital Management Application Administrator

Spreadsheet Business Object Security Mapping

Human Capital Management Integration Specialist

Role Provisioning Associated Role List

IT Security Manager

Role Provisioning Rule

IT Security Manager

Country Security Profile Country List

IT Security Manager

Country Security Profile

IT Security Manager

HR Document Type Security Profile List

IT Security Manager

HR Document Type Security Profile

IT Security Manager

Legislative Data Group Security Profile List

IT Security Manager

Legislative Data Group Security Profile

IT Security Manager

Organization Security Profile Classification List

IT Security Manager

Organization Security Profile

IT Security Manager

Organization Security Profile Organization List

IT Security Manager

Payroll Security Profile Pay

IT Security Manager

Payroll Security Profile

IT Security Manager

Payroll Flow Security Profile Pay

IT Security Manager

Payroll Flow Security Profile

IT Security Manager

Person Security Profile Manager Type

IT Security Manager

Person Security Profile Person Type

IT Security Manager

Person Security Profile

IT Security Manager

Person Security Profile Area of Responsibility Scope

IT Security Manager

Position Security Profile Position List

IT Security Manager

Position Security Profile

IT Security Manager

Position Security Profile Area of Responsibility Scope

IT Security Manager

Transaction Security Profile

IT Security Manager

Transaction Security Profile Entries

IT Security Manager

Transaction Security Profile Sub Categories

IT Security Manager

HCM Data Role Security Profile

IT Security Manager

HCM Data Role

IT Security Manager

China Ledger Option

Enterprise Financial Data Export Options Management for China

China Depreciation Method Formula

Enterprise Financial Data Export Options Management for China

China Financial Information Option

Enterprise Financial Data Export Options Management for China

China Golden Tax Miscellaneous Option

Golden Tax Administration for China

China Value Added Tax Invoice Option

Golden Tax Administration for China

China Golden Tax Transfer Rule

Golden Tax Management for China Duty

China Golden Tax Transfer Rule Line

Golden Tax Management for China Duty

China Golden Tax Transfer Rule Line Transaction Type

Golden Tax Management for China Duty

China Golden Tax Miscellaneous Option

Golden Tax Management for China Duty

China Value Added Tax Invoice Option

Golden Tax Management for China Duty

China Value Added Tax Invoice Assignment

Golden Tax Management for China Duty

China Golden VAT Limit

Golden Tax Management for China Duty

China Golden VAT Type

Golden Tax Management for China Duty

Italian VAT Letter of Intent Limit Setup

EMEA Financial Reporting Duty

Additional Settings for Setup Data Export and Import Processes

In general, you won't need these additional settings for your export and import processes. To know whether you need them, review the special requirements explained in this topic.

Manage Import-only Setup Mode

You may have to operate one of your environments, such as your production environment, in import-only setup mode. Then, you can manage the setup data in that environment through the setup import process.

When an environment is in import-only setup mode, users won't be able to use any of the setup user interfaces to manage setup data. If anyone wants to use import processes to manage setup data, they must have the Manage Setup Migration Settings (ASM_MANAGE_SETUP_MIG_SETTINGS_PRIV) privilege to run setup data import. This privilege isn't included in any roles delivered by Oracle and must be granted explicitly to you.

To specify your environment as import-only, follow these steps.

  1. Click Navigator > Enterprise.

  2. On the Enterprise Information page, go to the Functional Setup Settings section and enable Import-only Setup Mode.

Mange Export of Externally Mastered Setup Data

You may have some of your setup data sourced from an external master system. If you want to exclude those externally mastered data from the setup export process, follow the instructions and make the required changes. You need the Manage Setup Migration Settings (ASM_MANAGE_SETUP_MIG_SETTINGS_PRIV) privilege for this task. This privilege isn't included in any roles delivered by Oracle and must be granted explicitly to you.

  1. Click Navigator > Enterprise.

  2. On the Enterprise Information page, go to the Functional Setup Settings section and click Manage Export of Externally Mastered Setup Data. The Manage Export of Externally Mastered Setup Data page lists all business objects sourced from an external master system.

  3. Select the Include in Export check box to include a business object in the export process. If you want to exclude a business object, deselect the check box.

  4. Click Save and Close.

Change Export File Size

The default size of setup data export files is usually sufficient for most export requirements. If you're exporting large volumes of setup data for any tasks, Oracle might advise you to increase the export file size. That would also address the size-related warning message that you might see during the export process.

Note: Don't change the file size unless Oracle advises you to do so.

For this task, you need the Application Implementation Consultant (ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOB) role and the Manage Setup Migration Settings (ASM_MANAGE_SETUP_MIG_SETTINGS) privilege. To change the export file size, follow these steps.

  1. Click Navigator > Enterprise.

  2. On the Enterprise Information page, go to the Functional Setup Settings section and click Manage Setup Data File Sizes.

  3. Select the file type and change its value as per the recommendation from Oracle Support. If you want to set a larger file size, consider the available memory in your environment before changing the value.

  4. Click Save and Close.

Guidelines for Troubleshooting Errors from Setup Data Export and Import Processes

Use the information in this topic to troubleshoot warning or error messages that you might receive when you run setup data export and import related processes. You might receive errors when you:

  • Export or import XML based configuration packages

  • Export or import CSV file packages

  • Compare setup data

If there are any exceptions, the process completes with the status: Completed with warnings, or Completed with errors. Click Status to view the exception details on the process results page.

Review Process Results

The process results page lists all business objects whose setup data couldn't be processed successfully. You could also download a summary report of the process results from the Actions > Download > Process Results Summary Report. Download the summary and review log files of each failed business object to identify what type of error occurred, and take appropriate corrective actions.

Download Log Files

Click Download Log File button on the Process Results page to download the file that includes error details of all failed business objects when running a process for an offering, a functional area or a task. Alternatively, use the Business Objects table to select a specific business object and then go to Action > Download Log File to download error details of a specific business object.

For export and import of implementation project-based configuration packages, click the Status Details link on the Process Results page and download the error log. The log file includes information about all the business objects that failed.

For the comparison of two configuration packages, click the Status link on the Process Results page and download the error log. The log file includes information about all the failed business objects. Alternatively, you can use the Business Objects table to select a specific business object and then use Status Details column to download error details of a specific business object.

Examine Log Files

The text in a log file begins with general information about the process. All business objects are listed in the same order as they were processed. For each business object, you will find a summary of the total number of records processed and how many of those records failed processing. If any record or a business object fails, then its status details shows the relevant error message along with the name of the product that owns the business object. Detailed information about the cause of failure for each record appears in the Row Identifier.

Setup data of certain business objects are processed in batches. In those cases, detailed information for the failed record will also include the batch file name in which the record is created.

Note: Review detailed information provided for the failed objects and determine if you can fix the cause of the error. Resubmit the export or import process once you have fixed the issue. If, on the other hand, you determine that you can't fix the cause of the error, report it to the product shown in the status detail of the business object. Include the log file in your service request so that the product owner has relevant details to analyze the error.

Common Error Types

Here are some of the common errors seen at the time of running setup data export and import related processes.

Error Type Example Error Message Description Suggested Action

Access Related

Access Denied

The user doesn't have the necessary permissions to export or import setup data of the business object.

Refer to the Using Functional Setup Manager guide to find out which role is needed besides the Application Implementation Consultant role. Grant that role to the user before the user runs the process again.

Setup Data Processing Related

  • Review and report the errors for this business object to product <product name>

  • The values <reference key> aren't valid for the attribute <attribute name>.

One or more records of a business object caused an exception when the setup data is processed. An error can also occur if the record of a dependent business object can't find the reference to its parent record.

  • Download and review the log file for detailed information and take the necessary action.

  • If the error indicates invalid attribute values, find the missing dependent business object and fix the reference between the parent and child business objects.

  • If nothing is reported in the log file, report the error to the product shown in the status details

Multiple Business Objects Sharing the Export or Import Service

This object was already processed. The import or export details were listed under <name of the business object processed previously>

If multiple business objects are processed by the same export or import service and an error occurs during the process, error details are reported on the first business object processed by the export or import service, while the status details of the remaining business objects sharing the service displays the error message.

Fix the error reported on the first business object.

Invalid File Format

The format of the file <filename> is invalid. The XML should have the same number of attributes for all rows within a node path.

This error message is applicable only to the export or import of CSV file packages and setup data comparison process.

Download the log file and report the error to the product specified in the error message.

Export or Import Service Invocation

NA

You might find a business object failing with the message that an error was experienced while invoking the export or import service.

Download the log file and report the error to the product specified in the error message.

FAQs for Setup Data Export and Import

How can I view and print any errors generated while importing or exporting offering setup data?

Follow the steps to open export or import process results as specified in the procedure topics for exporting and importing setup data. Download the log file for either the entire process, or for a specific business object.

Why is an import process stuck with User Action Required status?

An import process is set to User Action Required when the process paused because certain data must be imported. This occurs when the standard service to automate the setup data export and import for a business object which is marked as required for other data isn't available. You must migrate or enter the data manually using another application or process external to the Setup and Maintenance work area. Review the process results to identify the business object and resume the process after you take appropriate action to externally import the required setup data.

How can I exclude a business object from exporting?

You can exclude a business object from exporting by deselecting the Export column while creating the configuration package. However, business objects that are exported might have data dependencies on the excluded business objects, which may cause the setup data import of those business objects to fail. Therefore, be cautious when deciding to exclude business objects from the export process.

For a business object, scope values are selected by default if you selected any scope value when you performed a task to enter setup data, or if it's one of the application core tasks, such as task for defining profile options, which have predefined parameters to filter setup data. You can remove any of these preselected values from the configuration package, if appropriate, for export purposes. Similarly, you can also add more scope values to the configuration package if applicable for your export process.

How can I cancel an export or import process that I submitted?

You can cancel an export or import process from the Manage Export and Import Processes page. Select Cancel Process from the Actions menu on the Manage Export and Import Processes page. Once you confirm to cancel the process, it completes processing the business object that already started, doesn't process the remaining business objects. The process status is changed to Canceled, and you can't resume the process.

You can modify a configuration package only if its status displays Definition in progress. Once you submit the configuration package for export, or upload it for import, its status displays Locked. You can't modify a configuration package whose status displays Locked.