› Import › Import a package

Import a package

For a recommended approach to the automated import of packages, see "Automated export and import of packages" in the Kofax TotalAgility Best Practices Guide.

You can import all items within a package, import selected items from the package, or import individual items from each group (Artifact) in the package. The items in a package belong to the following groups:

  • All

  • Capture

  • Custom service groups

  • Devices

  • Export Connector

  • Integration

  • Miscellaneous Files

  • Monitoring

  • Packages

  • Queries

  • Resources

  • System

  • System data

  • User interface

  • Workflow

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.

If a deployment is selected

If a deployment is not selected

When importing the package, the package will have all the deployments defined along with the values overridden for the selected deployment type.

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.

When importing selected items, only the values for the selected items are overridden with the values of the selected deployment type. The values for the transformation settings are not overridden.

When importing selected items, the base values of the items are imported.

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 artifact list.

For more information on the items that are included or not included see Additional information on importing a package.

  1. Navigate to Import.
  2. Click Browse and select the package zip file to import, or drag the zip file to the File to import field.

    All the artifacts from the selected package are displayed in two views.

    • Main view: This tab displays all the items including the global variables, server variables, web service references, custom services, custom service groups, category, field validators, device settings, and export connector mappings selected regardless of the groups in the package. You can choose to exclude the items to import by clearing the check box for those items. You can further filter the list to display items from a specific group. For example, to view only processes, case definitions, business rules, skins, and custom services, on the Artifact list, select Workflow.

    • Overview: This tab displays all the items selected in the Main view along with their associated items which are to be imported. If items are deselected in the Main view, their associated items are also deselected in the Overview. You cannot add or remove items on the Overview tab; however, you can filter on items.

  3. You can choose to overwrite the values for individual items or all items.

  4. You can overwrite the non-versioned items.
  5. You can import the entire package or import selected items from the package or import selected items from a specific group.

    To import the entire package Click Import.

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

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

    All the items in the package are imported even if you choose to exclude a few items from importing.

    To import the selected items from the package

    You can clear the check boxes for the items to exclude and click Import selected items.

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

    If the package contains a sub-package, only the items selected from the main package and sub-package are imported.

    To import selected items from a specific group

    On the Artifact list, select the artifact, such as Workflow, 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.

    If you have selected the Allow solution rollback system setting and if any error occurs on import, the Rollback solution button appears. To roll back the solution, click Rollback solution. The solution is rolled back. For more information on items that can be rolled back, see Solution rollback items.

    If any error occurs during rollback, you can Retry or Cancel the solution rollback. An audit log entry is added for the solution rollback.

Exclude associations

To exclude the associations while importing the selected items from a package, do the following:

  1. Select Do not import associations. (Default: Clear)

    A warning message is displayed, stating: "Please be aware that selecting this option may result in unexpected behavior on the target system."

  2. Click OK.
  3. Click Import selected items.

    The selected items from the package are imported without any associations.

Include or exclude import options

In the Form import options group, you can include the following import options (Default: Clear):

  • Security tokens

  • Security roles

  • Security role members

Overwrite the values of individual items or all items

You can choose to overwrite the values for all items or individual items (Role members, Server variables, Global variables, Web service references, Devices, Device profiles, and the Device settings.)

Overwrite the values for all items

You can choose to overwrite the values for all items. In the Overwrite options group, do the following:

  1. Select Overwrite all. (Default: Clear)

    Automatically, all the items are selected.

  2. In the Artifacts table, under the 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.

Overwrite the values for a global or server variable

To overwrite the value of a global or server variable on the existing target system. In the Overwrite options group, do the following:

  1. Select Global variables or Server variables. (Default: Clear)
  2. In the Artifacts table, under the Action column, click Update for the variable, modify the Value as needed and click Update.
    You cannot update the Complex and XML Expression variables. If the global variable/ server variable does not exist on the target system, the variable is added to the system with the provided value regardless of the overwrite variable setting.

Overwrite the value of a web service reference

You can overwrite the value of a web service reference on the existing target system. In the Overwrite options group, do the following:

  1. Select Web service references. (Default: Clear)
  2. In the Artifacts table, under the Action column, click Update.
  3. Change the value of URL, Endpoint URL, and User credentials (Username and Password) as needed and click Update.
    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 the web service reference.

Overwrite the value of device settings

You can overwrite the value of devices, device profiles, and device settings on the target system. In the Overwrite options group, do the following:

  1. To overwrite and import data of all the devices, select Devices. (Default: Clear. This means that only the devices that do not exist on the target system are imported.)
  2. To overwrite and import profile data of all the devices, select Device profiles. (Default: Clear. This means that 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, select Device settings. (Default: Clear. This means that only the custom advanced settings that do not exist on the target system are imported.)
  4. In the Artifacts table, under the Action column, click Update for the setting to modify.
  5. Ensure that the Is overridable check box 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.

    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.

Overwrite the value of connector mappings

You can overwrite the value of an export connector setting. In the Capture group, do the following:

  1. Select Connector mappings. (Default: Clear)
  2. In the Artifacts table, under the Action column, click Update for the connector mapping to update.
  3. Change the Value as needed.
  4. Select Override.
  5. To update the same value for all the instances of the setting with the same connector type and property, select Update '{0}' value for all instances with the same value.
  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.

Overwrite the non-versioned items

You can 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, Page renditions, Stylesheets, Images, Custom pages, Localization strings, Job query, Work queue query, System query, Personas, Node colors, Formatters, Import sources, Import connections, Reporting tags, and any OAuth servers associated with processes or forms.

Any 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.

To overwrite the non-versioned items, in the Non-versioned items group, select Overwrite.

Import the import connections and import sources

You can import the import connections and import sources. If an import source does not have an import connection, you must add an import connection before importing. If required, you can also modify the import connection for an import source. Do the following:

  1. Select the required import sources in the Artifacts table to update.
  2. Optional. To change/add the import connection for an import source, under the Action column, click Update. Select the required Import connection and click Update.

    You cannot import an import source for which the "Import connection" field is blank.

  3. Update the other import sources as required.

Import the associated OAuth servers

When you import a process map or a form that has a RESTful web service type with OAuth 2.0 authentication, you can also import the associated OAuth servers.

  1. Select the required OAuth servers in the Artifacts table.
  2. Under the Action column, click Update. Specify Client ID and Client secret.
  3. Update all the OAuth servers as required.

    Edit the OAuth servers after importing and authorize them to generate valid access tokens.

How to: