BulkConfigurator_V11

8/13/2019 BulkConfigurator_V11

1/96

Bulk Configurator

User Guide

Invensys SimSci-Esscor5760 Fleet Street, Suite 100,

Carlsbad, CA 92008


2/96

Bulk Configurator User Guide Version 1.1

11-Feb-11

The 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 underwhich you obtained it. The technical documentation is being delivered to you AS IS andInvensys Systems, Inc. makes no warranty as to its accuracy or use. Any use of thetechnical 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 ofIntel Corporation. Windows 98, Windows ME, Windows NT, Windows 2000, Windows XP,Windows 2003 Server, Exceland MS-DOS are trademarks of Microsoft Corporation. Adobe,Acrobat, Exchange, and Reader are trademarks of Adobe Systems, Inc. All other products aretrademarks of their respective companies.

No part of this publication and protected by this copyright may be reproduced or utilizedin any form or by any means, electronic or mechanical without the written permissionfrom Invensys Systems, Inc., including photocopying, recording, broadcasting, or by anyinformation storage and retrieval system.


3/96

Bulk Configurator User Guide 3

Table of Contents

Welcome to Bulk Configurator..........................................................................................5Getting More Information...................................................................................................6Glossary..................................................................................................................................7Introduction to the Bulk Configurator.............................................................................8

Checkout View (Tieback Simulation).......................................................................... 8Features................................................................................................................... 8

Model Data View........................................................................................................ 8Features................................................................................................................... 8

Intended Audience ...................................................................................................... 9Additional Reading ................................................................................................... 10

Introduction to Tieback Simulation................................................................................11Tieback Simulations..........................................................................................................12Important Simulation Concepts......................................................................................16

Simulation Engines ................................................................................................... 16Time Control and Synchronization............................................................................ 17Cross Referencing..................................................................................................... 17Model Objects and Parameters.................................................................................. 18FSIM Engine Snapshots and Checkpoints ................................................................. 18TRISIM Engine Snapshots........................................................................................ 19FSIM Engine with Multiple I/A Series Control Processors ........................................ 19TRISIM Engine Multiple PLC Simulation ................................................................ 20

Bulk Configurator...............................................................................................................21Launching the Bulk Configurator.............................................................................. 21Components of the Bulk Configurator....................................................................... 22

Action Pane........................................................................................................... 23Bulk Configurator Toolbar .................................................................................... 24

Checkout View (Tieback Simulation)........................................................................ 25Tieback Simulation using the Bulk Configurator: Workflow ................................. 25Cross Reference and Model Worksheets................................................................ 27Rulebook............................................................................................................... 30Import / Export Rules............................................................................................ 33Setting up a Rule Simple Example...................................................................... 34Apply Rules .......................................................................................................... 36Model (Checkout) Worksheet................................................................................ 39

Send to DSS.......................................................................................................... 43Status Messages .................................................................................................... 44

Model Data View...................................................................................................... 45Configure Model Data View ................................................................................. 47Rename Model Objects ......................................................................................... 50Model Data View settings ..................................................................................... 51Model Data View Navigation Features.................................................................. 52


4/96


Status Messages .................................................................................................... 56Appendix A: Tieback Simulation Model Classes (Checkout View).......................57

STATIC_DOUBLE .................................................................................................. 58DYNAMIC_INTEGER............................................................................................. 60STATIC_INTEGER.................................................................................................. 61LATCH..................................................................................................................... 62AND, OR.................................................................................................................. 63FCTGEN .................................................................................................................. 64RLIMIT .................................................................................................................... 65PID ........................................................................................................................... 70SUM......................................................................................................................... 73TIMER ..................................................................................................................... 74LEADLAG ............................................................................................................... 78MISCEQTN.............................................................................................................. 81Custom for OTS Engineers ....................................................................................... 85

Appendix B: Using Regular Expressions with the Tieback Simulation(Checkout View)..................................................................................................................86

Regular Expression ................................................................................................... 86.NET Regular Expressions ........................................................................................ 86Starter Syntax Examples ........................................................................................... 86Search Syntax ........................................................................................................... 87Regex Replace .......................................................................................................... 89Examples specific to I/A Series and Triconex............................................................ 89Regular Expression Basic Syntax Reference ............................................................. 91Regular Expression Basic Syntax Reference ............................................................. 91Other Resources........................................................................................................ 96


5/96


Welcome to Bulk Configurator

This User Guide provides an overview of use cases and configuration of the BulkConfigurator tool, an Excelbased 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 Excelspreadsheet front-end tool to provide a convenient, tabular way of enteringmodel/equipment data and is designed for control and instrumentation specialists primaryworking with FOXBORO I/A Seriessoftware and TRICONEXsoftware. It can beextended to any DCS or PLC process requiring process control loop validation throughdynamic I/O stimulation. This tool resides outside of the simulation environment anddisplays static configuration model parameters typically specified when building aprocess model.

Dynsim applicationis a process-modeling package that links instrument and controlsignals with a cross-reference database utility built into Dynsims Graphical User

Interface (GUI). The Dynsim process model engine sends signals to and from DCS orPLC engines configured either directly through the Dynamic Simulation Suite interface(i.e., FSIM Plusengine/ TRISIM Plusengine/ other PLC-type engine) or through abridge to a third party application.

If you are new to Dynsim application, FSIM Plusapplication, or TRISIM Plus applicationwe suggest you review the relevant getting started guides to gain an understanding ofbasic 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 Started with Dynsim


6/96


Getting More Information

The Bulk Configurator, FSIM Plus, TRISIM Plus, and Dynsim user guides are availableon the product-specific installation CD.

Access FSIM Plus application, TRISIM Plus application, and Dynsim applicationspecific 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-EsscorTMspecific documentation, downloadable software, andsoftware updates and patches at the SimSci-Esscor Electronic Software Downloadwebsite: http://www2.simsci.com/sim4me/esd/login.asp


7/96


GlossaryAPI Application Programming Interface

Checkpoint File The Control Database that resides on the hostworkstation and downloaded to the

FCP270/ZCP270 or FSIM StationCP 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 aspecific point in time. For the FSIM Plus Engine,a picture of the Control Processor (CP) databasememory. For the TRISIM Plus Engine, a text-based file that represents the state of the PT2files objects and tags.

SSMU Snapshot Management Utility

UOM Unit of Measure

XRef Cross Reference (List)


8/96


Introduction to the Bulk Configurator

The Bulk Configurator is an Excel based model configuration tool to provide aconvenient, tabular way of entering model/equipment data. It supports two modes:

o Checkout Viewo Model Data View

Checkout View (Tieback Simulation)

In Checkout View mode, the tool provides a mechanism to apply rules in order toautomatically create model objects and tie them off to appropriate I/O points. The rulestake advantage of I/O block naming conventions to specify the type of model to do thetieback (like a rate limit block to simulate the operation of a valve). The tieback-typerulebook was designed to rapidly configure low-fidelity, simple tieback models forcontrol 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. InModel Data View, model objects and their parameters display in tabular, customizablespreadsheet format that provide visualization and bulk parameterization capability. BulkConfigurator supports model objects from every available Dynsim engine, includingDynsim, 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


9/96


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 UOMfor 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 themwith 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 AudienceThis guide is intended for engineers (Application Engineers, Instrumentation and Control,or Process engineers) who have a high level of familiarity with Distributed ControlSystems (DCS) or Programmable Logic Controllers (PLCs), and in particular FoxboroI/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 tiebacksimulation Bulk Configurator.


10/96


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 andconnect 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)

Checkout Equipment


11/96


Introduction to Tieback SimulationTieback simulation is a method for testing process control system loop configurations, byconnecting output I/O back to input I/O (within the same control loop), either directly orthrough some kind of filtering function. For instance, a MOTOR RUN COMMAND

digital output can be connected directly back to the MOTOR RUNNING STATUS digitalinput in a simulation environment, to test operation of the motor control logic. Anotherexample would be to test a vessel level control loop by tying the VESSEL LEVELCONTROL VALVE (0-100%) analog output back to the VESSEL LEVEL (FT) analoginput, 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 theloops 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 thecontrol system is going to work once it is installed in the plant. Tieback testing is usuallysimple in nature, but is sufficient to find misconnected control blocks, parameterizationerrors, mis-linked graphics, incorrect high/low limits, etc., that could not (very easily) befound by static testing.

A Bulk Configuration tool is extremely valuable for tieback simulation, in that it providesa mechanism to apply rules in order to automatically create model objects and tie themoff to appropriate I/O points; the rules take advantage of I/O block naming conventions tospecify the type of model to do the tieback (like a rate limit block to simulate theoperation of a valve). It is especially handy for control systems with thousands of I/Opoints, especially when many typical control loops are repeated.

This document describes the function and use of the Tieback Simulation BulkConfigurator, 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 enginesare different. Hence all the products have the same look and feel. The term DSS GUI maybe used to refer to any of the product user interfaces.)

This document will discuss tieback simulation types and general simulation topics, beforegetting into the specifics of the Bulk Configurator.


12/96


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 processcontrol 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


13/96


Until recently, tieback-type testing required various configurations of control systemhardware to accomplish. One type of tieback simulation involves staging the entirehardware and software systems to be assembled, with tieback done by using actual wiresor signal generators to loop output signals back to input signals on the I/O module (asalready shown in Figure 2). Another approach, requiring less hardware, is to build

simulation-type blocks within the actual control system software, and connect thesesimulation 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 controlprocessors are still required for block processing. I/O software blocks modification, toturn off the connection to I/O hardware, and to reconfigure the block to accept inputsfrom the simulation block is required

Another method (Figure 4) uses commercially available simulation software, such asCAPE VPLink, to provide simple process simulation algorithms to stimulate the controlsystem I/O. Like the second method, the I/O control blocks still need to be modified toturn off their connection to the physical I/O modules, but now the off-board simulationsoftware reads/writes to the I/O blocks via a special Application Programming Interface(API).

K

AOUT

To I/OModule

AIN

FromI/OModule

LAG

Specially-insertedSimulation

Block

Modifyblocks to

turn offconnectionto I/OModule


14/96


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 turnoff connection to physical I/O

With the Tieback Simulation Bulk Configurator addition to the Dynamic SimulationSuite, many of the shortcomings of the alternative tieback approaches have beenaddressed through an approach called Virtual Stimulation Control Simulation(Figure 5):


15/96


16/96


In the subject of control system checkout using tieback simulation, the primary challengelies with understanding control engineering and with the specifics of the control systemitself. However, essential simulation concepts are requisite to tieback simulation BulkConfigurator discussion.

Important Simulation Concepts

The concepts discussed in this section are a subset of those contained in the FSIM PlusGetting Started Guideand the Trisim Plus Getting Started Guide. They are presentedhere as an introduction and the minimum pre-requisite knowledge required before tiebacksimulations can be built. Please refer to these manuals as well as theInstallationandUser Guidesfor more detailed information.

Simulation Engines

In process simulation, every entity in that simulation is considered anEngine. A typicalbasic simulation requires at least two simulation engines: one for the Foxboro I/A Seriescontrol system (or Triconex controller) and one for the tieback process model. A morecomplex system example to be includes a Foxboro I/A Series DCS and a Triconex safetysystem; in this case, three engines include one for I/A Series, one for Triconex, and onefor the process model. As a complex example, a large high-fidelity Operator TrainingSimulator might have many control systems and an extensive process model. Such asystem may have tens of engines one for each of the control system entities, andperhaps several for the process model itself (large detailed process models need to besplit up to be able to run on different computers or processors in order to have acceptablespeed). Figure 7 shows the engine concept.

Figure 7. Simulation Engine Architecture

DCS

SIM4ME

DynsimEngine

ExcelEngine

PLC

GUI

3rdPartyEngine


17/96


Time Control and Synchronization

One advantage the InvensysDynamic Simulation Suite has over the types discussed inprevious sections is the concept of time control. In a nutshell, time control refers to theability 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 theprocess, like the filling of a large vessel). Expressed as a % of real time (i.e. thewall 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 engines execution cycle (like Basic ProcessingCycle 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 regulationof this time-marching sequence controls the simulation speed (Slow, Real, or Fast Time).The Simulation Executive ensures deterministicoperation, meaning that exactly the sameresults occur for an operation scenario run from a saved initial condition, if the actions inthe 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 orincrementally changed, the change does not take effect until the block has processed atleast one cycle.

Cross Referencing

Cross Referencing can be thought of like a marshalling cabinet (Figure 5): it connectscontrol system I/O points to the simulated process, like the copper wires that connect I/Omodules to sensors and actuators in the field in the real world. Cross Referencingconnects 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 thecontrol system. Therefore, From DynsimEngine to FSIMEngine refers to an I/A Seriessoftware input (analog input in this illustration). The points connected are the FromSymbol and To Symbol. As a minimum, one line exists in the Cross Reference tablefor each I/O point in the entire simulation.


18/96


Model Objects and Parameters

The Dynsim dynamic simulation environment is object-oriented, with each modelingobject a certain Classthat 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 isreferenced by the ObjectName.Parameter; a parameter can be an input, output, or aconfiguration 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 LT5T27s 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 berestored to the exact same operating point as when the snapshot was taken. Save andrestore snapshots through the Dynamic Simulation Suite Graphical User Interface. ForFSIM, a snapshot can be thought of as a checkpoint file, the main difference is that asnapshot 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 existingcontrols modified. FSIMs Snapshot Management Utility (SSMU) performs this actionautomatically when an out-of-date snapshot restores. The update starts with thecheckpoint file and pushes values of settable/connectable parameters from the snapshot into the checkpoint file, then saves the result as the updated snapshot.

The second consideration is that the checkpoint file must be valid when rebooting thecomputer or restoring a snapshot. With simulation the checkpoint file isonlyvalid ifblocks process after (re)deploying the controls (i.e., run the simulation) and manuallyperforming Checkpoint after processing blocks: the automatic checkpoint that occursbefore 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 thecheckpoint file contents, initialize all controls mapped to the FSIM Station and reboot theFSIM Station.


19/96


TRISIM Engine Snapshots

For the TRISIM engine, restoring older snapshots is not problematic: if an object or tagexisted in the old controls, those values populate the control system on a reset. Newobjects 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 advantageover other methods in that multiple I/A Series Control Processors (CPs) can be simulatedon a single desktop or laptop PC (Figure 6). Additionally, a mix of I/A Series CPs andTriconex Tricon/Trident controllers can be simulated simultaneously. Recent advancesin FSIM Plus and simulation enhancement added to I/A Series software now allowmultiple CPs to be kept segregated, even though they are all run on one super controlprocessor, 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 segregatecontrols. This step is typically a one-time setup for each project. Refer to the FSIM PlusUser Guide for details.

Another important point is the physical limit to the number of I/A Series CPs mapped to asingle FSIM Station. This limit is based on the size of the control set, the number ofpeer-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 estimationsake 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 ofSimulated Control Processors


20/96


TRISIM Engine Multiple PLC Simulation

With Triconex TriStation, configuring multiple PT2 files per simulation also requiresinitial setup to instantiate emulator filenames (to the NodeName). Although no changesto 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 configurationis required within the TRISIM engine. For communication between FSIM and TRISIM,some manual cross referencing within DSS is needed. The TRISIM Plus User Guidecontains details for each of these configurations.


21/96


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 BulkConfigurator, the current model data and cross reference table in the DSSdatabase/simulation, are imported into the Excel spreadsheet.

The user can then,

(a) Perform model edits and manual cross referencing by simply typinginto 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)


22/96


(c) Use the Rulebook (described in subsequent sections) to automaticallybulk-configure a large number of model objects, based on parsing I/Otag records in the cross reference table (only in Checkout View).

(d) Rename model objects in bulk and update the database, cross referenceand ICs appropriately (only in Model Data View).

Note: Launch the Bulk Configurator from the DSS GUI and not by double-clicking theExcel file.

Components of the Bulk Configurator

Once launched, two main interfaces appear (Figure 11a):

Excel Workbook1. Cross Reference Worksheet Tab

2. Model (Checkout) Worksheet Tab (Checkout View)OrModel Worksheet Tab (Model Data View)

Action Pane1. View selection2. User Action Buttons3. Status Messages display box

Figure 11a. Tieback Simulation Bulk Configurator


23/96


24/96


Refresh Update data from the Dynsim application into the XRef andModel (Checkout)/Model sheets. No need to close and openBulk Configurator to update with this integrated two-way datatransfer 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 ApplyRules. 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 filtercriteria

Apply Rules Update Cross Reference table and model objects withinthe Bulk Configurator environment

Model Data View Actions

Configure Model DataView

Select which objects appear based on the Dynsimlibrary, such as Checkout Equipment, ProcessEquipment, 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 optioncontains additional menu options (Figure 13).

Document Actions (activate Actions Pane), Help (Bulk Configurator documentation)


25/96


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 atieback simulation.

Tieback Simulation WorkflowMore generally, the workflow includes (for a new project):

1. Load new controls2. Create a new (empty) simulation3. 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 Rules6. Apply Rules and populate the Cross Reference and Model (Checkout) sheet s


26/96


7. Send the modified Cross Reference table and model objects back to thesimulation

8. Use the simulation to test loopback control logic9. Repeat 3-8 as needed

(The Model Data View may be used to view and modify model objects that are notsupported in the Checkout View).

The following sections will discuss in detail items 4-7. Details for all other items may befound in the FSIM Plusor TRISIM Plus User Guides.

Find details for other items in the FSIM Plus,TRISIM Plus, or Dynsim User Guides.


27/96


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 thisview, under the Model tab, only model objects configurable through the Rulebookappear. To view model objects that are not configurable with the Rulebook, but exist inthe 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) unlikethe DSS GUI where a model object is represented graphically on a flowsheet (Figure15b). The graphical representation of the model object is shown in the flowsheet on theright and the model object and its parameters are shown in the Instances tree on the left.


28/96


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 modelobject.


29/96


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 intentionallyto provide the users of the Bulk Configurator with the most commonly usedparametersthat are needed for tieback simulation.

The Model Data View of Model objects, shown in Figure 15d, provides more objectparameterization 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 parameterswithin specific object types.

Figure 15d. Model Data View of Model Object XV1


30/96


Utilize any of the four views in Figure 15 to make editing changes. However, for the sakeof simplicity, this document concentrates only on the Bulk Configurator (refer to theDynamic Simulation Suite Users Guide for more details on creating/editing models fromthe DSS GUI).

Rulebook

The Rulebook (Figure 16) enables rule creation to parse I/O block (tag) names in theCross Reference table, create and configure model objects based on matches to filtercriteria, and then connect the model inputs and outputs to the I/O block outputs andinputs 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 aRulebook Entry.

Figure 17a. Rulebook Entry (part 1)

1. Enable Rule When selecting Apply Rules, this rule will execute2. Overwrite:

None Does not overwrite previously-definedor custom entries for XRef or model(None willoverwrite default pointsin XRef)

XRef Overwrite any applicable XRef entries


31/96


Model Overwrite any applicable model entries

Both Overwrite model and XRef entries3. Description Text field describing rule4. Control Engine The non-Dynsim engine, such as FSIM Plus engine or

TRISIM Plus engine

5. Filter UsingOut/In Tag Tells the rule which I/O point is the search tag andwhich is the resulting paste tag6. 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 thesearch 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 bespecified for a rule to be valid, specifying the other tagis not required. If specified, the Bulk Configurator tiesthe paste tag to the model.

Important:Be sure to properly specify search/replace expressions and select the correctFilter 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 theControl OutTag field.

A replace expression [e.g., $1:U$2.POINT] may be specified in theControl 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 InTag 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 RegularExpressions. Be sure to generate valid DSS modelnames (start with alphabet and no special characters)when applying the rule.


32/96


10. Model In Param Tie the control system Output Tag to this ModelInput parameter. A selection of None implies no tieback for that tag.

11. Model Out Param Tie this model Output parameter back to thiscontrol 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 analogsignals.

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 classspecification 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 modelclass and a set of parameter values associated with it. Applying a rule creates severalmodel objects based on matches in the XRef sheet and populates the model objectparameters 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 tothose considered most important in tieback models. Access the complete parameter listof parameters through the DSS GUI. If needed, online documentation and the DynamicSimulation Suite User Guide can help.

A replace regular expression may be used to bulk configure equations for parameterfields. Prefix this expression with # to indicate that it is a regular expression.


33/96


Figure 19. Regular Expression

When processing this rule, the expression automatically expands and parameter valuesfill with the corresponding equation. In the above example, the parameter PV could beexpanded to FV5F01.OUT, FV5F02.OUT, FV5F03.OUT, etc. This feature enables modelobject 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.

.Figure 20. Save Rules


34/96


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 tiebackmodel for the following control loop (Figure 22):


35/96


Figure 22. Typical Control Loop

If this loop is typical and repeated many times in the control system, the user can create arule to generate a tieback model for each instance of this loop type. An English-languageversion of the rule might state:

1. Find any DCS output tag in a) any compound, b) that has block namestarting 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 object4. Find any DCS input tag in a) the same compound, b) that has block name

beginning with LI and c) the same loop ID, and5. 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 calledRegular Expressions. Regular Expressionsare 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.


36/96


37/96


Dynsim Model specifications for a given rule change and the rule reprocesses (seeRulebook Section below).

Model (Checkout) sheet validation occurs first, prompting for errors, as needed. Correctthe 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 forscaling


38/96


When the entries change by applying rules, the updated cells highlight to emphasizeRulebook processing (Figure 23b). Previously highlighted lines clear when reapplyingrules.

Figure 27b. Bulk Configurator Cross Reference Table Highlighted after RulesApplied

Validation

DSS expects the cross reference data in a certain format and therefore Bulk Configuratorprevents column deletion or rearrangement. Likewise, it prevents sheet deletion orrenaming.


39/96


Model (Checkout) Worksheet

The Model Worksheet displays available bulk-configured model data in a Model sheetas 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 Dynsimprocess models (HeatExchanger, Drum, Column, etc.) are not supported by the BulkConfigurator, and do not appear in the model worksheet when opened. The Send toDSS command does not overwrite the portion of the simulation containing modelclasses not maintained by the Bulk Configurator.

Model ObjectDefinition

ModelParameters


40/96


Parameters

The parameter names for the model objects display at the top of the worksheet withappropriate parameters for the model class in line with the highlighted cell. Selecting arow 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 aretypically modified in a tieback simulation. Reducing the parameter set to the minimumeases configuration.

Figure 28b. Model Worksheet N/A Parameters and Comments

The number of supported parameters for the different model classes differs. TheDYNAMIC_INTEGER for example, supports only one parameter (VALUE) while aVALVE supports more. An unused column displays N/A in the corresponding headercell. Send to DSS updates valid columns and ignores columns that display N/A.

Header cells include comments for clarity. Select and manipulate data using standardExcel features, such as Conditional Filtering.

Parameter Input Dialog

Select a row in the Model sheet and right click on any cell to display Parameter InputDialog 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 thesheet or from Input Parameter Dialog (updating data in one updates the data in the other,Figure 29b).


41/96


Figure 29a. Parameter Input Dialog

Figure 29b. Parameter Input Dialog


42/96


Edit with the Parameter Input Dialog for manual configuration. Invalid values (e.g., outof range value) are rejected. When opening the dialog, invalid Excel cell values displayan error in the dialog (a related error message displays in the Status Messages box). UponOK, the value(s) in the dialog write back to the Excel cell(s).

Some model parameters allow DSS equations / parameter references. Specify a numericvalue or an equation in such cases. Validation is not performed in the equation field andmay 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 rowin the Model (Checkout) sheet. Be sure to delete empty rows: when performing Send toDSS, 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 flowsheetsin the DSS before opening the Bulk Configurator.

Non-existent flowsheet specification defaults the flowsheet value to the first flowsheet inthe 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 inthe Model (Checkout) sheet . The flowsheet name resets to the flowsheet containing theoriginal object. Move objects between flowsheets through the DSS interface.


43/96


44/96


subsequently opens the Bulk Configurator, the Bulk Configurator automatically picks theDSS changes. Although the DSS GUI and Bulk Configurator can remain opensimultaneously, recommended workflow to avoid inadvertent conflicts follows thesesteps:

1. From DSS, launch Bulk Configurator2. Do not make any further changes to model through DSS while Bulk Configuratoris open

3. Make desired modeling changes within Bulk Configurator4. When done, send to DSS5. Close Bulk Configurator6. Repeat as needed

Configure either within the Bulk Configurator orwithin the DSS GUI, but not both at thesame time.

Status Messages

Information, Warning, and Error messages display in the Status Message window, colorcoded with Information (blue), Warning (orange) and Error (red). Review statusmessages for warning and error details.

Figure 31. Status Messages


45/96


Messages are also displayed in Excel status bar.

Figure 32. Invalid Configuration

The Clear button removes accumulated messages.

Model Data ViewThe Model Data View contains the XRef (cross reference) and Model worksheets.

When the Model Data View radio button is selected, the Rulebook and Apply Rulesbuttons become inactive and the Configure Model Data View, Rename Model Objects,and Model Data View settings buttons become active. Before actually viewing modelsunder Model Data View, set up the model classes and parameters to view using theConfigure Model Data View button.

When the Configure Model Data View button is clicked, the Configure Model DataView 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 fromwhich the user can select the list of parameters to be shown in the Model sheet.


46/96


Figure 33. Configure Model Data View


47/96


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 theUnit of Measure selection should be overwritten. Objects are broken down intocategories related to their library. For instance, objects available with a Dynsim-Clicense are grouped under Base Checkout Equipment. Within a library, individual objectscan be included or excluded. This file can be exported and shared or modified, asneeded.


48/96


Customize the models and parameters

By default, Model Data View displays parameters that likely require parameterizationand not every available parameter. The reason is that for most objects, the defaultsettings 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 ofMeasure in the respective fields and click OK.


49/96


Import / Export Model Data View

Import the predefined view and Export the customized view through the ConfigureModel Data View dialog. The Model Data View can be exported / imported only in xmlformat.

Import

Import a predefined Model Data View by clicking on the Importbutton. Select thedesired xml file from the Import XML File window and click Open, as shown in Figure37.

Figure 37. Import Dialog

Export

Export the customized Model Data View selection file by clicking on the Exportbutton.Select the customized Model Data View xml file from the Save dialog and click Save,asshown in Figure 38.


50/96


Figure 38. Export Dialog

Restore Default View

Restore the original Model Data View before making changes to the Model sheet byclicking the Restore Default Viewbutton.

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 Objectsbutton. 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 otherobjects or equations, object references or inputs to widgets, and snapshots.

To rename the model objects globally, enter the new model name in the New ModelName field and click Rename Model Objectsbutton. The current Model object isreplaced with the new model name.


51/96


Figure 39. Rename Model Objects

Note:Renaming will work only on the ICs stored in the local machine where theBulkConfigurator is running. Before renaming, user collects all his ICs on to his localmachine by using the Collect feature in the Dynsim application. After renaming, usershould redistribute the ICs.

Model Data View settings

Most objects contain a set of shared parameter names, such as Value, UOM, orAssignment. When viewed through Model Data View, those parameters do notuniversally align in a single column heading. In order to limit the data viewed throughBulk Configurator, users can optionally hide or show specific parameters through ModelData View settings. On clicking the Model Data View settingsbutton a dialog pops-updisplaying the parameter columns. Select / unselect the parameter columns to hide /unhide.

Figure 40. Model Data View settings


52/96


Model Data View Navigation Features

Within the Model Data View, Bulk Configurator includes additional custom features tofacilitate object parameterization. These features are discussed below.

Convert UOM

The Convert UOM option enables the user to change/convert the default units to thedesired units. The Convert UOM dialog appears by right-clicking on the UOM cell thatcontains an existing UOM (i.e., MISSING UOM is not valid) and by selecting thechange/convert Units menu. Select the desired UOM and click Change Units or ConvertValue button. Select the Long Descriptions checkbox to display the long descriptions ofUOM.

Figure 41. Convert / Change Units

Custom Column Views

A column is a special case and contains several vector parameters whose size isdependent on the number of stages. Unlike other vector parameters, the column vectorparameters are displayed in rows. This mode of display is more convenient for the user tohave all stage wise data in one column.

Figure 42. OEV Display of TOWER temperature data at different stages


53/96


Figure 43. Bulk Configurator display of TOWER temperature data at differentstages

The column/tower also has sections and many vector parameters that are of the sizeequivalent to number of sections. Bulk Configurator segregates all the vector parametersof 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.


54/96


Figure 46. OEV display of TOWER - composition data at different stages

Figure 47. Bulk Configurator display of TOWER composition data at different

stagesNote: The following index parameters for TOWER model are not displayed on Model

worksheet: STAGEIDX, STAGEIDX2, STAGEIDX3, STAGEIDXSUMPFlash001.SolidIDX and SumpFlash.SolidIDX.


55/96


Static, Dynamic and States Data

The Bulk Configurator displays all the STATIC data including the Default Data. Thisdata is obtained from Dynsim Edit Engine. It also displays the parameter values when theSimulation 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 notlive 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 highlightsin red under Status Messages.

The tool does not provide validation of the model parameter values. Care should be taken

to provide valid Dynsim data.

Figure 48. Validate Data Message Box


56/96


57/96

Tieback Simulation Model Classes


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, availableparameters, and example usage. The same or similar-type tieback model can be createdmany different ways, according to the preference of the control engineer. The readershould carefully review the all examples to get an idea of alternate approaches to buildingmodels, as well how to handle special situations (like selectively overwriting orprotecting 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 TRANSMITTERFT049 (0 TO 550 GPM)

Field I/A


58/96



Note: A Dynamic point value updates while the simulation runs. Either change thevalue 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 aSTATIC_DOUBLE model point.

STATIC_DOUBLE

Type: General Purpose Double Precision Constant, or Table Array

Parameters:


ISFUNCTABLE TRUE/FALSE TRUE implies table-lookup array (seeFCTNGEN description). FALSE implies singledynamic (i.e. variable) double precision number

VALUE[0] Any FP number

VALUE[1] Any FP number Only used for a table arrayVALUE[2] Any FP number Only used for a table array

VALUE[3] Any FP number Only used for a table array





Monitor

Slider BarWidget


59/96



Example Use: Lookup Table Array

Parameter Value DescriptionISFUNCTABLE TRUE X-Y Table Array

VALUE[0] 5 Number of X-Y PairsVALUE[1] 0 (not used)

VALUE[2] -100000 1stPair X Value

VALUE[3] -15 1stPair y ValueVALUE[4] -25 2nd Pair X Value

VALUE[5] -15 2nd Pair Y ValueVALUE[6] 15 3rd Pair X Value

VALUE[7] 10 3rd Pair Y ValueVALUE[8] 25 4th Pair X Value

VALUE[9] 15 4th Pair Y Value

VALUE[10] 100000 5th Pair X ValueVALUE[11] 15 5th Pair Y Value

Note:Use with FCTGEN block. If the X lookup value exceeds 100000 in the exampleabove, the value clamps to the last Y value in the table (i.e. the table lookup doesnot extrapolate). Similarly, if lookup falls below -100000, the output clips.


Enter an array directly into the Model flowsheet or, alternatively, add it in the DSS GUI.

-25 15 25

15

10

-15


60/96



DYNAMIC_INTEGER

Type: General Purpose Integer Variable

Parameters:


VALUE Any positive ornegative integer,or zero

Example Use: Motor Run Command/Feedback Status

Parameterization:


VALUE Assigned in Cross Reference table for both

output and input


Note: In this example, the control system Digital Output writes to theDYNAMIC_INTEGER, which in turn writes back to the Digital Input. The usermay 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 theCross Reference tool from the user interface).

COUT CIN

I/A Field I/A

1MCC:XU6P13.COUT 1MCC:XU6P13_M.CIN

XU6P13M

MOTOR6P13RUNCOMMAND


61/96



STATIC_INTEGER

Type: General Purpose Integer Constant

Parameters:


VALUE Any positive ornegative integer,or zero

Example Use: Local/Remote Interlock Status

Parameterization:


VALUE 1 Always Remote Status


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 pointin the cross reference table).

CIN

1CST:PB1_LOCAL.FBCIM

PB1_LOC

MOTORLOCAL/REMOTESTATUS (1=REMOTE)


62/96



LATCH

Type: Set/Reset Latching Block (flip-flop)

Parameters:


SET 0/1 Set latchRESET 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 OutputOUTR 1/0 Inverse Output

Example Use: Motor Run Start/Stop Command with Feedback Status

Parameterization:


SET Leave blank (connected in cross reference)

RESET Leave blank (connected in cross reference)


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 statusfeedback. The second rule connects the stop command to the RESET parameter.

COUT CIN

I/A Field I/A

1MCC:XU6P13ST.COUT 1MCC:XU6P13_M.CINXU6P13M

MOTOR6P13STARTCOMMAND

LATCH

COUT

MOTOR6P13STOP

COMMAND

1MCC:XU6P13SP.COUT


63/96



AND, OR

Type: Logic Blocks, with four inputs

Parameters:


INP[0] 0/1 First inputINP[1] 0/1 Second input

INP[2] 0/1 Third input

INP[3] 0/1 Fourth inputINV_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 inputMA 0/1 Man/Auto

OUT 0/1 Output

Example Use: Fan run command with Local Lockout

Parameterization:

Parameter Value DescriptionINP[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 DefaultINV_INP[1] 1 Invert local lockout

INV_INP[2] Unused

INV_INP[3] Unused

COUT CIN

I/A Field I/A

1PHFAN:XUPHF.COUT 1PHFAN:XUPHF_M.CINXUPHF

PENTHOUSEFAN RUNCOMMAND

AND

COUT

PENTHOUSEFAN LOCALLOCKOUT

1PHFAN:XUPHFLO.COUT


64/96




Note:The AND block feeds back running status if Run Command is true and LocalLockout is not true.

FCTGEN

Type: Function Generator

Parameters:


IN Any FP number Input x-coordinate to interpolateTABLE 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 valueHI_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


65/96



Parameterization:


IN PT512 Pressure variable

TABLE PRESS_VS_TEMP[0] Table array that relates temperature vs.

pressureHI_OUT (optional, can leave blank)

LO_OUTMA

MANSET

OUT Assigned in Cross Reference table

HI_LIM

LO_LIM

Note: In this example, the user sets the value of PT512. The corresponding temperaturefeedback depends on the table look up using this value. See STATIC_DOUBLE

to configure table array.


Enter a function generator directly into the Model flowsheet or add it in the DSS GUI.

RLIMIT

Type: Rate Limit Block.

Parameters:

Parameter Value DescriptionIN Any FP Input value or point to be rate-limited

RTYPE LINEAR,FIRST_ORDER

Rate limit type: linear or first-order lag

RATE Any FP >= 0.0 Ramp rate, in Units/second. If RTYPE =FIRST_ORDER, then RATE is first-orderlag time constant Tau (steady-state reachedin approximately 3 * Tau)

K_IN Any FP or point Scalar on input value

B_IN Any FP or point Bias on input value

HI_OUT Any FP or point High output limit

LO_OUT Any FP or point Low output limitMA 0, 1 or integerpoint Man/Auto status

MANSET Any FP or point Value of output when in Manual

OUT Any FP Output value

HI_LIM 0, 1 Flag to indicate high limit reached



66/96



Example Use #1: Control Valve with open and closed limit switch feedback

Parameterization:


IN Assigned in Cross Reference tableRTYPE LINEAR Linear rate limitRATE 5 5%/second; full travel in 20 seconds

K_IN Scalar on input value

B_IN Bias on input value

HI_OUT 100 High output limit when output reaches 100%

LO_OUT 0 Low output limit when output reaches 0%

Example #1 Rulebook Entry:

Note: This example illustrates the power of the rulebook and its ability to create a modeland connect several I/O points at the same time.

Interpret the first line as follows: for all flow control valves FY*, create a rate limit blockand call it FV*.

In the second and third lines, the algorithm searches for the same flow control, butoverwrite is set to XRef only, which does not redefine the rate limit block created inthe first line, but connects the Low and High Limit outputs of the (already created) ratelimit block to the Closed and Open Limit Switch digital inputs, respectively. Ensure loopidentifier consistency (224 in this example in the figure above) for all three I/O points.

CIN

CIN

1FP:ZSC224.CIN

CLOSED LIMIT SWITCH

OPEN LIMIT SWITCH

1FP:ZSO224.CIN

I/A Field I/A

AOUT

1FP:FY224.OUT

RLIMITIN

LO_LIM

HI_LIM

FV224


67/96


68/96




Note: In this example, the XRef Auto Scale checkbox is ticked. This selectionautomatically scales the feedback to the Analog Input such that 0% input equatesto the AINs LSCALE parameter, and 100% equates to HSCALE (MIN SCALEand MAX SCALE in the Cross Reference table). This functionality is achievedby automatically creating an equation entry in the table, rather than pasting intothe FROM SYMBOL column:

The auto scaling equals:

MIN SCALE + VALUE (0-100%)*(MAX SCALE MIN SCALE) / 100

The user can make custom equations in the cross reference table, however, only include

one entry in the FROM SYMBOL column or the EQUATION column, not both (whichcauses a run time error message when attempting to load the cross reference table).

Example Use #3: Same as Example #2, except engineer desires to calculateEngineering Units instead of auto scaling. When the valve reaches 80% open, the ratedflow measures 200 GPM

Parameterization:


IN Assigned in Cross Reference table

RTYPE FIRST_ORDER Response with first order lagRATE 3 3 second time constant (approx 9 seconds to

steady-state)K_IN 2.5 Scalar on input value

B_IN 0 Bias on input value

HI_OUT 250

LO_OUT 0


69/96



The XRef Auto Scale checkbox should not be ticked, and instead the user should specifyK_IN and B_IN to give the desired rated flow:

K_IN = 200GPM / 80% (rated flow)B_IN = 0 (no flow for closed valve)


It is not strictly necessary to specify HI_OUT and LO_OUT, as signal limiting alsooccurs in the cross reference table (signal limited to a maximum of 225 GPM).

Example Use #4: Jog Valve

Parameterization:


IN (see Notebelow) Assigned in Cross Reference table

RTYPE LINEAR Linear rate limit

RATE 5 5%/second; full travel in 20 secondsK_IN Scalar on input value

B_IN Bias on input valueHI_OUT 100 High output limit when output reaches 100%

LO_OUT 0 Low output limit when output reaches 0%

CIN

CIN

1FP:ZSC301.CIN

CLOSED LIMIT SWITCH

OPEN LIMIT SWITCH

1FP:ZSO301.CIN

I/A Field I/A

1FP:XS301R.COUT

RLIMITLO_LIM

HI_LIM

V301

COUT

COUT

1FP:XS301L.COUT

VALVE 301RAISE

LOWER

V301R

V301L


70/96




Note: In this two-step model, Open and Close command points are bulk-created and anequation simulates a jog valve in the Rate Limit block. The syntax of the equationfollows:

V301.IN = IF(V301R = 1, 100, IF(V301L = 1, 0, V301.OUT))

Translating to:

If Raise Command is true, then rate limit input is 100%, else if Lower Command

is true, then rate limit input is 0%, else input = current position.

Equation syntax is very powerful and many types of models can be economically-created. See standard DSS documentation for MISCEQTN to find moreinformation on valid equation syntax.

PID

Type: General Proportional plus Integral plus Derivative Math Block (uses PID controlalgorithm)

Parameters:

Parameter Value DescriptionSP Any FP, point Setpoint

PV Any FP, point Process Variable

KP Any FP Proportional Gain

KI Any FP Integral Gain

KD Any FP Derivative GainHI_OUT Any FP High output limit

LO_OUT Any FP Low output limit

MA 0, 1 or integerpoint Man/Auto status


OUT Any FP Output valueHI_LIM 0, 1 Flag to indicate high limit reached



71/96



Algorithm:

Error = SP PVProportional = Kp * Errord/dt Integral = Kp * Ki * Error

d/dt Deriv = PV Deriv / (Period + 1/Kd)Derivative = Kp * Kd *(PV Deriv)Out = Proportional + Integral + Derivative

Example Use #1: Tank with Level Control Valve and Pumps

Parameterization:


SP Connected to Level Control valve output in

Cross Reference table (0 100%)PV 45 * (XU5P57A +

XU5P57B)Flow out tank = 45% * Pump A and/or Brun status (90% maximum)

KP Leave blank for integral-only action

KI 0.01 Adjust to obtain desired fill/drain rate

KD Derivative GainHI_OUT 100 High output limit

LO_OUT 0 Low output limit


72/96


73/96



If the rulebook entry in Example #1 above was used as-is, the output from the tank modelwould not be entered in the cross reference table, since the analog input is in a differentcompound from the analog output. To remedy this limitation, add another entry:

Note the following:

Rule #2: removed Control In Tag (because the tag is in a different compound the rulewould be unsuccessful for tying back the analog input because it wouldnt be found).

Rule #3: moved the Control In Tag here from Rule 2, and Filter using In Tag ischecked.

Rule #3: Model Name repeated from Rule 2, however Overwrite is set to XRef inRule 3. This algorithm means that the model object defined by Rule 2 is not overwritten,but its output is used to tie back to the analog input.

SUM

Type: Sums two signals. Each input signal can be scaled.

Parameters:


IN[0] Any FP, point First input

IN[1] Any FP, point Second inputK_IN[0] Any FP Scalar on first input

K_IN[1] Any FP Scalar on second input

B_IN[0] Any FP Bias on first input

B_IN[1] Any FP Bias on second input

HI_OUT Any FP High output limitLO_OUT Any FP Low output limit

MA 0, 1 or integerpoint Man/Auto status


OUT Any FP Output valueHI_LIM 0, 1 Flag to indicate high limit reached



74/96



Example: Split Range Control Valves and Flow Feedback

Parameterization:


IN[0] Leave blank connected in cross reference

tableIN[1] Leave blank connected in cross referencetable

K_IN[0] 0.25 1stvalve 25% of capacity (small valve)K_IN[1] 0.75 2ndvalve 75% of capacity (big valve)

B_IN[0] Leave blank (=0)B_IN[1] Leave blank (=0)

Example Rulebook Entry

Note: This model is configured with two rules: the first to define the SUM block andconnect the A valve, the second to connect the B valve. The first rule alsoconnects to the single flow transmitter feedback. In Rule 2 that Overwrite is setto XRef; this ensures that the model defined in Rule 1 is not overwritten; onlythe cross reference entries are connected. The XRef Auto Scale is selected sothat 0 100% on the input automatically scales to high and low scale engineering

units of the analog input.

TIMER

Type: Time delay on, time delay off, pulse timer

AIN

1FP:FI224.POINT

Flow: 0 to 500 GPM

I/A Field I/A

AOUT

1FP:FY224A.OUTSUMIN[0]

IN[1]

OUT

FT224

FlowControlValve A,0-100%

AOUT

1FP:FY224B.OUT

FlowControlValve B,0-100%


75/96



Parameters:


START 0,1 Start timer

PRESET Any FP Timer setting (seconds)

TYPE PULSEEXTENDED PULSEON DELAYSTORED ONDELAYOFF DELAY

Type of timer

MA 0,1 Man/AutoOUT 0,1 Timer output

ACCUM FP Stored timing value

TIMING 0,1 Timing in progress

The various types of timers are illustrated by the figures below:


76/96


77/96


78/96


79/96



Example: Pressure Control Valve

Parameterization:


IN Leave blank, will be connected in crossreference table

KLAG 10 10 second time constant (reaches steady-statein approximately 30 seconds)

KLEAD Not used

Example Rulebook Entry

I/A Field I/A

5E01:PY5E01.OUT

VESSELE01PRESSURECONTROL

PTE01

AINAOUT LEADLAG

5E01:PI5E01.OUT

VESSELE01PRESSURE


80/96




81/96



MISCEQTN

Type: General purpose miscellaneous equation block

Parameters:


OUT[0] Equation Any valid Dynsim equation

OUT[1]

OUT[2]OUT[3]

OUT[4]

OUT[5]

OUT[6]OUT[7]

OUT[8]OUT[9]

OUT[10]

OUT[11]

The MISCEQTN equation syntax is identical to the Microsoft Excel application. Thefollowing types of operations are supported:

Operator Description Operator

SpecifiedFirst

Argument

StyleOperands

Priority # of

Operands

Example

+ Plus No No 3 2 Var1 + Var2

- Minus No No 3 2 Var1 - Var2

x Multiply No No 2 2 Var1 x Var2

/ Divide No No 2 2 Var1 / Var2- Negative Yes No 1 1 - Var1

^ Power No No 1 2 Var1 ^ Var2

& And (result is1.0 if bothare not 0.0)

No No 4 2 Var1 & Var2

| Or (result is1.0 if eitheris not 0.0)

No No 4 2 Var1 | Var2

> greater than No No 4 2 Var1 > Var2< less than No No 4 2 Var1 < Var2

== Equal to No No 4 2 Var1 == Var2

! Not (inverse Yes No 1 1 ! Var1


82/96



Operator Description OperatorSpecified

First

ArgumentStyle

Operands

Priority # ofOperands

Example

logical)

EQFF Equivalent

flowcoefficientsin series

Yes Yes 1 2 eqff(Var1,

Var2)

CINTRP1

Functiongenerator

Yes Yes 1 2 cintrp1(Var1,Tab1)

LIM01 Limitsbetween 0.0and 1.0

Yes Yes 1 1 lim01(Var1)

LIMV Limitsbetweenminimum

andmaximum

Yes Yes 1 3 limv(Var1, Min,Max)

MAX maximum of2 values

Yes Yes 1 2 max(Var1,Var2)

MIN minimum of2 values

Yes Yes 1 2 min(Var1,Var2)

ABS absolutevalue

Yes Yes 1 1 abs(Var1)

RAND random noise Yes Yes 1 2 rand(Amp,Period)

IF if statement Yes Yes 1 3 if(condition,

true value, falsevalue)

SIN Sine Yes Yes 1 1 sin(var1)COS Cosine Yes Yes 1 1 cos(var1)TAN Tangent Yes Yes 1 1 tan(var1)ASIN Arc sine Yes Yes 1 1 asin(var1)ACOS Arc cosine Yes Yes 1 1 acos(var1)ATAN Arc tangent Yes Yes 1 1 atan(var1)EXP Exponential,

base eYes Yes 1 1 exp(var1)

LOG Natural

logarithm(base e),argumentmust begreater than0

Yes Yes 1 1 log(var1)

LOG10 Base 10logarithm,

Yes Yes 1 1 Log10(var1)


83/96



Operator Description

Documents

BulkConfigurator_V11