Documentation Interface for File System

Transcription

1 Documentation Interface for File System Dragonfly Version 6 User-friendly Cross-platform Industry 4.0 Web Viewer Smartphone-App Free Hotline Indi.Systems GmbH Universitätsallee 23 D Bremen Tel Fax info@indi-systems.de

2 Table of contents What is the QuickHMI Interface for File system?... 3 How to prepare the interface?... 4 For what purpose I can use this interface?... 5 Settings... 6 Data archiving... 8 Current data image... 9 Structure text file data image... 9 Structure XML file data image Encryption and decryption Do you have any questions?

3 What is the QuickHMI Interface for File system? The interface for File system gives QuickHMI developer an easy way to provide an interface for an existing Oracle database with following features: Data-Archiving Every QuickHMI incoming datas form devices will be written in Files day by day. The maximum size and the maximum count of records are adjustable. Data-Image Complete Image of variables their current value and timestamp of last change. One File for each data source. Optional encrypting Incoming data will be encrypted. Tools for an easy decrypting are added. Automatically data reorganization (optional) For example: A self-created application could get access to the data of the QuickHMI and connected devices. It could use the data for analyses. It is possible to encrypt all data with a 256-Bit AES-cryption, for best protection. Only user/application who knows the decryption key have access tot he data. 3

4 How to prepare the interface? You have to create an available folder in you file system. The folder should be exists, if it s not the system try to create it. The process needs read, write and delete access to this folder. Are these rights missing it could course malfunctions. Particularly the delete rights are needed to reorganize the old data. This could course a full disk or a windows crash. The same could happened if external processes blocking the tables permanently. Check if the target system has enough free disk space. The rights have to be exist for the current windows user while development, therefore the file can be written and read while Editors runtime. Additionally these rights are necessary for the production environment for the user which runs the data source service. Important: The archiving to the file system high performed and tested with merchantable hardware and 1000 variable changes per 100 milliseconds. If the amount of data from the QuickHMI much higher and the data cannot be written to the archive, the data will be held on RAM by the system and write the data back-to-back. If the data reaches more than data records for each data source, new data will deleted. This problem could appear while hardware working to capacity or missing resources (e.g. virtual servers). Before using check the performance of your target Oracle database system. It is also necessary that the target system has enough (at least 20 GB) free disk space. This always depends on the incoming data and the time of archiving. 4

5 For what purpose I can use this interface? There are countless possibilities of using the interface. Every time if you need an outside access to the QuickHMI or connected devices (e.g. PLCs or modbus devices) you can use this interface. You can use the data for analyses, charting, reporting or just to archiving. For example: A self-created application could get access to the data of the QuickHMI and connected devices. It could use the data for analyses. You do not have to learn different scripting languages, just use your favorite programming language. 5

6 Settings The following QuickHMI File system interface settings are available: 1. Target path 2. Archive function on/off 3. (Option) max count data records within target table. While reaching this count the old data records will be deleted. 4. (Option) max age of files indication in hours. While reaching the age range the old files will be deleted. 5. Maximum size of each archive file indication in MB. If the file reaches the size, a new file will be created with next sequence number. If you do not set a max size the file will reach a max size of 2 GB. 6. Automatic reorganize the archive on/off. If deactivated, the old data records stay in the table. The user has to delete the old data by themselves. 7. Creating a variable image on/off optionally as flat- or XML format. 8. (Optional) set a password for encrypting. If you don t set a password the file won t be encrypted. Please handle this password with care. Do not give this password to other users. 6

7 You can find the options for archiving in the Data sources window accessible through the Project Explorer. By creating or editing a data source the options will be opened by pressing the External logging button. In the opened window you can select File by activate the checkbox and choose the path where the file should be saved. Determine if an image should be created, set the different settings and define a password. Click OK to continue. 7

8 Data archiving By the data archiving all incoming data changes will be logged in the archive table. You can use this data for any purposes. Files will be created in this format: <date>_<sequence 5-digit>_<datasource name>.log e.g _00001_DataSource1.log Optional encrypted archive files have the same name with the ending *.logx If the file reaches the set max size or 2 GB, a new file will be created with next sequence number. The fields in the file are separated with a semicolon. The first row gives you the column names. Following information will be written: 1. Timestamp incl milliseconds 2. Sender (Name of data source) 3. Data type 4. Name of Variable 5. Current Value 6. Quality (GOOD if QuickHMI-connection to target device regulatory works, BAD if problems appear (e.g. Timeouts) 8

9 Current data image The data image provides the QuickHMI variables and their current value for external applications there are two options for the data image format. Text file or XML-file. Structure text file data image Files will be created in this format: <Data source name>.dat e.g. DataSource1.dat Optional encrypted archive files have the same name with the ending *.datx The fields in the file are separated with a semicolon. The first row gives you the column names. It exists one row in the file for each variable. Following information will be written: 1. Timestamp incl milliseconds 2. Sender (Name of data source) 3. Data type 4. Name of Variable 5. Current Value 6. Quality (GOOD if QuickHMI-connection to target device regulatory works, BAD if problems appear (e.g. Timeouts) 9

10 Structure XML file data image Files will be created in this format: <Data source name>.xml e.g. DataSource1.xml Optional encrypted archive files have the same name with the same ending *.xml It exists one row in the file for each variable. Following information will be written: 1. Flag if file is encrypted 2. Timestamp incl milliseconds 3. Sender (Name of data source) 4. Data type 5. Name of Variable 6. Current Value 7. Quality (GOOD if QuickHMI-connection to target device regulatory works, BAD if problems appear (e.g. Timeouts) For encrypted files, the XML format has remained preserved. Only the field contents are encrypted. 10

11 Encryption and decryption To provide optimal data security, the QuickHMI file interfaces are equipped with optional encryption. Encryption is carried out directly if you have set up the necessary settings within the data sources. Please note: You must assign a password for encryption. Please keep this password up! If it is lost, the encrypted files can no longer be opened We can t help in this case. The encryption routines require CPU resources! Plan slightly higher computing power. Especially when you very many variables are changed in very short intervals. However, you can test the load in the editor during the runtime mode. Your QuickHMI system includes a command line program for encryption and decryption. You can find it under [QuickHMI-Home] /qhmisecu.exe within the editor or server installation. You can carry out the following actions: 1. Log files in logx-format or decrypt image files in the datx format To do this, open the program qhmisecu.exe with the following parameters: qhmisecu.exe -d <source file> <target file> <your password> The decrypted file will be created. 2. Decode image files in xml format Open the program qhmisecu.exe with the following parameters: qhmisecu.exe -x <source file> <target file> <your password> The decrypted file will be created. 11

12 Do you have any questions? If you have questions about our product QuickHMI, please call us on our free hotline or send us an . Free hotline: We will process your request promptly or respond to you directly. 12