Macro API Introduction

Welcome to the Sym3 Macro API.

The macro API is used to automate or add functionalities to Sym3. Those macros are not saved in the project.

Here are the main entry points to access the API:

• Project: Gives you access to the current project. The value will be null if no project is loaded.
• Editor: Gives you access to the Sym3 editor. Example: execute the ‘Save As…’ function:
  • Editor: Designer Editor
  • Editor: Integrator Editor
  • Editor: Operator Editor
• Client: For Operator Client (called Operator Runtime)
• Server: For Operator Server

Example of usage:

• Import objects (Tags, Alarms, Equipment etc…) from a file (.tsv, .xml etc…)
• Automatic project generation
• Create scripts to check for errors
• Add new functionalities

Scripting Language

The language used is Javascript. Sym3 Macro API supports only ECMAScript 5.1 (ES5). Sym3 Macro API is build on top of .NET Framework so it will give you full access of the .NET Framework (Winform, Networking, SQL etc…)