Need help working from home with your Bentley software? We're here to help - click here
The material report on the drawing is controlled with the report definition file (report.def). This definition file provides a very flexible way of specifying the material output on the drawing.
With the report definition file multiple reports can be defined which will always be processed any time a drawing is generated. Not all reports need to be included in the drawing. All reports become available as text files. At the discretion of the user these files can be used for various purposes. They may even be formatted in such a way that they can be used as input into the material handling system of the organization.
Note -With Recent release of OpenPlant Isometrics Manager - Version 08.11.11.224 SS6 Refresh 2, Many things have been changed. Users are advised to take a notice on changes that has been made to facilitate the ease of use for customizing reports.
This can be commonly check for both AutoPLANT Modeler-OpenPlant Isometrics Manager & OpenPlant Modeler-OpenPlant Isometrics Manager
The table layout of a material report is defined by COLUMN keywords. The column definition has the following syntax:
COLUMN = <width> : <format/alignment> : <expression>COLUMN = 3: R : PARTIDCOLUMN = 19: R : QUANTITYCOLUMN = 7: R : SIZE1COLUMN = 7: R : SIZE2COLUMN = 2: :COLUMN = 60: W : IE_DESCRIPT
Where:
Note: The COLUMN width field is now interpreted as a millimeter (MM) value instead of a character count. User may need to change their reports a bit. This allow user for easier settings. For More information click here>>>>
The COLUMN keyword specifies the properties to include and their sequence. In the example below, the PARTID property is the first property in the report, followed by the QUANTITY property. The properties are ordered from left to right in the report.
COLUMN = 3: R : PARTIDCOLUMN = 19: R : QUANTITYCOLUMN = 7: R : SIZE1COLUMN = 7: R : SIZE2COLUMN = 2: :COLUMN = 60: W : IE_DESCRIPT
To specify a fixed text as start of the report, use the TEXT keyword. Extra flexibility is provided with the WRITE keyword. The WRITE keyword writes the variable part of the report in between the fixed text from the TEXT keywords.
Below is an example positioning the material table between a header and a single footer line:
TEXT = @ ---------------------------------------------------------------- TEXT = @ PART | QUANTITY | SIZE1 | SIZE2 | DESCRIPTION TEXT = @ ---------------------------------------------------------------- WRITE = TEXT = @ ----------------------------------------------------------------
The position of the Bill of material is defined by the position of its related text node. By default the text node number for the Bill of Material is set to 60. The text node number for the Pipe Cut List is set to number 61. These default numbers can be changed by changing the related property in the Bill of Material definitions file.
Use the INCLUDE and EXCLUDE keywords to specify the type of elements that will be included in, or excluded from, the report. The example below includes only field items and excludes welds.
INCLUDE = IE_FIELD=1EXCLUDE = IE_TYPE=CT_WELD
To specify a report that only contains field components, specify the following line in the material report: INCLUDE = IE_FIELD=1
REPORT = FLD# this to include only field items INCLUDE = IE_FIELD=1 EXCLUDE = IE_TYPE=CT_WELD
COLUMN = 3: R : PARTID COLUMN = 19: R : QUANTITY COLUMN = 7: R : SIZE1 COLUMN = 7: R : SIZE2 COLUMN = 2: : COLUMN = 60: W : IE_DESCRIPT
GROUP = PARTID SORT = PARTID:N SEP = @ SORTHEADERS = 1
TEXT = @ ---------------------------------------------------------- TEXT = @ Field Materials TEXT = @ ---------------------------------------------------------- Write =END
The grouping and/or sorting of the report contents is done by adding the GROUP and/or SORT keywords to the report definition. Each field in the column list can be used as grouping or sorting criteria.
GROUP = PARTIDSORT = PARTID:N
Note: Removing the GROUP keyword will create a material list with each component on a separate line.
To summarize the number of components that have been grouped together, use the QUANTITY keyword.
COLUMN = 19: R : QUANTITY
If you want to have a material list that first shows the shop items and then the field items, you can combine 2 reports into one. The example below combines a report named shp with a report named fld.
#---------------------------------------------------------------------------# The COMBI report combine the SHP and FLD report into a single report# and attaches it to textnode 60 in the isometric#--------------------------------------------------------------------------- REPORT = combi WRITE = shp TEXT = @ TEXT = @ WRITE = fld NODE = 60 END
The appearance of a report on the drawing can be enabled or disabled. The placement and positioning of a report on the drawing is controlled by tying it to a text node element in the seed file.
Adding or removing the NODE keyword to display or not display the report on the drawing. A ‘#’ can also be used to turn the line into a comment, causing the placement of the report to be disabled.
Placement enabled:
NODE = 60
Placement Disabled:
#NODE = 60
The User Labels section in the Configuration Manager is used to control the placement of Pipe Cut Labels in the drawing.
In Default Report.def file a sample reported is listed which user can use it as reference and customize and add more data as per requirement. See below sample Report.
#-----------------------------------------------------------------------------# A sample weld report#-----------------------------------------------------------------------------REPORT = WELD include = IE_TYPE = CT_WELD COLUMN = 5:C:WELDID COLUMN = 10:R:SIZE COLUMN = 10::TYPE
# the next two columns list the pipe/fitting connected by the weld. COLUMN = 30:W:left(EC_CLASS) COLUMN = 30:W:right(EC_CLASS) SORT = WELDID:N SEP = @END
User can add report type in existing COMBI report and get the information. See below settings to see in BOM.
REPORT = combi WRITE = shp TEXT = @ TEXT = @ WRITE = fld TEXT = @ --------------------------------------------------------------------------------- TEXT = @ WELDID | SIZE | TYPE | CONNECTION-1 | CONNECTION-2 TEXT = @ --------------------------------------------------------------------------------- WRITE = WELD NODE = 60END
User can add the following report type in report.def file and get the information. See below settings to see in BOM.
A margin can be specified between text and the column borders. For instance with a column width of 30 and a margin of 2 only 26 mm will be usable for text. MARGIN can be specified outside a report. In that case every report will be initialized with that margin. When defined in a report the global margin will be overridden.The default value for margin is 1mm.
#-----------------------------------------------------------------------------# A sample report that writes shop material to a report#-----------------------------------------------------------------------------
MARGIN = 3REPORT = SHP
# this to include only shop material INCLUDE = IE_FIELD=0 EXCLUDE = IE_TYPE=CT_WELD
TEXT = @ ---------------------------------------------------------- TEXT = @ Shop Materials TEXT = @ ---------------------------------------------------------- Write =END
See BOM output shown for both without MARGIN and with MARGIN.
Without MARGINWith MARGIN
In Default Report.def file a sample reported is listed, which user can use it as reference and customize it as per requirement. See below sample Report.
#-----------------------------------------------------------------------------# A sample report that writes shop material to a report#-----------------------------------------------------------------------------SPACING = 7REPORT = SHP
# this to include only shop materialINCLUDE = IE_FIELD=0EXCLUDE = IE_TYPE=CT_WELD
GROUP = PARTIDSORT = PARTID:NSEP = @ SORTHEADERS = 1
TEXT = @ ----------------------------------------------------------TEXT = @ Shop MaterialsTEXT = @ ----------------------------------------------------------Write =END
Without SPACING valueWith SPACING value
The separator is only used when the report is to be output as text. The SEP statement actually forces the report to be output as text. A report is no longer output as a formatted text files.
Specifies the maximum number of lines available for the report. In case the report contain more lines the behavior is that the report continues with an offset to the right. In case MAX-LINES isn’t defined or is zero the report can have infinite length. This does implements multi column reports.
Click here>>>> to check more information where this setting can be used. Also check >>>> for other example use of it.
COLUMN = 30: R : SIZE
The COLUMN width field is now interpreted as a millimeter value instead of a character count. User may need to change their reports a bit. It will however make life much, much easier.Click here >>>> to check problem description article related to this.
Note the above versions are now using Millimeters instead of characters. Applicable to both AutoPLANT Modeler & OpenPlant Modeler
Steps to Resolve
User Can also See other wiki articles and its sub articles on configuring various types of reports in OpenPlant Isometrics Manager.
Bentley's Product Advantage Group requests that you please confine any comments you have on this Wiki entry to this "Comments or Corrections?" section. THANK YOU!