Importing configurations

Administrators can import packages that have been deployed to their Network instance.

Note: Before applying the imported package to the target environment, use the Ad Hoc Download (Settings > Configuration Export) to take a snapshot of your current configuration so that you can refer back to it in case there are issues with the imported configuration. The snapshot can help you to troubleshoot any issues.

To import a configuration package:

  1. In the Admin console, click Settings > Configuration Import.
  2. The Configuration Packages - Import page lists any packages that have been imported to your environment.

    The table contains the following information:

    Name - The package name.

    Signature - The unique identifier of the package. This consists of the Network instance ID and an incremental package ID.

    Source Environment - The instance where the configuration package was created.

    Created By - The user who created the configuration package in the source environment. This user might not exist on the target environment.

    Created At - The time that the package was created in the source environment.

    Processed By - The user who imported the package.

    Processed At - The time that the package was imported to the target environment.

    Status - The configuration package status. The status can be one of the following:

    • Pending - The package has been transferred to the target but has not yet been imported.
    • Completed - The package was imported.
    • Failed - The package failed to be imported to the target.

    Actions - The package can be downloaded.

  3. Click a package that is in Pending state.

    The package contains details about the configuration records that are included and what action will be taken during import.

    • Configuration Category - The configurations that were included in the package display in the table in the following categories:
      • Custom Objects - All of the custom object types (objects, sub-objects, and relationship objects).
      • Custom Fields- All custom fields associated to the custom objects.
      • Network Data Model - All Veeva standard fields and custom fields on Veeva objects, grouped by Veeva object.

      All of the standard feature configurations are listed by name in the table; for example; Data Maintenance, Profile Validation Rules, and so on.

    • Version columns - The feature version displays for each configuration category. The version in the package and the version in your target environment must be the same for the package to successfully import.
    • Import Action - Actions can be one of the following:
      • Add - Configuration records that do not exist in the target environment will be added.
      • Update - Configuration records that exist will be overridden.
      • Partial update - Some configuration records will be skipped or ignored, so they will have to be manually updated. For example, General Settings are typically partially updated because they contain feature flags that must be configured in the instance. When records are partially updated, you can see which records are skipped or ignored so that you can manually update them after the import.
      • Partial add – Some configuration properties are skipped during the add. For example, some single sign-on (SSO) settings are skipped.

      • Skipped - The complete configuration is skipped during the import. Configurations are skipped if the feature (for example, Concur) is enabled in the source environment but is not enabled in the target environment. The Concur settings will not be imported.

  4. Click Import.
  5. In the Confirm Import dialog, click Proceed.
  6. When the package is being processed the Status field updates to Active. You can monitor the progress using the Percent Complete field. Refresh the page to update this field; it does not automatically refresh. You can navigate to other pages in the Network UI when the package is processing.

    When the package is imported, the Status field updates to Completed and the Processed At and Processed By fields are populated.

Considerations during import

  • Failed records - if individual configuration records fail to be imported, the entire configuration package does not fail.
  • Feature version mismatch - If there is a mismatch between the versions in the configuration package and the environment, the Import button is dimmed and the package cannot be imported. Configurations must contain the same feature versions to be compatible.

    Feature versions change when there are significant enhancements to a feature. If there is a mismatch, wait until the target environment is updated (for example, if your source is a sandbox environment, wait until the target (production) environment is updated). Delete the configuration package and recreate it when the target environment is updated so the package contains any changes to the source environment

  • Feature version information can be found in the manifest.txt file in the configuration package.