CLI Rulex Platform Desktop Reference Manual

This page describes in detail all the possible flags and options we can use from command line prompt (cmd or PowerShell in windows) to launch Rulex Platform Desktop Version in all its possible modes.

Launching modes

Rulex Platform Desktop can be launched in the following modes:

• GUI (default)

• batch - this page will focus on this second launching mode. The batch mode runs the application without a graphical user interface, executing the command expressed by the subsequent arguments, and closing the application.

  Batch mode allows the execution of any API call as a command line string, and represents the API counterpart when the Desktop version of Rulex Platform is used. In the subsequent paragraphs we will describe the two ways of expressing subsequent arguments to permit Rulex Platform to execute a particular API call:

  • General Approach

  • Batch Mode Shortcuts
    

General Approach

In the general approach, the different components of an API call (route, headers, params, body etc…) are expressed as keyword arguments in the command line. This makes it possible to perform any general API call of Rulex Platform from a PowerShell/cmd script directly on the desktop version, without any other plugins.

Rulex Platform Desktop CLI exposes shortcuts for the most commonly used commands, i.e. a dedicated set of arguments and keywords to simplify the command line creation, and speed up script construction.

Any call used with any approach can produce these general exit codes:

General API Client Batch Approach

A general form for a batch command is as follows:

&".\Rulex Platform.exe" --batch resource -a create -c flow -rs {envPath} -rtp environment -q label=MyCreatedFlow -b '{"view":"allow", "modify":"allow", "share":"deny"}'

Which is made up of the following sections:

• Route Mapping

• Query String Params

• Body

• Authorization

• Headers

• Exit Codes

Route Mapping

To express the route of the API call in the command line, the following options can be used:

Query String Params

To express the query string params of the API call in the command line, the following options can be used:

Body

To express the body of the API call in the command line, the following options can be used:

Authorization

Using this general approach you can also use command line keywords to express the authorization information needed to establish the permissions in the command. If no keywords are specified, authorization of the current user sending the command is used. To express information to authorize the command in the command line, the following options can be used:

Headers

Using this general approach, you can also use command line keywords to express general information about the request, which is usually imposed using headers in standard API calls.
To express information about the headers in the command line, the following options can be used:

Exit Codes

In the general approach, the exit code is always the status code of the corresponding API call:

• 0 if the request call was not successful

• 200 if the request call was successful.

Batch Mode Shortcuts

The most commonly used commands, for which a shortcut is present in the CLI, are the following:

• computeflow

• importflow

• exportflow    

• createflow  

• deleteflow    

• executemacro

Keywords and arguments, together with exit codes, are specific for each shortcut; hence we will describe them one by one.

Compute Flow

An example of the compute flow shortcut call is as follows:

&".\Rulex Platform.exe" --batch computeflow -fp "/RulexDesktop/Env_TestUser/Test" -iss

The list of all the possible flags is as follows:

Specific exit codes for the command are:

• 2 (FLOW SELECTION FAILED): the flow indicated by flowPath is not a flow, or it does not exist, or it is locked at the moment of the command.

• 4 (TASK COMPUTATION FAILED): some tasks have ended in a managed error during the computation.

• 12 (FLOW INITIALIZATION ERROR): a managed error occurred during task initialization, which failed. Possible root causes are improper topology, loops in import tasks, GOLD error in evaluation of environment or flow variables.

Import Flow

An example of the import flow shortcut call is as follows:

&".\Rulex Platform.exe" --batch importflow -fp {path of the flow} -u {path of the rfl file}

The list of all the possible flags is as follows:

Specific exit codes for the command are:

• 9 (IMPORT UNSUCCESSFUL): the import operation failed with a managed error.

Export Flow

An example of the export flow shortcut call is as follows:

&".\Rulex Platform.exe" --batch exportflow -fp {path of the flow} -u {path of the rfl file}

The list of all the possible flags is as follows:

Specific exit codes for the command are:

• 10 (EXPORT UNSUCCESSFUL): the export operation failed with a managed error.

Create Flow

An example of the create flow shortcut call is as follows:

&".\Rulex Platform.exe" --batch createflow -fp {path of the flow}

The list of all the possible flags is as follows:

Specific exit codes for the command are:

• 2 (FLOW SELECTION FAILED): the creation failed because the flowPath cannot be created due to a managed error. Possible root causes are that the flow already exists, or the environments in the path are not present, or sufficient permissions are not granted.

Delete Flow

An example of the delete flow shortcut call is as follows:

&".\Rulex Platform.exe" --batch deleteflow -fp {path of the flow}

The list of all the possible flags is as follows:

Specific exit codes for the command are:

• 11 (DELETE UNSUCCESSFUL): the delete operation failed with a managed error.

Execute Macro

An example of the execute macro shortcut call is as follows:

&".\Rulex Platform.exe" --batch executemacro -fp {path of the flow} -e {event name}

The list of all the possible flags is as follows:

Specific exit codes for the command are:

• 13 (MACRO COMPUTATION FAILED): macro or event execution failed with a managed error.