RRT naming convention

A Runtime Replacement Tag (RRT) has three components consisting of the three-character RRT identifier, the separator (::), and the RRT name. These are all contained between two tilde (~) markers.

The figure below provides you with an illustration of the RRT definition. Each part of the RRT is designed to create a standard field tag replacement that can be expanded to all components designed and developed within the component framework.

Important: RRTs are case sensitive and cannot have any space characters between segments. Be careful to use the exact combination of lower and upper case characters specified by an RRT definition.

The table below provides details on each segment of the RRT:

Segment Name Description
Markers The tilde character (~) used to mark the beginning and the ending of each RRT. You cannot use the ~ character anywhere else within other parts of an RRT. Including the ~ as the value of a special field is not supported.
RRT ID Three characters that identify the component owning the RRT and responsible for replacing the tags with the actual values.
Separators Double colon characters (::) are used to separate the Component RRT ID from the actual Replacement Tag Name. The double colon is reserved and cannot be used anywhere else within other parts of an RRT. The following example would not be permitted as it repeats the :: within the Replacement Tag Name ~MYC::Invoice::Number~.
Replacement Tag Name The Replacement Tag Name or RTN can be the name of the metadata collected from a content source (such as a device) or a metadata generated by the component (for example, an XML data field). The following types of RTN are currently supported:
Reserved (RRTN)
Each component is allowed to create and maintain a set of reserved RTN or RRTN. Within the boundaries of each component reserved names have special meaning. Each component defines a list of RRTNs.
Field (FRTN)
Some components that support field names allow the fields to be referenced using the special enclosure character: %. An example of a field name used within an RRT is:
~MYC::%Invoice Number%~

This example allows replacement for a field called “Invoice Number” within the MYC component with the value of the field Invoice Number.

Special Sets (SSRTN)
These are special set of characters providing you with useful information on the job such as document date, document time, etc.
Important: Not all components support the SSRTN values. Look in documentation for a component to find if it supports SSRTNs.