Component Process Start

Table of Contents

Description

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

The operation must be pre-permitted and configured in the assert file permissions.json on each server where the component can run.

Table 1. System Characteristics

Index

117

Short title

execprocess

Types of scenarios

All of them

Starter module

r_script_component_execprocess

Mode

Asynchronous

Icon

117

Branching pattern

Branching, closing

Properties

Table 2. Properties
Specification Description

Title: Mode
Code: mode
Visibility: no
Default: Asynchronous startup

Waiting mode for OS process termination.
Possible values:

  • Asynchronous startup (async, 0) - Immediately after the process starts, passes control to the next component.

  • Waiting for completion (sync, 1) - Passes control to the next component only after the process completes or a wait timeout.

Title: Path to executable file
Code: path
Visibility: no
Default: — 

File path or OS command. Command line prefix.
The prefix must be resolved in the file permissions.json.

Examples of specifying commands:

  • echo

  • myprogram1

  • /bin/myprogram2

  • :GLOBALSHARE_COMMON/cmd/myprogram3

  • bash :SYNC_COMMON/cmd/myscript.sh

To resolve these examples, the 'permissions.json' file must have 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 only checked on the path to the starting bash script.

Title: Command Line Startup Parameters
Code: params
Visibility: no
Default: — 

Command postfix containing parameters.

Title: Time, s
Code: timeout
Visibility: yes
Default: — 

Waiting timeout for the process to complete.

Title: Transition
Code: transfer
Visibility: no
Default: — 

A component to which control is passed after an asynchronous startup, or after a successful completion of a process.

Title: Result to variable
Code: result
Visibility: no
Default: — 

Variable to save the console output of a completed process.

Title: Transition, Error
Code: transferError
Visibility: no
Default: — 

Component to which control is passed in case of a startup error or process crash.

Title: Reason for error to variable
Code: error
Visibility: no
Default: — 

Variable to save the error.

Title: Transition, Time
Code: transferTimeout
Visibility: yes
Default: — 

The component to which control is passed after the process completion wait time has elapsed.

See also