This guide walks you through configuring the Scripts module for custom automation and business logic. You'll create reusable classes, automated tasks, simple expressions, and integrate external libraries using C#, VB.NET, or Python.
Prerequisites:
ScriptClasses are libraries of reusable methods available throughout your solution.
Class | Purpose | Domain |
---|---|---|
ServerMain | Methods for all server tasks | Server |
ClientMain | Methods for all client displays | Client |
csharp
public class ServerMain
{
public double CalculateEfficiency(double input, double output)
{
if (input == 0) return 0;
return (output / input) * 100;
}
public void LogEvent(string message)
{
@Alarm.AuditTrail.AddCustomMessage(message);
}
}
ScriptTasks execute code based on triggers or schedules.
Task | Trigger | Purpose |
---|---|---|
Server Startup | Solution starts | Initialize server resources |
Server Shutdown | Solution stops | Cleanup operations |
Client Startup | Client connects | Setup client environment |
Client Shutdown | Client disconnects | Client cleanup |
Trigger Type | Example | Use Case |
---|---|---|
Tag Change | Tag.Temperature | React to value changes |
Condition | Tag.Level > 100 | Monitor thresholds |
Interval | 00:00:30 | Periodic execution |
Schedule | Daily at 06:00 | Scheduled reports |
Startup | Built-in | Initialization |
csharp
// Task: MonitorProduction
// Trigger: Tag.ProductionRun (on change)
public void RunTask()
{
if (@Tag.ProductionRun == 1)
{
@Tag.StartTime = DateTime.Now;
@Tag.BatchNumber = @Tag.BatchNumber + 1;
// Call class method
@Script.Class.ServerMain.LogEvent("Production Started");
}
else
{
@Tag.EndTime = DateTime.Now;
TimeSpan duration = @Tag.EndTime - @Tag.StartTime;
@Tag.BatchDuration = duration.TotalMinutes;
}
}
Expressions are single-line statements for simple operations.
Property | Description | Example |
---|---|---|
Object | Target tag | Tag.Result |
Expression | Calculation/action | Tag.Input1 + Tag.Input2 |
Execution | When to run | OnChange |
Trigger | Optional trigger | Tag.Calculate |
IIF Method (all parameters evaluated):
Tag.Status = IIF(Tag.Value > 100, "High", "Normal")
TIF Method (conditional evaluation):
TIF(Tag.Mode == 1, @Script.Class.Method1(), @Script.Class.Method2())
csharp
// Mathematical
Tag.Average = (Tag.Value1 + Tag.Value2) / 2
// Conditional
Tag.Alarm = Tag.Temperature > Tag.Setpoint
// Method call
@Script.Class.ServerMain.CalculateEfficiency(Tag.Input, Tag.Output)
// String manipulation
Tag.FullName = Tag.FirstName + " " + Tag.LastName
Location | Macro | Use For |
---|---|---|
ThirdParty folder | _ThirdParty_ | Server-side DLLs |
WpfControls folder | _WpfControls_ | Client-side controls |
Solution folder | _SolutionPath_ | Solution-specific DLLs |
csharp
using System.Data;
using MyCustomLibrary;
Check script performance:
csharp
// In expressions or displays
@Script.Task.MyTask.ExecutionCount // Number of executions
@Script.Task.MyTask.LastCPUTime // Last execution time
.
after objects for property listTool | Shortcut | Purpose |
---|---|---|
Format Document | Toolbar | Auto-format code |
Comment | Ctrl+K,C | Comment selection |
Uncomment | Ctrl+K,U | Uncomment selection |
Compile | F6 | Check for errors |
Common operations via TK
namespace:
csharp
// Type conversion
double value = TK.ConvertTo<double>("123.45");
// Tag to DataTable
DataTable dt = TK.CopyTagToDataTable(@Tag.MyTemplate);
// Dynamic property access
object val = TK.GetPropertyValue(@Tag.MyTag, "Value");
Script Not Executing
Compilation Errors
DLL Not Found
Performance Issues
Use descriptive names - Clear task and class identification
Handle exceptions - Try-catch blocks for error handling
Reuse code - Create methods in classes
Comment complex logic - Document purpose and parameters
Test incrementally - Verify each script separately
Monitor performance - Check execution times
Avoid circular references - Classes shouldn't reference each other
csharp
// Runs every 1 minute
public void CalculateKPIs()
{
double production = @Tag.ProductionCount;
double runtime = @Tag.RuntimeHours;
if (runtime > 0)
{
@Tag.ProductionRate = production / runtime;
@Tag.Efficiency = @Script.Class.ServerMain.
CalculateEfficiency(@Tag.PlannedProduction, production);
}
}
// Object: Tag.AlarmActive
// Expression:
TIF(Tag.Critical == 1, @Script.Class.ServerMain.SendAlert(), 0)
csharp
// Client Startup Task
public void InitializeClient()
{
@Display.MainPage.UserLabel = @Client.UserName;
@Display.MainPage.LoginTime = DateTime.Now;
}