Overview

The Scripts Module allows the automation of various tasks through scripting. You can configure these tasks to run in response to specific events or on a scheduled basis, enhancing the application's efficiency and functionality. 
Script tasks can call Script Classes or use external DLLs.

On this page:

Configuring Tasks

Tasks are program units, written in VB.Net, C# or Python, that execute either when a trigger event occurs or periodocally at specified intervals. To create and configure a Sctipt Task, follow the steps below:

  1. Access Scripts > Tasks.
  2. Click on the plus icon.
  3. Input a task Name, Description and select the desired Language.
  4. Choose to create new code or import a code from an existing library.
  5. Click Ok.

To modify an existing Script task, double-click and modify the desired field column and make the changes. See a list of available properties in the next section.

The image below illustrates the process described above.

Built-in Tasks

All soutions include the following built-in tasks:

  • Server Startup: Executed when the solution starts running. Runs on the server (computer running TServer.exe).
  • Server Shutdown: Executed when the solution shuts down. Runs on the server.
  • Client Startup: Executed on each client when the Displays module (TVisualizer.exe) starts running.
  • Client Shutdown: Executed on each client when the Displays module closes.

Script Tasks Properties

The following is a table describing each available property field for the Alarm Item:

If a property column is not visible on the grid, enable it by right-clicking the grid header and selecting it from the list.

Property

Description

Name

The name of the task.

Code

Specifies the language used for the code of this task. By default, this is the language you selected when you created the project. You can change the project default by accessing Info > Settings.

Trigger

The event that triggers the task execution.

Period

The time interval that should occur between executions of the task, if there is no trigger.

Domain

The location where the script executes, there are two options:

  • Client: Task executes on each client system. These are tasks that apply locally (on the user's computer).
  • Server: Task executes on the server system. These are tasks that apply across the application, that is, globally.

Initial State

The task's initial state, theoiptions are as follows:

  • Enabled: The task is ready to run.
  • Disabled: The task is not ready to run. You may enable the task under specific conditions.

Build Status

The Status of the task code from the continuous compiling process.

  • Green check mark: The task runs without errors.
  • Red X: The task has warnings or errors, double-click to access the warning or error.
    • Warnings are information only.
    • Errors will prevent the code from running for that specific task. The rest of the solution will run.

Build Errors

Displays any errors encountered during the last build.

Edit Security

The security to enable who can edit the tasks. 

Description

Description of the task.


In this section...