The HS/FS can record and archive values of communication objects (internal and EIB).
Recording can be carried out cyclically and using a command.
All data can be retrieved in different formats (csv, html, xml), which enables further processing, e.g., for graphic representation or spreadsheets.
In addition, a Menu page displays the data directly as a graph.
An archive can be sent per e-mail, retrieved via http, and stored externally via ftp.
The information can be retrieved within the network per ISDN direct dial-in or via the Internet.
Recording can be carried out cyclically and using a command.
All data can be retrieved in different formats (csv, html, xml), which enables further processing, e.g., for graphic representation or spreadsheets.
In addition, a Menu page displays the data directly as a graph.
An archive can be sent per e-mail, retrieved via http, and stored externally via ftp.
The information can be retrieved within the network per ISDN direct dial-in or via the Internet.
Important
Only numerical values can be saved in the archives!
Note
Texts can be saved in message archives.
1.Archive
The states of communication objects are archived in the archive (more precisely: data archive).
Archiving can be carried out with a command. In addition, the data can be recorded cyclically.
Questions on this topic are dealt with in the FAQ.
In order to create a data archive, change to the "Archive" window. Move the mouse pointer in the directory tree to the "Archive" node. Press the right mouse button. A pull-down menu opens. Click "Create archive". A new archive is added to the directory tree.
Specify under "Columns" which data should be saved within a data record.
Archiving can be carried out with a command. In addition, the data can be recorded cyclically.
Questions on this topic are dealt with in the FAQ.
In order to create a data archive, change to the "Archive" window. Move the mouse pointer in the directory tree to the "Archive" node. Press the right mouse button. A pull-down menu opens. Click "Create archive". A new archive is added to the directory tree.
Specify under "Columns" which data should be saved within a data record.
1.1.Tabs
1.1.1.Data
The basic definition of the archive takes place here.
Designation
The archive is maintained under this term in HS/FS Expert.
Archives can be searched via the end point interface, where a word from the designation begins with the search word used there.
Archives can be searched via the end point interface, where a word from the designation begins with the search word used there.
Ring memory
Maximum number of data records that are to be kept in the ring memory. If this number is reached, the oldest existing data record is replaced by the next new record to be created. See also Limit values.
Cycle
If this option is selected, the data is recorded cyclically.
| Yes | Recording is done cyclically. The cycle duration is specified in minutes in the adjacent field. Regardless of this option, a data record can be saved at any time via a command. |
|---|---|
| No | Recording must be triggered by a command. |
Dead time
This time prevents data from being recorded at excessively short intervals.
This time period is primarily of importance for data recording in connection with commands.
Example:
If the dead time is 60 seconds, commands for data storage are only executed after this time has expired. (FAQ on the topic)
This time period is primarily of importance for data recording in connection with commands.
Example:
If the dead time is 60 seconds, commands for data storage are only executed after this time has expired. (FAQ on the topic)
Columns
Up to 128 communication objects (1 communication object per column) can be saved simultaneously in a line. This simplifies later evaluation. Each archive always contains the date and time in the first column.
The columns are created, changed, or deleted using the operating buttons on the right of the list. A mask appears for this.
The columns are created, changed, or deleted using the operating buttons on the right of the list. A mask appears for this.
Important
If an archive is changed (columns added, deleted or the data type changed), then any data of this archive which may be already saved there may be lost after subsequent retransfer of the project to the HS/FS!
1.1.2.End point
Archives can be accessed via the end point interface of the HS/FS.
There is a description of the call parameters here.
There is a description of the call parameters here.
Note
Any archive can of course be used instead of the archive used in all the call-up examples shown in the following table.
Placeholders are specified in UPPER CASE.
Placeholders are specified in UPPER CASE.
1.1.2.1.Methods
| Method | Description/Call |
|---|---|
| meta | Retrieval of metadata from the archive.https://HS_IP/endpoints/call?key=DA@my_archive&method=meta&user=USER&pw=PWD |
| get | Retrieval of certain columns of an archive in a specific time period.https://HS_IP/endpoints/call?key=DA@my_archive&method=get&startat=1702261500&cnt=12&size=5&cols=MYCOL1+MYCOL5&user=USER&pw=PWD |
1.1.2.2.Fields
ID
The value entered here forms the unique object key of the end point together with the fixed prefix "DA", with which the ID is connected by an '@' character.
Permitted characters are: A-Z, a-z, 0-9, hyphen ("-") and underscore ("_")!
Permitted characters are: A-Z, a-z, 0-9, hyphen ("-") and underscore ("_")!
Description
A meaningful description of the archive.
Archives can be searched via the end point interface, where a word from the description begins with the search word used there.
Archives can be searched via the end point interface, where a word from the description begins with the search word used there.
Tags
A list of terms, separated by commas (",").
Archives can be searched via the end point interface, where an individual tag completely matches the search word used there.
Permitted characters are: A-Z, a-z, 0-9, hyphen ("-") and underscore ("_")!
Archives can be searched via the end point interface, where an individual tag completely matches the search word used there.
Permitted characters are: A-Z, a-z, 0-9, hyphen ("-") and underscore ("_")!
User groups
Important
This item is only available when user groups have been activated!
User groups can be authorised to access this archive (for reading) via the end point interface.
1.1.3.E-mail
Note
This option is only available after sending via e-mail has been activated beforehand via Master data\Project\Network\E-mail.
Sending via e-mail
This list shows all archive versions that can be sent by e-mail.
Actuate the operating buttons "Create/Change/Delete" on the right next to the list. A mask appears for processing.
Actuate the operating buttons "Create/Change/Delete" on the right next to the list. A mask appears for processing.
1.1.4.HTTP call
HTTP call
This list shows all archive versions that can be retrieved via an HTTP query.
Actuate the operating buttons "Create/Change/Delete" on the right next to the list. A mask appears for processing.
Actuate the operating buttons "Create/Change/Delete" on the right next to the list. A mask appears for processing.
1.1.5.FTP
Note
This option is only available after support has been activated beforehand via Master data\Project\Network\FTP.
Sending via FTP
This list shows all archive versions that can be stored externally via FTP.
Actuate the operating buttons "Create/Change/Delete" on the right next to the list. A mask appears for processing.
Actuate the operating buttons "Create/Change/Delete" on the right next to the list. A mask appears for processing.
1.2.Limit values
The data is saved permanently (retentively) within a ring memory. The memory is similar to a table that is made up of lines and columns. It can be configured for every archive.
Important
The first column always contains the date and time of saving and is not included in the calculation of the limit values for HomeServer and FacilityServer.
The maximum specifications listed in the following tables are outer limits. The specifications do not represent any characteristics with regard to memory capacity. No larger values can be used in HS/FS and HS/FS Expert. Therefore the memory capacity can be much smaller depending on the data to be saved and the compression methods used!
The limits are as follows and the first that takes affect will apply. The limits differ for the HomeServer and the FacilityServer.
The limits are as follows and the first that takes affect will apply. The limits differ for the HomeServer and the FacilityServer.