Script Runner

All component configurations are classified broadly into 3 section

Please follow the demonstration to configure the component.

1.1.1. Script Runner

This component can be used for connecting it to a remote server/machine and running script files

present there based on some events.

i) Drag and drop Script Runner Component to the Workflow Editor.

ii) Open the dragged Script Runner component to open the component properties tabs.

iii) The Basic Information tab opens by default.

a. Select an Invocation type from the drop-down menu to confirm the running mode of the reader component. The supported invocation types are ‘Real-Time’ and ‘Batch’.

b. Deployment Type: It displays the deployment type for the component. This field comes pre-selected.

c. Container Image Version: It displays the image version for the docker container. This field comes pre-selected.

d. Failover Event: Select a failover event from the drop-down menu.

e. Batch Size (min 10): Provide the maximum number of records to be processed in one execution cycle (Min limit for this field is 10).

iv) Open the Meta Information tab and configure the required information.

a. Host: Host IP of the remote server/machine

b. Username: Username of the remote server/machine.

c. Port: Provide machine Port number.

d. Authentication: Select an authentication option from the drop-down menu.

1. Password: By selecting this option the user needs to pass the password.

2. PEM/PPK File: By selecting this option the user needs to pass the authentication file to connect to the server.

e. Script type: Choose the type of script file that You want to run out of SSH/ PERL/command options.

f. File path: Path of the file that is stored at the remote server.

g. File Name: The script file that you want to execute.

h. Event File Location: this is the location of the file sent through the file monitor (Non-mandatory).

Note: The displayed fields may vary based on the selected Authentication option.

Component Properties when the Authentication option is Password.

Component Properties when the Authentication option is PEM/PPK File.

i. Input Arguments

1. Manual Arguments (Optional): These are the arguments to the parameter of the script that the user can provide manually.

2. Event Arguments (Optional): These are the arguments to the parameter coming from the previous event/Kafka topic.

v) Click the ‘Save Component in Storage’ icon (A notification message appears to confirm the action completion).

vi) The Script Runner component gets configured, and the notification message appears to inform the same.

Note: The component can connect to the remote machine using the details provided. It will pick the file from the location in that machine using the file name and file path respectively and finally execute the script after passing arguments (if any).


a. It accepts only lists as input i.e. the in-event data should be a list.

b. It sends data on the out-event only when there is a print statement as output in the script if not there will be no data on the out-event.

The data produced from the script is of a list type.

Last updated