Exporting Packs

When you export a Pack, make sure that the metadata contains the correct values. Increase the version number with subsequent releases to differentiate between versions.

To Export an Action Pack

  1. Go to the Process Assembly perspective and open the Packs view.

  2. Right-click the Action Pack and select Export.

  3. On the Export Pack window, select Export to validate and build the Pack automatically.

  4. Select Download to download the Pack and select a destination.

    A semantic check is performed before exporting the Action Pack, thus ensuring that the Actions are defined correctly. The following properties are checked:

    • Generate Job at = Runtime
    • Deactivate on Finish = After error-free execution.
    • Error-free status = ANY_OK
    • Overwrite Agent's value = “&AGENT#“ or leave it empty

You administrator can configure the export method in the PACKS_COMPATIBILITY_MODE parameter of the UC_CLIENT_SETTINGS (see, UC_CLIENT_SETTINGS - Various Client Settings).

To Download a Pack to a Working Directory

Important! A package.yml file must exist in the current working directory. If it does not exist, call apm init <pack_name> to create it.

To download the Pack, enter

apm download [option]

Where [option] can be one of the following:

  • --force-overwrite

    Objects which already exist in the local file system will be overwritten with content from the AE client.

    Short:-force

    Default: false.

  • --include-appdata

    Download also the AppData folder.

    Short:-ia

    Default: false.

  • --remove-unused

    Remove unused files which do not have matching objects in the working directory.

    Short:-ru

    Default: false.

  • --compatibility-mode

    Enter this option if you want to download the Pack with the old structure (.xml).

    Short: -cm

    Default: false. Pack with new structure is downloaded (.json)