SARTORIUS Sim Api programinė įranga

Specifikacijos

• Produkto pavadinimas: SimApi vadovas
• Išleidimo data: 5 m. rugsėjo 2024 d
• Tikslas: teikti duomenis „Umetrics Suite“ produktams

Produkto naudojimo instrukcijos

Įvadas į SimApis

• SimApis are used to retrieve data for project creation and model building in Umetrics Suite products.

„SimApis“ gavimas

• To obtain SimApis, refer to the official documentation or contact customer support for assistance.

SimApi Features

• SimApis provide real-time data for monitoring, control, and model building in SIMCA and SIMCA-online.

Only Current Data Usage

• It is recommended to use current data only and avoid historical data for optimal performance.

Preparing for a SimApi Installation

• Before installation, ensure that your system meets the minimum requirements specified in the user guide.

„SimApi“ diegimas

• Follow the step-by-step instructions provided in the user manual to install the SimApi on your system.

Setting up SimApi for SIMCA

• Configure the SimApi settings in SIMCA according to the guidelines provided.

Setting up SimApi for SIMCA-online

• Set up the SimApi for real-time data retrieval and write-back operations in SIMCA-online.

Testavimas ir trikčių šalinimas

• After installation, perform testing to ensure proper functionality. In case of issues, refer to the troubleshooting section in the user guide.

Testing from SIMCA-online

• Test the SimApi integration from SIMCA-online to verify data retrieval.

Troubleshooting with Log Files

• Naudokite „SimApi“ žurnalą file to identify and resolve any installation or operational problems.

Service Account Configuration

• Ensure the correct configuration of the SIMCA-online service account for seamless operation.

Techninės detalės

• Refer to section 7 of the user guide for in-depth technical information on SimApis.

Įvadas į SimApis

• A SimApi is a software interface between the Umetrics® Suite software and a data source. The primary purpose of a SimApi is to provide data to SIMCA®-online or SIMCA®.
• Sartorius Stedim Data Analytics AB develops SimApis for many different data sources, such as process historians and general-purpose databases.
• This document shows what a SimApi is, and how it is used in Umetrics Suite products. You’ll learn how to plan for, and install a SimApi, how to troubleshoot and how to test your installation. The final chapter contains technical details of SimApis aimed at developers.

SimApi purpose: provide data to Umetrics Suite products

• The primary purpose of a SimApi is to provide data to SIMCA-online or SIMCA from a data source. The data source is not part of SIMCA-online but can be a process historian or other system that keeps and manages the data.
• A SimApi exposes a hierarchy of nodes, corresponding to folders in a file sistema. Kiekviename mazge gali būti kitų mazgų arba tags. A tag atitinka kintamąjį. Dėl šių tags, galima gauti duomenis. Nuotraukoje pavaizduota a tag, Temp, selected in the node
• BakersYeastControlGood in a data source in SIMCA-online. It also shows the latest values taken from the data source.

SimApi usage in the Umetrics Suite

• Stalinio kompiuterio programinė įranga SIMCA gali naudoti SimApi, kad gautų duomenis projekto kūrimui ir modelių kūrimui, kaip parodyta toliau pateiktame paveikslėlyje.
• SIMCA-online naudoja SimApis, kad gautų duomenis realiuoju laiku, kad būtų galima stebėti ir valdyti, taip pat įrašyti duomenis atgal į duomenų šaltinį. Toliau pateiktame paveikslėlyje parodyta, kur yra SimApi sistemoje, kurią sudaro duomenų šaltinis, SIMCA internetinis serveris ir klientai.

Commonly used SimApis

• Plačiausiai naudojami SimApis yra:
• The PI AF SimApi for connecting to Aveva (formerly OSIsoft) PI Systems.
• The OPC UA SimApi
• The ODBC SimApi – for general access to databases such as SQL Server or Oracle
• Visos galimos SimApis kartu su jų funkcijomis išvardytos 3 pastraipoje.

The DBMaker SimApi for simulation data

• DBMaker is an application provided with the SIMCA-online server installation. It simulates a data source, such as a process historian, by using a preloaded data table where observations are provided one by one to SIMCA-online through the DBMaker SimApi.
• DBMaker is only used for demonstration purposes and cannot be used in production with live data from a data source. See the built-in help to learn more about DBMaker.

Papildomi dokumentai

• This document is one of a set of related documents, each with a different focus and target audience:

Šaltinis	Ką	Kur
SIMCA tinkle web puslapį	Introductory information and downloads	sartorius.com/umetrics-simca- internete

SIMCA-online ReadMe and Installation.pdf	Installation and how to get started with SIMCA- online demo data	Diegimo zip file
SIMCA-online Implementation Guide	Apibrėžiamas SIMCA internetinis funkcionalumas, pateikiamas kontekste su kita Umetrics Suite programine įranga, aprašomi sėkmingo diegimo reikalavimai ir geriausia praktika bei nuoseklios diegimo instrukcijos.	sartorius.com/umetrics-simca- internete
SimApi vadovas	Pasirengimas SimApi diegimui ir jų vykdymas, įskaitant trikčių šalinimą. Taip pat yra techninės informacijos apie SimApis kūrėjams.	sartorius.com/umetrics-simapi
SimApi vartotojo vadovai	Kiekvieno paskelbto SimApi dokumentacija su funkcijomis, diegimo instrukcijomis ir konfigūracijos specifika.	sartorius.com/umetrics-simapi
SIMCA internetinis techninis vadovas	Technical reference for SIMCA-online server installation planning, troubleshooting, and in-depth how SIMCA-online works.	sartorius.com/umetrics-simca-internete
SIMCA pagalba internetu	Web-based help on how to use SIMCA-online and how SIMCA-online works.	In the software itself, and on sartorius.com/umetrics-simca
SIMCA tinkle Web Client Installation Guide	Aprašomas SIMCA-online diegimas Web Klientas.	sartorius.com/umetrics-simca-internete
Umetrics knowledge base	Ieškoma duomenų bazė su straipsniais apie kiekvieną išleistą programinės įrangos versiją, techninius straipsnius ir žinomas „Umetrics Suite“ produktų problemas.	sartorius.com/umetrics-kb
SIMCA help/user guide	Kaip naudoti darbalaukio SIMCA kuriant projektus ir modeliuojant duomenis.	In SIMCA and on sartorius.com/umetrics-simca
Palaikymas web puslapį	Kaip gauti techninę pagalbą.	sartorius.com/umetrics-support

Techninė pagalba

• Sartorius online support team answers technical questions about SimApis and can also forward requests for enhancement of SimApis to the appropriate people. Learn more at sartorius.com/umetrics-support.

„SimApis“ gavimas

• We provide documentation for available SimApis and links to installation programs at sartorius.com/umetrics-simapi.
• Each SimApi is documented in its User Guide.
• The SimApi Guide, which you are reading no,w complements that information with SimApi complementing information when it comes to SimApi planning, installation, and troubleshooting.

SimApi funkcijos

• Ne visi duomenų šaltiniai yra vienodi. „SimApi“ nebūtina įdiegti visų specifikacijos funkcijų. Dėl šių priežasčių skirtingos SimApis siūlo skirtingas funkcijas. Šioje matricoje pateikiami galimi SimApis ir jų funkcijos.
• Funkcijos paaiškintos toliau. Atkreipkite dėmesį, kad lentelėje yra atskiri stulpeliai, rodantys, kurios funkcijos galimos atitinkamai SIMCA-online ir SIMCA.

Funkcija	Tikslas	SIMCA naudojimas internetu	SIMCA naudojimas
Dabartiniai duomenys	Read a single observation with the most recent value from the data source.	Real-time normal execution	–
Istoriniai duomenys	Skaitykite daug stebėjimų vienu metu naudodami istorinius duomenis iš duomenų šaltinio.	Sekite ir nuspėkite praeities duomenis, kurkite projektus naudodami File > Naujas	Duomenų bazės importavimo vedlys, skirtas importuoti proceso duomenis modeliui kurti.
Diskretūs duomenys	Skaityti laboratorijos/IPC duomenis iš duomenų šaltinio. Daug stebėjimų vienoje partijoje.	For batch projects with phases or batch conditions configured for discrete data retrieval.	–
Paketiniai duomenys	Perskaitykite partijos sąlygas ir galutinius kokybės atributus (arba	Partijos sąlygos arba vietinis centravimas.	Duomenų bazės importavimo vedlys, skirtas nuskaityti paketo sąlygas

Funkcija	Tikslas	SIMCA naudojimas internetu	SIMCA naudojimas
	kiti ŠMM tipo duomenys). Vienas stebėjimas vienoje partijoje.		partijos lygio modelio kūrimas.
Partijos mazgas	Specify the start time and the end time (empty for an active batch) for a specific batch. Enumerate all batches that existed in a time range.	Reikalingas paketinių konfigūracijų vykdymui.	Duomenų bazės importavimo vedlys, kad pasirinktumėte importuojamas partijas.
Write back – continuous data	Į duomenų šaltinį įrašykite nuolatinius duomenis, pvz., prognozes.	Write back data from the batch evolution level, for Control Advisor or for continuous configurations	–
Write back – discrete	Įrašykite atskirus duomenis, pvz., prognozes, atgal į duomenų šaltinį.	Write back for batch configurations at the batch evolution level for phases configured for discrete data retrieval	–
Write back – batch data	Write back batch level data, such as predictions or final quality attributes, to the data source.	Write back for batch configuration at the batch level	–
Mazgų hierarchija	SimApi palaiko mazgų hierarchiją, panašiai kaip a file sistema. Kiekviename mazge gali būti tags ir kiti mazgai. Hierarchija leidžia lengviau valdyti daugybę mazgų ir tags.	Palaikoma visose vietose, kur tags yra naudojami.
Masyvas tag išplėtimas	Masyvas tag saugo kelias vertes. „SimApi“ išplečia masyvą tag daugeliui individų tags, po vieną kiekvienam masyvo elementui.	Palaikoma kur tags naudojami nuolatiniams duomenims. Kiekvienas išsiplėtė tag turi būti susietas su kintamuoju SIMCA projekte.
Keli duomenų šaltiniai	„SimApi“ gali prisijungti prie daugiau nei vieno duomenų šaltinio arba palaiko kelis savo egzempliorius su atskirais nustatymais ir žurnalu files kiekvienam atvejui.	Prisijunkite prie kelių skirtingų tos pačios rūšies duomenų šaltinių.	–
Ryšio atsparumas	If the SimApi becomes disconnected from the data source, it will try to reestablish the connection automatically.	The SimApi doesn’t have to be restarted to reestablish connections to the data source.	–
Developed in- house	The SimApi is developed, provided and supported by

Only current data, without historical data, is not recommended

• Kai kurios SimApis, ypač OPC DA, palaiko tik dabartinių, o ne istorinių duomenų skaitymą.
• „SimApi“, kuris palaiko tik dabartinius duomenis, negali būti naudojamas darbalaukio SIMCA, nes jis negalės nuskaityti istorinių duomenų, kuriais remiantis būtų kuriami modeliai.
• „SIMCA-online“ primygtinai rekomenduojame duomenų šaltinį ir „SimApi“, kurie teikia ne tik dabartinius duomenis, skirtus vykdyti realiuoju laiku, bet ir istorinius duomenis, kad būtų galima numatyti ir pasivyti praeities duomenis. SIMCA-online automatiškai perjungia realaus laiko duomenis į istorinius duomenis, jei reikia, ir to negalima išjungti.
• A data source that only provides current data, but not historical data, can work for continuous projects in SIMCA-online, but for batch projects, historical data is required.

Pasiruošimas „SimApi“ diegimui

• Šiame skyriuje aprašoma svarbi informacija apie sėkmingą SimApi įdiegimą.

64-bit or 32-bit SimApis

• There are 32-bit and 64-bit versions of each SimApi.
• SIMCA-online and SIMCA are 64-bit and require the 64-bit SimApis variants. The legacy 32-bit SimApis are still available for older installations.

Location for log file ir parametrus

• „SimApi“ saugo savo žurnalą files in the hidden Program Data folder1:
  %programdata%\Umetrics\SimApi, where %programdata% maps to the actual folder on your computer. It defaults to C:\ProgramData.
• Kiekvienas SimApi paprastai naudoja savo žurnalą file, kuris panašiai kaip SIMCA internetinio serverio žurnalas file bus daugiau ar mažiau duomenų, priklausomai nuo žurnalo lygio nustatymo. Tai file yra naudinga trikčių šalinimui. Rąstas file yra pavadintas
  <simapi>.log where <simapi> is the SimApi that you are installing, for example PIAFSimApi. Also see the next section for SIMCA-online SimApi instance names.
• This folder also contains the SimApi settings in an XML file named <simapi>.xml.
• Most SimApis have graphical user interfaces that change the settings in the xml file, bet kai kuriems pakeitimus įvedate tiesiai į XML file naudodami teksto rengyklę, pvz., Notepad. Žr. kiekvieno SimApi vartotojo vadovą.

File vardai, kai pavadinti egzemplioriai naudojami su SIMCA-online

• SIMCA-online kiekvienas SimApi egzempliorius gauna savo konfigūraciją file ir žurnalas file dirbti su keliais kiekvieno SimApi egzemplioriais. Šių pavadinimai files yra susegta egzemplioriaus pavadinimu, kaip nurodyta SIMCA internetinio serverio parinkčių dialogo lange „SimApi“.
• Šis buvęsample rodo šių pavadinimų files, kur reikia pakeisti SimApi pavadinimu.
• Configuration name given when the instance is added: OmegaServer
• Konfigūracija file name: <simapi>OmegaServer.xml
• Žurnalas file vardas: OmegaServer.log
• Atkreipkite dėmesį, kad bendrinis file .log file vis dar kuriamas. Šis žurnalas file yra įrašų, kurie dėl techninių priežasčių negali būti nukreipti į žurnalą file of the instances..
• This folder is hidden in Windows by default. To see it in File „Explorer“, kurį sukonfigūravote, rodyti paslėptą files. Atminkite, kad galite pereiti į paslėptą aplanką įvesdami adresą File Explorer adreso juosta.
• Atminkite, kad SIMCA nepalaiko kelių SimApi egzempliorių, todėl naudoja pavadinimus be egzemplioriaus pavadinimo, kaip aprašyta aukščiau.

Tinklo planavimas

• Turėtumėte rasti SIMCA internetinį serverį netoli duomenų šaltinio tinkle. Tai užtikrina greitą ryšį tarp SIMCA-online ir jos duomenų šaltinio.
• Tinklo įranga gali trikdyti ryšį tarp SIMCA-online ir duomenų šaltinio.

User accounts and data source permissions

• Data sources typically control access to their data. This is usually done with usernames and passwords but IP-address- or DNS-based restrictions can also be used (for example PI Trusts in Aveva PI System).
• Vartotojo vardas ir slaptažodis duomenų šaltiniui gali būti pateikiami įvairiais būdais:
• A SimApi is run as the Windows user of the user running desktop SIMCA or the SIMCA-online service account on the server computer. The SimApi can connect to the data source using this account. This is how the OPC I, and the PI SimApi work, and ODBC if you don’t provide credentials when configuring it.
• For generic ODBC you can use the ODBC Data Sources Administrator application found on Start in Windows.
• Some database providers provide their own drivers and tools for their databases. Oracle databases, for example, naudokite Oracle Data Access Components (ODAC).
• Some SimApis, such as PI AF and ODBC, have configuration dialogs that store the encrypted credentials in the SimApi XML configuration file.
• PI also has various security options available in the PI System Management Tools on the PI server computer. Read more in the PI AF SimApi User Guide. This guide is helpful even if you use the older OSIsoft PI SimApi.
• OPC DA and HDA use DCOM as the transport between a data source and SimApi. DCOM is configured with the Component Services tool (DCOMCNFG.EXE) in Windows and uses Windows authentication.
• For the older OSIsoft PI SimApi (not the newer AF SimApi), the OSIsoft AboutPI-SDK application (PISDKUtility.exe) is used to set up the connection to the PI server.

Verifying data source connectivity
When you want to install a SimApi on a computer, it can be useful to verify the connectivity from that computer to the data source with another tool:

• ODBC Data Sources in Windows is used to configure and test generic ODBC. Note that there are two versions of this tool on 64-bit Windows: one for 32-bit applications and one for 64-bit. Use the Test Data Source button at the end of the ODBC configuration wizard to verify connectivity to the database. We recommend that you configure your data sources as System DSNs.
• A database-specific connection tool from the provider of the database, such as the Oracle Data Access Components.
• PI System Explorer can be used to test connectivity to the PI AF server. It is part of the PI AF Client which is a pre-requisite for the PI AF SimApi.
• OPC UA Expert from Unified Automation – UaExpert is a cross-platform test client for OPC UA servers.
• The PI-SDK application (PISDKUtility.exe) can be used to test connectivity and to view any error messages that might have been logged when SIMCA-online tries to connect to the PI server. This is only used for the older OSIsoft SimApi, not PIAF.
• PI System Management Tools are used on the PI server computer for troubleshooting from that side. For example, ieškoti saugos problemų, neleidžiančių pasiekti SIMCA-online serverio. Sužinokite daugiau apie PI sistemos trikčių šalinimą šiame „YouTube“ vaizdo įraše.
• Excel can be used to obtain data from an ODBC connection and most other systems when a suitable plugin is installed.
• Matrikon OPC Explorer for Ior HDA (these are separate tools) can be used to test OPC connectivity, and Matrikon OPC Analyzer can be used to diagnose the OPC connectivity issues. Download these free tools from https://www.matrikonopc.com/products/opc-desktop-tools/index.aspx
• OPC Rescue (for DInd HDA) from the OPC Training Institute’s web site “enables users to easily diagnose communication and security problems, and repair them instantly with the push of a button. All this can be done without ever having to learn to configure DCOM“

„SimApi“ diegimas

Here is how to install a SimApi on a PC:

1. Read the User Guide for the SimApi you are installing. It contains specifics for that SimApi that complement the general instructions you are reading now.
2. Install and configure any prerequisites mentioned in the SimApi User Guide (for example database drivers or SDKs)
3. Run the setup program to install the SimApi. Install the 64-bit (x64) or the 32-bit (x86) version that matches the software you will run it in.
4. Configure the SimApi in SIMCA-online or SIMCA as described in the following sections and refer to the user guide of the SimApi for descriptions of available settings.
5. Start the SIMCA-online server. Note that this can take time, because when the SimApi is initialized, it will enumerate all tags in the data source.
6. Test the SimApi by obtaining some data. For SIMCA-online, you can use File > Extract as described in 6.1.
7. If the SimApi fails to work as expected, refer to the SimApi log files trikčių šalinimui ir SimApi vartotojo vadove.

Setting up the SimApi for use in SIMCA

Here’s how to use the SimApi in SIMCA:

1.  Start the database import in one of the following ways:
   • a. To create a new project in SIMCA: File > New Regular Project or New Batch Project. Select From database on the Home tab.
   • b. To import a data set in an existing project in SIMCA: From dataset on the Data tab of an open SIMCA project.
2. Click Add new data source
3. Select SimApi as the connection type, click the …-button and locate the <simapi>.dll in the installation folder, and click Open.
4. Click Configure and refer to the individual SimApi User Guide how to make the settings.
5. Click the Test data source connection to verify that you can connect to the database. This can take a long time if there are many tags in the data source.
6. Click OK to complete the configuration.
7. Refer to the SIMCA help for how to work with imported data.

Setting up the SimApi for use in SIMCA-online

• Svarbu: norint naudoti SimApi, reikalinga SIMCA internetinio serverio licencija. Demonstracinis SIMCA-online diegimas neleidžia naudoti SimApis.
• Norėdami pridėti SimApi prie sistemos, serverio kompiuteryje paleiskite SIMCA-online serverio parinktis. Išsamius veiksmus sužinokite SICMA internetinėje žinyno temoje Pridėkite ir sukonfigūruokite SimApi serveryje.
• Patarimas: jei atliekate „SimApi“ pakeitimus, galite iš naujo paleisti „SimApi“ atskirai iš „Serverio parinkčių“, neperkraunant viso serverio.
• Norėdami sukonfigūruoti kelis šio SimApi egzempliorius, pakartokite aukščiau nurodytus veiksmus ir kiekvienam egzemplioriui naudokite unikalius pavadinimus. Skaitykite daugiau apie skirtingą žurnalą ir konfigūraciją files 4.2 atvejams.

Testing and troubleshooting a SimApi

• Šis skyrius yra apie SimApi diegimo testavimą ir trikčių šalinimą.

Testing a SimApi from SIMCA-online

• Once the SIMCA-online server has been started successfully you can test your SimApi in SIMCA-online (if the server does not start, see 6.2):
• Prisijunkite prie serverio SIMCA internetiniame kliente ir eikite į Išskleisti File skirtuką. Ištrauka padeda išbandyti SimApi, gaudama duomenis per jį:
• The nodes (“folders”) of the SimApi are displayed in the left box. Tags pasirinktam mazgui rodomi viršuje dešinėje.
• Dabartinius duomenis galima greitai patikrinti tiesiog spustelėjus view> įjungtas tags kurie teikia nuolatinius proceso duomenis (žr. ekrano kopiją)
• Right-click on a node to Find batches within a time range. The node must be a batch node that knows about batches.
• Pasirinkite tags Išskleisti, spustelėkite Pirmyn ir užbaikite vedlį, kad gautumėte duomenis naudodami skirtingus duomenų gavimo režimus: esamus, istorinius, paketinius ir atskirus duomenis.
• Naudodami jo įrankius palyginkite ištrauktus duomenis su tuo, ką matote duomenų šaltinyje. Sužinokite daugiau apie visų SimApi funkcijų testavimą ir patvirtinimą 7.13 versijoje.

Pašalinkite „SimApi“ problemas naudodami „SimApi“ žurnalą file

• Jei serveris nepasileidžia, SimApi neveikia taip, kaip tikėtasi arba nepavyksta išskleisti, turite peržiūrėti SimApi žurnalą file kuri jums pasakys, kokia yra problema. Įjunkite derinimo lygio registravimą SimApi žurnale, kad gautumėte išsamią informaciją. Žr. 4.2.
• Pastaba: SIMCA internetinio serverio žurnalai čia nėra tokie naudingi. Jie parodys, kaip serveris įkėlė ir inicijavo SimApi, tačiau konkrečios SimApi detalės yra jo žurnale file.

Use the right SIMCA-online service account

• When you are testing access to the data source, remember that you are logged in as a specific user on the server computer (typically your own user account in a Windows domain), but that the SIMCA-online server service account is a different account, by default LocalSystem, which has different access rights compared to your user account.
• For this reason, it is not uncommon that tests work when run as your account, but that SIMCA-online fails to connect to the data source.
• To solve this issue, access must be granted for the account used by the SIMCA-online server service. Typically, you change LocalSystem to a specific domain service account, and grant rights to this account. Note that this does not apply if the SimApi uses credentials that are set in the SimApi configuration because these credentials take precedence.

SimApis techninė informacija

• This chapter gives technical details on how a SimApi works. It is mainly aimed at developers that want to understand SimApis to implement a SimApi for a data source.
• Developers should also read the earlier parts of this document for an introduction to SimApis and to the high-level descriptions of features.

When to consider developing a SimApi and when not to?

Before considering developing a SimApi for a data source:

1. Investigate if there already is a SimApi that you can use. Perhaps you can enable some feature in your data source to use one of the existing SimApis, such as OPC UA.
2. Carefully go through this document and its references and investigate if your data source fulfills requirements: for example, jis turi būti pakankamai greitas, pateikti ne tik dabartinius, bet ir istorinius duomenis.

• For these reasons, we don’t recommend developing a SimApi that connects to low-level hardware or instruments. It is better to connect those instruments to a process historian such as Aveva PI System, and let it obtain data from the instrument, and historize it. Then the PIAF SimApi can be used to obtain data from PI to the Umetrics product.

SimApi development and the SimApi specification

• The SimApi specification, SimApi-v2, contains documentation for all C-functions in the SimApi that a SimApi DLL needs to implement as well as some guidance for how to develop a SimApi.
• Implementing a SimApi using C or C++ is in most cases at an unnecessarily low level.
• The recommended, and easier, way to implement a SimApi is to base it on the ExampleSimApi šaltinio kodas, kurį pateikiame. Tai buvęsample SimApi implementation that handles the C-interface and translates it into.NET Framework where the actual implementation is made. It also has framework code for logging, settings, configuration GUI, and other framework code.
• To develop a SimApi, the team of developers needs experience in Windows development, .NET Framework, C, or C++. Good knowledge of the data source that the SimApi should connect to is also required, because the purpose of a SimApi is to translate data requests from SIMCA-online or SIMCA to the API of the data source. A SimApi implementation is never a one-off project, but typically needs ongoing support and occasional maintenance.

Reading or writing data

• A SimApi has the main task of providing data from a data source. This is referred to as reading data.
• Most SimApi implementations also support writing data. This means writing back data through the SimApi to the data source. Writing data is an optional feature in SIMCA-online.

Tags ir Mazgai

• A tag yra duomenų šaltinio stulpelio arba „kintamojo“ identifikatorius. A tag’s name is used to identify the tag. Vardai mazge turi būti unikalūs. SIMCA-online 18 yra pirmoji versija, palaikanti mazgą, kuriame yra pomazgas ir tag tuo pačiu vardu. Pavyzdžiui,ample: mazgas Parent gali turėti antrinį mazgą pavadinimu Batch ir a tag vadinamas Partija.
• Mazgas yra konteineris tags. Mazge taip pat gali būti kitų mazgų, panašiai kaip a file system has folders in folders.
• Like in a file sistema, mazgas ir tag pavadinimai gali būti sujungti į visą kelią, kuris unikaliai identifikuoja a tag. The tag renkantis naudojami SIMCA-online arba SIMCA keliai tags naudoti. A tag kelias prasideda SimApi egzemplioriaus pavadinimu, po kurio seka mazgo struktūra ir baigiasi tag pavadinimas, kiekvienas elementas atskirtas dvitaškiu (:). Pavyzdžiui,ample “:ODBCSQLServer:Node:SensorTag1”.

The SimApi enumerates tags ir mazgai paleidžiant

• „SimApi“ diegimas naršo serveryje, ieškodamas mazgų ir tags duomenų šaltinyje, kai inicijuojamas SimApi, ir seka juos, kad įvairios SimApi funkcijos, naudojamos surašyti tags and node can be implemented.
• SimApi initialization does not happen just at startup of the server but can also be re-triggered by a user in SIMCA-online with the Refresh SimApi functionality.

Case sensitivity of tag- ir mazgų pavadinimai

• Tag names and node names are case sensitive.
• Taigi, a tag vadinamas "tag1“ nėra tas pats kaip „Tag1“ dėl skirtingo „T“ raidės. Rekomenduojame nenaudoti tags arba mazgų pavadinimai, kurie skiriasi tik tuo atveju.

Continuous process node 

• Kai mazge yra tags su nuolatiniais proceso duomenimis, jis gali būti vadinamas proceso mazgu. Šios dvi ekrano kopijos rodo proceso mazgo lentelę su duomenimis, po kurių yra paveikslėlis, rodantis, kaip mazgas atrodo pasirenkant tags SIMCA tinkle.

Continuous process nodes must be independent of batches, runs, or time

• To work well in a SimApi a node must be independent of batches, runs, or time. Having a node that contains data for a specific batch or time range would not work well in SIMCA-online because the project configuration then could only read data for that batch and not be used for other batches.
• Instead, a node should be mapped to one or more physical units in the process where measurements are performed.

Partijos ID tag reikalingas nuolatinio proceso mazguose paketiniam projektui vykdyti

• Kiekvienas nuolatinis procesas turi turėti a tag (variable) holding the batch identifier for each observation. This batch identifier is used by SIMCA or SIMCA-online to know to which batch each observation belongs.
• The $BatchID tag 7.4.3 ekrano kopijose yra toks buvęsample.
  While not required, it is recommended to have a tag proceso mazge, kuris rodo esamą proceso fazę arba žingsnį. Tai tag Tada galima naudoti fazės vykdymo sąlygomis SIMCA-online arba SIMCA, kai importuojami duomenys. Vertybės tam tag gali būti pvzamp„1 fazė“, „valymas“, „2 fazė“.

Batch context node

• Paketinis mazgas yra mazgas, kuris seka paketus; jų partijos identifikatorius, pradžios ir pabaigos laikus. Tai yra paketinio projekto vykdymo SIMCA-online reikalavimas. Duomenų šaltinis gali turėti daugiau nei vieną paketinį mazgą, kuris įvairiais būdais parodo paketus. Vartotojas pasirenka paketinį mazgą, kuris taikomas jo programai. Šis buvęsample atskleidžia partijas, kurios apima du skirtingus vienetus:
• /Factory1 –batches with aggregated lifetimes over both Unit1 and Unit2.
• /Factory1/Unit1 – batches with lifetimes in Unit1 only
• /Factory1/Unit2 – batches with lifetimes in Unit2 only
• Jei duomenų šaltinyje nėra paketinio mazgo, SIMCA-online galite naudoti paketinio konteksto generatorių. Žr. integruotą žinyną.
• Optional batch data
• Paketiniame mazge taip pat gali būti paketinių duomenų; duomenys, kurių visoje partijoje yra tik vienas stebėjimas. Atkreipkite dėmesį, kad tags su paketiniais duomenimis nebūtinai turi būti mazge, kuris turi visas paketinio mazgo funkcijas. Pakanka, kad „SimApi“ palaiko paketinių duomenų nuskaitymą tags. Learn more on batch data in 7.6.
• Čia yra buvęsamppaketinio mazgo le:
• Pastaba: aukščiau pateikta ekrano kopija paimta iš DBMaker, kartu su SIMCA-online. Norėdami patys tai pamatyti DBMaker, spustelėkite View Duomenų mygtukas Bakers Yeast duomenų bazėje, kad būtų rodomi du langai, vienas iš kurių yra partijos mazgas, o kitas – proceso duomenys.

Data types: numerical data, text data, and missing data

• Kiekvienam tag, a SimApi can support three types of data: numerical, tex,t and missing:
• Numerical data are typically real values of process parameters, for example 6.5123. The SimApi can only handle 32-bit single precision floating point values. Single-precision floating-point format -Wikipedia. All other numerical data types in a data source should be converted to float. As such, they can deal with both large and small values but with only about 6 or 7 significant digits. Learn more in the Technical Guide.
• This can lead to loss of precision for large integers or for real numbers that are both large and have decimals. For more information, see the Technical Guide.
• Text/string data are used for batch IDs, phase execution conditions or for qualitative variables. The values for text tag data are case sensitive. This means that the value “running” is not the same as
  “RUNNING”. Datetime variables are not supported directly by the SimApi, but they can be returned as a string formatted as YY-MM-DD HH:MM (for example “2020-09-07 13:45”).
• Missing values means there is no value to return, i.e., no data.
• Kokio tipo grąžinama, priklauso nuo „SimApi“ diegimo. „SimApi“ žino apie duomenis duomenų šaltinyje ir turėtų pateikti tinkamiausią duomenų tipą.

Three modes of data retrieval: Continuous, Batc,h and Discrete

• The SimApi specification defines three modes of retrieval for data, i.e,. three different ways the SimApi can provide data from tags duomenų šaltinyje (arba kita kryptimi: įrašykite duomenis į tags duomenų šaltinyje).
• Continuous data retrieval – this refers to data read continuously, and sequentially, observation per observation as the batch or process evolves. Data is read for the current time, or for a specific range, at a regular interval between observations. For example, visi duomenys nuo 09:00:00 iki 10:00:00 sampled every 60 seconds, resulting in 61 observations when end points are inclusive.
• Batch data retrieval – this refers to a single observation with data for an entire batch (not associated with a specific maturity or time point). Batch attributes and local centering data are read as batch data in SIMCA-online. Batch conditions are normally read as batch data too (unless they are configured for discrete data retrieval).
• Discrete data retrieval – discrete data can consist of several observations for many maturities. But unlike continuous data, discrete data is not read sequentially but rather all data at once for a specific phase of a batch. Data need not be spaced with regular intervals of the maturity variable. All data is re-read each time the data is requested, at the configured interval.
• Už bet kokį duotą tag duomenų galima prašyti bet kuriuo iš trijų režimų, tačiau paprastai SimApi palaikys tik vieną iš šių režimų asmeniui. tag. Taip pat leidžiama maišyti tags mazge, bet paprastai visi tags konkrečiame mazge palaiko tą patį duomenų gavimo režimą.
• Ištisiniams duomenims (bet ne paketiniams arba atskiriems duomenims2) galima pateikti užklausas dabartiniams arba istoriniams duomenims, kurie yra kito skyriaus tema.
• Ne visos SimApis palaiko visus režimus. Žr. aukščiau esančią funkcijų matricą ir SimApi web puslapyje, kur rasite daugiau informacijos.

Current and Historical continuous data through a SimApi

• Nuolatiniai duomenys reiškia apdorotus duomenis, kurie laikui bėgant kinta.

Dabartiniai duomenys

• Dabartinių duomenų skaitymas reiškia, kad duomenų šaltinio reikia prašyti naujausių reikšmių tags klausimo metu. Atkreipkite dėmesį, kad čia nenaudojamas išorinio duomenų šaltinio laikas.
• Duomenys, nuskaityti kaip dabartiniai duomenys, yra tai, ką SIMCA-online rodys kaip tiesioginius duomenis. Dėl šios priežasties svarbu, kad duomenų šaltinyje nebūtų nereikalingų delsų. Dabartiniai duomenys turi būti kuo naujesni, kad gerai veiktų SIMCA-online.
• Duomenų šaltinis gali pasinaudoti žiniomis apie duomenis ir tai, kiek laiko reikšmės galioja, ir nuspręsti grąžinti trūkstamus duomenis, kai neapdoroti tam tikro laiko duomenys yra per seni. Pavyzdžiui,ample: duomenų prašoma 15:00:00, bet naujausias duomenų taškas duomenų šaltinyje yra nuo 03:00:00. Šiuo atveju duomenys yra 12 valandų senumo, todėl SimApi gali nuspręsti grąžinti trūkstamą reikšmę (nėra duomenų).

Istoriniai duomenys

• Istorinių duomenų skaitymas reiškia, kad duomenų šaltinio reikia prašyti vienos ar kelių verčių tags for a specific time range with a specific interval between observations. Notice that here it is the data source’s local time that is used to find the data. Therefore, time synchronization between data source and servers is important.
• Istorinius duomenis sudaro duomenų matrica. „SimApi“ diegimas turi reikalauti duomenų iš duomenų šaltinio, o sampLeiskite jį nurodytu intervalu ir sukurkite grąžinamų duomenų matricą:
• Sometimes the data source itself has aggregation functions to return processed data, or sampling funkcijos, kurias galima naudoti norint grąžinti reikiamus duomenis.
• For other data sources, the SimApi must request all data in the time range and then sample teisingus pastebėjimus matricai sudaryti.
• Data must be returned for a time range, even though there might not be raw data in the time range, but only just before the start time. For example: data exists in the data source at time points 10 and 20. The SimApi requests data for time 15 and 17. In this case, the values for timepoint 10 should be returned by the SimApi but timestamp15 ir 17 laikas, nes tai buvo naujausi duomenų taškai tuo metu. Vertės, skirtos tags 10 momentu yra nurodytos reikalaujamo diapazono ribinės vertės. Norėdami išsamiau paaiškinti ribines vertes, žr. pvzample the documentation for returnBounds at UA Part 11: Historical Access – 6.4.3 ReadRawModifiedDetails structure
  (opcfoundation.org)
• Interpolation should never be used to calculate values for future time points, because data will not match what is read in real time as current data. For the example from the previous bullet: if data for 15 and 17 were to be interpolated using the values for item 10 and 20, they would effectively use values from the future, which is not allowed..
• Duomenų šaltinis gali naudotis žiniomis apie duomenis ir tai, kiek laiko reikšmės galioja, ir nuspręsti grąžinti trūkstamus duomenis, kai neapdoroti tam tikro laiko duomenys yra pasenę. Pavyzdžiui,ample: data is requested for 15:00:00 but the most recent data point in the data source is from 03:00:00. In this case, the data is 12 hours old so the SimApi may decide to return missing value (no data).

Pastaba: SIMCA-online typically does not request more than one hundred observations in one call during normal project execution. When doing extract in SIMCA-online, or when running desktop SIMCA, larger requests of data can be made. These can take a long time, which is to be expected.

Current data and historical data must match

• Kartais gali būti skirtumų, kai duomenys skaitomi kaip dabartiniai realaus laiko arba istoriniai duomenys. Tai sukelia SIMCA-online problemų, nes serveris automatiškai perjungia esamus ir istorinius duomenis pagal poreikį.

Low latency data acquisition

• Kai SIMCA-online duomenų šaltinį naudoja realiuoju laiku, svarbu, kad duomenų šaltinio duomenys būtų naujausi. Duomenų rinkimas duomenų šaltinyje neturėtų būti nereikalingas. Nepertraukiamo proceso duomenys apie visus kintamuosius turi būti prieinami tuo pačiu metu kiekvienam stebėjimui. Kai kurių kintamųjų duomenų, kurie pateikiami pavėluotai, SIMCA-online nepriims.

Data can be read for any time 

• Kai SIMCA-online prašo įvesti a reikšmę tag for time t it will receive the value from the data source from time t, or the latest observation in the data source before time t, or an interpolated value for time t. Thus, the server will always get a value at each time it asks for, even though an observation for this exact time point might not exist in the data source.
• Laikuamps SimApi visada yra UTC. SIMCA internetiniai klientai ir SIMCA pateikia laiką kaip vietos laiką.

Sriegimas 

• The SimApi is, by default, called by a single thread by the user of the SimApi. This is true for all SIMCA versions and SIMCA-online up until version 17.
• SIMCA-online 18 supports a feature flag to turn on multi-threaded access through SimApi. Read more in the help topic Concurrent SimApi access.
• This means that SimApis should prepare for multi-threading, if possible, by making the SimApi implementation thread safe, and document this and any considerations for users of the SimApi.

Žurnalas file

• „SimApi“ savo žurnale turėtų registruoti veiksmus, klaidų pranešimus ir įspėjimus file to help troubleshooting. Use the different log levels to signify the importance of the logging.
• It is recommended to log “Not implemented” for features that have not been implemented in a SimApi.

Klaidų tvarkymas

• Kai SimApi negali įvykdyti užklausos iš duomenų šaltinio, ji gali išspręsti šią problemą vienu iš dviejų būdų; grąžinant trūkstamas reikšmes (nėra duomenų) arba pranešant apie SimApi klaidą:
• Returning missing values to the caller and signaling success allows the caller to continue as normal (but of course without any data). This is a recommended practice for partial errors such as when data could be obtained for some, but not all, tags prašyme.
• Signaling a SimApi error allows the caller (for exampSIMCA internetiniame serveryje), kad tai iš karto pamatytumėte ir imtųsi veiksmų. Tai rekomenduojama užklausoms, kurios visiškai nepavyksta ir negali grąžinti jokių duomenų.
• SIMCA-online kitaip apdoroja trūkstamas reikšmes arba klaidų kodus, kaip aprašyta SIMCA-online techniniame vadove.

SimApi performance requirements

• The functions in the SimApi are used to obtain data.
• If data access is slow, the SimApi will not work well which this example shows: If SIMCA-online requests data every second, but it takes two seconds to obtain, the SIMCA-online server will never be able to keep up in real-time but progressively fall further and further behind.
• Poskyriuose parodysime, kaip SIMCA ir SIMCA-online naudoja duomenų prieigos SimApi funkcijas ir kaip dažnai bus iškviečiamos SimApi funkcijos. Tai gali padėti nustatyti „SimApi“ diegimo našumo reikalavimus.

SIMCA’s usage of SimApi functions

• Kai staliniams kompiuteriams skirta SIMCA ar kiti neprisijungus naudojami produktai naudoja SimApi duomenims gauti, šios užklausos bus skirtos paketams ir apdorotų kintamųjų rinkinio duomenis tam tikru laikotarpiu.
• Kadangi šias užklausas vartotojas inicijuoja rankiniu būdu, jos nevyksta labai dažnai ir neapkrauna duomenų šaltinio.
• Šios SimApi funkcijos naudojamos duomenims gauti:
• simapi2_nodeGetActiveBatches
• simapi2_nodeGetBatchTimes
• simapi2_connectionReadHistoricalDataEx

SIMCA-online’s usage of SimApi functions

• SIMCA-online naudojama proceso stebėjimui realiuoju laiku, todėl reguliariai prašo duomenų per SimApi. Trumpiausias vykdymo intervalas, kurį galima naudoti, yra 1 sekundė. Kažkoks realaus pasaulio buvęsampMažesni vykdymo intervalai yra 10 s, 1 minutė arba 10 minučių.
• Serveryje vienu metu gali veikti daug projektų.
• To reduce the number of API calls through the SimApi, the server optimizes data requests by grouping many concurrent smaller requests into a single larger request for all variables at the same time (learn more in the help topic ‘Optimized reading from data sources improves performance’).
• Serverio vykdymo algoritmas veikia taip, kai jis prašo duomenų, naudodamas toliau nurodytas SimApi funkcijas:
• All phases that execute at the same interval are grouped into a single SimApi call to reduce the number of calls. The server reads the latest data for all variables used by all models that share the interval, i.e., this call will result in a wide data row which then is used by all projects.
  • simapi2_connectionReadCurrentData
• For each batch project the server also needs to know which batches are active. This also needs to happen each time a project executes:
  • simapi2_nodeGetActiveBatches
  • simapi2_nodeGetBatchTimes is called less frequently.
• In addition, SIMCA-online also requires historical data. These requests happen only when needed, such as catch up the beginning of a batch that started before SIMCA-online was started, or when the server is falling behind and needs to read a block of data:
  • simapi2_connectionReadHistoricalDataEx
• Optionally, some project configuration use features that use batch data or discrete data which results in SimApi calls to:
  • simapi2_connectionReadBatchData
  • simapi2_connectionReadDiscreteEx
• Optionally, some project configuration use write-back to push data back to the data source:
  • simapi2_connectionWriteHistoricalDataEx (and corresponding functions for batch data, discrete data)
• It is important that each call to the core functions for getting data, readCurrentData, getActiveBatches/getBatchTimes, is fast and that is not computationally hard for the  data source itself, given how often SIMCA-online may call those functions.

Testing and validating SimApi data

• Šiame skyriuje aprašomas „SimApi“ bandymas, siekiant patikrinti, ar iš jo grąžinti duomenys atitinka duomenis pačiame duomenų šaltinyje. Tokių testų vykdymas yra svarbus sukūrus ar pakeitus „SimApi“ diegimą arba pasikeitus duomenų šaltinio API.
• Praktiškai duomenų patvirtinimas atliekamas naudojant SIMCA-online ir jos išskleidimo funkciją, kad duomenys būtų paimti iš duomenų šaltinio per SimApi ir tada lyginami su neapdorotais duomenų šaltinio duomenimis. Darbalaukio SIMCA negalima naudoti SimApi realaus laiko aspektams išbandyti.

Preparations and requirements

• Kai kurie elementai yra neprivalomi, tačiau juos galima atlikti, jei į jūsų testavimo sritį įeina:

1. Install SIMCA-online as described in ReadMe and Installation Guide.pdf that comes in the product zip.
2. Obtain a license for the SIMCA-online server it and install it. The SimApi won’t work without a license. The knowledge base article for SIMCA-online shows how to license the product. For example: SIMCA-online 18 (sartorius.com)
3. Install and configure the SimApi you want to test. Refer to chapters 4 – 5 in this document and the user guide of the specific SimApi.
   • a. Optional: make sure the user guide is up-to-date and correct.
4. Make sure you have a tool for your data source which you can use to compare the SimApi data with.
5. In the SIMCA-online desktop client, log in to your SIMCA-online server and use File > Išskleiskite, kad gautumėte duomenis per SimApi.
6. Optional if your testing scope includes it: after finishing testing, uninstall the SimApi and verify its files yra pašalinami.

What to test

• Funkcijų matricoje 3 skyriuje pateikiamos visos galimos funkcijos, tačiau tam tikras SimApi diegimas gali palaikyti tik poaibį. Turėtumėte išbandyti visas funkcijas, kurias įdiegė nurodyta SimApi.
• Šie testai yra bendri daugumai „SimApi“ diegimų:
• Authentication with usernames and passwords
• Test the various settings in the configuration of the SimApi
• Node hierarchy: The nodes and tags yra teisingi.
  • There must be a tag rodomi visiems „kintamiesiems“, kurie turėtų būti pasiekiami naudojant „SimApi“. Pvzamples: proceso matavimai, skaičiuojamos reikšmės, konstantos.
• Connection resiliency: if the data source is unavailable this results in warnings or errors in the log file, bet ryšys su duomenų šaltiniu atkuriamas automatiškai, kai duomenų šaltinis yra pasiekiamas.
• Multiple instances: that two instances can be configured and used independently and simultaneously, with separate logs files.
• Current data: extract current data for tags. Make sure data is the last known values from the data source, or missing for bad quality or when data is too old.
  • Extract data every 10 seconds (or so) for a minute.
• Historical continuous data: extract historical data for tags.
  • Use the time range that matches when you extracted current data. Verify that current data matches historical data, and the raw data in the data source.
  • Try different time ranges and sampling intervals, verify the data matches the data source.
  • Try extracting data every 1 s, which is the shortest possible samplingo intervalas.
  • Try various type of tags in the data source (process variables, etc.), making sure data matches.
  • Note: SIMCA-online may split a single large historical data request into several smaller chunks. This will be visible in the SimApi log.
• Verify that the SimApi works with text data, numeric data, and missing data.
• SimApi log file. Verify that the log contains reasonable entries.
• Batch node: right-click a node and do Find batches.
  • Verify batch names, start times, end times for batches.
  • Try an active batch that is running in data source. It should not have an end time through the SimApi.
• Process node batch identifier tag. If the SimApi has batch node functionality (see previous bullet), it must also have a batch identifier tag atitikimo proceso duomenų mazge. Duomenys tam tag turėtų būti partijos identifikatorius (partijos pavadinimas). Šie duomenys reikalingi paketiniams projektams nustatyti, kuriai paketai priklauso duomenų eilutė.

Priklausomai nuo to, ar SimApi jį palaiko, galbūt norėsite išbandyti:

• Batch data using File > Extract.
• Discrete data using File > Ištrauka. Pastaba: norėdami patikrinti atskirus duomenis su File > Extract the node, the batch node and discrete data node must be in the same SimApi (when SIMCA-online executes projects, they can be from different SimApis).
• Write back – pushing data batch to the data source. To test this, you must configure a project configuration in SIMCA-online to write back data vectors to the data source. Then execute the project in SIMCA-online and check the data that is written back in the data source.
• Continuous data is configured on the Evolution Write Back page in the project configuration.
• Discrete data is configured on the same page, but only for a phase configured for discrete data retrieval.
• Batch data from the Batch Write back

DAUGIAU INFORMACIJOS

• Sartorius Stedim Data Analytics AB Östra Strandgatan 24 903 33 Umeå Švedija
• Telefonas: + 46 90-18 48 00
• www.sartorius.com
• Šiose instrukcijose esanti informacija ir skaičiai atitinka toliau nurodytą versijos datą.
• Sartorius pasilieka teisę be įspėjimo keisti įrangos technologiją, savybes, specifikacijas ir dizainą. Vyriškos arba moteriškos giminės formos naudojamos siekiant palengvinti šių nurodymų įskaitymą ir visada vienu metu žymi visas lytis.
  Autorių teisių pranešimas:
• Šios instrukcijos, įskaitant visus komponentus, yra saugomos autorių teisių.
• Bet koks naudojimas, viršijantis autorių teisių įstatymo ribas, neleidžiamas be mūsų sutikimo.
• Tai visų pirma taikoma pakartotiniam spausdinimui, vertimui ir redagavimui, neatsižvelgiant į naudojamos laikmenos tipą.

DUK

• K: Koks yra SimApis tikslas?
  • A: The main purpose of SimApis is to provide data to Umetrics Suite products for project creation and model building.
• Kl.: Kaip pašalinti „SimApi“ diegimo triktis?
  • A: You can troubleshoot by testing from SIMCA-online, checking the SimApi log file, and ensuring the correct service account configuration.

Dokumentai / Ištekliai

SARTORIUS Sim Api programinė įranga [pdfVartotojo vadovas „Sim Api“ programinė įranga, „Api“ programinė įranga, programinė įranga

Nuorodos

• Vartotojo vadovas