On the Command Descriptions

Structure of the command descriptions

The Tcl command descriptions in this manual are ordered by command groups (e.g. obj or attribute). The command descriptions of a group are complemented by a table listing the fields or parameters for that group. For each field or parameter its name, the type of its value, and a short explanation are given. The table also specifies how the field or parameter can be accessed (read or write) and whether the value of the field or parameter can be set when creating a new instance (e.g. of a CMS file).

The command descriptions themselves contain the function declarations with an explanation of the task, the parameters, and the return value. The permissions a user must have to execute the command are listed as well.

Data types and notation

The data types of the field values and parameters and the return values of the function calls can be:

  • string: character string
  • stringlist: lists and arrays of strings
  • number: integer number
  • datetime: date and time
  • bool: boolean value (no | yes or false | true or 0 | 1)
  • void: nothing (no return value, no parameter)

In Tcl funktion declarations the following symbols are used:

Symbol Usage and example
( ) Links elements logically:
obj (withId id ) | (withPath path ) get parameter
[ ] The element in parenthesis is optional:
logout [login]
{ } The element in braces must be present at least once:
obj withId id mget {parameter}
| The vertical bar means that either the element to the left or to the right of it must be specified:
obj (withId id) | (withPath path) get parameter

Date format

All date and time stamp specifications are stored internally in GMT in canonical form as a 14-place string (starting from the left: Year (4 digits), Month (2 digits), Day (2 digits), Hour (2 digits), Minute (2 digits), Second (2 digits)).

For information on converting date and time stamp specifications from the canonical form to a conventional form, see System Configuration. The user defaults for the time zone and the output format are used during conversions of a date or time specification if you use the userConfig command instead of the systemConfig command (see User Preferences).

Identifier requirements

No identifier used in the Content Manager (for field names, logins, group names, CMS file names, etc.) may contain spaces or special characters. All characters except a-z, A-Z, 0-9, and the underscore are considered special characters. CMS file names may also contain the Dollar sign and the hyphen. On export, disallowed characters in file names are converted to underscores.