DSM Template Services Manual

Introduction
DSM Template Services Manual—427187-004
1-6
Templates and Template Files
When you set =_EMS_TEMPLATES DEFINE while processes are running, several
variables determine whether the process uses the new template file. As a result, you
should consult one or more of the listed documents to learn how DEFINE procedures
operate.
SSIDTOTEXT and TEXTTOSSID Procedures
SSIDTOTEXT converts the internal form of a subsystem ID to text. This is useful if an
application needs to display a subsystem ID.
TEXTTOSSID converts subsystem ID text to the internal form of a subsystem ID. This
is useful if an application needs to receive a subsystem ID that is input by an operator.
For more information, see the Guardian Procedure Calls Reference Manual.
Custom-Formatting Procedures (User-Written)
Although you can specify many display options for tokens through DDL definition files,
occasionally you might need to write a custom-formatting procedure to display a
token’s values in a specific way. The SPI_BUFFER_FORMATNEXT_ procedure can
accept formatted text that a custom-formatting procedure supplies. For writing
guidelines, see Custom-Formatting Procedures on page 2-19.
Templates and Template Files
Templates provide the instructions that procedures in applications use to construct text
from event, command, or response messages. Templates are stored in various
template files.
Template Services Template Types
Type Description
Format Tells the EMSTEXT procedure how to create an operator message from a
particular event message.
Override Specifies a site-specific value that a token in an EMS event message should
have. It can override certain token values in a message.
DDL-
defined
Tells the SPI_BUFFER_FORMATNEXT_ procedure how to construct display
text for tokens appearing in an event, command, or response message.
EMSTEXT also uses some DDL-defined templates, such as those that define
tokens or enumerations. DDL is a language defining data, such as constants,
definitions, records, and SPI token codes, token maps, and token types. DDL-
defined templates are constructed from this information.
Special Does not give formatting instructions for a particular message, but indicates for
the templates in an application’s template file attributes such as version,
subsystem name, and whether the formatting instructions in the file need the
DDL definitions of other subsystems or management applications.