MKS Data Analytics Solutions SimApis

A SimApi is a software interface between MKS Data Analytics Solutions software and a data source. The primary purpose of a SimApi is to provide data to SIMCA-online and SIMCA from the data source.

MKS Data Analytics Solutions develops SimApis for many different data sources, such as process historians and general purpose databases.

The SimApi specification is public, so anyone can develop SimApis for data sources that MKS Data Analytics Solutions do not currently support. Learn more

Obtaining SimApis

Download MKS Data Analytics Solutions SimApis below. Refer to the feature matrix and the user guides to learn more about each SimApi

OPC HDA

The MKS Data Analytics Solutions HDA SimApi connects to a data source using the industry standard OPC HDA.

  OPC HDA User Guide
  OPC HDA 2.0.7 64 bit
  OPC HDA 2.0.7 32 bit

OPC DA

The MKS Data Analytics Solutions DA SimApi connects to a data source using the industry standard OPC DA.

  OPC DA User Guide
  OPC DA 2.0.8 64 bit
  OPC DA 2.0.8 32 bit

ODBC

The MKS Data Analytics Solutions ODBC SimApi connects to a SQL database with process data. The required database schema is described in the user guide.

  ODBC User Guide
  ODBC 2.1.3 64 bit
  ODBC 2.1.3 32 bit

IP21

The MKS Data Analytics Solutions IP21 SimApi connects to an AspenTech InfoPlus.21 data source.

  IP21 User Guide
  IP21 2.1.3 64 bit
  IP21 2.1.3 32 bit

IP21 Batch

The MKS Data Analytics Solutions IP21 Batch SimApi connects to an AspenTech InfoPlus.21 Batch Historian data source. Multiple batch historians are supported simultaneously.

  IP21 Batch User Guide
  IP21 Batch 2.1.1 64 bit
  IP21 Batch 2.1.1 32 bit

Discoverant

The MKS Data Analytics Solutions Discoverant Simapi connects to a Accelrys Discoverant data source.

  Discoverant User Guide
  Discoverant 2.1 64 bit
  Discoverant 2.1 32 bit

BioPAT® Spectro

The MKS Data Analytics Solutions-Sartorius BioPAT® Spectro SimApi connects to a BioPAT® Spectro NIR-online spectrometer. Contact Sartorius for more information.

This SimApi is not yet available for download. Contact MKS Data Analytics Solutions to obtain it.

Batch Table Wrapper

The MKS Data Analytics Solutions 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.

  Batch Table Wrapper User Guide
  Batch Table Wrapper 2.1.1 64 bit
  Batch Table Wrapper 2.1.1 32 bit

OPC/ODBC

The MKS Data Analytics Solutions OPC/ODBC SimApi is a combined SimApi that obtains current data from an OPC DA data source, historical data from OPC HDA and batch data from an ODBC data source.

This SimApi is supported, but new features will not be added. MKS Data Analytics Solutions recommend you use the individual SimApis OPC DA, OPC HDA and ODBC instead. One reason to keep using OPC/ODBC is if you need to be able to read the same tags from both DA and HDA. Note that OPC HDA supports reading current data so OPC DA is usually not needed.

  OPC/ODBC User Guide
  OPC/ODBC 2.0.4 64 bit
  OPC/ODBC 2.0.4 32 bit

CSV File Reader

The MKS Data Analytics Solutions CSV SimApi reads the most recent data from text files with comma separated values (CSV).

  CSV User Guide
  CSV 2.0.1 64 bit
  
CSV 2.0.1 32 bit

PI

The OSIsoft PI SimApi connects to an OSIsoft PI Server, specifically the PI Data Archive. The SimApi can connect to both the PI Batch Database and the PI Analysis Framework (AF). Read more at the OSIsoft Partner Solutions Showcase.

This SimApi 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.

Download documentation and view the latest technical news at OSIsoft (registration required). The installation kits for the SimApi must be obtained by contacting OSIsoft.

SIPAT

The Siemens SIPAT SimApi connects to a Siemens SIPAT data source.

This SimApi is provided by Siemens, please contact Siemens for further details.

SynTQ

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.

  SynTQ User Guide

Wonderware Historian

The MKS Data Analytics Solutions Wonderware Historian SimApi connects to a Wonderware Historian data source.

  Wonderware Historian SimApi User Guide
  Wonderware Historian SimApi 2.0.1 64 bit
  
Wonderware Historian SimApi 2.0.1 32 bit

 

Feature matrix

A SimApi need not implement all functions in the SimApi specification. For this reason, different SimApis offer different functionality. The following table lists all currently available SimApis and their features. The individual features are explained below the table.

Feature

Description

SIMCA-online usage

SIMCA usage

Current data

Read the most current value from the data source.

Real-time normal execution

 

Historical data

Read historical data from the data source.

Catch-up and repredict of past data

Database Import Wizard to import process data for model creation.

Discrete data

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.

Batch phases configured for discrete data retrieval.

 

Batch data

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.

Batch node

Read the start time and the end time (empty for active batches) 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 data for.

Write back - continuous data

Write continuous 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 for the batch level

 

Node hierarchy

The SimApi supports a hierarchical structure 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.

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 instances

The SimApi can handle multiple instances of itself with individual settings and log files for each instance.

Connect to several different data sources of the same kind. See http://www.umetrics.com/kb/multiple-instances-same-simapi-simca-online-server

 

Connection resiliency

If the SimApi becomes disconnected from the data source, it will try to reestablish the connection on the next call.

The SIMCA-online server doesn't have to be restarted to reestablish connections to the data source.

 

Developed by MKS DAS

The SimApi is developed, provided and supported by MKS Data Analytics Solutions

   

Note: As you can see above only a subset of the SimApi features are applicable to SIMCA, while SIMCA-online can use all features. 

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 used to obtain data from a data source through a SimApi (click for full size)

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.

A SIMCA-online installation with server, SimApi connecting to a data source, and clients (click for full size)

Learn more

To learn more about the inner workings of SimApis, see the SIMCA-online Technical Guide.

Umetrics online support team answers technical questions about SimApis, and can also forward requests for enhancement of SimApis to the appropriate people.

The SimApi specification for developers and a software development kit can be obtained from Umetrics by contacting Umetrics SIMCA-online support.

Login

For access to downloads you need an account. You will only need to create an account once.