Welcome > Packages module > Create a package

Create a package

See Packages.

  1. On the Home page, click Packages > Package.
    The Package page appears.
  2. On the General tab, configure the package properties.
  3. Enter a Name for the package.
  4. Enter a Description for the package.
  5. Consume a Category for the package. (Default: Working category)
  6. In the Comments box, enter the version number for the package.
  7. By default, all the associated items from the selected processes are added to the package. To include only the selected items from processes, click No for Include items associated with processes.

    • The package does not include the following items associated with processes:

      • Category for all

      • Job Creation form

      • Members of group

      • Alerts

      • Process and work type for the work allocation rule

    • Resources configured for functional and maintenance access are not automatically included in a package. You must manually add them to the package.
    • If you select to include the items associated with processes, the Include Role Members option becomes available.
  8. To add role members to the package, click Yes for Include Role Members. (Default is No for a new package, and Yes for an existing package created using a previous version, in which include items associated with processes is set to Yes).
  9. By default, all the associated items from forms are added to the package. To include only selected items from forms in a package, click No for Include items associated with forms.

    A package does not include the following items associated with forms:

    • Category for all

    • Resources (worker and group)

    • Job queries

    • Work Queue queries

    • Currency codes

    • Form, Resources (worker and groups) and global variables for the Navigation menu

    • Theme, Form, and Navigation for a site

  10. To include the data of devices that are registered in the TotalAgility Device Manager in the Kofax Front Office Server package XML, click Yes for Include Devices . (Default: No)
  11. To include all the items from a category and its subcategories to the package, click Yes for Include items associated with categories. (Default: No).
    Note Only subcategories for which you have access are included in the package.
  12. To include information of all the device profiles listed on the TotalAgility Device Manager in the Kofax Front Office Server package XML, click Yes for Include Device Profiles. (Default: No)
  13. To protect the entire package, click Yes for Protect all items in the package (Default: No). A message is displayed. Click either of the following:
    • Yes: All the items within the package are protected and you cannot unprotect any item within that package.
    • No: None of the items within the package are protected and you can individually protect the items in Package Overview.
  14. To include the information of general and advanced settings of the TotalAgility Device Manager in the Kofax Front Office Server package XML, click Yes for Include Device Settings. (Default: No)
  15. To include items in a package, click the relevant tab and consume the required items.

    Export options, if applicable, are displayed for the item. You can include or exclude the export options, as needed.

  16. On the Processes tab:
    1. Consume the required Processes (case, case fragments, and templates) and Business Rules.
    2. Include or exclude the following export options:

      • Generalized Export (default: No).

      • .NET References with Path (default: Yes).

      • Template Skins (default: No). If you select to export template skins, all skins associated with the selected template are exported with the template.

      • Document, Folder, Classification Project Data (Default: Yes).

        Note If you set the Document, Folder, Classification Project Data option to No, the Transformation Designer project data associated with the process is not included in the package.
      • Connector Mappings: (default: No). If you select to export, the connector mappings are exported along with the process in the package.
  17. On the Forms tab:
    1. Consume the required Forms, Custom Pages, Images, Navigation Menus, Sites, Style Sheets, Themes, and Form Templates.
    2. Include or exclude the following export options (Default: No):

      • Global Variables (Default: Yes)

      • Web Services

      • Security Tokens

      • Security Roles (If this option is set to Yes, the role members are automatically added to the package)

  18. On the DLLs tab, consume the required .NET Assemblies.

    The package does not include categories associated with DLLs.

  19. On the Resources tab:
    1. Consume the required Resources, Group, Work Allocation Rules, and Personas.

      When you consume a group, the members of the group are not added to the package. However, when you consume a process with an associated group and include associated items, only the group is added to the Resources tab. The members of the group are not added to the package.

    2. Include the following export options (default: No):

      • Resource Extensions

      • Group Resource Members: The associated group members are included in the package for the selected group and the group associated with the process.

    Note A package does not include the following items associated with resources: Category for all, External resources, Personas, Supervisor resource and members (worker resources and group resources) for Group resource, Supervisor, Persona, Working group, and associated groups for Worker resource. You cannot consume security roles in a package.
  20. On the Data tab, consume the required Checklist Templates, Checklist Items, Classification Groups, Document Templates, Entities, Extraction Groups, Folders, Formatters, Lookups, Regular Expressions, Job Queries, Work Queue Queries and System Queries.

    The package does not include the following items associated with data:

    • Category for all

    • Currency Codes

    • Resources (workers and groups) and Processes for Entity

    • Resources (workers and groups) and Forms for Extraction Groups

    • Resources (workers and groups) and Forms for Folder Type

    • Resources (workers or groups) and Process for Job Query and Work Queue Query

    • Cannot consume server variables in definition

    When you import a package, the Job, Work Queue, and System Queries are overwritten only if the Overwrite Non-versioned items option is set to Yes.

  21. On the Business Monitoring tab, consume the required Alerts, Events and Targets.

    The package does not include categories associated with alerts, events and targets.

  22. On the System tab:
    1. Consume the required Categories, Job Schedules, PDF Generation Profiles, Scan/VRS Profiles and Separation Profiles.
    2. Include or exclude the following export options. (Default: No)

      • Note Types

      • Hotkeys

      • Page Renditions

      • Node Colors

      • Reporting Tags

    A package does not include the following items associated with the system:

    • Category for all

    • Parent category and Resources (workers and groups) for Category

    • Process and Server Variables for Job Schedule

  23. On the Miscellaneous Files tab, consume the additional items (supported documents) to include in the package. See Add additional items to a package.
  24. On the Packages tab, consume a sub package to include in the package.
  25. To search for the items modified since a specific time period and add to the package, do the following:
    1. Click Search.
      The Search page appears where you can define the search criteria.
    2. Consume the Category of the package in which to search.
    3. On the Artifact list, select the artifact type, such as Process. (Default: All).
    4. On the Modified Date list, select the time period to search.
      You can search for items modified since a specific date time, between certain dates, today (from 00.01 to current time), one week (last seven days), this month (from the first of the selected month to current date) and this year (from January 1 to current date). (Default: One Week)
    5. Specify the date and time using the Calendar and Time Picker.
    6. Click Search.
      The artifacts created during the selected period are displayed in the table.
    7. Select one, multiple, or all artifacts to add to the package and click OK.
      The selected artifacts are added to the respective tabs in the Package page.
      Note The PDF Generation, Scan/VRS, and Separation profiles from the search are not included in the package, if "Include items associated with categories" is set to Yes.
  26. To access the package in different languages at runtime:
    1. Click Select Languages.
      The Languages page appears.
    2. Select the required languages and click Close.

      The selected languages are added to the list.

      Note To select all the available languages, click All.
  27. To view the items included in your package:
    1. Click Package Overview.

      The Package Overview page appears and lists all items included in your package. The total count of items and the count of items grouped by tabs is also displayed.

    2. To view items selected from the individual tab, on the Artifact list, select the artifact, such as Process.

      A list appears with all items included in your package from this tab. The total count of items from the selected tab is displayed.

    3. To protect an individual artifact, select the Protected check box for the artifact.
    4. Click Close.

      The Package Overview page is closed.

  28. To save the package, select either option on the Packages Action bar:

    • Save : Saves the package.

    • Save & Export Save and Release: Saves and then exports the package.

      • To export the base package, click OK and click Yes.

      • To export a specific deployment type, on the Deployment list, select the deployment type and click OK and click Yes.

      The package is downloaded.

    The newly created package appears on the Explorer, in the Packages list.