 |
Overview
of Project
Software
Requirements
The Import/Export
Process
- FIRSTVUE’s
Default Directories
Process
Overview
Processing
Steps
Rules
- Rules
for INtools User
- Rules
for FIRSTVUE User
Miscellaneous
Topics
Revision Tracking,
One-Directional Fields
Contacts
The Project
Fisher Controls and
PID have worked together to develop an electronic interface between
PID’s INtoolsâ software and Fisher’s FIRSTVUE and FIRST valve
sizing software.
The Process
The normal process
will start in INtools. The INtools user will create Tags and enter
Service Conditions and other pertinent data. He will then export the
data to a file and send the file to the FIRSTVUE user (usually as an
attachment to an e-mail).
The FIRSTVUE user
will import the file, size and select the valve and any accessories,
and export the data to a file. He will then send this file back to
the INtools user (again via e-mail).
The INtools user will
import the file back into INtools to complete the process.
The Scope
The scope of
the data to be exchanged between INtools and FIRSTVUE encompasses
the ISA S20.50 Control Valve Specification Sheet. All fields on the
Spec Sheet will be exchanged between INtools and FIRSTVUE.
Additional fields required for ISA sizing are also included in the
interface. For control reasons, a handful of fields will be
one-directional, meaning that they may only transfer from INtools to
FIRSTVUE or FIRSTVUE to INtools. These fields are listed later in
this document as well as in the INtools user manual.
The Benefits
The electronic
exchange of data between INtools and FIRSTVUE will save time for
users of both systems by eliminating the re-keying of data. It will
also reduce data entry errors for both users.
Overview
This section lists
the Software required to execute the INtools/FIRSTVUE Interface.
Software
Required
INtools User
- INtools version
4.1c or newer
FIRSTVUE User
- Fisher
FIRSTVUE version 1.0P or newer. This version will be released on
the November 1998 CD. IMPORTANT NOTE: The INtools interface
works equally well with Fisher FIRST (November 1998 release or
newer). While most of the associated documentation refers to
FIRSTVUE, please remember that the interface is identical in
FIRST.
- INtools.csm
mapping file. This file is used when exporting from FIRSTVUE
and will be available on the December 1998 CD at Firstvue\INtools\INtools.csm.
It is currently available by contacting Fisher Controls (see
list of Contacts later in this manual). Copy this file to your
pc. If you wish to use the FIRSTVUE default import/export
directories (recommended), see the next section of this
manual.
File
Comparison Utility (Optional)
One of
the biggest issues concering electronic exchange of
specification data is revision control. To address this issue,
Fisher Controls has developed a File Comparison Utility. This
utility compares a file to be imported with a file that was
exported and identifies data that has changed. The utility can
be used BEFORE importing data back into INtools or FIRSTVUE.
Contact Fisher Controls to obtain this free utility.
Other Requirements
INtools User
Set up to insure that the
"Fisher-FIRSTVUE" menu option is available within
INtools under "Interfaces-Export" in the
"File" menu within INtools.
- Set up to insure that the "FIRSTVUE"
hot button is available in the INtools import utility.
Use of control valve "spec 70"
as opposed to the default INtools control valve specification
form. The interface between FIRSTVUE and INtools was written
around the "spec 70" form - misplacement of data will
occur if another form or modification of this form is used.
INtools/FIRSTVUE
Interface
Users Manual - Default Directories
Following are
the default directories that FIRSTVUE uses for import/export. We
recommend using these directories to make import/export a bit easier
to use. To automatically make these directories on your C: drive and
to copy the intools.csm mapping file from the CD to its default
directory, execute Firstvue\INtools\setup.bat from the CD (execute
from this directory even if you are using FIRST). This is a one-time
setup step.
INtools/FIRSTVUE
Interface
Users Manual - Processing Steps
Overview
This section
gives detail on each of the steps in the INtools/FIRSTVUE
interface process.
Step 1 -
Create Tags and enter pertinent data into INtools - INtools user
The
process is designed to start in INtools. (Note: the process can
start in FIRSTVUE, but there are a few extra steps to follow when
importing data into INtools - see the INtools user’s manual for
more information.) The INtools user will create the Tags for the
control valves he needs. He will then enter data on the
requirements of the valve into "spec 70". Some of the
data likely to be entered are Service Conditions and Pipeline
Size.
Step 2
- Export data to a text file - INtools user
When the INtools user has
finished entering data for the control valves he needs, he will
export the data to a text file using the "Fisher-FIRSTVUE"
menu option. See the INtools user’s manual for instructions.
Notes:
For this
export file, and all the import/export files referred to in this
document, the first record contains the field names. The
remainder of the file consists of one record per valve Tag.
Fields are separated (delimited) by a COMMA (","). All
files are simply text files.
We
recommend developing naming standards that will help both
INtools and FIRSTVUE users identify a file. For example, the
file name may be related to the Project Name or Number. We
recommend using a ".csv" extension since INtools
creates a comma delimited file.
Step 3 - Send
file to the FIRSTVUE user - INtools user
If the
FIRSTVUE user is a Fisher Representative, we envision that the
file created in Step 2 will be sent to him as an attachment to an
e-mail. For special cases where the INtools user and the FIRSTVUE
user are at the same location, the file may be placed on a common
network or handed-off via floppy disk.
Step 4 - Copy
file to pc - FV user
When the
FIRSTVUE user receives the file from INtools, he should place it
in a directory on his pc or network. FIRSTVUE’s default
directory for import files is C:\Ff_isa\Import, so we recommend
putting the file in this directory.
Step 5 -
Import file into FIRSTVUE - FV user
This step
imports the INtools file into FIRSTVUE:
Select
Import ISA File from the FIRSTVUE file menu.
Select the
file from Step 4 (change the "List files of type" list
to show .csv files if necessary).
Set the
File Delimiter to ",".
Select the intools.csm map
file (see www.firstvue.com
for download).
Click the
Import button at the bottom of the window to start the import
process.
As the
import process runs, messages will appear in the Import Log.
Audit messages will appear as items are added to FIRSTVUE, and
error messages will appear if errors are encountered in the
data. If you receive any error messages, click the Save Log
button when the import process is completed. Enter the name of a
file to save the log to.
Click the
Close button to close the window.
Notes:
FIRSTVUE
imports items into the project you have open. If you get the
error "Warning: No Active Document" it means that you
don’t have a project open. Open a project and try again.
The
FIRSTVUE import process is "add-only". This means you
cannot update existing items via the import.
Data is
imported into two places. Sizing fields are imported into
sizing. Non-sizing fields are imported as ISA Spec Sheet User
Overrides. Some fields are imported into both places.
Import
messages will appear in the Import Log as the import process
runs. An audit message such as "Tag # of Import File
added to Project as Item #" will appear for each item that
is imported. If you encounter import errors, save the Import Log
as directed above. Using a text editor (such as Notepad), open
the saved log file to investigate further (the default directory
for saving the logs is C:\Ff_isa\Imp_log). It will be up to the
FIRSTVUE user to investigate and resolve all import errors. Some
possible fixes include carefully editing the import file or
having the INtools user fix the problem and re-send the data.
The 3 most common errors that you may encounter are:
- Fluid
State Error - The only valid ISA Fluid States are Liquid, Gas,
and Vapor. If the import encounters something else, you will see
the message "Error in Tag #. FluidState has invalid
value of ‘imported value’. Defaulting to LIQUID for
this item." As the message suggests, the item will be
imported, but its Fluid State will be changed to
"LIQUID".
- Sizing
Field Out of Range - If the import encounters a sizing variable
that is out of range, you will see the message "Error in
Tag #. VariableName has an invalid field value of
‘imported value’. Value Not Set." This item will
be imported, but the value for the variable that is out of range
will be blank.
- Invalid
Sizing Unit of Measure (UOM) - If the import encounters a sizing
UOM that it does not recognize, you will see the message
"Tag #. VariableName has an invalid unit
value of ‘imported value’. Import of this Line
failed." Like the message suggests, this item will NOT be
imported.
Step 6 - Size
and select the valves and any accessories - FV user
Before
starting the sizing and selection process, we recommend printing a
copy of the ISA Spec Sheet for all the imported items. Referring
to this Spec Sheet will aid in the sizing and selection process by
showing any customer preferences specified on the Spec Sheet.
The INtools/FIRSTVUE
interface is based on the ISA S20.50 Spec Sheet and ISA sizing
calculation. When using this interface, you must use the ISA Spec
Sheet and ISA Sizing in FIRSTVUE.
As you
select components, Spec Sheet Data will be populated. Use the User
Overrides column on the ISA Spec Sheet entry screen to complete
the Spec Sheet. The User Overrides column will be highlighted in
BLUE where both a Data and a Override value have been specified,
but do not match.
When filling
out the Spec Sheet, the FIRSTVUE user must follow some basic Rules
so that the data will flow seamlessly back into INtools. These
Rules are documented in the Rules for FIRSTVUE User section
of this manual.
Notes:
Non-sizing
fields are imported into Spec Sheet User Overrides. On export,
User Overrides always take precedence over Data that is
populated during selection. Be sure to review the Spec Sheet
Entry screen for all items before going to the next step.
Step 7 -
Export data to a text file - FV user
When the
FIRSTVUE user has completed the sizing and selection process, and
has reviewed the FIRSTVUE ISA Spec Sheet for each item, it is time
to export the data:
- Select
Export ISA File from the FIRSTVUE file menu.
- Click the
Browse Map button
- Select the "intools.csm"
map file.
- Set the
File Delimiter to ",".
- Verify
that "Only Fields in Map" option is selected.
- Verify
that Custom Names is selected.
- Select
the items you wish to export. You can highlight just certain
items by clicking on them, or select all items by checking the
Select All Items box.
- Click the
Export button at the bottom of the window to start the export
process.
- Enter the
name of the export file you wish to create. We recommend that
you use the default directory (C:\ff_isa\export) and you use the
".csv" extension.
- As each
item is exported, a message will pop up. When the process has
finished, click the OK button to acknowledge the last message
and then click the Close button to close the window.
Step 8 - Send
file to the INtools user - FV user
If the
FIRSTVUE user is a Fisher Representative, we envision that the
file created in Step 7 will be sent back to the INtools user as an
attachment to an e-mail. For special cases where the FIRSTVUE user
and the INtools user are at the same location, the file may be
placed on a common network or handed-off via floppy disk.
Step 9 - Import file into
INtools to update tags with FIRSTVUE data using the
"FIRSTVUE" hot button - INtools user
See the
INtools user’s manual for instructions.
INtools/FIRSTVUE
Interface
Users Manual - Rules of INtools User
Rules for
INtools User
When
creating an export file, the INtools Fluid Phase will be converted
to FIRSTVUE’s Fluid State as follows:
INtools
Fluid Phase FIRSTVUE Fluid State
L
Liquid
W
Liquid
G
Gas
S
Vapor
Always
use "spec 70" form in INtools for control valve
specifications.
INtools
supports many more Units of Measure (UOM’s) than FIRSTVUE. When
entering UOM’s for Process Data and other sizing fields in
INtools, you must be sure to use Units that are supported in
FIRSTVUE. For a complete list of these UOM’s, see the INtools user’s
manual. If you use an unsupported UOM or leave a UOM blank, FIRSTVUE
will default the UOM based on its customized Sizing Configuration -
THIS MAY CAUSE THE WRONG UOM TO BE USED.
Travel
Units (ISA Line 10) are not included in the interface. For Sliding
Stem, Travel Units are assumed to be % Open. For Rotary, Travel
Units are assumed to be Deg Open.
Some
fields used in the interface are one-directional, meaning that they
are only transferred from INtools to FIRSTVUE or from FV to INtools.
A list of these fields appears later in this document. They are also
listed in the INtools user’s manual.
For
additional rules, consult the INtools user’s manual.
INtools/FIRSTVUE
Interface
Users Manual - Rules of FIRSTVUE User
Rules for
FIRSTVUE User
Save all
import error messages to a log file. Immediately investigate log
using an editor such as Notepad.
The
following Sizing Conditions MUST be used:
Condition 1
Minimum
Condition 2
Normal
Condition 3
Maximum
Condition 4
Other / Shut-Off (if Other is used it will be interpreted as
Shut-Off)
The
following spec sheet User Override fields must be NUMERIC:
ISA Line 10
- Maximum, Normal, and Minimum Travel
ISA Line 11
- Maximum, Normal, and Minimum Predicted SPL (preceding
"<" is o.k.)
ISA Line 18
- Maximum Pressure and Maximum Temperature
ISA Line 36
- Trim Rated CV (trailing "Cv" designation is allowed)
Do NOT
enter data in the Insulation Thickness and Insul. Thickness UOM
User Overrides as they are not part of the interface.
After
sizing and selecting in FIRSTVUE, wipeout any undesired spec sheet
overrides for each item before exporting. On export, spec sheet
overrides take precedence over any value populated by attributes
or sizing.
The
following fields appear near the bottom of FIRSTVUE’s ISA Spec
Sheet Entry screen:
Plant
Name Instrument Type Name
Plant
Area Name Line Type
Plant
Area Unit Number Line Number
Loop
Name Specification Form Number
Measured
Variable
These
fields do NOT print on the spec sheet. They exist only to
facilitate the INtools interface. Normally, after importing from
INtools, you will leave these fields alone. However, if you are
initiating tags in FIRSTVUE instead of INtools, these fields
will need to be entered via FIRSTVUE’s User Overrides column.
Please contact the INtools user to obtain valid values for these
fields as well as for valid Tag Numbers.
Also, if
you use FIRSTVUE’s Copy Tag feature, be sure to review these
fields so that they contain the correct values to send back to
INtools.
When
creating an export file, FIRSTVUE will default the Valve
Manufacturer to "FISHER" if it is blank.
Some fields
used in the interface are one-directional, meaning that they are
only transferred from INtools to FIRSTVUE or from FIRSTVUE to
INtools. A list of these fields appears later in this document.
They are also listed in the INtools user’s manual.
INtools/FIRSTVUE
Interface
Users Manual - Miscellaneous Topics
Overview
This section
discusses miscellaneous topics.
Revision
Tracking
Tracking
revisions and data changes will be important to the successful
implementation of this interface. Good communication between
the INtools user and the FIRSTVUE user will be essential. Work
processes will need to be developed and followed. While
INtools ISA Revision fields are passed from INtools to
FIRSTVUE for informational purposes, they are not passed back
into INtools. This is so the INtools user can remain in
control of his own revisions.
To further
help manage revisions, Fisher Controls has developed a File
Comparison Utility to compare export files with import files
BEFORE data is re-imported into INtools or FIRSTVUE. This
utility is very valuable in identifying changes. To get a copy
of the utility, contact Fisher Controls.
One-Directional Fields
The
following list shows INtools and FIRSTVUE fields that are
transferred only one way (from INtools to FIRSTVUE or from
FIRSTVUE to INtools):
INtools
to FIRSTVUE only
- ProjectName
- ProjectUnit
- PONum
- POItemNum
- MFRSerial
- FluidState
- OutPressUOM
- MolWeightMax
- MolWeightMin
- InPipeLineSched
- InPipeLineSize
- PipeLineUOM
- PipeInletDiameter
- PipeOutletDiameter
- All
Revision Fields
FIRSTVUE
to INtools only
- ReqCvMax
- ReqCvNorm
- ReqCvMin
- TravelMax
- TravelNorm
- TravelMin
- PredictSPLMaxValueOnly
- PredictSPLMaxLTSignOnly
- PredictSPLNormValueOnly
- PredictSPLNormLTSignOnly
- PredictSPLMinValueOnly
- PredictSPLMinLTSignOnly
- TrimRatedCvValueOnly
- TrimRatedCvUnitOnly
Overview
This section
list individuals to contact if you have questions or need
support regarding the INtools/FIRSTVUE Interface.
Ordering or
Installing FIRST and FIRSTVUE
- Ken Walton
- Fisher Controls
- Marshalltown, Iowa, USA
- 641-754-
2616
Sales and
Marketing Support
- Alan Talbert
- Fisher
Controls
- Marshalltown,
Iowa, USA
- 641-754-3933
Technical
Support
- Tim
Wignall
- Fisher
Controls
- Marshalltown,
Iowa, USA
- 641-754-3962
|
