apn-app-manager

Node.js: apn-app-manager

apn-app-manager is a command line tool that ingests an Appian application zip file, makes changes to the underlying XML files, and outputs a new Appian application zip file. It currently supports cloning an application.

Why?

When app building you may want to do things in bulk that are easiest to do via an application's exported XML files and a re-import. This tool helps to automate some of those tasks.

Disclaimer

The functionality provided by this tool is not supported, nor endorsed by Appian. It is merely a community tool to manipulate XML files following strict rules. The structure of these XML files may change between Appian platform releases, and those changes may break this tool.

Importing an application export modified by this tool should be done at your own discretion.

Latest compatible Appian platform version tested against: 25.2.

Installation

• Download and install the latest version of node if you don't already have it.
• Globally install or upgrade on your local machine in your favorite command-line terminal via command .
  • npm i -g apn-app-manager
• Check installation or your current version of this tool by running npm list -g.
• After installing, you should have access to the command apn globally in your terminal.
  • If this command is not recognized, you will need to troubleshoot. Since this is machine-specific, it's something you can Google related to the npm "prefix" config. To fix this, the command is npm config set prefix _, where the _ is specific to your operating system. Here are helpful links to troubleshoot for Windows and Mac.

Usage

• Download any Appian application zip and navigate to the folder containing the download in your favorite command-line terminal.
• Run the command apn and follow the prompts to modify the application.

Currently this tool only supports cloning applications, although more functionality may come in future releases.

Cloning

Used to duplicate all objects of an application, which replaces the namespace of each object with a new namespace and generates unique UUIDs for each new object.

Steps

• Run the command apn in a folder containing your exported application zip.
• Select clone for "What would you like to do?".
• Choose advanced options or not:
  • Regular options:
    • Select your application zip.
    • Select your import customization properties file, if you have one.
    • Enter your current namespace.
    • Enter your new namespace.
      • For example, an application with objects such as SMP APP Artifacts and SMP_APP_displayUser would have a namespace of SMP_APP
      • Note that this tool can only clone objects of one namepsace at a time with regular options.
  • Advanced options:
    • Select your application or package zip you wish to clone.
    • If cloning a package which is part of an application which is already cloned in the target environment, select the zip file(s) that your package from the first step contains references to, to ensure all references to objects not in the package are remapped. Use the same namespace configuration you did on the application(s) which were already cloned.
    • Select your import customization properties file, if you have one.
    • The tool will search through all object files and attempt to find every unique namespace, allowing you to specify cloning logic for each namepsace.
    • Select whether you want database table names (within CDTs and records) to be renamed or not during cloning.
• Access your cloned application in the generated /out/ folder.

Notes

• Always inspect your cloned zip before importing to verify that what will be imported matches what you'd expect.
• The cloning tool is idempotent meaning it will always return the same output zip run against the same input. This also means you can develop an application, clone it, then enhance the original application, re-clone it, and that second clone will deploy over the first clone with objects being recognized as "Changed" as if you had just modified the clone directly.
• SQL files for your application are not supported for cloning at this time. SQL scripts will have to be adjusted manually to align with the cloned objects (i.e. changing table name references).
• There are some other documents generated in the /out/ folder after cloning:
  • objects.json - This contains every attribute of collected metadata from every object in the package, including its current value and new value.
  • not-cloned-uuids.json - Warnings may appear during cloning about UUIDs in the package that the tool didn't know how to handle, which will be listed in this file. If no warnings appeared, this file will be empty. Generally these can be ignored if your inspection looks good, however these may be actual issues that come up due to XML structure changes in future Appian platform releases. Please reach out to the authors of this tool if you have any questions about this.
  • namespaces.json - This contains a mapping of old-to-new namespaces used when cloning.
  • problem-terms.json - Only output if problem terms were identified. This contains a mapping of problem words, where they were found, and what decision was made for them.
  • composer/ - This directory contains a JSON file for each application which has "Composer/Requirements/Plan" of the requirementsCaptureB64 node in JSON format.

License

Licensed under Apache 2.0