Professional Documents
Culture Documents
Reports Training Manual: Vantage Training Vantage Training Vantage Training Vantage Training
Reports Training Manual: Vantage Training Vantage Training Vantage Training Vantage Training
Revision Log
Date Page(s) Revision Description of Revision Release
Updates Updates to this manual will be issued as replacement pages and a new Update History Sheet complete with instructions on which pages to remove and destroy, and where to insert the new sheets. Please ensure that you have received all the updates shown on the History Sheet. All updates are highlighted by a revision code marker, which appears to the left of new material. Suggestion/Problems If you have a suggestion about this manual or the system to which it refers please report it to the training department at Fax +44 (0)1223 556669 Email training.uk@aveva.com This manual provides documentation relating to products to which you may not have access or which may not be licensed to you. For further information on which products are licensed to you please refer to your licence conditions. Copyright 2006 AVEVA Solutions All rights reserved. No part of this publication may be reproduced, stored in a retrieval system or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without prior written permission of AVEVA The software programs described in this document are confidential information and proprietary products of AVEVA Ltd or its licensors. Visit our website at http://www.aveva.com
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 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. While every effort has been made to verify the accuracy of this document, AVEVA shall not be liable for errors contained herein or direct, indirect, special, incidental or consequential damages in connection with the furnishing, performance or use of this material.
Content
1 Introduction.............................................................................................................................................. 4 1.1 Aim .................................................................................................................................................... 4 1.2 Objectives......................................................................................................................................... 4 1.3 Prerequisites .................................................................................................................................... 4 1.4 Course Structure ............................................................................................................................. 4 1.5 Using this guide............................................................................................................................... 4 2 Introduction.............................................................................................................................................. 5 2.1 Generating Reports ......................................................................................................................... 5 2.2 Quick Reports .................................................................................................................................. 5 2.3 Report ............................................................................................................................................... 6 2.4 Starting to Use Reports................................................................................................................... 7 2.5 Running a Report from a Saved Template .................................................................................... 7 2.6 Creating a New Template .............................................................................................................. 10 Exercise.......................................................................................................................................................... 17
Chapter 1
Introduction
1.1 Aim
The Vantage Marine Outfitting database stores a large amount of 3D engineering information about your ship design. You can extract this data both graphically, in the form of drawings, or in text form, by producing reports. This training course describes the principles and practice of producing reports. At the end of this one-day session participants will be able to generate many kinds of reports from Vantage Marine Outfitting.
1.2 Objectives
At the end of this training, you will: Quick reports to the Vantage Marine Outfitting command line or file More complex reports with sorting priorities, quantities and totals Creating report templates for project or company use
1.3 Prerequisites
To best understand the options available in Vantage Marine Outfitting Report tools, it is necessary to have completed one or more of the following modules: M4, M5, M6, M7, M8 or M9.
Chapter 2
2 Introduction
At the end of this session you will be able to: Generate Reports from VM Otfitting
2.3 Report
The template specifies what the report will contain, whether it will be sent to the screen or a file, 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 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.
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. 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 be produced for all the elements given.
With: Defines the criteria that must match the elements before they will be reported on. This is sometimes referred to as a filter but works in the same way as the other occurrences in PDMS.
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
10
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 Off will 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 an error 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 with the level in the database hierarchy below which the selection will be made and any particular selection 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 of reporting can be achieved. For example if we were reporting on branches we might choose to only report on branch that had their Pspec set to /A3BTRA.
11
The Hierarchy field is simply used to define the start point for the report search. This eliminates checks to elements above the start point in the hierarchy so reducing the time taken.
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.
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 you create 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.
12
Reports Template form in the area under the columns buttons. The selection of Previous Column or Next 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 or Next 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.
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.
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.
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.
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.
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.
15
Header Form
To define your Header enter the required text or PML expressions into the text area of the form and select OK. A Footer can 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.
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.
16
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 of Report Format will cause the Reports Format form to be displayed.
Exercise
1. Run the report nozz_sched and line_list to show the type of output created. Create a report to list all the pipes with spec A1A. Create columns to display Name, Pspec, Hbore, and Tbore. Create a line list report as shown overleaf, experiment with the sorting facility and notice the way it changes the output.
2. 3.
element that you wish to add, then use the Add button so that it is now shown in the obstruction list. When adding any element to the obstruction list all elements and primitives below the specified item are automatically incorporated into the list.
17