| HTML |
|---|
<style>
.text-span-6 {
background-image: linear-gradient(99deg, rgba(170, 163, 239, .5), rgba(125, 203, 207, .5));
border-radius: 50px;
padding-left: 15px;
padding-right: 15px;
}
#title-text {
display: none;
}
.panelgradient {
background-image: linear-gradient(180deg, #d5def0, whitesmoke);
border-radius: 8px;
flex-direction: column;
justify-content: center;
align-items: center;
padding: 4rem;
display: flex;
position: relative;
}
</style>
<div class ="panelgradient">
<h1 style="text-align: center;">Scripts <br> (Tasks and Classes)</h1>
</div> |
Introduction to the Scripts Module
The Scripts Module supports multiple programming languages, including C#, VB.NET, Python, and JavaScript, enabling the creation of high-performance server-side and client-side scripts. Its built-in code editor streamlines development with automated translation between C# and VB.NET and provides access to all .NET Framework classes available in Visual Studio. The module simplifies distributed application development using server or client domains and ensures high performance through custom code compilation. Additionally, it enhances graphical displays with Display Code Behind functions and offers debugging tools for quick identification and resolution of coding issues.
The Scripts Module Allows:
- Multi-Threaded Task Execution
- Event-Driven Actions
- Library Creation for Methods and Classes
- Integration with Third-Party Libraries.
On this page:
| Table of Contents | ||||
|---|---|---|---|---|
|
Key Concepts and Terms
The Scripts Module manages and executes user-defined scripts for automation and process control.
| Panel | ||
|---|---|---|
| ||
Script TasksDefines code that executes in reaction to an event (trigger) or periodically at specified intervals. |
| Panel | ||
|---|---|---|
| ||
Script ClassesA library of functions and methods that can be used in Script Tasks, Expressions, or from the Code Behind on graphical Displays. |
| Panel | ||
|---|---|---|
| ||
Script ExpressionsOne line of code in response to an event, where the entire script isn't necessary. |
| Panel | ||
|---|---|---|
| ||
Script ReferencesExternal DLLs included for a script or display code compilation. |
Understanding the Scripts Module
Module Highlights
- Built-in Code Editor: Our code editor works for C#, VB.NET, JavaScript, and Python languages, as well as XML and JSON documents.
- 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
| Script module configuration workflow | ||
|---|---|---|
| Action | Where | Comments |
Manage Class Scripts | Scripts / Classes. Learn more at Scripts - Classes. | |
Manage Task Scripts | Scripts / Task. Learn more at Scripts - Tasks. | |
Manage Expressions | Scripts / Expressions. Learn more at Scripts - Expressions. | |
Manage References | Scripts / References. Learn more at Scripts - References. | |
Track the module changes | Scripts / Monitor. Learn more at Scripts - Monitor. | |
Working with the Script Module
Runtime Execution
For a detailed understanding of the script execution process on the software framework, refer to the Script Execution Process.
Monitoring the Script Module
The Scripts Monitor feature tracks and assesses script performance, providing crucial insights for optimizing your software platform. Explore Monitoring Scripts for an in-depth exploration of script monitoring techniques.
Client-Server Programming
To learn more about client-server programming in the software framework context, see Client-Server Programming.
Client-Server Data Security
To ensure the security and integrity of your data within the software framework, explore Client-Server Data Security. This resource provides detailed information on safeguarding data exchanges between clients and servers, protecting your project from potential security risks.
Leveraging Built-in Function Libraries
The Script module provides several built-in classes and methods libraries that can greatly streamline your project development process. For detailed documentation, see Built-in Methods and Libraries.
Troubleshooting and Best Practices
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:
Script Task properties | ||
|---|---|---|
Property | Type | Description |
| Integer | Number of times the Script Task <Task1> was executed. |
| TimeSpan | The Amount of CPU used the last time the Script Task Task1 was executed. |
ModuleScript properties | ||
|---|---|---|
Property | Type | Description |
| Boolean | Flag indicating if the module Dataset has started. |
| String | Message OK or error when initiating the module. |
→ Read more about Objects and Namespaces.
→ Check the Script Examples and Solution Examples pages for some scripting examples.
What's Next?
| Page Tree | ||||
|---|---|---|---|---|
|