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
Figure 11a. Tieback Simulation Bulk Configurator
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:
• Send to DSS Send the modified data to Dynsim simulation
• 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),
• Help (Bulk Configurator documentation)
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
6. Apply Rules and populate the Cross Reference and Model (Checkout) sheet s
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.
Find details for other items in the FSIM Plus, TRISIM Plus, or Dynsim 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.
Figure 15d. Model Data View of Model Object XV1
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)
• XRef Overwrite any applicable XRef entries
• 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.
.
Figure 20. Save Rules
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
Definition Model
Parameters
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
Figure 29b. 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
“Save” button on the toolbar. The 'Save As' option is disabled intentionally to prevent