Process Start Component

:icons:font :hardbreaks: :imagesdir: ../../../assets/images :toc-title: Contents :toc:

Description

Launches an external console process on the server. Parameters are passed in the body of the command line. The process’s return value from the console can be captured and returned to a variable.

The operation must be previously enabled and configured in the permissions.json asset file on each server where the component can be executed.

Table 1. System characteristics

Index

117

Short name

execprocess

Script types

All

Start module

r_script_component_execprocess

Mode

Asynchronous

Icon

117

Branching type

Branching, closing

Properties

Table 2. Properties
Specification Description

Name: Mode

Code: mode

Visibility condition: no

Default: Asynchronous launch

Waiting for the OS process to complete.

Possible values:

  • Asynchronous launch (async, 0) – Immediately after the process starts, transfers control to the next component.

  • Wait for completion (sync, 1) – Transfers control to the next component only after the process completes or wait timeout.

Name: Path to the executable file

Code: path

Visibility condition: no

Default: — 

Path to file or OS command. Command line prefix.

The prefix must be resolved in the permissions.json file.

Examples of specifying commands:

  • echo

  • myprogram1

  • /bin/myprogram2

  • :GLOBALSHARE_COMMON/cmd/myprogram3

  • bash :SYNC_COMMON/cmd/myscript.sh

To allow these examples, the 'permissions.json' file must contain the following content:

{
  "exec_perm": {
    "check": true,
    "user": "root",
    "commands": [
      "echo",
      "myprogram1",
      "/bin/myprogram2",
      ":GLOBALSHARE/common/cmd/myprogram3",
      ":SYNC/common/cmd/myscript.sh"
    ]
  }
}

Using bash scripts you can run any commands; permission is checked only for the path to the starting bash script.

Name: Command line launch options

Code: params

Visibility condition: no Default: — 

Command postfix containing parameters.

Name: Time, s

Code: timeout

Visibility condition: yes

Default: — 

Timeout waiting for process completion.

Name: Transition Code: transfer Visibility condition: no

Default: — 

The component to which control is transferred after an asynchronous launch, or after the successful completion of the process.

Name: Result into variable

Code: result

Visibility condition: no

Default: — 

Variable for saving the console output of the terminated process.

Name: Transition, error

Code: transferError

Visibility condition: no

Default: — 

The component to which control is transferred in the event of a startup error or process crash.

Name: Cause of error in variable

Code: error

Visibility condition: no Default: — 

Variable for storing the error.

Name: Transition, time

Code: transferTimeout

Visibility condition: yes

Default: — 

The component to which control is transferred after the timeout for waiting for the process to complete.

See also