Key Concepts and Terms

The Scripts Module manages and executes user-defined scripts for automation and process control. 

Understanding the Scripts Module

Module Highlights

• Built-in Code Editor: Our code editor works for C#, VB.NET, JavaScript, and Python languages.
• Server and Client Domains: Create scripts that execute on the server for global reach, or on the client side for local reach.
• Events and Scheduling: Tasks and expressions can be triggered by date, time, condition, calendar, tag change, or interval. Execution is distributed among processes, each running in its own application domain, isolated from the real-time database, ensuring maximum system security and performance.
• Object Orientation and Project Elements: All solution elements, including Tags, Datasets, Alarms, devices, and communication statuses, are immediately accessible via IntelliSense as native .NET objects. No temporary tags or function calls are required. With a single command, move data from Tags to .NET objects and external Data-tables.
• Configure your Python Interpreter: The Script module delivers exceptional scripting capabilities across various programming languages with seamless integration of Python. You can configure any version of the Python interpreter for each project.

Configuring the Scripts Module

Configuration Workflow

Working with the Scripts Module

Runtime Execution

The key concept to be aware on the execution of the Tasks and Expressions define on the Script Module is that they execute on the Server computer.

Only the CodeBehind of the displays is executed on each Client Computer. The Script Classes can be consumed by both Server and Client stations.

Current solution are prorating User Interfaces that are Portable, meaning the exact same drawing and display configuration can run both as a WPF Windows RichClient, or as Web HTML5 page inside a browser. If you intend to run the graphical interface only on Windows, it is possible to enable in Solution → Settings to allow Tasks and Expressions running on the Client side.

For complex solutions or very large solutions, it's useful to get a deeper understanding of the Module execution process, see Scripts Module Execution if that is your case.

Best Practices and Troubleshooting

Troubleshooting and Common Issues

The Scripts module may encounter some issues in its operation. Here are some common issues and their troubleshooting:

Build Errors and Warnings: Make sure to check the 'BuildStatus' and 'BuildErrors' tabs to identify and address errors and warnings that arise during the build.

Code Language: If you change the code language in the code editor, confirm that the code has been correctly converted to the selected language.

Build Order: Ensure that the build order of the classes is set up correctly to avoid circular dependencies or initialization issues.

Domain Selection: Ensure that the domain is selected correctly (Client or Server) based on the needs of your project.

Expression Syntax: Check the syntax of the expressions, ensuring they comply with VB.Net or C# standards.

Execution Settings: Ensure that the execution settings are correct, so that the expressions are executed as expected.

Reference Issues: Make sure that all external references are configured correctly and that there are no compatibility issues or conflicts. Code Editor

Syntax Errors: Check for syntax errors in the code. Use the 'Auto Format' feature to identify potential issues.

Incremental Compilation Issues: Monitor the incremental compilation process to identify and resolve potential issues that may arise.

Debugger Setup: Ensure that the debugger setup is correct to allow effective code debugging.

Breakpoints and Watch Variables: Use breakpoints and watch variables effectively to identify and resolve issues.

Best Practices and Recommendations

Tasks:

• Naming Convention: Use a coherent and descriptive naming convention for tasks.
• Task Domain: Select the appropriate domain for each task, considering whether the task is more suitable for client-side or server-side execution.

Classes:

• Reusable Code: Promote code reuse by creating classes that encapsulate functionalities for use in various parts of the project.

Expressions:

• Expression Optimization: Write optimized expressions to ensure efficient execution and reduce resource usage.

External Libraries:

• Library Management: Manage libraries and external components effectively to avoid conflicts and compatibility issues.
• Code Consistency: Maintain code consistency by following best practices and coding conventions.
• Build Before Deployment: Always perform a build operation before deploying a project in a production environment to ensure all scripts are correct and up to date.

Script Runtime Attributes

The Script Namespace is the entry point for all objects related to the Scripts module.

The Script.Class object lists all configured tables and its runtime properties.

The Script.Task object lists all configured database connections and their runtime properties.

Examples:

→ Read more about Objects and Namespaces.

→ Check the Script Examples and Solution Examples pages for some scripting examples.

In this section: