CMS environment variables are the variables created in the process of site document generation. Environment variables are mostly defined at the beginning of the process based on address string parameters (URL). Environment variables contain all the necessary information about the selected document and about the executed interface command.
The meaning of SAPI:EXP expressions is in comparative operations with the CMS environment variables.
Starting at 1.1 version of XML Sapiens specification, environment variables represented as object tree. Root element of this tree is abstract element “project”. It defines interface of entire information area. “Project” objects set unite all site definition objects. Objects’ names correspond to variables, identifying sites or language versions of sites in information area structure. Each of these site objects contains own set of objects. As a result, to get value of configuration record “feedback_email” can be called in the following way:
project.sitea_en.config.feedback_email.value
which is equivalent to
sitea_en.config.feedback_email.value
If this value belongs to current site, syntax simplifies:
config.feedback_email.value
Below site objects collection is listed
|
Namespace | |
|
variable.value |
Variable of the site |
|
http_path.value |
URL of the site |
|
root_path.value |
Absolute address |
|
Navigation | |
|
date_start.value |
Selection starting date |
|
date_finish.value |
Selection finishing date |
|
limit_start.value |
Starting element of the selection list |
|
limit_finish.value |
Finishing element of the selection list |
|
Address String (URI) | |
|
REQUEST_URI.value |
Content of REQUEST_URI |
|
argv_string.value |
Content of the address string (URI) without navigation part. Supposed, that first part of address string defines document location, and the second part defines specific part of a document. I.e. navigation inside a document is built using this (second) part of address string. |
|
argv[el_index].value |
Content of the given address string argument |
|
len_argv.value |
Number of address string arguments |
|
last_argv.value |
Content of the last address string argument |
|
prev_last_argv.value |
Content of the last but one address string argument |
|
argv_nav[el_index].value |
Contents of given argument of navigation part of address string |
|
len_argv_nav.value |
Count of arguments in navigation part of address string |
|
argv_virtual.year.value |
The value of “year” filter in address string |
|
argv_virtual.month.value |
The value of “month” filter in address string |
|
argv_virtual.day.value |
The value of “day” filter in address string |
|
argv_virtual.id.value |
The value of “id” filter in address string |
|
Current Document | |
|
document.id.value |
Identifier of the current document |
|
document.variable.value |
Variable (object name) of the current document |
|
document.title.value |
Title of the current document |
|
document.id_parent.value |
Identifier of the parent section/document |
|
document.template.value |
Identifier of the presentation template |
|
document.flag_children.value |
Flag indicating the availability of children for the current document |
|
document.meta_description.value |
Document description |
|
document.meta_keywords.value |
Document keywords |
|
document.printversion |
The variable contains the TRUE value, if the requested document is a document print version. |
|
document.error404 |
The variable contains the TRUE value, if the requested document is not found. |
|
Path to the Current Document | |
|
trackinfo[el_index].href.value |
URI of the given path element |
|
trackinfo[el_index].title.value |
Title of the given path element |
|
Configuration | |
|
config.variable_name.value |
Value of the given configuration variable |
|
Other | |
|
user.name |
Authorized user’s name |
|
user.group[group_name] |
Flag which defines current user’s membership in a group |
|
user.role |
Authorized user’s role |
|
user.astatus |
Authorized user’s status |
|
keywords.value |
User retrieval request |
|
timestamp.value |
Current time in the TIMESTAMP format |
|
error_message.value |
Content of the error message |