Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
en:sw:01-mervis:03-mervis-db [2021/05/18 10:57] avsetula |
en:sw:01-mervis:03-mervis-db [2024/04/03 10:40] (current) avsetula [The service is available in cloud and local variants] |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Mervis DB ====== | ====== Mervis DB ====== | ||
- | {{ :cs:sw:01-mervis:mervis_db.png?nolink&400 |}} | + | {{ cs:sw:01-mervis:mervis_db.png?nolink&400 |}} |
- | Mervis DB je vysoce optimalizovaná databáze určená pro dlouhodobé ukládání dat z kontrolerů, aplikací a mnoha jiných zařízení, které využívají otevřeného API databáze. | + | Mervis DB is a highly optimized database designed for long-term storage of data from units, applications and many other devices that use an open API database. |
- | Hlavní využití s kontroléry Unipi je ukládání historických dat a jejich analýza pomocí [[cs:sw:01-mervis:05-mervis-scada|Mervis SCADA]]. | + | For Unipi units is the main use as storage of historical data and their analysis using [[en:sw:01-mervis:05-mervis-scada|Mervis SCADA]]. |
+ | ===== The service is available in cloud and local variants ===== | ||
- | ===== Služba je dostupná v cloudové i lokální variantě ===== | + | <html><span class="kbBlue-H5alt">Part of Mervis SCADA (cloud)</span></html>\\ |
+ | The standard way of using Mervis DB is the cloud service variant. The Mervis DB credentials are generated **together with the Mervis SCADA project** and are intended for all PLCs connected to this SCADA project. | ||
- | <html><span class="kbBlue-H5alt">Cloudová varianta</span></html>\\ | + | To use Mervis DB together with Mervis SCADA, follow the instructions [[en:sw:01-mervis:mervis-scada-project-hidden|]]. |
- | Standardním způsobem použití Mervis DB je varianta cloudové služby. Přístup do databáze je umožněn po [[https://www.unipi.technology/cs/mervis-p56|zakoupení]] a [[cs:sw:01-mervis:getting-mervis-licence-hidden|aktivaci licence Mervis]]. | + | |
- | Návod pro nastavení PLC a ukládání dat do Mervis DB naleznete v návodu: [[cs:sw:01-mervis:storing-data-to-mervis-db-hidden|]] | + | ---- |
+ | |||
+ | <html><span class="kbBlue-H5alt">Only Mervis DB (cloud)</span></html>\\ | ||
+ | The Mervis DB cloud service can also be operated **separately**, without Mervis SCADA. In this case, credentials are generated individually and their validity must be agreed in advance. | ||
+ | |||
+ | <WRAP center round box 95%> | ||
+ | If you are only interested in the Mervis DB, please [[https://www.unipi.technology/contacts|contact our sales department]] for an individual offer. | ||
+ | </WRAP> | ||
+ | |||
+ | |||
+ | Instructions for setting up a unit and saving data to the Mervis DB can be found in the manual: [[en:sw:01-mervis:storing-data-to-mervis-db-hidden|]] | ||
---- | ---- | ||
- | <html><span class="kbBlue-H5alt">Varianta lokální instalace</span></html>\\ | + | <html><span class="kbBlue-H5alt">Local installation option</span></html>\\ |
- | Službu Mervis DB lze provozovat i na lokálním serveru. Pro více informací kontaktujte naše [[[email protected]|obchodní oddělení]]. | + | The Mervis DB service can also run on a local server. For more information contact our [[[email protected]|Sales Department]]. |
- | /* | ||
- | <html><span class="kbBlueLightText">Minimální požadavky serveru Mervis DB pro lokální instalaci:</span></html> | ||
- | * OS: Windows 7 nebo Windows Server 2012 a nainstalovaný framework .NET4.5 | ||
- | * IIS - doporučeno | ||
- | * HDD: 2 GB + prostor pro data | ||
- | * RAM: 1 GB | ||
- | */ | ||
- | ===== Migrace a správa dat ===== | + | ===== Data migration and management ===== |
- | V rámci placené služby nabízíme také několik variant správy dat: | + | As part of the paid service, we also offer several options of data management: |
- | * Přesun dat mezi účty Mervis DB, včetně možné úpravy časového razítka | + | * Transfer of data between Mervis DB accounts, including possible timestamp editing |
- | * Import dat z Excelového, nebo CSV souboru | + | * Import data from Excel or CSV file |
- | * Export dat do Excelového, nebo CSV souboru | + | * Export data to Excel or CSV file |
- | * Vymazání nechtěných dat z Mervis DB | + | * Delete unwanted data from Mervis DB |
- | V případě zájmu o některou z výše zmíněných služeb kontaktujte naše [[[email protected]|obchodní oddělení]]. | + | If you are interested in any of the above mentioned services, contact our [[[email protected]|Sales Department]]. |
\\ | \\ | ||
- | {{cs:sw:01-mervis:migrace_mervis-db_cz.png?direct|}} | + | {{ en:sw:01-mervis:migrace_mervis-db_en.png?direct |}} |
===== Mervis DB Viewer ===== | ===== Mervis DB Viewer ===== | ||
- | K prohlížení ukládaných dat z cloudové instance Mervis DB na serverech Unipi lze využít Mervis DB Viewer. Jedná se o on-line aplikaci, která se spojí s databází a zobrazí dle zadaných parametrů (např. časového rozmězí) data které obsahuje. | + | The Mervis DB Viewer can be used to view stored data from a cloud instalation of Mervis DB on Unipi servers. It is an online application that connects to the database and displays database data according to the specified parameters (e.g. time range). |
- | URL adresa: [[https://db.unipi.technology/viewer]]. | ||
- | {{cs:sw:01-mervis:db-mervis-info-viewer.png?direct|}} | + | URL address: [[https://db.unipi.technology/viewer]]. |
+ | |||
+ | {{ cs:sw:01-mervis:db-mervis-info-viewer.png?direct |}} | ||
===== API ===== | ===== API ===== | ||
- | Mervis DB nabízí otevřené rozhraní protokolu SOAP. Odpovídající WSDL je k ke stažení: | + | Mervis DB supports open SOAP API described by this WSDL: |
- | * {{:cs:sw:01-mervis:mervisdb_wsdl-2017-07-12.zip|}} | + | * {{cs:sw:01-mervis:mervisdb_wsdl-2017-07-12.zip|}} |
- | Pro speciální použití existují i další rozhraní pro komunikaci s Mervis DB - pro jejich použití a popis kontaktujte prosím [[cs:contact:00-start|technickou podporu]]. | + | For special use, there are other interfaces for communication with Mervis DB - for their use and description, please contact [[en:contact:00-start|technical support]]. |
- | ==== Seznam základních podporovaných funkcí ==== | ||
- | ^ Funkce ^ Popis ^ | + | ==== List of supported functions ==== |
- | | SaveData | Uloží jeden, nebo více záznamů z jedné nebo více proměnných. | | + | |
- | | GetData/GetDataAsync | Přečte jeden, nebo více záznamů z jedné nebo více proměnných. | | + | ^ Function ^ Description ^ |
- | | GetParticularData/GetParticulatDataAsync | Optimalizovaná metoda pro čtení „speciálních“ dat - poslední hodnota, poslední hodnota po určitém časovém okamžiku atd. | | + | | SaveData | Save one or multiple records from one or multiple variables | |
- | | GetVariables | Získá seznam proměnných. | | + | | GetData/GetDataAsync | Read one or multiple records from one or multiple variables. | |
+ | | GetParticularData/GetParticulatDataAsync | Optimized method for reading of „special“ data - last value, last value after certain time moment etc. | | ||
+ | | GetVariables | Get the list of variables. | | ||
| GetAllVariables | | | | GetAllVariables | | | ||
- | | ServerAlive | Zastaralé | | + | | ServerAlive | Obsolete | |
| DeleteVariables | | | | DeleteVariables | | | ||
| DeleteData | | | | DeleteData | | | ||
| EnsureVariables | | | | EnsureVariables | | | ||
- | | GetTransformedData/GetTransformedDataAsync | Metoda čtení agregovaných výsledků s daným časovým obdobím, agregace může být min, max, integrál, vážený průměr, první, poslední a medián | | + | | GetTransformedData/GetTransformedDataAsync | Method for reading of aggregated results with given time period, the aggregation may be Min, Max, Integral, Weighted average, First, Last and Median | |
| GetServerVersion | | | | GetServerVersion | | | ||
- | | GetVariableStats | Zastaralé | | + | | GetVariableStats | Obsolete | |
- | | GetVariableStatsAsync | Zastaralé | | + | | GetVariableStatsAsync | Obsolete | |
| CheckCredentials | | | | CheckCredentials | | | ||
- | ==== Příklady použití ==== | + | |
+ | ==== Object Properties ==== | ||
+ | * (UTC)TimeStamp - UTC time stamp of the record | ||
+ | * GoodThrough - UTC time stamp of the end of validity of particular record | ||
+ | * Interval - period of time (in seconds) when next value should be recorded | ||
+ | |||
+ | |||
+ | ==== Examples ==== | ||
=== C# === | === C# === | ||
- | {{cs:sw:01-mervis:mervis_db_csharp.png?direct|}} | + | {{ cs:sw:01-mervis:mervis_db_csharp.png?direct |}} |
- | <html><span class="kbBlueText">Příklady ke stažení:</span></html> \\ | + | <html><span class="kbBlueText">Download:</span></html> \\ |
* {{cs:sw:01-mervis:mervisdb_getdata_example.zip|}} | * {{cs:sw:01-mervis:mervisdb_getdata_example.zip|}} | ||
* {{cs:sw:01-mervis:mervisdb_savedata_example.zip|}} | * {{cs:sw:01-mervis:mervisdb_savedata_example.zip|}} | ||
| | ||
- | <html><span class="kbBlueText">Příklad kódu:</span></html> \\ | + | <html><span class="kbBlueText">Code example:</span></html> \\ |
<code csharp| MervisDB_GetData_Example.cs> | <code csharp| MervisDB_GetData_Example.cs> | ||
Line 391: | Line 404: | ||
=== Matlab === | === Matlab === | ||
- | {{cs:sw:01-mervis:mervisdb_matlab_api.png?direct|}} | + | {{ cs:sw:01-mervis:mervisdb_matlab_api.png?direct |}} |
+ | |||
+ | == Supported functions: == | ||
+ | |||
+ | ^ Function ^ Description ^ | ||
+ | | SaveData | Save one or multiple records from one or multiple variables. | | ||
+ | | GetData | Read one or multiple records from one or multiple variables. | | ||
+ | | GetDataUnmerged | Read one or multiple records from one or multiple variables. Allow more setting options than GetData function. | | ||
+ | | GetDataOrigin | Read data exactly as are stored in the database. | | ||
+ | | DeleteVariable | Delete entire variable or some certain interval. | | ||
+ | | GetRequiredTimestamp | Get time stamp depending on input options. | | ||
- | == Podporované funkce: == | ||
- | ^ Funkce ^ Popis ^ | ||
- | | SaveData | Uloží jeden, nebo více záznamů z jedné nebo více proměnných. | | ||
- | | GetData | Přečte jeden, nebo více záznamů z jedné nebo více proměnných. | | ||
- | | GetDataUnmerged | Přečte jeden, nebo více záznamů z jedné nebo více proměnných. Umožňuje nastavit více možností než funkce GetData. | | ||
- | | GetDataOrigin | Přečte data přesně tak, jak jsou uložena v databázi. | | ||
- | | DeleteVariable | Smažte celou proměnnou nebo určitý interval. | | ||
- | | GetRequiredTimestamp | Získej časové razítko v závislosti na nastavení vstupu. | | ||
== Toolbox == | == Toolbox == | ||
- | Pro komunikaci Matlabu s Mervis DB potřebujete nainstalovat toolbox: | + | You need to import specialized toolbox to communicate with Mervis DB from Matlab: |
* {{cs:sw:01-mervis:mervisdb_matlabtoolbox.zip|}} | * {{cs:sw:01-mervis:mervisdb_matlabtoolbox.zip|}} | ||
- | * Zobrazení nápovědy ke každé z funkcí je možné: <code matlab> | + | * There is a help available for all toolbox functions. To display the help use: <code matlab>help MervisDatabse.supported_function_name</code> |
- | help MervisDatabse.supported_function_name | + | |
- | </code> | + | |
- | == Kód == | + | == Code example == |
<code matlab| MervisDB_GetData_example.m> | <code matlab| MervisDB_GetData_example.m> | ||
% Instance of Mervis DB | % Instance of Mervis DB | ||
Line 443: | Line 457: | ||
=== PHP === | === PHP === | ||
- | == Kód == | + | == Code example == |
<code php| MervisDB_GetData_example.php> | <code php| MervisDB_GetData_example.php> | ||
<?php | <?php | ||
Line 547: | Line 561: | ||
?> | ?> | ||
</code> | </code> | ||
- | |||
- | |||
- | /* | ||
- | ===== Excel Exporter ===== | ||
- | K dispozici je také nástroj pro příkazovou řádku s názvem Excel Exporter, který může z vašich dat v Mervis DB vytvořit plně přizpůsobitelný soubor aplikace Microsoft Excel. | ||
- | |||
- | Jeho základem je šablona XLSX souboru, ve kterém můžete pomocí speciální syntaxe umisťovat data z Mervis DB. | ||
- | |||
- | ==== Příklad: ==== | ||
- | V tomto příkladu si ukážeme, jak exportovat jednu proměnnou z Mervis DB do Excelového souboru. | ||
- | |||
- | Obrázek | ||
- | |||
- | === Soubor s konfigurací === | ||
- | Nejprve je třeba vytvořit konfigurační soubor XML, kde se definuje mapování mezi sadou klíčů popisujících jednotlivé proměnné Mervis DB a některými názvy proměnných, které budou použity později v šabloně aplikace Excel. | ||
- | |||
- | Můžete také definovat název výstupního souboru a také zda má být soubor pouze aktualizován nebo přepsán. | ||
- | |||
- | <code xml| ExcelDemo.xml> | ||
- | <?xml version="1.0" encoding="utf-8"?> | ||
- | <RcWareDbExporterVariableTemplateFile> | ||
- | <exportTemplate>exceldemo.xlsx</exportTemplate> | ||
- | <exportOutput>exceldemo_[yyyy-MM-dd_HH-mm].xlsx</exportOutput> | ||
- | <fillIncrementaly>false</fillIncrementaly> | ||
- | <variables> | ||
- | <variable name="OutsideTemperature"> | ||
- | <keyValuePairs> | ||
- | <keyValuePair key="DPGuid" value="338E2882-D72B-4D17-A241-73E8BC30F458" isId="true" /> | ||
- | <keyValuePair key="StationName" value="ENERGO" isId="true" /> | ||
- | </keyValuePairs> | ||
- | </variable> | ||
- | <variable name="HereCouldBeSomeOtherVariable"> | ||
- | <keyValuePairs> | ||
- | <keyValuePair key="DPGuid" value="338E2882-D72B-4D17-A241-73E8BC30F458" isId="true" /> | ||
- | <keyValuePair key="StationName" value="ENERGO" isId="true" /> | ||
- | </keyValuePairs> | ||
- | </variable> | ||
- | </variables> | ||
- | </RcWareDbExporterVariableTemplateFile> | ||
- | </code> | ||
- | |||
- | === Excelová šablona === | ||
- | Pomocí jednoduchého jazyka šablony můžete definovat, které hodnoty z Mervis DB se maji umístit na jaké místo ve výstupním souboru aplikace Excel. | ||
- | |||
- | <code> | ||
- | [YEAR:2016|MONTH:1|DAY:15|HOUR:12|MINUTE:0|VARIABLE:OutsideTemperature] | ||
- | </code> | ||
- | |||
- | Libovolnou z hodnot definujících čas lze vynechat a bude nahrazena aktuálním datem, časem nebo hodnotami předanými prostřednictvím parametrů příkazového řádku. | ||
- | |||
- | obrázek | ||
- | |||
- | |||
- | === Spuštění exportéru === | ||
- | <code | runExcelDemo.bat> | ||
- | .\ESG.RcWareDb.DataExporter\ESG.RcWareDb.DataExporter.exe tmpPath:"ExcelDemo.xml" srvUrl:"http://db.unipi.technology/dbaccess" srvUser:"exceldemo" srvPsw:"pfi4cj4qrj" timeTolerance:300 toleranceType:before | ||
- | </code> | ||
- | |||
- | Pro více informací spusťte: | ||
- | <code | runHelpInfo.bat> | ||
- | .\ESG.RcWareDb.DataExporter\ESG.RcWareDb.DataExporter.exe --help | ||
- | </code> | ||
- | |||
- | === Výstup === | ||
- | Výstupní soubor je definován v konfiguračním souboru XML. Ukázkový výstup by měl vypadat následovně: | ||
- | |||
- | obrázek | ||
- | |||
- | === Celý příklad ke stažení: === | ||
- | |||
- | Příklad: excelexporterdemo.zip | ||
- | */ | ||
- | |||
- | |||