Parameters for Archive
Parameters for archive
The D2000 Archiv reads the following parameters from the system registry (Windows) or from the application.properties file in the application directory (Linux) when it starts. Parameter values are set using the D2000 Application Manager (D2Smc.exe) or the regedit utility (Windows) or by editing the application.properties file (Linux).
Parameter | Meaning |
|---|---|
AlmostZero | Size of delta used in a comparison of two values. If the parameter is not specified, the default value is 1e-10.
Note: Parameter AlmostZero can be changed via the TELL command SET_OPTION. |
ArcsynchroAuto | The command for automatic synchronization of the archive database after the start. If this command is not defined, the archive doesn't run this command but presumes that synchronization of archive holes will be performed by an external mechanism. |
ArcsynchroBackground | When the archive detects a patched hole, it runs recalc for the closed hole. If the parameter ArcsynchroBackground is set to 1, recalc will be performed by the auxiliary calc task. The default value is 0 - recalc will be performed by the main archive write task(s). More information. |
ArcsynchroTimeDelta | When the archive detects a patched hole, it runs recalc for the closed hole, extending over the hole interval by ArcsynchroTimeDelta seconds on both sides. If the parameter is not defined, the default value is 10 seconds (the same as the default value of parameter /TD of arcsynchro utility). More information. |
AutoMountPath | Configuration parameter for depository databases on the Sybase platform - more information. |
BackupOffset | The offset of the start of backup in the given period. It is given in the format HH:MM. It is the offset in hours and minutes. |
BackupPath | Path to the directory where the archive database backup will be stored. |
BackupPeriode | The backup period specified in hours. The value 0 means the backup will not be performed. |
BackupPassive | Acquires the values 0, 1:
|
ChainedReadPrio | This parameter enables chained reading from archives. If the archive being read has a small archive depth and older data is required, the D2000 Archive can continue reading from the derived statistical archive. Since there may be several different statistical archives (and only some statistical functions have the nature of source data), the ChainedReadPrio parameter can be used to define their priorities (from highest to lowest), e.g. F_WGAVG,F_AVG,F_TIMESLICE,F_MAX,F_MIN,NOFUNCTION (if there are several statistical archives created from a single primary archive, the one with the highest priority will be used). |
CommitCountActive | When CommitCount values are inserted into the archive database, D2000 Archiv calls Commit. The default value is 1000. By increasing this value, the frequency of Commit operations will be lowered. This parameter can be set separately for active and passive archives. Note 1: The Archive is considered to be active if it reads data from the archive database. The archive is passive if it is connected to a standby server or if it is a passive instance of an archive. |
CommitDeleteRatio | The number of deleted values (by the TELL command DELETE_DATA or by the action DELETEARCHDATA), which are considered equivalent to one inserted value, as far as Commit is concerned (see the description of CommitCountActive/CommitCountPassive). The default value is 100 deleted values. |
CommitTimeActive | Time (in seconds), after which the archive performs periodic Commit. The default value is 60 seconds. This parameter can be set separately for active and passive archives. See notes at CommitCountActive/CommitCountPassive parameters. |
CursorCacheSize | Cache size for precompiled cursors (precompiled INSERT or UPDATE commands). On Sybase 6.0, 7.0, 9.0, 12.0, on MS SQL, and MSDE platforms, a cache with more than 3000 cursors was tested. Note 1: It is not usually needed to define the parameters CursorCacheSize and CursorCacheUpdates. |
CursorCacheUpdates | If the value of the parameter is 1, the cache will store precompiled UPDATE commands too. Note 1: It is not usually needed to define the parameters CursorCacheSize and CursorCacheUpdates. |
DataTableSlices | Value 0 (default) means that the archive doesn't use time slices. |
DbUsername | The parameter can be used to change the default value of the username used by the archive to connect to an archive database.
Note: This parameter can be used to simplify the renaming or migration of an application using an Oracle archive. Otherwise, export of all archive tables and import under a different Oracle user/scheme (e.g., MyNewTest_archiv) is necessary. If depositories are configured, setting the parameter TrezorPrefix is recommended. |
DbPassword | The parameter can be used to change the default value of the password used by the archive to connect to an archive database. |
DeleteInSlice0 | If time slices are used in the archive, the value 1 (default) means that during periodic delete in the archive database, also data from slices zero (original data tables) will be deleted. The value 0 turns the deletion off so that during the periodic delete, no data is deleted from slices zero, but the whole slice will be emptied (via SQL command TRUNCATE TABLE) when it is older than the configured "History depth" parameter of the historical value. The advantage is speed (the database is not burdened by DELETE commands, which generate REDO logs and optionally by following automatic reorganization), the disadvantage is up to double the disk space needed for the database (until all slices zero get truncated). |
DeleteInSlices | If time slices are used in the archive, the value 0 (default) means that during periodic delete in the archive database, data from time slices won't be deleted, but the whole slice will be emptied (via SQL command TRUNCATE TABLE) when it is older than the configured "History depth" parameter of the historical value. The advantage is speed (the database is not burdened by DELETE commands, which generate REDO logs and optionally by following automatic reorganization), the disadvantage is an increase in the disk space needed for the database by the data contained in one time slice (i.e., 1 month). |
DiskUsageWarning | Setting the parameter DiskUsageWarning to a value of 0 disables the archive warning (ODBC version only) that free space on a disk with the archive database is below 10% of the archive database size. |
DiskUsagePeriod | The parameter specifies how often (number of minutes) the archive will generate a warning that free space on a disk with the archive database is below 10% of the archive database size. The default value is 15 minutes. |
DropOldRequests | If the recalculations of older values of computed historical values by auxiliary calc task are on (see the RecalcImmediateDepth parameter), setting the DropOldRequests parameter to a value of 1 causes the recalculations not to be performed but instead to be written to a file in the application directory. The name of the file is SELF_ARCHIV_DROPPED_CALCS.DAT for the process SELF.ARC or name_ARCHIV_DROPPED_CALCS.DAT for the process name.ARC. The contents of this file can be processed by a TELL command CALC_OLD_REQUESTS. The default value of the parameter DropOldRequests=0 means that the recalculations will be performed. |
DSN_Override | This parameter has a similar meaning for archive on Sybase/MS SQL/PostgreSQL platforms, as has TNS_Service_Name parameter for archive on the Oracle platform. That is, it enables the change of a predefined DSN (Application.Archiv for SELF.ARC or Application.Arcname.Archiv for Arcname.ARC), which the process D2000 Archiv uses to connect to the archive database. It enables, e.g., running two instances of the archive on a single computer. |
ForceSelectIndex | If the parameter of DWORD type is set to a non-zero value, the FORCE INDEX clause of the SELECT command will be used when reading from Sybase Anywhere version 9 and higher. Note 1: If reading from the archive database on Sybase is too slow, check whether the Optimization_goal option is set to First-row. |
FreeSpaceQuery | The parameter of the STRING type determines how the process D2000 Archiv queries free space in the archive database on the Oracle platform:
Free space in the database is displayed as a FreeSpace item in the predefined structured variable SV._System_ArchivPerformance. If the parameter FreeSpaceQuery is not specified or differs from the values listed above, free space will be queried from the view USER_FREE_SPACE. |
IsochronousCache | Value of 1 switches the archive cache into a new mode - so-called isochronous cache. In this mode, the cache of the process D2000 Archiv works as follows:
If the parameter IsochronousCache is set to the value 0, the cache behaves as originally designed, i.e.:
By enabling the isochronous cache and by specifying sufficient cache size (depending on the archive's load) it is possible to achieve "in memory archive" when the time depth of the cache (e.g., several hours) is sufficient for most graphs and script operations, which speeds up the opening of graphs and decreases the load on the archive database. Enabling the isochronous cache is recommended for "delayed" archives, which contain a lot of archived objects calculated on demand (OnDemand archives), which are calculated behind the real-time (e.g., with a 1-hour time lag). If a sufficient time depth of the cache is set, the values necessary for the calculation of statistical and calculated archived objects will be available from the cache, which will speed up the calculations. |
IsoCacheFullDepth | The parameter is meaningful only if the Isochronous cache is enabled by setting the IsochronousCache parameter. |
IsoCacheAutoFill | The parameter is meaningful only if the Isochronous cache is enabled by setting the IsochronousCache parameter. |
IsoCacheDepth | The parameter is meaningful only if the Isochronous cache is enabled by setting the IsochronousCache parameter. |
MaxCacheSize | Size of the memory [MB] that can be used by the archive process to create a dynamic cache. Using the archive cache significantly speeds up the evaluation of statistical and evaluated archive objects. |
MaxOpenTrezors | The maximum number of depository databases that can be opened for reading at the same time.
|
OldValIgnoreAge | If the parameter value is nonzero, the values older than OldValIgnoreAge hours will be discarded. If the debugging category DBG.ARCHIV.IGNORED_VALUES.OLD is enabled, then the discard information will be written to the archive log. This parameter is useful as a way to protect the archive from old communication values (since subsequent massive calculations of dependent historical objects could overload the archive). Dropping values refer to old values from communications (which only go to the archive and have an archive flag of OldVal) as well as values without the OldVal flag. It does not apply to values inserted from the script or values manually changed in HI. Parameter OldValIgnoreAge can be changed via the TELL command SET_OPTION. |
OldValOnAuxTask | Old values from the communication (which go only to the archive and have the archive flag OldVal set) will be processed by the auxiliary calc task. |
OneThreadForGraph | The value can be 0 or 1. If OneThreadForGraph = 1, only one thread will be used for one instance of a graph when reading its data. If OneThreadForGraph = 0, the number of threads, defined in the parameter ReadThreadsCount, will be used. |
PG_CreateTrezor | Configuration parameter for depository databases on the PostgreSQL platform - more information. |
PG_ReorganizeSlice | A value that determines SQL commands used during the reorganization of previous time slices on the PostgreSQL platform:
Note 1: value will be in effect also for TELL command REORGANIZE for SLICE=-3 ("previous time slice") and SLICE=-4 ("all slices older than current time slice"). |
PG_ReorgSliceTime | A value determining a time interval (in seconds) after which previous time slices will be reorganized on the PostgreSQL platform. The default value is 3600 + 600 seconds, i.e., an hour and ten minutes after the previous time slices ceased to be used. |
PG_TrezorFileMulti | Configuration parameter for depository databases on the PostgreSQL platform - more information. |
PG_TrezorFilePath | Configuration parameter for depository databases on the PostgreSQL platform - more information. |
PG_TrezorName0 | Configuration parameter for depository databases on the PostgreSQL platform - more information. |
PG_TrezorName | Configuration parameter for depository databases on the PostgreSQL platform - more information. |
Pg_TrezorOldConnect | Configuration parameter for depository databases on the PostgreSQL platform - value 1 turns on the old way of working (a permanent database connection to every attached depository database) that has higher demands on the database server. A value of 0 (default) causes the connection to be open only during the reading of a particular depository database. |
ReadThreadsCount | The parameter specifies the number of threads that provide parallel access to data from the archive. Possible values 1...10. The default value is 1. A value greater than 1 requires a license for the "High Performance Archive" pack. |
ReadTimeBeforeStart | Experimental parameter. When reading time interval <Start, Stop> from the archive, the queried interval will be <Start-ReadTimeBeforeStart, Stop>. For specific applications, it is possible to tune the parameter ReadTimeBeforeStart to achieve that also the first value before the time interval <Start, Stop>, which is otherwise read by another SELECT command, will be obtained. |
RecalcFuture | Parameter to limit future recalculations. If non-zero, its value specifies the number of seconds into the future that dependent archives will be recalculated after a value with a time in the future arrives. The default value of 0 means that no restrictions are applied. Note: The parameter does not affect user-requested recalculations (via the RECALC command or the CALCONDEMANDSTAT action). |
RecalcImmediateDepth | Time depth (in seconds) of the recalcs of computed historical values, which are performed by the main archive task. Default value 0 means that all recalcs of historical values are performed by the main archive task. A non-zero value means that recalcs older than RecalcImmediateDepth seconds will be performed by an auxiliary calc task so that the main archive task will not be overloaded by recalcs of older historical values. |
RecalcOptimize | The parameter activates the optimization of the repeated recalculation of the time interval. |
RecalcParallelInterval | Specifies the size of the recalculated time interval (in seconds) intended for parallelization. The parameter is meaningful for a multiwrite archive (i.e., if the value of parameter WriteThreadsCount > 1 the archive uses multiple write tasks). If the parameter RecalcParallelInterval is set to a non-zero value (the default value is 0), then the recalcs of time intervals greater than the specified value which are initiated externally (by a TELL command or from a script) will not be performed by a write task assigned to the recalculated historical value, but by a write task with the smallest number of recalc requests in its queue will be used. |
RecalcTimeIntervalLimit | The parameter (specified in hours) for the process D2000 Archiv defines a limit for the time interval for the recalculation of statistics. If a request for recalculation of a longer time interval is generated (internally or as a result of the TELL command RECALC), it will be split into several shorter requests with a time interval not longer than the limit defined by the RecalcTimeIntervalLimit parameter. This parameter is meant to be a safeguard against the crash of the process D2000 Archiv during recalcs of long time intervals entered by a user or caused by the arrival of the old value. |
RecalcUseTrezor | The parameter can acquire the value 0 or 1. |
ReorganizeOffset | The offset of the beginning of periodic reorganization in the given period. It is given in the format HH:MM. It is the offset in hours and minutes. See the description of the ReorganizePeriode parameter. |
ReorganizePeriode | Periodic reorganization period, given in hours. During the periodic reorganization, all archive tables are reorganized irrespective of the number of deleted rows and the time of the last reorganization (see ReorganizeTableRowLimit and ReorganizeTableTimeLimit parameters). |
ReorganizeTableRowLimit | The parameters define the conditions for the process D2000 Archiv to perform automatic reorganization of the archive database. The parameter ReorganizeTableRowLimit defines the number of deleted rows, and the parameter ReorganizeTableTimeLimit specifies the number of hours. (e.g., ReorganizeTableRowLimit=50000 and ReorganizeTableRowLimit=24 --> the archive table is to be automatically reorganized after 50000 values of the archive table are deleted but not more often than once in 24 hours). Warning: The parameters can be only used for archives on Oracle, PostgreSQL, Sybase 9.0, and higher platforms. |
SelectBeforeUI | If the value of the parameter is 1, a Select is performed before Insert/Update to find out whether a value with a specific timestamp is already in a database. If it is, an Update is performed; otherwise Insert is performed. When using this parameter, it is necessary to turn on the IsochronousCache parameter and set the RecalcImmediateDepth parameter to 0. |
StatKeepFlags | The parameter activates copying of user flags (FA, FB, … FO, FP) from source values to calculated values of statistical historical values. If the parameter value is 1, the value of will statistical historical values will have a summary of all user flags of the source values. |
StatKeepWeak | The parameter activates the copying of the Weak flag from the source values to the calculated values of the statistical historical values.. If the value of the parameter is 1, the value of will statistical historical values will have the Weak flag set if at least one source value has this flag (plus the standard setting of the Weak flag remains as a consequence of the poor quality of the source data configured on the archived value by the Validation Criteria parameter. |
StructCursorMode | The parameter defines the mode of processing values of columnar and structured historical objects in conditions of parallel writing to the database (WriteThreadsCount > 1). The following values are supported:
Note: modes 1 and 2 enable the processing of structured archive objects to be optimized; on the other hand, they require the cursor for the archive object to be compiled on each writing task. However, in the case of large applications, cursors may run out (there can be a maximum of 65535 open cursors on one task/database connection - these are ODBC or OCI limitations, not D2000 limitations). |
ReportLongRecalc | The parameter activates logging of a recalc interval longer than the parameter value. The default value is 30 * 24 * 3600 seconds. A value of 0 disables logging. |
SystemLogging | If the value of the parameter is 1, information about completed conversions is sent to the D2000 Server process and written to the log database. If the value of the parameter is 0, this information is not sent to the D2000 Server process or written to the log database. |
TimescaleDBType | Activates TimescaleDB support and converts data tables to hypertables on the PostgreSQL platform.
|
TimescaleDBInterval | This text parameter is related to TimescaleDB support and specifies the time interval size for each hypertable chunk in PostgreSQL interval syntax. The recommended value is |
TimescaleDBIntervalCps | This optional text parameter is related to TimescaleDB support and specifies the compression time for each hypertable chunk in PostgreSQL interval syntax. Chunks that contain older data will be compressed. If this parameter is not specified, the value of TimescaleDBInterval is used. |
Tablespace_Name | Configuration parameter for the archive database on the Oracle platform - it defines the name of the archive tablespace. If this parameter is empty, the name APPLICATION_NAME_TS_ARCHIV is used. If the name is wrong, the process D2000 Archiv will not report the information about the archive tablespace in the system structure SV._System_ArchivPerformance (columns DatabaseSize, AutoExtensible, FreeSpace, DataSize). |
TNS_Service_Name | Configuration parameter for the archive database on the Oracle platform - defines the TNS of the database that the archive tablespace is in. |
TNS_Service_Name_Trezor | Configuration parameter for depository databases on the Oracle platform - more information. |
Trezor_Active_Only | Configuration parameter for depository databases on the Oracle platform - more information |
TrezorCompressPath | Configuration parameter for depository databases:
|
TrezorCompressOffline | Configuration parameter for depository databases:
|
TrezorCompressTime | Configuration parameter for depository databases:
|
TrezorCountDatafiles | Configuration parameter for depository databases on the Oracle platform - more information. |
TrezorCountSegments | Configuration parameter for depository databases:
|
TrezorDatafileSizeStep | Configuration parameter for depository databases on the Oracle platform - more information. |
TrezorDatafileSuffix | Configuration parameter for depository databases on the Oracle platform - more information. |
TrezorMaxDatafileSize | Configuration parameter for depository databases on the Oracle platform - more information. |
TrezorNologging | Configuration parameter for depository databases on the Oracle platform - more information. |
TrezorPath | Configuration parameter for depository databases:
|
TrezorPostCompressCmd | Configuration parameter for depository databases:
|
TrezorPostCompressPar | Configuration parameter for depository databases:
|
TrezorPeriod | Configuration parameter for depository databases:
|
TrezorPrefix | Configuration parameter for depository databases on the Oracle platform - more information. |
TrezorReadOnlyTimeout | Configuration parameter for depository databases on the Oracle platform - more information. |
TrezorStartDatafileSize | Configuration parameter for depository databases on the Oracle platform - more information. |
Upsert | Setting the parameter to value 1 activates the usage of the SQL command "UPSERT" (a combination of Insert and Update SQL commands), which is supported by PostgreSQL database starting with version 9.5. In this case, insertion of values into the archive and depository databases will be performed by command INSERT .. ON CONFLICT .. DO UPDATE. This enables setting the archive ODBC parameter "Level of rollback on errors" to the value Transaction (instead of the current standard value Statement). That radically decreases the generation of XIDs (database transaction IDs related to the existence of savepoints separating every single SQL statement) and consequently reduces the related overhead of PostgreSQL (frequent vacuuming to avoid "transaction ID wraparound"). |
WorkingHoursStart | An hour marking the beginning and the end of working hours. During this time, time-consuming archive operations are minimized to increase the availability of the archive. |
WriteThreadsCount | The number of threads used for parallel writing of the values to the database. Possible values 1...32. The default value is 1. A value greater than 1 requires a license for the "High Performance Archive" pack. The parameter is implemented starting with version 8.00.011. For archives with heavy load running on PostgreSQL or Oracle database, we recommend setting this value equal to the number of processors (respective cores of processors) of the archive server. For archives using the Sybase database, no significant improvements have been observed when writing was parallelized. |
Note: To change a parameter, select the parameter in the right part of the window and press Enter, or double-click the parameter.
Related pages: