Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
R9.04.00 SP1
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
1.2
Aug 2012
R.Houtman
YHQ, GSC
Date
Sign
Approval
Name
Yokogawa GSC
Template name/version:
Department
Page 1 of 30
4.1
File name: DCS FTExchange - Getting started
with RGS v1.2.doc
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
Table of Contents
1.
2.
3.
4.
5.
Introduction ............................................................................................................................................ 3
1.1
Purpose ...................................................................................................................................... 3
1.2
Audience ................................................................................................................................... 3
1.3
Validity ..................................................................................................................................... 3
1.4
Known issues ............................................................................................................................ 4
1.5
Abbreviations ............................................................................................................................ 4
Basic architecture ................................................................................................................................... 5
2.1
Applicability ............................................................................................................................. 6
2.2
Data throughput......................................................................................................................... 6
Getting started ........................................................................................................................................ 7
3.1
Interface at start-up ................................................................................................................... 7
3.2
Creating a new project .............................................................................................................. 9
Task Pane ............................................................................................................................................. 12
4.1
Import DCS ............................................................................................................................. 13
4.2
Import RS ................................................................................................................................ 15
4.3
Import MTL ............................................................................................................................ 17
4.4
Publish..................................................................................................................................... 22
The publication .................................................................................................................................... 28
5.1
Loading the publication .......................................................................................................... 28
Page 2 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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
Page 3 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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
<install dir>/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
RGS
FTS
SCS
FCS
UGS
Page 4 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
2. Basic architecture
Page 5 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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.
Page 6 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
3. Getting started
3.1 Interface at start-up
button
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
Page 8 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
From here select RGS project. This will open the New project wizard as shown next;
Page 9 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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.
Page 10 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
Page 11 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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.
Page 12 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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:
Page 13 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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:
Page 14 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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<domain nr><station nr>.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(
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.
Page 15 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
This panel merely shows an overview of which files will be imported. Clicking Finish will start
importing.
Page 16 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
A so called installation with the name set to <project abbreviation> (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 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>.<station>.<dcs tag><suffix>
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.
Page 17 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
MTL_UNIT
MTL_DESCRIPTION
MTL_PROCESSAREA
MTL_AOINAME
MTL_PVFORMAT
MTL_MVFORMAT
MTL_BUTTONCOLORTOP
MTL_BUTTONCOLORBOTTOM
MTL_RS_DATAITEM
MTL_AUXFLAG
Description
Matches the DCS tagname
Type: VARCHAR(16) UNIQUE
Provides a shortened tag name.Up to 11 characters
Type: VARCHAR(11)
Overwrites the default installation. The default equals the project
abbreviation.
Type: VARCHAR(16)
Overwrites the default unit. The default equals the DCS station
name.
Type: VARCHAR(16)
Overwrites the description which was found in DCS
Type: VARCHAR(64)
Assigns a process area. Valid values are 0-99.This ties in with the
FAST/TOOLS authorization scheme.
Type: INTEGER
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)
Overwrites the PV value format as read from DCS
Type: VARCHAR(24)
Overwrites the MV value format as read from DCS
Type: VARCHAR(24)
Overwrites the top button color
Type: VARCHAR(12)
Overwrites the bottom button color
Type: VARCHAR(12)
Used for Prosafe-RS SCI_I and SCO_I data types Type:
VARCHAR(6)
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.
Page 18 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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.
Page 19 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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.
Page 20 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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.
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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:
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.
Page 22 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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.
Page 23 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
If the first two panels (Location and Filtering) are configured, this panel will show up the next time you
press the play button (
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.
Page 24 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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
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.
Page 25 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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:
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
Click Continue if you are aware of any errors and want to generate a publication.
Page 26 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
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.
Page 27 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
5. The publication
When the publishing task finished successfully, the publication directory will contain the following;
If the machine is identified as either FTS or RGS and FAST/TOOLS is running, the next stages of loading
can be identified:
-
Page 28 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
Next a decomposition of a successful run of the load scipt and the sub scripts it executes:
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
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.
Page 29 of 30
Project name
GSC project nr
GSC doc. code
:
:
:
Date
Version
:
:
30/08/12
1.0
End Of Document
Page 30 of 30