3. Usage

Running ARG

Included in the Arg package is a batch file that is utilized to execute the script, and requires one parameter: the designated location of the configuration file.

ARG <configuration file>

Configuration Data

Crafting a configuration file in JSON format is the first crucial step in creating a deck using ARG. This file must include vital information necessary for deck generation, such as the company and project names, chosen template, and a comprehensive list of all applications. Additionally, it must also contain the requisite REST API configurations for both Highlight and CAST.

General Configuration

The general configuration section contains four parts,

• company - the name of the company as it will appear on the report
• project name - the name of the project as it will appear on the report
• template - the absolute location of the report template
• output - the absolute location of the report output folder

Application list

This section contains a list of all applications that will be used in the report. It is divided into three parts,

• aip - the application schema triplet base
• highlight - the name of the application as it appears in the Highlight portal
• title - the name of the application to be used in the report The content of "api" will be utilized if either "highlight" or "title" contains no value.

aip is the only required in this section. If Highlight or title are empty or left out the aip value will be used.

REST Configuration

The REST configuration is divided into two parts, AIP and Highlight. Both configurations contain

• Active - toggle to turn REST service on/off
• Token - when set to True the Engineering Dashboard REST API login will the AIP Key.
• URL - the service base URL
• user - login user id
• password - login password, or MRI Console AIP Key

The Highlight configuration contains an additional field, instance, which refers to the login instance id.

Sample configuration

{
    "company":"MMA Company Name",
    "project":"Project Name",
    "template":"C:/com.castsoftware.uc.arg/Template.pptx",
    "output":"C:/output/folder",
    "application":[
        {
            "aip":"triplet_base_name",
            "highlight":"highlight_name",
            "title":"application title"
        },
        {
            "aip":"triplet_base_name",
            "highlight":"highlight_name",
            "title":"application title"
        }, ...
    ],
    "rest":{
        "AIP":{
            "Active":true,
            "Token":true,
            "URL":"http://<URL>:<Port>/rest/",
            "user":"user_name",
            "password":"user_pasword"
        },
        "Highlight":{
            "Active":true,
            "URL":"https://<URL>/WS2/",
            "user":"user_name",
            "password":"user_pasword",
            "instance":"instance id"
        }
    }
}