📘

Note

Previous generation C# calculation applications and APIs are continued to support. Find instructions from %APP_ROOT%\Calculations after installing History.

Introduction

Calculations are engineered in web browser based tool that is part of the ABB Ability™ History Engineering UI. Calculations are constructed from the code modules, data mappings, and scheduling definitions. While the Calcuations are configured in the client side web browser, the Calculations and data mappings are executed at the server side by Calc Engine service.

Calculation modules contain the actual logic. Calculation modules are connected to the data with parameter mappings that allow reusing the same calculation module with multiple data sets and multiple triggering methods.

Features

• Calculation tool is particularly designed for time series data, but can handle also other types of data
• Variable and Equipment model based calculations
• Mapping calculations to data
• Time periodical history calculations
• Batch calculations
• Event trigger based calculations
  • Execute when an instance of a class is created
  • Execute when the current value of a variable changes
  • Execute when the current value of an equipment property changes
• Task-based triggers
  • Execute calculation after another calculation has finished
• Browser-based code editor
  • Auto-completion using IntelliSense
  • Calculation code written in C#
• Diagnostics to monitor calculation execution and resource consumption

Structure

Getting started

• Calculation Tool tutorial - If you're new to the Calculation Tool, you should start from the tutorial. It'll teach you how to use the Calculation Tool in practice.
• Concepts - This page provides a bit more theoretical look at the concepts of the Calculation Tool. It is recommended to read this page after doing the tutorial.
• Creating calculation in Engineering UI - Provides detailed guide on how to create a new calculation in our Engineering UI.

Setting up

• Calculation Tool installation - If you're configuring the Calculation Tool on a production system, you should follow the instructions on this page.
• Calculation Tool configuration - This page contains a reference of the Calculation Tool configuration options.
• Calculation Tool security - In order to create a secure production environment, you should familiarize yourself with the concepts on this page.

Working with the Calculation Tool

• Calculation Tool API - Contains the reference documentation for the Calculation Tool C# API.
• Troubleshooting - If you encounter errors, you may find help from this page.

Deepening your understanding

• Under the hood - This section discusses more advanced topics and gets into more detail about the inner workings of the Calculation Tool.
• Calc service and processes - Two entities that are important for the operation of the Calculation Tool, CalcService and CalcProcess, are discussed on this page.
• Calculation Tool classes - This page contains the reference documentation for the Calculation Tool database classes. These classes can be used to configure and operate the Calculation Tool.