Getting Started

Note: In the future, the idea is that Jazz can be used as a real self-service platform, in which users with none technical skills can use configure their integration packages by themselves. However, at this moment, the user interface for Jazz Task Runner is still a Work in Progress, so that, the only way to use Jazz is through the command line tool, which is described below.

Running the package as a local project

Initiate a project:

Create a directory to your project and enter on the directory:

mkdir hello-jazz && cd jazz-hello

Initiate a new node project (use --yes to use the default options):

npm init --yes

Install jazz core engine using npm:

npm install jazz-core

Install the jazz-pack you which to use using npm:

npm install jazz-pack-{packname}

Note: Replace the packname by the package you which to use.

Running a process

Use npx to run the jazz command line:

npx jazz --configFile ./node_modules/jazz-pack-{packname}/dist/pack-config.js

Note: the configFile path above will change accordingly to the jazz-pack

Command Line Arguments:

By default, the jazz command line accepts the following arguments:

• configFile: the jazz-pack Configuration File path. [required]
• debug: true or false
• decryptKey: the key to decrypt the jazz-pack file (in case the jazz-pack file is encrypted)
• log: the Log Strategy

Each jazz-pack will provide different options for arguments on the command line tool.

For example, the jazz-pack-citibank-paylink, which is a pack that converts an excel spreadhseet into the Paylink-1024 formatted text file, provides the 2 additional arguments below:

Name	Description
sourceFile	The path of the excel source file. Default: source.xlsx (in the root directory)
outputFile	The output File path for the converted text file. Default: target.txt (in the root directory)

Note: to check the arguments accepted by each pack, please refer to each jazz-pack documentation. In case of jazz-pack-citibank-paylink, for example, visit here.