36
Standard Reporting Reference Manual

Standard Reporting

Embed Size (px)

DESCRIPTION

report

Citation preview

  • Standard Reporting

    Reference Manual

  • Discl1.1 AVE errupted, error-free or free fromviruses

    1.2 AVE will and/or similar losses; loss ofanticipa tion of data or information; anyspecial,sufferedcreatedcontrac

    1.3 AVEperformclaim is

    1.4 Cla

    1.5 In thwhich th

    CopyCopyrig(includiwith it)

    All rightis commthe priothat thismade.

    The maelectronengineepublicapermissprohibit

    The AVand coUnauth

    Copynot be lfrom a u

    AVEVA

    TradeAVEVAthe AVE

    AVEVAsubsidia

    The coplogo be

    AVEVA Solutions Limited aimerVA does not warrant that the use of the AVEVA software will be unint

    .

    VA shall not be liable for: loss of profits; loss of business; depletion of goodted savings; loss of goods; loss of contract; loss of use; loss or corrup

    indirect, consequential or pure economic loss, costs, damages, charges or expenses which may be by the user, including any loss suffered by the user resulting from the inaccuracy or invalidity of any data by the AVEVA software, irrespective of whether such losses are suffered directly or indirectly, or arise int, tort (including negligence) or otherwise.

    VA's total liability in contract, tort (including negligence), or otherwise, arising in connection with theance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the user's brought.

    uses 1.1 to 1.3 shall apply to the fullest extent permissible at law.

    e event of any conflict between the above clauses and the analogous clauses in the software licence undere AVEVA software was purchased, the clauses in the software licence shall take precedence.

    rightht and all other intellectual property rights in this manual and the associated software, and every part of it

    ng source code, object code, any data contained in it, the manual and any other documentation suppliedbelongs to, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries.

    s are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this documentercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without

    r written permission of AVEVA Solutions Limited. Where such permission is granted, it expressly requires copyright notice, and the above disclaimer, is prominently displayed at the beginning of every copy that is

    nual and associated documentation may not be adapted, reproduced, or copied, in any material oric form, without the prior written permission of AVEVA Solutions Limited. The user may not reverser, decompile, copy, or adapt the software. Neither the whole, nor part of the software described in this

    tion may be incorporated into any third-party software, product, machine, or system without the prior writtenion of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised action is strictlyed, and may give rise to civil liabilities and criminal prosecution.

    EVA software described in this guide is to be installed and operated strictly in accordance with the termsnditions of the respective software licences, and in accordance with the relevant User Documentation.orised or unlicensed use of the software is strictly prohibited.

    right 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA shalliable for any breach or infringement of a third party's intellectual property rights where such breach resultsser's modification of the AVEVA software or associated documentation.

    Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.

    mark and Tribon are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised use ofVA or Tribon trademarks is strictly forbidden.

    product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or itsries, registered in the UK, Europe and other countries (worldwide).

    yright, trademark rights, or other intellectual property rights in any other product or software, its name orlongs to its respective owner.

  • Revisi

    Date

    Septe n.

    Janua

    Standard Reporting Reference Manual on Sheet

    Version Comments / Remarks

    mber 2011 12.1.1 Modifications to Text Display sectiory 2012 Copyright added to all pages.

  • Standard Reporting Reference Manual

  • Standard Reporting Reference Manual Standard Reporting Reference Manual

    Contents Page

    Standard ReportingIntroduction to Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1Sample Report Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1Before You Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2Starting to Use Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:3How to Use This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:3Running a Report from a Saved Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:3

    Creating and Running a Simple Report . . . . . . . . . . . . . . . . . . . . . . 2:112 Seriesi Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    Creating a Simple Nozzle Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1Running the Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2

    Column Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2Adding and Moving Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3Runtime Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4Saving and Deleting Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4Saving a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4Deleting a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5

    Reporting on Different Parts of the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5Adding Elements using the Members List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5Adding Elements in a Given Volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5

  • Standard Reporting Reference ManualFrom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:6

    More Column Layout Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:6Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:6Numeric Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:7Text Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:8

    Introductions and Summaries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:8

    Sorting and Totalling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1Changing the Order of Sorting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2Sorting on More than one Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2Totalling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4Subtotalling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4Showing only the First Occurrence of Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5

    Quantity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6

    Selective Reporting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1

    File Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1Page Information Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1Report Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:2Late Evaluation of Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:2Points to Note. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:2

    Headers, Footers and Page Lengths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:3Introduction and Summaries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:3Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:3

    Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1Running Reports in Batch Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1System Command Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1Report Output Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:112 Seriesii Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualIntroduction to Reports1 Introduction to Reports

    This manual is an introduction to the PDMS Reports Utility, available in DESIGN, DRAFTand PARAGON.

    The main features of the Report Utility include: Generation of report to file or screen. Listing of any element from a PDMS database. Specify lists of properties by which elements can be sorted. Quantifying of lists under sub-totals and grand totals. The ability to create expressions for column values, based on the contents of the

    column or the results of other columns. The ability to use expressions in report output, including user definition of titles,

    summaries, headers and footers. Generation of reports with specified column widths and delimiters for interfacing to

    other database systems or spread sheets. Complete control over the report definition and layout. Generation of reports using the batch process.

    1.1 Sample Report TemplatesYou produce a report by running a report template. The template specifies what the reportwill contain, whether it will be sent to the screen or a file and how it will be laid out.Templates also specify what information can be specified at the time the report is run, forexample, what part of the database, or the output filename.

    There is a library of example reports supplied with the product in the directory %PDMSUI%/REPORTS. Under this directory is a TEMPLATES directory, which contains the templateswhich generated the reports. The templates are PDMS macros, but the best way to see howthey are set up is to select Utilities > Standard Reporting > Reports > Modify from themain menu, and look at the settings on the forms displayed.

    Templates have the file extension .tmp, and the corresponding reports have a file extension.rep. 12 Series 1:1 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    Most of the examples are based on the sample project and the sample templates suppliedwith the product.

  • Standard Reporting Reference ManualIntroduction to ReportsThe sample templates produce the following types of report:

    1.2 Before You StartThis manual assumes that you are familiar with PDMS to the level of the Basic TrainingCourse.

    Most of the examples in this manual illustrate templates which report directly on PDMSattributes and pseudo-attributes. You can also use more complex expressions in reporttemplates, and although some of these are illustrated, you will need to be familiar with PML,the AVEVA Programmable Macro Language, if you want to set these up for yourself.

    For information about further training, please contact your nearest AVEVA Support Office(see the copyright page at the front of this guide for details).

    To use the sample templates supplied with the product, the PDMS variable $PDMSREPDIRshould be set to the directory where the sample reports are stored.

    nozz_sched This is a Nozzle schedule, which lists all Nozzles sorted byname, and shows the P1 bore, connection type anddirection, and the position of each Nozzle.

    line_list This report is a list of Branches, sorted by the name of thePipe which owns them. The Head and Tail bores and theHead and Tail references are given.

    pipe_mto This report shows material information for all Branchmembers, sorted by type, Detail Text and Material Text. TheTube length and quantity of each component are totalled.There is an Imperial version of this report template.

    tube_mto This report totals all Tubing. The Specification Reference,P1 Bore, Detail Text and Material Text are shown.

    steel_mto This is a material take-off list for structural components.

    valve_list This report is an example of selective reporting.

    centre_line The centre-line length of each Branch is listed. There is anImperial version of this report template.

    tube_gradient This report gives the gradient of each tubing component.

    catalogue_param This is an example of reporting on the catalogue database.It lists Branch members, with their CATREFs and theparameters of the CATREFs.

    catalogue_ptgmref This is an example of reporting on the catalogue database.It lists Branch members, with their CATREFs followed by thePTREFs and GMREFs of the CATREFs.

    tube_area_vol This report uses derived properties to report on the areaand volume of tubing.12 Series 1:2 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualIntroduction to Reports1.3 Starting to Use ReportsYou will usually have a library of report templates set up for you, but you can produce andrun a report template quickly by selecting Utilities > Standard Reporting > Reports >Create, filling in the New Report Template form to specify what you want to report on andthen pressing Apply on the form, which will run the report.

    Note that this is the easiest way of testing a template that you are creating or modifying.

    1.4 How to Use This ManualRunning a Report from a Saved Template summarises how to run a report from a savedtemplate, which you may already know about.

    Creating and Running a Simple Report in Chapter Creating and Running a Simple Report isa tutorial which works through the steps of creating a simple report template, running it andsaving it.

    Sorting and Totalling in Chapter Sorting and Totalling illustrates sorting and totalling bymodifying the sample templates.

    Selective Reporting in Chapter Selective Reporting is a brief introduction to using PMLexpressions to produce selective

    File Reports in Chapter File Reports describes the options which are only applicable to filereports, including inserting headers and footers. It also describes how to insert introductionsand summaries, which can be provided for screen reports as well, but they are created inthe same way as headers and footers.

    Note that not all the options on all the forms are described when they are first seen. If youwant more information about a form, use the online help.

    1.5 Running a Report from a Saved TemplateYou may already be familiar with creating a report by running a saved report template. If not,try this introductory exercise:

    1. Select Utilities > Standard Reporting > Reports > Run. You will see a File Browser,showing the contents of the directory REPORTS. Select the TEMPLATES sub-directory.

    2. Select the report template pipe_mto.tmp and select Open. You will see the ReportDetails form, with the following options: Filename

    If you specify a filename, the report will be sent to the given file in your workingdirectory. If you leave the text box empty, the report will be sent to the screen.

    HierarchyGive a list of elements. The report will be output for all the elements given, and allthe elements owned by them. 12 Series 1:3 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualIntroduction to Reports12 Series 1:4 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualCreating and Running a Simple Report2 Creating and Running a Simple Report

    This chapter describes how to create a simple report template, run it and save it. To workthrough the example, start up DESIGN, DRAFT or PARAGON, using the SAM project.

    2.1 Creating a Simple Nozzle ScheduleThe exercise creates a nozzle schedule, a simplified version of the one in the templatenozz_sched.tmp supplied with the product.

    If you are running DRAFT, make sure that the Members List for the DESIGN database isdisplayed.

    Select Utilities > Standard Reporting > Reports > Create. You will see the New ReportTemplate form.

    There are several groups of options on the form, described in the following subsections.

    2.1.1 DestinationDestination allows you to specify whether the report is output to Screen or to a File.

    For this example, select Screen.

    2.1.2 SelectionThe Selection options allow you to specify the type of item you want to report on, and thelevel in the database hierarchy below which the selection will be made.

    The Zone EQUIP in the sample project contains the Equipment /E1301, which owns severalNozzles. We will produce a template to report on these Nozzles.

    For this example:

    1. Enter NOZZ in the Type(s) textbox.2. Leave the With text box blank. This is used in selective reporting, described in

    Selective Reporting.3. Replace WORLD in the Hierarchy text box with /E1301. Note that the slash must be12 Series 2:1 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    present, as you can give several names in the box.

    2.1.3 ColumnsNow create three columns for the report, to display the name of the Nozzle, the arrive boreand the position, using the Columns options.

    Select the New option button, and the Creating Column form will be displayed.

  • Standard Reporting Reference ManualCreating and Running a Simple ReportThe Expression text box defines the contents of the column. You can enter a PDMSattribute or pseudo-attribute here, or an expression containing attributes or pseudo-attributes.

    Ignore the Sorting and Precedence option for now. By default, the list of items in the reportwill be sorted in the order in which they are stored in the database.

    You can set the Units option when appropriate.

    The Column Layout button is used to control the format of each column, but we will use thedefault layout for now.

    Fill in the form as follows:

    1. For the first column, enter NAME in the Expression text box.2. This is all you need to set for the first column: do not press OK yet, but select Next

    Column. The settings on the Creating Column form will be cleared ready for you todefine the second column.

    3. The second column will display the arrive bore of the Nozzles. Type P1 BORE into theExpression text box. Select Units of Any/mm.

    4. Select Next Column again and define the third column, which will display thecoordinates of the Nozzle, by entering POS into the Expression text box. Units shouldbe set to Pos(mm).

    Now select OK on the Creating Column form. Note that the three columns you have definedare shown in the scrolling list on the New Report Template form.

    2.1.4 Running the ReportSelect Apply on the New Report Template form, which will run the report.

    The report will be output to a window: if you have an active window displayed, for examplethe command line window, the report will be displayed there. If there is no active window, anew window will be opened.

    The report should look like this:

    Note: By default the text that you entered in the Expression text box is used as the columnheading. You can change this, as described in Text Display.

    2.2 Column LayoutThe layout of this report is not very easy to read, so now we will use the option on the Layoutfor Column form to improve it.

    NAME P1 BORE POS

    /E1301-S1 200.00 E 0.00 N 3540.00 D 635.00

    /E1301-S2 200.00 E 0.00 N 1100.00 U 635.00

    /E1301-S3 200.00 E 0.00 N 5980.00 U 635.00

    /E1301-T1 100.00 E 0.00 N 290.00 U 635.00

    /E1301-T2 100.00 E 0.00 N 290.00 D 635.0012 Series 2:2 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualCreating and Running a Simple ReportHighlight POS in the list on the New Report Template form, and select Modify. On theModifying Column 3 form, select Column Layout, and you will see the Layout for Columnform.

    Set the Spaces before Column option to 4, and set Justification to Left. The output willlook like this:

    Further column layout options are describes in More Column Layout Options.

    2.3 Adding and Moving ColumnsNow we will add two more columns to the report, for P1 CONN and P1 DIR.

    1. A new column is inserted before the one selected in the list on the New ReportTemplate form. To insert a column at the end of the list of columns, make sure that theentry reading is highlighted, and select New again.

    2. Enter P1 CONN into the Expression text box and set Units to Off. On the ColumnLayout form, set justification to Left. Select Next Column on the Creating Columnform.

    3. Enter P1 DIR into the Expression text box and set Units to Off. On the Column Layoutform, set justification to Centre and select OK.

    4. Select OK on the Creating Column form.Remember that inserting a new column will renumber all columns to the right of the newcolumn.

    Now move the POS column so that it is the last (fifth) column again.

    1. Highlight the POS column in the list on the New Report Template form, and select theMove option button. You will see the Move Column form. Select 5 from the optiongadget and select OK.

    2. Select Apply on the New Report Template form. The modified report should look likethis:

    NAME P1 BORE POS

    /E1301-S1 200.00 E 0.00 N 3540.00 D 635.00

    /E1301-S2 200.00 E 0.00 N 1100.00 U 635.00

    /E1301-S3 200.00 E 0.00 N 5980.00 U 635.00

    /E1301-T1 100.00 E 0.00 N 290.00 U 635.00

    /E1301-T2 100.00 E 0.00 N 290.00 D 635.00

    NAME P1 BORE P1 CONN P1 DIR POS

    /E1301-S1 200.00 FBD D E 0.00 N 3540.00 D 635.00

    /E1301-S2 200.00 FBD U E 0.00 N 1100.00 U 635.00

    /E1301-S3 200.00 FBD U E 0.00 N 5980.00 U 635.00

    /E1301-T1 100.00 FBB U E 0.00 N 290.00 U 635.00

    /E1301-T2 100.00 FBB D E 0.00 N 290.00 D 635.0012 Series 2:3 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualCreating and Running a Simple Report2.4 Runtime PromptsIf you are going to save the template so that it can be run in future, it is likely that you willwant to have some control over the content when the report is run. For example, you willwant to specify the part of the hierarchy to report on.

    You can control what information the user is prompted for when the report is run usingruntime prompts. The Runtime Prompts form will be displayed when you select Options >Runtime Prompts on the menu on the New/Modify Report Template form.

    The options correspond to the options on the New/Modify Report Template form. They are: File name Type(s) With Hierarchy Volume From

    File name allows you to specify the file where the report will be stored. The only otheroptions we have looked at so far are Type(s) and Hierarchy.

    1. Switch on File name, Type(s) and Hierarchy on the Runtime Prompts form and selectOK.

    2. Now run the report again, by selecting Apply on the New Report Template form. Youwill see the Report Details form, with the values you have set on the Report Templateform for the three parameters displayed. You can now change them: for example, entera filename, and add other Equipments to Hierarchy.

    Note: If you specify in the template that a report will be sent to a file, and the user removesthe filename on the Report Details form, the report will be sent to the screen.However, if you specify that the report will be sent to the screen, do not switch on theFilename option on the Runtime Prompts form, because the report will be sent to thescreen even if the user gives a filename.

    Note: Do not set any runtime prompts for report templates intended for batch mode.

    Note: Text boxes filled on the Runtime Prompts form will appear as defaults on the ReportDetails form.

    2.5 Saving and Deleting Templates

    2.5.1 Saving a TemplateIf you want to save the report template in a file, select one of the options under File on themenu at the top of the New Report Template form:

    Save As allows you to save the template in a new file. A File Browser will be displayed. Save saves the template to the current file if the template has been saved already. The

    filename is shown in the title bar of the form.

    Note: The file where the template is stored has no relation to the file specified if you want tooutput the report itself to a file. See File Reports for more information.

    You can save your template if you wish, provided you have write access to the directory, butyou will not need it in future exercises.12 Series 2:4 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualCreating and Running a Simple Report2.5.2 Deleting a TemplateIf you select Utilities > Standard Reporting > Reports > Delete, you will see a FileBrowser from which you can select the template or report you want to delete.

    2.6 Reporting on Different Parts of the DatabaseThe following exercises are based on the supplied template pipe_mto.tmp. You may wishto look at the corresponding supplied report, pipe_mto.rep, first, using a text editor.

    Select Utilities > Standard Reporting > Reports > Modify, and select the template fromthe list. The Modify Report Template form will be displayed. Note that this is exactly thesame as the New Report Template form, except that the name of the template is shown inthe title bar of the form, and the setting for the template are shown on the form.

    Note: All the supplied templates output to files, and have runtime prompts set. For theexercises, we suggest that you send the reports to the screen, and switch off theruntime prompts by selecting Options > Runtime Prompts from the menu at the topof the Modify Report Template form.

    The parts of the database you want to include in the report are specified by entering theelements at the top of each part of the hierarchy in the Hierarchy text box on the New/Modify Report Template form. The default is the World. If you just want to specify one or twoelements, you can just type in the element names. The names must always be preceded bya slash and separated by a space, because you can enter several names, for example:

    /100-B-1 /100-B-2If you want to specify several elements, it is easiest to use the Hierarchy form, which alsoallows you to report on all the elements in a Volume, selected from the MDB, the Drawlistor the Obstruction list.

    2.6.1 Adding Elements using the Members ListThe Hierarchy form is displayed when you select the Hierarchy button on the Modify ReportTemplate form.

    1. Go to the PIPES Zone in the Members List.2. Select Pipe /100-B-1 in the Members List, and select CE on the Hierarchy form. The

    Pipe will be shown in the scrolling list in the Hierarchy form. Do the same for /100-B-2and /150-A-3.

    3. Note that you can remove an element from the list by highlighting it in the list andpressing Remove.

    4. Select OK on the Hierarchy form, and the Pipes will appear in the Hierarchy text boxon the Modify Report Template form.

    Note: Specifying elements using this option will override anything you specify in the Volumeor From option.

    2.6.2 Adding Elements in a Given VolumeIf you leave the Hierarchy option on the Modify Report Template form empty, you canspecify a Volume in the model, and report on elements Completely within or Partiallywithin it. Selecting Completely within or Partially within from the Volume option buttonon the Hierarchy form will display the Report Volume form, which is used in the same way12 Series 2:5 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    as other PDMS forms for defining volumes.

  • Standard Reporting Reference ManualCreating and Running a Simple ReportThe volume is defined by entering the coordinates of the diagonal of a limits box, either byentering the coordinates into the text boxes, or using the menu options to pick a point withthe cursor. The reporting volume can also be defined by selecting the Grid Lines optionfrom the Intersections menu on the Report Volume form. This will display the Volume fromGrid form, which is used in exactly the same way as the Clip from Grid form (described inGraphical Model Manipulation Guide).

    Note: Specifying a Volume will select elements from the whole MDB. The other Fromoptions cannot be used.

    2.6.3 FromThe From options are used to specify where the Reports Utility will look for the elements toreport on:

    MDBshould be used if you are giving specific elements in the Hierarchy.

    Drawlistwill select all elements in the drawlist. The Hierarchy text box should be left blank.

    Obstruction listwill select all elements in the obstruction list. The Hierarchy text box should be leftblank.

    2.7 More Column Layout OptionsThe following examples illustrate some more of the options on the Layout for Column nform.

    Some of the options are only used in sorting and totalling, and these are described inSorting and Totalling. Some only apply to File reports, and these are described in FileReports. This section describes the general options which apply to all reports.

    2.7.1 LayoutThe number of Spaces before column. This is the number of spaces between the end ofthe previous column and the start of the current column. The effect will be affected by theJustification.

    The Column width in characters. If you do not give a value, the width of the widest entry willbe used.

    The Justification can be set to Left, Centre or Right.

    The effects of the layout options are illustrated in the following examples, based on thetemplate centre_line.tmp:

    The format as supplied:

    Centre Line Length Report for /100-B-1

    PIPE NAME PSPEC HEAD BORE CENTRE LINE LENGTH

    /100-B-1 /100-B-1-B2 /A3B 80.00 2455.1912 Series 2:6 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualCreating and Running a Simple ReportJustification for the HBORE column set to Centre:

    Space before the HBORE column set to 5, rather than 2:

    Space before the HBORE column set to 2, and the column width set to 15:

    2.7.2 Numeric DisplayThe Remainder can be set to:

    Decimalin which case you can specify the number of Decimal places

    or Fraction

    in which case you must specify the Denominator. In the output, the denominator willbe reduced if possible.

    The Style only affects how feet and inches are displayed. For example: US gives 10'-5" PDMS gives 10' 5

    Leading zeros can be on or off.

    /100-B-1 /100-B-1-B1 /A3B 50.00 39524.55

    /100-B-1 /100-B-1-B3 /A3B 50.00 3119.80

    Centre Line Length Report for /100-B-1

    PIPE NAME PSPEC HEAD BORE CENTRE LINE LENGTH

    /100-B-1 /100-B-1-B2 /A3B 80.00 2455.19

    /100-B-1 /100-B-1-B1 /A3B 50.00 39524.55

    /100-B-1 /100-B-1-B3 /A3B 50.00 3119.80

    Centre Line Length Report for /100-B-1

    PIPE NAME PSPEC HEAD BORE CENTRE LINE LENGTH

    /100-B-1 /100-B-1-B2 /A3B 80.00 2455.19

    /100-B-1 /100-B-1-B1 /A3B 50.00 39524.55

    /100-B-1 /100-B-1-B3 /A3B 50.00 3119.80

    Centre Line Length Report for /100-B-1

    PIPE NAME PSPEC HEAD BORE CENTRE LINE LENGTH

    /100-B-1 /100-B-1-B2 /A3B 80.00 2455.19

    /100-B-1 /100-B-1-B1 /A3B 50.00 39524.55

    /100-B-1 /100-B-1-B3 /A3B 50.00 3119.8012 Series 2:7 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualCreating and Running a Simple Report2.7.3 Text DisplayYou can specify the characters used to specify Unset text, which enables you to specifysome text to be output for an attribute which does not exist for an element, for exampleDESC on a CYLI element.

    Headings

    For reports without sorting or totalling Headings will normally be On. For example ofswitching Headings off, see Sorting and Totalling. The Page option is only used for filereports. For more information, see File Reports .

    Heading TextThe Heading Text can be set to:

    Expression Textwhich will use the expression entered in the Expression text box on the CreatingColumn form. For example, CLLE for the centre line length.

    Defaultwhich will use the full PDMS attribute name if possible. For example, if you enter CLLEin the Expression text box, the column heading will be CENTRE LINE LENGTH.

    Customin which case you should enter the text required in the text box. You can insert severallines of text. The Centre Line Length template, which has the heading split over twolines, is an example.

    Values

    For reports without sorting or totalling Values will normally be On. For examples of the otheroptions see Sorting and Totalling.

    Subtotals and Totals

    Totals can only be produced for columns containing numeric data, and which do not havethe Subtotal option set. For more information, see Sorting and Totalling.

    2.8 Introductions and SummariesThe Page options on the menu on the New/Modify Report Template form can be used toinsert Introductions and Summaries into screen or file reports. However, they normallyinvolve using variables, which are introduced in Selective Reporting and so they aredescribed later, in File Reports.12 Series 2:8 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualSorting and Totalling3 Sorting and Totalling

    By default, the items reported on will be listed in the order that they are stored in thedatabase.

    You can specify which attributes will be used to sort the elements in the report and the typeof sorting, for example, ascending or descending numerical order. If more than one attributeis used for sorting, you can control the precedence, that is which attribute is sorted first.

    For this exercise, look at the template line_list.tmp by selecting Utilities > StandardReporting > Reports > Modify on the Main Menu.

    Note: The sample templates are all for file reports, with runtime prompts set. If you want totry the examples, send the reports to the screen and switch the prompts off (useOptions > Runtime Prompts on the New/Modify Report Template form).

    This template reports on the Pipe Name, Specification, Head Bore, Tail Bore, Head Ref andTail Ref of Branches. The template sorts the Branches in ascending order of Head Bore.

    With the Hierarchy set to the Zone PIPES, the output will look like this:Line List for WORLD PIPE PSPEC HBORE TBORE HREF TREF /50-B-9 /A3B 15.00 15 /50-B-9-B1-TEE2 =0/0 /40-B-10 /A3B 40.00 40 /40-B-10-B1-TEE1 /40-B-10-B1-TEE2 /100-B-1 /A3B 50.00 100 /P1502A-N2 =0/0 /100-B-1 /A3B 50.00 100 /P1502B-N2 /100-B-1-B1-TEE1 /50-B-9 /A3B 50.00 50 /P1501A-N2 /1101/N4 /50-B-9 /A3B 50.00 50 /50-B-9-B1-TEE4 /50-B-9-B1-TEE5 /50-B-9 /A3B 50.00 50 /P1501B-N2 /50-B-9-B1-TEE1 /40-B-10 /A3B 50.00 40 /50-B-9-B1-TEE3 =0/0 /80-A-11 /A1A 50.00 80 /80-B-14-B1 =0/0 /80-B-14 /A3B 50.00 50 /80-B-14-B1-TEE1 /80-A-11-B1-TEE1 /100-B-1 /A3B 80.00 80 /100-B-1-B1-TEE2 /100-B-1-B1-TEE3 /100-B-2 /A3B 80.00 80 /100-B-2-B1-TEE1 =71/608 /80-B-7 /A3B 80.00 80 /E1302A-S2 /D1201-N1 /100-C-12 /F1C 80.00 80 /100-C-12-B1-TEE1 /100-C-12-B1-TEE2 /80-B-14 /A3B 80.00 50 /D1201-N2 /80-A-11-B112 Series 3:1 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    /100-B-2 /A3B 100.00 100 =0/0 /150-A-3-B1 /150-A-3 /A1A 100.00 150 /100-B-2-B1 =0/0 /100-B-8 /A3B 100.00 100 /D1201-N4 /P1501B-N1 /100-B-8 /A3B 100.00 100 /100-B-8-B1-TEE1 /P1501A-N1 /100-C-12 /F1C 100.00 100 =0/0 /1301/NS2 /100-C-13 /F1C 100.00 100 /1301/NS1 =0/0 /150-B-6 /A3B 150.00 150 /1101/N5 /E1302B-S1 /150-A-57 /A1A 150.00 100 =0/0 /P1502A-N1 /150-A-57 /A1A 150.00 100 /150-A-57-B1-TEE1 /P1502B-N1

  • Standard Reporting Reference ManualSorting and Totalling /200-B-4 /A3B 200.00 200 /1101/N3 /1301/N1 /250-B-5 /A3B 200.00 250 /1301/N2 /1101/N2 /250-B-5 /A3B 200.00 250 /1301/N4 =72/615Summary: 27 Lines in Schedule

    3.1 Changing the Order of SortingChange the order of sorting to descending order of Head Bore. Select HBORE in the list onthe Modify Report Template form, and select the (Columns) Modify option button.

    On the Modify Columns form, set the Sorting option button to 9-0. When you run the report,the output will be as follows:Line List for /PIPES PIPE PSPEC HBORE TBORE HREF TREF /200-B-4 /A3B 200.00 200 /C1101-N3 /E1301-S1 /250-B-5 /A3B 200.00 250 /E1301-S2 /C1101-N2 /250-B-5 /A3B 200.00 250 /E1301-S3 =140/612 /150-B-6 /A3B 150.00 150 /C1101-N6 /E1302B-S1 /150-A-57 /A1A 150.00 100 =0/0 /P1502A-N1 /150-A-57 /A1A 150.00 100 /150-A-57-B1-TEE1 /P1502B-N1 /100-B-2 /A3B 100.00 100 /C1101-N1 /150-A-3-B1 /150-A-3 /A1A 100.00 150 /100-B-2-B1 =0/0 /100-B-8 /A3B 100.00 100 /D1201-N4 /P1501B-N1 /100-B-8 /A3B 100.00 100 /100-B-8-B1-TEE1 /P1501A-N1 /100-C-12 /F1C 100.00 100 =0/0 /E1301-T1 /100-C-13 /F1C 100.00 100 /E1301-T2 =0/0 /100-B-1 /A3B 80.00 80 /100-B-1-B1-TEE2 /100-B-1-B1-TEE3 /100-B-2 /A3B 80.00 80 /100-B-2-B1-TEE1 =139/603 /80-B-7 /A3B 80.00 80 /E1302A-S2 /D1201-N1 /100-C-12 /F1C 80.00 80 /100-C-12-B1-TEE1 /100-C-12-B1-TEE2 /80-B-14 /A3B 80.00 50 /D1201-N2 /80-A-11-B1 /100-B-1 /A3B 50.00 100 /P1502A-N2 /C1101-N4 /100-B-1 /A3B 50.00 100 /P1502B-N2 /100-B-1-B1-TEE1 /50-B-9 /A3B 50.00 50 /P1501A-N2 /C1101-N5 /50-B-9 /A3B 50.00 50 /50-B-9-B1-TEE4 /50-B-9-B1-TEE5 /50-B-9 /A3B 50.00 50 /P1501B-N2 /50-B-9-B1-TEE1 /40-B-10 /A3B 50.00 40 /50-B-9-B1-TEE3 =0/0 /80-A-11 /A1A 50.00 80 /80-B-14-B1 =0/0 /80-B-14 /A3B 50.00 50 /80-B-14-B1-TEE1 /80-A-11-B1-TEE1 /40-B-10 /A3B 40.00 40 /40-B-10-B1-TEE1 /40-B-10-B1-TEE2 /50-B-9 /A3B 15.00 15 /50-B-9-B1-TEE2 =0/0Summary: 27 Lines in Schedule

    3.2 Sorting on More than one AttributeRemember to use the Next column and Previous column option buttons on the ModifyColumns form, to move between columns.

    Keeping Sorting as 0-9 for HBORE, switch Sorting to 0-9 for TBORE. Note that thePrecedence button is now set to 2, and that the precedence is also shown by Sort 1 andSort 2 against the columns on the Modify Report Template form. Go back to the HBOREcolumn, and note that the Precedence is shown as 1. This means that the Branches will besorted first in order of Head Bore, and second in order of Tail Bore. 12 Series 3:2 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualSorting and TotallingIf you run the report now, the output will look like this; note the different order for Brancheswith HBORE 50:Line List for /PIPES PIPE PSPEC HBORE TBORE HREF TREF /200-B-4 /A3B 200.00 200 /C1101-N3 /E1301-S1 /250-B-5 /A3B 200.00 250 /E1301-S2 /C1101-N2 /250-B-5 /A3B 200.00 250 /E1301-S3 =140/612 /150-A-57 /A1A 150.00 100 =0/0 /P1502A-N1 /150-A-57 /A1A 150.00 100 /150-A-57-B1-TEE1 /P1502B-N1 /150-B-6 /A3B 150.00 150 /C1101-N6 /E1302B-S1 /100-B-2 /A3B 100.00 100 /C1101-N1 /150-A-3-B1 /100-B-8 /A3B 100.00 100 /D1201-N4 /P1501B-N1 /100-B-8 /A3B 100.00 100 /100-B-8-B1-TEE1 /P1501A-N1 /100-C-12 /F1C 100.00 100 =0/0 /E1301-T1 /100-C-13 /F1C 100.00 100 /E1301-T2 =0/0 /150-A-3 /A1A 100.00 150 /100-B-2-B1 =0/0 /80-B-14 /A3B 80.00 50 /D1201-N2 /80-A-11-B1 /100-B-1 /A3B 80.00 80 /100-B-1-B1-TEE2 /100-B-1-B1-TEE3 /100-B-2 /A3B 80.00 80 /100-B-2-B1-TEE1 =139/603 /80-B-7 /A3B 80.00 80 /E1302A-S2 /D1201-N1 /100-C-12 /F1C 80.00 80 /100-C-12-B1-TEE1 /100-C-12-B1-TEE2 /40-B-10 /A3B 50.00 40 /50-B-9-B1-TEE3 =0/0 /50-B-9 /A3B 50.00 50 /P1501A-N2 /C1101-N5 /50-B-9 /A3B 50.00 50 /50-B-9-B1-TEE4 /50-B-9-B1-TEE5 /50-B-9 /A3B 50.00 50 /P1501B-N2 /50-B-9-B1-TEE1 /80-B-14 /A3B 50.00 50 /80-B-14-B1-TEE1 /80-A-11-B1-TEE1 /80-A-11 /A1A 50.00 80 /80-B-14-B1 =0/0 /100-B-1 /A3B 50.00 100 /P1502A-N2 /C1101-N4 /100-B-1 /A3B 50.00 100 /P1502B-N2 /100-B-1-B1-TEE1 /40-B-10 /A3B 40.00 40 /40-B-10-B1-TEE1 /40-B-10-B1-TEE2 /50-B-9 /A3B 15.00 15 /50-B-9-B1-TEE2 =0/0Summary: 27 Lines in Schedule

    Change the Precedence of the TBORE column to 1, which will automatically change theprecedence of the HBORE column to 2.

    Now the output will look like this:Line List for /PIPES PIPE PSPEC HBORE TBORE HREF TREF /50-B-9 /A3B 15.00 15 /50-B-9-B1-TEE2 =0/0 /40-B-10 /A3B 50.00 40 /50-B-9-B1-TEE3 =0/0 /40-B-10 /A3B 40.00 40 /40-B-10-B1-TEE1 /40-B-10-B1-TEE2 /80-B-14 /A3B 80.00 50 /D1201-N2 /80-A-11-B1 /50-B-9 /A3B 50.00 50 /P1501A-N2 /C1101-N5 /50-B-9 /A3B 50.00 50 /50-B-9-B1-TEE4 /50-B-9-B1-TEE5 /50-B-9 /A3B 50.00 50 /P1501B-N2 /50-B-9-B1-TEE1 /80-B-14 /A3B 50.00 50 /80-B-14-B1-TEE1 /80-A-11-B1-TEE1 /100-B-1 /A3B 80.00 80 /100-B-1-B1-TEE2 /100-B-1-B1-TEE3 /100-B-2 /A3B 80.00 80 /100-B-2-B1-TEE1 =139/603 /80-B-7 /A3B 80.00 80 /E1302A-S2 /D1201-N1 /100-C-12 /F1C 80.00 80 /100-C-12-B1-TEE1 /100-C-12-B1-TEE2 /80-A-11 /A1A 50.00 80 /80-B-14-B1 =0/0 /150-A-57 /A1A 150.00 100 =0/0 /P1502A-N1 /150-A-57 /A1A 150.00 100 /150-A-57-B1-TEE1 /P1502B-N112 Series 3:3 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualSorting and Totalling /100-B-2 /A3B 100.00 100 /C1101-N1 /150-A-3-B1 /100-B-8 /A3B 100.00 100 /D1201-N4 /P1501B-N1 /100-B-8 /A3B 100.00 100 /100-B-8-B1-TEE1 /P1501A-N1 /100-C-12 /F1C 100.00 100 =0/0 /E1301-T1 /100-C-13 /F1C 100.00 100 /E1301-T2 =0/0 /100-B-1 /A3B 50.00 100 /P1502A-N2 /C1101-N4 /100-B-1 /A3B 50.00 100 /P1502B-N2 /100-B-1-B1-TEE1 /150-B-6 /A3B 150.00 150 /C1101-N6 /E1302B-S1 /150-A-3 /A1A 100.00 150 /100-B-2-B1 =0/0 /200-B-4 /A3B 200.00 200 /C1101-N3 /E1301-S1 /250-B-5 /A3B 200.00 250 /E1301-S2 /C1101-N2 /250-B-5 /A3B 200.00 250 /E1301-S3 =140/612Summary: 27 Lines in Schedule

    3.3 TotallingTo see the effect of totalling, use the template centre_line.tmp and set the hierarchy to 100-B-1 and 100-B-2.

    The template as supplied will report on the Branches, giving the Pipe name and the PipeSpecification, sorted on descending order of Head Bore, and the Centre Line Length, asfollows:

    Centre Line Length Report for /100-B-1 /100-B-2 PIPE NAME PSPEC HEAD BORE CENTRE LINE LENGTH /100-B-2 /100-B-2-B1 /A3B 100.00 7610.35 /100-B-1 /100-B-1-B2 /A3B 80.00 2455.19 /100-B-2 /100-B-2-B2 /A3B 80.00 2526.65 /100-B-1 /100-B-1-B1 /A3B 50.00 39524.56 /100-B-1 /100-B-1-B3 /A3B 50.00 3119.80Now switch on the Totalling option button on the Layout for Column form for the CentreLine Length column, and the report will appear like this:

    Centre Line Length Report for /100-B-1 /100-B-2 PIPE NAME PSPEC HEAD BORE CENTRE LINE LENGTH /100-B-2 /100-B-2-B1 /A3B 100.00 7610.35 /100-B-1 /100-B-1-B2 /A3B 80.00 2455.19 /100-B-2 /100-B-2-B2 /A3B 80.00 2526.65 /100-B-1 /100-B-1-B1 /A3B 50.00 39524.56 /100-B-1 /100-B-1-B3 /A3B 50.00 3119.80 ===========

    55236.56

    3.4 SubtotallingThe Subtotals option on the Layout for Column form can be Off or set to the number of asorted column. Subtotals can only be produced for columns containing numeric data.12 Series 3:4 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualSorting and TotallingSet Subtotalling on for the Centre Line Length column, and the report will look like this:Centre Line Length Report for /100-B-1 /100-B-2 PIPE NAME PSPEC HEAD BORE CENTRE LINE LENGTH /100-B-2 /100-B-2-B1 /A3B 100.00 7860.35 -----------

    7860.35 /100-B-1 /100-B-1-B2 /A3B 80.00 2455.19 /100-B-2 /100-B-2-B2 /A3B 80.00 2526.65 -----------

    4981.84 /100-B-1 /100-B-1-B1 /A3B 50.00 39524.55 /100-B-1 /100-B-1-B3 /A3B 50.00 3119.80 -----------

    42644.36Subtotalling with Totalling will produce the following report: PIPE NAME PSPEC HEAD BORE CENTRE LINE LENGTH /100-B-2 /100-B-2-B1 /A3B 100.00 7610.35 -----------

    7610.35 /100-B-1 /100-B-1-B2 /A3B 80.00 2455.19 /100-B-2 /100-B-2-B2 /A3B 80.00 2526.65 -----------

    4981.84 /100-B-1 /100-B-1-B1 /A3B 50.00 39524.56 /100-B-1 /100-B-1-B3 /A3B 50.00 3119.80 -----------

    42644.36 ===========

    55236.56

    Subtotalling is closely related to the Values option on the Layout for Column form. Theoptions are:

    OnThe result of the expression (entered in the Expression text box on the CreatingColumn form) will be shown for every line in the report. This is the normal setting forreports without sorting or totalling.

    OffNo values will be shown.

    1stIf this column is sorted, this option can be used to display only the first occurrence of aparticular expression result.

    SubA value will only be output in this column when a subtotal appears in one of the othercolumns.

    3.4.1 Showing only the First Occurrence of ValuesFor a sorted column, you can output only the first occurrence of a value. For example, setthe Values to 1st for the HBORE column:12 Series 3:5 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    Centre Line Length Report for /100-B-1 /100-B-2

  • Standard Reporting Reference ManualSorting and TotallingPIPE NAME PSPEC HEAD BORE CENTRE LINE LENGTH /100-B-2 /100-B-2-B1 /A3B 100.00 7610.35 -----------

    7610.35 /100-B-1 /100-B-1-B2 /A3B 80.00 2455.19 /100-B-2 /100-B-2-B2 /A3B 2526.65 -----------

    4981.84 /100-B-1 /100-B-1-B1 /A3B 50.00 39524.56 /100-B-1 /100-B-1-B3 /A3B 3119.80 -----------

    42644.36 ===========

    55236.56You can display each value for a sorted column next to the corresponding subtotal value.

    Set the Values option for HBORE (which must be sorted) to Sub. Set the Centre LineLength Subtotals to 4, that is, show subtotals for each value in column 4 (HBORE).Centre Line Length Report for /100-B-1 /100-B-2 PIPE NAME PSPEC HEAD BORE CENTRE LINE LENGTH /100-B-2 /100-B-2-B1 /A3B 7610.35 -----------

    100.00 7610.35 /100-B-1 /100-B-1-B2 /A3B 2455.19 /100-B-2 /100-B-2-B2 /A3B 2526.65 -----------

    80.00 4981.84 /100-B-1 /100-B-1-B1 /A3B 39524.56 /100-B-1 /100-B-1-B3 /A3B 3119.80 -----------

    50.00 42644.36 ===========

    55236.56

    3.5 QuantityThe template pipe_mto.tmp outputs a report which shows the quantity of each type of itemwith a given Detail Text. Hence the important relationship is between Column 2, Detail Text,and Column 5, Quantity.

    Values are set to Sub for all the columns except Detail Text, where the 1st occurrenceof each value is given.

    Subtotals is set to 2 for the Quantity column, which means that items with the same12 Series 3:6 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    Detail Text are totalled.

  • Standard Reporting Reference ManualSorting and TotallingThe elements are first sorted alphabetically on type. The Material Text, and in the case ofTUBI elements, the length, is also given.

    The columns are set up as follows:

    TYPESort Aa to zZ, Precedence 1.Values set to Sub, Subtotals Off and Total Off.

    DTXRSort Aa to zZ, Precedence 2.Values set to 1st, Subtotals Off and Total Off.

    MTXXNo sorting.Values set to Sub, Subtotals Off and Total Off.

    ITLENo sorting.Values set to Sub, Subtotals set to 2 and Total Off.

    QUANTITYNo sorting.Values set to Sub, Subtotals set to 2 and Total Off.

    Pipework MTO for /100-B-1 /100-B-2 /150-A-3 Type Detail Material Tube Quantity Text Text ATTA unset unset 5 ELBO ELBOW LR ANSI B16.9 BW ASTM A234-WPB 17 FLAN ANSI.B16.36.WN.ORIFACE.FLANGE.#300.RF ASTM A105 2 FLAN FLANGE WN ANSI B16.5 #150.RF ASTM A105 2 FLAN FLANGE WN ANSI B16.5 #300.RF ASTM A105 22 GASK GASKET RF 1.5MM ANSI B16.5 #150 SS & ASB 2 GASK GASKET RF 1.5MM ANSI B16.5 #300 SS & ASB 26 INST ORIFICE PLATE 3MM THK #300 unset 1 REDU NIPPLE CONC SWAGED BLE/PSE ASTM A234-WPB 2 REDU REDU CONC ANSI B16.9 BW ASTM A234-WPB 3 REDU REDU ECC ANSI B16.9 BW ASTM A234-WPB 2 TEE TEE ANSI B16.9 BW ASTM A234-WPB 5 TUBI PIPE SCH40 ANSI B36.10 API 5L-B 13410.56 51 VALV CTRL VALVE FISHER TYPE 657-ED #300.RF ASTM A216-WCB 2 VALV MISSION K WAFER CHECK VALVE #300 RF ASTM A216-WCB 2 VALV VALVE GATE ANSI B16.10 #150.RF ASTM A216-WCB 1 VALV VALVE GATE ANSI B16.10 #300.RF ASTM A216-WCB 5 VALV VALVE GLOBE ANSI B16.10 #300.RF ASTM A216-WCB 212 Series 3:7 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualSorting and Totalling12 Series 3:8 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualSelective Reporting4 Selective Reporting

    The With option on the New/Modify Report Template form allows you to restrict the report toelements of the given type whose properties satisfy given conditions. The restriction isdefined by an Expression, which is entered in the text box, full information about usingexpressions is given in the Database Management Reference Manual.

    The expressions used in selective reporting will be a combination of PDMS attributes orpseudo-attributes, logical operators and values.

    For example, if you are reporting on Elbows (that is, you have entered ELBO in the Typetext box), you can restrict the report to Elbows with ABORE greater than 50 by entering theexpression:

    ABORE GT 50

    where ABORE is the PDMS attribute, GT is an operator meaning greater than, and 50 is thevalue. The operators you can use are:

    You can specify more than one condition using the operators AND, OR and NOT. Forexample, to report on Elbows with ABORE greater than 50 but less than 100 enter:

    (ABORE GT 50) AND (ABORE LT 100)

    EQ equal to

    NE not equal to

    GT greater than

    GE greater than or equal to

    LE less than

    LT less than or equal to12 Series 4:1 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualSelective Reporting12 Series 4:2 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualFile Reports5 File Reports

    This chapter describes how to set up templates for reports that will be output to a file. Thecontent of the reports is defined in the same way as for screen reports, and the layout of thecolumns is also controlled in the same way, but there are additional options which controlheaders, footers and headings and other information which can be added to file reports.

    Set Destination to File, and give a filename in the text box. The file will be stored in thedirectory PDMSUSER/REPORTS.

    You should also specify what will happen if the file exists. The options are Append

    If the file exists, output will be appended to it. New

    If the file exists, you will be prompted to confirm that you want to overwrite the file. Overwrite

    If the file exists, it will be overwritten with no warning.

    5.1 Page Information OptionsThe options under Page Information on the menu at the top of the New/Modify ReportTemplate form allow you to add information which is not specified in the body of the report.The options are:

    Set a Header Set a Footer Insert an Introduction into the Report Insert a Summary into the Report Set the Page Length

    Each option displays a form with a text pane. You type the information you want in the textpane. Each line of information is entered as an expression, full information about usingexpressions is given in the Database Management Reference Manual.12 Series 5:1 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualFile Reports5.2 Report VariablesThere are several special variables used to insert information such as date and pagenumbers in a report. The variables are designed to be used outside the body of the report,that is, in the Introduction, Summary, Header or Footer.

    These variables must be used together with the operators which control late evaluation ofvariables.

    5.2.1 Late Evaluation of VariablesVariables stored in file report templates must be used with one of the late evaluationoperators described below. Without these operators, the variables would be evaluated assoon as the form containing them is actioned using the OK or Apply button, instead of beingstored as variables in the template and evaluated when the template is run.

    The three operators are: VTEXT, used for the late evaluation of variables when a text result is required. VLOGICAL, used for late evaluation when a logical result is required. VVALUE, used for late evaluation when a numeric result is required.

    Examples of using the report variables with the late evaluation operators are given in thefollowing sections.

    5.2.2 Points to NoteA summary of the information you are most likely to need in setting up the page information

    !pageno Inserts page numbers.

    !filename Inserts the filename to which the report will be sent.

    !seltype Inserts the contents of the Type text box.

    !selhierarchy Inserts the contents of the Hierarchy text box.

    !selvolspec Inserts Off, Completely within or Partially within, as specified onthe Hierarchy form.

    !selvolume Inserts the coordinates defining the volume, as specified on theHierarchy form.

    !selfrom Inserts MDB, Drawlist or Obstruction List, as specified on theHierarchy form.

    !criteria Inserts the complete selection criteria on which the report is based.

    !selsize Inserts the number of elements that match the criteria.

    !selno Inserts the sequence number of an element in a selection. Thisvariable should be used with the Sort option on the CreatingColumn form set to Fix for the column.

    !date Inserts today's date.

    !time Inserts the time.12 Series 5:2 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    is given below.

  • Standard Reporting Reference ManualFile Reports Text must be entered in quotes. For example:

    'Page number' You can include any PML variables in the expressions. Variables must be preceded by one of the functions vtext, vval or vlog, which ensure

    late evaluation of the variables. For example, to show the page number on every pageof the report, enter the following expression in the header or footer:

    vtext( !pageno ) If you want to combine text and variables in the same expression (that is, on the same

    line, you must combine them using the text operator +. For example, if you want tonumber the pages with the format Page 1, Page 2 and so on, you should enter thefollowing expression in the header or footer:

    'Page ' + vtext ( !pageno )

    5.3 Headers, Footers and Page LengthsInformation in Headers and Footers will appear at the top or bottom of every pages of a filereport. Headers and footers are not available for screen reports.

    Note: You must have a page length of between 5 and 500 lines set before headers andfooters will be displayed in file reports.

    The Page Length form, Page Header form and Page Footer form are displayed by selectingthe options under Page Info from the menu on the New Report Template form.

    5.4 Introduction and SummariesBoth file reports and screen reports can have an Introduction and Summary. You can insertwhatever text and variables you want.

    5.5 ExamplesThe following examples are mainly taken from the templates supplied with the product.

    To insert a page number containing the text Page number, followed by the page number,use the !pageno variable:

    'Page No. ' + vtext (!pageno)

    To insert the users name in the form of the text User Name: followed by the name, usethe PDMS global variable !!user:

    'User name: ' + vtext(!!user)

    To insert the date and time, use the report variables !date and !time:

    'Date: ' + vtext(!date) + ' ' + vtext(!time)

    To insert a blank line, use:

    ''

    To insert the hierarchy reported on, use:12 Series 5:3 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualFile Reports'Nozzle Schedule for ' + vtext(!selhierarchy)

    To insert the number of elements reported on, use, for example:

    'Summary: ' + vtext(!selsize) + ' Nozzles in Schedule'12 Series 5:4 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualAdditional Information6 Additional Information

    6.1 Running Reports in Batch ModeReport templates are PDMS macros, which can be run in batch mode by giving thecommand $M/template-name. For more information about batch mode, see the MONITORReference Manual.

    Note: Report templates for batch mode must not have any runtime prompts set.

    6.2 System Command Option The System Command text box on the New/Modify Report Template form allows you togive a system command that will be run when the report has been completed.

    For example, you could use this option to send the report output to a printer, or to run amacro to process the report. The command is entered as an expression full informationabout expressions, is given in the Database Management Reference Manual.

    6.3 Report Output FormatsThe Report Format form will be displayed when you select Options > Other Formats onthe menu on the New/Modify Report Template form. It allows you to output a report in CSV(Comma Separated Variable) format, which can be read into a spreadsheet.

    You can specify the field separator and text delimiter. Values in the report are recognised astext if the Units option on the Creating Column form is set to Off.12 Series 6:1 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualAdditional Information12 Series 6:2 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

  • Standard Reporting Reference ManualIndex

    AAdding and moving columns . . . . . . . . . . 2:3Adding elements . . . . . . . . . . . . . . . . . . . 2:5

    BBatch mode . . . . . . . . . . . . . . . . . . . . . . . 6:1

    CColumn Layout . . . . . . . . . . . . . . . . . . . . 2:2Column width . . . . . . . . . . . . . . . . . . . . . 2:6Columns . . . . . . . . . . . . . . . . . . . . . . . . . 2:1

    adding . . . . . . . . . . . . . . . . . . . . . . . . 2:3

    of values . . . . . . . . . . . . . . . . . . . . . 3:5Footers . . . . . . . . . . . . . . . . . . . . . . . 5:1, 5:3Formats

    output . . . . . . . . . . . . . . . . . . . . . . . . 6:1Fraction . . . . . . . . . . . . . . . . . . . . . . . . . 2:7

    HHeaders . . . . . . . . . . . . . . . . . . . . . . 5:1, 5:3Headings . . . . . . . . . . . . . . . . . . . . . . . . 2:8Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . 2:5

    adding elements . . . . . . . . . . . . . . . 2:5

    I12 SeriesIndex page 1 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    moving . . . . . . . . . . . . . . . . . . . . . . . 2:3Creating a report template . . . . . . . . . . . 2:1CSV format . . . . . . . . . . . . . . . . . . . . . . . 6:1

    DDecimal . . . . . . . . . . . . . . . . . . . . . . . . . . 2:7Deleting a template . . . . . . . . . . . . . . . . . 2:5Destination . . . . . . . . . . . . . . . . . . . . . . . 5:1Drawlist

    adding elements from . . . . . . . . . . . . 2:6

    EExpressions . . . . . . . . . . . . . . . . . . . . . . 4:1

    FFile reports . . . . . . . . . . . . . . . . . . . 2:1, 5:1First occurrence

    Imperial units style . . . . . . . . . . . . . . . . . 2:7Introductions . . . . . . . . . . . . . . . . . . . . . . 2:8Introductions in reports . . . . . . . . . . . 5:1, 5:3

    JJustification . . . . . . . . . . . . . . . . . . . . . . 2:6

    LLeading zeros . . . . . . . . . . . . . . . . . . . . . 2:7

    NNew Report Template form . . . . . . . . . . 2:1Numeric Display . . . . . . . . . . . . . . . . . . . 2:7

    OObstruction list

  • Standard Reporting Reference Manualadding elements from . . . . . . . . . . . . 2:6Output formats . . . . . . . . . . . . . . . . . . . . 6:1

    PPage information . . . . . . . . . . . . . . . . . . . 5:1Page length . . . . . . . . . . . . . . . . . . . . . . . 5:1page length . . . . . . . . . . . . . . . . . . . . . . . 5:3Precedence . . . . . . . . . . . . . . . . . . . . . . . 3:2

    QQuantity . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6

    RRemainder . . . . . . . . . . . . . . . . . . . . . . . 2:7Report Details form . . . . . . . . . . . . . . . . . 1:3Report variables . . . . . . . . . . . . . . . . . . . 5:2Reports directory . . . . . . . . . . . . . . . . . . . 1:1Running a report . . . . . . . . . . . . . . . . . . . 1:3Runtime Prompts . . . . . . . . . . . . . . . . . . 3:1Runtime prompts . . . . . . . . . . . . . . . . . . . 2:4

    SSample report templates . . . . . . . . . . . . . 1:1Saving a template . . . . . . . . . . . . . . . . . . 2:4Screen reports . . . . . . . . . . . . . . . . . . . . 2:1Selective reporting . . . . . . . . . . . . . . . . . 4:1Sorting . . . . . . . . . . . . . . . . . . . . 2:6, 2:8, 3:1Spaces before column . . . . . . . . . . . . . . 2:6Style (Imperial units) . . . . . . . . . . . . . . . . 2:7Subtotalling . . . . . . . . . . . . . . . . . . . . . . . 3:4Subtotals . . . . . . . . . . . . . . . . . . . . . . . . . 2:8Summaries . . . . . . . . . . . . . . . . . . . . . . . 2:8Summaries in reports . . . . . . . . . . . 5:1, 5:3System Command . . . . . . . . . . . . . . . . . 6:1

    TTemplates

    deleting . . . . . . . . . . . . . . . . . . . . . . . 2:5saving . . . . . . . . . . . . . . . . . . . . . . . . 2:4

    Text Display . . . . . . . . . . . . . . . . . . . . . . 2:8Totalling . . . . . . . . . . . . . . . . . . . . . 3:1, 3:4Totals . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:8

    UUnset text . . . . . . . . . . . . . . . . . . . . . . . . 2:8

    VValues . . . . . . . . . . . . . . . . . . . . . . . . . . 2:8

    in subtotalling . . . . . . . . . . . . . . . . . . 3:5Variables

    late evaluation . . . . . . . . . . . . . . . . . 5:2Volumes

    adding elements from . . . . . . . . . . . 2:5

    WWith option . . . . . . . . . . . . . . . . . . . . . . . 4:112 SeriesIndex page 2 Copyright 1974 to current year.AVEVA Solutions Limited and its subsidiaries. All rights reserved.

    Standard Reporting1 Introduction to Reports1.1 Sample Report Templates1.2 Before You Start1.3 Starting to Use Reports1.4 How to Use This Manual1.5 Running a Report from a Saved Template

    2 Creating and Running a Simple Report2.1 Creating a Simple Nozzle Schedule2.1.1 Destination2.1.2 Selection2.1.3 Columns2.1.4 Running the Report

    2.2 Column Layout2.3 Adding and Moving Columns2.4 Runtime Prompts2.5 Saving and Deleting Templates2.5.1 Saving a Template2.5.2 Deleting a Template

    2.6 Reporting on Different Parts of the Database2.6.1 Adding Elements using the Members List2.6.2 Adding Elements in a Given Volume2.6.3 From

    2.7 More Column Layout Options2.7.1 Layout2.7.2 Numeric Display2.7.3 Text Display

    2.8 Introductions and Summaries

    3 Sorting and Totalling3.1 Changing the Order of Sorting3.2 Sorting on More than one Attribute3.3 Totalling3.4 Subtotalling3.4.1 Showing only the First Occurrence of Values

    3.5 Quantity

    4 Selective Reporting5 File Reports5.1 Page Information Options5.2 Report Variables5.2.1 Late Evaluation of Variables5.2.2 Points to Note

    5.3 Headers, Footers and Page Lengths5.4 Introduction and Summaries5.5 Examples

    6 Additional Information6.1 Running Reports in Batch Mode6.2 System Command Option6.3 Report Output Formats