Automated Import Manager (AIM) Client

 

The features provided by this utility are now available out of the box (OOTB) in Appian versions 23.2+. For more information, refer to the Deployment APIs documentation.

Overview

This utility automates the process of inspecting the application, executing DDL scripts, updating CDTs, republishing the appropriate datastores, and importing the application.

With the Automated Import Manager Client, users can automatically deploy applications and package contents (either applications from Appian OR packages generated from the Automated Versioning Manager) to any environment. This utility provides the scripts that support triggering deployments from an external CI tool or deploy from the command line.

Key Features & Functionality

Automated Import Manager:

  • Inspect Application: This tool will automatically mimic the "Inspect" functionality that exists within Appian
  • Validating Application Content: In addition to inspecting the application, the tool will ensure all CDT dependents are included to avoid objects pointing to older versions. (This feature is only available on Appian 7.9 and above)
  • Execute DDL Scripts: DDL scripts can be uploaded and automatically executed. NOTE: For Microsoft SQL Server, only Transact-SQL statements are valid.
  • Execute Migrations with Flyway: Flyway is a tool used for managing database migrations. It makes it easier to track SQL script versions and not re-execute SQL scripts that have already been run. If a Flyway directory is provided, the Automated Import Manager will automatically execute migrations against the corresponding datasource. Learn more about Flyway here.
  • Update CDTs: Users are no longer required to delete CDTs before updating them, this tool will perform this step automatically
  • Import Application and admin console configuration: Automatically import an application with an optional customization file
  • Republish Datastores: After application import, datastores will be automatically published or republished
  • Add Patches: Automatically add patch contents to a specified existing application

For more information, please see visit: https://community.appian.com/w/the-appian-playbook/198/deployment-automation

Note: This utility does not support Java version 9.0. 

Anonymous
  • I use ssh key to get access to my GitLab repository and not a username and password. When I use the versioning-client I get an Auth fail when try to push contents to my repository.

    Details of error:                                                                                                
    org.eclipse.jgit.api.errors.TransportException: git@gitlab.my-git-details.git: Auth fail  

    I have gotten this to work on Linux, but not Windows. Most of our users are on Windows so this is an issue. Has anybody else experienced this?

  • I am having a similar issue to what sneham0002 said. The only difference is I'm exporting an excel file instead of the DDL files in the patch.

    Has anyone found a solution to this?

  • While trying the buildSingleApp action does it consider packaging the DDL file in the package?

    I am unable to deploy the application using the deployment Automation web UI, as the package generated by AVM is not containing the ddl files to execute, but the metadata property file refers to ddl file and the deployment fails because of the same.

  • - I suggest posting in community.appian.com/.../ as you'll get more visibility there.

  • Can anyone give the demo ? As it is not working as expected .

  • v2.5.3 (Update on 09 Nov 18)

    * Enhancements

        * Created a reset command for Remote Automated Deployment Manager

    * Bug Fixes

        * Version and Import Metrics Logger Initialized correctly to fix null pointer exception

  • v2.5.2 (Update on 16 Oct 2018)

    * Enhancements

        * Folder listener to auto trigger “Add Contents” action

        * Field validation for import and versioning manager properties files

        * Usage metrics collection to better understand tool use

        * Updated error log messages

    * Bug Fixes

        * ADM UI: Handle apostrophes in app name

        * ZIP type validation for Automated Import Manager

  • v2.5.1 (Update on 17 Sep 2018)

    * Enhancements

       * New BuildMultipleApps action

       * Check version of tools with -v or -version flags

    * Bug Fixes

       * Fixed ADM SQL errors with non-null statements and forward slash as delimiters

  • v2.5.0

    * Enhancements

       * Added Flyway DB version control tool to command line and AIM GUI

       * Allow import of DDL scripts or Flyway scripts without an application zip or patch zip

       * Added Folder Listener script that will run addContents automatically when a file is dropped into a folder

    * Bug Fixes

       * Added buildAllApps to list of approved actions

       * Set inspect_only properly in AIM

       * Fixed bug where repo would be cloned into a folder with an incorrect name

       * Passed in correct authentication token for buildAllApps and buildSingleApp

  • v2.4.7

    * Enhancements

       * Added buildSingleApp action to extract one app from multi app repo

       * Renamed buildPackage to buildAllApps to better clarify the functionality

    * Bug Fixes

       * Fixed miscellaneous issues with parsing SQL in DDL file

       * Mark/reset issue with large customization files