Tell commands - D2000 Server

AUDIT_INFO [REINIT [USER|RESGROUP]]

The command without parameters writes out the status of monitoring or storing of auditing information (see also Object Group - monitoring changes in configuration).
Parameter REINIT USERS causes the writing of the current configuration of all objects of *User* type into the monitoring database.
Parameter REINIT RES_GROUP causes the writing of the current configuration of necessary objects of *Object group* type into the monitoring database.
In any object type is not stated in the command, both types of objects will be written into the monitoring database.

BACKUP SYSCFG path

Creates a configuration database backup in a directory specified by the path parameter (Sybase SQL Anywhere and PostgreSQL platforms).
Note: The backup can be influenced by the setting of ConfigBackUpTimeout parameter.

BACKUP LOGFILE path

Creates a log database backup in the directory specified by the path parameter (Sybase SQL Anywhere and PostgreSQL platforms).

CFGSYNCHROAUTO ON/OFF

Enables/disables the automatic synchronization of configuration databases after a new SBS (standby server) is connected.

Note 1: The command can be applied to the HOT server only.
Note 2: The synchronization can be influenced by the setting of the parameter ConfigSynchroTimeout.

CHECK_ARCHIVE

Checks a value type consistency between the primary archive object and the archive one and shows the errors (writes it into the log). The error is if the value type of the primary archive object is different from the value type of historical value.

CORRECT_TIME COUNT DELAY_MS

The command is used to quickly reduce the time offset on an active D2000 Server. This offset was created when the D2000 Server was passive (SBS) and when it becomes active (HOT), it is automatically reduced at a rate of 1 ms per second. However, if there are problems with the time (e.g. a jump of several minutes due to problems with the NTP server), this reduction rate is insufficient and the CORRECT_TIME command must be used. The command reduces the time offset COUNT times by 1 ms, waiting DELAY_MS milliseconds between corrections.

DEPLOY_JAVA_SHARED

If some files - the external and user libraries for Java, placed in directory %lt;appldirgt;/java/shared are changed, the D2000 Server will send these files to all running clients.

DI ON/OFF

DI /E+dbginfo

DI /E-dbginfo

Debug Info - shows (DI ON)/ hides (DI OFF) internal debug information of D2000 Server (in the process window and in the process D2000 Sysconsole).

The command allows show/hide viewing debug information by category as the SysConsole user interface allows.

Example 1: Show debug information

DI /E+DBG.CFG_RQ

Example 2: Hide debug information

DI /E-DBG.CFG_RQ

DP ON/OFF

Debug Pipe - enables/disables the displaying of the communication of the D2000 Server with client processes (only if the D2000 Server's window is displayed on the desktop).

ENABLEAUTOSTARTPROCESSES

Since version v23.0

If the kernel was started with the /N parameter, i.e. so that it does not start processes, by calling this tell command, startup is turned on and kernel processes start.

GENERATEYAML Path Mask

Generates OpenAPI specification for ESL RPC procedures into yaml. Specification is generated only for RPC procedures marked TC_BE.

; Test
;
; @Param _a -
; @Param _b -
RPC PROCEDURE [_h, TC_BE] Test(IN BOOL _a, INT _b)
   
END Test

Details on how to create documentation for procedures here

Path - path to generated yaml file
Mask - mask of objects of type event, for which the specification is generated

Example 1: Generation of OpenAPI specification for RPC procedures declared in E.Test

GENERATEYAML D:\D2000\D2000_Vxx.x.xx\D2000_APP\App_1\Test.yaml E.Test

Example 2: Generation of OpenAPI specification for RPC procedures declared in the events of an aplication

GENERATEYAML D:\D2000\D2000_Vxx.x.xx\D2000_APP\App_1\Test.yaml *

INSTANCE SET|GET ACTIVE|PREFERRED|USABLE ...

It is used to determine and set the active instance, preferred instance, and instance mode in a load-balancing mode.

INSTANCE GET PREFERRED process_name	Shows the number of the preferred process instance.
INSTANCE SET PREFERRED process_name instance_number	Sets a preferred process instance. It is used to set the preferred archive if the archives run as an instance (for more information see the chapter Redundant archiving). By default, the instance with a minimal number is active. This parameter can be used also for setting up the D2000 KOM process (for more information see the chapter Redundancy of communication process KOM). The command writes the number of the preferred instance into the system registers: HKEY_LOCAL_MACHINE\Software\Ipesoft\D2000V70\cfg_Meno_Aplikacie\Kernel\SELF.ARC_PreferredActiveInstance Warning: If the preferred value is 0, the process instances are not switched actively while the terminated active instance is started. I.e. when some active instance is finished, another existing instance will be a new active instance. If there are more process instances, the active one will be that with the minimum instance number. This process instance remains active even if another one is started (it had to be active before termination). Incorrect termination of the active and preferred instances may change the preferred process instance. If the active instance crashes while another instance is operating, it becomes a new preferred active instance (with the minimum number).
INSTANCE GET ACTIVE process_name	Enables displaying of the number of active process instance.
INSTANCE SET ACTIVE process_name instance_number	Sets the active instance of a given process. The parameter is used for setting up the active instance of the archive process if all the instances are running as instances (for more information, see the chapter Redundant archiving). By default, the active instance is the one that connects to the D2000 Server process as first. This parameter can be used also for setting up the D2000 KOM process (for more information, see the chapter Redundancy of communication process KOM). The command switches the active instance of the process.
INSTANCE GET USABLE process_name instance_number	Enables display '1' if a process of a given instance is active in load-balancing mode. If not, then '0'.
INSTANCE SET USABLE process_name instance_number 1\|0	Sets the instance of the process as active or passive in Load balancing mode (see the chapter Redundant archiving - Load balancing).

MESSAGE Message_Text process_name

Broadcasts (sends) a text message to client processes. The process name can be entered as a mask (e.g. *.HIP - for all processes D2000 HI). If the return code is Success, it contains the number of clients, and the message from the D2000 Server was sent.

LIC_PostponeLicWrnToUsers
0 až 240 [hod], default 24

Delay of license warnings for common users. The administrators of D2000 will get the license warning always and immediately.

LIC_DoNotAllowConsoleOverLimit
0|1, default 0

When setting 1, the system will not allow connecting consoles (HI) over the scope of the license.

LIC_DoNotAllowSysProcOverLimit
0|1, default 0

When setting 1, the system will not allow the system processes (CALC, EVENT, KOM,...) over the scope of the license.

RD_SET_HOT serverName

Sets the HOT server in the redundant system. The parameter serverName is the name of the server within the redundant group.

REFRESH_LICENCE

Online refresh of the information about the license range (from file LicenceRun.code or LicenceDev.code) and information about the network clients (from file ConsolesInfo.txt). It enables changing the license range without any need to stop the system, as well as re-reading the list of network clients after it has been manually edited. A list of networks and IP ranges for client access control is also refreshed.

Note 1: In redundant systems, it is necessary to replace the files LicenceRun.code or LicenceDev.code on all redundant servers.
Note 2: In redundant systems, it is necessary to modify the file ConsolesInfo.txt only on the active (HOT) server. The changes will be transferred to all SBS servers.
Note 3: The information about the license is sent to the client processes when connecting to the D2000 Server. For that reason, if the change of license affects even other processes than the D2000 Server, they must be restarted. For example, when a user adds a new communication protocol, it influences the D2000 CNF process. To enable this protocol in D2000 CNF, it must be restarted. Also, when adding a new communication station and I/O tags with the given protocol to the D2000 KOM process, it must be restarted.

RELOAD_PARAMS

Reloads all parameters for D2000 Server (except the parameters for saving the monitoring database to the depository) from the registry (Windows) or from the configuration file (Linux) without restarting the D2000 system.

RELOAD_SECURITY

Sets the new configuration of Security Policy without restarting the D2000 System.

REPAIR_ARCHIVE

Checks the consistency of the value type between the object being archived and the historical value. If an error occurs, it will be repaired immediately, and information will be written into the log. The error occurs if the value type of the object being archived is different from the value type of the historical value.

REPOSITORY INIT [path]

Initialize the path to the repository. If the directory does not exist, a new one will be created. If there is a repository on a given path, this one will be used for storing object history. History capturing must be disabled.

REPOSITORY DISCONNECT

Remove the setup path to the repository. History capturing must be disabled.

REPOSITORY ON|OFF

Enable/disable history capturing. A path to the repository must be set.

RESTART process_name

Stops the given process and then starts it correctly.

Note: If the process is stopped (Stop or Crash status), the command just starts it.

SET_LOAD_BAL_MODE
process_name mode

Activates/deactivates Load balancing mode for D2000 Archiv (see the chapter Redundant archiving - Load balancing) or D2000 Kom (see the chapter Redundancy of communication process KOM) processes.

Example:
SET_LOAD_BAL_MODE SELF.ARC 1 - activates Load balancing mode for SELF.ARC process.
SET_LOAD_BAL_MODE SELF.KOM 1 - activates Load balancing mode for SELF.KOM process.

SHOW_ACCESS_LIST

The command writes the list of the names registered by the GETACCESS action within the application (with the keyword PUBLIC) into the text console and to the log file (kernel.log) of the D2000 Server process.
The list contains the owner of the registered name as follows:
computer_name;process_name;event_name/activepicture_name

Example:
ACCESS LIST BEGIN
GETACCESS : "RegisteredName" is locked by : ComputerName;SELF.EVH;E.EventName
GETACCESS : "RegisteredName2" is locked by : ComputerName;ComputerName.HIP;S.PictureName
ACCESS LIST END

SHOW_ARC_STAT
process_name

Shows the statistical information about the running instances of the archive - the maximum number and sum of the read requests that are being processed.

SHOW_CONFIG

Shows the configuration information of the process D2000 Server.
This information covers:

start parameters of the process D2000 Server,
configuration parameters of D2000 system installation common for all applications,
parameters of process D2000 Server specified in the Windows registry (specific for running application),
in redundant systems, parameters of redundancy specified in the Windows registry (specific for the running application),
parameters specific for the ODBC and OCI versions of process D2000 Server.
detailed information on the number and structure of the tags
For Structured Variables: Object Name; the number of tags; the number of tags according to the methodology into the version D2000 V11
;D2RECORD;SV.DaE_Export_Head; 0; 11
For Structured Eval Tags: Object Name; the number of tags;
;CLC_VAL Struct;P.TASK_SUM_Pending; 13

Summary information on the contribution to the total number of tags for each object type:
Number of tags for structured variables from V11 and to V11
;D2RECORD;Summary V11+; 9126
;D2RECORD;Summary OLD; 49044
Number of tags for structured eval tags
;CLC_VAL Struct;Summary; 314

Number of tags for eval variables
;CLC_VAL;; 98
Number of tags for I/O tags
;POINT;; 25
Number of tags for user variables
;USER_VAR;; 2095
Number of tags for remote objects
;REM_OBJ;; 2
The total number of application tags
;TOTAL TAGS;; 11510

Note: By comparing the information obtained by this TELL command, it is possible to find out whether D2000 Server processes in a redundant group are configured identically, resp. if any parameter was omitted during the migration of the application server.

SHOW_DYN_INFO object_name or HOBJ

Shows dynamic information on the specified object (list of objects that dynamically or statically use the object) on the text console of the D2000 Server process.

Note: The command is intended to be used mainly for the D2000 system diagnostic purposes.

SHOW_DYNO_LIST idFirst idLast

The command dumps the list of current dynamic objects (ID and object name) to the text console of the process based on the defined interval.

Note: The command is mainly intended for diagnostic purposes.

SHOW_TRANS_LIST

Lists internal transactions of the D2000 system.

Note: The command is intended to be used mainly for the D2000 System diagnostic purposes.

SHUTDOWN D2000

Stops the D2000 system.

SHUTDOWN RESTART_D2000

Restarts the D2000 system.

SHUTDOWN RESTART

Stops the D2000 system and restarts the operating system.

SHUTDOWN SHUTDOWN

Stop the D2000 system and shut down the operating system.

SHUTDOWN WINNT

Stops the D2000 System and restarts the operating system.

STANDBYCFGFREEZE

Stop applying configuration changes to the Standby server. The Standby server must then be restarted (to synchronize with the Master server) or set as the Master (to discard configuration changes on the Master server). See the Standby server as a backup when deploying changes.

START process_name

Starts the specified process.

STDOUT output

The command redirects the standard output to a new output specified by output.

Example:
D2000 on OpenVMS platform: STDOUT "_TNA2:" (output is redirected to the terminal _TNA2:)
D2000 on Windows platform: STDOUT C:\output.txt (output is redirected to the file output.txt)

Note: If a D2000 process is run on the Windows platform as a service, the console output is disabled.

STOP process_name [FORCE]

It stops a process. When using the optional parameter FORCE, the termination of the process will be forced.

*SUSPEND* SLEEP [WAKEUP yyyy-mm-ddThh:mi:ssZ]|HIBERNATE

It causes the operating system to switch into sleep mode (SLEEP) or hibernation (HIBERNATE). If the OS switches into sleep mode, the user may define a time of its automatic awakening by the parameter WAKEUP yyyy-mm-ddThh:mi:ssZ, where yyyy-mm-ddThh:mi:ssZ defines UTC time of awakening. The string must be in ISO 8601 format (http://sk.wikipedia.org/wiki/ISO_8601).

Example: *SUSPEND SLEEP WAKEUP 2015-02-11T12:00Z* - causes putting the computer to sleep and automatic awakening at noon, February 11th, 2015 (UTC).

TCP_NO_DELAY process_name|process_mask [FALSE|TRUE|QUERY]

It enables, disables, or queries the delay of data transfer between the D2000 Server process and the client connected via TCP/IP protocol. Setting the parameter TCP_NO_DELAY to TRUE disables TCP delay before sending TCP packets (setsockopt function with parameter TCP_NODELAY - see Nagle's algorithm). The delay improves the efficiency of TCP/IP networks by reducing the number of packets that need to be sent over the network. On the other hand, if the communicating partners wait for each other's response (e.g., remote procedure calls between two EVENT processes or between HI and EVENT), this delay can significantly slow down the execution of scripts and other interactions.
By default, TCP delay is on (TCP_NO_DELAY = FALSE).
This TELL command is intended only for tuning and debugging purposes.

Note 1: When registering a TCP/IP client, the process D2000 Server queries the value of parameter TCP_NO_DELAY, and, depending on this value, it does or does not change the parameter TCP_NO_DELAY for client connection. This value is then sent to the client, which also changes the TCP_NODELAY parameter of its TCP connection to the server.
Warning: In the current implementation, the TCP_NO_DELAY command does not cause any change in the setting on the client's side!
Note 2: Besides the TCP_NO_DELAY parameter, there is also another parameter that influences sending TCP delayed acknowledgements (it can be set on OpenVMS and *nix systems by calling sysconfig -r inet tcpnodelack). This parameter induces a 200 ms delay before sending TCP acknowledgements, and it can interact with the TCP_NODELAY parameter.

XML_EXPORT_TABLE

The configuration parts exported to the XML files, which is not part of the object configuration.
The parameters: [Path, FileName, TableName].

Path - defines the path for saving the configuration.
FileName - defines the name of the output file. E.g. for the "systemtxt" file, a file with the name "systemtxt.xml" is created.
TableName - defines the table of the database, from which the configuration is to be exported.
TableName can acquire the following values: SYS_COLORS, SYSTEM_TEXT, TRANS_MASKA, DICTIONARY, LANGUAGES, LOGDEF, NAME_RULES.

Warning: Extension ".xml" is added automatically, do not explicitly specify it.

XML_IMPORT

Warning: This command is not supported for OpenVMS.

XML file(s) import of a specific file or of all XML files from the specified directory, depending on path_to_dir / path_to_file parameter:

path_to_dir - directory name with XML files (eg D:\temp). Note - the directory is searched for xml files recursively.

path_to_file - absolute path to the XML file (eg D:\temp\H.Sec.xml)

For this TELL command to be executed, a configuration key must be present!.

The path for the file import on VMS should be entered in Unix format.
Correct syntax: /DKB0/d2000/d2000-app/RIS_ROVE/XML/
Incorrect syntax: DKB0:[d2000.d2000-app.RIS_ROVE.XML] - this syntax is not supported, import of the directory containing XML files ends with an error

The import of one file supports both records:
Correct syntax: /DKB0/d2000/d2000-app/RIS_ROVE/XML/file.xml
Correct syntax: DKB0:[d2000.d2000-app.RIS_ROVE.XML]file.xml

Note: The command belongs to the "security" TELL commands. I.e., it can be activated only from interactive processes with the configuration key or from the process D2000 Event Handler.

XML_IMPORT_TABLE
Path [FileName TableName] [CleanTable]

Import of the configuration parts that are not part of the object configuration from XML files.
Parameters:

Path - defines the path from which the configuration will be read.
FileName - defines the name of the input file without XML extension. For example, "systemtxt" for the file with the name "systemtxt.xml".
TableName - defines the table of the database to which the configuration is to be imported.
TableName can acquire the following values: SYS_COLORS, SYSTEM_TEXT, TRANS_MASKA, DICTIONARY, LANGUAGES, LOGDEF, NAME_RULES.
Note: If the FileName and TableName parameters are not specified, all tables are imported, with the file name being identical (e.g. SYS_COLORS, i.e. the SYS_COLORS.xml file must be in the Path directory).
CleanTable - defines whether the table in the database will be cleaned before import (and then the import is performed), or whether the imported data is appended.
This parameter is optional; the default value is FALSE.
The parameter can acquire two values: TRUE - clean the table before import, FALSE - the table is updated.

The initialization of the TELL command is conditioned by using the configuration key.

Note: The command belongs to the "security" TELL commands. I.e., it can be activated only from interactive processes with the configuration key or from the process D2000 Event Handler.

XML_Update

Partial update of the objects by XML from the directory, which is defined by the parameter Path.
The parameter:
[path_to_dir / path_to_file]

Note: The command belongs to the "security" TELL commands. I.e., it can be activated only from interactive processes with the configuration key or from the process D2000 Event Handler.