Bentley Communities
Bentley Communities
  • Site
  • User
  • Site
  • Search
  • User
OpenPlant | AutoPLANT
  • Product Communities
OpenPlant | AutoPLANT
OpenPlant | AutoPLANT Wiki Configuring the BOM and Reports
    • Sign In
    • -OpenPlant | AutoPLANT Wiki
      • -OpenPlant
        • +CONNECT Services - OpenPlant
        • +Example Configuration - CONNECT Edition
        • +Installations - OpenPlant CONNECT Edition Applications
        • +OpenPlant Download Links & Videos
        • OpenPlant Product Compatibility
        • +OpenPlant Modeler CONNECT
        • +OpenPlant PID CONNECT
        • +OpenPlant Isometrics Manager CONNECT
        • +OpenPlant Orthographics Manager CONNECT
        • +OpenPlant Support Engineering CONNECT
        • +OpenPlant Project Administrator CONNECT
        • +OpenPlant CONNECT Edition-PlantSight Integration
        • +OpenPlant Modeler v8i
        • -OpenPlant Isometrics Manager v8i
          • -OpenPlant Isometrics Manager for OpenPlant
            • Installation/Upgradation Steps for OpenPlant Isometrics Manager
            • +Errors, Logs, Messages, Crashes - OpenPlant Isometrics Manager
            • +Open/Save - OpenPlant Isometrics Manager
            • +Processing - OpenPlant Isometrics Manager
            • -Settings/Attributes - OpenPlant Isometrics Manager
              • -Configuring the BOM and Reports
                • Grouping of Supports Based on Common EC CLASS Name
                • Grouping of Supports Based on Common Tag Name
                • How Define to List Property Values in Limited Number of Rows
                • How to Add Desired Custom Property Value to OpenPlant Isometrics BOM
                • How to add End type Information in Isometric Bill of Material Cut list
                • How To Add Field components Under Shop Material In Bill Of Materials
                • How to Add Piping Component Properties on Weld Reports
                • How To Create Various BOM Report Types in OpenPlant Isometrics Manager
                • How to Generate Reports based on Size
                • How to Generate Reports based on Size with Sequential Numbering System
                • How To Display only Support List in OpenPlant Isometrics Manager Bill of Materials
                • How to display Pipeline size in Bolt BOM Description in Isometric Manager
                • How to Force Field Weld Component to Appear Under Field Materials in BOM
                • How to Report Cut list in Multiple Columns
                • How to Round Up Quantity in Bill of Material
                • How To Set Reducer Size Annotation in BOM Report
                • How to Show Calculated Pipe Weight in BOM
                • How To Show Tag For Multiple Components in Isometrics BOM
                • How To Show Total Weight for Bill Of Material in OpenPlant Isometrics Manager
                • How To Sort PARTID In OpenPlant Isometrics Manager BOM
                • Modifying the Welding Information
                • To Add End Type Information (BEVEL, SQCUT) in Isometric BOM Cut list
                • To Concatenate Additional Property in RBR-UBR Description in BOM
                • To Display Bolt Length as Metric in BOM Description
                • To Display New Line for each Attributes in BOM
                • To Display Pipe Bend components in Numbers in OpenPlant Isometrics Manager BOM
                • To Display Sum of Bolt Length and Bolt Excess Length in BOM
                • To Display UNIT information for Support in BOM for OpenPlant Isometrics Manager
                • To Fix BOM column Text Wrapping issue in OpenPlant Isometrics Manager
                • To Get Shop Field Information for welds in OpenPlant Isometrics Manager
                • To include the sheet number in the SPOOLID of BOM in the OpenPlant Isometrics Manager
                • Weld Tags Sorting in Numerical and Sequencing Order in OpenPlant Isometrics Manager
              • +DBQuery : usage, logging, debugging
              • +Grid Lines - OpenPlant Isometrics Manager
              • Connectivity Information Lost in Isometric After Detaching/Attaching Reference Model
              • How To Add Detail Sketches in OpenPlant Isometrics Manager Using OpenPlant Modeler
              • How to Add NEW Schema Field to Component for Custom Tagging in OpenPlant Isometrics Manager
              • How to Adjust Imperial Accuracy in OpenPlant Isometrics Manager
              • How to Assign FieldFit Weld Allowances or Other Weld Types for BOM & Cut List in OpenPlant Isometrics Manager
              • How to Change Numbering Sequences For Spools, Welds & CUTID
              • How to Control Socket Weld Symbols in OpenPlant Isometrics Manager
              • How to Define Existing lines in OpenPlant Isometrics Manager
              • How to Delete Levels and Create Custom Level List in OPIM Seed File
              • How To Display Co-ordinates Using Multipliers
              • How to Display Nozzle Rating and Facing Information on Connection & Continuation in OpenPlant Isometrics Manager
              • How To Display Pipe Length using Multipliers
              • How To Feature Microstation Tags And AutoCAD Attributes
              • How to Format Data in Fractions Listed Under Drawing Tag Data
              • How to Get Exclusive Support PARTID Report with Prefix
              • How to Hide Sizes Of Bolts in Bill Of Material
              • How To Modify Valve Tag
              • How to Obtain Different Descriptions for Trimmed Elbow in OpenPlant Isometrics Manager BOM
              • How to Remove Information from Isometric Output
              • How to Rotate Support Symbols in OpenPlant Isometrics Manager
              • How to Round Off Values After Decimal For Support Co-ordinates
              • How to Split the Components on Different Description and to Avail Different PartID in BOM
              • Managing Isometrics Styles
              • +Modifying Dimensions
              • +Modifying Symbols in OpenPlant Isometrics Manager
              • +Modifying Text and Annotation Settings
              • +Modifying the Isometric Content
              • +Setting File Type (DGN or DWG) and Paper Setting
              • To Specify Various Imperial Value Output Type in OpenPlant Isometrics Manager
              • To Concatenate Length Property in Description Field for BOM
              • To Define Symbology for Multiple Component State in OpenPlant Isometrics Manager
              • To Display Handwheel Orientation For GearBox Operator in OpenPlant Isometrics Manager
              • To Display Multiple Rows for Notes as Labels
              • To Display New Property in Description Field For BOM in OpenPlant Isometrics Manager
              • To Display Right Angle Operator Direction with Spindle in OpenPlant Isometrics Manager
              • To Display Support Orientation in OpenPlant Isometrics Manager
              • Additional 3D.DWG file Created in OpenPlant Isometrics Manager
              • How to insert spaces between PARTID labels in OpenPlant Isometrics Manager
          • +OpenPlant Isometrics Manager for AutoPLANT
          • +Release Notes - OpenPlant Isometrics Manager
          • OpenPlant Isometrics Manager [FAQ]
        • +OpenPlant Project Administrator v8i
        • +OpenPlant PID v8i
        • +OpenPlant Orthographics Manager v8i
        • +OpenPlant Support Engineering v8i
        • +OpenPlant ModelServer v8i
        • +OpenPlant Reporting v8i
        • How to Connect with Bentley Technical Support Team using Microsoft Teams
        • How to Connect with Bentley Technical Support Team using Microsoft Teams via Browser
        • How to get list of installed applications/programs on Windows Machine using Command Prompt.
        • How to get list of Windows Updates installed on the machine using Command Prompt.
        • How to Package WorkSpace to be Shareable to Users for OpenPlant Projects
      • +Bentley AutoPLANT
      • +Bentley Navigator
      • +Bentley PlantSpace
      • +Plant Project Tools
      • +Bentley Raceway and Cable Management
      • i-model Composition Service for S3D
      • Working from home with OpenPlant
      • Working from home with Bentley Raceway and Cable Management
      • Working from home with AutoPLANT Modeler
      • Your Feedback is important to us!

     
     Questions about this article, topic, or product? Click here. 

    Configuring the BOM and Reports

    Applies To 
    Product(s): OpenPlant Isometrics Manager
    Version(s): 08.11.11.XXX (SS6)
    Environment:  Windows 7/8.1/10 (64 bit)
    Area:  Settings/Attributes
    Subarea:  -
    Original Author: Keith Couvillion, Bentley Product Advantage Group

    BOM / Report Configuration

    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

    Report Definition

    Report Definition File

    1. From the Isometric Configuration dialog:
    2. Select the Isometrics Style tab
    3. Style – Select the relevant style from the dropdown
    4. Select Advanced from the left pane
    5. Click Open Report Definition



      Note: The header of the report definition file explains the available option to configure the content and layout of reports.

    Table Definitions

    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 : PARTID
    COLUMN = 19: R : QUANTITY
    COLUMN = 7: R : SIZE1
    COLUMN = 7: R : SIZE2
    COLUMN = 2:   :
    COLUMN = 60: W : IE_DESCRIPT

    Where:

    <width> specifies the width of the column in millimeters (Note: This has changed as it used to specify character count for the width)
    <format/alignment> can be one of the following:
    L – left aligned
    C – centered
    R – right aligned
    W – wrap (a new line will be added if the length of the expression exceeds the width of the column
    <expression> is an expression for the content of the report column. Any component attribute or string can be used. Example: IE_DESCRIP + UUID + “and a string” would concatenate the attributes IE_DESCRIPT and UUID and the string “and a string.”

    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>>>>

    Displayed Properties

    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 : PARTID
    COLUMN = 19: R : QUANTITY
    COLUMN = 7: R : SIZE1
    COLUMN = 7: R : SIZE2
    COLUMN = 2:   :
    COLUMN = 60: W : IE_DESCRIPT

    Table Headers

    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 = @ ----------------------------------------------------------------

    Bill of Material

    Location on Drawing

    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.

    Component Types

    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=1
    EXCLUDE = IE_TYPE=CT_WELD

    Field and Erection Materials

    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

    Grouping / Sorting Reports

    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 = PARTID
    SORT = PARTID:N

    Note: Removing the GROUP keyword will create a material list with each component on a separate line.

    Summarizing Reports

    To summarize the number of components that have been grouped together, use the QUANTITY keyword.

    COLUMN = 19: R : QUANTITY

    Combining Reports

    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

    Enable/Disable Reports

    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

    Pipe Cut Length Report

    Include the Cut ID in the report

    1. To include the cut id of the pipe cut labels in your pipe cut report, specify the CUTID keyword for one of the columns. The NODE keyword specifies the location of the report in the drawing.

      #-----------------------------------------------------------------------------
      # The CUT report lists the pipe cut pieces
      # Attaches to text node 61
      #-----------------------------------------------------------------------------
      REPORT = CUT
          INCLUDE = IE_TYPE=CT_PIPE|CT_BEND
          COLUMN  = 6:C:CUTID
          COLUMN  = 7:R:SIZE1
          COLUMN  = 21:R:QUANTITY
          COLUMN  = 3:R:
          COLUMN  = 80:W:IE_DESCRIPT
          GROUP   = CUTID
          SORT    = CUTID
          NODE    = 61
      END

    2. With use on New setting, Cut list for Reports overflows, click here>>>> for more details

    Enable the Placement of Pipe Cut Labels

    The User Labels section in the Configuration Manager is used to control the placement of Pipe Cut Labels in the drawing.

    1. From the Isometric Configuration dialog:
    2. Select the Isometrics Style tab
    3. Style – Select the relevant style from the dropdown
    4. Select User Labels from the tree
    5. Select Pipe Cut Labels

    Weld Report

    Include the Weld reports in BOM

    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

    Example: 

    User can add report type in existing COMBI report and get the information. See below settings to see in BOM. 

    1. Add values & report type in COMBI report. 

      REPORT = combi
      WRITE = shp
      TEXT = @
      TEXT = @
      WRITE = fld
      TEXT = @ ---------------------------------------------------------------------------------
      TEXT = @ WELDID | SIZE | TYPE | CONNECTION-1 | CONNECTION-2
      TEXT = @ ---------------------------------------------------------------------------------
      WRITE = WELD
      NODE = 60
      END

    2. Save & close file. 
    3. See Image below for Sample report.



      Note - Here left(EC_CLASS) is always pipe as first connection if exists. Second EC_CLASS is second connection element. For more information of these attributes use, click here>>>>

    Spools List Report

    Include the Spools List reports in BOM

    User can add the following report type in report.def file and get the information. See below settings to see in BOM. 

    1. Add the following report in report.def 

      #-----------------------------------------------------------------------------
      # A sample Spools report
      #-----------------------------------------------------------------------------
      REPORT = SPOOLS
        INCLUDE = IE_FIELD=1
        INCLUDE = IE_FIELD=0

       COLUMN   = 100:R: "SPOOL NUMBER  " + PARTID + "  =  " + SPOOL_ID

       GROUP = SPOOL_ID
        SORT = SPOOL_ID:N
        SEP = @
        NODE = 105
      END

    2. Save & close file. 
    3. Open Isometric Configuration -> Isometric Style -> Advanced  -> Open Seed File



    4. Attach text node at proper place in the seed file



    5. Close the seed file; Generate Isometrics and Verify Result.

    Configure BOM Reports

    Include MARGIN between the Text 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 = 3
    REPORT = SHP

    # this to include only shop material
    INCLUDE = IE_FIELD=0
    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 = @ Shop Materials
    TEXT = @ ----------------------------------------------------------
    Write =
    END

    See BOM  output shown for both without MARGIN and with MARGIN. 

    Without MARGIN


    With MARGIN

    Include SPACING between the Text in BOM

    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 = 7
    REPORT = SHP

    # this to include only shop material
    INCLUDE = IE_FIELD=0
    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 = @ Shop Materials
    TEXT = @ ----------------------------------------------------------
    Write =
    END

    See BOM output shown for both without MARGIN and with MARGIN. 

    Without SPACING value


    With SPACING value

    Separator (SEP)

    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.

    • A report line will never be wrapped.
    • No matter what width is specified for a column, the full text is always output.
    • Columns are concatenated separated by the SEP

    MAX-LINES

    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

    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. 

    OpenPlant Isometrics Manager V8i (SELECTseries6) Version: 08.11.11.224  Refresh 2

    Note the above versions are now using Millimeters instead of characters. Applicable to both AutoPLANT Modeler & OpenPlant Modeler

    Steps to Resolve

    1. OPEN { report.def }
    2. below is the old out of the box version settings.



    3. The following is altered for standard Out Of the Box Isometrics.



    4. Save file close and re-run the ISO to check results:

      NOTE : End user should open seed file and measure in MILLIMETERS according to their Custom BOM. This setup is specific to individual project basis and different settings may require based on various projects used.
    5. See results: 



    6. For details click here>>>>.

    See Also

    User Can also See other wiki articles and its sub articles on configuring various types of reports in OpenPlant Isometrics Manager.

    Comments or Corrections?

    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!

    • Bill of Materials
    • reports
    • AutoPLANT Modeler
    • BOM
    • OpenPlant Isometrics Manager
    • Share
    • History
    • More
    • Cancel
    • Keith.Couvillion Created by Bentley Colleague Keith.Couvillion
    • When: Thu, Mar 13 2014 3:49 PM
    • Kestutis Mitkus Last revision by Bentley Colleague Kestutis Mitkus
    • When: Mon, Dec 17 2018 1:21 PM
    • Revisions: 18
    • Comments: 0
    Recommended
    Related
    Communities
    • Home
    • Getting Started
    • Community Central
    • Products
    • Support
    • Secure File Upload
    • Feedback
    Support and Services
    • Home
    • Product Support
    • Downloads
    • Subscription Services Portal
    Training and Learning
    • Home
    • About Bentley Institute
    • My Learning History
    • Reference Books
    Social Media
    •    LinkedIn
    •    Facebook
    •    Twitter
    •    YouTube
    •    RSS Feed
    •    Email

    © 2023 Bentley Systems, Incorporated  |  Contact Us  |  Privacy |  Terms of Use  |  Cookies