G2 Optegrity
Version 5.1 Rev. 1
Readme


(August 2007)

Contents

What is Optegrity

Optegrity is an extensible software platform that delivers applications for abnormal condition management for the process manufacturing industry. Optegrity applications ensure sustained operational performance and continuous availability of production assets. Optegrity applications perform advanced detection of abnormal process conditions that left undetected can disrupt productivity and weaken product quality and profits.

Optegrity is a powerful application platform for OEMs, value-added-resellers (VARs), system integrators (SIs), and consultants. Combined with existing control systems, data historians, and databases, Optegrity applications work in real time to:

Optegrity consists of a broad set of capabilities for meeting the wide-ranging needs of Abnormal Condition Management, covering the whole life cycle of projects from modeling to validation and deployment. Optegrity monitors and evaluates, in real time, process conditions received from a DCS, provides advisory messages, extensive diagnostics, and root cause analysis capabilities. Fault models that leverage the reasoning over process maps reduce the number of operator alarms significantly and isolate the root cause(s) of problems.

Domain experts such as process engineers can graphically model and deploy the logic used to monitor, diagnose, and control the process conditions. Logging and replay capabilities enable domain experts to validate their logic before deployment or replay historical data for in depth analysis of specific situations. Optegrity also enables domain experts to build libraries of reusable intelligent process objects that include a generic formalization of event detection and fault models.

Optegrity is a client/server, multi-user environment, enabling multiple users to collaborate during the development and deployment phases of a project. Multiple operators can interact with the server simultaneously to monitor and diagnose in real time the state of the process condition.

System Requirements

To use Optegrity, you need:

Windows Operating Systems Considerations

Optegrity installation differs depending on the Windows operating system:

Enabling this option allows the user to run Optegrity without giving administrator privileges. You can now run Optegrity.

Known Issues

Information on bug fixes and known bugs is available separately as Technical Bulletins through HelpLink at www.gensym-support.com. For information on bugs in Optegrity Version 5.1 Rev. 1, choose Technical Bulletins for Optegrity, specify Starting From Version as 5.0 Rev. 0 and Ending At Version as
5.1 Alpha Rev. 0, choose the bugs and suggestions that either Remain Open or Were Fixed, then click Execute.

What's in this Release?

Optegrity is installed in the following directory, by default:

Optegrity contains the following directories and files in the installation directory. This table lists only those directories and files that you need to know about for building and running Optegrity applications.

Directory/File Description
optegrity

The top-level directory for all Optegrity KBs.

    archives

Directory in which you can store log file archives.

    bin

Batch files or shell scripts for starting Optegrity.

      InstallServerAsNTService.bat

On Windows platforms, installs the Optegrity server as an NT service. You can provide the same arguments that you provide to StartServer.bat.

      UninstallServerAsNTService.bat

On Windows platforms, installs the Optegrity server as an NT service.

    data

Sample .csv files for the f102demo.kb sample application.

    examples

f102demo.kb demonstrates the use of intelligent objects for out-of-the-box event detection on a heater. For a description of this application, see the Optegrity Heater Tutorial.

    kbs

Required KBs for running Optegrity.

      optegrity.kb

The top-level KB is optegrity.kb. The batch file or shell script that starts the server loads this KB at startup.

    logs

Directory in which you can store log files.

    projects

Directory in which user-defined projects are saved.

    resources

Text resource file for localizing

g2i

Top-level directory for Optegrity support KBs.

    readme-symcure.html

Readme file for SymCure.

    examples

Provides an example named cdg-modguide.kb, which contains two SymCure applications for fault diagnosis. For a description of one of these applications, see the SymCure User's Guide.

Provides example KBs for the various g2i modules.

    kbs

Support KBs for Optegrity.

      config.txt

Optegrity initialization file for setting configurable parameters at startup. For a description, see the Optegrity User's Guide.

doc

Top-level directory for all online documentation for the Optegrity bundle.

    optegrity

Subdirectory that contains Optegrity online documentation. For a description of each document and information on how to access them, see Online Documentation.

g2

Top-level directory for core G2 server and client executables.

    StartServer.bat

Batch file for starting the Optegrity server.

    twng.exe

Executable for the Telewindows Next Generation client.

Online Documentation

The Optegrity documentation is available in Windows HTML Help and PDF format. The typical installation directory is:

You can access both types of online documentation from the Windows Start menu by choosing:

You can also access the Windows HTML Help from within the Optegrity client from the Help menu.

Optegrity is bundled with the G2 Bundle, which means the complete G2 Bundle documentation is also available. For a description of the G2 Bundle documentation, see the readme-g2.html file.


Note: The Integrity documentation has been partially updated for Version 5.0 Rev. 0. However, the dialogs and figures have not been updated to reflect the new user interface. Updated documentation will be provided in a future release.

Windows HTML Help

You can access Optegrity online help by choosing Help > Help Topics from within the Optegrity client. You can also access Optegrity online help from the Start menu by choosing:

The Windows help files are located in the doc\optegrity\WinHelp directory.

The top-level help file is called Master.chm and includes these online books:

PDF Documentation

You must have the Adobe Acrobat Reader Version 4.0 or later to view the PDF files.


Note: Due to a display bug in earlier versions of Adobe Reader, we recommend that you use Adobe Acrobat Reader Version 5.05 or later for viewing PDF files.

The PDF documentation includes these files:

Directory/File Description
readme-optegrity.html

This readme file.

OptegrityHeaterTutorial.pdf

A description of the f102demo.kb demo, which provides a complete example of an Optegrity application that monitors abnormal conditions of an intelligent heater.

OptegrityUsersGuide.pdf

User's guide that describes how to use the Optegrity user interface to create applications.

GEDPUsersGuide.pdf

User's guide that describes how to configure and use each GEDP block to create event-detection diagrams.

SymCureUsersGuide.pdf

User's guide that describes how to create generic fault models that perform diagnostic reasoning for events.

readme-symcure.html

Readme file for SymCure.

To access online release notes:

To access online PDF documentation:

Examples

Optegrity provides this example:

Example Description
f102demo.kb

Provides an end-to-end example of abnormal condition management for a heater. For a description of this application, see the Optegrity Heater Tutorial.

To run the Optegrity tutorial:

Upgrading SymCure Applications

For information on upgrading SymCure applications, see readme-symcure.html.

Gensym Customer Support

If you need help with the installation, use Helplink or contact Gensym Customer Support:

 
Americas Europe, Middle-East, Africa (EMEA)

Phone

781-265-7301

+31-71-5682622

Email

service@gensym.com

service-ema@gensym.com