Skip to content

System Configuration Variables

imperia CMS has a variety of options for system configuration. This configuration is done via variables that are stored in files.

The most important variables are automatically set during the installation process. These can be changed via the user interface in the corresponding dialog windows, for example, the settings for the MAM or the configuration of the target system.

In addition to these basic variables, there are a number of other settings that allow you to customize your system to suit your individual requirements.

All configuration files can be edited via the GUI.

Note

If imperia 11 is installed on an existent imperia 9 system, a so-called “compatibility layer” is installed. This compatibility layer interprets some of the system.conf variables that no longer exist in imperia 11. Thus, among other things, project scripts continue to operate. In a “fresh” imperia 11 system, these variables are no longer available. Please note that the compatibility layer is only equipped with limited functionality in order to facilitate the transition.

The following configuration variables are shown grouped thematically.

Note

Both the parameter name and the value must be enclosed in quotation marks.


ACL Group#

ENABLE_FLEX_ACL Variable#

Set this variable to 1 to enable the ACL for flex and slot modules.

ENABLE_ADDON_PERMISSIONS Variable#

Set this variable to 1 to enable the Imperia Release News Widget for roles with appropriate access permissions.


Archive Group#

ARCHIVE_DISABLE_DELETE Variable#

Set this variable to 1 to disable the delete function in the archive, document browser and MAM.

ARCHIVE_DOC_DISPLAY Variable#

Indicate the value - e.g. Doc-ID - to be displayed in case the document has no title by setting the following variable:

"ARCHIVE_DOC_DISPLAY" = "<!--XX-TEXT:title--> (<!--DOC_ID:0-->)"

IBS_PAGE Variable#

Set this variable to a value >= 0 to enable pagination in the archive. The value indicates how many documents should appear on a page in the archive. The display of categories and document versions in the archive does not affect this variable.


Authentication Group#

AUTH_PLUGIN Variable#

imperia's authentication plug-in.

Possible values (to be found under /dev/site/modules/core/Dynamic/Authenticator) for "AUTH_PLUGIN" =

    "Superuser"
    "Basic"
    "LDAPAuth"
    "Demo"
    "HTTPBasic"
    "Null"
    "Password"
    "SuperuserGroup"

AUTH_PLUGIN_BACKUP Variable#

In this variable, the authentication mechanism from AUTH_PLUGIN is saved when the system is in maintenance mode. When the maintenance mode is switched off this value is then written back to the AUTH_PLUGIN variable.

This variable was introduced in imperia 8.

DISABLE_FOREIGN_USER_SYNC Variable#

If this variable is set, no imperia users will be generated on log-in. In case the variable is not set, the system will continue generating a new user for each external one.

The variable takes effect, if you are using one of the following authentication protocols:

  • LDAP

  • Kerberos

  • Basic

IMPBLOG_NOCAPTCHA Variable#

Deactivate the Captchas for the blogging module by setting IMPBLOG_NOCAPTCHA = 1 in the system-conf.


Automatically set variables#

Following variables are set automatically by the system:

IMPERIA_LIVE Variable#

This variable is set when you are currently on the live system.

Other variables


Caching Group#

IMPVIEW_CACHE_POLICY#

By setting this variable to the value "timestamp" in the system.conf, the View template will be reloaded with every change.

Variables SITE_META_CACHED and METADIR_CACHED#

Both variables are used to implement site/meta/-Cache by different "strategies".


Category Group#

CATEGORY_TEMPLATE Variable#

Set a template for editing the meta information of categories.

This variable was introduced in imperia 8.

The default value is Fallback-Template.

DEFAULT_DIRECTORY Variable#

Set the default directory for categories.

The default value is /.

DEFAULT_FILENAME Variable#

Set the default file name for documents.

The default is index.html.

CATEGORY_QUICK_CONFIG Variable#

Setting this variable will simplify the category management dialog. The Edit permissions section is not displayed. Furthermore, the Category ACL tool dialog contains only essential information.

DIRECTORY_COUNTER_REGEX Variable#

This system configuration variable is used when restructuring categories, that contain “counter” directories. The variable should contain a Perl regular expression, that describes the format of the “counter” directories, that have to be moved along with the documents.

The regular expression is used to match the parent directory where a document currently exists. Examples:

# match directories which names consist of 5 or more digits:
DIRECTORY_COUNTER_REGEX = "\\d{5,}"

# match only directories which are based on a document's node_id:
DIRECTORY_COUNTER_REGEX = "0*{node_id}"

# match directories that are in hexadecimal format:
DIRECTORY_COUNTER_REGEX = "[0-9A-Fa-f]{5,20}"

DISABLE_CATEGORY_SEARCH Variable#

This variable relates to Disable Category Search for given Groups which is to be found in the GUI under Menu -> Structure -> General Settings.

MAYMETAVIEW Variable#

In order for editors to edit meta fields, you have to set the system.conf variable MAYMETAVIEW to selected roles ID, along with the priviliges on the controller /document/meta_view as well as write permissions on the document

Example:

"MAYMETAVIEW" = "-3" would mean that additional to the superuser also members of the group with the ID -3 are also allowed to see the meta view.

DOCTREE_PLUGIN_CONF Variable#

This variable is very useful for development/QA purposes:
When you want to quickly change current doctree to test some feature/bug you now use variable DOCTREE_PLUGIN_CONF and don't have to modify "DOCTREE_PLUGIN" and also not need to replace site/config/repositories/default.conf with a new one, specially crafted for that doctree.

Set the variable as in the following example (where imperia_11_mysql.conf and pg.default.conf are doctree config files for MySQL and PostgreSQL respectively):

    DOCTREE_PLUGIN_CONF = 'MySQL:imperia_11_mysql.conf, PostgreSQL:pg.default.conf'

You can configure all the available doctree plugins.
Each config file, specified in the DOCTREE_PLUGIN_CONF is then used (read and write) when that doctree is selected.
In the example above the file imperia_11_mysql.conf is used when MySQL doctree is selected and the default.conf is ignored. No change to default.conf must be made.
For those doctrees not listed in the DOCTREE_PLUGIN_CONF the default.conf is used, as usual.

Now, after you've created a full mapping to all doctrees, all you need to do, to change the doctree is to simply set the DOCTREE_PLUGIN Variable with the desired doctree name.


Date and Time Group#

CALENDAR_TIME_FORMAT Variable#

This variable is used to set the time format of dates that are generated with imperia's calendar widget. You can choose between 12- and 24-hour time format by setting the variable to 12 and 24 respectively.

CALENDAR_DISABLED Variable#

This variable is used to disable the calendar.

DATE_COMBO_MINUTES_STEP Variable#

When using the dropdown lists for entering date and time, the grid can be inputted in minutes. This variable is used to set the interval. For example, if 15 is set, the values for minutes available will be: 0, 15, 30, 45.

If a document is already recorded with minutes that don't fit the framework, the value is rounded to the nearest framework value.

Important

If DATE_COMBO_MINUTES_STEP has a value, the JavaScript widget can no longer be used for time settings (hours and minutes).

"DATE_COMBO_MINUTES_STEP" = "10"

DATE_COMBO_YEARS_LIMIT Variable#

A drop down boxes is used to enter the year in the calendar widget. By default, the list consists of the current year and 15 years into the future. Using this variable, this could be changed. For example, if the DATE_COMBO_YEARS_LIMIT variable has a value of 2, the list will consist of the current year and the next two years.

"DATE_COMBO_YEARS_LIMIT" = "2"

DISPLAY_TIME_ZONE Variable#

By default, date and time in imperia's interface are displayed to match the time zone settings that a user has set in his/her operating system. If this is undesirable, this conversion may be disabled by setting the following in the system.conf:

"DISPLAY_TIME_ZONE" = "UTC"

When imperia starts, the cookie that stores the user's time zone is read first. If this cookie is present, its value is used. If it isn't present or its value is not valid, the time zone of the system is read again and it's stored in a cookie. The server time is defined by the time zone and that is used to calculate the time that will be displayed.

If the value of AUTH_PLUGIN is Password, the JavaScript /imperia/jscript/timezone.js is used to set the timezone.

The set user time is not always applicable, as it can vary more or less. The server time is always used with an offset of the set in the browser time zone.

Usually, the time zone is taken from the browser and it is saved in a user's profile. In rare cases with some browsers, it is not possible to determine the time zone when logging in. In this cases the time zone may be set as follows:

  1. Open the menu Account -> Profile -> Preferences.
  2. Löschen Sie dort die Datei tz_info.

Variable PRESERVE_MODIFIED_DATE_ON_REIMPORT#

Setting this variable to 1 prevents the updating of the meta field __imperia_modified when reimporting.


Desktop Group#

DESKTOP_COLUMN_MODULES Variable#

A list of modules for desktop columns. The individual elements are separated by semicolons. Modules must be stored in a directory under site/modules/core.

This variable was introduced in imperia 8.

For the values use a semicolon separated list with the package names of the Perl modules that include the columns' definition. Modules must be stored under site/modules/core.

Example: * "DESKTOP_COLUMN_MODULES" = "Imperia::Desktop::myDefaultColumns;mycols::mySpecialColumns". * in this example, two modules are included in the system. * the associated files are to be found under site/modules/core/Imperia/Desktop/myDefaultColumns.pm and site/modules/core/mycols/mySpecialColumns.pm.

DESKTOP_CONFIG_MODULES Variable#

A list of modules for desktop configuration. The individual elements are separated by semicolons.

This variable was introduced in imperia 8.

In this variable you store the Package names of the Perl modules including your Desktop Views. Modules must be stored in a directory under site/modules/core and the names must be separated by semicolons

Example: To store the modules site/modules/core/Imperia/Desktop/myDefaultConfig.pm and site/modules/core/mycols/mySpecialConfig.pm, set following:

"DESKTOP_CONFIG_MODULES" = "Imperia::Desktop::myDefaultConfig;myconf::mySpecialConfig"

Display Group#

CATEGORY_DELETION_PROMPT Variable#

If this variable has the value 1, the system will display a confirmation dialog before deleting an empty category.

LATCHING Variable#

Use this variable to turn on “latching” of documents in edit mode. Then an additional button, with which content can be saved without leaving the workflow step, appears in the controls in the edit step of a document.

Latching can also be set in the Edit plug-in in the workflow. There are three options:

  • With the default setting, the setting value is taken from the system configuration.

  • If latching is set to disable, the button is hidden, even if the system configuration is set differently.

  • If the value is set to latching, the button is shown, even if the system configuration is set differently.

MD-WINDOW-HEIGHT Variable#

Use this variable to specify the height of all MAM windows. The value is numeric and is implemented as height in pixels.

MD-WINDOW-WIDTH Variable#

Use this variable to specify the width of all MAM windows. The value is numeric and is implemented as a width in pixels.

NO_HTML5 Variable#

This system.conf variable deactivates HTML5 form fields as email, tel, color, url, date, datetime, datetime-local, month, week, time, range, number and search.


Document Browser Group#

DOC_CAT_ORDER_BY_NAME#

Activate alphanumeric sorting of the category tree in the document browser by setting this variable to 1.


Document Storage Plug-in Group#

FILE65-DOCUMENT-DIR Variable#

Set a directory where the File65 plug-in documents will be stored.

The default value is SITE-DIR/documents.

BINARY_DOCTREE_PLUGIN Variable#

If you are using a SQL data storage and do not want your imperia to store the binary asset data in the database, set this variable to the value File65.


File Transfer Group#

OPEN_3_USE_SYSREAD Variable#

This variable is needed on Linux systems with more recent kernel versions if file transfer via Secure Copy has to be used. Set it to 1, to enable SYSREAD with Secure Copy transfers.

This variable was introduced in imperia 8.

SSH-OPTIONS Variable#

Options to be used with SSH connection can be entered through this variable. In order for the shell connections and the imperia connections to be stored in the same way, the option has to be administrated through the .ssh file.

SSH-CLIENT Variable#

The absolute path to the SSH binary file. This is needed if the default value does not apply. The default is ssh.


Flex Modules Group#

ALLOW_PERL_UPLOAD Variable#

This variable controls whether Perl flex modules can be uploaded and edited in imperia.

EDITMODE_DEFAULT_CONTROL_VIEW Variable#

This variable can be used to specify the default VIEW for a control element (such as a flex module). Example:

EDITMODE_DEFAULT_CONTROL_VIEW = standard.html

If you want to overwrite this behavior for a given category or document, you can use the meta field __imperia_editmode_default_control_view. imperia first checks the document's meta information and then the meta information of the category. In case this meta variable does not exist, or is empty, the value of either the system configuration variable or the base.html view is used.

EDITMODE_CONTROL_INSERT_JSON_AS_AJAX Variable#

If this variable is set, all JSON-loaded modules will be loaded as if the loading method was set to AJAX.

EDITMODE_CONTROL_INSERT_AS_AJAX Variable#

If this variable is set, imperia forces AJAX as a default loading method for all control modules and also implicitly sets EDITMODE_CONTROL_INSERT_JSON_AS_AJAX to true.

If you wish to change this behavior for a certain module, set the JS_OPERATIONS parameter to false.


Hermes Group#

HERMES_RECONNECT Variable#

Setting HERMES_RECONNECT to 1 ensures that on each pass of the Hermes, a new connection to the database is established.

This variable was introduced in imperia 8.5.4.

MAX_AUTO_PUBLISH_DOCS Variable#

This variable specifies the maximum number of documents that will be released within a loop of the Hermes. The default value is 25.

HERMES_INCOMING_DELAY Variable#

In some FTP servers the locking mechanism during a file transfer is wrong. This variable can be used to set the seconds, after which the MessageCheck plug-in will pause the file, during the data processing to influence on the error.

HERMES_IMPORT_REINIT_TIME Variable#

The Import.pm reinitializes the data storage every 1 hour, but can be adapted by the system.conf variable HERMES_IMPORT_REINIT_TIME (in seconds)
By that, the reinitialization can be changed to e.g. 18000 (5 hours) or 86400 (1 day).


History Group#

DISABLE_HISTORY Variable#

There are three possible values:

  • COMPLETELY - no history is displayed.

  • 1 - the history is not displayed in the confirmation dialog, but there is a link leading to it.

  • 0 - the history is displayed.

This variable was introduced in imperia 7.5.

HISTORY_HIDE_DATE Variable#

If this variable is set to yes, only users with access to the superuser group will be able to see the data entry in the history.

This variable was introduced in imperia 7.5.

HISTORY_HIDE_DATE_SU Variable#

With this variable all date entries in the history are hidden from all users, including the superuser.

This variable was introduced in imperia 7.5.


imperia cookie name.

This variable is used to determine the validity (Time To Live) of imperia cookie. The value is numerical and indicates the lifetime of the cookies in seconds. If a user is inactive for a longer period of time than the one set here, his/her session is automatically deleted and s/he must log in again. The default value is 7200 seconds.

SESSION_EXPIRY_REMINDER Variable#

This variable controls whether a notification is displayed to users when their session is about to expire. By default, the feature is enabled and a notification will be displayed 5 minutes before the session expiration. The notification window contains a link, that can be used to extend the current session to the value of COOKIE_TTL.

If the value of COOKIE_TTL is less than 300 seconds, no notification will be displayed.

Along with the pop-up window, a sound notification, controlled by the SESSION_EXPIRY_REMINDER_AUDIO variable, is played (see below).

SESSION_EXPIRY_REMINDER_AUDIO Variable#

Set this variable, if you wish to have a sound notification when the session is about to expire. By default, the audio is turned on.


I18N Group#

DEFAULT_LOCALE Variable#

The default locale settings are stored in this variable.

The default value is C.

DEFAULT_LANGUAGE Variable#

This variable stores the country code, for example, DE or UK.

SYSTEM-LANGUAGE Variable#

This variable stores the selected system language.

SYSTEM_LOCALE Variable#

This variable stores the locale setting of the system.

USER_LOCALE Variable#

This variable stores the user's locale setting.


imperia Develop Session Group#

ADDR_AUTH Variable#

This variable is used to make sure that changing the remote address invalidates the login session. Additionally — if set to PROXY — the remote address is determined by the “forwarded_for” HTTP header. Other possible value is: FIX.

CRYPT_ALGO Variable#

This variable stores the encryption algorithm for the cookies of session management on the production server.

Note

For more information, see Crypt::CBC (3).

The default value is DES_PP.


imperia GUI View Group#

VIEW_TEMPLATE_DIRS Variable#

Use this variable if new skins have to be added for imperia's GUI . The values of the variable have to be a pipe-separated list of directories where your own skins are located:

"VIEW_TEMPLATE_DIRS" = "mysite|/etc/imperia/global|imperia/default"

The default templates, located in site/view/imperia/default, can be used as a base for the new ones. Copy them to the new directory and edit them according to your desires.

Important

Do not overwrite the files in site/view/imperia/default.


Initial Settings Group#

IMPVIEW_MINIMIZE_IMPORTS Variable#

The variable IMPVIEW_MINIMIZE_IMPORTS activates CSS and JavaScript files compression and concatenation.

SITE-DIR Variable#

This is one of the few configuration variables that are NOT set in /site/config/system.conf, but in /cgi-bin/imperia.conf.

This variable stores the absolute path to the site directory of your installation.

Important

For safety reasons the three directories SITE-DIR, CGI-BIN and DOCUMENT ROOT should be separated. That is, none of these three directories should be located within one another, because in this way, accidental or malicious access by users via the Internet would be made possible.

DOCUMENT-ROOT Variable#

This variable contains the absolute path to the document root of your imperia installation. Example: “DOCUMENT-ROOT” = “/usr/httpd/htdocs”.

Note

The directory “imperia” should be located below the base directory for web documents of your web server. For example, “/usr/http/htdocs/imperia”.

CGI-BIN Variable#

Note

This system configuration variable is only available in the compatibility layer!

This variable contains the URI of the cgi-bin directory on the web server, i.e. the path starting from the document root of your server, for example, '/cgi-bin', '/cgi-shell', '/cgi/perl', etc.

The default value is /cgi-bin.

CGI-DIR Variable#

Note

This system configuration variable is only available in the compatibility layer!

This variable stores the absolute path to the cgi-bin directory of your web server. All imperia CGI scripts are in this directory.

DEMOMODE Variable#

This variable can be used as a backdoor to the system for emergencies. Should you have no access to your system, comment out the respective line in the site/config/system.conf file. You can then log in to the system again and have superuser privileges (each user then logs into the system has superuser privileges). Then a new user can be created. Remove the comment from the line to return to normal operation.

The default value is no.

DISABLE-FLOCK Variable#

Set this variable to 1 to disable file locking. This is necessary if the operating system on which imperia is installed does not support this mechanism (e.g. Windows 98).

DOCTREE_PLUGIN Variable#

Specifies the document storage plug-in to be used.

The default value is File65.

With this variable parts of the filesystem that are outside of the document root can be integrated. Use this variable only in urgent cases, as it can potentially make your system vulnerable to attacks.

IMPERIA-VERSION Variable#

Please, do not change the imperia version number.

IMPERIA_ERROR_LOG Variable#

Set this variable to 1 for a separate error log. The file is located under SITE-DIR/logs/error.log.

Note

This variable is automatically enabled in Windows installations.

Important

In case you are using IIS, this variable has to be set and it should be done manually.
Since imperia 9 it is mandatory; if this system.conf Variable isn't set the error messages will be thrown into the HTML header.

MAX_REQUEST_SIZE Variable#

Use this variable to set the maximum size in bytes for files when uploading. The specification must be numeric. Attempts to upload files that are larger than this value result in an error message. If this variable is not set, files of unlimited size can be uploaded.

This variable was introduced in imperia 6.5.2.

Example (limit upload to 500 MB):

MAX_REQUEST_SIZE = "524288000"

MIME_TYPES Variable#

With these variables, an alternate path to your MIME type database can be defined. Here, project-specific extensions can be safely updated. Note that in order to remain in force the required types must be enlisted in the original file.

SECRET_FREQUENCY Variable#

Set the time in seconds that has to elapse for the secret cookie to be renewed.

The default value is 3600.

SECURE_UMASK Variable#

Mask that generates the secure directory.

ABS_DOC_ROOT Variable#

ABS_DOC_ROOT contains the domain name of the imperia backend and is set automatically. If your system is behind a proxy server, you should additionally set the variable REVERSE_PROXY_ROOT.

OPERATING-SYSTEM Variable#

The operating system that imperia is installed on. The available values are UNIX and DOS.

The default value is UNIX.

REVERSE_PROXY_ROOT Variable#

Use this variable to indicate the address of your Reverse Proxy Server so imperia can convert the internal URLs.

ALT_REVERSE_PROXY_ROOT Variable#

There, you can add the value of an alternative server.

PERL_PATH Variable#

By setting this variable to an absoluten path to your Perl (e.g. c:\Perl\bin\perl.exe), this will use the indicated Perl.

IMPERIA_SERVER_ENABLE_SSI Variable#

By default, SSI are not interpreted by the internal Imperia Webserver (which is not intended for the live system). To change that, following line has to be added to the file site/config/system.conf:

IMPERIA_SERVER_ENABLE_SSI = 1

This variable enables link checks with HTTP requests.

NOPROXY Variable#

Without proxy.

PROXY_FTP Variable#

FTP-Proxy.

PROXY_HTTP Variable#

HTTP-Proxy.


Live Preview-Gruppe#

You are able to turn on/off the Live Preview and also to configure the responsiveness in system.conf:

System.conf-Variable range of values description
DOCUMENT_EDIT_LIVE_PREVIEW 1 or 0 turn on/off systemwide
DOCUMENT_EDIT_KEYUP_INTERVAL milliseconds time interval between the last keyboard input in the Edit mode and the execution of the preview
DOCUMENT_EDIT_CHANGE_INTERVAL milliseconds Time interval between misc. change in Edit mode and the execution of the preview

PREVIEW_ANCHOR#

This variable enables you to configure the anchor tags in the Live Preview.
Those anchors are used in in order to go directly to the position that has been changed in the EDIT mode.

The default view (under view/imperia/default/layout/previewmode/live_preview_anchor.html) can be replaced (not overwritten as it will be generated again) by indicating the path to the *imperia View file, e.g. /layout/components/myanchor.html.
On the level of categories, you can set this setting via the category's variable __imperia_live_preview_anchor_template.
On the level of modules, you have the parameter PREVIEW_ANCHOR.
It is recommended to adapt the default setting to your CSS.

Alternatively, you can deactivate anchor tags in the preview (not recommend!):
Users are able to use the imperia GUI to deactivate the preview under Look and Feel.
As a system administrator you can deactivate the display of anchors system-wide by setting the value 0 or none.

NO_RESPONSIVE_PREVIEW#

imperia creates a frame around the preview in order to display the preview in different resolutions.

In order to deactivate the responsive Preview set: NO_RESPONSIVE_PREVIEW = 1


Lock Constants Group#

Note

The system configuration variables in this group are relevant only for MS Windows!

LOCK_EX Variable#

Internal value of the file locking.

The default value is 2.

LOCK_NB Variable#

Internal value of the file locking.

The default value is 4.

LOCK_SH Variable#

Internal value of the file locking.

The default value is 1.

LOCK_UN Variable#

Internal value of the file locking.

The default value is 8.


Look and Feel Group#

The setting of your imperia system can be changed not only via the GUI, but also with the following variables:

IMPERIA-VIEW-Variable#

(former COLORSCHEME)

You can change the default theme (IMPERIA_VIEW = default) for your system. This will be the default one for users who haven't set any preferences.

To do so, set the system.conf variable IMPERIA-VIEW to one of the predefined themes:

  • darkred
  • darkgreen
  • darkblue
  • darkviolett (Note: written with double "t")

Example:

 "IMPERIA_VIEW" = "darkblue"

IMPERIA-LOGO-Variable#

You can replace imperia logo (which is displayed in the upper left corner) with your own.
The size of the is 227x70 Pixels.

To do so, in the variable IMPERIA_LOGO set the path to your new logo.

Example:

"IMPERIA_LOGO" = "/imperia/rebelia.png"`

Alternatively, you can use the variable IMPERIA_LOGIN_LOGO.

IMPERIA-HEADER-Variable#

You can set a title for your system. Especially, when having different system (e.g. test and develop system) a title can be used to differ between those systems.

Set the variable "IMPERIA-HEADER".

Example:

IMPERIA_HEADER" = "TESTSYSTEM"


Mail Group#

FORWARDED_INTERNAL_MESSAGES_PREFIX Variable#

Use this variable to enable the feature Forward to external email.

Forward options are hidden if system_conf. SMTP_SERVER is not set.

SMTP_SERVER Variable#

The SMTP_SERVER variable should contain the name or IP address of the mail server that will be used to transfer your e-mail.


Media Asset Management Group#

DISABLE_8BIT_FILENAMES#

By setting 1 this variable forces 8-bit file and directory names upload in a “safe” character set.

If the variable is set, it is no longer possible to create a category whose directory contains NON-ASCII characters.

Furthermore, it is no longer possible to upload an asset to an existing category whose directory contains NON-ASCII characters.

MAM_CAT_ORDER_BY_NAME Variable#

Activate alphanumeric sorting of the category tree in media asset management by setting this variable to 1.

MAM_ENABLE_PUBLISH Variable#

This variable is not valid anymore since imperia 9. It was used for activating the independent publishing of asset which is now enabled in the MAM, see also Enable Independant Assets Publishing, and also in the Document Browser.

MAM_CATEGORY_TEMPLATE Variable#

Enter the name of system-wide templates for asset categories creation (under site/templates). The information is given without file extension. If this variable is not present, defining the template is done via the category's settings.

MAM_GET_UPLOAD_FILENAME Variable#

This variable enables an additional field in the upload box of an asset template. This field is initialized with the default file name from the asset category. Delete the default and leave the field blank if you want to accept the original file name for the asset.

"MAM_GET_UPLOAD_FILENAME" = "1"

MAM_HIDDEN_FIELDS Variable#

This variable affects the display of columns in the list view of asset details and the corresponding links in the IconBox view. Note a comma-separated list of column whose display has to be avoided. The system evaluates the list as a regular expression. Here is an example:

"MAM_HIDDEN_FIELDS" = "directory, .*filename" => m/^directory|.*filename$/"
"MAM_HIDDEN_FIELDS" = "directory,template" => m/^directory|template$/"

The following table lists the available column names:

Column name (list view) FeldID
- (Checkbox) __mam_select
Icon __mam_icon
Insert __mam_insertion
Title __mam_title
Filename __mam_filename
Directory *
Filesize __mam_filesize
Details __mam_details
Reference __mam_references
Delete __mam_delete
Created by __mam_createdby
Last Editor __mam_editedby
Created at __mam_createdat
Template *
Dimensions __mam_dimensions
User action __mam_action
User variants __mam_variants
Archive __mam_archive
Re-import __mam_reimport
Change Actions __mam_change
Category __wf_category

Note

The Icon field can only be hidden in the list view. For users with superuser group this has no effect.

MAM_JPEG_QUALITY#

This parameter influences the visual quality and file size of JPEG versions of assets. The default value is 85, and the values range from 20 to 100. The higher the value, the better the visual quality, but also the file size is increased.

"MAM_JPEG_QUALITY" = "75"

The MAM_LINKS_STYLE variable sets the appearance of the links in the columns of the list view. The syntax is as follows:

"MAM_LINKS_STYLE" = "[Option]"

These three options are available:

ICON
Small icons are displayed in columns.

TEXT
Text links appear in columns.

ICON,TEXT
Both icons and text appear in columns. This is the default setting.

LINKTOOL_HIDE_ICON Variable#

Giving this variable a value of 1 will hide the linktool buttons in the templates.

MAM_MULTIUPLOAD_OPTIONS Variable#

The variable MAM_MULTIUPLOAD_OPTIONS sets the options for the multiple upload. The specification of options is in the form of a comma-separated list of numbers.

Example:

"MAM_MULTIUPLOAD_OPTIONS" = "2,3,4,5,6,7,8,9,10"

Note

The performance may decrease noticeably with more than 15 assets. This is only a guideline. Depending on the system conditions, it may happen even sooner.

MAM_MULTIUPLOAD_SIZE Variable#

The multiupload option allows for the creation of multiple assets in one operation. The MAM_MULTIUPLOAD_SIZE variable sets the number of assets that can be uploaded simultaneously.

Example:

"MAM_MULTIUPLOAD_SIZE" = "5"

MAM_PUBLIC_SPOOL Variable#

If this variable is set to 1, all users may import assets in all MAM categories via the /cgi-bin/site_mam_spool_import.pl script. Information about the script, see in the chapter Importing Assets from a Folder or Zip File .

MAM_READ_ONLY_FIELDS Variable#

Use this variable to influence the details of the popup list view. Specify which fields should not be editable by a user. By default, this fields are directory , filename and template .

Example:

MAM_READ_ONLY_FIELDS = "width,height"

MAM_SAVED_FILTERS Variable#

This variable contains saved filters available for all users. For information on global filters, see the Chapter Defining Global Filters.

MAM_SPOOL_CHARSET#

If the character set of the operating system is not UTF-8, it must be specified when using the MAM's mass import, so that special characters are correctly implemented in imperia's interface and log files.

MAM_OEM_CODEPAGE#

This variable is used when importing assets into the MAM from a zip file. You have to set it when the zip archive was generated under Windows®. The variable contains the OEM code page of your system. For example, with German, the variable is set as follows:

"MAM_OEM_CODEPAGE" = "cp850"

Under Windows-based imperia installations, you can set the variable to “auto”. In this way, the system will automatically detect the OEM code pages of your system.

MAM_SPOOL_PATH Variable#

This variable holds the directory that is the source for uploading zip files in the MAM via the /cgi-bin/mam_spool_import.pl script (see also the chapter Importing Assets from a Folder or Zip File).

"MAM_SPOOL_PATH" = "/my_spool"

MAM_THUMBNAIL_SIZE Variable#

This variable sets the default thumbnail size. The value has to be numeric and is implemented as width in pixels.

Note

After this variable is set run the admin_mam_thumbgen.pl to enforce the change.

MAM_MIME_MAP Variable#

Use this variable to save MAM images in other formats (separated by comma).

Example: Normally svg images are not shown as thumbnails. Use the variable like this, to create a png as thumbnail for the svg:

 MAM_MIME_MAP = 'svg+xml: png'

Note

After including the variable, the asset as to be re-imported.

MAM_UNIQUE Variable#

Set this variable to 1, if all assets and their associated variants have to be stored in subdirectories of the relevant categories in the file system. This can prevent the accidental overwriting of assets with the same file name or identical variants when moving assets.

PROTECT_REFERENCED_ASSETS Variable#

Set this variable to forbid deletion of referenced assets via the MAM or the document browser.

MAM_EXTENDER_NORMALIZE Variable#

If this variable is set, file extensions are taken as this and the mime.type is not changed.

GLOBAL_METAKEYS Variable#

To make an image description globally available, set

    "GLOBAL_METAKEYS" = "alt,description,licence"

MAM_ADD_USER_FIELDS Variable#

To have the Alttext displayed, set

MAM_ADD_USER_FIELDS = "alt:Alternativtext description:Bildunterschrift licence:Lizenzinformation"

Multilanguage Group#

ML_FIX Variable#

If this variable is set, imperia does not try to fix the content of multilingual documents. The affected imperia versions are imperia 9.2.0 and 9.2.1.

ML_AJAX Variable#

Via the AJAX multilang feature you can load addtional languages. This is useful, if you have too many languages to use the normal multilang.

It can be activated via the system variable ML_AJAX.

ML_RANGE Variable#

ML_INDEX Variable#

In order to store the used languages, set for example:

"ML_INDEX" = "de=0, en=1"

It should only be used in the context where multilang-start and multilang-end is used and not in the complete chain of slots,flexes and iblocks. Because otherwise content of those slots, flexes and iblocks cannot be copied via "Multilang copy".


One-Click-Edit Group#

ONECLICKEDIT Variable#

Defines how the One-Click-Edit treats copies of a document system-wide. With the default value, DOCUMENT, OCE adjusts to document-based processing. Set the variable to FILE if you want, for example, to be able to delete copies of a document.

Note

If you wish to change the behavior of the OCE toolbar, see the chapter One-Click-Edit in the programming documentation.


Password Group#

PASSWORD_GENERATOR_PLUGIN Variable#

Define a password generator plug-in. In case the variable is not set, the system uses imperia.pm, which generates a 9 characters long password with 3 uppercase, 3 lowercase letters and 3 digits.

PASSWORD_RULES Variable#

Define a comma-separated list of password limitations. Each element of the list is the name of the plug-in, optionally followed by its configuration separated with white space. Example:

PASSWORD_RULES = "digits > 4, whitespace, length < 30, length > 5"

If an element is left without configuration (as “whitespace” in the example above), the default one is used instead:

digits >= 1
whitespace <= 0
uppercase >= 1
lowercase >= 1
punctuation >= 1
length >= 8

PASSWORD_RENEWAL Variable#

Set who has the privileges to reset an expired password. Possible values are user and admin (default).

PASSWORD_AGE Variable#

Set an expiration time for passwords. Default is 30 days. The value for this variable should be in seconds.

PASSWORD_REMINDER Variable#

If this variable is set, the login mask or the email contain a link for sending a password to a user (or to reset the password).
If PASSWORD_REMINDER is set to expire, the user gets an e-mail with an activation link that expires at 00:00 UTC on the next day.
If the variable is set to password, an auto-generated password is sent to the user.

Note

Make sure the variable SMTP_SERVER is set!

You can find three templates, that you could copy and customize to meet your requirements, in site/view/imperia/default/controllers/roles/user/password_recovery:

  • display.html - here, a user provides a login and e-mail address.

  • submit.html - a confirmation whether the e-mail was sent or not.

  • email.txt - the text of the e-mail.

    !!!note "Please note"
            In case the variable is set to `password`, you have to change the email, i.e. add `{% raw(password) %}` in the body of the email in order to display the password generated by *imperia*. If this is not done, there will be missing links in the email.
    

PASSWORD_SETTERS Variable#

This variable relates to the setting Privileges for resetting a users password, where you can Select groups, who can set a new imperia password, without knowing the old one.

In the GUI, you can change this under Menu -> Structure -> General Settings.


PHP Group#

PHP_CLI Variable#

Type the PHP version used. Set this variable to true, if you have the CLI version of the PHP interpreter in use. By default, the system goes from the CGI version.

PHP_PATH Variable#

The variable stores the path to the PHP interpreter.


Publisher Group#

DEFAULT_VERBOSITY Variable#

For verbose output when disconnecting set this variable to 1.

INFORM_ROLE_ON_PUBLISH Variable#

If you want to send notifications when publishing set this variable to 1.

This variable was introduced in imperia 7.5.

SERIALIZER Variable#

This variable stored the serialization method that the publisher uses. With “DUMPER” choose the Data::Dumper(3) module, without the storable variable. With any other value, the system searches the plug-in's name in the site/modules/core/Dynamic/Serialize directory of your imperia installation.

Important

Changes to this variable can lead to data loss.

The default value is Storable.

TARGET_TRIGGER_ON_DELETE Variable#

Set this variable if you want to honor a trigger when a document is unpublished from a target system.

DISABLE_PUBLISHER_WARNINGS Variable#

Set this variable if you wish to disable warnings when a document hasn't been published on a trigger-protected target system.

DEFER_PUBLISH Variable#

This variable is used to defer documents' publishing, when a defined autopublish time is reached on finishing a document. If DEFER_PUBLISH is set, lengthy publishing is left to the Hermes.

Note

If you wish to set deferment on category or document level, use the meta variable __imperia_defer_publish.

Example:

DEFER_PUBLISH = 1
__imperia_defer_publish  1

TARGET_DELETE_IF_EXISTS_ONLY Variable#

When you delete documents/assets from your development system, imperia send an execution request to all the available target systems, even if the data structures have no record of such object existing on some of those target systems. For this reason the deletion of documents and assets may take a very long time.

If you wish to change this behavior, set the TARGET_DELETE_IF_EXISTS_ONLY variable. In this case, imperia trusts the data structures on the development system and tries to delete documents/assets only from target systems on which they are currently recorded as present.


QR Code Group#

QRCODE_BINARY Variable#

In order to use QR codes in imperia, this variable must be set. The parameter should be the absolute path to the QR code binary tool used on your system.

Example:

"QRCODE_BINARY" = "/Users/somebody/imperia/site/qrencode/qrencode"

Important

Make sure that the value of QRCODE_BINARY variable is an absolute path.


Registration Key Group#

Note

These variables should not be set by “hand”. When entering the system key, those values ​​are required.

REG_DEMO Variable#

This variable stores the demo registration key.

REG_KEY Variable#

This variable store imperia's registration key.

REG_KEY2 Variable#

Stores automatically generated checksum of regkey.bin, the licensee and the license key.

REG_NAME Variable#

This variable store imperia's registration name.


Reparse Group#

REPARSE_ACTION_CHECKED Variable#

Choose one of the following objectives for documents that are reparsed: “live”, “workflow” or “pending”. This setting can be changed by users. By default, the option is enabled.

REPARSE_ACTION_FIXED Variable#

Choose one of the following objectives for documents that are reparsed: “live”, “workflow” or “pending”. This setting cannot be changed by users.

REPARSE_SOURCE_CHECKED Variable#

With these variables, you can determine which source fields are pre-selected. The choices are “live” and “pending” (for multiple selection use comma). If the value is an empty string “”, no values are pre-selected. This setting can be changed by users. By default the option is enabled.

REPARSE_SOURCE_FIXED Variable#

With this variable select the source. The choices are “live” and/or “pending” (for multiple selection use comma). If the value is an empty string “”, no values are pre-selected. This setting cannot be modified by users.


Server Group#

DYNAMIC_URI_PREFIX Variable#

Sets the system-wide prefix. Default is /imp.

DEACTIVATE-SITEACTIVE-HTTP Variable#

This variable prevents system services from being accessed and produced via the Web. This makes sense if the generated homepages are partially protected via .htaccess or if the parameters are passed to SiteActives and the only allowed parameters are the ones specified in imperia.schedule.

By default, the variable is NOT set.

FORK_SITEACTIVE Variable#

In order to avoid an overload of the memory by SiteActives, set following:

FORK_SITEACTIVE = 1

SiteActives might run slower then.


SiteActive Group#

SAVEPAGE-PASSWORD Variable#

Enter a password in order to be able to use “SAVEPAGE” in site_active.pl via CGI.

SCHEDULE Variable#

Enter a colon-separated list of additional schedule files.

This variable was introduced in imperia 8.

SCHEDULE_ALWAYS Variable#

Set this variable to 1, if you want to execute schedule files if no document is published.


Template Group#

ALLOW_TEMPLATE_FORM Variable#

Set this variable to 1 to allow forms in HTML templates.

ALLOW_TEMPLATE_FRAME Variable#

Set this variable to 1 to allow frames in HTML templates.

ALLOW_TEMPLATE_SCRIPT Variable#

Set this variable to 1 to allow scripting in HTML templates.

Use this variable to determine which links are displayed in the Media Database call. Possible values ​​are “mam”, “upload”, “remove”, “actions”, or any combination of them in a comma-separated list.

The default is mam, upload, remove, actions.

The variable is only assessed when it is set. If not, the default behavior is assumed.

SAFE_TEMPLATE Variable#

Set this variable to 1 so that external Perl code (for example, in flex modules) is executed in a safe(3) environment.

TEMPLATE_EWE Variable#

Set this variable to 1 to enable the processing of the EWE Word Processor module in templates.

EDITMODE_MENU Variable#

Use this variable to display the imperia menu in edit-mode after including the imperia header in your template. How to include the imperia header is descriped in chapter Displaying the Document Progress in the programmer documentation.


Template Processor Group#

TEMPLATE_CHAIN Variable#

Describes the system-wide order of the modules used by the template processor. Remove unnecessary modules from the chain in order to increase the performance of your system.

Important

Removing absolutely necessary modules or changing the default order can lead to unexpected results when processing a template.

If you want to use the MultiLang functions implemented in imperia, you must define a modified template chain. Insert the MultiLang module after the first “Code Include” and before “Flex” in the process chain and the MultilangFinish module at the end.

This variable was introduced in imperia 8.

Note

The meta-variable __imperia_template_chain is the category-wide equivalent of this configuration variable.

FIELD_NAME_CHECKING Variable#

Set this variable if you want the Edit plug-in to ignore cgi parameters not set in a template. The field names are taken from the html, generated by the Edit plug-in during Edit mode. If this variable is set, any further actions as adding, removing, etc. of Flex modules, Slots, imperia blocks, Array blocks, etc. will be tracked.

Important

The __imperia_no_field_name_checking parameter has to be false in both a document's and a category's meta data for the FIELD_NAME_CHECKING to work properly.

Note

Since fields added to a template through JavaScript are not directly handled by the Edit plug-in, they will not be part of the generated html or perl during Edit mode. In this case, a template developer should “sign” them in a template. Signatures are done as follows:
<!--SIGNATURE:my_field_name-->


User Management Settings Group#

DATABASE_STORAGE_PLUGIN Variable#

Set the data management plug-in for user management. Possible values are FileStore or LDAP.

The default value is FileStore.

SORT_ROLES Variable#

Set this variable to IDs to sort roles by their IDs.

UMLIGHT_PLUGIN Variable#

Set the user plug-in.

The default value is FilestoreLight.

USER_PROP_FIELDS Variable#

Add additional user attributes. The value should be a comma-separated list of the new attributes, with no white spaces. Example:

USER_PROP_FIELDS = "field1,field2,..."

Important

Please note that the newly added attributes do not automatically appear in admin_getuser.pl. You have to assign values to them (use admin_setuser.pl).

LDAP_DEBUG Variable#

To receive more information on the login process, you have to set the environment variable:

LDAP_DEBUG=1

Tip

In order to activate the writing of the error.log, the variable LDAP_DEBUG needs to be set as an ENV variable in the Apache.conf:

PerlSetEnv LDAP_DEBUG  1

Variables RECYCLE_UIDS and RECYCLE_GIDS#

Both defaulting to FALSE.

Deleting a user or group leaves a gap in the sequence of IDs. That can be problematic under some circumstances. Therefore, the system variables RECYCLE_UIDS and RECYCLE_GIDS should control the behavior of imperia.

Activating recycling may imply other problems though:

* when you recycle GIDs, old ACLs may unintentionally allow certain things for gropus that receive a recycled GID.</br>Example: GID -27 used to be assigned to the group "admin". At one point the group admin gets deleted, and a new group "guest" is created which accidentally receives the group id -27. The new group "guest" will now inherit permissions from the ex-admin group.

* When you recycle UIDs, old history entries will now show the new user name instead of "deleted user" or so.

Important

  • Before using a role id (recycled or not) check that it is not used in the file system.

  • When calculating the next id only take ids of local users/groups into account
  • Protect the role creation against concurrrency, that is try to make the calculation of the next id more or less atomic

Workflow Group#

CONFIRM_NEXT_STEP Variable#

If this variable is set to 1, each workflow step must be confirmed.

APPROVAL_DISABLE_JUMP Variable#

If this variable is set to 1, documents that are in the approval step, no longer can be placed in previous workflow steps.

This variable was introduced in imperia 8.