Chapter 5. Administration

<< Prev   Next >>

This section contains a description of 1C:Enterprise administration methods for client/server mode.

5.1. Infobase administration

5.1.1. Backup in Client/Server Mode

Creating a backup with DBMS utilities allows you to get a perfectly accurate copy of the database so that you can revert exactly to the pre-backup state. For the backup purposes, it is assumed that the data in the database is valid. If the database contains any abnormal data, restoring the backup may fail.

To improve usability of the infobase backup, it is recommended to include log files in it (for more details see {HL: adm: TI000000145}). However, you cannot add the log files to the backup using the standard DBMS functionality. You need a convenient tool of your choice instead. When restoring a backup, it is also recommended to restore the log. In this case, activity history will be available in the infobase along with the recovered data.

To create a backup, it is recommended to use these methods:

• For file option. Copying of file 1Cv8.1CD, while there should be no connection to informational base (in case with the help of Designer).
• For client server option. By means of reserve backup of appropriate DBMS.

Materials on creating backups for specific SQL servers:

• Microsoft SQL Server 2000: http://msdn.Microsoft.com/ru-ru/library/aa196685.
• Microsoft SQL Server 2005: http://msdn.Microsoft.com/ru-ru/library/ms187048(v=sql.90).aspx.
• Microsoft SQL Server 2008: http://msdn.Microsoft.com/ru-ru/library/ms187048(v=sql.100).aspx.
• Microsoft SQL Server 2008 R2: http://msdn.Microsoft.com/ru-ru/library/ms187048(v=sql.105).aspx.
• Microsoft SQL Server 2012: http://msdn.Microsoft.com/ru-ru/library/ms187048(v=sql.110).aspx.
• Microsoft SQL Server 2014: http://msdn.Microsoft.com/ru-ru/library/ms187048(v=sql.120).aspx.
• Microsoft SQL Server 2016: http://msdn.microsoft.com/ru-ru/library/ms187048(v=sql.130).aspx.
• Microsoft SQL Server 2016: https://docs.microsoft.com/ru-ru/sql/relational-databases/backup-restore/back-up-and-restore-of-sql-server-databases?view=sql-server-2017.
• Microsoft SQL Server 2019: https://docs.microsoft.com/ru-ru/sql/relational-databases/backup-restore/back-up-and-restore-of-sql-server-databases?view=sql-server-ver15.
• PostgreSQL 8.1: http://www.postgresql.org/docs/8.1/static/backup.html.
• PostgreSQL 8.2: http://www.postgresql.org/docs/8.2/interactive/backup.html.
• PostgreSQL 8.3: http://www.postgresql.org/docs/8.3/interactive/backup.html.
• PostgreSQL 8.4: http://www.postgresql.org/docs/8.4/interactive/backup.html.
• PostgreSQL 9.0: http://www.postgresql.org/docs/9.0/interactive/backup.html.
• PostgreSQL 9.1: http://www.postgresql.org/docs/9.1/interactive/backup.html.
• PostgreSQL 9.2: http://www.postgresql.org/docs/9.2/interactive/backup.html.
• PostgreSQL 9.3: http://www.postgresql.org/docs/9.3/interactive/backup.html.
• PostgreSQL 9.4: https://www.postgresql.org/docs/9.4/backup.html.
• PostgreSQL 9.6: https://postgresql.org/docs/9.6/backup.html.
• PostgreSQL 10: https://postgresql.org/docs/10/backup.html.
• PostgreSQL 11: https://postgresql.org/docs/11/backup.html.
• PostgreSQL 12: https://postgresql.org/docs/12/backup.html.
• Postgres Pro Standard 9.6: https://postgrespro.ru/docs/postgrespro/9.6/backup.html.
• Postgres Pro Standard 10: https://postgrespro.ru/docs/postgrespro/10/backup.html.
• Postgres Pro Standard 11: https://postgrespro.ru/docs/postgrespro/11/backup.html.
• Postgres Pro Standard 12: https://postgrespro.ru/docs/postgrespro/12/backup.html.
• Postgres Pro Enterprise 9.6: https://postgrespro.ru/docs/postgresproee/9.6/backup.html.
• Postgres Pro Enterprise 10: https://postgrespro.ru/docs/postgresproee/10/backup.html.
• Postgres Pro Enterprise 11: https://postgrespro.ru/docs/postgresproee/11/backup.html.
• Postgres Pro Enterprise 12: https://postgrespro.ru/docs/postgresproee/12/backup.html.
• IBM Db2 v9.7: http://publib.boulder.ibm.com/infocenter/db2luw/v9r7/topic/com.ibm.db2.luw.admin.ha.doc/doc/c0052073.html.
• IBM Db2 v10.1: http://publib.boulder.ibm.com/infocenter/db2luw/v10r1/topic/com.ibm.db2.luw.admin.ha.doc/doc/c0052073.html.
• IBM Db2 v11.1: http://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/com.ibm.db2.luw.admin.ha.doc/doc/c0052073.html.
• Oracle Database 10g Release 2: http://download.oracle.com/docs/cd/B19306_01/backup.102/b14192/toc.htm.
• Oracle Database 11g Release 1: http://download.oracle.com/docs/cd/B28359_01/backup.111/b28270/toc.htm.
• Oracle Database 11g Release 2: http://docs.oracle.com/cd/E11882_01/backup.112/e10642/toc.htm.
• Oracle Database 12с Release 1: http://docs.oracle.com/database/121/BRADV/toc.htm.

5.1.2. Converting infobases for use in client/server mode

To convert an infobase from file to client/server mode, export/import it to a file.

It is necessary to export infobase (click Administration – Export infobase). Create an empty infobase in the client/server mode. Open base in the Designer mode and make loading of the infobase (clickAdministration – Load infobase).

5.2. Server cluster administration

5.2.1. General information

This utility is a snap-in MMC module that can be used on computers with Microsoft Management Console installed. Microsoft Management Console is a standard tool in the Microsoft Windows operating systems. When installing 1C:Enterprise for infobase operations in client/server mode for these operating systems, the utility start shortcut will be in the Start menu, in section 1C:Enterprise 8.

Functionality of the server cluster administration utility is similar to the software administration capabilities of the server cluster (see page ).

Please note that the information displayed by the administration console is not refreshed automatically. For getting up-to-date information be sure to use console command Actions – Renew (or command Renew from context menu).

5.2.2. Running the administration utility

The utility can only be run on a computer that has Microsoft Management Console installed. The launching of utility can be performed with the help of the following menu commands Launch – Programs – 1C:Enterprise 8  – More details – 1C:Enterprise servers administration for 32-bites version of utilityor Launch – Programs – 1C:Enterprise 8 (x86-64) – More details  1C:Enterprise servers administration for 64-version of utility.

Alternately, start the Microsoft Management Console (MMC) using the command line:

mmc

After Microsoft Management Console (MMC) is started, click File – Add / Remove Snap-in...

The Add or Remove Snap-in dialog box appears. Click the Add button.

The Add Isolated Snap-In dialog box appears. Select 1C:Enterprise 8.3 Servers from the list, click Add, and close the dialog box using the Close button.

In the Add / Remove Snap-in dialog box, click OK. This will connect the administration utility to the Microsoft management console.

5.2.3. Registering an instance of a working server

When you first start the administration utility, the tree of central servers includes only the working server installed on the computer running the administration utility (provided that the server agent is running on this computer).

To display the full list of central servers, select and expand the 1C:Enterprise 8.3 Central Servers branch in the central server tree.

The tree of central servers contains a list of central servers to which the utility is connected. Each central server is identified by the name of the computer on which it is running. The properties field displays a list of central servers, containing the network address of each central server and its description.

5.2.3.1. Connecting the utility to central server

For the utility connection to new central server it is necessary to perform the command of context menu New – Central server of 1C:Enterprise 8.3 or similar command of utility main menu.

The central server properties dialog box will be displayed.

You need to enter the following data in the dialog box fields:

Protocol used by the central server connection. Selected from the list. The default value is tcp. This field specifies the protocol the administration utility will use to connect to the central server agent. The only value supported istcp.

Network address of the central server on which the server agent is running.

Network port of the server agent that is running on the central server. The default value is1540. The server agent port is specified on start (see page).

Arbitrary description of the central server.

5.2.3.2. Viewing and editing central server properties

To view or edit properties of a central server, select the server in the list of central servers and execute the Properties context menu command, or the corresponding command in main menu of the utility.

The central server properties dialog box described in the previous section will be displayed (see page).

5.2.3.3. Removing central server from utility

To remove a central server from the list of central servers in the utility, select the server in the list and execute the Delete context menu command, or the corresponding command in main menu of the utility.

5.2.3.4. Disconnecting utility from central server

The 1C:Enterprise server cluster administration utility can be disconnected from the central server, while connection settings to the central server will not be deleted.

To disconnect the utility from the central server, select the server in the list of central servers and execute the Disconnect context menu command, or the corresponding command in main menu of the utility.

5.2.4. Operations with list of central server administrators

The server cluster allows to create a list of central server administrators so that administrative operations (for example, adding a new cluster, or viewing the list of central server administrators) can be performed by authenticated users only.

The list of central server administrators is empty by default. This means that the central server administrator authentication is not required to perform the above actions.

To display the list of central server administrators, select a server in the central server tree, and then select and expand the Administrators branch.

The central server tree contains the list of administrators of the selected central server. Each administrator is identified by name. The properties field displays a list of administrators of the selected central server, containing the name and description of each administrator.

For each working server that is not assigned as a central server of a cluster and that has a non-empty list of central server administrators, the administrators list must include an administrator with OS authentication of the user on whose behalf ragent is running on the central server of the cluster, or an administrator with name and password that matches the name and password for one of the administrators of the central server of the cluster.

5.2.4.1. Creating a central server administrator

For adding new administrator of central server be sure to select in central servers tree the required server, select tree Administrators and perform context menu command New – Administrator or the similar command of utility main menu.

The central server administrator properties dialog box will be displayed.

You need to enter the following data in the dialog box fields:

Name of the central server administrator.

Arbitrary description of the central server administrator.

Flag indicating that password authentication is enabled. It is set by default.

Password of the central server administrator.

Password confirmation.

Flag indicating that OS authentication is enabled.

OS user. It can be specified like this: \\domain name\username. For example: \\domainname\username. You can directly specify a user by entering their name, or select a user from the OS user list available on a computer running the infobase administration utility. To select a user from the list, click the "..." button and select an OS user.

Two methods of central server administrator authentication are supported:

• Using a password
• Using OS functionality

When authenticating with a password, a central server administrator authentication dialog box is displayed. You are required to enter a username and password.

When authenticating using the OS functionality, you are not required to enter a username or password. The authentication dialog box is not displayed. The central server administrator is selected depending on the OS user on whose behalf the connection was established.

5.2.4.2. Viewing and editing central server administrator's properties

To view or edit the central server administrator's properties, select the administrator in the list of central server administrators and clickProperties, or the corresponding command in main menu of the utility.

The central server administrator properties dialog box will be displayed.

All properties, except for the administrator name, are editable. Values of Password and Password Confirmation fields are hidden.

5.2.4.3. Deleting a central server administrator

To delete a central server administrator, select the administrator in the list of central server administrators and execute the Delete context menu command, or the corresponding command in main menu of the utility.

5.2.4.4. Central server administrator authentication

Authentication is automatically requested from a central server administrator when they attempt to perform an action requiring authentication (provided that the list of central server administrators is not empty). The central server administrator authentication dialog box is displayed.

You need to enter the following data in the dialog box fields:

Name of the central server administrator.

Password of the central server administrator.

5.2.5. Operations with list of clusters

To display the list of clusters registered on the central server, select a server in the central server tree, and then select and expand the Clusters branch.

 

Fig. . List of clusters

The central server tree contains a list of clusters for the selected central server. Each cluster is identified by a network port number. The properties field displays a list of clusters of the selected central server, containing port number and description of each cluster.

5.2.5.1. Adding clusters

For adding new cluster to central server be sure to select in central servers tree the required server, select tree Clusters and perform context menu command New – Cluster or the corresponding command in main menu of the utility.

The cluster properties dialog box will be displayed.

You need to enter the following data in the dialog box fields:

Arbitrary description of the cluster.

Name of the central server hosting the cluster. Not editable.

Network port number of the cluster manager. The default value is 1541.

Cluster security level. Select it from the list of possible values: Never, Connection only, Always. By default value is disconnected. For details on using cluster security levels, see page.

Once this period expires, the working process will be restarted. A zero value means that working processes will not restart automatically.

The reloading of working process is done in the following way:

• The existing working process (let's call it the "old" one) is disconnected. The working process in disconnected mode:
  • Continues serving old connections with infobases.
  • Accepts new connections with infobases, which are maintained by current working process.
  • Does not accept new connections to infobases, which are not maintained by working process.
• New working process (let's call it the "new" one) is launched and registered in server cluster.
• In new working process the contexts of infobases, which maintain stopped working process are created. The infobases applications are downloaded to created contexts. The creation of contexts is performed by system background tasks with some specific traits:
  • The list of connections displays the title of application System background tasks and application identifier SystemBackgroundJob.
  • In case of background system task launching the requirements of functionality value are not taken into account.
  • The background system task operated without session creation and its operation is not displayed in logs register.
  • The background system tasks can be aborted by means of server cluster administration.
• On the completion of infobases contexts forming in new  working process, the old working process:
  • Stops the acceptance of all new connections.
  • "Transfers" existing connections to new working process.
• The old working process is completed on the fulfillment of one of the following conditions ( conditions " by OR"):
  • After successful transfer of all existing connections.
  • On the time expiration Problematic processes should be aborted via.
• The registration of old working process in server cluster is aborted.

If the cluster monitoring mechanism approves the process to be the corrupted one, this flag defines the option of such processes forced abortion. This flag does not influence the operation of monitoring itself. See page for cluster monitoring detailed description.

Defines the necessity of working process forced abortion dump forming in case if server cluster performs working process forced abortion. This situation might occur in case if during monitoring of cluster condition the value set in working server parameter Processor memory amount crucial amount is violated. The description of algorithm, which might cause working process abortion, see page .

Dump is being formed in accordance with current settings of formation of force closure dumps ({HL:adm:TI000000152}).

Time frame on the completion of which the corrupted working process is forcedly aborted irrespectively of the number of connections. All connections to this process fail. Value of this property can be changed while the cluster is running. A zero value means that processes will not be terminated. A cluster manager that exceeds the limit of the virtual address space is always restarted without waiting period.

The level of resilience defines the maximum number of working servers in the cluster whose concurrent failure would not result in abnormal termination of any user sessions. For more detailed description of this property, see page .

This parameter determines how a working process is selected when establishing a new connection. For more detailed description of this property, see page .

5.2.5.2. Viewing and editing cluster properties

To view or edit cluster properties, select a cluster in the list of clusters of the central server and execute the Properties context menu command, or the corresponding command in main menu of the utility.

The cluster properties dialog box will be displayed.

When the Secure connection property is changed for a running server cluster, you need to restart the cluster in order for the new value of this property to be applied for the server cluster.

5.2.5.3. Calling operation to apply functionality assignment rules

The functionality assignment rules do not take effect until they are explicitly applied. The list of rules edited in the cluster console does not affect the operation of the server cluster until the rules are applied. The application may be full or partial.

In the case of partial application, services that support migration between working servers without data loss are reassigned. Other services are reassigned only if the new functionality assignment rules do not allow these services to remain at their previous locations or the working servers on which these services functioned at the time of the partial application operation are not available. Full application affects all services regardless of formal characteristics of the services.

When performing full application, any client applications connected to the server cluster on which the operation is performed may be terminated. This situation is also possible in the case of partial application, if a decision has been made to reassign all services, and not only those that allow migration without data loss.

To apply the rules, select menu item Apply functionality assignment rules (partial) or Apply functionality assignment rules (full) in the context menu of the server cluster.

5.2.5.4. Deleting clusters

To delete a cluster, select a cluster in the list of clusters of the central server and execute the Delete context menu command, or the corresponding command in main menu of the utility.

5.2.6. Operations with list of working servers in cluster

To display the list of cluster working servers, select a server in the central server tree, select a cluster registered on this server, and then select and expand the Working servers branch.

The central server tree contains a list of working servers of the cluster. Each working server is identified by a network name. The properties field displays a list of working servers of the selected cluster, containing the name of each server, the network port number of the server agent running on this server, and a description of the server.

When you create a default cluster, the working server where it was created is added to the cluster automatically. The Central server check box is automatically selected for this working server.

5.2.6.1. Adding a working server to cluster

For adding new working server to cluster it is necessary to select in central servers tree required central server, select required cluster, registered on this server, select tree Working servers and perform context menu command New – Working server or the corresponding command of utility main menu.

The working server properties dialog box will be displayed.

You need to enter the following data in the dialog box fields:

Arbitrary description of the cluster server.

Network address of the working server on which the server agent is running.

Network port number of the server agent that is running on the specified computer. The default value is 1540.

The range of network ports that will be used to assign addresses to working processes created on this server. The default value is 1560:1591.

The amount of memory, in bytes, that can be safely used during a server call.

It can take values from -1 to 9 223 372 036 854 775 807:

• -1. Any server call is deemed dangerous, if during the same a working process memory capacity becomes equal to a value specified in Temporary allowed amount of process memory property.
• 0. Capacity is determined by default as a 10% share of a value specified in Temporary allowed amount of process memory.

Defines the amount of cluster (working processes and cluster managers) processes memory critical amount. The total amount of the virtual address space occupied by working processes of the cluster running on the working server, the increase of which can cause significant decrease of working server efficiency.

If the amount of process memory exceeds the value of this parameter, it will cause the abortion of the required number of processes in order total amount of consumed memory of remaining cluster processes does not exceed this parameter value. If cluster settings contain flag Register dump process in case of memory critical amount increase, in case of each working process force termination the attempt of dump formation will be performed taking into account the settings of force closure of dumps formation.

At each iteration of cluster monitoring of cluster condition in case if critical amount of processes memory is increased, the technological register fixes ATTN event with the specification of identifiers of all cluster processes and their memory amount.

This parameter can be assigned a value from -1 to 9 223 372 036 854 775 807, while:

• -1.Memory available for cluster working processes on the current working server is unlimited.
• 0.Memory available for cluster working processes on the current working server is limited to 95% of server RAM.

The default value is 0.

Defines the size of temporary allowed amount of operative memory occupied with working processes and cluster managers (cluster processes) at installed working server in bites. If the amount of memory consumed by cluster processes exceeds the value of parameter, the system thinks that the aforementioned working server has low efficiency level and it should not have new connections with infobases.

This value is designed to monitor memory capacity used by working processes in general or any specific server call in particular:

• Working process memory monitoring.

  If the value of Temporary allowed processes memory sizeexceeds the time stipulated in Interval of growth of temporary allowed processes memory (it cannot be 0), reloading of this working server processes starts. The reload is performed starting from working process, which consumes maximum amount of memory in order to decrease the consumed operative memory size. If the reload process had been terminated the time when the sum of consumed memory by remaining cluster processes is less or equal to Temporary allowed processes memory amount.

  During reloading sessions serviced by working processes selected for completion are reassigned to other working processes. A working process is completed only if it ceases to service sessions of client connections.

• Server call memory monitoring. Parameter values in this mechanism depend on a server license used.

  Each cluster working process determines the amount of memory occupied by cluster processes on this working server (hereinafter ProcessMemory). ProcessMemory is updated every two seconds.

  When you make a server call, ProcessMemory current value is registered (hereinafter CurrentProcessMemory) and a difference between Temporarily allowed amount of process memory and CurrentProcessMemory is calculated (hereinafter MemoryLimitPerCall). If MemoryLimitPerCall is less than Safe Memory Consumption Limit, MemoryLimitPerCall is deemed equal to Safe Memory Consumption Limit.

  During the call, the amount of memory consumed by the call (hereinafter, CallMemory) is calculated.

  If upon memory allocation MemoryPerCall is in excess of MemoryLimitPerCall in a single server call, the said call is interrupted by an exception and terminated as failed. In this case, an EXCP event is written to the technology log, containing the following information:

  • Exception text
  • Exception context

    Temporarily allowed amount of process memory value (see the above algorithm) depends on a server license used by a server cluster:

  • PROF server license: always equal to 80% of computer physical memory (irrespective of a value you enter for this parameter).
  • CORP server license: a value entered by a user in server cluster settings is used.

It can take values from -1 to 9 223 372 036 854 775 807:

• -1. Temporary allowed memory size available for cluster processes at the aforementione working server is unlimited.
• 0. A default value is used as a temporary allowed memory size available for cluster processes on this working server:
  • To monitor working process memory, 70% of server RAM.
  • To monitor server call memory, 80% of server RAM.

The default value is 0.

Defines the time the size of operative memory consumed by cluster processes can exceed the value of Temporary allowed processes memory amount. Find the details in the working server parameter descriptionTemporary allowed processes memory amount. This parameter will be used only in case if its value is not equal to 0 and the value of Temporary allowed processes memory amount differs from -1.

The default value is 300 seconds.

Maximum number of infobases whose connections can be processed by a single working process on this server. A zero value means that no limit is set.

If the number of infobases exceeds this number, the server cluster will create at this working server an additional working process.

Maximum number of infobase connections that a single working process of this server can process. A zero value means that no limit is set.

If the number of connections maintained by working process exceeds this number, the server cluster will create on this server an additional working process.

Number of network port of the main cluster manager running on this working server. This network port is used when generating the server cluster address for client application. The address will look like this: <Computer property>:<Main cluster manager port>. If the Computer property is set to COMP1 and the Main cluster manager port property is set to 2541, the server cluster address is COMP1:2541.

The value of this parameter is ignored if the Central server check box is not selected.

Enables allocating a separate cluster manager for each type of service (see page). If this check box is selected, a dedicated cluster manager will be created for each cluster service type. Otherwise, all cluster services are assigned to the same cluster manager of the working server.

If this check box is selected, the cluster registry will be synchronized with this working server and the client applications will use the address of this working server to connect to the cluster.

5.2.6.2. Viewing and editing cluster server properties

To view or edit the properties of a cluster server, select a server in the list of cluster servers and execute the Properties context menu command, or the corresponding command in main menu of the utility.

The working server properties dialog box will be displayed.

In addition to the properties that are displayed in the dialog box when creating a new server, the properties dialog box of the existing server also displays the internal network port of the server agent that was automatically assigned on the server agent startup and is used for interaction between the server cluster processes.

In the properties of an existing server, only the network port range is editable.

5.2.6.3. Removing servers from cluster

Removing a working server can cause client connections to terminate abnormally. To avoid this, add this functionality assignment rule (with the highest priority) before removing the server:

• Object type: Any requirement object.
• Rule type: Do not assign.
• Infobase name: do not specify.
• Additional parameter value: do not specify.

Then, apply a new set of rules and wait until the existing connections terminate. Then, remove the working server using the Delete context menu command, or the corresponding main menu command.

You cannot delete the last working server with property Central server enabled.

5.2.6.4. Functionality assignment rules

To view the list of functionality assignment rules for a specific working server, select the server in the central server tree. Then, select a cluster and a working server. Then, select the Functionality assignment rules branch.

To create a new rule be sure to select Create – Functionality assignment rule in context menu or in menu Activity of main menu.

For a detailed description of the functionality assignment rules, see page .

The rules are processed in the order they are placed in the rules list for the server. The processing order (rule priority) is determined by the column Number of the functionality assignment rule list. The smaller the number, the higher the priority and the earlier the request will be processed. To change the priority of a rule, place the cursor over the rule, open the context menu (or the Action submenu of the main menu), and select the Increase rule priority or Reduce rule priority command, depending on whether you need to increase or decrease the rule priority.

The functionality assignment rules do not take effect until they are explicitly applied. For more details on applying functionality assignment rules, see page .

5.2.7. Operations with list of infobases

To display the list of infobases registered in a cluster, select a server in the central server tree, select a cluster registered on this server, and then select and expand the Infobases branch.

The central server tree contains a list of infobases in the cluster. Each infobase is identified by name. The properties field displays a list of infobases of the selected cluster, containing the name and description of each infobase.

5.2.7.1. Registering a new infobase

Registration of a new infobase in a server cluster can be performed:

• From the client application
• Directly in the server cluster

When a new infobase is added in the client application, it is automatically registered in the server cluster.

To register a new infobase using the server cluster administration utility, select a central server in the central server tree, select a cluster registered on this server, select the Infobases branch and execute context menu command New – Infobases or the corresponding command in main menu of the utility.

The infobase properties dialog box will be displayed.

Parameters of the infobase are identical to the parameters of the new infobase created using the 1C:Enterprise launcher. For description of these parameters {HL:adm:TI000000096:refer to the book}.

Please pay attention to the Allow 1C:Enterprise server to issue licenses parameter. This parameter controls whether 1C:Enterprise server can issue client licenses. If the parameter is set to Yes, the 1C:Enterprise server will issue client licenses whenever the client application fails to get a client license. For the specific procedure of acquiring client licenses using 1C:Enterprise server {HL:adm:TI000000261:refer to the book}. If the parameter is set to No, the 1C:Enterprise server will not issue client licenses. In this case, the client application that fails to get a client license will display the following message: License not found. No protection key or software license found.

When registering a new infobase, a check is made whether an infobase with the same name exists on the specified database server. If the infobase exists, a connection with it will be established. If the existing database already contains 1C:Enterprise infobase data, a connection will be established with the existing infobase. If the database does not contain infobase data, a new 1C:Enterprise infobase will be created in it.

5.2.7.2. Viewing infobase properties

To view and change the properties of an infobase, select the infobase in the infobase list and execute the Properties context menu command, or the corresponding command in main menu of the utility.

In the infobase parameter properties window, you can edit the names of the database server and the database, change the type of DMBS used, the database user name and password.

Properties related to locks of user sessions with this database are also editable.

If the check box is selected, session start lock is enabled for the infobase. The following rules are applied:

• Existing sessions can continue
• Existing sessions can start background jobs
• Existing sessions can establish connections
• Opening new sessions is not allowed
• Establishing new connections is not allowed, except by existing sessions

The lock takes effect if the current time exceeds the value of this property.

The lock ends if the value of this property is non-zero and less than or equal to the current time.

Text that will be included in the error message when trying to establish a connection to a blocked infobase.

This string is added to the /UC command-line parameter or to the UC connection string parameter to establish a connection to the infobase regardless of connection lock.

Arbitrary text. It can be used in configurations for various purposes.

If this check box is selected, scheduled job lock is enabled for this infobase.

A string describing the parameters of the external session management web service. The web service parameters string has the following format: Parameter=Value;. The parameter string contains 4 mandatory parameters (wsdl, ns, srvc, port) and two optional parameters (tout, wsver):

• wsdl is the URL used to get WSDL description of the web service.
• ns is the web service namespace.
• srvc is the name of the web service that will be used for external session management.
• port is the name of the web service port.
• tout is the maximum timeout for external session management web service, in seconds. The default value is 5 seconds.
• wsver is the version number of the external session management web service. The default value is 3. For more details about the external session management service, see page.

An example of web service description string:

wsdl=http://server/sm/ws/manager?wsdl;ns=http://v8.1c.ru/SessionManager;srvc=manager;port=managerSoap;tout=10;wsver=1;

For more details on how external session management works, see page .

If the check box is selected, an error occurs when the external session management web service is unavailable and connection to the infobase cannot be established. If the check box is cleared and the web service is unavailable, the connection can be established and no restrictions are applied on the number of concurrent sessions.

If you specify the name of a security profile in this field (see page ), the security profile applies its restrictions to the server-side application. For more detailed description of security profiles, see page .

If you specify the name of a security profile in this field, the security profile applies its restrictions to the application segments running in safe mode. For more detailed description of security profiles, see page .

If you check this check box, a server cluster starts to create backup working processes for this infobase. For more information concerning working process backup, see page .

5.2.7.3. Deleting infobases

To delete an infobase, select an infobase in the list and execute the Delete context menu command, or the corresponding command in main menu of the utility.

A warning will be displayed: Do you want to delete the infobase? If you confirm, you will be offered a choice of three options for deleting the infobase.

• Delete database. If you select this option, registration of the infobase in the server cluster will be deleted, and the corresponding database on the database server will also be deleted.
• Clear database. If you select this option, registration of the infobase in the server cluster will be deleted, and all data will be deleted from the corresponding database on the database server. The database itself will not be deleted from the database server.
• Make no changes. If you select this option, only registration of the infobase in the server cluster will be deleted. No changes will be made to the database.

If you select the Delete database option while the database has active user connections, registration of the infobase in the server cluster will be deleted but the database will not be deleted and the database server will display an error message, such as:

5.2.8. Operations with list of cluster administrators

You can create a separate list of administrators for each cluster registered on the central server, so that only authenticated users can perform administrative actions with the cluster.

By default, the list of cluster administrators is empty. This means that cluster administrator authentication is not required.

To display the list of cluster administrators, select a server in the central server tree, select a cluster registered on this server, and then select and expand the Administrators branch.

The central server tree contains the list of administrators of the selected cluster. Each administrator is identified by name. The properties field displays a list of administrators of the selected cluster, containing the name and description of each administrator.

5.2.8.1. Adding cluster administrators

To add a cluster administrator, select a server in the central server tree, select a cluster registered on this server, select the Administrators branch and execute context menu command New – Administrator or the corresponding command in main menu of the utility.

The cluster administrator properties dialog box will be displayed.

You need to enter the following data in the dialog box fields:

Name of the cluster administrator.

Arbitrary description of the cluster administrator.

Flag indicating that password authentication is enabled. It is set by default.

Password of the cluster administrator.

Password confirmation.

Flag indicating that OS authentication is enabled.

OS user. Specify the username in the following format: \\domain name\username. For example: \\domainname\username. You can directly specify a user by entering their name, or select a user from the OS user list available on a computer running the infobase administration utility. To select a user from the list, click the "..." button and select an OS user.

Two methods of cluster administrator authentication are supported:

• Using a password
• Using OS functionality

When authenticating with a password, a cluster administrator authentication dialog box (see page ) is displayed. You are required to enter a username and password.

When authenticating using the OS functionality, you are not required to enter a username or password. The authentication dialog box is not displayed. The cluster administrator is selected depending on the OS user on whose behalf the connection was established.

If no authentication type is specified for an administrator, this administrator can perform only those actions that do not require authentication.

5.2.8.2. Viewing and editing cluster administrator properties

To view or edit the properties of a cluster administrator, select an administrator in the list of cluster administrators and execute the Properties context menu command, or the corresponding command in main menu of the utility.

The cluster administrator properties dialog box will be displayed.

All properties, exceptfor the administrator's name, are editable. The values of the Password and Confirm Password fields are hidden.

5.2.8.3. Deleting cluster administrators

To delete a cluster administrator, select the administrator in the list of cluster administrators and execute the Delete context menu command, or the corresponding command in main menu of the utility.

5.2.8.4. Cluster administrator authentication

Authentication is automatically requested from a cluster administrator when they attempt to perform an action requiring authentication (provided that the list of cluster administrators is not empty). The cluster administrator authentication dialog box is displayed.

You need to enter the following data in the dialog box fields:

Name of the cluster administrator.

Password of the cluster administrator.

5.2.9. Viewing list of cluster managers

You can view and edit the list of cluster managers. By default, one cluster manager is set as the primary cluster manager. It is defined in all clusters.

The cluster determines the number and location of cluster managers. The number and location of cluster managers is affected by the functionality assignment rules (see page ) and the working server properties Dedicated manager for each service and Central server (see page ). The administrators cannot manually add or delete cluster managers.

To view description of a cluster manager, use the Properties command in the context menu of the cluster manager.

A window will be displayed where you can edit the description of the cluster manager.

5.2.10. Viewing a list of working processes

The list of working processes can be displayed:

• For the entire cluster
• For a cluster server

To display a list of working processes for the entire cluster, select a server in the central server tree, select a cluster that is registered on this server, and then select and expand the Working processes branch.

To display the list of working processes for the selected cluster server only, select a server in the central server tree, select a cluster, select a cluster server, and then select and expand the Workflows branch.

The central server tree contains a list of working processes. Each working process is identified by a server name and a sequence number in that working server. The property field displays technical information that describes a particular working process. The description of the displayed parameters is given below.

To view the properties of a working process, select a working process in the list of working processes and execute the Properties context menu command, or the corresponding command in main menu of the utility. The administrators cannot manually add or delete working processes.

The working process properties dialog box will be displayed.

The working process properties dialog box contains the following fields that are not editable:

Name of the working server where the working process runs.

The working process is currently enabled and can be used.

The working process is currently in use.

Currently, this is a backup working process (for more information, see page ).

Last start time of the working process.

Network port of the working process dynamically selected on working process startup from the range of network ports specified for the server.

Current number of connections processed by the working process.

The process number (in terms of the OS running the working process).

The amount of memory occupied by the working process.

Current available performance. For more information see page .

The average time spent on processing a connection. Equal to the sum of the values of the following fields:

• Spent by server
• Spent by DBMS
• Spent by client
• Spent by lock manager

The average time consumed by a working process for processing a connection.

The average time consumed by a DBMS for processing a connection.

The average time spent by a client for processing a connection.

The average time spent by a working process for processing a connection.

The average number of client threads processed by the working process. Used to calculate working process performance.

For details on working process performance parameters, see page .

This field displays information about a server license used by this working process and a description of this license. For description of the string, see page .

5.2.11. Operations with list of sessions

5.2.11.1. General information

The list of sessions can be displayed:

• For the entire cluster
• For an infobase

To display a list of sessions for the entire cluster, select a central server in the central server tree, select a cluster registered on this server, select and expand the Sessions branch.

To display the list of connections for a specific database, select a central server in the central server tree, select a cluster, select an infobase, and then select and expand the Sessions branch.

The properties field displays a list of sessions containing the following information:

Name of the connected infobase.

Session number.

Time of session creation.

Time of the last activity of the session.

Network name of the computer running the client application that initiated creation of the session. The computer name will be empty if the session is created by web client, thin client connected via a web server, or a web service.

Name of the infobase user.

Client application startup mode (see page ).

Application localization language.

Name of the connected cluster server.

Number of the network port of the working process servicing this connection.

Process number of the working server (in terms of the operating system) that is processing this session.

Number of the connection established to this session.

ID of the database server process. It is displayed if the connection to the database is currently captured by a session: either a database call is in progress, or the transaction is open, or the TempTablesManager object containing at least one temporary table is captured.

Duration of the capture of the connection to the database by the current session, from the moment of capture to the current moment. It is only displayed if the database connection is captured by the session.

ID of the process that locked the process.

User name (session number) in the event that a process is waiting for a transaction lock to be released.

Time since the start of the current database call (in seconds).

Total duration of database calls in the last five minutes (in seconds).

Total duration of database calls since the beginning of the first call (in seconds).

Amount of data sent over this client connection between the 1C:Enterprise server and the database server in the last 5 minutes (in bytes).

Amount of data sent over this client connection between the 1C:Enterprise server and the database server since the beginning of this session (in bytes).

Current execution time of the latest incomplete server call.

Total duration of server calls by this connection in the last five minutes (in seconds).

Total duration of server calls since the client connection was established (in seconds).

Number of times this connection called the server in the last five minutes.

Number of times this connection called the server since the client connection was established.

Amount of data sent and received in the last five minutes (in bytes).

Amount of data sent and received since the client connection was established (in bytes).

Difference between the amounts of memory occupied and released by the thread making the current call, since the beginning of the call (in bytes).

Difference between the amounts of memory occupied and released by the threads making calls for this session, in the last five minutes (in bytes).

Difference between the amounts of memory occupied and released by the threads making calls for this session, since the session was opened (in bytes).

Amount of data read from disk since the current call was initiated (in bytes).

Amount of data read by this session from disk in the last five minutes (in bytes).

Amount of data read by this session from disk since the session was opened (in bytes).

Amount of data written to disk since the beginning of the current call (in bytes).

Amount of data written by this session to disk in the last 5 minutes (in bytes).

Amount of data written by this session to disk since the session was opened (in bytes).

Summary of the client license used by this session. For description of the string, see page .

Indicates that the session is hibernating.

Time period (in seconds) after which an inactive session enters hibernation mode.

Time period (in seconds) after which a hibernating session is terminated.

Current running time of the cluster service. Name of the service is specified in the Current service property.

Name of the service that is currently running. If the column is empty, it means that no cluster services are running currently.

Total running time of all cluster services in the last 5 minutes.

Total running time of all cluster services since the beginning of the session.

Information on the consumption of CPU time by the current server call, with millisecond accuracy.

Information on the consumption of CPU time by server calls in the last 5 minutes, with millisecond accuracy.

Information on the consumption of CPU time by server calls during the entire session, with millisecond accuracy.

IP address of the client application that started this session.

5.2.11.2. Viewing session properties

To view the session properties, select a session in the session list and execute the Properties context menu command, or the corresponding command in main menu of the utility.

The session properties dialog box will be displayed.

The session properties dialog box contains the following information (all session properties are not editable):

Name of the infobase used to open the session.

Session number.

Time of session creation.

Time of the last activity of the session.

Network name of the computer running the client application that initiated creation of the session. The computer name will be empty if the session is created by web client, thin client connected via a web server, or a web service.

IP address of the client application that started this session. IP address is obtained:

• From web server headers upon connecting via a web server. If reverse proxy is used, configure the X-Forwarded-For header to reverse proxy.
• From TCP connection properties upon connecting directly to the server cluster.
• This information is unavailable to background jobs.

Name of the infobase user.

Client application startup mode (see page ).

Localization language of the client application.

Name of the connected cluster server.

Number of the network port of the working process servicing this connection.

Process number of the working server (in terms of the operating system) that is processing this session.

Number of the connection established to this session.

This field displays information about a client license used by this session and a description of this license. For description of the string, see page .

5.2.11.3. Terminating sessions

To terminate a session, select a session in the list of sessions and execute the Delete context menu command, or the corresponding command in main menu of the utility. If the session is assigned to a connection at the time of termination, an attempt is made to break the connection (see page ).

Before termination, you will be asked to provide an error message that will be displayed to the user who started the session to be terminated.

To terminate a session, you need server cluster administrator privileges (see page ).

5.2.12. Operations with list of connections

5.2.12.1. General information

The list of connections can be displayed:

• For the entire cluster
• For a cluster working process
• For an infobase
• For a cluster server working process

To display the list of connections for the entire cluster, select a central server in the central server tree, select a cluster registered on this server, and then select and expand the Connections branch.

To display a list of connections for a cluster working process, select a central server, select a cluster, select Working processes branch, select a working process, and then select and expand the Connections branch.

To display the list of connections for an infobase, select a central server in the central server tree, select a cluster, select an infobase, and then select and expand the Connections branch.

To display the list of connections for a cluster server working process, select a central server in the central server tree, select a cluster, select a cluster server, select a working process, and then select and expand the Connections branch.

Connections are not displayed in the central server tree. The property field displays a list of connections containing the following information:

Name of the connected infobase. This field is empty when using technical connections.

Connection number. Number of each new infobase connection is incremented by 1. A new connection can only have number 1 assigned if no connections were established to the infobase previously. Number 0 is only assigned to technical connections that are not associated with any infobase. Thus, both in the file and in the client/server version, the numbering of connections starts from 1, only after all clients, including the scheduled and background jobs, disconnect from the infobase.

Session number associated with the connection.

Network name of the computer establishing the connection.

Identifier of the application using this connection (see page ).

Name of the connected cluster server.

Number of the network port of the working process servicing this connection.

Time when this connection was established.

If the list of connections is open for an infobase, additional columns are displayed in the properties field, allowing you to quickly analyze database locks. A list of these properties is given in the next section.

5.2.12.2. Viewing connection properties

To view the connection properties, select a connection in the list of connections and execute the Properties context menu command, or the corresponding command in main menu of the utility.

The connection properties dialog box will be displayed.

The connection properties dialog box contains the following information (all connection properties are not editable):

User on whose behalf this connection is established.

Name of the computer that established the connection.

Name of the application (see page ) that established the connection to the infobase.

Indicates that an exclusive infobase lock has been established (see page ).

Indicates that database connection was established.

Indicates that an exclusive infobase mode was set.

Name of the server to which you are connected.

Network port of the server used for the connection.

Time when the connection was established.

Identifier of the connection.

ID of the database server process. It is displayed if the connection currently performs a database call.

Duration of database server access at the moment of opening the properties dialog box. It is displayed if the connection currently performs a database call.

Total duration of database calls since the beginning of the first call (in seconds).

Total duration of database calls in the last 5 minutes (in seconds).

Time since the start of the current database call (in seconds).

Amount of data sent over this client connection between the 1C:Enterprise server and the database server since the beginning of this session (in bytes).

Amount of data sent over this client connection between the 1C:Enterprise server and the database server in the last 5 minutes (in bytes).

ID of the process that locked the process.

User name (connection number); displayed if a process is waiting for a transaction lock to be released.

Total duration of server calls since the client connection was established (in seconds).

Duration of server calls by this connection in the last 5 minutes.

Current execution time of the latest incomplete server call.

Total number of server calls made by this connection since it was established.

Number of times this connection called the server in the last five minutes.

Amount of data transmitted and received since this connection was established (in bytes).

Amount of data transmitted and received in the last 5 minutes (in bytes).

Amount of RAM used for calls since this connection was established (in bytes).

Amount of RAM used for calls in the last 5 minutes (in bytes).

Amount of RAM used since the current call was initiated (in bytes).

Amount of data read from disk since the current call was initiated (in bytes).

Amount of data read from the disk by this session since the connection was established (in bytes).

Amount of data read from disk by this connection in the last 5 minutes (in bytes).

Amount of data written to disk by this connection since the session was opened (in bytes).

Amount of data written by this session to disk in the last 5 minutes (in bytes).

Amount of data written to disk since the beginning of the current call (in bytes).

The following properties are available only in the connection list of an infobase and are not displayed in the connection properties.

Current running time of the cluster service. Name of the service is specified in the Current service property.

Name of the service that is currently running. If the column is empty, it means that no cluster services are running currently.

Total running time of all cluster services in the last 5 minutes.

Total running time of all cluster services since the beginning of the session.

5.2.12.3. Terminating a connection

To terminate a connection, select the connection in the list of connections and execute the Delete context menu command, or the corresponding command in main menu of the utility.

If a large query to a Microsoft SQL Server database, IBM DB2, or Oracle Database is in progress, 1C:Enterprise server attempts to terminate the connection. The attempt succeeds if the connecting user has the appropriate permissions (for more information about the required database user rights, see the documentation for the database you are using). If the connection is successfully terminated, the user will receive a message: The session is terminated by the administrator. PostgreSQL database connections cannot be terminated. If you try to execute a delete command, no action will be performed.

If the client runs code on the 1C:Enterprise server, the 1C:Enterprise server will attempt to disconnect the client application from the server. To terminate a connection, you need the rights of a server cluster administrator (see page ) and infobase administrator. If the connection is successfully terminated, the user will receive a message: The session is terminated by the administrator.

A connection cannot be terminated while the 1C:Enterprise server performs a client call and only one 1C:Enterprise language code line is being executed (except for database calls). For example, a connection cannot be terminated when a long call to a COM object method or an HTTP call is made from code in 1C:Enterprise language.

5.2.13. Operations with list of locks

The list of locks can be displayed:

• For the entire cluster (all locks, or by connections)
• For an infobase (all locks, or by connections)

To display a list of locks for the entire cluster, select a central server in the central server tree, select a cluster registered on this server, and then select and expand the Locks branch.

If you then select the All branch, a list of all cluster locks will be displayed.

You can also expand the By sessions branch and select a session. The list of locks for the selected session will be displayed.

To display the list of locks for an infobase, select a central server in the central server tree, select a cluster, select an infobase, and then select and expand the Locks branch.

If you then select the All branch, a list of all locks for this infobase will be displayed.

You can also expand the By sessions branch and select a session. The list of locks for the selected session will be displayed.

If you choose to view the list of locks for a connection, the central server tree will contain a list of connections. Each connection is identified by the number and name of the user's computer.

The property field displays a list of locks containing the following information:

Contains a view of the lock type and their basic parameters. There are the following types of locks:

• Infobase locks:
  • DB. The blocking data base of 1C:Enterprise" Parameters:
    • Lock source (session or connection)
    • Infobase name
    • Shared or exclusive
    • If the infobase is shared (for more details {HL: dev: TI000000876}), this parameter contains information about the parameters of the locked area in the format of the / Z parameter of the client startup command line (for more details {HL: dev: TI000000892}). If a background job reacquires the exclusive lock from the parent session, this parameter contains the parent session's ID number in >>SessionNumber format, and the parameters of the locked area are listed in the next parameter.
  • IB. The infobase lock. Parameters:
    • Lock source (session or connection)
    • Infobase name
    • Shared or exclusive
  • Designer. Exclusive blocking of Designer. Parameters:
    • Infobase name
• DB object. Exclusive blocking of 1C:Enterprise object. Parameters:
  • Infobase name
• Cluster locks:
  • Manager of cluster. Activity of cluster manager process. Parameters:
    • Server name
    • Ports of the cluster manager process
  • Working process. Activity of 1C:Enterpise working process. Parameters:
    • Server name
    • Ports used by cluster working process
  • Connection. Connection to working process of cluster by TCP or a scheduled job. Parameters:
    • Name of the server context (may be identical to the infobase name)
    • Computer name and identifier of the application from which the connection is established
    • Infobase names and connection numbers if the connection is associated with any infobases

Name of the infobase the lock applies to. Empty if the lock is not applied to an infobase.

Number of infobase connection. May be empty if:

• Lock does not apply to an infobase
• Lock source is a session not assigned to any connection

Number of session that applied the lock. May be empty if:

• Lock does not apply to an infobase
• Lock source is a connection with no sessions assigned to it

Name of the client computer used to set the lock. Empty if the lock source is a server-side process.

Name of the client application that set the lock. Empty if the lock source is a server-side process.

Name of the server of the working process responsible for the lock. Empty if the lock source is a server-side process or a session not assigned to any connection.

Network port of the working process responsible for the lock. Empty if the lock source is a server-side process or a session not assigned to any connection.

Time when the lock was set.

5.2.14. Operations with list of security profiles

To display a list of infobases registered in a cluster, select a server in the central server tree, select a cluster registered on this server, and then select and expand the Security profiles branch.

The central server tree contains a list of cluster security profiles. Each security profile is identified by a name. The properties field displays a list of security profiles of the selected cluster, containing the name and description of each profile.

5.2.14.1. Adding profiles

To add a security profile to the cluster, select a central server in the central server tree, select a cluster registered on this server, select the Security profiles branch and execute context menu command New – Security profile or the corresponding command in main menu of the utility.

The security profile properties dialog box will be displayed.

You need to enter the following data in the dialog box fields:

Name of the security profile. The name must be unique within the cluster.

Arbitrary description of the security profile.

Indicates that the name of this profile can be specified as the value of the SafeMode parameter of the SetSafeMode() global context method, the Create() and Connect() methods of the external data processor manager, the Create() and Connect() methods of the external report manager, and also that it can be passed as the result of the SafeMode() global context function.

You can assign roles (separated by ;) to be used when privileged mode is switched on, whileto privileged mode check box is not checked. For more details on this parameter, see page .

Allows you to specify the roles (using the separator ";") that prevent the extension of the rights of the extensible configuration from the extension. For detailed description of this parameter {HL:dev:TI000001850:refer to the book}.

Contains a list of modules that can be extended with extensions. For more details on this parameter, see page .

Contains a list of modules that cannot be extended with extensions. For more details on this parameter, see page .

Indicates whether the application can access the file resources of the computer on which the 1C:Enterprise server is running. For more details on this parameter, see page .

Indicates whether the application can interact with the COM objects of the computer on which the 1C:Enterprise server is running. This option does not apply for servers running Linux. For more details on this parameter, see page .

Indicates whether the application can interact with add-ins on the 1C:Enterprise server. For more details on this parameter, see page .

Indicates whether the application can use external modules (external reports, data processors, and configuration extensions), as well as the Execute() operator and the Calculate() function. For more details on this parameter, see page .

Indicates whether the application can access OS applications on the 1C:Enterprise server. The list of applications depends on the operating system used to run the 1C:Enterprise server. For more details on this parameter, see page .

Indicates whether the application running on the 1C:Enterprise server can access Internet resources. For more details on this parameter, see page .

Defines the mode of verification of access rights (and applicable data access restrictions), when the current session is managed by a security profile. For more information about this check box, see page .

Indicates whether the application running on the 1C:Enterprise server can access Internet resources. For more details on this parameter, see page .

Indicates whether access permissions of the main configuration for any object of the extendable configuration can be extended. For detailed description of this parameter {HL:dev:TI000001850:refer to the book}.

Indicates whether all server configuration modules can be extended with any extension. For more details on this parameter, see page .

5.2.14.2. Viewing and editing profile settings

To view or edit the security profile settings, select a profile in the list of cluster security profiles and execute the Properties context menu command, or the corresponding command in main menu of the utility.

The security profile properties editing dialog box will be displayed.

Some profile parameters allow you to create exceptions from general restrictions. For example, you can deny access to all directories in the server file system, except for specific directories included in the list of exceptions.

In order to create an exception from any security profile restriction, select an item subordinate to the selected virtual directory and select the commandCreate – Name of the item to be created, for example, Create – Virtual Directory.

This will open a window that displays the Description property describing the item being created, and other parameters as described in the corresponding section of the general description of the security profile (see page ).

5.2.14.3. Deleting profiles

To delete a security profile, select the profile in the list of security profiles and execute the Delete context menu command, or the corresponding command in main menu of the utility.

5.2.15. Operations with resource management mechanism

5.2.15.1. Resource consumption counters

5.2.15.1.1. General information

Resource consumption counters are designed to collect and accumulate system performance information. Each counter has a name, a description, and a set of properties that describe the accumulated information.

The information accumulated by the counters can be displayed in the cluster console, and can be used by the resource consumption limiting mechanism. The resource consumption limiting mechanism uses the data from the counters as a basis for making decisions to restrict user actions.

The counter accumulates information for a single server call or for a specified time period. The counter operation mode is set using the Collection duration property:

• Server call. The counter accumulates all data from the current server call.
• Other value. The counter accumulates data for the time period specified in the property Collection duration time frame. A sliding window of the specified size is used to accumulate data.

The counter accumulates the following information:

• Time spent on the following actions:
  • Server calls. Time from the start to the end of the server call, in milliseconds. Based on the Call time value in the session properties.
  • CPU time. Processor time used for a server call, in milliseconds. Based on the CPU time value in the session properties.
  • DBMS call time. Time used for a DBMS call, in milliseconds. Based on the Database call time value in the session properties.
  • Service call time. Time used for cluster service operations, in milliseconds. Based on the Service call time value in the session properties.
• Amount of data processed during the measurement:
  • Memory.The amount of RAM currently used by the session, in bytes. This indicator always shows the current value. Based on the Memory (total) value in the session properties.
  • Read. Data volume read from disk, in bytes. Based on the Read value in the session properties.
  • Write.The amount of data written to disk, in bytes. Based on the Write value in the session properties.
  • DBMS data amount of data. Volume that was sent and received during DBMS operations, in bytes. Based on the Database data value in the session properties.
• Quantitative indicators:
  • Number of calls. The number of server calls. Based on the Number of calls value in the session properties.
  • Number of active sessions.The current number of active sessions.
  • Number of sessions.The total number of sessions per measurement period. It includes both active sessions and completed sessions.

Depending on the data collection duration, different session properties may be used to calculate the indicators:

• When calculating data per server call, a session property with the (current) suffix is used as the initial information. For example, to calculate the duration of a server call, the Call time (current) property is used.
• When calculating data per time period, the difference between the total value of the indicator at the end and at the beginning of the period is used. Thus, to calculate the Server calls value for the period, Call Time (total) value at the end of period is subtracted from Call Time (total) value at the beginning of period.

See also:

• Session properties (see page ).

5.2.15.1.2. Viewing and editing counter settings

To create a resource consumption counter, open the branchResource consumption countersand select Create – Resource consumption counter in the context menu. To edit the counter parameters, select a counter in the list and execute the Properties command in the context menu.

In both cases, a window with counter parameters will open. When editing an existing counter, the Name property is not editable.

The Name and Description properties are used to identify and describe the counter. The Collection duration property describes how long the counter will collect data. Each counter can be created in the context of a certain property, meaning that the number of counter instances created is equal to the number of unique values for this property. The Grouping property allows you to specify the counter property that will be used when creating a new instance:

• Users. The counter separately accumulates data for sessions running on behalf of different 1C:Enterprise users.
• Data separation. The counter separately accumulates data for sessions working with different data areas.

When changing the valueGroup, the counter is cleared (all fields are deleted). Next the counter starts accumulating new values in accordance with new group data. The change of other counter properties does not cause the counter clearing.

The Filter and Filter type fields allow you to specify how the sessions used by the counter will be filtered. In the Filter field, the filter values are indicated. You can set filters:

• By infobase (infobase parameter).
• By values of the separators that describe the data area (data-separation parameter). Values of the separators that describe the data area are set in the same way as /Z client startup command line parameter ({HL: dev: TI000000892: for detailed description}).
• By user name (user parameter).
• By ID of the application using the session (appID parameter). Value of this parameter is equal to the value of the InfobaseConnectionApplicationName property.
• By security profile (parametersafe-mode-profile-name). For the selection based on by default security profile leave the fields titles blank, for example, safe-mode-profile-name=;.
• By means of secure mode installation (parametersafe-mode). Possible values are on (safe mode enabled) and off (safe mode disabled).

The parameter value can be compared for equality (operator =) or for inequality (operator <>). Some filter conditions can be combined "by AND". "|" operator is used to group conditions "by OR". For example, see below:

infobase=IB; user<>Admin; user<>Руководитель; safe-mode-profile-name=profile | infobase<>IB; safe-mode=on

which will be interpreted as follows:

• This filter has the following two conditions:
  • First condition: infobase is equal to IB AND user is not equal to Admin AND user is not equal to Manager ANDsecurity profile is equal to profile.
  • Second condition: infobase is not equal to IB AND safe mode enabled.
• The first and second conditions are combined "by OR".

Use the Filter type property to specify the filter mode in general: equality or inequality.

5.2.15.1.3. Deletion of one or all items of counter

You can delete both counter and specific detail of selected counter. Both operations are performed in a similar manner: select an item that you need to delete, right-click it, and then select Delete.

For deleting counter in whole be sure to select required counter in the cluster units tree or in the counters list (having selected the point Resources consumption counters in units tree).

To select a specific item of a counter, first, select a counter, and then select an item from the list of this counter items.

5.2.15.2. Resource consumption limits

5.2.15.2.1. General information

Different client applications create different load on the server cluster. This load may adversely affect the overall performance of the cluster. For example, if a user decides to get all records for all goods for the entire lifetime of the infobase, such a report most likely will completely paralyze the entire system for a long period of time. In addition, such a report may cause a crash due to the exhaustion of available RAM or other similar reasons.

In order to detect such actions, you can create resource consumption counters in server cluster. You can also automatically restrict operations performed by the users and data areas (depending on the counter grouping) that exceed the resource consumption threshold. For this purpose, a resource consumption limiting mechanism is used. The mechanism works in conjunction with resource consumption counters.

Using the restriction mechanism, you can choose what to do with a session that exceeded a specified threshold for one or several counter parameters. The following options are available:

• End session. Interrupt the server call and terminate the session.
• Interrupt server call. Interrupt the server call but do not terminate the session.
• Decrease thread priority. Decrease the priority of a thread that is performing the current server call.
• None. Record the threshold violation in the technological log, but do not restrict execution of the server call.

Regardless of the selected option, a record is added to the technological log.

The restriction mechanism operates as follows:

• One or more counters with the desired characteristics are created.
• For each counter, you can create a rule that specifies the threshold values for any counter parameters; once the threshold is exceeded, the restrictive action is performed. The restrictive action is only performed when all thresholds are exceeded at the same time. However, only the first threshold violation is recorded in the technology log.
• The counter and rules take effect.

Please keep in mind that for counters set up to analyze indicators for a period of time, executing restrictions of End session and Interrupt server call types will prohibit any new server calls until the counter indicators fall below their thresholds.

5.2.15.2.2. Viewing and editing restriction settings

To create a resource consumption counter, open the branch Resources consumption counters and click Create – Resources consumption limitation. In order to edit the restriction parameters, select a restriction in the list and execute the Properties command in the context menu.

In both cases, a window with restriction options will open. When editing an existing restriction, the Name property is not editable.

The Name and Description properties are used to identify and describe each resource consumption restriction. The Resource consumption counter property contains the name of the counter on the basis of which this restriction will work. This property is mandatory. Using the Action when exceeded property sets the action that will be performed if the current counter value exceeds the thresholds specified in this window.

The Threshold value... groups are used to specify the threshold values for triggering the actions specified in the Action on exceeding property. The values are described with the parameters of the resource consumption counter.

Text in the Error message property will be displayed to the user if the server call or session is terminated.

See also:

• Resource consumption counters (see page).

5.2.15.2.3. Deleting restrictions

To delete a resource consumption restriction, select the restriction in the list and execute the Delete context menu command, or the corresponding command in main menu of the utility.

5.3. Server cluster administration software

5.3.1. Using 1C:Enterprise language to access server clusters

5.3.1.1. Via COMconnection

The 1C:Enterprise server cluster administration software interface is described in the syntax assistant in Integration and administration means – COM connections manager – Server cluster administration.

The usage of such mechanism is possible in case if 1C:Enterprise application from which the cluster administration is performed:

• Works under Windows OS control.
• Has the same number of version as the administered server cluster.

Two objects are used for server cluster administration: ConnectServerAgent and ConnectWorkingProcess.

To get ConnectServerAgent, use the ConnectAgent() method of the COM connector object:

COMConnector = New COMObject("V83.COMConnector");
ConnectServerAgent = COMConnector.ConnectAgent ("TestSrv");

Server agent connection is used to:

• Authenticate, add, delete, get a list of central server administrators and cluster administrators
• Create, delete, get a list of clusters
• Create, delete, get a list of servers
• Create, delete, get a list of cluster working processes
• Get a list of cluster services
• Get a list of infobase sessions
• Get a list of cluster connections
• Get a list of infobase connections
• Get a list of infobases registered in the cluster
• Get a list of cluster locks
• Get other information

To get ConnectWorkingProcess, use the ConnectWorkingProcess() method of the COM connector object:

COMConnector = New COMObject("V83.COMConnector");
ConnectWorkingProcess = COMConnect.ConnectWorkingProcess ("TestSrv: 1562");

Working process connection is used to:

• Authenticate infobase users
• Create, delete, get a list of infobases registered in the cluster
• Get a list of infobase connections
• Disconnect an infobase
• Connect to an infobase (COM connection)
• Get other information

5.3.1.2. With the help of server cluster administration

Software interface of 1C:Enterprise server cluster administration with the help of server administration is described in syntax assistant in Integration and administration means – 1C:Enterprise server administration.

1C:Enterprise system provides the possibility of administration of random amount of clusters of 1C:Enterprise system server cluster with the help of 1C:Enterprise server cluster administration (ras).

As it can be seen from the picture the overall administration scheme looks like that:

• Client application is connected to any administration server.
• With the help of selected administration server the connection to required server clusters is performed.

One can say that object model designed for the work via administration server is the analogue of command line utility (rac), designed for the work with the usage of administration server.

Taking into account the aforementioned information, the administration is possible on the following conditions:

• The 1C:Enterprise application where the administration is performed can operate in the following operating systems: Linux, macOS, Windows.
• It does not require the correspondence of 1C:Enterprise application version, from which the administration is performed and administration server versions and server cluster (taking into account administration servers).
• Control can be done both from client application and server application side.
• 1C:Enterprise client application, from which the administration functions are performed can work in file option of infobase and is in no way connected to the administered server cluster by data.

In general case the scheme of operation looks the following:

• Connection to the required administration server.
• Authentication of administrator of cluster central server (in case of any).
• Users gets the list of clusters available at selected central server.
• User performs authentication of specific cluster administrator (in case of any).
• The following administration actions are being performed.

In the simplest case the example of software interface usage looks as follows:

Agent = New Serveradministration("localhost", 1545);
Agent.Authenticate();
Clusters = Agent.GetClusters();
For each cluster From clusters Do
Cluster.Authenticate();
Infobases = Cluster.GetInformationalBases();
For each InfoBase From InfoBase Do
Inform(InfoBase.Name + ", " + InfoBase.Description);
EndDo;
EndDo;

See also:

• Server of administration of server cluster (see page ).

5.3.2. External session management

5.3.2.1. General information

For external session management, you need to implement a web service that will provide a specific set of methods and control logic. This web service can be implemented through 1C:Enterprise functionality or third-party tools.

This chapter contains a description of the web service and an example of implementation using 1C:Enterprise functionality.

5.3.2.2. Web service description

The web service name is not specified. The default timeout for method execution is 5 seconds. To change the default timeout value, use the tout parameter when calling the web service.

5.3.2.2.1. Version 1

onStartSession

Description:

The method is called by the server cluster on session start (except for background job sessions and WS connection sessions). The method determines whether a new session with the specified parameters can be created. The return code is passed to the server cluster.

Parameters:

Number. Sequence number of the call. Each time the cluster calls the web service, the sequence number of the call is incremented by 1. Based on the CallNo value, the web service may request synchronization of session data.

The call number is unique per infobase.

String. Server cluster ID. Contains a string presentation of the unique identifier (UUID).

String. Name of the server cluster where the infobase is located.

String. Name of the infobase used by the session.

String. Session ID. Contains a string presentation of the unique identifier (UUID).

String. User ID. Contains a string presentation of the unique identifier (UUID).

String. User name.

String. Name of the application attempting to access the infobase. For detailed information on the values of this parameter, see description of the global context function ApplicationPresentation().

String. Contains the initial separator values for the session being created. The string is passed in the format specified for the /Z startup command line parameter.

String. The message language code for the session being created.

String. It contains a description of the reason for prohibiting session creation in a human-readable format. Filled in when the web service method returns 1.

Returns:

Number. Return values:

• 0. Session can be created.
• 1. Session cannot be created. The user that attempts to create the session is presented with an error message containing the exception text from the ErrorDescription parameter, or text string Starting session is prohibited by the external session management service if the value of the ErrorDescription parameter is empty.
• 2.  Synchronization is required. In this case, the server cluster calls the synchronize method with a list of sessions not including this session, and then calls the onStartSession method again. External session management calls are not synchronized; the external session management service determines whether synchronization of the session list is required. Sequence number of the call (CallNo parameter) can be used for this purpose. Skipping some call numbers after timeout may be considered a condition requiring synchronization.

onFinishSession

Description:

The method is called at the end of the session.

Parameters:

Number. Sequence number of the call.

The call number is unique per infobase.

String. Server cluster ID. Contains a string presentation of the unique identifier (UUID).

String. Session ID. Contains a string presentation of the unique identifier (UUID).

Returns:

None.

synchronize

Description:

It is intended to synchronize data on created sessions between a server cluster and a web service that implements an external session management mechanism. The server cluster calls this method if onStartSession() returns 2.

Parameters:

Number. Sequence number of the call.

The call number is unique per infobase.

String. Server cluster ID. Contains a string presentation of the unique identifier (UUID).

String. Name of the server cluster where the infobase is located.

String. Name of the infobase for which you are synchronizing information about the number of sessions.

Type: Sessions. The object contains data about all sessions created for a specific infobase using the external session management mechanism. The object contains the Content property, which is a collection of Session objects that describe a single session each. The collection may be empty.  For a description of the Sessions object, see page .

Returns:

None.

5.3.2.2.2. Version 2

Besides the functionality provided by version 1, version 2 includes two methods that allow you to take actions when a session enters or leaves Hibernating state (see page ).

onHibernateSession

Description:

The method is called by the server cluster when a session hibernates. When a session enters hibernating state, its license is revoked and becomes available (see page ), which must be reflected in the web service data. At the beginning of the session that enters Hibernating state, the server cluster called the onStartSession method of this web service.

Parameters:

Number. Sequence number of the call.

The call number is unique per infobase.

String. Server cluster ID. Contains a string presentation of the unique identifier (UUID).

String. Session ID. Contains a string presentation of the unique identifier (UUID).

Returns:

None.

onWakeupSession

Description:

Parameters:

Number. Sequence number of the call. Each time the cluster calls the web service, the sequence number of the call is incremented by 1. Based on the CallNo value, the web service may request synchronization of session data.

The call number is unique per infobase.

String. Server cluster ID. Contains a string presentation of the unique identifier (UUID).

String. Session ID. Contains a string presentation of the unique identifier (UUID).

String. It contains a description of the reason for prohibiting session creation in a human-readable format. Filled in when the web service method returns 1.

Returns:

Number. Return values:

• 0. Session can be transferred to working mode.
• 1.  Session cannot be transferred to working mode. The user whose session attempts to wake up is presented with an error message containing the exception text from the ErrorDescription parameter, or text string Session wakeup is prohibited by the external session management service if the value of the ErrorDescription parameter is empty.
• 2.  Synchronization is required. In this case, the server cluster calls the synchronize method with a list of sessions not including this session, and then calls the onWakeupSession method again. External session management calls are not synchronized; the external session management service determines whether synchronization of the session list is required. Sequence number of the call (CallNo parameter) can be used for this purpose. Skipping some call numbers after timeout may be considered a condition requiring synchronization.

5.3.2.2.3. Version 3

In version 3, the onStartSession() method got new parameters. The SessionNumber and ClientIPAddress parameters were added.

onStartSession

Description:

The method is called by the server cluster on session start (except for background job sessions and WS connection sessions). The method determines whether a new session with the specified parameters can be created. The return code is passed to the server cluster.

Parameters:

Number. Sequence number of the call. Each time the cluster calls the web service, the sequence number of the call is incremented by 1. Based on the CallNo value, the web service may request synchronization of session data.

The call number is unique per infobase.

String. Server cluster ID. Contains a string presentation of the unique identifier (UUID).

String. Name of the server cluster where the infobase is located.

String. Name of the infobase used by the session.

String. Session ID. Contains a string presentation of the unique identifier (UUID).

Number. Session number. Contains the number of the session within the infobase.

String. User ID. Contains a string presentation of the unique identifier (UUID).

String. User name.

String. IP address of the client application attempting to start a session.

String. Name of the application attempting to access the infobase. For detailed information on the values of this parameter, see description of the global context function ApplicationPresentation().

String. Contains the initial separator values for the session being created. The string is passed in the format specified for the /Z startup command line parameter.

String. The message language code for the session being created.

String. It contains a description of the reason for prohibiting session wakeup in a human-readable format. Filled in when the web service method returns 1.

Returns:

Number. Return values:

• 0. Session can be created.
• 1. Session cannot be created. The user that attempts to create the session is presented with an error message containing the exception text from the ErrorDescription parameter, or text string Starting session is prohibited by the external session management service if the value of the ErrorDescription parameter is empty.
• 2. Synchronization is required. In this case, the server cluster calls the synchronize method with a list of sessions not including this session, and then calls the onStartSession method again. External session management calls are not synchronized; the external session management service determines whether synchronization of the session list is required. Sequence number of the call (CallNo parameter) can be used for this purpose. Skipping some call numbers after timeout may be considered a condition requiring synchronization.

5.3.2.2.4. Sessions type description

Description of the Sessions object (in XSD format):

<xs:schema xmlns:ns1="http://v8.1c.ru/8.1/data/core" xmlns:tns="http://v8.1c.ru/SessionManagement" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://v8.1c.ru/SessionManagement" attributeFormDefault="unqualified" elementFormDefault="qualified">
<xs:import namespace="http://v8.1c.ru/8.1/data/core"/>
<xs:complexType name="Session">
<xs:sequence>
<xs:element name="SessionID" type="xs:string"/>
<xs:element name="UserID" type="xs:string"/>
<xs:element name="UserName" type="xs:string"/>
<xs:element name="AppID" type="xs:string"/>
<xs:element name="Zone" type="xs:string"/>
<xs:element name="LanguageCode" type="xs:string"/>
<xs:element name="Hibernate" type="xs:boolean"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Sessions">
<xs:sequence>
<xs:element name="Content" type="tns:Session" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:schema>

5.3.2.3. Implementation example

Let us review an example of an external session management web service.

This example will implement the following algorithm:

• The administrator can restrict the number of concurrent sessions for an infobase. To do this, the infobase name and the maximum number of concurrent sessions are specified.
• If the infobase is not in the list the amount of sessions with it is limited.
• You can see the list of sessions for each infobase in the list.

A simple configuration including one catalog and one web service is used as a web service. The catalog contains a list of infobases, the limit on the number of sessions, and the sequence number of the last call. The web service performs session registration activities.

The catalog is organized as follows:

• Name: AvailableSessions.
• Code length: 0.
• Name length: 50.
• Attributes:
  • Name: Quantity, Number (2), non-negative.
  • Name: LastCallNumber, Number (10), non-negative.
• Tabular section:
  • Name: CurrentSessions.
  • Attributes:
    • Name: SessionID, String (40) of variable length.
    • Name: UserID, String of unlimited length.
    • Name: UserName, String of unlimited length.
    • Name: AppID, String of unlimited length.
    • Name: Zone, String of unlimited length.
    • Name: LanguageCode, String of unlimited length.
    • Name: Hibernate, Boolean.

This catalog will store the infobase name (standard attribute Name), the maximum number of concurrent sessions for this infobase (attribute Quantity), and the sequence number of the last web service call (attribute LastCallNumber). LastCallNumber is used to determine whether data synchronization between the 1C:Enterprise server cluster and the web service is required. The tabular section stores information on the sessions that the web service allowed to start. The session record is created in the onStartSession () method, and deleted in the onFinishSession() method. By comparing the maximum number of sessions allowed for this infobase and the number of remembered sessions, you can determine whether a session can be created. If the second version of the interface is used, session hibernations and wakeups are also recorded. When you hibernate a session, the session record is not deleted but is marked accordingly.

You will also need to create a web service described above (see page ) and add the following code to the web service module. The web service must contain a link to the XDTO package http://v8.1c.ru/SessionManagement describing the Sessions object. For description of this package, see page .

Text of the web service operations:

Function onStartSession(CallNo, ClusterID, ClusterName, InfoBaseName, SessionID, UserID, UserName, AppID, Zone, LanguageCode, ErrorDescription)
ErrorDescription = "";
Result = Catalogs.AvailableSessions.FindByName(InfoBaseName, True);
If Result.Empty() Then
// If infobase with this name is not listed in the catalog, the infobase has no restrictions
Return 0;
EndIf;        
Object = Result.GetObject();
Object.LastCallNumber = Object.LastCallNumber + 1;
// If the call sequence is broken, synchronization will be required
If Object.LastCallNumber <> CallNo Then
Return 2;
EndIf;        
Sessions = Result.CurrentSessions.FindRows(New Structure("Hibernate", False));
If Sessions.Quantity()+1 > Result.Quantity Then
// Maximum number of sessions reached, cannot create any more sessions
Object.Write();
ErrorDescription = "Exceeded the maximum number of sessions allowed by the external session management service";
Return 1;
Else
// Can create sessions
String = Object.CurrentSessions.Add();
String.SessionID = SessionID;
String.UserID = UserID;
String.UserName = UserName;
String.AppID = AppID;
String.Zone = Zone;
String.LanguageCode = LanguageCode;
String.Hibernate = False;
Object.Write();
Return 0;
EndIf;        
EndFunction
 
Function onFinishSession(CallNo, ClusterID, SessionID)
Query = New Query;
Query.Text ="SELECT
|AvailableSessions.Ref
|FROM
|Catalog.AvailableSessions AS AvailableSessions
| WHERE
|AvailableSessions.CurrentSessions.SessionID = &SessionID";
 
Query.SetParameter("SessionID", SessionID);
QueryResult = Query.Execute();
SelectionDetailedRecords = QueryResult.Select();
While SelectionDetailedRecords.Next() Do
// Deleting the session from the service database
Object = SelectionDetailedRecords.Ref.GetObject();
Result = Object.CurrentSessions.FindRows(New Structure("SessionID", SessionID));
For Each Row In Result Do
Object.CurrentSessions.Delete(Object.CurrentSessions.Index(Row));
EndDo;
Object.LastCallNumber = CallNo;
Object.Write();
EndDo;
Return Undefined;
EndFunction
 
Function Synchronize(CallNo, ClusterID, ClusterName, InfoBaseName, CurrentSessions)
Result = Catalogs.AvailableSessions.FindByName(InfoBaseName, True);
If Result.Empty() Then
// If infobase with this name is not listed in the catalog, the infobase has no restrictions
Return Undefined;
EndIf;        
// Can create sessions
Object = Result.GetObject();
Object.CurrentSessions.Clear();
For Each Session In CurrentSessions.Content Do
String = Object.CurrentSessions.Add();
String.SessionID = Session.SessionID;
String.UserID = Session.UserID;
String.UserName = Session.UserName;
String.AppID = Session.AppID;
String.Zone = Session.Zone;
String.LanguageCode = Session.LanguageCode;
EndDo;
Object.LastCallNumber = CallNo;
Object.Write();
Return Undefined;
EndFunction
 
Function onHibernateSession(CallNo, ClusterID, SessionID)
Query = New Query;
Query.Text ="SELECT
|AvailableSessions.Ref
|FROM
|Catalog.AvailableSessions AS AvailableSessions
| WHERE
|AvailableSessions.CurrentSessions.SessionID = &SessionID";
 
Query.SetParameter("SessionID", SessionID);
QueryResult = Query.Execute();
SelectionDetailedRecords = QueryResult.Select();
While SelectionDetailedRecords.Next() Do
// Marking the session as hibernating in the service database
Object = SelectionDetailedRecords.Ref.GetObject();
Result = Object.CurrentSessions.FindRows(New Structure("SessionID", SessionID));
For Each Row In Result Do
Row.Hibernate = True;
EndDo;
Object.LastCallNumber = CallNo;
Object.Write();
EndDo;
Return Undefined;
EndFunction
 
Function onWakeupSession(CallNo, ClusterID, SessionID, ErrorDescription)
Query = New Query;
Query.Text ="SELECT
|AvailableSessions.Ref
|FROM
|Catalog.AvailableSessions AS AvailableSessions
| WHERE
|AvailableSessions.CurrentSessions.SessionID = &SessionID";
 
Query.SetParameter("SessionID", SessionID);
QueryResult = Query.Execute();
If QueryResult.Empty () Then
ErrorDescription = "Cannot wake up the session. Start of the session # "+ SessionID +" was not registered";
Return 1;
EndIf;        
SelectionDetailedRecords = QueryResult.Select();
While SelectionDetailedRecords.Next() Do
// If the call sequence is broken, synchronization will be required
If SelectionDetailedRecords.Ref.LastCallNumber + 1 <> CallNo Then
Return 2;
EndIf;        
// Marking the session as hibernating in the service database
Object = SelectionDetailedRecords.Ref.GetObject();
// Getting the number of non-hibernating sessions
NotHibernating = Object.CurrentSessions.FindRows(New Structure("Hibernate", Truth)). Number ();
// Starting wakeup
Result = Object.CurrentSessions.FindRows(New Structure("SessionID", SessionID));
For Each Row In Result Do
If NotHybernating > Object.Quantity Then
ErrorDescription = "Cannot wake up the session. Exceeded the maximum number of sessions allowed by the external session management service";
Return 1;
EndIf;        
NotHibernating = NotHibernating + 1;
String.Hibernate = False;
EndDo;
Object.LastCallNumber = CallNo;
Object.Write();
EndDo;
Return 0;
EndFunction

After creating the configuration, publish the web service on the web server. For details on Web service publication {HL:adm:TI000000222:refer to the book}.

Let us assume that the publication is called sc, the web service is called SessionControl, the namespace of this web service is called http://v8.1c.ru/SessionManagement, and the XDTO package must include the http://v8.1c.ru/SessionManagement package. The publication is performed on the localhost computer.

After publishing and verifying the web service publication, you need to create a string pointing the server cluster to the created web service. For description of the string, see page .

The string will look like:

wsdl=http://localhost/sc/ws/SessionControl?wsdl;ns=http://v8.1c.ru/SessionManagement;srvc=SessionControl;port=SessionControlSoap;

You also need to create a client/server infobase whose sessions will be managed by the web service. Let us call this infobase TestDB. Any infobase (including empty) can be used. After creating the infobase, use the cluster console to specify the string generated above (wsdl = ...) as the value of the External session management property, and select the check box for the Mandatory use of external control property.

Then, run the session management infobase in 1C:Enterprise mode, create an item in the AvailableSessions catalog, and set the standard requisite Name to TestDB and Quantity to 2 for this catalog item. This sets a maximum limit of 2 concurrent sessions for TestDB.

Now, only two users can access TestDB at the same time.

5.3.3. Server cluster administration server

5.3.3.1. General information

To administer a server cluster, you can use a cluster administration server. It includes the server (ras) and the command line utility (rac) used for server cluster management.

The server cluster and the administration server (ras) must have the same version. When using the command line utility (rac), the following limitations should be considered:

• The command line utility (rac) version 8.3.1 or 8.3.2 can only be used with the administration server (ras) version 8.3.1 or 8.3.2.
• The command line utility (rac) version 8.3.3 or 8.3.4 can only be used with the administration server (ras) version 8.3.3 or 8.3.4.
• The command line utility (rac) version 8.3.5 through 8.3.8 can only be used with the administration server (ras) version 8.3.5 through 8.3.8.
• The command line utility (rac) version 8.3.9 and later can only be used with the administration server (ras) version 8.3.9 and later. When using the command line utility of earlier version than the version of the administration server, only the functionality implemented in the platform corresponding to the command line utility version is available. If you need a specific feature, make sure to use the command line utility of version in which the feature is implemented (subject to the above limitations).

Both the administration server and the command line utility can work in any supported OS. Multiple administration servers can be connected to the server cluster at the same time. An administration server can be connected to one server agent only.

An administration server (ras) can run as an application, as a Windows service, or as a Linux daemon. The general procedure is as follows:

• The administration server is started (as an application, or as a service/daemon).
• The command line utility connects to the administration server to perform the necessary actions.
• For the duration of the operations, the administration server connects to the server cluster and, after performing the operationsdisconnects from the cluster. Therefore, there is no need to shut down the administration server during scheduled operations on a cluster of servers associated with cluster shutdown or restart. Changing the server cluster version is an exception. In this case, you need to set administration server version identical to the server cluster version.

The administration server and the administration utility are installed together with the 1C:Enterprise server (see page ).

For interaction between the administration server and the administration utility, network port 1545 is used. This can be redefined using the --port parameter of the administration server startup command line (ras).

The administration utility allows you to perform all operations required to administer a cluster of servers. However, the following features are not supported:

• OS authentication for server cluster administrators, working server administrators, and infobase administrators.

The administration utility (rac) gets all necessary parameters from the command line and sends information to the standard output stream (stdout). If successful, the return code of the utility is equal to 0. Otherwise, the return code is non-zero and an error message is sent to the standard error stream (stderr).

The result of the utility operation is a description of one or several data objects (for example, a list of infobase servers registered in a cluster) in the form of a table:

<Parameter name> : <Parameter value>

Where each parameter is displayed on a new line and contains an empty line indicating the end of the object description. <Parameter name> matches the names of the utility command line parameters. If the parameter cannot be set from the command line (or it is read-only), then the parameter name is converted from the property name of the corresponding COM object. The conversion is performed in the following way: all words and abbreviations in the name of a property are converted to lowercase and separated by "-". For example, theMemoryExcessTime working process property will be converted to memory-excess-time.

Cluster item creation commands (with the exception of administrators), send the ID of the created item to the stream in the above format when successful.

Strings that allow arbitrary characters are put in double quotes, with double quotes in the strings themselves being duplicated.

Dates are in XML format (https://www.w3.org/TR/2012/REC-xmlschema11-2-20120405/#dateTime).

For more information about parameters of the administration server (ras) or the administration utility (rac), run the corresponding executable file with the help command-line parameter:

ras help
rac help

The ITS disk also comes with a package of Java archives, which allows you to interact with the administration server from a Java-language program without the help of a console administration utility (https://1c-dn.com/library/1c_enterprise_8_administrative_service_api/).

5.3.3.2. Starting the administration server

5.3.3.2.1. On Windows

In application mode

To start the administration server in application mode, use the following command line:

ras cluster --port=<port><host[:port]>

The command can have the following keys:

Starts the administration server in server cluster administration mode.

Specifies the network port on which the administration utility will communicate with the administration server. The default value is 1545.

Specifies the address of the service agent of the server cluster administrated by the administration server.

If the address of the cluster agent is not explicitly specified, the default value is localhost:1540.

In SaaS

To start the administration server in SaaS, you need to register the administration server as a service. This operation can be performed using the sc utility.  Administrator rights are required to complete the registration.

Let us review an example of the batch file that performs the registration of the server service.

Register-ras.bat:

@echo off
rem %1 – 1C:Enterprise full version
 
set SrvUserName=<user name>
set SrvUserPwd=<user password>
set CtrlPort=1540
set AgentName=localhost
set RASPort=1545
 
set SrvcName="1C:Enterprise 8.3 Remote Server"
set BinPath="\"C:\Program Files\1cv8\%1\bin\ras.exe\" cluster --service --port=%RASPort% %AgentName%:%CtrlPort%"
set Description="1C:Enterprise 8.3 Administration Server"
 
sc stop %SrvcName%
sc delete %SrvcName%
sc create %SrvcName% binPath= %BinPath% start= auto obj= %SrvUserName% password= %SrvUserPwd% displayname= %Desctiption%

Before using this batch file, you need to edit it with user name and password of the user on whose behalf the administration server service will run (set SrvUserName = and set SrvUserPwd = lines). This batch file performs registration of the administration server with the following parameters:

• Service name: 1C:Enterprise 8.3 Remote Server
• Display name: 1C:Enterprise 8.3 administration server
• Administration server port: 1545
• Address of the 1C:Enterprise server cluster: localhost:1540
• Service start mode: Automatic

Example:

register-ras 8.3.3.100

5.3.3.2.2. On Linux

In application mode

To start the administration server in application mode, use the following command line:

./ras cluster --port=<port><host[:port]>

The command can have the following keys:

Starts the administration server in server cluster administration mode.

Specifies the network port on which the administration utility will communicate with the administration server. The default value is 1545.

Specifies the address of the service agent of the server cluster administrated by the administration server.

If the address of the cluster agent is not explicitly specified, the default value is localhost:1540.

In daemon mode

To start the administration server (ras) in daemon mode, you need to start the administration server using a special command-line key:

./ras cluster --daemon --port=<port><host[:port]>

The command line keys for starting the administration server (ras) on Windows and Linux are identical.

5.4. Database administration

In 1C:Enterprise applications, you can perform actions that do not affect the operability of the application or presentation of the data structures used by 1C:Enterprise (including infobase restructuring and saving the changes made after the restructuring):

• Using encryption at the database level
  • Available for database:
    • Microsoft SQL Server 2008 or later
    • Oracle Database
  • Mechanism documentation:
    • Microsoft SQL Server 2008: http://msdn.Microsoft.com/ru-ru/library/bb510663(v=sql.100).aspx.
    • Microsoft SQL Server 2008 R2: http://msdn.Microsoft.com/ru-ru/library/bb510663(v=sql.105).aspx.
    • Microsoft SQL Server 2012: http://msdn.Microsoft.com/ru-ru/library/bb510663(v=sql.110).aspx.
    • Microsoft SQL Server 2014: http://msdn.Microsoft.com/ru-ru/library/bb510663(v=sql.120).aspx.
    • Microsoft SQL Server 2016: http://msdn.microsoft.com/ru-ru/library/bb510663(v=sql.130).aspx.
    • Microsoft SQL Server 2017: https://docs.microsoft.com/ru-ru/sql/relational-databases/security/encryption/sql-server-encryption?view=sql-server-2017.
    • Microsoft SQL Server 2019: https://docs.microsoft.com/ru-ru/sql/relational-databases/security/encryption/sql-server-encryption?view=sql-server-ver15.
    • Oracle Database 10g R2: http://docs.oracle.com/cd/B19306_01/network.102/b14268/asotrans.htm.
    • Oracle Database 11g R1: http://docs.oracle.com/cd/B28359_01/network.111/b28530/asotrans.htm.
    • Oracle Database 11g R2: http://docs.oracle.com/cd/E25178_01/network.1111/e10746/asotrans.htm.
    • Oracle Database 12с R1: https://docs.oracle.com/database/121/ASOAG/toc.htm.
    • Oracle Database 12с R2: https://docs.oracle.com/en/database/oracle/oracle-database/12.2/asoag/toc.htm.
    • Oracle Database 18с: https://docs.oracle.com/en/database/oracle/oracle-database/18/asoag/toc.htm.
    • Oracle Database 19с: https://docs.oracle.com/en/database/oracle/oracle-database/19/asoag/toc.htm.
• Using server clusters groups of computers united by high-speed communication channels and representing a single hardware resource from the user's point of view.
  • Available for database:
    • IBM Db2;
    • Microsoft SQL Server
    • Oracle Database
    • PostgreSQL
  • Mechanism documentation:
    • IBM Db2 v9.1: http://publib.boulder.ibm.com/infocenter/db2luw/v9/topic/com.ibm.db2.udb.admin.doc/doc/c0006354.htm;
    • IBM Db2 v9.5: http://publib.boulder.ibm.com/infocenter/db2luw/v9r5/topic/com.ibm.db2.luw.admin.ha.doc/doc/t0051382.html;
    • IBM Db2 v9.7: http://publib.boulder.ibm.com/infocenter/db2luw/v9r7/topic/com.ibm.db2.luw.admin.ha.doc/doc/t0051382.html;
    • IBM Db2 v10.1: http://publib.boulder.ibm.com/infocenter/db2luw/v10r1/topic/com.ibm.db2.luw.admin.ha.doc/doc/t0051382.html;
    • IBM Db2 v11.1: http://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/com.ibm.db2.luw.admin.ha.doc/doc/t0051382.html;
    • Microsoft SQL Server 2000: http://msdn.Microsoft.com/ru-ru/library/aa196694(v=sql.80).aspx;
    • Microsoft SQL Server 2005: http://msdn.Microsoft.com/ru-ru/library/ms189134(v=sql.90).aspx;
    • Microsoft SQL Server 2008: http://msdn.Microsoft.com/ru-ru/library/ms189134(v=sql.100).aspx;
    • Microsoft SQL Server 2008 R2: http://msdn.Microsoft.com/ru-ru/library/ms189134(v=sql.105).aspx;
    • Microsoft SQL Server 2012: http://msdn.Microsoft.com/ru-ru/library/ms189134(v=sql.110).aspx;
    • Microsoft SQL Server 2014: http://msdn.Microsoft.com/ru-ru/library/ms189134(v=sql.120).aspx;
    • Microsoft SQL Server 2016: http://msdn.microsoft.com/ru-ru/library/ms189134(v=sql.130).aspx;
    • Microsoft SQL Server 2017: https://docs.microsoft.com/ru-ru/sql/sql-server/failover-clusters/windows/always-on-failover-cluster-instances-sql-server?view=sql-server-2017;
    • Microsoft SQL Server 2019: https://docs.microsoft.com/ru-ru/sql/sql-server/failover-clusters/windows/always-on-failover-cluster-instances-sql-server?view=sql-server-ver15;
    • Oracle Database 10g R2: http://docs.oracle.com/cd/B19306_01/server.102/b14210/hafeatures.htm#CJACEEIA (на английском языке);
    • Oracle Database 11g R1: http://docs.oracle.com/cd/B28359_01/server.111/b28281/architectures.htm;
    • Oracle Database 11g R2: http://docs.oracle.com/cd/E15586_01/server.1111/e17157/architectures.htm ;
    • Oracle Database 12с R1: http://docs.oracle.com/database/121/HAOVW/toc.htm.
    • Oracle Database 12с R2: https://docs.oracle.com/en/database/oracle/oracle-database/12.2/haovw/toc.htm.
    • Oracle Database 18с: https://docs.oracle.com/en/database/oracle/oracle-database/18/haovw/toc.htm.
    • Oracle Database 19с: https://docs.oracle.com/en/database/oracle/oracle-database/19/haovw/toc.htm.
    • PostgreSQL 8.2: http://www.postgresql.org/docs/8.2/interactive/high-availability.html;
    • PostgreSQL 8.3: http://www.postgresql.org/docs/8.3/interactive/high-availability.html;
    • PostgreSQL 8.4: http://www.postgresql.org/docs/8.4/interactive/high-availability.html;
    • PostgreSQL 9.0: http://www.postgresql.org/docs/9.0/interactive/high-availability.html;
    • PostgreSQL 9.1: http://www.postgresql.org/docs/9.1/interactive/high-availability.html;
    • PostgreSQL 9.2: http://www.postgresql.org/docs/9.2/interactive/high-availability.html.
    • PostgreSQL 9.3: http://www.postgresql.org/docs/9.3/interactive/high-availability.html.
    • PostgreSQL 9.4: https://www.postgresql.org/docs/9.4/high-availability.html.
    • PostgreSQL 9.6: https://www.postgresql.org/docs/9.6/high-availability.html.
    • PostgreSQL 10: https://www.postgresql.org/docs/10/high-availability.html.
    • PostgreSQL 11: https://www.postgresql.org/docs/11/high-availability.html.
    • PostgreSQL 12: https://www.postgresql.org/docs/12/high-availability.html.
    • Postgres Pro Standard 9.6: https://postgrespro.ru/docs/postgrespro/9.6/high-availability.html.
    • Postgres Pro Standard 10: https://postgrespro.ru/docs/postgrespro/10/high-availability.html.
    • Postgres Pro Standard 11: https://postgrespro.ru/docs/postgrespro/11/high-availability.html.
    • Postgres Pro Standard 12: https://postgrespro.ru/docs/postgrespro/12/high-availability.html.
    • Postgres Pro Enterprise 9.6: https://postgrespro.ru/docs/postgresproee/9.6/high-availability.html.
    • Postgres Pro Enterprise 10: https://postgrespro.ru/docs/postgresproee/10/high-availability.html.
    • Postgres Pro Enterprise 11: https://postgrespro.ru/docs/postgresproee/11/high-availability.html.
    • Postgres Pro Enterprise 12: https://postgrespro.ru/docs/postgresproee/12/high-availability.html
• Using data compression at database level
  • Available for database:
    • Oracle Database (only through compressed tablespace)
  • Mechanism documentation:
    • Oracle Database 11g R2: http://docs.oracle.com/cd/E11882_01/server.112/e25494/tables.htm#CJAGFBFG.
    • Oracle Database 12с R1: https://docs.oracle.com/database/121/ADMIN/tables.htm#ADMIN-GUID-34D15DD1-0925-4C9A-BE8A-3EE91671E526.
    • Oracle Database 12с R2: https://docs.oracle.com/en/database/oracle/oracle-database/12.2/admin/managing-tables.html#GUID-ED833867-4B7F-442E-A70C-9C19DAA8F445.
    • Oracle Database 18c: https://docs.oracle.com/en/database/oracle/oracle-database/18/admin/managing-tables.html#GUID-ED833867-4B7F-442E-A70C-9C19DAA8F445.
    • Oracle Database 19c: https://docs.oracle.com/en/database/oracle/oracle-database/19/admin/managing-tables.html#GUID-ED833867-4B7F-442E-A70C-9C19DAA8F445.
• Changing location of predefined tablespaces
  • Available for database:
    • IBM Db2;
    • Oracle Database
    • PostgreSQL
  • Predefined tablespaces:
    • IBM Db2:
      • for indexes  V81C_INDEXSPACE;
      • for data  V81C_LARGESPACE;
      • for LOB  V81C_LOBSPACE;
      • user temporary table space  V81C_USERTEMP;
      • system temporary table space  V81C_SYSTEMPBP.
    • Oracle Database:
      • for indexes V81C_INDEX;
      • for data V81C_DATA;
      • for LOB V81C_LOB;
      • temporary table space  V81C_TEMP.
    • PostgreSQL:
      • for indexes V81C_INDEX;
      • for data V81C_DATA;
      • temporary table space  free title set via configuration file postgresql.conf.
• Changing location of the database file
  • Available for database:
    • Microsoft SQL Server
• Changing location of transaction log
  • Available for database:
    • IBM Db2;
    • Microsoft SQL Server
    • Oracle Database
    • PostgreSQL
• Performing administrative tasks that do not alter database structures but ensure adequate performance
  • Tasks:
    • Integrity check
    • Reindexing
    • Defragmentation
    • Reorganization
    • Backup creation (see page )
    • Cleaning procedure cache
    • Collecting statistics data
  • Available for database:
    • IBM Db2;
    • Microsoft SQL Server
    • Oracle Database
    • PostgreSQL

<< Prev   Next >>