<OUTPUT-CONTROLS> - Intergraph I-Data Integrator - Help - Hexagon

Intergraph I-Data Integrator Help

Language
English
Product
Intergraph I-Data Integrator
Search by Category
Help
I-Data Integrator Version
2019 R1 (8.1)

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.

  • 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, 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" />

  • PIPELINE-REFERENCE must be one of the fields in the Components recordset. When the Components recordset is written out, each group of records sharing the same value of PIPELINE-REFERENCE is written out into a separate file or table. This file or table is given the value of the grouping field (with any illegal characters being replaced by “_”). A sample Components recordset is shown below.

PIPELINE-REFERENCE ITEM-CODE N_S_
P-1 I1 4
P-1 I2 2
P-2 I-3 6

When written out, the Components recordset is split into two delimited files, as shown in the next example.

P-1.CSV, P-1,I1,4, P-1,I2,2
P-2.CSV, P-2,I3,6

  • NAME and SPLITBY are mutually exclusive.

  • If using SPLITBY, you can override the default output extension for a particular recordset using the optional attribute EXTENSION.

  • START-CELL defines the location where the recordset is written. This defaults to cell A1. Used only for Excel output.

  • HEADER determines if the column names are written as the first row. Used only for Excel output.

  • EXTENSION overrides the default file extension for text file (either delimited or fixed) output.

<SUPPRESS-OUTPUT>

The <SUPPRESS-OUTPUT> tag contains a single attribute, RECORDSET. If this attribute is set to the name of one of the 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.