View source

{{toc | category = Настройка системы | sortkey = 001.001}}
Described here are all available configuration variables in K4. Each variable is a record in 2 tables:
* [[K4:ConfigurationAdmin|ConfigurationAdmin]] - visual representation of the variable in the administrative console;
* [[K4:ConfigurationValues|ConfigurationValues]] - value of the variable in the administrative console.

== Configuration Variables ==

=== Core ===
{| class="prettytable" 
! name || description || default setting
|-
| {{ConfigProperty|UseCronForRegularEvent|int}} || Indicates how [[K4:Regular Events|regular events]] are to be carried out. If turned on, then all scheduled events will be carried out only through cron. 
| 0
|-
| {{ConfigProperty|UseChangeLog|int}} || Indicates that database changes must be written to the log file. Available since version [[K4:Core v 4.3.0|Core v 4.3.0]].
| 0
|-
| {{ConfigProperty|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 [[K4:Core v 4.2.2|Core v 4.2.2]]. {{TipBox|Previously, the user's session was always available when reopening the browser.}}
| 0
|-
| {{ConfigProperty|AutoRefreshIntervals|string}} || The available intervals of automatically refreshing grids. Comma separated values in minutes. Available in "View Menu" for grids. Available since version [[K4:Core v 4.3.0|Core v 4.3.0]].
| 1,5,15,30,60,120,240
|-
| {{ConfigProperty|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 [[K4:Core v 4.3.1|Core v 4.3.1]]. {{TipBox|Previously, the user was always redirected to the last template they were on, after authenticating.}}
| 0
|-
| {{ConfigProperty|SSL_URL|string}} || Indicates the URL, where the site is accessible when using SSL. The address must always start with "'''<code>https://</code>'''" and must not end with "'''<code>/</code>'''". Available since version [[K4:Core v 1.1.2|Core v 1.1.2]].
|
|-
| {{ConfigProperty|AdminSSL_URL|string}} || Indicates the URL, where the site's administrative console is accessible through SSL (it's not necessary to include ("<code>/admin</code>"). The URL must always start with "'''<code>https://</code>'''" and must not end with "'''<code>/</code>'''". If the field for this configuration variable is left blank, the the value for the [[#SSL_URL|SSL_URL]] variable will be used. Available since version [[K4:Core v 4.3.1|Core v 4.3.1]].
|
|-
| {{ConfigProperty|Require_AdminSSL|int}} || Indicates that access to the administrative console is only through SSL. Available since version [[K4:Core v 4.1.0|Core v 4.1.0]].
| 0
|-
| {{ConfigProperty|Require_SSL|int}} || This configuration variable indicates that on templates with the tag <code>m_CheckSSL</code> with parameter <code>condition="Require_SSL"</code>, the site must automatically switch into SSL-mode (obviously if the site is not already in SSL-mode). <source lang="xml"><inp2:m_CheckSSL mode="required" condition="Require_SSL"/></source>
| 0
|-
| {{ConfigProperty|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''' <code>http://</code> template (for example the address "<code>'''https://'''<nowiki>www.test.com/no_ssl.html</nowiki></code>" will become "<code>'''http://'''<nowiki>www.test.com/no_ssl.html</nowiki></code>").
| 1
|-
| {{ConfigProperty|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). {{InfoBox|Before turning on this configuration variable, it's important to make sure that the site specified in the configuration variable [[#SSL_URL|SSL_URL]] includes support for mod_rewrite (in your server settings).}}
| 0
|-
| {{ConfigProperty|AllowSelectGroupOnFront|int}} || This configuration variable allows the site user, on the Front-End, to choose for him or herself, the permissions [[K4:PortalGroup|group]] that he or she wants (virtual field <code>UserGroup</code>). It will only be possible to choose from those [[K4:PortalGroup|groups]] that allow this (see field [[K4:PortalGroup#FrontRegistration|FrontRegistration]]). Available since version [[K4:Core v 4.3.1|Core v 4.3.1]].
| 0
|-
| {{ConfigProperty|ForceImageMagickResize|int}} || This configuration variable says that image scaling must be done using the [http://www.imagemagick.org/script/index.php ImageMagicк] program, even if the <code>GD</code> library is available in <code>в PHP</code>. Available since [[K4:Core v 4.3.1|Core v 4.3.1]].
| 0
|-
| {{ConfigProperty|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 [[K4:Core v 1.1.0|Core v 1.1.0]].
| 0
|-
| {{ConfigProperty|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 [[K4:Core v 4.0.1|Core v 4.0.1]].
| 0
|-
| {{ConfigProperty|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 [[K4:Core v 1.0.0|Core v 1.0.0]].
| 3
|-
| {{ConfigProperty|User_NewGroup|int}} || This configuration variable determines the user group, to which a new user is assigned if one was not specifically set.
<source lang="php">
$this->Application->GetVar('user_group')
</source>
For security reasons, the variable <code>user_group</code> works only in the administrative console - so that users registering on the front end can't choose a group for themselves. Available since version [[K4:Core v 1.0.0|Core v 1.0.0]].
| 13 (Member)
|-
| {{ConfigProperty|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 [[K4:Отсылка почтового извещения|e-mail notice]] (event <code>USER.MEMBERSHIP.EXPIRATION.NOTICE</code>) to those whose membership is ending soon and the administrator. Available since version [[K4:Core v 1.0.0|Core v 1.0.0]].
| 10 
|-
| {{ConfigProperty|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 [[K4:Core v 1.0.0|Core v 1.0.0]].
| 0
|-
| {{ConfigProperty|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 [[K4:Core v 1.1.2|Core v 1.1.2]].
| 1
|-
| {{ConfigProperty|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 [[K4:Core v 1.2.0|Core v 1.2.0]].
| no_permission
|-
| {{ConfigProperty|SessionCookieName|string}} || This configuration variable sets the name of the cookie that stores the session ID of the user. Available since [[K4:Core v 1.1.4|Core v 1.1.4]].
| sid
|-
| {{ConfigProperty|SessionReferrerCheck|int}} || This configuration variable determines whether the <code>$_SERVER['HTTP_REFERER']</code> variable is checked when the session ID of the user can be passed bypassing <code>cookies</code>. This test provides an additional guarantee that the system won't process false <code>POST</code>-requests, generated outside the system. Available since version [[K4:Core v 1.1.4|Core v 1.1.4]].
| 1
|-
| {{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
|-
| {{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
|-
| {{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}} || 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>, where <code>'''domain'''</code> - the domain, setup during installation of site
|-
| {{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
|-
| {{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}} || 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}} || 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}} || 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>

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>

which is good for search engine indexing. Available since version [[K4:Core v 1.1.4|Core v 1.1.4]].
| 0
|-
| {{ConfigProperty|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 [[K4:Core v 4.2.0|Core v 4.2.0]].
| 1
|-
| {{ConfigProperty|YahooApplicationId|string}} || This configuration variable let's the administrator enter a [http://developer.yahoo.com/wsregapp/ Yahoo Application ID], that in the future will be used for integrating functionality provided by the <code>Yahoo</code> service. Currently, it's used for the [[K4:SpellingDictionary|spelling dictionary]] search suggestion functionality that's for the search field. 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>
|}

=== In-Portal ===
{| class="prettytable" 
! name || description || default setting
|-
| {{ConfigProperty|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 [[K4:Core v 4.2.2|Core v 4.2.2]].
|
|-
| {{ConfigProperty|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 [[K4:Core v 4.3.0|Core v 4.3.0]].
| 0
|-
| {{ConfigProperty|PageHitCounter|int}} || Stores the total number of site visits. Used with [[#UsePageHitCounter|UsePageHitCounter]]. Available since [[K4:Core v 4.3.0|Core v 4.3.0]].
| 0
|-
| {{ConfigProperty|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 [[K4:Core v 1.0.0|Core v 1.0.0]].
| Set by the administrator when installing the system
|-
| {{ConfigProperty|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 [[K4:Core v 1.0.0|Core v 1.0.0]].
| lu_rootcategory_name
|}

=== Proj-Base ===
{| class="prettytable" 
! name || description || default setting
|-
| {{ConfigProperty|UseSmallHeader|int}} || Let's one remove grid headings
  {| class="prettytable vertical-table"
  ! before || after
  |-
  | [[Image:Normal grid header.gif|thumb]] || [[Image:Small grid header.gif|thumb]]
  |}
Will only work if '''<code>combined_header</code>''' block is used. Available since [[K4:Core v 4.2.0|Core v 4.2.0]].
| 0
|-
| {{ConfigProperty|UsePopups|int}} || Adding/editing items in a grid will be done in a pop-up
| 1
|-
| {{ConfigProperty|TrimRequiredFields|int}} || Indicates that before required form fields are checked (to see if they were entered), that the <code>trim()</code> function will be applied first. Available since version [[K4:Core v 4.2.2|Core v 4.2.2]].
| 0
|-
| {{ConfigProperty|MenuFrameWidth|int}} || Sets the width of the frame with the navigation tree (in pixels), 200px by default. Available only in Platform, since version [[K4:Core v 4.2.2|Core v 4.2.2]].
| 200
|-
| {{ConfigProperty|DefaultSettingsUserId|int}} || The user that's used when a new administrator (that doesn't have [[K4:PersistantSessionData|PersistentSession]] data yet) goes into any grid for the first time. An administrator in this situation receives the [[K4:PersistantSessionData|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 [[K4:PersistantSessionData|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 "<code>Users Management -> Admins</code>" section, a <code>Reset</code> 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 <code>-1</code>, i.e. "root". Available since version [[K4:Core v 4.2.2|Core v 4.2.2]].
{{TipBox|If no value is entered, then it'll be interpreted as "<code>-1</code>" anyway :(. To turn off the above described functionality, it's necessary to enter any <code>ID</code> of a non-existent user, for example <code>999999999999</code>}}
| -1
|-
| {{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
|-
| {{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
|}

=== Proj-CMS ===
{| class="prettytable" 
! name || description || default setting
|-
| {{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
|}

=== In-Commerce ===
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" 
! name || description || default setting
|-
| {{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
|-
| {{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}} || 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}} || 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}} || 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}} || 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}} || 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:ConfigurationValues|ConfigurationValues]]