5.3.1. Application Tag

Application tags are virtual tags generated by system based on project configuration. They are built-in system tags that user can use to obtain various server status such as current server time and device connectivity status among others. User cannot add or remove the application tags. All application tags are read-only.

In a project, these tags can be referenced when editing the SVG files in Inkscape SAGE. Simply type in the tag name for Get Animation in Object Properties setting. Aside from Inkscape, these tags can also be used in Javascript by using the getTag('tagname') function.

 Setting

Name

Tag name of the tag.

Type

Data type of the tag.

Dynamic

Indicate whether the value of the tag will be changed during runtime. If the value is Yes , the value will change based on runtime condition, otherwise, the value is fixed from the start of the project.

 Tags

All application tags have a app. prefix.

  Server environment

The following is the list of application tags related to server environment:

app.startupTime

The timestamp when the project was started in local time format.

app.startupTime.date, app.startupTime.year, app.startupTime.month, app.startupTime.day, app.startupTime.dayOfWeek, app.startupTime.time, app.startupTime.hour, app.startupTime.minute, app.startupTime.second

These tags are the breakdown of the app.startupTime tag.

app.currentTime

The system current time in local time format.

app.currentTime.date, app.currentTime.year, app.currentTime.month, app.currentTime.day, app.currentTime.dayOfWeek, app.currentTime.time, app.currentTime.hour, app.currentTime.minute, app.currentTime.second

These tags are the breakdown of the app.currentTime tag.

app.version

The version number string of the current IntegraXor server.

app.debug

The indicator whether debug option selected. When debug option is selected, debug messages emited by script will be displayed in Script status, and some screens marked as debug will be displayed in front end.

app.env.os.name, app.env.os.version, app.env.os.memory

The group of tags that tell the name and version of the operating system, and the memory installed.

app.homepage, app.homepage.raw

The URL of the default homepage.

app.processFolder, app.processPath

The location where the IntegraXor server is installed.

app.projectFolder, app.projectPath

The location of the running project.

app.projectName

The name of the running project.

app.server.primary

This tag indicates whether current server is the primary server in a redundant network.

app.server.rank

The rank of the current server in a redundant network.

  Task

The following is the list of application tags related to task:

app.task[XX].status, app.task[XX].statustext

The current status of the task indicated by XX.

XX is the built-in task name or add-in name, e.g. alarm , io , log , redundancy , etc.

The following status and statustext are possible:

  • 0 (Stopped) indicates the project is not in running state. This could be the project is openning, opened but not started, or totally stopped.

  • 3 (Starting) indicates the project is starting but not all tasks fully started yet.

  • 5 (Running) indicates the project is running.

  • 6 (Stopping) indicates the project is stopping.

app.alarm[XX].status

The status of the alarm or alarm group.

XX is the name of the alarm or alarm group.

The following status are possible:

  • 0 (Normal)

  • 1 (Reset)

  • 2 (Acknowledged)

  • 4 (Active)

  Device

The following is the list of application tags related to device:

app.device[XX].status, app.device[XX].statustext, app.device[XX].status.connected

The current status of the device indicated by XX.

XX is the name of the device configured.

The following status and statustext are possible:

  • 1 (Connected) indicates the device is connected.

  • 2 (Initializing) indicates the device is initializing.

  • 3 (Disconnecting) indicates the device is disconnecting.

  • 4 (Disconnected) indicates the device is disconnected.

  • 5 (Read error) indicates the server failed to read from the device.

  • 6 (Write error) indicates the server failed to write to the device.

If device status is Connected, Disconnecting, Read error or Write error, app.device[XX].status.connected is true , otherwise false .

app.device[XX].status.sent

The number of bytes sent for the device XX.

app.device[XX].status.succeeded

The number of bytes sent successfully for the device XX.

app.device[XX].status.speed

The average time in millisecond for every transaction.

[Tip] Tip

Use copy and paste method for the tag name to avoid mistakes (capitalization, dot location) in typing the longer tag names.


Prev Up Next
5.3. Tag Home 5.3.2. Action Tag