Redbex Reference Manual - General output markups

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Navigation: Application Server > General information > Text templates

General output markups

This chapter lists variables (which can be primitives, classes and collections of primitives or classes) available for output markup with any text template in Redbex. The context in which the text template is used might provide additional variables. Refer to the documentation of the context for details.

Variable Name	Variable type	Description
GlobalSetting	Class	The GlobalSetting exposes the values of some Global Settings.
License	Class	The License object exposes some properties of the currently loaded license.
Support	Class	The Support object exposes contact information for technical support. This information is read from the currently loaded license. The values are therefore set by the distributor of the license.
Branding	Class	The Branding object exposes data that is used for branding Redbex. Branding information is read from the currently loaded license and is therefore provided by the distributor of the license.
Product	Class	The Product object exposes some information about the Redbex software product.
Instance	Class	The Instance object exposes details about the currently loaded instance configuration.
CurrentUser	Class	The User object exposes details about the user executing the text template.
CurrentDateTime	Primitive	The current date & time (when the template is processed). Use filters to format the date& time value according to your needs.

Table 1: Markup variables available with all text templates

GlobalSetting Class

Variable name	Variable type	Description
OperatorName	Primitive	Value of the respective global setting.
OperatorWebPage	Primitive
OperatorAdministratorEmail	Primitive
OperatorAdministratorTelephoneNumber	Primitive
ApplicationServerAddress	Primitive
SmtpAllowAttachments	Primitive
DomainName	Primitive

Table 2: Properties of the GlobalSetting markup class.

License Class

Variable name	Variable type	Description
LicenseeName	Primitive	Information about the currently loaded license
LicenseeContactDetails	Primitive
LicenseEmailAddress	Primitive
ProductKey	Primitive

Table 3: The License, Support and Branding classes expose data read from the currently loaded license.

Support Class

Variable name	Variable type	Description
SupportOrganization	Primitive	Product support information
SupportContact	Primitive
SupportTelephoneNumber	Primitive
SupportEmailAddress	Primitive
SupportWebPage	Primitive
SupportDescription	Primitive

Table 4: The License, Support and Branding classes expose data read from the currently loaded license.

Branding Class

Variable name	Variable type	Description
OrganizationName	Primitive	Branding organization name

Table 5: The License, Support and Branding classes expose data read from the currently loaded license.

Product Class

Variable name	Variable type	Description
Name	Primitive	Information about the product producer
Producer	Primitive
ProducerContact	Primitive
Copyright	Primitive
WebPage	Primitive	Redbex web page of Pöyry Infra GmbH
DocumentationWebPage	Primitive	Web page where the documentation of Redbex can be viewed.
DownloadWebPage	Primitive	Web page where the components of the Redbex system can be downloaded.

Table 6: The Product class exposes some general facts about Redbex

Instance Class

Variable name	Variable type	Description
InstanceIdentifier	Primitive	Name of the running Application Server instance
Protocols	Collection	A collection of objects of class Protocol describing the protocols available on this instance of the Application Server

Table 7: Miscellaneous variables

User Class

Property	Variable type	Description
Username	Primitive	Details of the currently accessing user.
FirstName	Primitive
MiddleName	Primitive
LastName	Primitive
Id	Primitive
CellNumber	Primitive
PhoneNumber	Primitive
EmailAddress	Primitive
Address	Primitive
Company	Primitive
Position	Primitive
Gender	Primitive	A string that defines the gender of the user possible values are: •Male •Female •Undefined
FormattedUserNameSystem	Primitive	Nicely formatted name of the currently accessing user. Includes username first name, middle name and last name
FormattedUserNameSignature	Primitive	Nicely formatted name of the currently accessing user. Includes pre-nominal letters, post-nominal letters, first name, middle name and last name
AuthenticationType	Primitive	A string that defines which authentication type is used for this user. Possible values are: •ApplicationServer •AdLdap •AdLdaps

Table 8: The User class that exposes properties a specific Redbex user.

Protocol Details Class

Property	Variable type	Description
Protocol	Primitive	Name of the protocol
Port	Primitive	Port configured for this protocol
Enabled	Primitive	Specifies if this protocol is enabled

Table 9: The protocol class exposing details about a specific connection protocol.