Welcome > Packages module > Work with packages > Import a package

Import a package

You can import entire package or the selected items to Kofax TotalAgility. When importing a package, all items from the selected ZIP file are displayed. The details of the item, such as item name, artifact, version, last modified date, value and action are also displayed.

Note You cannot import very large projects using Internet Explorer 9. Use Internet Explorer 10 and above to import large projects; a new browser window opens to improve performance.

You can import selected items from the package or individual items from each group in the package. The items in a package belong to the following groups:

  • Process

  • Form

  • DLLs

  • Resources

  • Data

  • Business Monitoring

  • System

  • Miscellaneous Files

  • Package

  • Integration

  • Devices

  • Export Connector

You can additionally include items based on the selected deployment configuration. During import, you can overwrite the values of items based on the selected deployment type.

Note the following:

  • If a deployment is not selected when importing the package, the package will have the deployments defined in the package while the values for global variables, server variables, web services, device settings and export connector settings are not overwritten.

  • If a deployment is not selected when importing selected items, the base values of the items are imported.

  • If a deployment is selected when importing the package, the package will have all the deployments defined along with the values overridden for the selected deployment type.

    Note When importing a package with a deployment type, the values for existing transformation settings are not overwritten but only additional transformation settings are added to the artefact list.

  • If a deployment is selected when importing selected items, only the values for the selected items are overridden with the values of selected deployment type. The values for the transformation settings are not overridden.

  1. On the Home page, click Packages > Import Packages.
    The Import Package page appears.
  2. Click Browse and select the ZIP file to import.
    All the items from the imported ZIP file appear in the table. By default, all the items including the global variables, server variables, web service references, device settings, and export connector mappings are selected regardless of the groups in the package. However, you can filter the items to display from a specific group. For example, to view only items from a process, on the Artifact list, select Process.
    Note

    • When importing a base package (this means, no deployment is selected and all the deployment configurations in the package were exported), all the deployment configurations settings defined in that package are displayed. You can update the values for the global variables, server variables, web services, device settings, and export connector settings, and then import the package.

    • When importing a package that was exported by selecting a specific deployment type, the deployment type is not imported, but the values for the deployment settings (global variables, server variables, web services, device settings, and export connector settings) are automatically overwritten and displayed in the table. However, you can update the values for the settings as applicable and then import the package.

  3. In the Form Import Options group, include or exclude the following import options (Default: No):

    • Security Tokens

    • Security Roles

    • Security Role Members

  4. You can choose to overwrite the values for all items (Roles, Server Variables, Global Variables, Web Service References, Existing Devices, Existing Device Profiles and the Existing Device Settings) or individual items. To overwrite values of all items at one go, do the following:
    1. In the Overwrite Options group, click Yes for Overwrite All. (Default: No)

      Automatically, Yes is selected for all the items.

    2. In the Artifacts table, under Action column, click Update for each item, modify the Value as needed and click Update.

      The values for the items that were defined when adding the deployment configuration to the package, are overwritten.

      Note To overwrite the values for individual items, see Steps 5, 6, 7, 8, and 9.
  5. To overwrite the value of a global variable on the existing target system, do the following:
    1. In the Overwrite Options group, click Yes for Global Variables. (Default: No)
    2. In the Artifacts table, under Action column, click Update for the item, modify the Value as needed and click Update.
      Note You cannot update the Complex and XML Expression variables. If the global variable does not exist on the target system, the global variable are added to the system with the provided value regardless of the overwrite setting for global variable.
  6. To overwrite the value of a server variable on the existing target system, do the following:
    1. In the Overwrite Options group, click Yes for Server Variables. (Default: No)
    2. In the Artifacts table, under Action column, click Update for the item, modify the value as needed and click Update.
      Note If the server variable does not exist on the target system, the server variable are added to the system with the provided value regardless of the overwrite setting for server variable.
  7. To overwrite the value of a web service reference on the existing target system, do the following:
    1. In the Overwrite Options group, click Yes for Web Services References. (Default: No)
    2. In the Artifacts table, under Action column, click Update.
    3. Change the value of URL, Endpoint URL, and User Credentials (Username and Password) as needed and click Update.
      Note If the web service reference does not exist on the target system, the web service reference is added to the system with the provided value regardless of the overwrite setting for web service reference.
  8. To overwrite the value of a device setting on the target system, in the Overwrite Options group, do the following:
    1. To overwrite and import data of all the devices, click Yes for Existing Devices. (Default: No. This means, only the devices that do not exist on the target system are imported.)
    2. To overwrite and import profiles data of all the devices, click Yes for Overwrite Existing Device Profiles. (Default: No. This means, only the device profiles that do not exist on the target system are imported.)
    3. To overwrite and import the settings of all the devices, click Yes for Overwrite Existing Device Settings. (Default: No. This means, only the custom advanced settings that do not exist on the target system are imported.)
    4. In the Artifacts table, under Action column, click Update for the setting to modify.

      The Update Device Overridable Settings page appears.

    5. Ensure that the IsOverridable checkbox is selected so that the setting is overridden.
    6. Change the Value, and click Update.

      For the device settings, such as webdav.trust.all.certificates, you can upload the certificate.

    7. Update the value for other device settings as required.

    The values of the device settings that were defined when adding the deployment configuration to the package, are overwritten.

    Note If the device setting does not exist on the target system, the device setting is added to the system with the provided value regardless of the overwrite settings.

  9. To overwrite the value of an export connector setting, in the Capture group, do the following:
    1. Click Yes for Connector Mappings. (Default: No)
    2. In the Artifacts table, under Action column, click Update for the connector mapping to update.

      The Edit Connector Mapping pop-up appears.

    3. Change the Value as needed.
    4. Select the Override check box.
    5. To update the same value for all the instances of the setting with the same connector type and property, select the Update {Property} value for all instances check box.
    6. Click Update.
    7. Update the value for other connector mappings as required.

    The values of the export connector settings that were defined when adding the deployment configuration to the package, are overwritten.

  10. In the Non-Versioned Items group, click Yes to Overwrite the non-versioned items that already exist on the target system (default: No) with the items contained in the package. The non-versioned items that can be overwritten include: Checklist, Lookups, Scan VRS Profiles, PDF Profiles, Separation Profiles, Note Types, Hotkeys, Work Types, Work Allocation Rules, Events, Targets, Alerts, Themes, Navigations, Sites, Miscellaneous Files, Document Templates, .NET References, Stylesheets, Images, Custom Pages, Localization Strings, Job Query, Work Queue Query, System Query, Personas, Page Renditions, Node Colors, Formatters and Reporting Tags.

    Note If you select to overwrite the non-versioned items, the existing rendition settings are overwritten by the settings included in the package. For example, if the target machine has Rendition 1 and Rendition 2 and the package has Rendition A and Rendition B, Rendition A and Rendition B are retained in the target machine. Otherwise, Rendition 1 and Rendition 2 are retained in the target machine.

  11. Select either option:
    1. To import the entire package, click Import Package.

      The import summary is displayed with any error or warning messages.

    2. To import selected items from the package, do either of the following:

    • On the list of All items, clear the check boxes for the items to exclude and click Import Selected Items.

    • To import selected items from a group, on the Artifact list, select the artifact, such as Process, clear the check boxes for the items to exclude and then click Import Selected Items.

      The import summary is displayed with any error or warning messages.

    Note

    • The entire package is only imported if its version is greater than the package version existing on the target system.

    • When importing selecting items from a package, and if the package contains a sub package, only the items selected from the main package and sub package are imported.

    • When importing a package, if the process version is same as the version that exists on the target system, the package is not imported. For example, if version 3 of a process within a package already exists in the target system.

    • If you select to import the entire package, all the items in the package are imported even if you choose to exclude few items from importing.

    • The Resource Extensions are saved to the System settings. If the target system already has extensions, imported ones are added.

    • If the package includes the resource group members, only the resources that do not exist on the target system are imported.

    • If the package includes the hotkeys, you must restart the IIS Application Pool for the hotkeys to work at runtime.