Database Structure
- Last UpdatedApr 20, 2020
- 14 minute read
Cross Reference data entries for analog points differ slightly from those for digital points. Each point type is presented separately in the tables below.
Analog Points
|
Column Name |
Description |
Required / Optional |
|
Disabled |
Selecting the disabled option disables this line. After disabling the line, reload the cross reference database. |
Optional |
|
From Engine |
The Engine name from which the controls/object points/parameters are cross referenced. For example, an AIN (analog input) block requires a value from a field device. The DYNSIM-L engine’s process model sends a value. The From Engine is the name of the DYNSIM-L engine. |
Required |
|
From Symbol |
The variable, model object parameter, or control point cross referenced from an Engine specified in the "From Engine" field. Model object parameters are accessed using the syntax: ObjectName.Parameter |
Required unless a conversion equation is specified |
|
From Val Info |
Some control emulators and interfaces use this entry for reference purposes only |
Optional |
|
To Engine |
The Engine name to which the controls/object points/parameters are cross referenced. For example, for an analog input value, it might be set to the name of the SCPEngine |
Required |
|
To Symbol |
The parameter or control point, which receives cross reference values from "From Symbol". For example, for an analog input value, it might be set to the Compound:Block.Parameter from the Foxboro Evo control configuration. |
Required |
|
To Val Info |
Some control emulators and interfaces use this entry for references purposes only. |
Optional |
|
Conversion Type |
This contains the Fox SCI type number associated with the I/O block |
Required |
|
Spare 2 - 5 |
Extra fields for comments or third-party engines |
Optional |
|
Comments |
Field for engineering annotations. |
Optional |
Note: When multiple engines are configured in DYNSIM (a mix of DYNSIM and non DYNSIM engines), it is possible to have the same point names. This does not affect the Cross Reference table. The "From Symbol" can have duplicate names, but from different engines.
Digital Points
|
Column Name |
Description |
Required /Optional |
|
Disabled |
Selecting the disabled option disables this line. After disabling the line, reload the cross-reference database. |
Optional |
|
From Engine |
The Engine name from which the controls/object points/parameters are cross referenced. For a digital input, it might be set to the name of the DYNSIM-L engine. For a digital output, it might be set to the SCP engine name. |
Required |
|
From Symbol |
The variable or model object parameters or control point cross referenced from an Engine specified in the "From Engine" field. For a digital input, it might be set to the name of a model variable name from DYNSIM-L engine. For a digital output, it might be set to the Compound:Block.Parameter name. |
Required unless a conversion equation is specified |
|
From Val Info |
Some control emulators and interfaces use this entry for references purposes only. |
Optional |
|
To Engine |
The Engine name to which the controls/object points/parameters are cross referenced. For a digital input, it might be set to the name of the SCP engine. For a digital output, it might be set to DYNSIM-L engine name. |
Required |
|
To Symbol |
The parameter or control point, which receives cross reference values from "From Symbol". For a digital input, it might be set to the Compound:Block.Parameter name. For a digital output, it might be set to the name of a model variable name from the DYNSIM-L engine. |
Required |
|
To Val Info |
Some control emulators and interfaces use this entry for references purposes only. |
Optional |
|
Spare 2 - 5 |
Extra fields for comments or third-party engines |
Optional |
|
Comments |
Field for engineering annotation |
Optional |
I/O Control Blocks
In most cases, access to the Foxboro Evo I/O control blocks is normally obtained using the standard "Compound:Block.Parameter" (C:B.P) format. Some blocks include internal parameters that do not appear in the Detail Display. To facilitate access to the block’s parameters, "pseudo-parameter" naming is used to access the block’s I/O data. Some of the parameter names match that of a Foxboro Evo block parameter, while others are available only in the SCP environment.
The parameter names are automatically appended through the Automatic Cross Reference Generation Tool available through the GUI or through a command line batch file.
Note: Cross referencing to points other than actual I/O may cause the simulator to behave differently than an actual control system.
The points listed below are actual I/O. Requirements for automatic cross reference generation are listed in this table.
|
Block |
Configuration Notes |
|
AI |
Controls Configuration: IOM_ID must be set to a valid ECB device CHANNL must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Analog "To Symbol" Compound:Block.POINT |
|
AIN |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device SCI type required for conversion from raw counts to conditioned value PNT_NO must be unique for IOM_ID Cross Reference Configuration: Analog "To Symbol" Compound:Block.POINT If EXTBLK is set, the point must be "uncharacterized" and the high/low and min/max limits must be manually modified to prevent clipping If Thermocouple or RTD device is connected, the cross reference point created is Analog "To Symbol" Compound:Block.POINT_TEMP. See "Cold Junction Compensation" below See "I/O Control Block Scaling" below |
|
AINR |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device SCI type required for conversion from raw counts to conditioned value PNT_NO must be unique for IOM_ID Cross Reference Configuration: Analog "To Symbol" Compound:Block.POINT If EXTBLK is set, the point must be "uncharacterized" and the high/low and min/max limits must be manually modified to prevent clipping If Thermocouple or RTD device is connected, the cross reference point created is Analog "To Symbol" Compound:Block.POINT_TEMP. See "Cold Junction Compensation" below See "I/O Control Block Scaling" below |
|
AO |
Controls Configuration: IOM_ID must be set to a valid ECB device CHANNL must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Analog "From Symbol" Compound:Block.OUT |
|
AOUT |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID Cross Reference Configuration: Analog "From Symbol" Compound:Block.OUT |
|
AOUTR |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID Cross Reference Configuration: Analog "From Symbol" Compound:Block.POINT |
|
BIN |
Controls Configuration: IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Digital "To Symbol" Compound:Block.FBCIN |
|
BINR |
Controls Configuration: IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Digital "To Symbol" Compound:Block.FBCIN |
|
BOUT |
Controls Configuration: IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Digital "From Symbol" Compound:Block.COUT |
|
BOUTR |
Controls Configuration: IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Digital "From Symbol" Compound:Block.COUT |
|
CIN |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID Cross Reference Configuration: Digital "To Symbol" Compound:Block.FBCIN |
|
CINR |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID Cross Reference Configuration: Digital "To Symbol" Compound:Block.FBCIN |
|
COUT |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID Cross Reference Configuration: Digital "From Symbol" Compound:Block.COUT |
|
COUTR |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID Cross Reference Configuration: Digital "From Symbol" Compound:Block.COUT |
|
DI |
Controls Configuration: IOM_ID must be set to a valid ECB device CHANNL must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Analog "To Symbol" Compound:Block.FBCIN |
|
DO |
Controls Configuration: IOM_ID must be set to a valid ECB device CHANNL must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Analog "From Symbol" Compound:Block.COUT |
|
DPIDA |
Controls Configuration: IOM_ID must be set to a valid ECB device Cross Reference Configuration: Analog "To Symbol" Compound:Block.POINT Analog "To Symbol" Compound:Block.MEAS01 Analog "To Symbol" Compound:Block.MEAS02 Analog "To Symbol" Compound:Block.MEAS03 Analog "From Symbol" Compound:Block.OUT |
|
EVENT |
Controls Configuration: IOM_ID must be set to a valid ECB device Cross Reference Configuration: Digital "To Symbol" Compound:Block.FBCIN_1 to _32 |
|
GDEV |
Controls Configuration, Input: IOM_ID must be set to a valid ECB device IP_FBM 1 Cross Reference Configuration, Input: Analog "To Symbol" Compound:Block.FBDEVLM1 for closed/stopped Analog "To Symbol" Compound:Block.FBDEVLM2 for open/running Controls Configuration, Output: OP_FBM 1 Two Wire (PLSOPT 0) for sustained, single output Three Wire (PLSOPT 1) for pulse, dual output Cross Reference Configuration: Digital "From Symbol" Compound:Block.COUT_1 (sustained, for PLSOPT 0) Digital "From Symbol" Compound:Block.COUT_1 (start pulse, for PLSOPT Digital "From Symbol" Compound:Block.COUT_2 (stop pulse, for PLSOPT 1) |
|
IIN |
Controls Configuration: IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Signed integers can be positive or negative and range from ( -2147483648 to +2147483647). Unsigned integers are always positive and range from (0 to 4294967295). Analog "To Symbol" Compound:Block.POINT – This is by default listed in the Xref table, and supports signed long. Alternative configurations: If the default option is not appropriate, the user must manually edit the Xref table to add the hidden parameters and disable or delete the default parameter reference that is not used. The user must also change the Xref MinScale, MaxScale, LowLimit, and HiLimit values for the new ranges. Analog "To Symbol" Compound:Block.POINTUSG – This is hidden, and supports unsigned long. |
|
IINR |
Controls Configuration: IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Signed integers can be positive or negative and range from ( -2147483648 to +2147483647). Unsigned integers are always positive and range from (0 to 4294967295). Analog "To Symbol" Compound:Block.POINT_1 and Compound:Block.POINT_2. These are by default listed in the Xref table, and support signed long. Analog "To Symbol" Compount:Block.POINT_3 is created when ARBOPT=1 and supports signed long. Alternative configurations: If the default option is not appropriate, the user must manually edit the Xref table to add the hidden parameters and disable or delete the default parameter reference that is not used. The user must also change the Xref MinScale, MaxScale, LowLimit, and HiLimit values for the new ranges. Analog "To Symbol" Compound:Block.POINTUSG_1, Compound:Block.POINTUSG_2, Compound:Block.POINTUSG_3 – These are hidden, and support unsigned long. |
|
IOUT |
Controls Configuration: IOMID1, 2, 3 must be set to a valid ECB device II1_PT, 2_PT, 3PT must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Analog "To Symbol" Compound:Block.LOUT |
|
MAI |
Controls Configuration: IOM_ID must be set to a valid ECB device CHANNL must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Analog "To Symbol" Compound:Block.PV1 to PV8 |
|
MAIN |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device SCI type required for conversion from raw counts to conditioned value PNT_NO must be unique for IOM_ID Cross Reference Configuration: Analog "To Symbol" Compound:Block.POINT_1 to POINT_8 If EXTBLK is set, the point must be "uncharacterized" and the high/low and min/max limits must be manually modified to prevent clipping If Thermocouple or RTD device is connected, the cross reference point created is Analog "To Symbol" Compound:Block.POINT_TEMP. See "Cold Junction Compensation" below See "I/O Control Block Scaling" below |
|
MAO |
Controls Configuration: IOM_ID must be set to a valid ECB device CHANNL must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Analog "From Symbol" Compound:Block.IN_1 to IN_8 |
|
MCIN |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID Cross Reference Configuration: Digital "To Symbol" Compound:Block.FBCIN_1 to FBCIN_32 |
|
MCOUT |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID Cross Reference Configuration: Digital "From Symbol" Compound:Block.CO_1 to CO_16 |
|
MDACT |
Controls Configuration: IOM_ID must be set to a valid ECB device For ECB Type 34, Feedback lag For ECB Type 36, Pulse Width Modulation Cross Reference Configuration Analog "To Symbol" Compound:Block.POINT Digital "To Symbol" Compound:Block.FBLIMINC state of increase limit switch (true, at the increase limit) Digital "To Symbol" Compound:Block.FBLIMDEC state of decrease limit switch (true, at the decrease limit) Digital "To Symbol" Compound:Block.FBDIHOLD block in hold mode Analog "From Symbol" Compound:Block.UPMDAC (ranges between 0 and 100%) Analog "From Symbol" Compound:Block.DNMDAC (ranges between 0 and 100%) |
|
MDI |
Controls Configuration: IOM_ID must be set to a valid ECB device CHANNL must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Analog "To Symbol" Compound:Block.POINT_1 to POINT_8 |
|
MDO |
Controls Configuration: IOM_ID must be set to a valid ECB device CHANNL must be unique for IOM_ID SIMOPT must be 0 (false) Cross Reference Configuration: Analog "From Symbol" Compound:Block.IN_D1 to IN_D8 |
|
MOVLV |
Controls Configuration, Input: IOM_ID must be set to a valid ECB device IOMOPT must be set to 1 Cross Reference Configuration: Digital "From Symbol" Compound:Block.COUT_1 Digital "From Symbol" Compound:Block.COUT_2 |
|
MTR |
Controls Configuration, Input: IOM_ID must be set to a valid ECB device IOMOPT must be set to 1 Two Wire (OUTOP 0) for sustained, single output Three Wire (OUTOP 1) for pulse, dual output Cross Reference Configuration: Digital "From Symbol" Compound:Block.COUT_1 (sustained, for OUTOP 0) Digital "From Symbol" Compound:Block.COUT_1 (start pulse, for OUTOP 1) Digital "From Symbol" Compound:Block.COUT_2 (stop pulse, for OUTOP 1) |
|
PAKIN |
Controls Configuration: IOM_ID must be set to a valid ECB device SIMOPT must be 0 (false) Cross Reference Configuration Signed integers can be positive or negative and range from ( -2147483648 to +2147483647). Unsigned integers are always positive and range from (0 to 4294967295). Analog "To Symbol" Compound:Block.FBPAKCIN – This is by default listed in Xref table, and supports unsigned long. Alternative configurations: If the default option is not appropriate, the user must manually edit the Xref table to add the hidden parameters and disable or delete the default parameter reference that is not used. Analog "To Symbol" Compound:Block.FBPAKCINSG – This is hidden, and supports signed long. Use when most significant bit determines sign of integer. Analog "To Symbol" Compound:Block.FBBITREVERSE - This is hidden, and supports bit reversal. Use for typical upgrade projects from FSIM to SCP where manual bit reversal was implemented. |
|
PAKINR |
Controls Configuration: IOMID1, 2, 3 must be set to a valid ECB device PK1_PT, PK2_PT, PK3_PT SIMOPT must be 0 (false) Cross Reference Configuration Signed integers can be positive or negative and range from ( -2147483648 to +2147483647). Unsigned integers are always positive and range from (0 to 4294967295). Primary Analog "To Symbol" Compound:Block.FBPAKCINP – This is by default listed in Xref table, and supports unsigned long. Alternative configurations: If the default option is not appropriate, the user must manually edit the Xref table to add the hidden parameters and disable or delete the default parameter reference that is not used. Analog "To Symbol" Compound:Block.FBPAKCINSGP – This is hidden, and supports signed long. Analog "To Symbol" Compound:Block.FBBITREVERSEP - This is hidden, and supports bit reversal. Secondary / Tertiary Analog "To Symbol" Compound:Block.FBPAKCINS – This is by default listed in Xref table, and supports unsigned long. Analog "To Symbol" Compound:Block.FBPAKCINT – This is by default listed in Xref table, and supports unsigned long. Alternative configurations: If the default option is not appropriate, the user must manually edit the Xref table to add the hidden parameters and disable or delete the default parameter reference that is not used. Analog "To Symbol" Compound:Block.FBPAKCINSGS – This is hidden, and supports signed long. Analog "To Symbol" Compound:Block.FBBITREVERSES - This is hidden, and supports bit reversal. Analog "To Symbol" Compound:Block.FBPAKCINSGT – This is hidden, and supports signed long. Analog "To Symbol" Compound:Block.FBBITREVERSET - This is hidden, and supports bit reversal. |
|
PAKOUT |
Controls Configuration: IOM_ID must be set to a valid ECB device SIMOPT must be 0 (false) Cross Reference Configuration Analog "From Symbol" Compound:Block.FBPAKCO |
|
PLB |
Controls Configuration: IOM_ID must be set to a valid ECB device PLB controls must be loaded from a diskette device (not an ICC driver task) to assure the cross reference points are generated automatically from the DYNSIM GUI SIMOPT must be set to 0 Cross Reference Configuration: Digital "To Symbol" Compound:Block.FBCIN_1 to FBCIN_32 Digital "From Symbol" Compound:Block.CO_1 to CO_16 |
|
PLSOUT |
Controls Configuration: IOM_ID must be set to a valid ECB device Two Wire (OUTOP 0) for sustained, single output Three Wire (OUTOP 1) for pulse, dual output SIMOPT must be set to 0 Cross Reference Configuration: Digital "From Symbol" Compound:Block.COUT_1 Digital "From Symbol" Compound:Block.COUT_2 |
|
RIN |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device SCI type required for conversion from raw counts to conditioned value PNT_NO must be unique for IOM_ID SIMOPT must be false (0) Cross Reference Configuration: Analog "To Symbol" Compound:Block.POINT See "I/O Control Block Scaling" below |
|
RINR |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device SCI type required for conversion from raw counts to conditioned value PNT_NO must be unique for IOM_ID SIMOPT must be false (0) Cross Reference Configuration: Analog "To Symbol" Compound:Block.POINT See "I/O Control Block Scaling" below |
|
ROUT |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID SIMOPT must be false (0) Cross Reference Configuration: Analog "From Symbol" Compound:Block.OUT |
|
ROUTR |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID SIMOPT must be false (0) Cross Reference Configuration: Analog "From Symbol" Compound:Block.OUT |
|
VLV |
Controls Configuration: IOMOPT must be set to 1 IOM_ID must be set to a valid ECB device PNT_NO must be unique for IOM_ID Cross Reference Configuration: Analog "From Symbol" Compound:Block.COUT |
I/O Control Block Scaling
Certain input I/O blocks have a special feature in SCP to "assist" the OTS engineer. If the input I/O block has non-default gain and/or bias values and SCI > 0, the SCPEngine will perform the inverse of the gain and/or bias before I/O block performs its gain and/or bias. The gain / bias values of the I/O block are checked one time when the SCP App is started and are expected to remain constant during operation of the simulator (even though they are considered connectable/settable parameters by Foxboro).
The following block types with SCI > 0 are affected:
|
I/O Block Type |
with non-default of gain/bias parameters |
Feature new for SCP version |
|
AIN |
KSCALE / BSCALE |
2.1 HF and greater |
|
AINR |
KSCALE / BSCALE |
2.1 HF and greater |
|
MAIN |
KSCALE / BSCALE |
2.1 HF and greater |
|
RIN |
MGAIN / MBIAS |
2.1 and greater |
|
RINR |
MGAIN / MBIAS |
2.1 and greater |
For example, if the Foxboro HMI displays temperature in deg F, then the Dynsim From Value should be provided in deg F. The values in the Min / Max Scale and Low / Hi Limit columns of the cross reference table should be in deg F too. Any conversion from deg F to deg C and vice versa will be completed by the SIMAPI.
Note: An older project that uses the cross-reference list to perform unit conversions may be affected when its upgrades to a new version of SCP. The recommendation is to remove the unit conversion from the cross-reference list for the above block types. Also check that the values in the Min / Max Scale and Low / Hi Limit columns of the cross reference table are of consistent units of measure.
Cold Junction Compensation
A temperature input read from a thermocouple must be linearized before it can be used. The temperature value must also be compensated for the thermocouple’s cold junction temperature. For more information about the cold junction temperature compensation in a particular block, refer to the Integrated Control Block Descriptions, Volumes 1 & 2 (B0193AX1 & B0193AX2) and search for "cold junction". In particular, refer to these sections:
-
AIN - Sections 2.5.2.2 (Thermocouple Inputs) and 2.5.2.3 (RTD Inputs).
-
AINR - Sections 3.5.2.2 (Thermocouple Inputs) and 3.5.2.3 (RTD Inputs).
-
MAIN - Sections 81.5.2.2 (Thermocouple Inputs) and 81.5.2.3 (RTD Inputs).
The block types AIN, AINR, and MAIN have the ability to received temperature values from the field using thermocouple or RTD devices. How they do so depends on their SCI type and their EBC/FBM type.
Automatic cross reference generation will identify those blocks that require a cold junction temperature for compensation and create an extra line in the cross reference list with the CMP:BLK.POINT_TEMP parameter. For certain blocks and ECB/FBM combinations there may be one extra line for a group of inputs. In that case the extra line in the cross reference may be a CMP:BLK.POINT_9 or CMP:BLK.POINT_15 or CMP:BLK.POINT_33. These are equivalent to .POINT_TEMP.
Important notes for the .POINT_TEMP parameter:
-
This line is required in order for the input to function properly. Do not disable it.
-
Set the "To Value" to ZERO. In simulation we do not need this compensation.
-
No units of measure are required for this point. Simply pass a value of 0 to .POINT_TEMP.
In the real world, the millivolt signal of the transmitter (representing process temperature) is affected by ambient temperature. In the simulator, the process temperature is known exactly, and the measurement is not affected by ambient temperature; therefore, no compensation for ambient temperature is required in the simulation.