External Application/Script

External application/script Device Driver allows Iotellect Server to execute any applications or scripts located on a machine the server is running on. The applications can be executed on demand or periodically. Their exit codes, output and error output are available for analysis.

When calling an application or script on demand, operators can also specify custom input arguments for it.

Driver Information

Driver Plugin ID:

com.tibbo.linkserver.plugin.device.application

Global Settings

None defined.

User Level Settings

None defined.

Device Account Properties

Variables (Periodic Execution)

This is a tabular setting defining what applications will be executed periodically. Each application will be represented by a device setting variable those fields will contain exit code, output and errors retrieved during last execution.

Field

Description

Name

Name of a device setting variable representing application exit code and output.

Description

Description of the above variable.

Command

Path of an application or script to execute.

Arguments

List of arguments to pass to the above application/script.

Timeout

Maximum time to wait for the application to finish execution.

Encoding

Character encoding to apply for processing application output and errors.

If you’d like to execute a piped command, such as ls -l | grep foo, invoke a shell as a Command and specify your piped command in Arguments, for example:

  • Command: /bin/sh

  • Arguments: -c, ls -l| grep foo

Functions (On-Demand Execution)

This is a tabular setting defining what applications will be executed upon operators requests. Each application will be represented by a device operation function. These functions will accept application/script command line arguments as their input. Application/script exit codes and output will be returned by those functions.

Field

Description

Name

Name of device setting function that will call an application or script.

Description

Description of the above function.

Command

Path of an application or script to execute.

Timeout

Maximum time to wait for the application to finish execution.

Encoding

Character encoding to apply for processing application output and errors.

Device Assets

Assets are not supported by the driver.

Device Settings

External application/script device driver creates one device setting variable for each record of Variables (Periodic Execution) table. This variable has the following fields:

  • Exit Code. Numeric code returned by the application.

  • Output. Application output.

  • Errors. Application error output.

Device Operations

External application/script device driver creates one device operation function for each record of Functions (On-demand Execution) table. This function accepts a list of command line arguments to pass to the application. It has the following output format fields:

  • Exit Code. Numeric code returned by the application.

  • Output. Application output.

  • Errors. Application error output.

Device Events

No events provided by the driver.

Connection Handling

An application/script device is always Online.

Synchronization Details

During a synchronization, driver executes all applications and scripts defined in Variables (Periodic Execution) table.

Was this page helpful?