M12 Reports

7/30/2019 M12 Reports

1/23

Version 11.5

Module 12

Reports

Training Manual

7/30/2019 M12 Reports

2/23

PLEASE NOTE:

AVEVA has a policy of continuing product development: therefore, the information contained

in this document may be subject to change without notice.AVEVA MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS DOCUMENT,INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

While every effort has been made to verify the accuracy of this document, AVEVA shall notbe liable for errors contained herein or direct, indirect, special, incidental or consequentialdamages in connection with the furnishing, performance or use of this material.

This manual provides documentation relating to products that you may not have access to orwhich may not be licensed to you. For further information on that products are licensed toyou please refer to your licence conditions.

Copyright 2003 AVEVA Limited

All rights reserved. No part of this document may be reproduced, stored in a retrieval systemor transmitted, in any form or by any means, electronic, mechanical, photocopying, recordingor otherwise, without prior written permission of AVEVA.The software programs described in this document are confidential information andproprietary products of AVEVA Ltd or its licensors.

Visit our website at http://www.aveva.com

AVEVA Ltd, High Cross, Madingley Road, Cambridge CB3 0HB, UK
http://www.aveva.com/http://www.aveva.com/

7/30/2019 M12 Reports

3/23

Contents

Session 1 .............................................................. 1-1Introduction .................................................................................................. 1-1

Objectives............................................................................................................. 1-1Must Know Points................................................................................................. 1-1Generating Reports .............................................................................................. 1-2Quick Reports ....................................................................................................... 1-2

Report ................................................................................................................... 1-4

Starting to Use Reports......................................................................................... 1-5Running a Report from a Saved Template............................................................ 1-5Creating a New Template ..................................................................................... 1-9Selection............................................................................................................. 1-10New Columns ................................................................................................... 1-111Modify Columns.................................................................................................. 1-13Moving Columns ................................................................................................. 1-14Delete Columns .................................................................................................. 1-15System Command .............................................................................................. 1-15Hierarchy ............................................................................................................ 1-15

New Reports Template ....................................................................................... 1-17Exercise.............................................................................................................. 1-19

Module 12 Reports Contents-i

7/30/2019 M12 Reports

4/23

7/30/2019 M12 Reports

5/23

Session 1

Introduction

Objectives

At the end of this session you will be able to:

Generate Reports from VANTAGE PDMS

Must Know Points

It is important to have a sound knowledge of VANTAGE PDMS before undertaking thismodule.

Module 12 Reports 1-1

7/30/2019 M12 Reports

6/23

Introduction

Generating Reports

The PDMS database stores a large amount of 3D engineering information about your plant

design. You can extract this data both graphically, in the form of drawings, or in text form, by

producing reports. This session describes the principles and practice of producing reports.

You can produce a report by running a report template (REPORTS) or one based on your

own selection criteria (QUICK REPORTS) from within the Design module.

Quick Reports

The Create Quick Report form is displayed when you select Utilities > Quick Reports from

the main bar menu. This form allows you to create reports with only basic formatting and this

template cannot be saved.

You can enter a filename for the output report. If you just want to see the reporton the screen, leave the File text box blank, or press the Term button, in whichcase any filename given will be ignored. IfTerm is selected, a window will be displayed toshow the results or the report, unless there is already a form currently displayed to which theresults may be written to.

Quick Report form

1-2 Module 12 Reports

7/30/2019 M12 Reports

7/23

Introduction

Output from above example

The options performed by the buttons on the quick Reports form are as follows:

Types:PDMS element types can be specified.For examples: Bran Mem valve gask flan

With:This option is a way of narrowing down the report. Enter an PDMS expression, For example:abore gt 300 AND pspec of owner neq /A3B

Columns:These are the PDMS attributes to be output in the report. The attributes you specify will beused as headings to the column. You can enter expressions, enclosed in round brakets. Thefollowing 1st example outputs the type, name, and the first three characters of the owner'sname.For example: type name (substr(name of owner, 1, 3))Other examples: name owner hpos tpos

Hierarchy:Enter the element or elements at the top of the hierarchy that you want to report on.Because you can give a list of elements, you must enter the slash character before eachname, except for WORLD.For example: /200-B-4 /250-B-5

Run the Report:

Click this button when ready to generate the report.


7/30/2019 M12 Reports

8/23

Introduction

Report

The template specifies what the report will contain, whether it will be sent to the screen or afile, and how it will be laid out.

There is a directory of example reports supplied with the product. This can be found in the

directory $PDMSUI/REPORTS. Under this directory is a TEMPLATES directory. This

contains sample templates which can be used to generate standard reports. The templates

are PDMS macros. The best way to see how they are defined is to select Utilities> Reports

> Modify from the main menu, and look at the settings for the fields on the forms displayed.

Templates have the file extension .tmp, and the corresponding reports have a file extension

.rep.

Most of the examples are based on the sample project supplied with the product.

The sample templates produce the following types of report:

nozz_sched

This is a Nozzle schedule , which lists all Nozzles sorted by name, and shows the P1 bore,

connection type and direction, and the position of each Nozzle.

line_list

This report will list Branches, sorted by the name of the Pipe which owns them. The Pipe

Specification, the Head and Tail bores and the Head and Tail references are given.pipe_mto

This report shows material information for all Branch members, sorted by type, Detail Text

and Material Text. The Tube 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 an Imperial version of this report

template.

tube_gradient

This report gives the gradient of each tubing component.

catalogue_param

This report lists Branch members, with their CATREFs and the parameters of the CATREFs.

catalogue_ptgmref


7/30/2019 M12 Reports

9/23

Introduction

This report lists Branch members, with their CATREFs followed by the PTREFs and

GMREFs of the CATREFs.

tube_area_vol

This report uses derived properties to report on the area and volume of tubing.

Starting to Use Reports

You will usually have a library of report templates set up for you, but you can produce and

run a report template by selecting Reports > Create, filling in the New Report Template

form to specify what you want to report on and then pressing Apply on the form, which will

run the report.

Running a Report from a Saved Template

You may already be familiar with creating a report by running a saved report template. If not,

try this introductory exercise. Select the following

Utilities > Reports > Run

You will see a File Browser, showing the contents of the directory REPORTS.

Select the TEMPLATES directory. Now choose the report template required eg.

pipe_mto.tmp and press the OK button. The Report Details form will be displayed. On thisform the user will need to complete all fields. The information requested by this form is

dependent on the settings of the Runtime Prompts form, defined during the template

creation.


7/30/2019 M12 Reports

10/23

Introduction

The information required by this form is totally dependent on what has been defined within

the Template. We will look at what other questions could be asked by this form later under

Create. In the above case the following fields should be completed.


7/30/2019 M12 Reports

11/23

Introduction

Filename:

If you specify a filename, the report will be sent to the given file in the current directory. If you

leave this field empty, the report will be sent to the screen

Hierarchy:

Here you should specify the elements where report should start its searches. The report will

be produced for all these elements and elements owned by them.

Types:Here you should state all element Types that are to be reported on. The report will beproduced for all the elements given.

With:Defines the criteria that must match the elements before they will be reported on. This issometimes referred to as a filter but works in the same way as the other occurrences in

PDMS.


7/30/2019 M12 Reports

12/23

Introduction

Volume:Allows the setting of Limits. The report may be generated on elements that are Completely

or Partially within the limits.

From:Allows you to specify where the search will take place. The Default is MDB


7/30/2019 M12 Reports

13/23

Introduction

Creating a New Template

To create a new template we need to select the following options from the top bar menu.This is true for all graphical modules and applications.

Utilities > Reports > Create

This will cause the New Template form to be displayed. It is from this form that all the details

associated with the creation of a standard report template will be defined.

The New Report Template form, shown below, covers several important areas which need

to be completed even for a simple template. These are Destination, Selection and

Columns.


7/30/2019 M12 Reports

14/23

Introduction

Destination

Destination allows you to specify whether the report is output to Screen or to a File. This is

achieved by the selection of the Screen button. On will write the report to any commands

type window and Offwill send the report to the filename specified by the Filename text

field.

To send the report to a file you must select one of the buttons located under the File on the

form. All these buttons are mutually exclusive. As stated before, the Screen option will send

the report to a commands type window, the others will create a file containing the report.

Selection of the New button will mean that a new file of the name defined in the Filename

text field will be created. This means that if the file already exists then you will be given anerror message accordingly. Overwrite will create a new file if one doesnt exist or will

overwrite the contents of the file if it does. Lastly is the Append button. This will add your

report to the end of the contents of the file defined by the Filename text field.

Selection

The Selection options allow you to specify the type of item you want to report on, along withthe level in the database hierarchy below which the selection will be made and any particularselection criteria you may have..

The text field Type(s) allows you to define the element Gtypes that you wish to report on.

With text field allows for the defining of selection criteria, thus a more selective form ofreporting can be achieved. For example if we were reporting on branches we might chooseto only report on branch that had theirPspec set to/A3B-TRA.

The Hierarchy field is simply used to define the start point for the report search. Thiseliminates checks to elements above the start point in the hierarchy so reducing the timetaken.


7/30/2019 M12 Reports

15/23

Introduction

New Columns

Every report consists of a number of columns. The next stage is to define your columns by

their content. To create a new column select the New button to the right of the Columns.

The selection of this will cause the Creating Column form to be displayed.

Creating Column form

The Expression text field defines the contents of the column. You can enter a PDMS

attribute or pseudo-attribute here.

The Sorting button will allow you to choose one of the methods for listing the column

contents. In the above picture the sorting has been defined to list alphabetically. The case of

the letters is also taken into account.

The setting of sorting criteria will cause the Precedence button to be set. Each time youcreate a new column and set its sorting criteria it will be given a Precedence number. This

determines the order in which the sorting is carried out.

By selection of the Units button you can select one of the units option, when appropriate.

The Column Layout button will cause the Layout for Column xx form to be displayed.


7/30/2019 M12 Reports

16/23

Introduction

Layout for Column xx form

Spaces before column is the number of spaces between the end of the previous column

and the start of the current column. The effect will be affected by the Justification. The

Column width

is the number allowed for the column. If you do not give a value, the width of the widest entry

will be used. The Justification can be set to Left, Centre orRight.

The Numeric Display allows you to define if you wish to use Decimal orFraction in your

column output. These two buttons are again mutually exclusive. Depending on the selection

you can enter the number ofDecimal Places to be used or the Denominator. Note that the

Denominatorwill be reduced if possible.

The Style button only affects how feet and inches are displayed. Leading Zeroes can be

On orOff.

Using the Text Display options you can specify the characters used to specify Unset text.

In this field you can define the text string that will be displayed if the item to reported on is

Unset.


7/30/2019 M12 Reports

17/23

Introduction

The Headings can be set as On, OfforPage. The On option (default) will display the

expression used as the column heading. Offwill show no column headings and Page is only

used for file reports where the special page details have been set via the Page option on top

of the New Report Template form.

Heading Text can be set to:

Expression Text: This will use the expression entered in the Expression text field on the

Creating Column form.

Default: Will use the full PDMS attribute name if possible.

Custom: You can enter your own text for the column heading in the text area. You can

insert several lines of text.

Values can be selected from the form as On, Off, 1st orSub. On will give the result of the

expression for every element that passes the selection criteria. Offno values will be shown.

This can be used for reports which give only subtotals or totals. 1st If this is sorted, this

option can be used to display only the first occurrence of the result of a particular

expression. Sub will only output when a subtotal appears in one of the other columns.

Subtotals can only be produced for columns containing numeric data.

Totalling can only be produced for columns containing numeric data.

The last options on the Creating Column form are the two buttons below Column Layout.

Selection of either the Previous Column orNext Column buttons will cause the column

that you are currently defining to be added to the New Reports Template form in the area

under the columns buttons. The selection ofPrevious Column orNext Column is

dependent totally on if you wish the new column to be before or after the currently

highlighted item. The form will also be retained ready for your next column definition. If you

select the OK button your column definition will be entered after the current item, and the

form will be closed.

Modify Columns

The Modify button will call the Modifying Column form for the currently highlighted. This

will be the same as the form displayed by the New button. The operation of the Previous

Column orNext Column will be as before. The OK button will close the form and update

the New Report Template form.

Please note the column number being modified will be shown as part of the form name.


7/30/2019 M12 Reports

18/23

Introduction

Modifying Column

Moving Columns

If you have created your column in the wrong order or if you wish to change the order, this is

achieved by the selection of the Move button on the New Reports Template form. This will

display the Move Column form.

Move Column form

The number of the currently highlighted column will be displayed next to the From. You can

now select any of the column position which are displayed by the To button. Once the new

column position is selected press the OK button. The Order shown in the column area of the

New Reports Template form will now be modified.


7/30/2019 M12 Reports

19/23

Introduction

Delete Columns

To delete a column, select the column to be deleted on the New Reports Template form.

Once highlighted select the Delete button. You will now be asked to confirm that you want to

delete this column.

Delete Confirmation Form

System Command

At the bottom of the New Reports Template form is the text field marked System

Command. This text field allows you to give a system command that will be run when the

report has been completed. For example you might wish to direct it to your printer via your

print command eg. lpr (vtext(!filename))

Hierarchy

This button will display the Hierarchy form. This form is used to specify which part of the

hierarchy you want to report on. The information entered into this form will be used to

populate the Hierarchy field on the New reports Template form.


7/30/2019 M12 Reports

20/23

Introduction

Hierarchy Form

The Volume button allows you to specify if only elements that are Completely within or

Partially within the given volume are to be reported on. Selection of either of the above

options will cause the Report Volume form to be displayed. This form works in the same

way as the other volume area forms used within Design and Draft.

Report Volume Form


7/30/2019 M12 Reports

21/23

Introduction

When you define the volume to use, the default will take the elements from the current MDB.

You may, by using the From options, choose to obtain the elements from your current

Drawlist orObstruction list instead.

New Reports Template

Returning to the New Reports Template there are the bar menu options still to be

explained. These are

Bar Menu Option from the REPORTS Template form

File:Allows you to save your current definition to the filename which was selected from the

file browser or to enter a new filename for it to be stored as. It is advised that templates are

given the extension .tmp. It is also advised that you have a sample report to show users the

type of report format they can expect from this template. Sample reports are given an

extension of.rep.

Page Info: This is used to set up page information such as Header, Footer, Introduction,

Summary orPage Length. Please note that any of these options are only displayed onreports that are sent to file and not if sent directly to the command line window..

To create a header select the Headeroption from Page Info. This will display the Header

form.

Header Form


7/30/2019 M12 Reports

22/23

Introduction

To define yourHeaderenter the required text or PML expressions into the text area of the

form and select OK.

A Footercan be created in exactly the same way as the Header.

The Introduction option will display a large text window and is used as before. Please note

that in this case the text entered will only be displayed at the start of the report.

The Summary option will display a large text window and is used as before. Please note

that in this case the text entered will only be displayed at the end of the report.

The Page Length option allows the definition of the number of lines that will constitute the

page length. This number must be between 5 and 500.

Page Length Form

Options: This has two choices, Runtime Prompts and Report Format.

The Runtime Prompts option will display the Runtime Prompts form. This form is used to

define what information the user will be asked before the report may be run.

Runtime Prompts Form


7/30/2019 M12 Reports

23/23

Introduction

The buttons selected on this form will be added to a prompts displayed on the Reports

Details form which the user must complete to be able to complete the report. These form will

contain any definitions that have been given within the template or left blank.

Selection ofReport Format will cause the Reports Format form to be displayed.

Report Format Form

FormatThis allows you to choose either the Normal orCSV options. The Normal option will

produce a report in the standard PDMS reports format

However, by setting the option to CSV (Comma Separated Variable) you will produce your

report in a format that can be read into a spreadsheet package. You can specify the field

separator and text delimiter. Values shown in the report are recognised as text only if the

Units option on the Creating Column form is set to Off.

Exercise

1. Run the report nozz_sched and line_list to show the type of output created.

2. Create a report to list all the pipes with spec A1A. Create columns to display Name,Pspec, Hbore, and Tbore.

3. Create a line list report as shown overleaf, experiment with the sorting facility and

notice the way it changes the output.

M12 Reports

Documents

Transcript of M12 Reports