Bulk Configurator
User Guide
Invensys – SimSci-Esscor 5760 Fleet Street, Suite 100,
Carlsbad, CA 92008
Bulk Configurator User Guide Version 1.1
11-Feb-11The software described in this document is furnished under a written agreement and may be used only in accordance with the terms and conditions of the license agreement under which you obtained it. The technical documentation is being delivered to you AS IS and Invensys Systems, Inc. makes no warranty as to its accuracy or use. Any use of the technical documentation or the information contained therein is at the risk of the user. Documentation may include technical or other inaccuracies or typographical errors. Invensys Systems, Inc. reserves the right to make changes without prior notice.
Copyright Notice
©2011 Invensys Systems, Inc. All rights reserved. Invensys, Dynsim, SimSci-Esscor, ActiveFactory, ArchestrA, FoxDraw, FoxView, InFusion, I/A Series, and Wonderware are trademarks of Invensys plc, its subsidiaries and affiliates. Visual Fortran is a trademark of Intel Corporation. Windows 98, Windows ME, Windows NT, Windows 2000, Windows XP, Windows 2003 Server, Excel and MS-DOS are trademarks of Microsoft Corporation. Adobe, Acrobat, Exchange, and Reader are trademarks of Adobe Systems, Inc. All other products are trademarks of their respective companies.
No part of this publication and protected by this copyright may be reproduced or utilized in any form or by any means, electronic or mechanical without the written permission from Invensys Systems, Inc., including photocopying, recording, broadcasting, or by any information storage and retrieval system.
Table of Contents
Welcome to Bulk Configurator...5
Getting More Information...6
Glossary...7
Introduction to the Bulk Configurator...8
Checkout View (Tieback Simulation)... 8
Features... 8
Model Data View ... 8
Features... 8
Intended Audience ... 9
Additional Reading ... 10
Introduction to Tieback Simulation...11
Tieback Simulations...12
Important Simulation Concepts...16
Simulation Engines ... 16
Time Control and Synchronization... 17
Cross Referencing ... 17
Model Objects and Parameters ... 18
FSIM Engine Snapshots and Checkpoints ... 18
TRISIM Engine Snapshots ... 19
FSIM Engine with Multiple I/A Series Control Processors ... 19
TRISIM Engine Multiple PLC Simulation ... 20
Bulk Configurator...21
Launching the Bulk Configurator ... 21
Components of the Bulk Configurator... 22
Action Pane... 23
Bulk Configurator Toolbar ... 24
Checkout View (Tieback Simulation)... 25
Tieback Simulation using the Bulk Configurator: Workflow ... 25
Cross Reference and Model Worksheets... 27
Rulebook... 30
Import / Export Rules ... 33
Setting up a Rule – Simple Example... 34
Apply Rules ... 36
Model (Checkout) Worksheet... 39
Send to DSS... 43
Status Messages ... 44
Model Data View ... 45
Configure Model Data View ... 47
Rename Model Objects ... 50
Model Data View settings ... 51
Status Messages ... 56
Appendix A: Tieback Simulation Model Classes (Checkout View)...57
STATIC_DOUBLE ... 58 DYNAMIC_INTEGER... 60 STATIC_INTEGER... 61 LATCH... 62 AND, OR... 63 FCTGEN ... 64 RLIMIT ... 65 PID ... 70 SUM ... 73 TIMER ... 74 LEADLAG ... 78 MISCEQTN... 81
Custom for OTS Engineers ... 85
Appendix B: Using Regular Expressions with the Tieback Simulation (Checkout View)...86
Regular Expression ... 86
.NET Regular Expressions ... 86
Starter Syntax Examples ... 86
Search Syntax ... 87
Regex Replace ... 89
Examples specific to I/A Series and Triconex... 89
Regular Expression Basic Syntax Reference ... 91
Regular Expression Basic Syntax Reference ... 91
Welcome to Bulk Configurator
This User Guide provides an overview of use cases and configuration of the Bulk Configurator tool, an Excel® based application activated from within the Dynsim® Dynamic Simulation Suite environment to streamline the DCS and PLC control
validation process through dynamic simulation. The Bulk Configurator tool is an Excel spreadsheet front-end tool to provide a convenient, tabular way of entering
model/equipment data and is designed for control and instrumentation specialists primary working with FOXBORO I/A Series® software and TRICONEX® software. It can be extended to any DCS or PLC process requiring process control loop validation through dynamic I/O stimulation. This tool resides outside of the simulation environment and displays static configuration model parameters typically specified when building a process model.
Dynsim applicationis a process-modeling package that links instrument and control signals with a cross-reference database utility built into Dynsim’s Graphical User Interface (GUI). The Dynsim process model engine sends signals to and from DCS or PLC engines configured either directly through the Dynamic Simulation Suite interface (i.e., FSIM Plus® engine/ TRISIM Plus® engine/ other PLC-type engine) or through a bridge to a third party application.
If you are new to Dynsim application, FSIM Plusapplication, or TRISIM Plus application we suggest you review the relevant getting started guides to gain an understanding of basic simulation features and the Graphical User Interface:
• FSIM Plus Getting Started Guide (Foxboro I/A Series software)
• TRISIM Plus Getting Started Guide (Triconex TriStation 1131 software)
Getting More Information
The Bulk Configurator, FSIM Plus, TRISIM Plus, and Dynsim user guides are available on the product-specific installation CD.
Access FSIM Plus application, TRISIM Plus application, and Dynsim application specific documentation through a variety of means:
• Through the GUI, from the Help pulldown menu
• In PDF format where the software is installed
• From the IOM website Support tab: http://iom.invensys.com
Find additional SimSci-EsscorTM specific documentation, downloadable software, and software updates and patches at the SimSci-Esscor Electronic Software Download website: http://www2.simsci.com/sim4me/esd/login.asp
Glossary
API Application Programming Interface
Checkpoint File The Control Database that resides on the host
workstation and downloaded to the FCP270/ZCP270 or FSIM Station
CP I/A Series Control Processor
DCS Distributed Control System
DDM Dynsim Data Manager
DSS Dynamic Simulation Suite
GUI Graphical User Interface
HMI Human-Machine Interface
I/A Series Intelligent Automation Series
I/O Input/Output
IACC I/A Series Configuration Component
ICC Integrated Control Configurator
IEE InFusionTM Engineering Environment
IOM Invensys Operations Management
OEV Object Editor/Viewer
OTS Operator Training Simulator
PLC Programmable Control Logic
Regular Expression A parser that can search and manipulate text
based on patterns.
Snapshot An Initial Condition or Backtrack that contains a
picture of the state of a simulation engine at a specific point in time. For the FSIM Plus Engine, a picture of the Control Processor (CP) database memory. For the TRISIM Plus Engine, a text-based file that represents the state of the PT2 file’s objects and tags.
SSMU Snapshot Management Utility
UOM Unit of Measure
Introduction to the Bulk Configurator
The Bulk Configurator is an Excel based model configuration tool to provide a convenient, tabular way of entering model/equipment data. It supports two modes:
o Checkout View
o Model Data View
Checkout View (Tieback Simulation)
In Checkout View mode, the tool provides a mechanism to apply “rules” in order to automatically create model objects and tie them off to appropriate I/O points. The rules take advantage of I/O block naming conventions to specify the type of model to do the tieback (like a rate limit block to simulate the operation of a valve). The tieback-type rulebook was designed to rapidly configure low-fidelity, simple tieback models for control systems with thousands of I/O points, particularly when many typical control loops are repeated.
Features
1. Bulk Generate Models: Configure the Rulebook to generate tieback models based on I/O naming conventions.
2. Configure Cross Reference List: Manually or, through the Rulebook, automatically tie the cross reference data to the process model.
Model Data View
The Model Data View mode extends the tool to medium and high fidelity models. In Model Data View, model objects and their parameters display in tabular, customizable spreadsheet format that provide visualization and bulk parameterization capability. Bulk Configurator supports model objects from every available Dynsim engine, including Dynsim, Dynsim-P, Dynsim-C, and Dynsim-L engines.
Features
1. High, Medium, and Low Fidelity models: Supports parameterization of models generated for all available Dynsim-type engines, including:
• Dynsim engine
High-fidelity process modeling tool for oil and gas, refining, and chemical industries
• Dynsim-P engine
High-fidelity process modeling tool for power generation industry
• Dynsim-C engine
Medium-fidelity process modeling tool for control and safety system checkout and operator familiarization across
all industries
• Dynsim-L engine
Low-fidelity, “lite” base equipment modeling tool for simple tie-back modeling across all industries
2. Customize display parameter list for each model: Modify which parameters display in the Excel spreadsheet for each model.
3. Change Management: Optionally opens most recent spreadsheet or replaces spreadsheet with current process model.
4. Unit of Measure support: Customize UOM for individual model parameters from the Model sheet.
5. Refresh: Optionally update Bulk Configurator Spreadsheet with modified process model without closing or re-opening the Dynsim simulation file or Bulk
Configurator interface.
6. File Handling: The tool allows the user to create Excel files and associate them with the appropriate simulation. It supports saving (and opening) the Excel file in any folder location.
7. Link cells in spreadsheet or accept formula: Supports linking spreadsheet cells that represent parameters to cells in other spreadsheet tabs. Accepts Excel formula that is persistent when Dynsim data is imported. Handles equations present in the Dynsim OEV. Directly retrieve those equations into the Bulk Configurator
worksheet and send them back to the Dynsim application to the Dynsim equation placeholder for the parameters.
8. Display Dynamic and Snapshot data: Displays dynamic runtime model parameter values for the simulation in the Model sheet value column. Restore a snapshot and refresh Bulk Configurator to view model parameter values saved in a different simulation state.
9. Rename model objects: Optionally rename model objects from Model sheet. 10. Create Custom Parameters: Add, delete and edit custom model parameters
through “Configure Model Data View” window.
11. Configure Cross Reference List: Manually or, through the Checkout View Rulebook, automatically tie the cross reference data to the process model.
Intended Audience
This guide is intended for engineers (Application Engineers, Instrumentation and Control, or Process engineers) who have a high level of familiarity with Distributed Control Systems (DCS) or Programmable Logic Controllers (PLCs), and in particular Foxboro I/A Series and Triconex software (although the concepts apply to most control systems). Detailed knowledge of process simulation is not a pre-requisite to employ the tieback simulation Bulk Configurator.
Additional Reading
The following guides and user manuals are available for further reference:
• FSIM Plus Installation Guide
• FSIM Plus Getting Started Guide (tutorials to build basic process simulations and connect to I/A Series software)
• FSIM Plus User Guide (reference manual covering I/A Series simulation)
• TRISIM Plus Installation Guide
• TRSIM Plus Getting Started Guide (tutorials to build basic process simulations and connect to Triconex TriStation™ 1131 software)
• TRSIM Plus User Guide (reference manual covering I/A Series simulation)
• Dynamic Simulation Suite Users Guide (detailed information concerning DSS simulation features, as well as documentation for high-fidelity process modeling)
Introduction to Tieback Simulation
Tieback simulation is a method for testing process control system loop configurations, by connecting output I/O back to input I/O (within the same control loop), either directly or through some kind of filtering function. For instance, a MOTOR RUN COMMAND digital output can be connected directly back to the MOTOR RUNNING STATUS digital input in a simulation environment, to test operation of the motor control logic. Another example would be to test a vessel level control loop by tying the VESSEL LEVEL CONTROL VALVE (0-100%) analog output back to the VESSEL LEVEL (FT) analog input, through a Lag block with some gain to simulate level.
Why do tieback simulation? The purpose is to test the function of the control logic, loops, interlocks, graphics, alarms, etc. in a “dynamic” environment, meaning that the loops provide/receive stimuli and act upon those stimuli with (hopefully) the right sense, direction, and magnitude – in other words, to prove to the greatest extent possible that the control system is going to work once it is installed in the plant. Tieback testing is usually simple in nature, but is sufficient to find misconnected control blocks, parameterization errors, mis-linked graphics, incorrect high/low limits, etc., that could not (very easily) be found by “static” testing.
A Bulk Configuration tool is extremely valuable for tieback simulation, in that it provides a mechanism to apply “rules” in order to automatically create model objects and tie them off to appropriate I/O points; the rules take advantage of I/O block naming conventions to specify the type of model to do the tieback (like a rate limit block to simulate the
operation of a valve). It is especially handy for control systems with thousands of I/O points, especially when many typical control loops are repeated.
This document describes the function and use of the Tieback Simulation Bulk
Configurator, used in conjunction with the Invensys Dynamic Simulation Suite (DSS): FSIM Plus application, TRISIM Plus application, and Dynsim application. These are:
• FSIM Plus: FOXBORO I/A Simulation
• TRISIM Plus: TRICONEX and Trident™ Simulation
• Dynsim: Dynamic Simulation modeling environment
(Note: The GUI for all of the above products is the same though the underlying engines are different. Hence all the products have the same look and feel. The term DSS GUI may be used to refer to any of the product user interfaces.)
This document will discuss tieback simulation types and general simulation topics, before getting into the specifics of the Bulk Configurator.
Tieback Simulations
A tieback simulation attempts to test the behavior of a control system in a simulated real-world environment. Figure 1 shows a simple representation of the pieces of a process control system installed in a plant.
Figure 1. Typical Process Plant Control System
To simulate plant processes simply, output signals can be “tied back” onto input signals, either directly or through some kind of filter or signal generator in a lab or staging floor-environment:
Figure 2. Tieback Testing in Lab or Staging Floor Environment
Until recently, tieback-type testing required various configurations of control system hardware to accomplish. One type of tieback simulation involves staging the entire hardware and software systems to be assembled, with tieback done by using actual wires or signal generators to loop output signals back to input signals on the I/O module (as already shown in Figure 2). Another approach, requiring less hardware, is to build simulation-type blocks within the actual control system software, and connect these simulation blocks to the I/O software blocks (Figure 3).
Figure 3. Tieback Simulation built within Control System Blocks
This approach does away with the need for the actual I/O modules, however real control processors are still required for block processing. I/O software blocks modification, to turn off the connection to I/O hardware, and to reconfigure the block to accept inputs from the simulation block is required
Another method (Figure 4) uses commercially available simulation software, such as
CAPE VPLink™, to provide simple process simulation algorithms to stimulate the control
system I/O. Like the second method, the I/O control blocks still need to be modified to turn off their connection to the physical I/O modules, but now the off-board simulation software reads/writes to the I/O blocks via a special Application Programming Interface (API). K ⌠ AOUT To I/O Module AIN From I/O Module LAG Specially-inserted Simulation Block Modify blocks to turn off connection to I/O Module
Figure 4. Tieback Simulation using 3rd-Party Application
Each of these previous tieback simulation approaches has the following disadvantages:
• All require actual control system hardware, including networking interfaces. Method 1 requires actual I/O modules.
• Methods 2 and 3 require that the control system configuration be modified to turn off connection to physical I/O
With the Tieback Simulation Bulk Configurator addition to the Dynamic Simulation Suite, many of the shortcomings of the alternative tieback approaches have been
Figure 5. Virtual Stimulation Control System Simulation
“Virtual Stimulation” means that the control processors and I/O modules are simulated on a desktop or laptop computer, by porting the source code that runs on this hardware to run in a PC environment. Multiple controllers and I/O modules can be simulated on a single platform. In addition, this platform includes all control system applications (configuration tools, alarm manager, historian), HMI display tools, and includes Dynsim process modeling software (Figure 6). The Tieback simulation Bulk Configurator builds simple Dynsim models to interact with the control system.
In the subject of control system checkout using tieback simulation, the primary challenge lies with understanding control engineering and with the specifics of the control system itself. However, essential simulation concepts are requisite to tieback simulation Bulk Configurator discussion.
Important Simulation Concepts
The concepts discussed in this section are a subset of those contained in the FSIM Plus
Getting Started Guide and the Trisim Plus Getting Started Guide. They are presented
here as an introduction and the minimum pre-requisite knowledge required before tieback simulations can be built. Please refer to these manuals as well as the Installation and
User Guides for more detailed information.
Simulation Engines
In process simulation, every entity in that simulation is considered an Engine. A typical basic simulation requires at least two simulation engines: one for the Foxboro I/A Series control system (or Triconex controller) and one for the tieback process model. A more complex system example to be includes a Foxboro I/A Series DCS and a Triconex safety system; in this case, three engines include one for I/A Series, one for Triconex, and one for the process model. As a complex example, a large high-fidelity Operator Training Simulator might have many control systems and an extensive process model. Such a system may have tens of engines – one for each of the control system entities, and perhaps several for the process model itself (large detailed process models need to be split up to be able to run on different computers or processors in order to have acceptable speed). Figure 7 shows the engine concept.
Figure 7. Simulation Engine Architecture
DCS SIM4ME Dynsim Engine Excel® Engine PLC GUI 3rd Party Engine
Time Control and Synchronization
One advantage the Invensys® Dynamic Simulation Suite has over the types discussed in previous sections is the concept of time control. In a nutshell, “time control” refers to the ability to make each of the simulation engines march in lock-step (synchronization), and to control their execution in the following manners:
• Freeze/Run – halt processing, or proceed
• Slow/Fast Time – make the simulation run slow (so as for instance to watch fast-evolving sequences in detail), or fast (to get past a long waiting time for the process, like the filling of a large vessel). Expressed as a % of real time (i.e. the wall clock; 100% = execute at real time, 200% = 2X real time, etc.)
• Single Step – extremely useful for debugging sequence or Boolean control logic The Simulation Executive controls each engine’s execution cycle (like Basic Processing Cycle in I/A Series software), sending commands to each engine to run, and receiving a message back indicating the engine execution cycle completes (Figure 7). The regulation of this time-marching sequence controls the simulation speed (Slow, Real, or Fast Time). The Simulation Executive ensures deterministic operation, meaning that exactly the same results occur for an operation scenario run from a saved initial condition, if the actions in the scenario are repeated.
One important point to remember: the control blocks are not processing (executing) unless the simulation is in Run mode. For instance, if controls are loaded or
incrementally changed, the change does not take effect until the block has processed at least one cycle.
Cross Referencing
Cross Referencing can be thought of like a marshalling cabinet (Figure 5): it connects control system I/O points to the simulated process, like the copper wires that connect I/O modules to sensors and actuators in the field in the real world. Cross Referencing
connects the points in one engine to another (Figure 7) via a Cross Reference Table (Figure 8):
Figure 8. Cross Reference Table
In the figure, “DynsimEngine” refers to the process model; “FSIMEngine” refers to the control system. Therefore, From DynsimEngine to FSIMEngine refers to an I/A Series software input (analog input in this illustration). The points connected are the “From Symbol” and “To Symbol.” As a minimum, one line exists in the Cross Reference table for each I/O point in the entire simulation.
Model Objects and Parameters
The Dynsim dynamic simulation environment is object-oriented, with each modeling object a certain Class that defines what the model does (like LATCH, TIMER, VALVE); each instance of an object must have a unique name (the name cannot begin with a number; special characters are also not allowed). A particular value of a model is referenced by the ObjectName.Parameter; a parameter can be an input, output, or a configuration or tuning constant. Examples of common parameters are:
• IN (input value)
• OUT (output value)
• RATE (time constant)
• HI_LIM (output high clamping limit)
• etc.
In Figure 8, the points to be cross-referenced are the model object LT5T27’s OUT output parameter connecting to the analog input block LI5T27, in Compound 5ADD_SYSTEM.
FSIM Engine Snapshots and Checkpoints
A snapshot is the record of all internal states of each engine, such that these states can be restored to the exact same operating point as when the snapshot was taken. Save and restore snapshots through the Dynamic Simulation Suite Graphical User Interface. For FSIM, a snapshot can be thought of as a checkpoint file, the main difference is that a snapshot includes the current model states, such as automatic, running, or timing.
For the FSIM engine, two intractable considerations relate to snapshots and checkpoints. The first is that older snapshots must be updated if new controls are added or existing controls modified. FSIM’s Snapshot Management Utility (SSMU) performs this action automatically when an out-of-date snapshot restores. The update starts with the
checkpoint file and pushes values of settable/connectable parameters from the snapshot in to the checkpoint file, then saves the result as the updated snapshot.
The second consideration is that the checkpoint file must be valid when rebooting the computer or restoring a snapshot. With simulation the checkpoint file is only valid if blocks process after (re)deploying the controls (i.e., run the simulation) and manually performing Checkpoint after processing blocks: the automatic checkpoint that occurs before blocks process is not valid. With FSIM 4.5 and beyond, the checkpoint file is saved external to the simulation and restores automatically on a reboot. To clear the checkpoint file contents, initialize all controls mapped to the FSIM Station and reboot the FSIM Station.
TRISIM Engine Snapshots
For the TRISIM engine, restoring older snapshots is not problematic: if an object or tag existed in the old controls, those values populate the control system on a reset. New objects begin at their default values. With the TRISIM engine, it is possible to edit the contents of the text-based snapshot file.
FSIM Engine with Multiple I/A Series Control Processors
Tieback Simulation using Invensys Dynamic Simulation Suite has a major advantage over other methods in that multiple I/A Series Control Processors (CPs) can be simulated on a single desktop or laptop PC (Figure 6). Additionally, a mix of I/A Series CPs and Triconex Tricon™/Trident controllers can be simulated simultaneously. Recent advances in FSIM Plus and simulation enhancement added to I/A Series software now allow
multiple CPs to be kept “segregated,” even though they are all run on one “super” control processor, or FSIM Station. CP mapping utilities maintain segregation. In FSIM, this configuration takes place prior to deploying controls and depends on the configurator: ICC, IACC, or IEE. Each configurator makes use of a different mechanism to segregate controls. This step is typically a one-time setup for each project. Refer to the FSIM Plus User Guide for details.
Another important point is the physical limit to the number of I/A Series CPs mapped to a single FSIM Station. This limit is based on the size of the control set, the number of peer-to-peer connections, the number of blocks, and the number of non-repeating strings. The maximum number is variable based on the specifics of the project, but for estimation sake figure on 10 CPs per machine. If the number of physical CPs is greater than 10, then additional machines (again, typical laptop or desktop PCs) need to be networked (Figure 9), and additional instances of control engines are required.
Figure 9. Extending the Simulation Platform to Accommodate Large number of Simulated Control Processors
TRISIM Engine Multiple PLC Simulation
With Triconex TriStation, configuring multiple PT2 files per simulation also requires initial setup to instantiate emulator filenames (to the NodeName). Although no changes to the program files are needed, the TriStation project options need point to multiple instances under the emulator options. If controllers communicate directly via peer-to-peer (TRICON to TRICON) with USEND / URCV commands, additional configuration is required within the TRISIM engine. For communication between FSIM and TRISIM, some manual cross referencing within DSS is needed. The TRISIM Plus User Guide contains details for each of these configurations.
Bulk Configurator
Launching the Bulk Configurator
Launch the Bulk Configurator from the DSS GUI by selecting Tools->Bulk Configurator (Figure 10).
Figure 10. Launching the Bulk Configurator
The user is prompted to create or open an Excel spreadsheet. After launching the Bulk Configurator, the current model data and cross reference table in the DSS
database/simulation, are imported into the Excel spreadsheet. The user can then,
(a) Perform model edits and manual cross referencing by simply typing into the Excel cells.
(b) Use Microsoft Excel functions, like Search, Replace, Copy, Paste, Filter, etc., to
i. find and modify certain model objects,
ii. create additional model objects (only in Checkout View) and/or iii. delete existing model objects (only in Checkout View)
(c) Use the Rulebook (described in subsequent sections) to automatically bulk-configure a large number of model objects, based on parsing I/O tag records in the cross reference table (only in Checkout View). (d) Rename model objects in bulk and update the database, cross reference
and ICs appropriately (only in Model Data View).
Note: Launch the Bulk Configurator from the DSS GUI and not by double-clicking the Excel file.
Components of the Bulk Configurator
Once launched, two main interfaces appear (Figure 11a):• Excel Workbook
1. Cross Reference Worksheet Tab
2. Model (Checkout) Worksheet Tab (Checkout View) Or
Model Worksheet Tab (Model Data View)
• Action Pane
1. View selection 2. User Action Buttons
3. Status Messages display box
Action Pane
The Action Pane (figure 11b) includes the following sections:
Figure 11b. Bulk Configurator Action Pane
Simulation Name
When BulkConfigurator launches, the simulation name displays automatically in this field.
View
Through the Action Pane, choose how the data displays:
• Checkout View Bulk Configure model objects through the Rulebook and automatically tie I/O to model objects
• Model Data View
Parameterize model objects created using any Dynsim, Dynsim-P, Dynsim-C, or Dynsim-L library
Update
After bulk configuring a new tieback model or parameterizing model objects perform the following actions:
• Refresh Update data from the Dynsim application into the XRef and Model (Checkout)/Model sheets. No need to close and open Bulk Configurator to update with this integrated two-way data transfer option.
o View the IC data after the IC is loaded in the Dynsim application using Refresh.
o View the Dynamic (Runtime) data when simulation is in Frozen mode using Refresh.
Actions
The active actions depend on the view. Checkout View activates Rulebook and Apply Rules. Model Data View activates Configure Model Data View, Rename Model Objects, and Model Data View settings.
Checkout View Actions
• Rulebook Create rules to parse I/O in Cross Reference table, create and configure tieback models based on filter criteria
• Apply Rules Update Cross Reference table and model objects within the Bulk Configurator environment
Model Data View Actions
• Configure Model Data View
Select which objects appear based on the Dynsim library, such as Checkout Equipment, Process Equipment, or Controls
• Rename Model Objects Globally replace model object names
• Model Data View settings
Specify which parameter columns appear in Model Data View
These actions are discussed in further detail in the Error! Reference source not found. section.
Status Messages
The Status Message display box indicates action progress, warnings and errors. Bulk Configurator Toolbar
Along with the standard Excel menu options, a “SIMSCI-ESSCOR” menu option contains additional menu options (Figure 13).
• Document Actions (activate Actions Pane),
Figure 13. Bulk Configurator Toolbar
Checkout View (Tieback Simulation)
Tieback Simulation using the Bulk Configurator: Workflow
The figure below shows the start-of-day to end-of-day workflow procedures in using a tieback simulation.
Tieback Simulation Workflow More generally, the workflow includes (for a new project):
1. Load new controls
2. Create a new (empty) simulation
3. Create a Cross Reference table (pre-populated with default values until a model can be created)
4. Launch the Bulk Configurator. Select Checkout View. 5. Open the Rulebook and configure the Rules
7. Send the modified Cross Reference table and model objects back to the simulation
8. Use the simulation to test loopback control logic 9. Repeat 3-8 as needed
(The Model Data View may be used to view and modify model objects that are not supported in the Checkout View).
The following sections will discuss in detail items 4-7. Details for all other items may be found in the FSIM Plus or TRISIM Plus User Guides.
Cross Reference and Model Worksheets
Figure 14. Tieback Simulation Bulk Configurator
The Cross Reference worksheet contains all the model-to-control system I/O connections, and is identical in format to the Cross Reference table as accessed by the DSS GUI. By default, when the Bulk Configurator launches, Checkout View is selected. In this view, under the Model tab, only model objects configurable through the Rulebook appear. To view model objects that are not configurable with the Rulebook, but exist in the process model, select Model Data View radio button from the Action Pane. The Model worksheet format differs slightly between Checkout View and Model Data View, but the general concepts are the same.
The Model worksheet contains all details of the model objects for the tieback simulation. The format for model definition in the Bulk Configurator is tabular (Figure 15a) unlike the DSS GUI where a model object is represented graphically on a flowsheet (Figure 15b). The graphical representation of the model object is shown in the flowsheet on the right and the model object and its parameters are shown in the Instances tree on the left.
Figure 15a. Model Worksheet in Bulk Configurator showing Configuration for Model Object XV1
Figure 15b. DSS GUI showing Flowsheet and Model Object ASOV_61005_5 Figure 15c shows the Dynsim Object Editor Viewer representation of the same model object.
Figure 15c. Object Editor View of Model Object XV1
Figures 15a, 15b, and 15c are all different views of the same model object. However, only a subset of the parameters are shown in the Checkout View of the Bulk Configurator (Figure 15a) when compared to the DSS GUI (Figure 15c). This was done intentionally to provide the users of the Bulk Configurator with the most commonly used parameters that are needed for tieback simulation.
The Model Data View of Model objects, shown in Figure 15d, provides more object parameterization flexibility. Model Data View can be configured to display every object, in the process model, including all objects available in Dynsim, Dynsim-P, Dynsim-C, and Dynsim-L libraries. The tool can be configured to display user-specified parameters within specific object types.
Utilize any of the four views in Figure 15 to make editing changes. However, for the sake of simplicity, this document concentrates only on the Bulk Configurator (refer to the Dynamic Simulation Suite Users Guide for more details on creating/editing models from the DSS GUI).
Rulebook
The Rulebook (Figure 16) enables rule creation to parse I/O block (tag) names in the Cross Reference table, create and configure model objects based on matches to filter criteria, and then connect the model inputs and outputs to the I/O block outputs and inputs respectively. It is active when Checkout View is selected.
Figure 16. Bulk Configurator Rulebook Checkout View
The Control OUT, IN, Model Name, and model parameter fields (in the parameter pane) all support Regular Expressions (see Appendix B). Figures 17a and 17b detail a
Rulebook Entry.
Figure 17a. Rulebook Entry (part 1)
1. Enable Rule When selecting Apply Rules, this rule will execute 2. Overwrite:
• None Does not overwrite previously-defined or custom entries for XRef or model (“None” will overwrite default points in XRef)
• Model Overwrite any applicable model entries
• Both Overwrite model and XRef entries 3. Description Text field describing rule
4. Control Engine The non-Dynsim engine, such as FSIM Plus engine or TRISIM Plus engine
5. Filter Using Out/In Tag
Tells the rule which I/O point is the “search” tag and which is the resulting “paste” tag
6. Model Engine The Dynsim engine that models the process
Figure 17b. Rulebook Entry (part 2) 7. Control Out/In
Tag
Control System analog/digital output or input tag name associated with the control loop. One point is the “search” tag while the other is the “paste” tag, depending on the Filter flag (see #4 previous page). While the “search” tag is required and must be
specified for a rule to be valid, specifying the other tag is not required. If specified, the Bulk Configurator ties the “paste” tag to the model.
Important: Be sure to properly specify search/replace expressions and select the correct Filter checkbox for the Control Out and In Tag fields. Notice the wild-cards (.*) on the Control Out Tag and the checkbox on Filter Using Out Tag align. Selecting Filter Out Tag:
• A “search” expression [e.g., (.*):LY(.*)\.(.*)] should be specified in the Control Out Tag field.
• A “replace” expression [e.g., $1:U$2.POINT] may be specified in the Control In Tag field.
Selecting Filter In Tag:
• The expressions have to be interchanged, i.e., a “search” expression [e.g., (.*):XU(.*)\.(.*)] should be specified in the Control In Tag field.
• A “replace” expression [e.g., $1:XP$2.OUT] may be specified in the Control Out Tag field.
8. Model Class Type of tieback model (explained in next section) 9. Model Name Name to give the created model object using the
“search” and “paste” criteria from the Regular Expressions. Be sure to generate valid DSS model names (start with alphabet and no special characters) when applying the rule.
10. Model In Param “Tie the control system Output Tag to this Model Input parameter”. A selection of None implies no tie back for that tag.
11. Model Out Param “Tie this model Output parameter back to this control system Input Tag. A selection of None implies no tie back for that tag.
12. XRef Auto Scale Auto scale the model output. Applies only to analog signals.
Note: Incomplete rules are indicated by a red error mark adjacent to the rule number. Parameter Input Dialog
Selecting a rule displays a Parameter Input Dialog corresponding to the model class specification to the right side of the rulebook table.
Figure 18. Parameter Input Dialog
The user specifies parameter values for rules in this dialog box. Each rule has a model class and a set of parameter values associated with it. Applying a rule creates several model objects based on matches in the XRef sheet and populates the model object parameters with the values specified in the Parameter Input Dialog.
Similar behavior occurs in the Parameter Input Dialog for the Model (Checkout) sheet . Only a subset of the entire parameter list appear in the Parameter Input Dialog, limited to those considered most important in tieback models. Access the complete parameter list of parameters through the DSS GUI. If needed, online documentation and the Dynamic Simulation Suite User Guide can help.
A “replace” regular expression may be used to bulk configure equations for parameter fields. Prefix this expression with “#” to indicate that it is a regular expression.
Figure 19. Regular Expression
When processing this rule, the expression automatically expands and parameter values fill with the corresponding equation. In the above example, the parameter PV could be expanded to FV5F01.OUT, FV5F02.OUT, FV5F03.OUT, etc. This feature enables model object linking and is useful for complex control loop scenarios.
Default Rules
When Bulk Configurator opens, the previously used rules automatically load. Import / Export Rules
Export and import rules facilitate rulebook reusability for multiple projects. Export
Select Export to save rules in a separate text-base .xrl file.
.
Import
Select import to restore a previously exported rulebook file.
The rules currently in the Rulebook replace with the rules in the imported file. Therefore, consider exporting/saving the rules before importing a new set of rules.
Figure 21. Import Rules Setting up a Rule – Simple Example
As a general example of a rule, suppose a control engineer wishes to create a tieback model for the following control loop (Figure 22):
Figure 22. Typical Control Loop
If this loop is typical and repeated many times in the control system, the user can create a rule to generate a tieback model for each instance of this loop type. An English-language version of the rule might state:
1. Find any DCS output tag in a) any compound, b) that has block name starting with “LY,” c) with any loop ID
2. Create a PID model object called “LT” and append the same loop ID, 3. Connect the DCS output tag to the “SP” parameter of the model object 4. Find any DCS input tag in a) the same compound, b) that has block name
beginning with “LI” and c) the same loop ID, and
5. Connect the DCS input tag to the “OUT” parameter of the model object Diagrammatically, the tieback model looks like Figure 23:
Figure 23. Tieback Representation of Level Control Loop Figure 24 displays the Rulebook entry corresponding to the numbered rules:
Figure 24. Rulebook Entry to Create Level Control Loop Tieback Model
The Rulebook makes use of what are called Regular Expressions. Regular Expressions are a special kind of text syntax that allows for easy filtering, searching, and replacing based on string patterns. Figure 25 shows an example of a Regular Expression.
Figure 25. Breakdown of a Regular Expression
The use and meaning of Regular Expressions will become clearer through the use and examples contained in subsequent sections and examples. Appendix B provides a detailed explanation of Regular Expressions and a reference manual.
Select Apply Rules (from Action Pane) to processes rules sequentially:
• Parse each line in the cross reference, searching for a Filter criteria based on the rules
• Create a specified model object and name it based on the Filter search string
• Parameterize each model object based on the rule definition
• Connect the cross reference table I/O output and input tags to the newly-created model object
• Repeat for each enabled rule
Once the rules have been processed and the engineer satisfied with the result, export to the DSS through the Send to DSS button on the Action Pane. This action re-bundles the model and cross reference configuration files and reloads the DSS database. Returning to the DSS GUI, the model objects and cross reference connections contained in the Bulk Configurator appear in flowsheets and the Instances Tree.
Finally, the engineer loads the simulation in to memory, runs it, and performs desired testing. Should he/she wish to make modifications to the model, relaunch the Bulk Configurator repeat the process.
Apply Rules
Rules processing creates Dynsim models based on block naming patterns that connect to I/O points through an updated cross-reference table. It also modifies models when
Dynsim Model specifications for a given rule change and the rule reprocesses (see Rulebook Section below).
Model (Checkout) sheet validation occurs first, prompting for errors, as needed. Correct the errors before proceeding. XRef rows in error highlight in red. Detailed status
messages appear. Modify or correct rules and re-Apply Rules.
Figure 26. Apply Rules
Figure 27a. Bulk Configurator Cross Reference Table - EQUATION entry for scaling
When the entries change by applying rules, the updated cells highlight to emphasize Rulebook processing (Figure 23b). Previously highlighted lines clear when reapplying rules.
Figure 27b. Bulk Configurator Cross Reference Table Highlighted after Rules Applied
Validation
DSS expects the cross reference data in a certain format and therefore Bulk Configurator prevents column deletion or rearrangement. Likewise, it prevents sheet deletion or renaming.
Model (Checkout) Worksheet
The Model Worksheet displays available bulk-configured model data in a “Model” sheet as shown in Figure 28a.
Figure 28a. Model Worksheet Model Class
Note that only objects corresponding to model classes supported by the Bulk
Configurator are imported. The model classes that are currently supported are AND,
DYNAMIC_DOUBLE, DYNAMIC_INTEGER, FCTGEN, GAUSSRAND, LATCH, LEADLAG, MISCEQTN, OR, PID, RLIMIT, SELECT, STATIC_DOUBLE,
STATIC_INTEGER, SUM, SWITCH, TIMER and VALVE. High-fidelity Dynsim process models (HeatExchanger, Drum, Column, etc.) are not supported by the Bulk Configurator, and do not appear in the model worksheet when opened. The “Send to DSS” command does not overwrite the portion of the simulation containing model classes not maintained by the Bulk Configurator.
Model Object
Parameters
The parameter names for the model objects display at the top of the worksheet with appropriate parameters for the model class in line with the highlighted cell. Selecting a row with a different model class updates the header row with the appropriate set of parameters. Only a subset of the complete model parameters display, those that are typically modified in a tieback simulation. Reducing the parameter set to the minimum eases configuration.
Figure 28b. Model Worksheet –N/A Parameters and Comments The number of supported parameters for the different model classes differs. The DYNAMIC_INTEGER for example, supports only one parameter (VALUE) while a VALVE supports more. An unused column displays N/A in the corresponding header cell. Send to DSS updates valid columns and ignores columns that display N/A. Header cells include comments for clarity. Select and manipulate data using standard Excel features, such as Conditional Filtering.
Parameter Input Dialog
Select a row in the “Model” sheet and right click on any cell to display “Parameter Input Dialog” for the corresponding DSS model object from the context menu (Figure 29a). The dialog populates its fields with values from the Excel cells. Edit values within the sheet or from Input Parameter Dialog (updating data in one updates the data in the other, Figure 29b).
Figure 29a. Parameter Input Dialog
Edit with the Parameter Input Dialog for manual configuration. Invalid values (e.g., out of range value) are rejected. When opening the dialog, invalid Excel cell values display an error in the dialog (a related error message displays in the Status Messages box). Upon OK, the value(s) in the dialog write back to the Excel cell(s).
Some model parameters allow DSS equations / parameter references. Specify a numeric value or an equation in such cases. Validation is not performed in the equation field and may impact dynamic performance.
During rule configuration, the same dialog in the Rulebook appears for parameterization. Unsupported model classes disable the menu option dialog launch.
Adding / Deleting Model Objects
Create model objects of supported model classes by inserting a new row in the Model (Checkout) sheet and filling in the information. Delete model objects by deleting the row in the Model (Checkout) sheet. Be sure to delete empty rows: when performing Send to DSS, a blank line interprets as the end of the file: subsequent rows do not process. Flowsheet
The flowsheet must exist in the DSS simulation to be valid. Create multiple flowsheets in the DSS before opening the Bulk Configurator.
Non-existent flowsheet specification defaults the flowsheet value to the first flowsheet in the DSS simulation. In addition, if a model object already exists in a flowsheet in the DSS GUI, it cannot be moved to another flowsheet by changing the flowsheet name in the Model (Checkout) sheet . The flowsheet name resets to the flowsheet containing the original object. Move objects between flowsheets through the DSS interface.
Equation
Bulk Configurator rulebook output data populates the Equation field of the DSS parameter irrespective of whether a numeric value or an equation is entered.
Figure 30. DSS Object Editor Viewer Value in Equation Field
Note: Processing model rows stops when a blank row is encountered. Subsequent rows are ignored. Therefore, arrange model rows continuously without blank rows in between.
Save
The user has the ability to save the workbook by selecting File / Save or by pressing the “Save” button on the toolbar. The 'Save As' option is disabled intentionally to prevent configuration file proliferation.
When the Bulk Configurator relaunches, either choose to re-initialize the sheets from the DSS database or reuse the contents of the Excel file. Before proceeding verify the launching simulation name matches expectations. If multiple simulations are open in the DSS, the last simulation opened populates the Bulk Configurator. After changing the simulation, Bulk Configurator copies the .xls file before over-writing it (the location indicated via a pop-up message). During re-initialization, the Bulk Configurator modifies only the XRef and Model (Checkout) sheet s; all other Excel data are retained (charts, additional worksheets, drawings, etc.), which may be useful in model configuration when linking cells in some other Excel-based spreadsheet, like PRO/II™ software.
Send to DSS
Send to DSS regenerates the xml and cross-reference files and sends the updates to the simulator. Any changes made in DSS while the Bulk Configurator is open are
subsequently opens the Bulk Configurator, the Bulk Configurator automatically picks the DSS changes. Although the DSS GUI and Bulk Configurator can remain open
simultaneously, recommended workflow to avoid inadvertent conflicts follows these steps:
1. From DSS, launch Bulk Configurator
2. Do not make any further changes to model through DSS while Bulk Configurator is open
3. Make desired modeling changes within Bulk Configurator 4. When done, send to DSS
5. Close Bulk Configurator 6. Repeat as needed
Configure either within the Bulk Configurator or within the DSS GUI, but not both at the same time.
Status Messages
Information, Warning, and Error messages display in the Status Message window, color coded with Information (blue), Warning (orange) and Error (red). Review status
messages for warning and error details.
Messages are also displayed in Excel status bar.
Figure 32. Invalid Configuration The Clear button removes accumulated messages.
Model Data View
The Model Data View contains the XRef (cross reference) and Model worksheets. When the Model Data View radio button is selected, the Rulebook and Apply Rules buttons become inactive and the Configure Model Data View, Rename Model Objects, and Model Data View settings buttons become active. Before actually viewing models under Model Data View, set up the model classes and parameters to view using the “Configure Model Data View” button.
When the Configure Model Data View button is clicked, the “Configure Model Data View” dialog pops-up displaying the Dynsim Libraries tree view as shown in Figure 33. The tree structure consists of a list of Libraries, Models, Group and Parameters from which the user can select the list of parameters to be shown in the Model sheet.
After selecting the list of parameters the Model sheet appears as shown in Figure 34.
Figure 34. Bulk Configurator Worksheet in Model Data View
Configure Model Data View
Use this feature to specify which model objects appear under Model Data View and if the Unit of Measure selection should be overwritten. Objects are broken down into
categories related to their library. For instance, objects available with a Dynsim-C
license are grouped under Base Checkout Equipment. Within a library, individual objects can be included or excluded. This file can be exported and shared or modified, as
Customize the models and parameters
By default, Model Data View displays parameters that likely require parameterization and not every available parameter. The reason is that for most objects, the default settings are adequate. To add a parameter that does not appear in the list, right click, select Insert Parameter, and type the parameter name, as shown in Figure 35.
Figure 35. Customize Model and Parameter
On clicking the Insert Parameter, the Custom Parameter Form dialog appears as shown in Figure 36.
Figure 36. Custom Parameter Form
Enter the Parameter Name, Description, Parameter Class, UOM Type and Unit of Measure in the respective fields and click OK.
Import / Export Model Data View
“Import” the predefined view and “Export” the customized view through the Configure Model Data View dialog. The Model Data View can be exported / imported only in xml format.
Import
Import a predefined Model Data View by clicking on the Import button. Select the desired xml file from the Import XML File window and click Open, as shown in Figure 37.
Figure 37. Import Dialog Export
Export the customized Model Data View selection file by clicking on the Export button. Select the customized Model Data View xml file from the Save dialog and click Save, as shown in Figure 38.
Figure 38. Export Dialog Restore Default View
Restore the original Model Data View before making changes to the Model sheet by clicking the Restore Default View button.
Global UOM slate for Model Data View
Select the desired global UOM slate for the complete Model Data View from the drop-down menu, which updates all parameters with the global UOM.
Rename Model Objects
Globally rename the objects in bulk or individually using the Rename Model Objects button. When changing an object name, the Bulk Configurator locates all references located within the simulation, such as the cross reference list, inputs or outputs to other objects or equations, object references or inputs to widgets, and snapshots.
To rename the model objects globally, enter the new model name in the New Model Name field and click Rename Model Objects button. The current Model object is replaced with the new model name.
Figure 39. Rename Model Objects
Note: Renaming will work only on the ICs stored in the local machine where the BulkConfigurator is running. Before renaming, user collects all his ICs on to his local machine by using the “Collect” feature in the Dynsim application. After renaming, user should redistribute the ICs.
Model Data View settings
Most objects contain a set of shared parameter names, such as Value, UOM, or Assignment. When viewed through Model Data View, those parameters do not
universally align in a single column heading. In order to limit the data viewed through Bulk Configurator, users can optionally hide or show specific parameters through Model Data View settings. On clicking the Model Data View settings button a dialog pops-up displaying the parameter columns. Select / unselect the parameter columns to hide / unhide.
Model Data View Navigation Features
Within the Model Data View, Bulk Configurator includes additional custom features to facilitate object parameterization. These features are discussed below.
Convert UOM
The Convert UOM option enables the user to change/convert the default units to the desired units. The Convert UOM dialog appears by right-clicking on the UOM cell that contains an existing UOM (i.e., MISSING UOM is not valid) and by selecting the change/convert Units menu. Select the desired UOM and click Change Units or Convert Value button. Select the Long Descriptions checkbox to display the long descriptions of UOM.
Figure 41. Convert / Change Units Custom Column Views
A column is a special case and contains several vector parameters whose size is
dependent on the number of stages. Unlike other vector parameters, the column vector parameters are displayed in rows. This mode of display is more convenient for the user to have all stage wise data in one column.
Figure 43. Bulk Configurator display of TOWER temperature data at different stages
The column/tower also has sections and many vector parameters that are of the size equivalent to number of sections. Bulk Configurator segregates all the vector parameters of section and displays it row wise, which reduces the display of number of columns.
Figure 44. OEV display of TOWER -Spacing data at different sections
Figure 45. Bulk Configurator Display of TOWER Spacing data at different sections Similarly, composition at various stages / plates is conveniently displayed ROW wise.
Figure 46. OEV display of TOWER - composition data at different stages
Figure 47. Bulk Configurator display of TOWER composition data at different stages
Note: The following index parameters for TOWER model are not displayed on Model worksheet: STAGEIDX, STAGEIDX2, STAGEIDX3, STAGEIDXSUMP Flash001.SolidIDX and SumpFlash.SolidIDX.
Static, Dynamic and States Data
The Bulk Configurator displays all the STATIC data including the Default Data. This data is obtained from Dynsim Edit Engine. It also displays the parameter values when the Simulation is in FROZEN state, Backtrack State etc. These values are similar to the Value column, which can be seen in the actual Dynsim OEV. Note that the data is not live – it does not update continually – but it does represent a snapshot at a point in time, similar to restoring an IC and remaining in frozen mode.
Validate Data
The Bulk Configurator validates Dynsim Parameter naming conventions at the Unit-Operation level. The error message box displays in a Status Message box and highlights in red under Status Messages.
The tool does not provide validation of the model parameter values. Care should be taken to provide valid Dynsim data.
The user can view the Status Messages box, after selecting OK, for more information on the error messages as shown in Figure 49.
Figure 49. Error Messages on Status Message Box Status Messages
The Information, Warning, and Error messages are displayed in the Status Message window (Figure 49 above). The messages are color coded as – Information (blue),
Warning (orange) and Error (red). View the status messages for more details on the errors messages. The Clear button removes accumulated messages in the ‘Status Messages’ window.
Appendix A: Tieback Simulation Model Classes
(Checkout View)
This section describes the various model classes available within the Bulk Configurator through Checkout View. Each class is organized by name, what it does, available parameters, and example usage. The same or similar-type tieback model can be created many different ways, according to the preference of the control engineer. The reader should carefully review the all examples to get an idea of alternate approaches to building models, as well how to handle special situations (like selectively overwriting or
protecting previously created models).
DYNAMIC_DOUBLE
Type: General Purpose Double Precision Variable Parameters:
Parameter Value Description
VALUE[0] Any real number Variable value Example Use: Point to stimulate an Analog Input:
Example Rulebook Entry:
AIN 1CST:FI049.POINT FT049 FLOW TRANSMITTER FT049 (0 TO 550 GPM) Field I/A
Note: A Dynamic point value updates while the simulation runs. Either change the value via the Monitor Tab, directly on the flowsheet, or add a slider bar widget (see Figure).
The value is saved and restored with Snapshots. For a constant, use a STATIC_DOUBLE model point.
STATIC_DOUBLE
Type: General Purpose Double Precision Constant, or Table Array Parameters:
Parameter Value Description
ISFUNCTABLE TRUE/FALSE TRUE implies table-lookup array (see
FCTNGEN description). FALSE implies single dynamic (i.e. variable) double precision number VALUE[0] Any FP number
VALUE[1] Any FP number Only used for a table array VALUE[2] Any FP number Only used for a table array VALUE[3] Any FP number Only used for a table array VALUE[4] Any FP number Only used for a table array VALUE[5] Any FP number Only used for a table array VALUE[6] Any FP number Only used for a table array VALUE[7] Any FP number Only used for a table array VALUE[8] Any FP number Only used for a table array VALUE[9] Any FP number Only used for a table array
Monitor
Slider Bar Widget
Example Use: Lookup Table Array
Parameter Value Description
ISFUNCTABLE TRUE X-Y Table Array
VALUE[0] 5 Number of X-Y Pairs
VALUE[1] 0 (not used)
VALUE[2] -100000 1st Pair X Value
VALUE[3] -15 1st Pair y Value
VALUE[4] -25 2nd Pair X Value
VALUE[5] -15 2nd Pair Y Value
VALUE[6] 15 3rd Pair X Value
VALUE[7] 10 3rd Pair Y Value
VALUE[8] 25 4th Pair X Value
VALUE[9] 15 4th Pair Y Value
VALUE[10] 100000 5th Pair X Value
VALUE[11] 15 5th Pair Y Value
Note: Use with FCTGEN block. If the X lookup value exceeds 100000 in the example above, the value clamps to the last Y value in the table (i.e. the table lookup does not extrapolate). Similarly, if lookup falls below -100000, the output clips. Example Rulebook Entry:
Enter an array directly into the Model flowsheet or, alternatively, add it in the DSS GUI. -25 15 25
15 10
DYNAMIC_INTEGER
Type: General Purpose Integer Variable Parameters:
Parameter Value Description
VALUE Any positive or negative integer, or zero
Example Use: Motor Run Command/Feedback Status
Parameterization:
Parameter Value Description
VALUE Assigned in Cross Reference table for both
output and input Example Rulebook Entry:
Note: In this example, the control system Digital Output writes to the
DYNAMIC_INTEGER, which in turn writes back to the Digital Input. The user may observe the value of the point from the Monitor tab but does not alter the value, except through Cross Reference I/O Override utility (accessed from the Cross Reference tool from the user interface).
COUT CIN
I/A Field I/A
1MCC:XU6P13.COUT 1MCC:XU6P13_M.CIN XU6P13M MOTOR 6P13 RUN COMMAND
STATIC_INTEGER
Type: General Purpose Integer Constant Parameters:
Parameter Value Description
VALUE Any positive or negative integer, or zero
Example Use: Local/Remote Interlock Status
Parameterization:
Parameter Value Description
VALUE 1 Always Remote Status
Example Rulebook Entry:
Note: The value of this static integer remains at 1, and the Digital Input remains true. The user cannot change the value of this point (except by overriding the I/O point in the cross reference table).
CIN 1CST:PB1_LOCAL.FBCIM PB1_LOC MOTOR LOCAL/REMOTE STATUS (1=REMOTE)
LATCH
Type: Set/Reset Latching Block (“flip-flop”) Parameters:
Parameter Value Description
SET 0/1 Set latch
RESET 0/1 Reset latch
SET_DOM SET_PRIORITY/
RESET_PRIORITY
Set/Reset Dominance (if both signals are true, which dominates – default = reset dominant)
MA 0/1 Man/Auto
OUT 0/1 Output
OUTR 1/0 Inverse Output
Example Use: Motor Run Start/Stop Command with Feedback Status
Parameterization:
Parameter Value Description
SET Leave blank (connected in cross reference)
RESET Leave blank (connected in cross reference)
Example Rulebook Entry:
Note: The first rule defines the latch block, connects the SET (i.e. Start command) parameter, and feeds back the latch output status OUT to the running status feedback. The second rule connects the stop command to the RESET parameter.
COUT CIN
I/A Field I/A
1MCC:XU6P13ST.COUT XU6P13M 1MCC:XU6P13_M.CIN MOTOR 6P13 START COMMAND LATCH COUT MOTOR 6P13 STOP COMMAND 1MCC:XU6P13SP.COUT
AND, OR
Type: Logic Blocks, with four inputs Parameters:
Parameter Value Description
INP[0] 0/1 First input
INP[1] 0/1 Second input
INP[2] 0/1 Third input
INP[3] 0/1 Fourth input
INV_INP[0] 0/1 Invert first input
INV_INP[1] 0/1 Invert second input
INV_INP[2] 0/1 Invert third input
INV_INP[3] 0/1 Invert fourth input
MA 0/1 Man/Auto
OUT 0/1 Output
Example Use: Fan run command with Local Lockout
Parameterization:
Parameter Value Description
INP[0] Leave blank (set in cross reference)
INP[1] Leave blank (set in cross reference)
INP[2] Unused
INP[3] Unused
INV_INP[0] 0 Default
INV_INP[1] 1 Invert local lockout
INV_INP[2] Unused
INV_INP[3] Unused
COUT CIN
I/A Field I/A
1PHFAN:XUPHF.COUT XUPHF 1PHFAN:XUPHF_M.CIN PENTHOUSE FAN RUN COMMAND AND COUT PENTHOUSE FAN LOCAL LOCKOUT 1PHFAN:XUPHFLO.COUT
Example Rulebook Entry:
Note: The AND block feeds back running status if Run Command is true and Local Lockout is not true.
FCTGEN
Type: Function Generator Parameters:
Parameter Value Description
IN Any FP number Input x-coordinate to interpolate TABLE DYNAMIC_DOUBLE[0] Name of table array previously defined
(see DYNAMIC_DOUBLE)
HI_OUT Any FP number High output limit
LO_OUT Any FP number Low output limit
MA 0, 1 Man/Auto
MANSET Any FP number Value of output when in Manual
OUT Any FP number Output value
HI_LIM 0, 1 Flag to indicate high limit reached
LO_LIM 0, 1 Flag to indicate low limit reached
Example Use: Temperature as a function of Pressure
AIN AIN Field I/A 1HC:PI512.POINT Hydrocarbon Pressure Hydrocarbon Temperature PT512 F(x) 1HC:TI512.POINT PRESS_VS_TEMP TT512