In-Portal Developers Guide

This is a wiki-based Developers Guide for In-Portal Open Source CMS. The purpose of this guide is to provide advanced users, web developers and programmers with documentation on how to expand, customize and improve the functionality and the code the In-Portal software. Please consider contributing to our documentation writing effort.

K4:Configuration

From In-Portal Developers Guide

(Difference between revisions)
Jump to: navigation, search
Current revision (18:07, 4 November 2009) (view source)
(дополнение)
 
(One intermediate revision not shown.)
Line 130: Line 130:
| {{ConfigProperty|FilenameSpecialCharReplacement|string}} || This configuration variable indicates the symbol, that will be the symbol used in naming elements, used when building links with <code>mod_rewrite</code>. Before this configuration variable was developed, only the "<code>_</code>" was used, but now it can be replaced with "<code>-</code>". Available since version [[K4:Core v 4.3.2|Core v 4.3.2]].
| {{ConfigProperty|FilenameSpecialCharReplacement|string}} || This configuration variable indicates the symbol, that will be the symbol used in naming elements, used when building links with <code>mod_rewrite</code>. Before this configuration variable was developed, only the "<code>_</code>" was used, but now it can be replaced with "<code>-</code>". Available since version [[K4:Core v 4.3.2|Core v 4.3.2]].
| <code>_</code>
| <code>_</code>
 +
|-
 +
| {{ConfigProperty|QuickCategoryPermissionRebuild|string}} || Эта переменная конфигурации позволяет перестраивать кеш прав категорий (после сохранения категории) по быстрому, т.е. не используя <code>progress bar</code>. Доступна с версии [[K4:Core v 5.0.0|Core v 5.0.0]].
 +
| <code>1</code>
|}
|}
Line 182: Line 185:
| -1
| -1
|-
|-
-
| {{ConfigProperty|AdvancedUserManagement|int}} || Включает дополнительные возможности управления правами пользователей (администраторов) через группы. По умолчанию выключена. После включения необходимо очистить Sections Cache и перезагрузить фрейм с деревом. Параметр включает секцию <code>Groups</code>, в которой можно создавать группы по смыслу, а также просматривать и добавлять/удалять пользователей в этих группах. В редактировании администраторов добавляется закладка со списком групп в которых состоит пользователь. Для управления правами пользователей используется следующая схема: стандартной группе <code>admin</code> запрещается все, кроме права <code>ADMIN.LOGIN</code>, далее создаются группы по смыслу, которым разрешается доступ в нужные секции. Все администраторы автоматически добавляются в основную группу <code>admin</code> (при создании через соответствующую секцию). Далее их надо добавлять в нужные смысловые группы, НЕ УБИРАЯ из группы <code>admin</code> и НЕ МЕНЯЯ основную (primary) группу, т.к. в секции <code>Administrators</code> показываются пользователи, у которых основная группа - <code>admin</code>. Доступна только в Platform с версии [[K4:Core v 4.2.2|Core v 4.2.2]].
+
| {{ConfigProperty|AdvancedUserManagement|int}} || Turns on additional options for managing user permissions (for administrators) using groups. Turned off by default. After turning on, Sections Cache must be cleared and the navigation tree frame must be refreshed. The parameter turns on the <code>Groups</code> section, where it's possible to create meaningful groups and view/add/delete users in these groups. In the edit administrator window, a tab gets added with the list of groups to which he belongs. The following scheme is used for managing user permissions: for the standard <code>admin</code> group everything is not allowed, except for the permission <code>ADMIN.LOGIN</code>, further meaningful permissions groups are created, which receive permissions for specific sections. All administrators are automatically added to the primary group <code>admin</code> (when added through the corresponding section). Furthermore, they must be added to needed permissions groups, WITHOUT REMOVING them from the <code>admin</code> group and WITHOUT CHANGING their primary group because the <code>Administrators</code> section shows the users whose primary group is <code>admin</code>. Available only in Platform since version [[K4:Core v 4.2.2|Core v 4.2.2]].
| 0
| 0
|-
|-
-
| {{ConfigProperty|UseDoubleSorting|int}} || Эта переменная конфигурации определяет как меняется сортировка в списках. Сортировка меняется при выполнении события <code>OnSetSorting</code> - например, когда мышкой нажимают на заголовок столбца с данными. При <code>UseDoubleSorting = 0</code> (значение по умолчанию) в итоге получается фильтр только по одному столбцу, на заголовок которого нажали. Если же <code>UseDoubleSorting = 1</code>, и мышкой поочерёдно нажимали на заголовки разных столбцов, то фильтр будет по двум столбцам - вначале по столбцу, нажатому последним, а затем - по столбцу, нажатому предпоследним.  
+
| {{ConfigProperty|UseDoubleSorting|int}} || This configuration variable determines how sorting in grids changes. Sorting changes as a result of performing the event <code>OnSetSorting</code> - for example, when a grid heading is clicked. With <code>UseDoubleSorting = 0</code> (default setting) filtering is done only by one column, the column whose header was clicked. If <code>UseDoubleSorting = 1</code> and multiple columns were sorted by clicking the headings, then they will be sorted by two columns - first by the column heading that was clicked last, and then - by the column that was clicked second to last.  
| 0
| 0
|}
|}
Line 191: Line 194:
=== Proj-CMS ===
=== Proj-CMS ===
{| class="prettytable"  
{| class="prettytable"  
-
! название || описание || по умолчанию
+
! name || description || default setting
|-
|-
-
| {{ConfigProperty|ProjCMSAllowManualFilenames|int}} || Эта переменная конфигурации разрешает пользователю редактировать название файла для mod-rewrite (галочка "Auto-filename" и само название файла). Доступна с версии [[K4:Core v 4.0.1|Core v 4.0.1]].
+
| {{ConfigProperty|ProjCMSAllowManualFilenames|int}} || This configuration variable let's the user edit the file name used for mod_rewrite (the "Auto-filename" part and the name of the file itself). Available since version [[K4:Core v 4.0.1|Core v 4.0.1]].
| 0
| 0
|}
|}
=== In-Commerce ===
=== In-Commerce ===
-
Переменные вида <code>Comm_Shipping***</code> задают адрес с которого происходит доставка заказов и могут использоваться для расчёта стоимости доставки заказа.
+
Variables of the type <code>Comm_Shipping***</code> indicate the address from which the product is delivered and can be used for shipping pricing.
{| class="prettytable"  
{| class="prettytable"  
-
! название || описание || по умолчанию
+
! name || description || default setting
|-
|-
-
| {{ConfigProperty|Comm_RequireLoginBeforeCheckout|int}} || Эта переменная конфигурации определяет должен ли покупатель авторизоваться на пользовательской части сайта для окончательного оформления заказа. 1 - должен авторизоваться. 0 - не должен. Доступна с версии [[K4:In-Commerce v 1.0.0|In-Commerce v 1.0.0]].
+
| {{ConfigProperty|Comm_RequireLoginBeforeCheckout|int}} || This configuration variable determines whether the customer is required to login on the front-end to finalize an order. 1 - login required. 0 - login not required. Available since version [[K4:In-Commerce v 1.0.0|In-Commerce v 1.0.0]].
| 0
| 0
|-
|-
-
| {{ConfigProperty|Comm_Shipping_AddressLine1|string}} || Эта переменная конфигурации задаёт первую строку адреса с которого происходит доставка заказов. Доступна с версии [[K4:In-Commerce v 1.0.0|In-Commerce v 1.0.0]].
+
| {{ConfigProperty|Comm_Shipping_AddressLine1|string}} || This configuration variable indicates the first line of the address from which products are shipped. Available since version [[K4:In-Commerce v 1.0.0|In-Commerce v 1.0.0]].
|  
|  
|-
|-
-
| {{ConfigProperty|Comm_Shipping_AddressLine2|string}} || Эта переменная конфигурации задаёт вторую строку адреса с которого происходит доставка заказов. Доступна с версии [[K4:In-Commerce v 1.0.0|In-Commerce v 1.0.0]].
+
| {{ConfigProperty|Comm_Shipping_AddressLine2|string}} || This configuration variable indicates the second line of the address from which products are shipped. Available since version [[K4:In-Commerce v 1.0.0|In-Commerce v 1.0.0]].
|  
|  
|-
|-
-
| {{ConfigProperty|Comm_Shipping_City|string}} || Эта переменная конфигурации задаёт город из которого происходит доставка заказов. Доступна с версии [[K4:In-Commerce v 1.0.0|In-Commerce v 1.0.0]].
+
| {{ConfigProperty|Comm_Shipping_City|string}} || This configuration variable indicates the city from which products are shipped. Available since version [[K4:In-Commerce v 1.0.0|In-Commerce v 1.0.0]].
|  
|  
|-
|-
-
| {{ConfigProperty|Comm_Shipping_Country|string}} || Эта переменная конфигурации задаёт страну из которой происходит доставка заказов. Выбирается одно из значений <code>DestAbbr</code> таблицы <code>StdDestinations</code>. Доступна с версии [[K4:In-Commerce v 1.0.0|In-Commerce v 1.0.0]].
+
| {{ConfigProperty|Comm_Shipping_Country|string}} || One country is chosen from  <code>DestAbbr</code> values in the <code>StdDestinations</code> table. Available since version [[K4:In-Commerce v 1.0.0|In-Commerce v 1.0.0]].
|  
|  
|-
|-
-
| {{ConfigProperty|Comm_Shipping_State|string}} || Эта переменная конфигурации задаёт штат или провинцию откуда происходит доставка заказов. Доступна с версии [[K4:In-Commerce v 1.0.0|In-Commerce v 1.0.0]].
+
| {{ConfigProperty|Comm_Shipping_State|string}} || This configuration variable indicates the state or province from which products are shipped. Available since version [[K4:In-Commerce v 1.0.0|In-Commerce v 1.0.0]].
|  
|  
|-
|-
-
| {{ConfigProperty|Comm_Shipping_ZIP|string}} || Эта переменная конфигурации задаёт почтовый индекс с которого происходит доставка заказов. Доступна с версии [[K4:In-Commerce v 1.0.0|In-Commerce v 1.0.0]].
+
| {{ConfigProperty|Comm_Shipping_ZIP|string}} || This configuration variable indicates the zip code from which products are shipped. Available since version [[K4:In-Commerce v 1.0.0|In-Commerce v 1.0.0]].
|  
|  
|}
|}
-
== См. также ==
+
== See also ==
* [[K4:ConfigurationAdmin|ConfigurationAdmin]]
* [[K4:ConfigurationAdmin|ConfigurationAdmin]]
* [[K4:ConfigurationValues|ConfigurationValues]]
* [[K4:ConfigurationValues|ConfigurationValues]]

Current revision

Настройка системы Настройка системы
Статьи в этой категории

Described here are all available configuration variables in K4. Each variable is a record in 2 tables:

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.
Image:Tipbox Icon.gif Previously, the user's session was always available when reopening the browser.
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.
Image:Tipbox Icon.gif Previously, the user was always redirected to the last template they were on, after authenticating.
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).
Image:Infobox Icon.gif Before turning on this configuration variable, it's important to make sure that the site specified in the configuration variable SSL_URL includes support for mod_rewrite (in your server settings).
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:
  • 1 - registration is enabled, status of new users - active
  • 2 - registration is disabled
  • 3 - registration is enabled, status of new users - pending approval by the administrator

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 user_group works only in the administrative console - so that users registering on the front end can't choose a group for themselves. Available since version Core v 1.0.0.

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.

http://www.somedomain.com/index.php?env=-in-commerce/product/details:m304-1-1-3-s-:p-41----

If mod_rewrite 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,

http://www.somedomain.com/products/bikes/incredi_bike.html

which is good for search engine indexing. Available since version Core v 1.1.4.

0
UseToolbarLabels (int) This is a configuration variable that determines whether text names will be shown below buttons in the toolbars in the administrative console. Values: 1 - yes, 0 - no. This value is used in JavaScript-functions, that generate the buttons. Available since version Core v 4.2.0. 1
YahooApplicationId (string) This configuration variable let's the administrator enter a Yahoo Application ID, that in the future will be used for integrating functionality provided by the Yahoo service. Currently, it's used for the spelling dictionary search suggestion functionality that's for the search field. Available since version Core v 4.3.2.
FilenameSpecialCharReplacement (string) This configuration variable indicates the symbol, that will be the symbol used in naming elements, used when building links with mod_rewrite. Before this configuration variable was developed, only the "_" was used, but now it can be replaced with "-". Available since version Core v 4.3.2. _
QuickCategoryPermissionRebuild (string) Эта переменная конфигурации позволяет перестраивать кеш прав категорий (после сохранения категории) по быстрому, т.е. не используя progress bar. Доступна с версии Core v 5.0.0. 1

In-Portal

name description default setting
RecycleBinFolder (int) If set, then all deleted records from the catalog will be moved to the category with the ID indicated here. Available since version Core v 4.2.2.
UsePageHitCounter (int) Indicates to count the total number of visits to the site (i.e. total of visits to each front-end page). Avaiable since Core v 4.3.0. 0
PageHitCounter (int) Stores the total number of site visits. Used with UsePageHitCounter. Available since Core v 4.3.0. 0
RootPass (string) This configuration variable stores the hash of the password for the root site administrator and is used to check the password when the root administrator is logging in to the administrative console. Available since version Core v 1.0.0. Set by the administrator when installing the system
Root_Name (string) This configuration variable contains the phrase, that can be translated as the root category of the system (category with number 0). Used for displaying navigation elements. Available since version Core v 1.0.0. lu_rootcategory_name

Proj-Base

name description default setting
UseSmallHeader (int) Let's one remove grid headings
before after

Will only work if combined_header block is used. Available since Core v 4.2.0.

0
UsePopups (int) Adding/editing items in a grid will be done in a pop-up 1
TrimRequiredFields (int) Indicates that before required form fields are checked (to see if they were entered), that the trim() function will be applied first. Available since version Core v 4.2.2. 0
MenuFrameWidth (int) Sets the width of the frame with the navigation tree (in pixels), 200px by default. Available only in Platform, since version Core v 4.2.2. 200
DefaultSettingsUserId (int) The user that's used when a new administrator (that doesn't have PersistentSession data yet) goes into any grid for the first time. An administrator in this situation receives the PersistentSession value from the user indicated in this ID variable, specifically the following data:
  • ColumnPicker;
  • PerPage;
  • Filters.

What this allows is, if all grid preferences have been set in a particular way (including column widths, since they're also stored in PersistentSession) for the root user or for a different user (indicating that user's ID), then these settings will work for the new user by default. Also, in the "Users Management -> Admins" section, a Reset button was added (only in Platform), that removes such personal user settings (only those that are taken from the user by default) and thus the user can reset all default grid settings (all at once). The variable by default has the value -1, i.e. "root". Available since version Core v 4.2.2.

Image:Tipbox Icon.gif If no value is entered, then it'll be interpreted as "-1" anyway :(. To turn off the above described functionality, it's necessary to enter any ID of a non-existent user, for example 999999999999
-1
AdvancedUserManagement (int) Turns on additional options for managing user permissions (for administrators) using groups. Turned off by default. After turning on, Sections Cache must be cleared and the navigation tree frame must be refreshed. The parameter turns on the Groups section, where it's possible to create meaningful groups and view/add/delete users in these groups. In the edit administrator window, a tab gets added with the list of groups to which he belongs. The following scheme is used for managing user permissions: for the standard admin group everything is not allowed, except for the permission ADMIN.LOGIN, further meaningful permissions groups are created, which receive permissions for specific sections. All administrators are automatically added to the primary group admin (when added through the corresponding section). Furthermore, they must be added to needed permissions groups, WITHOUT REMOVING them from the admin group and WITHOUT CHANGING their primary group because the Administrators section shows the users whose primary group is admin. Available only in Platform since version Core v 4.2.2. 0
UseDoubleSorting (int) This configuration variable determines how sorting in grids changes. Sorting changes as a result of performing the event OnSetSorting - for example, when a grid heading is clicked. With UseDoubleSorting = 0 (default setting) filtering is done only by one column, the column whose header was clicked. If UseDoubleSorting = 1 and multiple columns were sorted by clicking the headings, then they will be sorted by two columns - first by the column heading that was clicked last, and then - by the column that was clicked second to last. 0

Proj-CMS

name description default setting
ProjCMSAllowManualFilenames (int) This configuration variable let's the user edit the file name used for mod_rewrite (the "Auto-filename" part and the name of the file itself). Available since version Core v 4.0.1. 0

In-Commerce

Variables of the type Comm_Shipping*** indicate the address from which the product is delivered and can be used for shipping pricing.

name description default setting
Comm_RequireLoginBeforeCheckout (int) This configuration variable determines whether the customer is required to login on the front-end to finalize an order. 1 - login required. 0 - login not required. Available since version In-Commerce v 1.0.0. 0
Comm_Shipping_AddressLine1 (string) This configuration variable indicates the first line of the address from which products are shipped. Available since version In-Commerce v 1.0.0.
Comm_Shipping_AddressLine2 (string) This configuration variable indicates the second line of the address from which products are shipped. Available since version In-Commerce v 1.0.0.
Comm_Shipping_City (string) This configuration variable indicates the city from which products are shipped. Available since version In-Commerce v 1.0.0.
Comm_Shipping_Country (string) One country is chosen from DestAbbr values in the StdDestinations table. Available since version In-Commerce v 1.0.0.
Comm_Shipping_State (string) This configuration variable indicates the state or province from which products are shipped. Available since version In-Commerce v 1.0.0.
Comm_Shipping_ZIP (string) This configuration variable indicates the zip code from which products are shipped. Available since version In-Commerce v 1.0.0.

See also

Retrieved from "http://guide.in-portal.org/eng/index.php/K4:Configuration"