Importing Packages

Learn how to import package.

Once the package has been exported as a .zip file, the .zip file needs to be imported on the production system.

Note: A package cannot be imported if a user is accessing the data model on the target system. A message is displayed if this is the case. During the import process, the data model on the target system is locked for editing and is only unlocked once the import is complete.

When importing records, records are matched up using the primary key. If the target database already contains records with the same key, these records are displayed in the Match-Up dialog, see Match-up . The station numbers therefore need to be different to prevent records added on the target station from being overwritten, as the record number is often part of the primary key.

Reps are matched up using the associated login. If a rep with the corresponding login is already present in the target database, the existing rep is retained and no new record is added. In this case, the rep record is updated with the imported rep record.

Exception: If reps are linked to the SU and WWW logins in the target database, the existing records are always retained and are not updated.

Note: When importing a package into a database that already contains data, ensure that the two station numbers are different. Records in the target database with the same key as imported record is otherwise overwritten!

To import a package:

  1. Copy the .zip file containing the package to the target system.
  2. Start CRM.cockpit on the target system and log in as SU.
  3. Select File > Import Package from .zip File from the menu.
  4. Select the .zip file containing the package.
  5. Confirm that you wish to import the package.

    The following dialog box is displayed:

  6. Enable Deploy web offline files to copy the files containing the '$WEB' placeholder to Aurea.CRM web offline's global patch directory. If you enable this option, all other options are unavailable and only the offline files are deployed, see Deploying Offline Files .
  7. Use the check boxes to determine which of the items included in the package are imported. You can choose whether to import core items (Aurea.CRM win items, such as formats, info areas etc.), designer units (for designer databases) and files (including directories):
    • Enable Import catalog maintenance items to import the catalog maintenance information and update catalogs on the target station based on the information in the catalog maintenance items, see Catalog Management and Automatic Catalog Maintenance in the Aurea.CRM win Administrator Guide. If the zip file contains catalog maintenance records, catalog values in the package are not imported and are ignored. These catalog values are not included in the import log and are not matched up. This prevents existing catalog values on the target station (which may since have been edited) from being overwritten.

      If the Import catalog maintenance items option is disabled, catalogs in the package are imported in full and overwrite the catalogs on the target station.

      For more information on managing catalogs, see Catalog Management and the CRM.core Administrator Guide.

    • Enable Import text table items to import items in the Text (04) info area into the database on the target station. The texts are imported automatically (without match-up) and overwrite any existing text entries with the same key.
    • Enable Import field help items to import all field help records in the .zip file and all text table entries referred to by the field help (even if Import text table items is disabled).
    • Enable Files to import the files and directories in the package.
  8. Enable the Update CRM.designer option to update the CRM.designer database with the current data model, catalogs, CRM processes (R4) and roles (R2) . This option is only available if a connection to the CRM.designer database was established.
    Note: Field labels, catalog values etc. in CRM.designer are updated in the language selected by the user performing the import. If you do not enable the Update CRM.designer option, the data model, catalogs, CRM processes and roles in the CRM.designer database are not updated when importing designer items. This option can be specified in the import XML file in the UpdateCRMDesigner node.

    Select how to synchronize catalog values:

    • Synchronize changed or new catalogs: Any catalogs values that are added or updated by the import process are synchronized with CRM.designer.
    • Synchronize only existing catalogs: Only existing catalog values are updated by the import process and synchronized with CRM.designer. You can choose how to match up existing catalog values:
      • Synchronize catalogs by default text and tenant no: Catalog values in the package are matched up with catalog values in the target CRM.designer database by the value in the catalog base language and tenant number.
      • Synchronize catalogs using the external key: Catalog values in the package are matched up with catalog values in the target CRM.designer database using the catalog value's external key.
      Note: Note: When importing via the command line, you can specify the synchronization option in the import XML file in the CatalogSyncMode node. If no value is specified in the XML file, catalog values are matched up by text and tenant number.
    • Do not synchronize catalogs: No catalogs are updated in the CRM.designer database.
  9. If you enable the Files option and your package contains files or directories whose target directory includes a placeholder, you need to enter the directory to replace the placeholder with.

    Click on ... in the Select Destination Folder column to select the target directory for the corresponding placeholder.

    If you do not select a directory for a placeholder, any files using that placeholder are not imported.

  10. Click on Next.
  11. If you are upgrading an existing package (i.e. importing the package over an older version of the same package), you may need to determine which items should be stored in the database, if items have been edited, see Match-up .
  12. Click on Next.

    A summary of your settings is displayed.

  13. Verify your settings, and click on Start writing to Database.

    The package is imported into the database. The process may take several stages to complete, as certain information needs to be imported before other related information.

    A message is displayed informing you of whether the import was successful or not.

  14. If you have imported a package containing the data model into Aurea.CRM web, you need to recycle the application pool, see Recycling the Application Pool (Aurea.CRM web) .

You can cancel the ongoing import process by clicking on Cancel. If you cancel the import process, those items that have already been written to the database are not removed.

Note: Triggers and workflows are disabled when importing data in CRM.cockpit.Changes made to the database during the import process are logged in the Process Tracking (T3) info area. This locks the CRM.cockpit import and data model process and no other imports can be performed on the station and the data model cannot be edited until the current import has ended (and the process is unlocked). The process tracking records for CRM.cockpit contain "cockpit Import" in the Process field. The Text field contains information on the name of the template, the items that were imported and information concerning the import (partial successes etc.). For more details on the Process Tracking info area, see Process Tracking in the CRM.core Administrator Guide. If an import fails to complete (successfully or unsuccessfully), the import process continues to be locked. To unlock the process, uss the repair option, see Troubleshooting .