The CIS Toolkit

This page provides an introduction to the Caplin Integration Suite (CIS) Toolkit, a command line tool for creating new integration adapter projects and packing them as Caplin Platform Blades.

Requirements

The CIS Toolkit requires Oracle Java 8, with the JAVA_HOME environment variable set to the root directory of the Java installation.

The CIS Toolkit can be run from a Bash shell or a Microsoft Windows shell.

Note: if you run the CIS Toolkit on Cygwin, then supply Microsoft Windows file paths to CIS Toolkit command arguments that specify a file path.

Accessing the CIS Toolkit

Unpack the Caplin Integration Suite ZIP file to a directory under your home directory.

The CIS Toolkit is a Jar file, cis-blade-toolkit-version.jar, in the tools directory of the Caplin Integration Suite.

Using CIS Toolkit commands

The CIS Toolkit takes the following syntax:

java -jar cis-blade-toolkit-version.jar command [argument] …

The Toolkit supports four commands:

  • create: creates a new blade project.
  • build: compiles the Java source code of your project into class files, ready to be exported.
  • export: bundles your Java classes into a JAR file, and then packs all the necessary code, APIs, and configuration files into a zipped blade kit, which can then be deployed using the Caplin Deployment Framework.
  • run: runs your blade on your local PC while you are still developing it (i.e. before you export and deploy it).  Once you blade is running, you can stop it from within the command line interface using CTRL+C.

Not all commands have arguments, and they are not always compulsory for those that do.

Example: creating a new project

The create command below creates a new blade project called 'MyNewBlade'.

java -jar cis-blade-toolkit-6.0.1-255011368.jar  create  -n MyNewBlade  -k ../../CaplinIntegrationSuite/  -i alerts permissioning

The create command doesn't have a main argument, so all the parameters are provided by options (flags).

  • The -n option specifies the name of the blade as 'MyNewBlade'.

    Note: The name of the blade will be used as the name of the blade's main Java class, and so the name must be in upper camel-case, in accordance with Java class naming conventions.

  • The -k option specifies the path to the root of the Caplin Integration Suite as '../../CaplinIntegrationSuite'.
  • The -i option specifies the integration APIs to include in the project as 'alerts permissioning'. This includes the Alerts API and the Permissioning API.