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 develops SimApis for many different data sources, such as process historians and general purpose databases. There are also SimApis offered by partners and other companies.
This page lists available SimApis, provides user guides and download links, and explains features in SimApis. Consult the feature matrix below to learn more about SimApi functionality and also limitations in functionality for some SimApis. Use the download links below to obtain the SimApis, free of charge.
The Sartorius Stedim Data Analytics Batch Table Wrapper SimApi can be used to generate a batch node from process data in a system where batch information is otherwise not available. This makes it possible to execute batch projects in SIMCA®-online. Batch Table Wrapper can also make batch identifiers unique to SIMCA®-online by modifying data from an existing batch node.
The Sartorius Stedim Data Analytics CSV SimApi reads the most recent data from text files with comma separated values (CSV).
This SimApi is not available to purchase. Please contact Sartorius Stedim Data Analytics directly to obtain it.
The OSIsoft PI interface connects to to an OSIsoft PI Server, specifically the PI Data Archive. The interface can connect to both the PI Batch Database and the PI Asset Framework (AF). Read more at the OSIsoft Partner Solutions Showcase.
This interface is offered by OSIsoft who in their terminology refers to it as the PI interface for SIMCA®-online or SimBatchOL, with part number PI-IN-SIM-BO-NT.
2017-09-30: OSIsoft will continue supporting this interface but will stop selling it. Customers should instead use the Sartorius Stedim Data Analytics PI AF SimApi (see above)
The Sartorius Stedim Data Analytics PI AF SimApi connects to an OSIsoft PI Server, specifically the PI Data Archive and the PI AF (Asset Framework) Server.
This SimApi is built by and fully supported by Sartorius Stedim Data Analytics unlike the OSIsoft PI SimApi described in the next section.
The Optimal SynTQ SimApi connects to a SynTQ system and permits the extraction of data from a SynTQ database. The SimApi allows historical data to be retrieved for analysis and also allows current data to be obtained from a running orchestration. It is not possible to write data to the SynTQ database.
The SynTQ SimApi is available directly from Optimal. Please contact contact Optimal for further details.
Not all data sources are alike. A SimApi need not implement all functions in the specification. For these reasons, different SimApis offer different functionality. The following matrix lists available SimApis and their features.
The table below the matrix explains the features. Notice that the table has separate columns to show which features are available in SIMCA®-online and SIMCA® respectively.
Read the most current value from the data source.
Real-time normal execution
Read historical data from the data source.
Catch-up and repredict of past data, create projects using File > New
Database Import Wizard to import process data for model creation.
Read laboratory/IPC data from the data source. Discrete data can be used for batch configurations when data needs to be re-read during the batch evolution. Many observations per batch.
For batch projects with phases configured for discrete data retrieval.
Read batch conditions and final quality attributes (or other MES type data). One observation per batch
Batch conditions or local centering.
Database Import Wizard to read batch conditions for batch level model creation.
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.
Required for execution of batch configurations.
Database Import Wizard to select batches to import.
Write back - continuous data
Write discrete data, such as predictions, back to the data source
Write back for batch configurations for the batch evolution level or for continuous configurations
Write back - discrete
Write discrete data, such as predictions, back to the data source.
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
The SimApi supports a hierarchy of nodes, similarly to a file system. Each node can contain tags and other nodes. The hierarchy makes is easier to manage a large number of nodes and tags.
Supported in all places where tags are used.
Array tag expansion
An array tag stores multiple values. The SimApi expands the array tag to many individual tags, one for each value in the array.
Supported where tags are used for continuous data.
Multiple data sources
The SimApi can connect to more than a single data source, or supports multiple instances of itself with individual settings and log files for each instance.
Connect to several different data sources of the same kind. See
If the SimApi becomes disconnected from the data source, it will try to reestablish the connection.
The SIMCA®-online server doesn't have to be restarted to reestablish connections to the data source.
The SimApi is developed, provided and supported by Sartorius Stedim Data Analytics
SimApi usage in SIMCA® and SIMCA®-online
SIMCA® can use a SimApi to retrieve data for project creation and model building as the following picture illustrates.
SIMCA®-online use SimApis to obtain data in real-time for monitoring and control, as well as write-back of data to the data source. The following picture shows where the SimApi is located in a system consisting of a data source, SIMCA®-online server, and clients
The Sartorius Stedim Data Analytics online support team answers technical questions about SimApis, and can also forward requests for enhancement of SimApis to the appropriate people.
To learn more about the inner workings of SimApis, see the SIMCA®-online Technical Guide.
The SimApi specification for developers and a software development kit with sample code can be obtained from The Sartorius Stedim Data Analytics by contacting your sales representative.