Script Runner

The Script Runner Component allows pipelines to connect to a remote server or machine and execute script files stored there. It can be triggered by events in the workflow and supports multiple script types and authentication methods.

Key Capabilities

• Connect to a remote server/machine using username/password or PEM/PPK key files.

• Execute script files of type SSH, PERL, or Command.

• Pass manual arguments or event arguments dynamically to scripts.

• Supports both batch and real-time invocation modes.

• Capture script output for downstream processing in pipelines.

Configuration Overview

All Script Runner configurations are grouped into the following sections:

• Basic Information

• Meta Information

• Resource Configuration

Steps to Configure the Script Runner Component

Accessing the Component

1. Locate the Script Runner Component under the Scripting section of the Component Palette.

2. Drag and drop it into the Workflow Editor.

3. Select the component to open its configuration tabs.

Basic Information Tab

• Invocation Type – Choose execution mode:

  • Real-Time – Keeps the component active and ready to process incoming data continuously.

  • Batch – Executes scripts only when triggered by the previous event.

• Deployment Type – Pre-selected deployment type.

• Container Image Version – Pre-selected docker container version.

• Failover Event – Select an event to capture failures.

• Batch Size (min 10) – Maximum number of records processed per cycle (minimum = 10).

Meta Information Tab

Server Connection

• Host – IP address of the remote server/machine.

• Username – Authentication username.

• Port – Port number for remote server connection.

Authentication Options

Select one of the authentication methods:

• Password – Enter password for the server.

• PEM/PPK File – Provide a certificate file for key-based authentication.

Note: Displayed fields vary based on the selected authentication method.

Script Execution

• Script Type – Choose the type of script to execute:

  • SSH

  • PERL

  • Command

• File Path – Directory path of the script file on the remote server.

• File Name – The script file to be executed.

• Event File Location – Path to the file sent via file monitor (optional).

Input Arguments

• Manual Arguments (Optional) – User-provided values for script parameters.

• Event Arguments (Optional) – Dynamic parameters passed from previous event or Kafka topic.

Saving the Component Configuration

1. Click Save Component in Storage.

2. A notification confirms successful configuration.

3. Once saved, the component can connect to the remote machine, locate the script file, pass arguments, and execute it.

Limitations

• Accepts only lists as input – the in-event data must be in list format.

• Produces output to the out-event only if the script contains a print statement.

• The output data from the script is always of list type.

Example Use Cases

• Execute a Python/Perl script for data transformation on a remote machine.

• Run system commands (e.g., cleanup, monitoring tasks) triggered by pipeline events.

• Integrate with legacy applications that require remote script execution.