K4:Configuration
From In-Portal Developers Guide
Path to article:
| Line 87: | Line 87: | ||
| 1 | | 1 | ||
|- | |- | ||
| - | | {{ConfigProperty|SessionTimeout|int}} || | + | | {{ConfigProperty|SessionTimeout|int}} || This configuration variable determines how long a user's session will remain active in the case where the user is idle. The time is entered in seconds. The maximum amount of time before the session times out is limited for security reasons. Available since version [[K4:Core v 1.0.0|Core v 1.0.0]]. |
| 3600 | | 3600 | ||
|- | |- | ||
| - | | {{ConfigProperty|Site_Name|string}} || | + | | {{ConfigProperty|Site_Name|string}} || This configuration variable indicates the site name that's used as the site title and in e-mail notifications sent by the site. Available since version [[K4:Core v 1.0.0|Core v 1.0.0]]. |
| KernelX | | KernelX | ||
|- | |- | ||
| - | | {{ConfigProperty|Site_Path|string}} || | + | | {{ConfigProperty|Site_Path|string}} || This configuration variable indicates the path to the site relative to the root directory, corresponding to the domain, used to get to the site (<code>$_SERVER['DOCUMENT_ROOT']</code>). For example, if the site is located in the subdirectory code>dev</code>, the value of this variable should be <code>/dev/</code>. Available since version [[K4:Core v 1.0.0|Core v 1.0.0]]. |
| / | | / | ||
|- | |- | ||
| - | | {{ConfigProperty|Smtp_AdminMailFrom|string}} || | + | | {{ConfigProperty|Smtp_AdminMailFrom|string}} || This configuration variable determines the return e-mail address that's used by default for e-mail notifications sent by the site. Available since version Доступна с версии [[K4:Core v 1.0.0|Core v 1.0.0]]. |
| - | | <code>portal@'''domain'''</code>, | + | | <code>portal@'''domain'''</code>, where <code>'''domain'''</code> - the domain, setup during installation of site |
|- | |- | ||
| - | | {{ConfigProperty|Smtp_Authenticate|int}} || | + | | {{ConfigProperty|Smtp_Authenticate|int}} || This configuration variable determines whether authorization is required when connecting to the mail server. Values: 1 - required, 0 - not required. Available since version [[K4:Core v 1.0.0|Core v 1.0.0]]. |
| 0 | | 0 | ||
|- | |- | ||
| - | | {{ConfigProperty|Smtp_User|int}} || | + | | {{ConfigProperty|Smtp_User|int}} || This configuration variable indicates the username for access to the mail server, if authentication is required. Available since version [[K4:Core v 1.0.0|Core v 1.0.0]]. |
| | | | ||
|- | |- | ||
| - | | {{ConfigProperty|Smtp_Pass|int}} || | + | | {{ConfigProperty|Smtp_Pass|int}} || This configuration variable indicates the password for the mail server if authentication is required. Available since version [[K4:Core v 1.0.0|Core v 1.0.0]]. |
| | | | ||
|- | |- | ||
| - | | {{ConfigProperty|Smtp_Server|int}} || | + | | {{ConfigProperty|Smtp_Server|int}} || This configuration variable let's one set the domain or <code>IP</code> of the mail server, if the default mail server set in the <code>PHP</code> configuration isn't going to be used. Available since version [[K4:Core v 1.0.0|Core v 1.0.0]]. |
| | | | ||
|- | |- | ||
| - | | {{ConfigProperty|UseModRewrite|int}} || | + | | {{ConfigProperty|UseModRewrite|int}} || This configuration variable determines the addressing of pages on the front-end part of the site. Values: <code>0 - mod_rewrite</code> turned off, <code>1 - mod_rewrite</code> turned on. If <code>mod_rewrite</code> is turned off, then when accessing the page, its location in the directory structure of the site is determined in the <code>env</code> variable. |
<code>http://www.somedomain.com/index.php?env=-in-commerce/product/details:m304-1-1-3-s-:p-41----</code> | <code>http://www.somedomain.com/index.php?env=-in-commerce/product/details:m304-1-1-3-s-:p-41----</code> | ||
| - | + | If <code>mod_rewrite</code> is turned on, then the location of the page in the directory structure of the site is shown in the directory-subdirectory style, corresponding to the names of the site's directories and the name of the current object shown on the page, | |
<code>http://www.somedomain.com/products/bikes/incredi_bike.html</code> | <code>http://www.somedomain.com/products/bikes/incredi_bike.html</code> | ||
| - | + | which is good for search engine indexing. Available since version [[K4:Core v 1.1.4|Core v 1.1.4]]. | |
| 0 | | 0 | ||
|- | |- | ||
Revision as of 20:54, 17 March 2009
| ||
|---|---|---|
| Статьи в этой категории | ||
|
Described here are all available configuration variables in K4. Each variable is a record in 2 tables:
- ConfigurationAdmin - visual representation of the variable in the administrative console;
- ConfigurationValues - value of the variable in the administrative console.
Contents |
Configuration Variables
Core
| name | description | default setting | ||
|---|---|---|---|---|
UseCronForRegularEvent (int) | Indicates how regular events are to be carried out. If turned on, then all scheduled events will be carried out only through cron. | 0 | ||
UseChangeLog (int) | Indicates that database changes must be written to the log file. Available since version Core v 4.3.0. | 0 | ||
KeepSessionOnBrowserClose (int) | Indicates that the session must NOT expire when the browser is closed. Turned off by default, i.e. when the browser is closed the session EXPIRES. Available since version Core v 4.2.2.
| 0 | ||
AutoRefreshIntervals (string) | The available intervals of automatically refreshing grids. Comma separated values in minutes. Available in "View Menu" for grids. Available since version Core v 4.3.0. | 1,5,15,30,60,120,240 | ||
RememberLastAdminTemplate (int) | Indicates that after authentication the user should not be redirected to the last template they were on. Only for the administrative console. Available since version Core v 4.3.1.
| 0 | ||
SSL_URL (string) | Indicates the URL, where the site is accessible when using SSL. The address must always start with "https://" and must not end with "/". Available since version Core v 1.1.2.
| |||
AdminSSL_URL (string) | Indicates the URL, where the site's administrative console is accessible through SSL (it's not necessary to include ("/admin"). The URL must always start with "https://" and must not end with "/". If the field for this configuration variable is left blank, the the value for the SSL_URL variable will be used. Available since version Core v 4.3.1.
| |||
Require_AdminSSL (int) | Indicates that access to the administrative console is only through SSL. Available since version Core v 4.1.0. | 0 | ||
Require_SSL (int) | This configuration variable indicates that on templates with the tag m_CheckSSL with parameter condition="Require_SSL", the site must automatically switch into SSL-mode (obviously if the site is not already in SSL-mode). <inp2:m_CheckSSL mode="required" condition="Require_SSL"/> | 0 | ||
Force_HTTP_When_SSL_Not_Required (int) | If this configuration variable is turned on, then when the site user, while in SSL-mode, enters a template that doesn't require SSL, he will be automatically redirected to an equivalent http:// template (for example the address "https://www.test.com/no_ssl.html" will become "http://www.test.com/no_ssl.html").
| 1 | ||
UseModRewriteWithSSL (int) | If this configuration variable is turned on and SSL is turned on for the front-end, then URLs in SSL-mode will also be built using mod_rewrite technology (just like when not in SSL-mode).
| 0 | ||
AllowSelectGroupOnFront (int) | This configuration variable allows the site user, on the Front-End, to choose for him or herself, the permissions group that he or she wants (virtual field UserGroup). It will only be possible to choose from those groups that allow this (see field FrontRegistration). Available since version Core v 4.3.1.
| 0 | ||
ForceImageMagickResize (int) | This configuration variable says that image scaling must be done using the ImageMagicк program, even if the GD library is available in в PHP. Available since Core v 4.3.1.
| 0 | ||
Email_As_Login (int) | This configuration variable indicates the field that's used for authentication on the front-end. 1 - Email. 0 - Login. Available since Core v 1.1.0. | 0 | ||
RegistrationCaptcha (int) | This configuration variable determines whether it's required for new users on the front end to enter an alphanumeric code, as proof that they are an actual person and not a robot. Values: 1 - required. 0 - not required. Available since Core v 4.0.1. | 0 | ||
User_Allow_New (int) | This configuration variable determines whether it's possible to register new users on the front-end. Values:
Available since version Core v 1.0.0. | 3 | ||
User_NewGroup (int) | This configuration variable determines the user group, to which a new user is assigned if one was not specifically set.
$this->Application->GetVar('user_group') For security reasons, the variable | 13 (Member) | ||
User_MembershipExpirationReminder (int) | In K4, users can be in user groups (Member, Subscribers, etc). Membership in a group can be constant or temporary. In the case where membership is temporary, this variable determines how many days before the end of the membership to send the e-mail notice (event USER.MEMBERSHIP.EXPIRATION.NOTICE) to those whose membership is ending soon and the administrator. Available since version Core v 1.0.0.
| 10 | ||
User_Password_Auto (int) | This variable determines whether the system should automatically generate a password for a user when the new user is created. Values: 1 - yes, 0 - no. If this option is turned on, then on the registration form on the front-end, there's no need to show the user the password field. Available since version Core v 1.0.0. | 0 | ||
FirstDayOfWeek (int) | This configuration variable determines the day of the week on which the week should start and affects how the calendar looks. Typical values: 1 - Monday, 0 - Sunday. Available since version Core v 1.1.2. | 1 | ||
NoPermissionTemplate (string) | This configuration variable indicates the template, to which the site user is redirected if they do not have the permissions to view the page they are trying to access on the front-end. Available since version Core v 1.2.0. | no_permission | ||
SessionCookieName (string) | This configuration variable sets the name of the cookie that stores the session ID of the user. Available since Core v 1.1.4. | sid | ||
SessionReferrerCheck (int) | This configuration variable determines whether the $_SERVER['HTTP_REFERER'] variable is checked when the session ID of the user can be passed bypassing cookies. This test provides an additional guarantee that the system won't process false POST-requests, generated outside the system. Available since version Core v 1.1.4.
| 1 | ||
SessionTimeout (int) | This configuration variable determines how long a user's session will remain active in the case where the user is idle. The time is entered in seconds. The maximum amount of time before the session times out is limited for security reasons. Available since version Core v 1.0.0. | 3600 | ||
Site_Name (string) | This configuration variable indicates the site name that's used as the site title and in e-mail notifications sent by the site. Available since version Core v 1.0.0. | KernelX | ||
Site_Path (string) | This configuration variable indicates the path to the site relative to the root directory, corresponding to the domain, used to get to the site ($_SERVER['DOCUMENT_ROOT']). For example, if the site is located in the subdirectory code>dev</code>, the value of this variable should be /dev/. Available since version Core v 1.0.0.
| / | ||
Smtp_AdminMailFrom (string) | This configuration variable determines the return e-mail address that's used by default for e-mail notifications sent by the site. Available since version Доступна с версии Core v 1.0.0. | portal@domain, where domain - the domain, setup during installation of site
| ||
Smtp_Authenticate (int) | This configuration variable determines whether authorization is required when connecting to the mail server. Values: 1 - required, 0 - not required. Available since version Core v 1.0.0. | 0 | ||
Smtp_User (int) | This configuration variable indicates the username for access to the mail server, if authentication is required. Available since version Core v 1.0.0. | |||
Smtp_Pass (int) | This configuration variable indicates the password for the mail server if authentication is required. Available since version Core v 1.0.0. | |||
Smtp_Server (int) | This configuration variable let's one set the domain or IP of the mail server, if the default mail server set in the PHP configuration isn't going to be used. Available since version Core v 1.0.0.
| |||
UseModRewrite (int) | This configuration variable determines the addressing of pages on the front-end part of the site. Values: 0 - mod_rewrite turned off, 1 - mod_rewrite turned on. If mod_rewrite is turned off, then when accessing the page, its location in the directory structure of the site is determined in the env variable.
If
which is good for search engine indexing. Available since version Core v 1.1.4. | 0 | ||
UseToolbarLabels (int) | Эта переменная конфигурации определяет будут ли в административной консоли, в Toolbar-ах показываться текстовые надписи под кнопками. Значения: 1 - будут, 0 - не будут. Это значение используется в JavaScript-функциях, генерирующих кнопки. Доступна с версии Core v 4.2.0. | 1 | ||
YahooApplicationId (string) | Эта переменная конфигурации позволяет задать Yahoo Application ID, которая в последствии будет использована для интеграции с возможностями, которые предоставляет сервис Yahoo. На данный момент она используется для осуществления орфографических подсказок на форме поиска. Доступна с версии Core v 4.3.2.
| |||
FilenameSpecialCharReplacement (string) | Эта переменная конфигурации позволяет символ, использующийся для замены запрещённых символов в названиях элементов, использующихся при построении ссылок в mod-rewrite режиме. До появления этой конфигурационной переменной использовался только символ "_", но теперь его можно заменить на "-". Доступна с версии Core v 4.3.2.
| _
|
In-Portal
| название | описание | по умолчанию |
|---|---|---|
RecycleBinFolder (int) | Если указать, то все записи из каталога после удаления будут попадать в категорию с ID, указанным здесь. Доступна с Core v 4.2.2. | |
UsePageHitCounter (int) | Указывать на то, что нужно считать общее количество посещений сайта (т.е. захода на каждую страницу на Front-End). Доступна с Core v 4.3.0. | 0 |
PageHitCounter (int) | Хранит в себе общее количество посещений сайта. Используется совместно с UsePageHitCounter. Доступна с Core v 4.3.0. | 0 |
RootPass (string) | Эта переменная конфигурации хранит hash пароля главного администратора сайта и используется для проверки пароля при входе главного администратора в администраторскую часть сайта. Доступна с версии Core v 1.0.0. | Задаётся администратором при инсталляции системы |
Root_Name (string) | Эта переменная содержит фразу, переводимую как название корневой категории системы (категории с номером 0). Используется для отображения элементов навигации. Доступна с версии Core v 1.0.0. | lu_rootcategory_name |
Proj-Base
| название | описание | по умолчанию | ||||
|---|---|---|---|---|---|---|
UseSmallHeader (int) | Позволяет убрать заголовок на grid.
Будет работать только при использовании блока | 0 | ||||
UsePopups (int) | Начинать создание/редактирование записей из grid в новом окне (popup). | 1 | ||||
TrimRequiredFields (int) | Указывает на то, что перед проверкой на наличие данных в обязательных полях к ним применяется функция trim(). Доступна с версии Core v 4.2.2.
| 0 | ||||
MenuFrameWidth (int) | Позволяет задать ширину фрэйма c деревом (в пикселях), по умолчанию 200. Доступна только в Platform с версии Core v 4.2.2. | 200 | ||||
DefaultSettingsUserId (int) | Пользователь, который используется когда новый администратор (у которого еще нет данных PersistentSession) первый раз заходит на любой список. Такому администратору проставляются значения PersistentSession от пользователя с указанным в этой переменной ID, а именно данные:
Таким образом если красиво настроить все списки (включая ширины колонок, т.к. они теперь тоже хранятся в PersistentSession) для root'а или другого пользователя (указав его Id), то эти настройки будут работать для новых пользователей по умолчанию. Также в раздел "
| -1 | ||||
AdvancedUserManagement (int) | Включает дополнительные возможности управления правами пользователей (администраторов) через группы. По умолчанию выключена. После включения необходимо очистить Sections Cache и перезагрузить фрейм с деревом. Параметр включает секцию Groups, в которой можно создавать группы по смыслу, а также просматривать и добавлять/удалять пользователей в этих группах. В редактировании администраторов добавляется закладка со списком групп в которых состоит пользователь. Для управления правами пользователей используется следующая схема: стандартной группе admin запрещается все, кроме права ADMIN.LOGIN, далее создаются группы по смыслу, которым разрешается доступ в нужные секции. Все администраторы автоматически добавляются в основную группу admin (при создании через соответствующую секцию). Далее их надо добавлять в нужные смысловые группы, НЕ УБИРАЯ из группы admin и НЕ МЕНЯЯ основную (primary) группу, т.к. в секции Administrators показываются пользователи, у которых основная группа - admin. Доступна только в Platform с версии Core v 4.2.2.
| 0 | ||||
UseDoubleSorting (int) | Эта переменная конфигурации определяет как меняется сортировка в списках. Сортировка меняется при выполнении события OnSetSorting - например, когда мышкой нажимают на заголовок столбца с данными. При UseDoubleSorting = 0 (значение по умолчанию) в итоге получается фильтр только по одному столбцу, на заголовок которого нажали. Если же UseDoubleSorting = 1, и мышкой поочерёдно нажимали на заголовки разных столбцов, то фильтр будет по двум столбцам - вначале по столбцу, нажатому последним, а затем - по столбцу, нажатому предпоследним.
| 0 |
Proj-CMS
| название | описание | по умолчанию |
|---|---|---|
ProjCMSAllowManualFilenames (int) | Эта переменная конфигурации разрешает пользователю редактировать название файла для mod-rewrite (галочка "Auto-filename" и само название файла). Доступна с версии Core v 4.0.1. | 0 |
In-Commerce
Переменные вида Comm_Shipping*** задают адрес с которого происходит доставка заказов и могут использоваться для расчёта стоимости доставки заказа.
| название | описание | по умолчанию |
|---|---|---|
Comm_RequireLoginBeforeCheckout (int) | Эта переменная конфигурации определяет должен ли покупатель авторизоваться на пользовательской части сайта для окончательного оформления заказа. 1 - должен авторизоваться. 0 - не должен. Доступна с версии In-Commerce v 1.0.0. | 0 |
Comm_Shipping_AddressLine1 (string) | Эта переменная конфигурации задаёт первую строку адреса с которого происходит доставка заказов. Доступна с версии In-Commerce v 1.0.0. | |
Comm_Shipping_AddressLine2 (string) | Эта переменная конфигурации задаёт вторую строку адреса с которого происходит доставка заказов. Доступна с версии In-Commerce v 1.0.0. | |
Comm_Shipping_City (string) | Эта переменная конфигурации задаёт город из которого происходит доставка заказов. Доступна с версии In-Commerce v 1.0.0. | |
Comm_Shipping_Country (string) | Эта переменная конфигурации задаёт страну из которой происходит доставка заказов. Выбирается одно из значений DestAbbr таблицы StdDestinations. Доступна с версии In-Commerce v 1.0.0.
| |
Comm_Shipping_State (string) | Эта переменная конфигурации задаёт штат или провинцию откуда происходит доставка заказов. Доступна с версии In-Commerce v 1.0.0. | |
Comm_Shipping_ZIP (string) | Эта переменная конфигурации задаёт почтовый индекс с которого происходит доставка заказов. Доступна с версии In-Commerce v 1.0.0. |
