Documente Academic
Documente Profesional
Documente Cultură
I-Data Integrator
User's Guide
April 2014
DISO-PE-200008D
Copyright
Copyright © 2008-2014 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains
confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and
international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.
Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.
Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.
Terms of Use
a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the
Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take
precedence and govern the use of this software product and Documentation. Subject to the terms contained within the
applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal,
non-commercial use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial. The Other Documentation may
not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any
reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
2 SmartPlant Isometrics
I-Data Integrator User's Guide
Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL,
SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT
INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS
MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN
CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2)
YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.
IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS
LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.
Export Controls
Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.
b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.
c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.
d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export
Compliance Department, Huntsville, Alabama 35894, USA.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, I-Sketch, I-Tools, I-Configure, ISOGEN, CADWorx, SmartSketch, SPOOLGEN,
Sapphire, and Intergraph Smart are trademarks or registered trademarks of Intergraph Corporation or its subsidiaries in the United
States and other countries. Microsoft and Windows are registered trademarks of Microsoft Corporation. All rights reserved. Other
brands and product names are trademarks of their respective owners.
Contents
Preface .......................................................................................................................................................... 7
Documentation Set ................................................................................................................................. 7
Documentation Comments ..................................................................................................................... 8
What's New in SmartPlant Isometrics I-Data Integrator ......................................................................... 8
Glossary ..................................................................................................................................................... 53
Index ........................................................................................................................................................... 55
SmartPlant Isometrics
I-Data Integrator User's Guide 5
Contents
6 SmartPlant Isometrics
I-Data Integrator User's Guide
Preface
This document is a user's guide for SmartPlant Isometrics I-Data Integrator and provides
conceptual information and procedural instructions for post-processing the report files produced
by SmartPlant Isometrics, SmartPlant Spoolgen, or ISOGEN and then consolidating the data for
transfer to downstream systems. The content is identical to the online Help that is delivered as
part of the I-Data Integrator software.
Intergraph gives you permission to print as many copies of this document as you need for
non-commercial use at your company. You cannot reprint this document for resale or
redistribution outside your company.
Documentation Set
SmartPlant Isometrics documentation is available as Adobe PDF files. To access these PDF
documents, click Help > Printable Guides in the software.
The documentation set is divided into three categories:
Installation guides contain information about installing, configuring, customizing, and
troubleshooting the product.
User's guides provide command reference and how-to information for working in a specific
product. The content is identical to what is delivered in the online Help.
ISOGEN guides
Installation Guides
SmartPlant Isometrics Installation Guide - Provides instructions on installing and configuring the
SmartPlant Isometrics software.
User's Guides
SmartPlant Isometrics User's Guide - Provides guidelines, procedures, and workflows for using
SmartPlant Isometrics to create isometric drawings.
SmartPlant Isometrics I-Convert User's Guide - Provides guidelines, procedures, and workflows
for converting third party plant design data into a format that is compatible with SmartPlant
Isometrics.
SmartPlant Isometrics I-Data Integrator User's Guide - Provides guidelines, procedures and
workflows for using I-Data Integrator to post-process report files.
SmartPlant Isometrics I-Tools User's Guide - Provides instructions for using I-Tools to produce
piping systems by merging IDF/PCF files from other ISOGEN-enabled products.
SmartPlant Symbol Editor User's Guide - Provides guidelines, procedures, and workflows for
using SmartPlant Symbol Editor to create custom symbol shapes to meet your drawing
annotation needs.
SmartPlant Material Editor User's Guide - Provides instructions for using SmartPlant Material
Editor to create reference data, including catalogs and materials specifications.
SmartPlant Isometrics
I-Data Integrator User's Guide 7
Preface
I-Configure User's Guide - Provides guidelines, procedures, and workflows for creating and
managing the isometric directories, projects, and styles used by other products to generate
isometric drawings and reports via ISOGEN.
ISOGEN Configuration User's Guide - Provides guidelines, procedures, and workflows for
configuring the drawing style properties that control ISOGEN isometric drawing and report
output.
ISOGEN Guides
ISOGEN Symbol Key Definitions Reference Guide - Provides information about the ISOGEN
symbol key library. This guide is from Alias, the makers of ISOGEN.
Documentation Comments
We welcome comments or suggestions about this documentation. You can send us an email at:
PPMdoc@intergraph.com.
Documentation updates for supported software versions are available from Intergraph Smart
Support (https://smartsupport.intergraph.com).
8 SmartPlant Isometrics
I-Data Integrator User's Guide
SmartPlant Isometrics I-Data Integrator
SECTION 1
SmartPlant Isometrics
I-Data Integrator User's Guide 9
SmartPlant Isometrics I-Data Integrator
10 SmartPlant Isometrics
I-Data Integrator User's Guide
SmartPlant Isometrics I-Data Integrator
SmartPlant Isometrics does not automatically accumulate material. This is done by adding
queries to the configuration file or by using the reporting tools in other software products, such
as Microsoft Access.
Key Features
SmartPlant Isometrics I-Data Integrator has the following key features:
By default, the software strips out all but the most recent dataset for each pipeline
encountered.
Interactive, command line or Automation execution. For more information, see Process
Pipeline Files (on page 31).
Mandatory, user-configurable XML options file. The file consists of the two sections. The first
section contains user settings, including those displayed in the interface, and a few
additional settings, such as controlling the log file. The second section describes the output
options. For more information, see Appendix: XML Configuration File Syntax (on page 39).
Data from ISOGEN can be integrated with external data, including Access databases, Excel
spreadsheets, or any ODBC compliant data source, such as an Oracle or SQL Server
database. A further option for external data is to extract a set of data from PCF, IDF or POD
files.
You can generate new datasets from the ISOGEN data and the new external data sources
using SQL statements to manipulate them. For more information, see
<GENERATED-DATA> in <I-DATA-INTEGRATOR-OUTPUT-OPTIONS> Section (on page
43).
ISOGEN or generated data can be further processed using scripts
Output datasets can be re-named or suppressed. For more information, see
<OUTPUT-CONTROLS> in <I-DATA-INTEGRATOR-OUTPUT-OPTIONS> Section (on page
43).
When using Excel output formats, you can specify the spreadsheet to write to and in which
sheet and cell to start writing the output.
When using delimited output formats, you can specify the delimiter character, an optional
quote ( " ) character, and the file extension. For example, it is possible to output data in
Intergraph PDS Tab delimited format, such as the .b file. For more information, see
<OUTPUT-FORMATS> in <I-DATA-INTEGRATOR-OUTPUT-OPTIONS> Section (on page
43).
You can specify the template database used by the Microsoft Access output format so that
predefined reports are automatically available in the output database.
I-Data Integrator reads the ISOGEN Bending file and can create datasets for cut pieces,
pipe (pulled) bends, and holes. For more information, see Bending File (on page 22).
SmartPlant Isometrics
I-Data Integrator User's Guide 11
SmartPlant Isometrics I-Data Integrator
I-Data Integrator reads the ISOGEN CenterlineLength Summary and user-defined Cut List
report files. For more information, see Centerline Length File (on page 25).
The Repeatability Return file is read if specified in the .fls or .opt file. For more information,
see Repeatability Return File (on page 20).
Recordsets can be split using a nominated field, for example, to split a component's
recordset by pipeline into separate output files or tables. For more information, see
<OUTPUT-CONTROLS> in <I-DATA-INTEGRATOR-OUTPUT-OPTIONS> Section (on page
43).
Recordsets can be merged into Master/Detail outputs (delimited format only), where a
record in the Master recordset is followed by all records in the Detail recordset that meet a
user-specified criterion. For more information, see <OUTPUT-FORMATS> in
<I-DATA-INTEGRATOR-OUTPUT-OPTIONS> Section (on page 43).
Generated recordsets are stored as queries in the temporary database.
I-Data Integrator stores/restores all your choices to the Main window each time it opens up, as
defined by the settings in the XML options file. For more information, see The I-Data Integrator
Interface (on page 12).
12 SmartPlant Isometrics
I-Data Integrator User's Guide
SmartPlant Isometrics I-Data Integrator
SmartPlant Isometrics
I-Data Integrator User's Guide 13
SmartPlant Isometrics I-Data Integrator
D - Output data
Defines the output format for the data that is processed and specifies the folder location
where the output data is written. For more information, see Output Data (on page 27).
Recommended Workflow
When the same pipeline is repeatedly run through ISOGEN, the material for each run is
appended to the Material Control, Weld Summary, Spool Information and Bending files. I-Data
Integrator strips out everything but the most recent set of data for each pipeline. In other words,
each time that you run I-Data Integrator, it produces data that reflects the current state of the set
of pipelines that have been processed through SmartPlant Isometrics or SmartPlant Spoolgen.
The recommended practice is to set up a style that is used to process pipelines when they have
reached their final state. The drawings and data reports produced by this style are often the
completed deliverables from a project.
When you use SmartPlant Isometrics, there are two options for producing final issue isometric
drawings from the project:
Single pipeline processing - Use the Generate Drawings command to process each
pipeline individually to produce drawings and data, appended to the output reports.
Multiple pipelines processing - Use the Batch Generate Drawings command to process
a batch of pipes and generate both the drawings and output reports automatically.
For more information about SmartPlant Isometrics drawing generation, see the
SmartPlant Isometrics User's Guide, available using the Help > Printable Guides command in
the software.
You can run I-Data Integrator only once, typically at the end of the project, to produce a
consolidated and accumulated set of materials that require purchasing. Alternatively, you can
run I-Data Integrator on a daily or weekly basis as the project progresses. In the latter scenario,
automatically deleting the material files from SmartPlant Isometrics and SmartPlant Spoolgen
after running I-Data Integrator ensures that the software only collects material from the last run.
The command line execution option is typically used in this scenario because it allows you to
schedule an automated batch process to run at regular intervals to convert the current output
files.
I-Data Integrator is not a material control system. It is intended to serve as a link to such
a system.
14 SmartPlant Isometrics
I-Data Integrator User's Guide
Configure the Software
ISOGEN Post-Processor
IDIPost.exe, a special application to be run as an ISOGEN post-processor, is delivered with
I-Data Integrator. IDIPost.exe is only available for use with Personal ISOGEN-enabled
applications, such as SmartPlant Isometrics and SmartPlant Spoolgen, and it enables the
insertion of the FILENAME field into all intrinsic recordsets.
SmartPlant Isometrics
I-Data Integrator User's Guide 15
Configure the Software
To update the configuration file so that it is compatible with the current version of the software,
click Yes.
6. Click to update the active style file with the new property settings.
16 SmartPlant Isometrics
I-Data Integrator User's Guide
Configure the Software
7. Click to close the ISOGEN Configuration Panel, and then click File > Exit to close
I-Configure.
Using IDIPost.exe is only necessary if the FILENAME field is required in all intrinsic
recordsets. Unless the particular dataset requires it, there is no need to implement this feature.
See Also
Automatically Generated Data (on page 29)
SmartPlant Isometrics
I-Data Integrator User's Guide 17
Configure the Software
18 SmartPlant Isometrics
I-Data Integrator User's Guide
SECTION 2
Input Data
SmartPlant Isometrics I-Data Integrator processes the ISOGEN output report files listed in the
table below. Output of these files is controlled in I-Configure. You set up these reports using the
ISOGEN Configuration Panel. For more information, see the ISOGEN Configuration User's
Guide, which is available using the Help > Printable Guides command in the software.
In most cases, the format and content of the output file must be specified using an input file, as
shown in the following table. In the indicated cases, the ISOGEN report file is a fixed format.
SmartPlant Isometrics
I-Data Integrator User's Guide 19
Input Data
REPEATABILITY RETURN
For a description of how I-Data Integrator behaves, see Output Data (on page 27).
Only the standard template configuration file is necessary to convert ISOGEN report data to
the required output format.
PRINTED-M/C-DATA-ITEMS
'PIPELINE-REFERENCE' 1 L ! <PipelineID>
This applies to SmartPlant Isometrics, ISOGEN, and SmartPlant Spoolgen input control
files, which are usually generated automatically by I-Configure.
See Also
Input Data (on page 19)
20 SmartPlant Isometrics
I-Data Integrator User's Guide
Input Data
Components_2 Recordset
The Components_2 table contains the following fields:
Field Description
Unique part number. This is the same as PT-NO if unique part numbering is
UPN not used or set to the ISOGEN generated unique part number if it is (for
example, 1.1, 1.2, 1.3, 2.1, and so on).
NS Nominal size in the current bore units (as specified by Option Switch 41).
The ISOGEN record type (for example, 100 for pipe, 130 for valve, and so
RECORDTYPE
on).
If unique component identifiers are not present in the input file (IDF or PCF), the software
does not generate any component records.
SmartPlant Isometrics
I-Data Integrator User's Guide 21
Input Data
Welds_2 Recordset
The Welds_2 table contains the following fields:
Field Description
NS Nominal size in the current bore units (as specified by option switch 41).
SKEY The ISOGEN SKEY (for example, WW, WS, and so on).
START_CPT The unique component identifier for the component at the weld “start”.
START_X
START_Z
FINISH_CPT The unique component identifier for the component at the weld “finish”.
FINISH_X
FINISH_Z
The format of the repeat file is fixed. The presence of the REPEATABILITY-RETURN or –117
record in the .FLS or .OPT file, respectively, is sufficient to trigger I-Data Integrator to read the
data.
See Also
Input Data (on page 19)
22 SmartPlant Isometrics
I-Data Integrator User's Guide
Input Data
Bending File
If you specify a Bending file in the .FLS file, or a –127 record in the SmartPlant Spoolgen .OPT
file, the software reads the generated file, consolidates it and then creates three intrinsic
recordsets: Bends, CutPieces, and Holes. These can be processed in the same way as other
intrinsic recordsets created from the Material Control, Welding, Spool Information or
Repeatability files.
Bends Recordset
Field Description
UMI Indicates the generated unique material identifier. Used to link to other tables (*).
SmartPlant Isometrics
I-Data Integrator User's Guide 23
Input Data
CutPieces Recordset
Field Description
UMI Indicates the generated unique material identifier. Used to link to other tables (*).
START-X
START-Z
FINISH-X
FINISH-Z
DEV-LENGTH Indicates the developed length (allowing for weld gaps, and so on).
24 SmartPlant Isometrics
I-Data Integrator User's Guide
Input Data
Field Description
Field Description
FINISH-COMP-LENGTH Length.
Holes Recordset
Field Description
UMI Indicates the generated unique material identifier. Used to link to other tables (*).
Fields marked with an asterisk ( * ) are always present. Other fields are present depending
on the content of the Bending file (which is subject to change). The Bends and Holes
recordsets are not created if there are no bends (pulled bends) or holes in the ISOGEN data.
See the ISOGEN documentation for a full description of these parameters.
See Also
Input Data (on page 19)
SmartPlant Isometrics
I-Data Integrator User's Guide 25
Input Data
CentreLineLength Recordset
Field Description
See Also
Input Data (on page 19)
26 SmartPlant Isometrics
I-Data Integrator User's Guide
Output Data
SECTION 3
Output Data
SmartPlant Isometrics I-Data Integrator can create the output data formats listed below.
Delimited (.csv)
Alias XML (a special version of XML)
Microsoft Access database tables
Fixed Text
Microsoft Excel spreadsheets
AES/32 XML
AES/32 is a third party application program, which supplies costing data for projects.
For additional information, see www.nhd.com.
All output data is created in the same format.
Bend Bends
Holes Holes
SmartPlant Isometrics
I-Data Integrator User's Guide 27
Output Data
These recordsets can be output into the specified output files or processed using SQL
statements in the output options configuration file. To distinguish them further, these recordsets
are known as the intrinsic recordsets, which can be created by SQL statements or by linking to
external data sources.
Access Data
If you select Access in the Output format list, the software looks for a template database called
template.mdb in the same folder that contains the I-Data Integrator executable (I-Data
Integrator.exe).
28 SmartPlant Isometrics
I-Data Integrator User's Guide
Output Data
Delimited Data
You can open and view delimited data deliverables using a standard text editor, such as
TextPad, or using Microsoft Excel.
Excel
SmartPlant Isometrics
I-Data Integrator User's Guide 29
Output Data
30 SmartPlant Isometrics
I-Data Integrator User's Guide
Process Pipeline Files
SECTION 4
Automation Interface
The automation interface allows I-Data Integrator to be instantiated by another application more
efficiently than using the command line interface. You trigger the data generation process using
an ExecuteConfigFile method.
Before using the automation interface, you must first register it. For more
information, see Register the automation interface (on page 36).
.NET Implementation
Information applies to Visual C++, C# and VB.NET. Use the Application2 object. The key
function of the interface is:
ExecuteConfigFile (String) - All data required to run I-Data Integrator is contained in the
configuration file. All the previous properties on the interface should be considered obsolete,
but have been retained for backward compatibility.
Visual Basic Implementation
Information applies to Visual Basic v6.0, using the obsolete Application object. On the Project >
References tab, select Alias I-Data Integrator Application.
SmartPlant Isometrics
I-Data Integrator User's Guide 31
Process Pipeline Files
32 SmartPlant Isometrics
I-Data Integrator User's Guide
Process Pipeline Files
2. If necessary, click Browse , and navigate to the configuration file that you want to use.
Alternatively, click File > Open and then navigate to the configuration file that you want to
use.
Unless otherwise specified, the software automatically uses the configuration file from
your last session with the software.
If you specify an XML configuration that was created for a previous version of the
software, the following message is displayed:
Click Yes to update the configuration file so that it is compatible with the current version
of the software.
The I-Data Integrator software opens and displays the main window.
3. Next, specify the type of input data you want to use.
By default, Use report files is selected, which instructs the software to read all of the
ISOGEN report data.
If you select Input files only, the specific input files you want the software to read must
be specified in the configuration file that you are using to process the pipeline data.
4. In the Isometric drawing style section, do one of the following:
Select Use I-Configure to specify the ISOGEN style defined within I-Configure and then
use the list boxes to select the Isometric directory, Project, and Isometric style that
you want to use.
Select Browse for style and then click Browse to navigate to the ISOGEN.fls or
SPOOLGEN.opt file that you want to use.
5. Select an output type in the Output format list.
6. Click Browse and navigate to the Output directory folder where the post-processing
output data is to be written.
SmartPlant Isometrics
I-Data Integrator User's Guide 33
Process Pipeline Files
The software remembers your configuration file between sessions and automatically stores
all the options displayed on the I-Data Integrator Main window in XML configuration file.
You can also initiate processing from the command line or by using the automation
interface.
See Also
Appendix: XML Configuration File Syntax (on page 39)
Input Data (on page 19)
Output Data (on page 27)
Syntax
I-Data Integrator/s style file /o output directory [/l log file ] [/f
output format] [/c]
/s - Specifies the path to the style file (FLS or OPT). Spaces are permitted in the path. This
parameter is required.
/s C:\SampleProj\SampleProject\Final-Basic\ISOGEN.fls
/o - Specifies the path to the folder to contain the output files. Spaces are permitted in the path
name. This parameter is required.
/o C:\SampleProj\SampleProject\Final-Basic\Reports
/l - Specifies a name for log file. This parameter is optional. If it is not specified, the log file is
written to the style file folder, with the name matconvert.log.
/l C:\SampleProj\SampleProject\Final-Basic\projectA.log
34 SmartPlant Isometrics
I-Data Integrator User's Guide
Process Pipeline Files
/f - Specifies the output format. This parameter is optional. If it is not specified, the first (default)
format from the list displayed on the SmartPlant Isometrics I- Data Integrator window is used.
This string is not case sensitive. For example, ACCESS is the same as access and Access.
/f Access
/f Delimited
/c - Optional clear flag (no parameters). If present on the command line, I-Data Integrator
automatically deletes all the ISOGEN data files after converting them to the specified format.
/u - Species the user configuration file used to pass the name of the user-specified XML
configuration file to I-Data Integrator when it is being run in batch.
/u user_output_options_file
Configuration file =
C:\SampleIsoDir\S5Tutorial\data\I-Data\Default.xml
Style = C:\SampleIsoDir\S5Tutorial\Final-Basic\ISOGEN.fls
Output Format = Access
Output directory = C:\SampleIsoDir\S5Tutorial\Final-Basic\Reports
Delete ISOGEN data = True
Data written to
C:\SampleIsoDir\S5Tutorial\Final-Basic\Reports\Materials.mdb
Table : Pipeline
Table : Components
See Also
Appendix: XML Configuration File Syntax (on page 39)
SmartPlant Isometrics
I-Data Integrator User's Guide 35
Process Pipeline Files
You can view the results data for the last generate event using your default text editor.
On the Main window, click File > View Log File.
The software opens the log file using your default text editor:
Alternatively, navigate to your local Temp folder, and double-click I-Data Integrator.log.
36 SmartPlant Isometrics
I-Data Integrator User's Guide
Process Pipeline Files
A sample template file called default.xml is delivered with the software to the [Installation
Drive]\SampleIsoDir\SPITutorial\Data\I-Data Integrator\Configuration folder.
When using the default template XML file, it is recommended that you copy it to a location
relevant to the current project, such as the project Data folder.
Input Data - Controls whether the software reads report files for the specified style. The Use
report files option is the initial setting. If you select Input files only, you must also specify a set
of IDF/PCF/POD files to be used in the output options.
Use I-Configure - Specifies the ISOGEN style defined with SmartPlant I-Configure when
working with SmartPlant Isometrics and SmartPlant Spoolgen. The three lists show all available
isometric directories, projects and styles. SmartPlant Isometrics I-Data Integrator stores and
restores the selected style between sessions from the configuration file
Browse for style - Allows you to specify an ISOGEN style file directly using the Specify
ISOGEN FLS or SPOOLGEN.OPT dialog box. To open the dialog box and navigate to the
ISOGEN style file, click Browse .
To specify a PDS DEF file, click PDS DEF File (*.DEF) in the Files of type list and then
navigate to the appropriate file.
When you select a PDS DEF file in the Browse for style operation, the software
displays an additional field in which you can type location of the ISOGEN output files
created when executed from PDS (the DEF file does not contain this information).
Output format - Defines the output format for the data that is processed. You can select
Delimited, AES 32XML, Alias XML, Fixed Text, or Excel.
Output directory - Specifies the folder location where the output data is written.
View - Attempts to open any output previously generated by SmartPlant Isometrics I-Data
Integrator. If the output options indicate that multiple files could have been generated the folder
holding these files is opened.
Clear - Deletes any material control, weld summary or spool information files referenced in the
style file. You can use it after processing a set of data as a convenient way of setting up the
software for subsequent runs.
Generate - Starts the conversion of the specified material control, weld summary and spool
information data into the selected output format. Alternatively, you can click Tools > Generate
Material File.
SmartPlant Isometrics
I-Data Integrator User's Guide 37
Process Pipeline Files
Close - Exits the software. Alternatively, you can click File > Exit.
38 SmartPlant Isometrics
I-Data Integrator User's Guide
APPENDIX A
SmartPlant Isometrics
I-Data Integrator User's Guide 39
Appendix: XML Configuration File Syntax
B - <I-DATA-INTEGRATOR-OUTPUT-OPTIONS>
Controls how the software behaves during the conversion process. It is used to specify links to
external data, what new generated data is to be created, and what scripts are to be run when
the dataset is processed. This section of the configuration file is typically divided into the four
sub-sections listed below.
1 - <EXTERNAL-DATA>
2 - <GENERATED-DATA>
3 - <OUTPUT-CONTROLS>
4 - <OUTPUT-FORMATS>
In This Appendix
<I-DATA-INTEGRATOR-SETTINGS> Section ..............................40
<I-DATA-INTEGRATOR-OUTPUT-OPTIONS> Section ................43
40 SmartPlant Isometrics
I-Data Integrator User's Guide
Appendix: XML Configuration File Syntax
<I-DATA-INTEGRATOR-SETTINGS> Section
Contains the settings required to run I-Data Integrator. Any changes that you make to the
options in the I-Data Integrator Main window are also reflected in this section of the XML
configuration file.
<INPUT-DATA>
<INPUT-DATA Enabled="Yes" ProjManStyle="No" Filter="Yes" Clear="No">
<STYLE-DATA IsoDir="c:\SampleIsoDir" Project="S5Tutorial"
Style="Final-Basic"/>
<CONTROL-FILE
Path="C:\SampleIsoDir\SPITutorial\Final-Basic\isogen.fls"/>
The <INPUT-DATA> tag contains four attributes.
ENABLED - Determines whether any report is to be processed. This attribute matches the
Use Report Files option in the software. Setting this option to Yes ensures that the ISOGEN
report files are read as part of the processing sequence.
PROJMANSTYLE - Specifies how the software locates the reports to be read. If set to Yes,
I-Data Integrator uses the SmartPlant I-Configure project setting defined in the
<STYLE-DATA> tag to locate the report data. If set to No, the software uses the
<CONTROL-FILE> tag to locate the reports. This attribute matches the Use I-Configure or
Browse for style options in the Main window.
FILTER - Controls which version of the pipeline is read if there are repeated pipelines in the
report files. If set to Yes, only the most recent version of the pipeline. This option is no
longer available through the user interface.
Clear - Controls whether report files are deleted. If set to Yes, the report files are deleted
when processing completes. Usually, this attribute is set to No. It is equivalent to clicking
Clear in the Main window.
<LOG-FILE>
<LOG-FILE Enabled="Yes" Path="C:\Program
Files\SmartPlant\Isometrics\I-Data Integrator\idi.log"/>
The <LOG-FILE> tag contains two attributes.
ENABLED - Specifies whether a log file is produced. If set to Yes, a log file is produced. If
set to No, a log file is not produced.
PATH - Specifies the full path location and filename of the log file.
You must use the configuration file to set up the log file. Options to do so are not
available through the user interface.
SmartPlant Isometrics
I-Data Integrator User's Guide 41
Appendix: XML Configuration File Syntax
<OUTPUT-DATA>
<OUTPUT-DATA Path="C:\SampleIsoDir" Type="5"/>
The <OUTPUT-DATA> tag contains two attributes.
PATH - Specifies the folder where any output is to be written.
TYPE - Defines the output format that is produced. The available values are listed below.
0 - Delimited
1 - AES/32 XML
2 - Alias XML
3 - Access
4 - Fixed Text
5 - Excel
You can change the PATH and TYPE attributes using the options in the Main window.
<TEMPLATE-DATABASE>
<TEMPLATE-DATABASE Path="C:\Data\DatabaseName.mdb"/>
The <TEMPLATE-DATABASE> tag contains a single attribute.
PATH - Specifies the full path location and filename to the Access database that the
software uses as the internal working database. Queries and external data tables that are
required during generation of the output can be stored here instead of in the
<OUTPUT-OPTIONS> tag. Also, you can define the structure of some of the tables to be
filled to ensure that certain columns are present. The default file used is the template.MDB
file stored in default I-Data Integrator installation folder
In previous versions of the software, the database listed in the <OUTPUT-FORMATS>
tag would have been used as both the internal database and the output database. However, in
the current version of the software, this dual functionality can be split.
<PDS-OUTPUT-DIRECTORY>
<PDS-OUTPUT-DIRECTORY Path="C:\PDS"/>
The <PDS-OUTPUT-DIRECTORY> contains a single attribute.
PATH - Specifies the location of the PDS DEF file, if one is being used.
42 SmartPlant Isometrics
I-Data Integrator User's Guide
Appendix: XML Configuration File Syntax
<I-DATA-INTEGRATOR-OUTPUT-OPTIONS> Section
Controls how I-Data Integrator behaves during the conversion process. This section of the
configuration file is used to specify links to external data, what new generated data is to be
created, and what scripts are to be run when the dataset is processed. To control additional
specific functions, the <I-DATA-INTEGRATOR-OUTPUT-OPTIONS> section is further divided
into the smaller sections listed below, each of which is discussed in detail.
<EXTERNAL-DATA>
Defines new, external datasets, such as databases or spreadsheets containing data that is to be
integrated with the ISOGEN data. This section can also reference IDF, PCF, and POD data files
so that additional datasets can be generated. The <EXTERNAL-DATA> section is processed
after the ISOGEN data has been read into recordsets and before the GENERATED-DATA
section is processed.
The EXTERNAL-DATA section of the configuration file can contain a number of <DBLINK>,
<PCF>, <IDF>, and <POD> tags. Each <DBLINK> tag defines a table in an external data source
that is to become a new I-Data Integrator dataset. Each <PCF>, <IDF>, or <POD> tag defines a
folder containing PCF, IDF, and POD files, respectively. These external data files are
automatically read and the data in them loaded into new I-Data Integrator recordsets.
<DBLINK>
<DBLINK PROVIDER="ODBC;DSN=MDP_ANSI"
TABLE="mto_ansi.pdtable_12"
RECORDSET="SegmentData"/>
The <DBLINK> tag contains three attributes.
PROVIDER - Specifies a string that contains the parameters needed to link to the external
data. This string is as defined by Microsoft for connecting to the specified data source. The
strings and their associated data source are listed below.
ODBC;DSN=MDP_ANSI - Any ODBC data source created using the Control Panel >
Data Sources (ODBC) application. In the example above, MDP_ANSI is the name of
the data source being defined.
Excel 8.0;Database=filename - The link to an Excel spreadsheet.
MS Access;Database=filename - The link to an Access database.
TABLE - Specifies the table in the external data source that is to become a new I-Data
Integrator dataset.
RECORDSET - Specifies the name of the recordset.
SmartPlant Isometrics
I-Data Integrator User's Guide 43
Appendix: XML Configuration File Syntax
44 SmartPlant Isometrics
I-Data Integrator User's Guide
Appendix: XML Configuration File Syntax
<GENERATED-DATA>
Defines new recordsets that are to be derived from any External and ISOGEN recordsets, as
well as from any previously defined generated recordsets.
The <GENERATED-DATA> section can contain any number of <DEFINE-RECORDSET>,
<EXECUTE-SCRIPT>, and <EXECUTE-SQL> tags. Each <DEFINE-RECORDSET> tag
contains a SQL statement that defines the contents of the new recordset, each
<EXECUTE-SCRIPT> tag contains a definition of a VBScript file to execute, and each
<EXECUTE-SQL> tag contains a SQL statement to be run in the intermediate database. This
section is processed after the EXTERNAL-DATA section.
<DEFINE-RECORDSET>
<DEFINE-RECORDSET NAME='NEW-MATERIALS"
SQL="SELECT MATERIALS."
FROM [MATERIALS];"/>
Each <DEFINE-RECORDSET> tag contains two attributes.
NAME - Defines the name for the new generated recordset.
SQL - Defines the SQL statement that is executed to populate the generated recordset. The
SQL statement can reference any ISOGEN recordset, any external recordset, or any
previously declared generated recordset. In the example above, a new recordset called
NEW-MATERIALS is being defined by selecting everything from the ISOGEN-generated
recordset called MATERIALS.
For information about the basic principles of SQL syntax, see Appendix: Basic SQL Syntax
(on page 51).
Your SQL statement from the XML configuration file is stored in an Access query in the
temporary database.
Typically, you can have a series of <GENERATE-RECORDSET> tags that reference
previously generated recordsets to gradually build up the required output over several
queries.
SmartPlant Isometrics
I-Data Integrator User's Guide 45
Appendix: XML Configuration File Syntax
<EXECUTE-SCRIPT>
<EXECUTE-SCRIPT SCRIPT-FILE='path to a script' SCRIPT='script to
execute'
PARAMETERS='script parameters' />
Each <EXECUTE-SCRIPT> tag contains three attributes to define a script that is executed
against the current dataset. Two of the attributes are mandatory, and one is optional.
SCRIPT-FILE - Specifies the path to the text file containing script(s), such as
'c:\scripts\script1.vbs'. This attribute is mandatory.
SCRIPT - Specifies the script within the file to execute. This must correspond to the name of
a public function in the text file. This attribute is mandatory.
PARAMETERS - Specifies the comma-separated list of parameters to be passed to the
script. This list must correspond to the argument list of the script being executed. This
attribute is optional.
<EXECUTE-SQL>
Each <EXECUTE-SQL> tag contains a mandatory sub-tag called <SQL>, which holds a SQL
action statement to be run directly in the temporary database. Any valid SQL action statement
can be put in the <SQL> tag. Although only linked or original tables can be affected, other
generated recordsets can be referred to within the tag. This allows table creation and editing
and appending data to existing tables.
It also can have two attributes, NAME and ON-ERROR. Setting ON-ERROR to CONTINUE,
allows I-Data Integrator to continue with its Generate step, even if the SQL action fails.
<OUTPUT-CONTROLS>
Contains any number of <OUTPUT-NAME> and <SUPPRESS-OUTPUT> tags.
<OUTPUT-NAME>
The <OUTPUT-NAME> tag has five possible attributes.
RECORDSET - Defines the internal name of the I-Data Integrator recordset.
NAME - Defines the name to be given to the data when it is written out to the specified
format. For example, the statement <OUTPUT-NAME RECORDSET="Components"
NAME="CPTS" />, specifies that the Components recordset (derived from the ISOGEN
Material Control file) is to be called CPTS when it is output. If a delimited format is chosen,
the output is CPTS.csv. If an Access database is specified, the output is the name given to
the table containing the data. If an Excel spreadsheet is specified, the name is the
worksheet name in which the data is to be written. If the worksheet does not exist in the
template, then it is created.
46 SmartPlant Isometrics
I-Data Integrator User's Guide
Appendix: XML Configuration File Syntax
SPLITBY - Specifies a field in the recordset. If this attribute is set, the recordset is split when
it is written out using the value in the SPLITBY field. For example, if you want to split a list of
components into components belonging to a pipeline, you can use the syntax shown in the
example below.
<OUTPUT-NAME RECORDSET="Components" SPLITBY="PIPELINE-REFERENCE" />
<SUPPRESS-OUTPUT>
The <SUPPRESS-OUTPUT> tag contains a single attribute, RECORDSET. If this attribute is set
to the name of one of the SmartPlant Isometrics I- Data Integrator recordsets, it prevents any
output being created for this recordset, such as any intermediate generated recordsets.
External recordsets are never output. They must be transferred to an intermediate
recordset if required for output.
<OUTPUT-FORMATS>
Contains data specific to each output format. The general syntax of the data is shown below.
<FORMAT attribute=”value” />.
The <OUTPUT-FORMATS> section can include the tags listed below.
SmartPlant Isometrics
I-Data Integrator User's Guide 47
Appendix: XML Configuration File Syntax
<ACCESS>
<ACCESS TEMPLATE="APP.PATH\TEMPLATE.MDB" OUTPUT="XMAT"/>
The <ACCESS> tag can have two attributes:
TEMPLATE - Specifies the template database used to create the output. The template
database can hold pre-configured reports. You can use the APP.PATH string to specify the
installed location of I-Data Integrator.
OUTPUT - Specifies the name for the output Access database. The default name is
Materials.mdb.
<EXCEL>
<EXCEL TEMPLATE="APP.PATH\TEMPLATE.XLS" OUTPUT="MATERIAL"/>
The <EXCEL> tag can have two attributes:
TEMPLATE - Specifies the template spreadsheet used to create the output. You can use
the APP.PATH string to specify the installed location of I-Data Integrator.
OUTPUT - Specifies the name for the output Excel spreadsheet. The default name is
Materials.xls.
<DELIMITED>
<DELIMITED DELIMITER="TAB" EXTENSION="B"/>
<DELIMITED DELIMITER=";" QUOTECHAR="'" />
The <DELIMITED> tag can have three attributes.
DELIMITER - Specifies the delimiter character. The default is “ ; ”. To specify a Tab
character as the delimiter, use DELIMITER="TAB".
EXTENSION - Specifies the default extension to use for the delimited files. The default is
.csv. This can be overridden for different recordsets in the <OUTPUT-CONTROLS> section.
QUOTECHAR - Specifies an option quote character. If used, all fields are prefixed and
suffixed with the specified character. To specify certain characters as quote characters, you
can use special XML strings as shown in the list below.
48 SmartPlant Isometrics
I-Data Integrator User's Guide
Appendix: XML Configuration File Syntax
<MASTER-DETAIL>
The delimited format can also contain a special set of tags that control the output of a
“master/detail” type file. In this type of file, one record from the Master recordset is followed by
all the records from the Detail recordset that meet a criteria, usually that they share a value with
the Master recordset.
For example, records from the Pipelines and Components recordsets can be merged as follows:
Pipeline 1
Components for pipeline 1
Pipeline 2
Components for pipeline 2
Pipeline 3
Components for pipeline 3
The data must be enclosed between the <MASTER-DETAIL> tags, of which there can be any
number within the <DELIMITED> tag, as shown in the example below.
<MASTER-DETAIL
MASTER="SRECORDS"
DETAIL="VRECORDS"
HEADER= "K,DOW,ABS-TRAIN
6,104146,Spoolgen,v4,CUSTOMER-EXAMPLE.CSV,6/02/2002"
CRITERIA="PIPELINE-REFERENCE = MASTER.[LINE]"
SUPPRESS-DETAIL-FIELDS="PIPELINE-REFERENCE,Geandert" >
</MASTER-DETAIL>
There can be any number of <MASTER-DETAIL> tags within the <DELIMITED> tag. Its
attributes are listed below.
DETAIL - Specifies the name of the recordset supplying the detail records.
HEADER - Specifies a string that is output as the first line of the file. It is an optional
attribute.
The HEADER attribute can contain the macros listed below, which are substituted at
run time by I-Data Integrator.
$DATE - Current system date
$TIME - Current system time.
$APP.TITLE - Title of the executable, such as SmartPlant Isometrics I-Data Integrator.
$APP.EXENAME - Name of the I-Data executable, such as SmartPlant Isometrics.
$APP.MAJOR - Major revision number.
$APP.MINOR - Minor revision number.
SmartPlant Isometrics
I-Data Integrator User's Guide 49
Appendix: XML Configuration File Syntax
<MASTER-DETAIL> output impacts only the specified Master recordset and has no effect
on whether the Detail recordset is output as normal.
The Detail recordset can appear as a Master recordset in another <MASTER-DETAIL> tag if
it is required to nest the output to more than one level.
<FIXED>
<FIXED RECORDSET="COMPONENTS" EXTENSION="STB">
<!-- FIELDS contain constant characters or fields - as taken from the
-->
<!-- specified recordset -->
<FIELD START="1" LENGTH="1" CONTENTS="|" />
<FIELD START="2" LENGTH="20" CONTENTS="PIPELINE" />
<FIELD START="22" LENGTH="1" CONTENTS="|" />
<FIELD START="23" LENGTH="20" CONTENTS="ITEM-CODE" />
<FIELD START="43" LENGTH="1" CONTENTS="|" />
<FIELD START="44" LENGTH="30" CONTENTS="QTY" />
<FIELD START="75" LENGTH="1" CONTENTS="|" />
</FIXED>
The <FIXED> tag specifies the format for a fixed format output file. It contains two attributes.
RECORDSET - Specifies the name of the recordset that is used as the source of the data to
be written to the fixed format text file. In the case of fixed text output only, the recordset is
only written out if a <FIXED> tag occurs in the configuration file, with the RECORDSET
attribute set to the name of the recordset to be output.
EXTENSION - Specifies the file extension. The default is .txt.
50 SmartPlant Isometrics
I-Data Integrator User's Guide
Appendix: Basic SQL Syntax
Each <FIXED> tag must contain one or more <FIELD> tags. These tags specify the
start position (the START attribute), length (the LENGTH attribute) and contents ( the
CONTENT attribute) of each column.
APPENDIX B
SmartPlant Isometrics
I-Data Integrator User's Guide 51
Appendix: Basic SQL Syntax
52 SmartPlant Isometrics
I-Data Integrator User's Guide
Glossary
I
I-Configure
Application used by SmartPlant Isometrics and SmartPlant Spoolgen to create the projects and
styles that are used to produce isometric drawing and report file output.
IDF
Intermediate Data File - the original input file for ISOGEN.
intrinsic recordset
a set of data known as a table or recordset--a table is held in a disk file, whereas a recordset is
held in dynamic computer memory. Intrinsic recordsets generated by SmartPlant Isometrics
I-Data Integrator are required for the transfer of the consolidated data into the output data format
required by the user.
ISOGEN
The industry standard for automatic generation of piping isometrics.
isometric style
A set of ISOGEN settings, controls and drawing sheets that will produce a drawing in a
particular format.
item code
A code identifying a particular type of component, which defines uniquely the bores and
dimensions of the component.
SmartPlant Isometrics
I-Data Integrator User's Guide 53
Glossary
PCF
The ISOGEN Piping Component File. A PCF is a man-readable input file for ISOGEN.
POD
The default file format for SmartPlant Isometrics data. POD stands for piping object data.
S
Spoolgen OPT File
each SPOOLGEN style is defined in an OPT file within the project directory. The OPT file
contains Option Switches, text positioning and AText records.
54 SmartPlant Isometrics
I-Data Integrator User's Guide
Index
Preface • 7
< Process files interactively • 33
<I-DATA-INTEGRATOR-OUTPUT-OPTION Process files using the command line • 34
S> Section • 43 Process Pipeline Files • 31
<I-DATA-INTEGRATOR-SETTINGS>
Section • 41 R
Recommended Workflow • 14
A Register the automation interface • 36
Appendix Repeatability Return File • 21
Basic SQL Syntax • 51
XML Configuration File Syntax • 39 S
Automatically Generated Data • 30
SmartPlant Isometrics I-Data Integrator • 9
Specify the XML configuration file • 16
B Spoolgen OPT File • 54
Bending File • 23
T
C The I-Data Integrator Interface • 13
Centerline Length File • 26
Configure the ISOGEN post-processor • 16 U
Configure the Software • 15
User-Specified Text (Field Names in Output
Data) • 20
D
Documentation Comments • 8 V
Documentation Set • 7
View output files • 35
View the log file • 36
I
I-Configure • 53 W
I-Data Integrator Main Window Options • 37
IDF • 53 What's New in SmartPlant Isometrics I-Data
Input Data • 19 Integrator • 8
intrinsic recordset • 53
ISOGEN • 53
isometric style • 53
item code • 53
O
Output Data • 27
Output Data Formats • 28
P
PCF • 54
PDS DEF File • 54
POD • 54
SmartPlant Isometrics
I-Data Integrator User's Guide 55