Installing Packs

Action Packs can be imported and exported in two different formats:

  • .xml and
  • .json.

Your administrator can define which format to use either in the PACKS_COMPATIBILITY_MODE parameter of the UC_CLIENT_SETTINGS or by adding the corresponding option in the apm download command (Package Manager).

Restricted Action Packs

The following Action Packs are for restricted use and can only be installed/updated from a file:

  • PCK.AUTOMIC_CA_ENDEVOR
  • PCK.AUTOMIC_EXCEL
  • PCK.AUTOMIC_IBM_ZOS
  • PCK.AUTOMIC_SIEBEL
  • PCK.AUTOMIC_TEMENOS_T24_CD
  • PCK.AUTOMIC_TEMENOS_T24
  • PCK.AUTOMIC_VSS

To Download and Install a Pack from the Marketplace (Automic Web Interface)

  1. Open the Administration perspective.
  2. Select the Packs tab.
  3. Select one or more Packs from the list.
  4. Click the Install button in the toolbar. The Packs are downloaded from https://marketplace.automic.com/
  5. Select the Ignore dependencies checkbox if you want to ignore possible dependencies to other Packs.

Note: This method can only be used to install Packs that are available in the GIT index. For more information, see the list of Installing Packs.

To Install a Pack from a File (Automic Web Interface)

  1. Download the Pack you want to install from https://marketplace.automic.com/ and save it to a local folder.

    Note: To find the Action Packs on the Marketplace, search for their descriptive names (for example: JSON Action Pack).

  2. Go to the Administration perspective.
  3. Select the Packs tab.
  4. Click the Install from File button in the toolbar.
  5. Click the Upload button, navigate to the location where you have downloaded the Pack (.zip file), and follow the wizard instructions.
  6. Select the Ignore dependencies checkbox if you want to ignore possible dependencies to other Packs.

When the installation is complete, the new Action Pack can be found in the PACKAGES folder of the Process Assembly perspective.

To Install a Pack Using the Command Line Interface (CLI)

  • To install a Pack from your local file system, enter

    apm install [option] <pack name>

    where [option] can be one of the following:

    • --force

      Force installation if the versions in the metadata and the index are inconsistent.

      Default: false.

    • --from-file

      Path to the local archive or directory containing the Pack to install

    • --ignore-dependencies

      Ignore dependency Packs. Use this flag to install Packs without the dependency check.

      Default: false.

    • --remote-user

      Username of the remote repository

    • --remote-password

      Password of the remote repository

  • To install a Pack from a file, enter

    apm install --from-file <path to the pack archive or directory>

To install multiple Packs, leave a blank space between the names of the Packs.

Examples

  • Single Pack installation

    apm install --from-file C:\Pack.Bond_PCK.AUTOMIC_BOND_1_0_0+build.164.zip

  • Multiple Pack installation

    apm install PCK.AUTOMIC_HTTP PCK.AUTOMIC_FTP -H automicdev -S AUTOMIC -p 1234 -c 123

To Upload a Pack Using the Command Line Interface (CLI)

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

You upload Packs from a working directory using the following command:

apm upload [option]

Where [option] can be one of the following:

  • --force-overwrite

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

    Short:-force

    Default: false.

  • --ignore-dependencies

    Package dependencies are ignored.

  • --include-appdata

    Upload also the AppData folder.

    Short:-ia

    Default: false.

  • --no-binary

    Upload all objects except binary objects.

    Short:-nb

    Default: false.

  • --no-content

    Upload binary objects that are defined in the Pack config only.

    Short:-nc

  • --remote-password

    Password of remote repository. Rrequired in case dependency packs need to be downloaded and installed before the current pack is installed.

  • --remote-user

    Username of remote repository. Required in case dependency packs need to be downloaded and installed before the current pack is installed.

  • --remove-unused

    Remove unused files which do not have matching objects in the AE client.

    Short:-ru

    Default: false.

  • --compatibility-mode

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

    Short: -cm

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