DCS FTExchange - Getting Started With RGS v1.2

DCS FTExchange

R9.04.00 SP1

Getting Started with RGS

Page 1 of 30 File name: DCS FTExchange - Getting started

with RGS v1.2.doc

Revision history and distribution

Status Version Date Author Distribution Remarks

Draft 1.0 March 2012

R.Houtman GSC Internal First version

Final 1.1 March

2012 R.Houtman YHQ, GSC Corrected after review

1.2 Aug 2012 R.Houtman YHQ, GSC For Japanese system

Approval

Name Department Date Sign

Yokogawa GSC Template name/version: Project Document GSC 4.1

Project name : DCS FTExchange for RGS GSC project nr : 33I-11-0005 Date : 30/08/12 GSC doc. code : GSC-R-20120404-01 Version : 1.0


with RGS v1.2.doc

Table of Contents

1. Introduction ............................................................................................................................................ 3 1.1 Purpose ...................................................................................................................................... 3 1.2 Audience ................................................................................................................................... 3 1.3 Validity ..................................................................................................................................... 3 1.4 Known issues ............................................................................................................................ 4 1.5 Abbreviations ............................................................................................................................ 4

2. Basic architecture ................................................................................................................................... 5 2.1 Applicability ............................................................................................................................. 6 2.2 Data throughput......................................................................................................................... 6

3. Getting started ........................................................................................................................................ 7 3.1 Interface at start-up ................................................................................................................... 7 3.2 Creating a new project .............................................................................................................. 9

4. Task Pane ............................................................................................................................................. 12 4.1 Import DCS ............................................................................................................................. 13 4.2 Import RS ................................................................................................................................ 15 4.3 Import MTL ............................................................................................................................ 17 4.4 Publish ..................................................................................................................................... 22

5. The publication .................................................................................................................................... 28 5.1 Loading the publication .......................................................................................................... 28

ERROR! NO TABLE OF CONTENTS ENTRIES FOUND.



with RGS v1.2.doc

1. Introduction

1.1 Purpose

This document explains the basic steps from how to create an RGS project up to how to load a

FAST/TOOLS system with the publication as created by the DCS FTExchange tool.

1.2 Audience

The reader is expected to have knowledge how to operate a FAST/TOOLS system. This includes starting

FAST/TOOLS, checking its installed components and properties and working with the engineering module.

Since DCS FTExchange reads data from DCS (both FCS, SCS and UGS stations) basic knowledge

regarding project location and file-export facilities of Prosafe-RS is required.

1.3 Validity

This documented is created against DCS FTExchange R9.04.00 SP1



with RGS v1.2.doc

1.4 Known issues

- File selector focus issue. To click the Prosafe-RS .csv file selector, first click the left cell, then the [] on the file selector

cell.

- Currently DCS Unicode text is expected to be Latin/ ISO-8859-1 format.

- After execution of the loader script, the Java VM may show a failure during shutdown/finalize(). Note: Scripts execution was already performed before that.

- For a Japanese Windows system, you need a publication to be created using DCS FtExchange with /plib/standard publication library.zip version 1.2

- Loading the publication (running load.cmd) doesnt function with directory paths having Japanese characters. This is encountered when running on a Japanese Windows XP system. This is

because the Jython runtime doesnt support the ms932 encoding.

1.5 Abbreviations

GSC Global SCADA Center

RGS Remote Gateway Station. A FAST/TOOLS host running vnet equipment driver.

FTS FAST/TOOLS Server. A FAST/TOOLS host running host-host equipment driver.

SCS Prosafe-RS Safety Control station

FCS CENTUM Field Control Station

UGS CENTUM Unified Gateway Station



with RGS v1.2.doc

2. Basic architecture

Figure 1: Showing the relation between FTS, RGS and DCS

The above impression shows that per DCS project a RGS node is available on the Vnet. Then using the

FAST/TOOLS host-host facility the RGS node is connected to the centralized FTS node.

The RGS and FTS configuration is created by the DCS FTExchange tool. Creating an RGS project with

this tool lets you import settings from one DCS project. A DCS project typically contains multiple FCS,

SCS and UGS stations which will provide I/O data to the DCS.

FCS and UGS data is extracted without needing additional information. Prosafe-RS configuration is

partially retrieved from the DCS configuration because of TUV regulation. More detailed information is

then read from CSV files produced by the Prosafe-RS engineering tool.

In addition to settings retrieved from the DCS project, there is the option to use a so called Master Tag

List. This MTL is actually just a .csv file for the purpose of overwriting settings such as tagname,

description, button color, format string etc.



with RGS v1.2.doc

2.1 Applicability

The typical setup is as follows;

One FTS system connecting to multiple RGS systems.

One RGS system per Vnet-IP domain.

One RGS project created in DCS FTExchange will retrieve the setting of exactly one DCS project. Thus

in case of a multi-project DCS environment where two Vnet-IP domains are interconnected, there will be

two RGS projects. Although not advisable, publications of multiple RGS projects can be loaded onto a

single RGS node. It is advised to use one RGS node per DCS domain.

Each RGS project will generate a publication. A publication is nothing more than a directory containing

the files which need to be taken to the RGS and FTS nodes and run there to execute the update.

The FAST/TOOLS version must be R9.04 SP1 or higher.

Tests were performed against CENTUM-VP R50120.

2.2 Data throughput

An RGS station (FAST/TOOLS with Vnet equipment driver) will be continuously reading data for each

station it is configured for. FAST/TOOLS will be running a single Vnet equipment process called

EQPVNET. This process is setup by default to read a maximum of 20 buffers per seconds. Thus each

vnet-station-definition set up in FAST/TOOLS is individually limited to that 20 buffers/sec. limit. In case

throughput needs to be in-/decreased that limit can be modified in the setup file linked to that equipment

process, effectively changing the limit for all the stations using that equipment process.

The FTS station is connected to the RGS station using the host-host equipment driver. Because currently

(R9.04 SP1) each host-host station is limited to holding 64K of items, each vnet-station as defined on the

RGS is accompanied by a host-host station on the FTS machine. Unlike for the RGS, at the FTS machine

each host-host station uses its own line definition (i.e. equipment process).



with RGS v1.2.doc

3. Getting started

3.1 Interface at start-up

Figure 2: Main interface

The main interface shows the task sheet for the selected project (called TTA in the picture above). From

here import and publish task can be started. The dropdown button on each task button gives access to

configuration options.

The first time you start the program, the screen will show up as below because it detected a publisher

library which has not yet been extracted.

Panel for quick

access to import and

publish tasks

Open projects pane

Detail output pane.

Can be enabled by

the button

Desktop pane which

holds opened dialogs



with RGS v1.2.doc

Figure 3: Unpacking publisher library

When you see this screen the application is unpacking the publisher library as found in the /plib

subfolder.

In case a new publisher library has been manually copied there, a manual action can be performed to

check for changes at runtime by clicking Tools > Scan for Publisher changes as shown below. A restart of

the application would pick up any new publisher libraries as well.

Figure 4: Manually check for publisher updates



with RGS v1.2.doc

3.2 Creating a new project

By selecting File > New Project the next dialog appears;

From here select RGS project. This will open the New project wizard as shown next;

Figure 5: New Project Wizard, panel 1

The first panel which is called Location asks for the project name and the project folder. The project

name can only contain 16 characters and consist of the characters [A-Z] _ - and the space.

The project folder can be selected by clicking the browse button.

The project file which will be created is shown after the storage: label.

You can click continue when all fields are filled in correctly.



with RGS v1.2.doc


This next panel is called Defaults. This pane requires you to enter:

Project abbreviation. This shorter name will be used in FAST/TOOLS definitions often in combination with the DCS station names( e.g. for lines, stations and status items).

The dur numbers for the FTS and RGS machines are required. These numbers can be found in the license information of each system.

Note: This tool doesnt set up a multi-node dur environment. This is left to the system integrator.

Please see the related manuals for that.

Queue name of the host-host server. The system integrator is expected to setup the RGS machine to run this server process. By default this server process will be called EQPHHCSRV1.

If all entries are filled in correctly the continue button will be enabled.



with RGS v1.2.doc


This panel lets you select the publisher library. By default there is only one library provided called

standard publisher library. Advanced users are able to add custom publisher libraries. This feature will

not be addressed in this document.

Clicking Done will close this dialog, create the project file and show the task pane.



with RGS v1.2.doc

4. Task Pane

The task pane gives an overview of which steps are available. After creating a new project, all steps will

show Not configured. Although the MTL is not required to be set-up, the import RS step is required

only if there are one or more Prosafe-RS stations found in the DCS configuration. The Publish step is of

course required.

By default if the task says Not configured, the play button ( ) will take you to the configuration part

of the wizard. If configuration is done, consequent clicks will take to you the part in the wizard which will

perform the action. I.e. importing or publishing. By selecting the little down arrow ( ) you can get to all

the actions available to that task.



with RGS v1.2.doc

4.1 Import DCS

Running the Importing DCS task for the first time will show the next dialog.

It requires you to locate the DCS project you wich to import its configuration from. By clicking the browse

button the DCS project directory can be located. Note that a DCS project directory will show up with a blue

icon:

Select folder and press Accept, then press Continue.



with RGS v1.2.doc

The next panel will show an overview of the DCS project found. This will also be the panel where the

play button will take you the next time.

Clicking Finish will start importing the configuration data. The Import panel will appear, showing a

progress report:

Click Done when finished.

The Import DCS task will now show the time at which the import was finished.



with RGS v1.2.doc

4.2 Import RS

When the Import DCS project found Prosafe-RS stations, those SCS tags can only be used when

combined with more detailed SCS tag data.

For this the Prosafe-RS engineer should generate a .CSV file from the SENG for each SCS station, and

supply it to the RGS project

This file should be selected by using the next panel:

You can type in the name, or a file selector can be used clicking the [] button.

The file names should adhere to the convention SCS.csv. A valid file name will

be marked with a blue icon as shown below.

Note: The interface is set up so that the Prosafe-RS engineer should update the same file with the latest

version. In that case this configuration panel can be skipped, and importing can be started directly by

clicking the play button( ) from the task pane.

If you dont need tags for a specific SCS stations you can leave the entry empty. Stations that do not have a

.csv file allocated will not be skipped during publishing.

Click Continue if the required stations are configured to go to the Summary panel.



with RGS v1.2.doc

This panel merely shows an overview of which files will be imported. Clicking Finish will start

importing.

When importing is finished click Done



with RGS v1.2.doc

4.3 Import MTL

The MTL (Master Tag List) option exists in order for the engineer to supply additional information to the

imported tags. The most common operation would be to supply shorter tags names than the original DCS

tags. Other properties such as description, format string, button color etc. can be overwritten. Essentially all

information which is not provided by DCS but are options to FAST/TOOLS can be entered here.

Below an example showing why an MTL would need to supply shorter tag names:

FAST/TOOLS R9.04 allows up to 15 characters for the itemtag part. Unlike DCS, where a tag (e.g.

12PID001 ) has data items like .PV .SV etc. FAST/TOOLS uses a different approach. This results in the

following;

A DCS tag 12PID001 of type PID will create the following FAST/TOOLS definitions:

- A so called installation with the name set to (See project properties). Let s assume it was set to prj1

- A so called unit with the name of the station containing the tag. E.g. FCS0103

- An object called O12PID001 of class DCS_PID ( An object is always prefixed with the letter O )

- An object of type DCS_PID creates items by appending the tag name with _PV _SV _MV for every data item. But also internal tags are created.( e.g. _TAG). This results in items in the form:

< project abbreviation>..

PRJ1.FSC0103.12PID001_PV

PRJ1.FSC0103.12PID001_MV

PRJ1.FSC0103.12PID001_SV

PRJ1.FSC0103.12PID001_TAG

The example above creates items for which itemtag uses already 11 characters. So when the DCS tag

name exceeds 11 characters, then adding the suffix which can be up to 4 characters will exceed the 15

character limit. For that reason a shorter name can be provided in the MTL file.



with RGS v1.2.doc

The standard publisher library allows entry of the following values:

MTL variable name Description

MTL_TAGNAME Matches the DCS tagname

Type: VARCHAR(16) UNIQUE

MTL_NEWTAGNAME11 Provides a shortened tag name.Up to 11 characters

Type: VARCHAR(11)

MTL_INSTALLATION Overwrites the default installation. The default equals the project

abbreviation.

Type: VARCHAR(16)

MTL_UNIT Overwrites the default unit. The default equals the DCS station

name.

Type: VARCHAR(16)

MTL_DESCRIPTION Overwrites the description which was found in DCS

Type: VARCHAR(64)

MTL_PROCESSAREA Assigns a process area. Valid values are 0-99.This ties in with the

FAST/TOOLS authorization scheme.

Type: INTEGER

MTL_AOINAME Assigns this objects items to an Area of interest, which is a

FAST/TOOLS filtering mechanism for alarming. Note that when

supplying a value, the actual Area of interestdefinition must

already be available in both the RGS and FTS systems.

Type: VARCHAR(16)

MTL_PVFORMAT Overwrites the PV value format as read from DCS

Type: VARCHAR(24)

MTL_MVFORMAT Overwrites the MV value format as read from DCS

Type: VARCHAR(24)

MTL_BUTTONCOLORTOP Overwrites the top button color

Type: VARCHAR(12)

MTL_BUTTONCOLORBOTTOM Overwrites the bottom button color

Type: VARCHAR(12)

MTL_RS_DATAITEM Used for Prosafe-RS SCI_I and SCO_I data types Type:

VARCHAR(6)

MTL_AUXFLAG Can be used for supplying arbitrary information to the publication

Tag filter.

Type: VARCHAR(24)

The MTL .csv file can contain any column with arbitrary column names. The wizard will ask for a mapping

form the found column names to the MTL variable name. All but the MTL_TAGNAME field may be left

blank/unmapped.



with RGS v1.2.doc

Configure the MTL file for the first time by clicking the

play button( ) from the task panel. If you already

configured it once, then dropdown the menu and select

configure from there.

The wizard will ask for a .csv file.

Once found with the Browse button click Continue



with RGS v1.2.doc

The next panel will ask for a mapping between the columns found in the .csv file, and the available MTL

variables.

By default the entries in the column .CSV file Source column will list the columns in the order as found

in the .csv file. By double-clicking the cell, a dropdown list lets you select another column as shown below.

Selecting the first value (a blank) will disable the mapping for that particular MTL variable.

Once that is finished, click Continue to go to the Inspect panel.



with RGS v1.2.doc

The Inspect panel will read the first 200 records and will show any errors which would occur during

importing. Any rows containing errors will be excluded from import. If an error is found (marked in red)

the table will jump to the first occurrence. Hovering over the cell will show the problem.

Clicking Inspect More.. will read another 200 rows. This button will be enabled until the end of the .csv

file is reached.

To correct a problem click Go Back. This will bring you to the Set Columns panel. Now you can correct

the MTL csv file. Once the .csv file is edited to be correct you can go back to this panel to verify your

changes.

Clicking Finish will perform the actual import. Any rows which still contains a problem is excluded and

listed as shown below.

Click Done to close this panel.



with RGS v1.2.doc

4.4 Publish

If you click the play button from the task panel the status bar will show Merging DCS, RS and MTL

table as shown below:

Progress is indicated with the ..

In total there will be 5 pairs ... Once merging is finished, the wizard will appear.

A publication is a set of files created under a directory with the name as specified with Name pattern.

The lable Example: shows what the actual storage location would be.

The Name pattern can be a fixed name. Using {} allows you to specify a data/time pattern as explained in

the java Simple data time format.(

http://docs.oracle.com/javase/1.4.2/docs/api/java/text/SimpleDateFormat.html )

The Overwrite sttings provide the option to just overwrite an existing directory, or if it will append a

number to the Name pattern. It will try the suffix _00, but if the resulting directory exists it will try

_01 etc. until it found a non-existing directory name.

Once the folder to store each publication is provided, the Continue button will get you to the Filtering

panel.

http://docs.oracle.com/javase/1.4.2/docs/api/java/text/SimpleDateFormat.html



with RGS v1.2.doc

The filtering panel will show the default string: TYPE LIKE '%PVI%' OR TYPE LIKE '%PID%'

The Examples tab explains the use of the Filter expression.

In short; any valid SQL where clause is accepted. Once you change the expression, the [Test] button will

become enabled and the [Continue] button will be disabled. When you click the [Test] button or press

Ctrl+Enter, the filter expression is tested. An invalid expression will show the Errors tab. A valid

expression will show the Test Results panel as shown below. The table allows for Excel like inspection.

All rows which are marked with X are matching the filter expression and are selected for publishing. Note

that the MTL variable MTL_AUXFLAG is provided for the sake of importing arbitrary data from the

MTL file and being able to filter on it here.

Click Continue if the appropriate tags are selected.



with RGS v1.2.doc

The Summary panel looks as follows:

If the first two panels (Location and Filtering) are configured, this panel will show up the next time you

press the play button ( ) for the publish task.

The overview shows the basic set of settings used for publishing. A copy of this summary is written to the

publication directory itself under the name publishReport.txt

In the case an MTL file is configured for use, a list of all the tags which were selected for publishing but

are not available in the MTL file is provided as shown under Note: in the above image.

The next steps in this wizard will append their results to the publishRerport.txt file.

Click Continue to start step 1 of the publication process.

Publication is a two-step process. The panels involved are named:

- Convert This step is also called Step 1, since it executes the first script in the publication library.

- Inspect This step is available to the engineers who need to dive into the details of the publication scripts.

By default this panel is skipped.

- Publish This step is also called Step 2, since it executes the second script in the publication library.



with RGS v1.2.doc

The first step in the publication process is to convert the tag list into values which will be written to

file in the second stage of the publication process.

In case the intermediate results of the publisher library need to be inspected, the Skip inspection can be

unticked. This way the next panel called Inspect will not be skipped.

The output window (activated by the button in the toolbar) shows more detailed output generated by

the publisher library

As shown above, the publisher library can report errors. These errors will be stored in 2 tables and will be

written to text-files during step 2 of the publication process.



with RGS v1.2.doc

Beside to name format errors or (unsupported) type errors, the tag names can also be duplicates.

This can be caused by the original DCS project already containing duplicate tag names, or after renaming

the tag by means of the MTL duplicates were introduced.

These will be listed in the result pane as follows:

Click Continue if you are aware of any errors and want to generate a publication.

The below DCS id's result in duplicates for FAST/TOOLS object name / item

Use the Master Tag List(MTL) column 'MTL_NEWTAGNAME11' to correct the tag name issues.

DCS tag: FCS1101.1101RC00010A

duplicate in objectname:TTA.FCS1101.ORC00010A

duplicate in itemname: TTA.FCS1101.RC00010A

DCS tag: FCS1101.1104RC00010A

duplicate in objectname:TTA.FCS1101.ORC00010A

duplicate in itemname: TTA.FCS1101.RC00010A



with RGS v1.2.doc

The last panel called Publish will create the actual publication as files in the publication directory.

By default the open publication folder is ticked. This will show the folder using windows explorer after

clicking Done.



with RGS v1.2.doc

5. The publication

When the publishing task finished successfully, the publication directory will contain the following;

5.1 Loading the publication

The load.cmd script must be executed on the actual FTS and RGS systems. Transporting this

publication directory to those systems is the responsibility of the engineer.

In case the system character encoding is not supported (e.g. ms932 on Japanese windows systems) the

script will start in limited mode. In this mode both the directory where this publication resides and where

FAST/TOOLS resides may only contain ascii characters.

Be sure to run the load.cmd script with administrative privileges. When running Windows7 etc. use:

Typical execution would show something like:

If the machine is identified as either FTS or RGS and FAST/TOOLS is running, the next stages of loading

can be identified:

- Loading RGS/FTS prerequisites. The classes, template items and all other definitions needed before loading any publication make

up the prerequisites.

- Loading the RGS/FTS definitions. These are the definitions generated by running the publish task, containing the object definitions

mapping to the DCS tag names.

- Loading and rebuilding the FTS displays. These are the LIST displays containing a sorted list of indicator symbols for each tag name in your

publication. Note that tags from previous publications are not included, unless those tags still

passed the publication filter and thus are part of this publication as well.

Command file started

Jython engine preparing

Script execution started

Command file waiting for input

Script output



with RGS v1.2.doc

Next a decomposition of a successful run of the load scipt and the sub scripts it executes:

The main script parses both the quickoad output files (.qlo ) as well as the display validation output for

errors. If some definitions failed to load or some LIST_* displays failed to load, the main script will list all

the file names containing a detailed description of the error.

Loading prerequisites

This script will ask for user input before closing

Main script

Shows the results of sub-scripts.

This script will ask for user input before closing.

Note: The output of this screen is

not saved to a file

Loading FTS quickloads

This script will close automatically

Loading and validating the LIST

displays

This script will close automatically



with RGS v1.2.doc

End Of Document

DCS FTExchange - Getting Started With RGS v1.2

Documents

Transcript of DCS FTExchange - Getting Started With RGS v1.2