Skip to end of metadata
Go to start of metadata

Overview

Indigo supports the following scripting options:

In-Session Command Scripting

In-Session Command Scripting allows you to send commands to the terminal session using Internal Command syntax.
The following types of scripting methods can be invoked.  

DescriptionExecutes a script function from a named script file.
Transmit return data to connected device/host.
Syntax:@<script-name>.<script-function>
Example:@PostProcessingSample.ForceToUpperCase("hello world")
DescriptionExecutes a script function from the currently configured session Post-Processing script file.
Transmit return data to connected device/host. 
Syntax:!<script-function>
Example:!MyCustomFunction()
DescriptionExecutes a VBScript code expression
Transmit return data to connected device/host. 
Syntax:=<script-code>
Example:=Host.Post("Hello World")
Example:=UCase("hello world")

Post Processing Scripts

Indigo supports a Post-Processing scripting feature that allows a user created script to analyze and modify data after it has been received.
Post-Processing
scripting enables you to execute a script function to process data received from a terminal session before it is rendered to the screen.

To use this feature, Post-Processing scripting must be enabled and configured for each session in the Advanced tab of the Session Properties editor. 

PropertyDescription
Post Processing ScriptThis option must be checked before the session will use Post-Processing scripting.
Script Language

Select the scripting language used in the script file.

  • VBScript
  • JScript
Script FileSelect the script file to use.
(This script file must exist in the Scripts data directory.
Script FunctionSelect the desired script function to be invoked when this terminal session receives data.
TestThis button provides a simple option to test an invocation of your script function.

In the example configuration above the "ForceToUpperCase" function is selected from the "PostProcessingSample.vbs" script file.

The code snippet below illustrates this function.

Post-Processing Script Example

When this Post-Processing script function is enabled, all textual data received will be forced into upper case before it is displayed on screen.
The screenshot below is an example of data received and displayed after being processed by this script function. 

Script File Location

Script files should be placed in the "Scripts" directory under the Indigo Data Directory.

OS VersionDirectory Location
Windows XPC:\Document and Settings\All Users\Application Data\shadeBlue\Indigo\Scripts
Windows 2003 ServerC:\Document and Settings\All Users\Application Data\shadeBlue\Indigo\Scripts

Windows Vista

C:\ProgramData\shadeBlue\Indigo\Scripts
Windows 7C:\ProgramData\shadeBlue\Indigo\Scripts
Windows 8C:\ProgramData\shadeBlue\Indigo\Scripts
Windows 2008 ServerC:\ProgramData\shadeBlue\Indigo\Scripts
Info

The C:\ProgramData directory is hidden by default in Windows.

Examples

Indigo includes two files to help get you started with writing your own scripts.

(These files are both located in the Scripts directory referenced above.) 

FileDescription
PostProcessingSample.vbsThis script file includes a number of example post-processing functions and event handlers.
Indigo Scripting Host API.txtThis is a text document that defines the available methods and events provided by the scripting "Host" object.

If you are creating your own script functions, please create a new script file and do not create your customization in the "PostProcessingSample.vbs" file.
This file may be automatically overwritten in Indigo version updates, thus losing your customization. 

Labels
  • None