Skip to main content

XATA - SMS Alias

Defines SMS aliases that map a plain-text SMS word to a TAIP configuration command.

When a matching alias is received by SMS, Antares executes the associated command internally and replies with AliasName: OK or AliasName: FAIL.

Qualifiers: Q, S, and runtime SMS alias execution (R behavior).

Format

  • Query alias slot: >QXATA{AA}<
  • Define alias: >SXATA{AA}1;{CCC...};{DDD...}<
  • Undefine alias: >SXATA{AA}U<

Response format:

  • Defined slot: >RXATA{AA}1;{CCC...};{DDD...}<
  • Undefined slot: >RXATA{AA}U<

Fields

FieldDescription
AAAlias index (00 to 09)
1Define flag
UUndefine flag
CCC...Configuration command to execute (without > and <), up to 80 characters
DDD...Alias text (case-sensitive), up to 10 characters

Parsing Rule for Commands with Multiple ;

XATA uses the first and last semicolon as separators:

  • Characters between the first and last ; are the configuration command (CCC...).
  • Characters after the last ; and before < are the alias (DDD...).

This allows the stored command to include additional semicolons.

Constraints and Validation

  • Up to 10 aliases can be defined (00 to 09).
  • Alias text is case-sensitive.
  • Alias names must be unique across different slots.
  • Alias text cannot contain >, <, or ;.

SMS Runtime Behavior (R)

When an inbound SMS text does not parse as a TAIP command:

  1. Antares checks whether the text matches a defined alias (exact case-sensitive match).
  2. If found, Antares wraps and executes the stored command as TAIP (>{CCC...}<).
  3. Antares sends SMS response: {alias}: OK on success, or {alias}: FAIL on failure.
  4. If no alias matches, no SMS response is sent.

Examples

Define an SMS alias for a 5-minute periodic counter:

>SXATA001;SGC00TR00300;SetCounter<

Define an SMS alias where the command itself has multiple semicolons:

>SXATA001;SED00NV0;IP2+;ACT=SSSU001;SetEvent<

The stored command is SED00NV0;IP2+;ACT=SSSU001 and the alias is SetEvent.

Query a defined slot:

>QXATA00<
>RXATA001;SGC00TR00300;SetCounter<

Undefine a slot:

>SXATA00U<
>RXATA<

Notes

  • Alias definitions are persisted and reloaded at startup.
  • Use concise, unique alias names to avoid operator mistakes when sending SMS commands.