Obtaining Lua language support

For many products, the Lua language extension package is automatically installed with the base software installation. If the Lua extension is installed on your node, there is no other installation or licensing tasks to perform. However, if you do not have the Lua extension installed on your node, contact your technical representative.

Determining if the Lua extension is installed

To determine if the Lua extension is installed on a node, follow these steps:

1. From the Workbench left pane, expand the node that you want to check for the Lua extension.
   
2. Select the Administration icon.
   The Administration window appears.
   
3. Select Packages to bring the tab to the front.
   
   

The Packages tab provides a table of all installed packages and extensions. Notice the Lua Extension support.

If the Lua extension is not listed in the Packages tab, then the appropriate Lua extension package file for the node type must be obtained and installed using the Packages tab. For information about obtaining and installing packages, see Downloading the Lua extension file at the bottom of this page.

Checking for Lua extension installed files

When the Lua extension is installed, folders and files are automatically created in the Staging Browser.

The files contain:

• Lua scripts to be accessed from triggers.
• Custom trigger actions implemented in Lua scripts.
  

To check for the Lua extension installed folders and files, follow these steps:

1. From the Workbench left pane, expand the node.
   
2. Select the Administration icon.
   The Administration window appears.
   
3. Select Staging Browser to bring the tab to the front.
   
   
4. Locate and then expand the scripts folder. The scripts folder indicates that the Lua extension is installed.
   
5. Expand the actions folder. The sample_action.lua file contains functions that show how to create a custom trigger action.
   The library folder provides a place to store files other .lua files.
   The sample.lua file is a sample Lua script that can be referenced from the Execute Lua Function From File action.
   

Using the Lua Scripting trigger actions

When the Lua extension is installed, actions are added under the Lua Scripting category in the list of available trigger actions.

To check for the Lua Scripting installed actions, follow these steps:

1. From the Workbench left pane, expand the node.
   
2. From Workbench left pane, select the Projects icon.
   The Projects window appears.
   
3. Select any existing project you want to add a trigger to.
   The project tab appears.
   
   
4. Display the pop-up menu from the project tab, and then select New > use List Editor or use Canvas Editor.
   If you are using the List Editor, from the bottom of the Actions section, select Add. The New Action window appears.
   If you are using the Canvas Editor, the list of available actions is displayed in the left pane.
   
   
5. Locate and expand the Lua Scripting category, The Lua actions will appear. For more information, go to Related Topics at the bottom of this page.

Downloading the Lua extension file

If you do not have the Lua extension installed on your node, you can contact your technical representative.

For instructions to download and add the Lua extension file, see Packages.

Related topics

Lua Scripting (action category)