Add a deployment configuration to a package

Define deployment configuration for a package by updating the base values of server variables, global variables, web service integrations, device settings (Kofax Front Office Server settings), transformation settings, and export connector settings for a deployment target, such as the production environment.

  1. Navigate to Packages > Packages.
    The Packages page appears.
  2. Open the package for which to add a deployment configuration.

    The package opens in a new browser tab.

  3. Click the Deployment configuration tab and click New.

    The New deployment dialog box is displayed.

  4. Enter a Name for the deployment package.
  5. Optional. Enter a Description for the deployment package.
  6. Under Configuration, the server variables, global variables, web service integrations, device settings (Kofax Front Office Server settings), transformation settings, and export connector settings configured with the package are displayed. To define a different value for a setting, click the tab and modify the corresponding settings as needed.

    Tab

    Description

    Server variables and Global variables

    1. On the list of server variables/global variables, select the setting to modify and click . Alternatively, double-click the item to edit.

      The Update dialog box is displayed.

    2. Change the Value as needed and click Update.

    Web services

    1. On the list of web services, select the web service to update and click .

      The Update dialog box is displayed.

    2. Change the URL that references the web service.

    3. To change the web service execution location without regenerating the web service proxy DLLs, click Yes for Endpoint URL and enter the endpoint URL.

      The Endpoint URL must be the location of the web service and not the WSDL link. Use an Endpoint URL only for SOAP and WCF. Endpoint URL does not support RESTful web services.
    4. To control access to the web service and not just restrict access to the configured TotalAgility Enterprise services account, click Yes for User credentials and enter the Username and Password.

    5. Click Update.

    Device settings

    This tab displays the device settings that can be overridden and their default values. These settings may be different between deployment targets.

    1. Select the device setting to update and click .

      The Update dialog box is displayed.

    2. Keep the Override checkbox selected and change the Value as needed.

    3. Click Update.

    Transformation settings

    This tab displays the Transformation settings that can be overridden and their default values. These settings may be different between deployment targets.

    Include training sets: Includes the training sets when a package is created for a certain deployment. (Default: Selected)

    To edit the setting:

    1. Select the Transformation setting to update and click .

      The Update dialog box is displayed.

    2. Change the Value as needed and click Update.

    Export connectors

    This tab displays the export connector settings that can be overridden and their default values. These settings may be different between deployment targets.

    1. Select the export connector setting to update and click .

      The Update dialog box is displayed.

    2. Change the Value as needed.

      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.

    3. Click Update.

    The updated settings appear in blue.

  7. Click OK.

    The deployment configuration name appears on the list.

  8. Click Save.

    The deployment configuration is saved with the package.

Maintain a deployment package

You can edit or delete a deployment package.

  1. Navigate to Packages > Packages.
    The Packages page appears.
  2. Open the package for which a deployment configuration is to be edited or deleted.

    The package opens in a new browser tab.

  3. Click the Deployment configuration tab.
    • To modify the deployment configuration, perform the following steps:

      1. On the list of deployment configurations, click the deployment configuration to edit.

        The Edit deployment dialog box is displayed.

      2. Make changes to the settings as needed.

      3. Click OK.

    • To delete a deployment configuration, perform the following steps:

      1. On the context menu of the deployment configuration to delete, click Delete.

      2. On confirmation, the deployment configuration is deleted.