+ All Categories
Home > Documents > Chap 20 - Advanced Reporting

Chap 20 - Advanced Reporting

Date post: 14-Apr-2018
Category:
Upload: bismarckandres
View: 217 times
Download: 0 times
Share this document with a friend

of 34

Transcript
  • 7/29/2019 Chap 20 - Advanced Reporting

    1/34

    20-1

    Advanced Reporting

    UltraPIPEs Advanced Reporting module includes three reporting features for added reportingflexibility. These features are designed to provide the user with the ability to build customizedreports from UltraPIPEs database to meet each customers unique needs. The followingreporting options will be discussed in this chapter:

    MS Word Builder

    Report Package

    Ad Hoc Reports

    All of the above Advanced Reporting features can be found under UltraPIPEsReportspull-down menu.

    MS Word Builder

    This chapter will describe how to utilize the MS Word Builder. The MS Word builder uses

    Microsoft Word as its viewing/printing environment but the construction of the report iscompleted through UltraPIPEs own custom windows. Build reports that filter off any field inUltraPIPEs database, create an unlimited number of custom reports, and save them for quickaccess in the future.

    1. Select theMS Word Bui lderoption from UltraPIPEsReportsmenu,OR

    2. Select the icon from the toolbar.

    The window shown in Figure 20 - 1 will be displayed.

    Chapter

    2

  • 7/29/2019 Chap 20 - Advanced Reporting

    2/34

    20-2

    Figure 20 - 1 Custom MS Word A d Hoc Reports Window

    The MS Word Builder section will be divided into five parts, addressed in the following order:

    Designing a New Report Launching an Existing Report

    Editing an Existing Report

    Copying an Existing Report

    Deleting an Existing Report

    Designing a New Report

    This section will step you through the process of creating a new custom report using the MSWord Ad Hoc Reporting feature.

    1. Select theDesign N ew Reportbutton from theCustom MS Word Ad H ocReportswindow, shown in Figure 20 - 1.

    2. TheCreate a N ew M S Word Ad H oc Reportwindow will be displayed (see Figure20 - 2).

    3. Name the MS Word Ad Hoc Report. Input a name for the MS Word Ad Hoc reportin theReport Namefield. This field will allow report names up to 32 characterslong. The report name is used to save the report format for future use. It will NOTbe displayed on the actual view/print of the report. Adding a Report Title will be

    discussed later in this section in step #10.

  • 7/29/2019 Chap 20 - Advanced Reporting

    3/34

    20-3

    Figure 20 - 2 Create a new MS Word Ad Hoc Report Window

    4. Add fields to the MS Word Ad Hoc Report. Select theAddbutton in the topright hand corner of theCreate a N ew M S Word Ad H oc Reportwindow, seeFigure 20 - 2. TheAdd a field to the reportwindow will appear.

    Figure 20 - 3 A dding a field from UltraPIPEs database to an MS Word Ad HocReport

  • 7/29/2019 Chap 20 - Advanced Reporting

    4/34

    20-4

    Database Use this combo box to choose an UltraPIPE MS Access file type. There aretwo file types available, UPIPE, and UPIPETBL. The UPIPE database contains allequipment information including the equipment master listing, corrosion monitoringdata, CAD link information, valve data, etc. The UPIPETBL contains the UltraPIPEsupport table information including component code tables, material code tables, and

    inspection personnel information.Table Choose a table from the selected MS Access file that contains the UltraPIPEfield to be added to the report. TheTable Descriptionsection describes whatUltraPIPE data is stored in the table being displayed, see Figure 20 - 3.

    Num Records This field displays the number of records stored in the selectedUltraPIPE database table.

    Table description This field describes the information that is contained in the selectedUltraPIPE database table.

    Field Select a field from the chosen UltraPIPE database table. The displayed namesare theactualfield names within the UltraPIPE database table.

    Field Type This field describes the data stored in the selected MS Access field. If thefield is a TEXT field then it will also indicate how many characters can be stored in thechosen field; i.e. TEXT-8 would indicate that the selected field stores up to 8 charactersof text.

    Field Title in Report Use this field to customize the field name for the MS Word AdHoc report, the field title and field name do not have to match. The field title can be upto 50 characters. UltraPIPE will store the field titles given to each field name forreference when making future MS Ad Hoc Reports.

    Prompt for Field Value Check this box to filter the information displayed on the MSWord Ad Hoc Report using this field. There are three types of filters provided for thesereports. The type of filter used depends on the type of data stored in the selected field;text filter, numeric filters, and an inclusive date range filter. For more details go to theLaunch Report section of this chapter.

    Hide Field in Report Choose this check box to hide the field on the report. The fieldwill be used as a filter, if thePrompt for Fieldcheck box is selected, but will not bedisplayed in the body of the report.

    OK button Click theOK

    button to add the selected field to the MS Ad Hoc Report.Cancel Select theCancelbutton to return to theCreate a new MS Word Ad H ocReportwindow WITHOUT adding a field to the Ad Hoc Report.

    5. When the field is added to the MS Word Ad Hoc Report it will appear in the FieldInformation list box, as seen in Figure 20 - 4. Below is a list of the column titles and adescription of the information represented for each field added to the report.

  • 7/29/2019 Chap 20 - Advanced Reporting

    5/34

    20-5

    Database This column describes which UltraPIPE database file from which the fieldwas chosen.

    Table This column indicates which table, from the selected UltraPIPE database, fromwhich the field is being updated.

    Field name The actual field name being referenced from the UltraPIPE database table.

    V This column denotes the view status of a field. A Y shows that theH ide Field onReportcheck box has NOT been checked; therefore this field will be viewed on thereport. An N indicates that theH ide Field on Reportcheck box HAS been checked;therefore this field will not be viewed in the report.

    S This column describes the Sort Order status of the field. An A would indicate anascending sort order setting and a D would indicate a descending sort order setting.The A or D will be followed by a number (A01, A02, A03 or D01, D02, D03)describing the priority the field plays in sorting the report records.

    Figure 20 - 4 MS Word A d Hoc Report field information displayed in the FieldInformation list box

    P This column denotes which fields will be prompted for a value and used to filter theinformation for the Ad Hoc report. A Y will appear in this column for each field thatthePrompt for Field Valuecheck box was selected. An N will appear in this columnfor all fields that did not have thePrompt for Field Valuecheck box selected.

    DT This column applies to numeric fields only. If a numeric field is added to a report,this column will indicate two features. The first number in this column indicates thenumber of decimal places to be displayed on the report. The second number denotes the

  • 7/29/2019 Chap 20 - Advanced Reporting

    6/34

    20-6

    type of filtering that has been selected for this numeric field. There are 7 types ofnumeric filters available:0Field=Number, 1FieldNumber, 5Number1

  • 7/29/2019 Chap 20 - Advanced Reporting

    7/34

    20-7

    Figure 20 - 5 Designing sort order logic for a MS Word Ad Hoc Report

    Report Fields:list box Lists all fields currently assigned to the MS Word Ad HocReport. The field names are preceded by the database table name where the field isstored.

    Sort Fields: list box Lists all fields currently being used for sorting the records of theMS Word Ad Hoc Report. The table name and field name are preceded by an A or aD to indicate whether the field will be sorted in Ascending or Descending order.

    The report will sort the records based on the order of fields listed in theSort Fieldslist

    box.

    Example: Shown in Figure 20 - 5 the records will first be sorted alphanumerically inAscending order based on each records KBCMEQ.GROUP (Unit) field name. Next, allrecords that share the same KBCMEQ.GROUP field name will be sorted in Ascending,alphanumeric order based on each records KBCMEQ.EQ_CIRC_ID (Eq/Circ ID) fieldname. Finally, the records in the report that share the same KBCMEQ.GROUP (Unit)andKBCMEQ.EQ_CIRC_ID (Eq/Circ ID) field names will be sorted in alphanumericorder based on each records KBCMTMLS.TML_TXT (TML) field name. A sampleresult of this sort process can be seen in Table 20 - 1.

    Unit Eq/Circ ID TML

    0043 D-0708 1.02

    0043 D-0708 1.04

    0043 D-0708 1.06

    0043 D-0708 1.08

    0043 W-0196 1.02

    0043 W-0196 1.04

    0043 W-0196 1.06

    0043 W-0196 1.08

  • 7/29/2019 Chap 20 - Advanced Reporting

    8/34

    20-8

    0043 X-0950-SH 1.02

    0043 X-0950-SH 1.04

    0043 X-0950-SH 1.06

    0043 X-0950-SH 1.08

    DEMO 0356-A2-1S-020 1.00

    DEMO 0356-A2-1S-020 2.00

    DEMO 0356-A2-1S-020 3.00DEMO 0356-A2-1S-020 4.00

    DEMO 1116-B2-1-043 1.00

    DEMO 1116-B2-1-043 2.00

    DEMO 1116-B2-1-043 3.00

    DEMO 1116-B2-1-043 4.00

    DEMO AD301 1.00

    DEMO AD301 2.00

    DEMO AD301 3.00

    DEMO AD301 4.00

    Table 20 - 1 Example of sorting results

    - To move a field from the Report Fields list box to the Sort Fields list boxhighlight the field name and select theAdd ->button. You may also double click on thefield name in the Report Fields list box to move it to the Sort Fields list box.

    - To move a field from the Sort Field list box to the Report Field list boxhighlight the field name and select the

  • 7/29/2019 Chap 20 - Advanced Reporting

    9/34

    20-9

    Cancel Choose theCancelbutton to return to theCreate a new MS Word Ad H ocReportwindow without saving the sort order shown in theSort Fieldslist box.

    10.Assign a Report Title to the MS Word Ad Hoc Report. Choose theReport Titlebutton from the right side of theCreate a new MS Word Ad H oc Reportwindow.TheReport Ti tlewindow shown in Figure 20 - 6 will be displayed.

    Figure 20 - 6 Adding a Report Title to a MS Word Ad Hoc Report

    Report Title Enter a Report Title into this field, the title can be up to 80 characters in

    length. The title entered here will be printed at the top of the MS Word Ad Hoc Report.

    OK button Select theOKbutton to save the Report Title and return to the Create anewMS Word Ad H oc Reportwindow.

    Cancel button Click on theCancelbutton to close theReport Ti tlewindow, withoutsaving the input report title, and return to theCreate a new MS Word Ad H oc Reportwindow.

    11.Review the report Structured Query Language (SQL) logic. Click theSQLbuttonto access theSQL statement to generate reportwindow shown in Figure 20 - 7.

  • 7/29/2019 Chap 20 - Advanced Reporting

    10/34

    20-10

    Figure 20 - 7 Reviewing the Structured Query language (SQL) for the MS Word AdHoc Report

    Ok button Click theOKbutton to save changes made to the SQL statement andreturn to theCreate a new MS Word Ad H oc Reportwindow.

    Print button Select thePrintbutton to print a hard copy of the SQL statement.

    SpellCheck button Choose theSpellCheckbutton to check the spelling of thetext used in the SQL statement.

    Cancelbutton Select theCancelbutton to return to the Create a new MS Word AdHoc Report without saving changes made to the SQL statement.

    12.Preview the MS Word Ad Hoc Report. Select thePreviewbutton in the bottomright hand corner of theCreate a new MS Word Ad H oc Reportwindow todisplay theLaunch Reportwindow shown in Figure 20 - 8.

    Prompt for Field Value Before launching the MS Word Ad Hoc Report select the

    desired filtering criteria for each field assigned thePrompt for Field Valueflag. In theexample shown in Figure 20 - 8 all three field type prompts are available; text, numeric,and date prompts. To change the prompt logic or remove the field from theLaunchReportwindow highlight the field in theCreate a new MS Word Ad H oc Reportwindow and select theEditbutton, see step 6 for more details.

    Text PromptsText prompts allow the user to filter the reportbased on a user defined field value. Select an existing value from the

  • 7/29/2019 Chap 20 - Advanced Reporting

    11/34

    20-11

    database using the pick list, click the arrow to the right of the textprompt to access a list of current field values currently stored in thedatabase, or type a field value directly into the text prompt. Thereport will only compile records from the database that match theuser defined field value for each text prompt. As shown in Figure 20

    - 8 wildcards are available to select a larger range of field values for atext prompt.

    Figure 20 - 8 Previewing a MS Word Ad Hoc Report

    Numeric Prompts Numeric prompts are represented by a buttondisplaying the current numeric filter logic for a field. The RepTMLcr (Representative TML Corrosion Rate) numeric prompt iscurrently configured to only compile those records that containTMLs with a Representative Corrosion Rate greater than 15 MPY.

    To change a numeric prompts filtervalueclick on the numeric prompt logic button.TheNumeric Promptwindow, seen in Figure 20 - 9, will be accessed. To edit thenumeric prompt logichighlight the field in theCreate a new MS Word Ad H ocReportwindow and select theEditbutton, see step 6 for more details.

    Filter Value edit box type in the desired filter value to complete the filter logicstatement, e.g. in Figure 20 - 9 the logic statement shows that only records that have aTML Representative Corrosion Rate greater than or equal (>=) to 15 MPY will be

  • 7/29/2019 Chap 20 - Advanced Reporting

    12/34

    20-12

    displayed on the report. For more details on the available filter logic statements see step#5.

    Figure 20 - 9 Changing a Numeric Prompts filter value

    OK button Select theOKbutton to save changes to the Numeric Prompt value.

    I nclusive Date Range Prompt Configure the beginning and

    ending date fields to filter date fields assigned the Prompt for FieldValue setting. Only records that have associated dates that fall withinthe configured inclusive date range will be displayed on the ad hocreport.

    Send report to printer without pausing Select this check box to print the reportBEFORE previewing the Ad Hoc report in MS Word.

    Launch Reportbutton Click on theLaunch Reportbutton to compile therecords from the UltraPIPE database that meet the configured filtering logic, launch MSWord, and build the Ad Hoc report.

    Done button Choose theDonebutton when you are finished previewing your newMS Word Ad Hoc report and return to theCreate a new MS Word Ad H oc Reportwindow.

    13.Save the new MS Word Ad Hoc report. Select theOKbutton at the bottom of theCreate a new MS Word Ad H oc Reportwindow to save the new report.

    Select theCancelbutton to leave theCreate a new MS Word Ad H oc Reportwindowwithout saving a new report. Before returning to the mainCustom M S Word Ad H ocReportswindow, shown in Figure 20 - 1, a confirmation window will be displayed.Select theYesbutton to abandon the new Ad Hoc report and return to theCustom MSWord Ad Hoc Reportswindow or choose theN obutton to return to theCreate anew MS Word Ad H oc Reportwindow to save the new Ad Hoc report.

  • 7/29/2019 Chap 20 - Advanced Reporting

    13/34

    20-13

    Figure 20 - 10 A bandon new Ad Hoc Report Confirmation Window

    Launching an Existing Report

    After creating a custom MS Word report, as described in the Design A New Report sectionabove, the report configuration will be saved in the UltraPIPE database for future use. Thissection of the MS Word Builder manual will step you through the process of launching existingMS Word Ad Hoc reports stored in UltraPIPEs MS Word Builder application.

    1. Select theMS Word Bui lderoption from theReportsmenu, or

    2. Select the icon from the toolbar.

    The window shown in Figure 20 - 11 will be displayed.

    Figure 20 - 11 Custom MS Word A d Hoc Reports Window

    1. Choose an existing Ad Hoc report from theExisting Ad H oc Reportspull downmenu. To create a new report, select theDesign N ew Reportbutton and follow

    the step-by-step instructions in the previous section.

    2. Select theLaunch Reportbutton to configure the report filters and launch thereport. All fields assigned the Prompt for Value setting will be displayed as seen inFigure 20 - 12.

  • 7/29/2019 Chap 20 - Advanced Reporting

    14/34

    20-14

    Figure 20 - 12 L aunching a MS Word A d Hoc Report

    3. Before launching the MS Word Ad Hoc Report, select the desired filtering criteria foreach field assigned thePrompt for Field Valueflag. In the example shown inFigure 20 - 12, all three field type prompts are available; text, numeric, and dateprompts. To change the prompt logic or remove the field from theLaunch Reportwindow highlight the field in theCreate a new MS Word Ad H oc Reportwindow

    and select theEditbutton, see step 6 for more details.

    Text Prompts Text prompts allow the user to filter the reportbased on a user defined field value. Select an existing value from thedatabase using the pick list, click the arrow to the right of the textprompt to access a list of current field values currently stored in thedatabase, or type a field value directly into the text prompt. Thereport will only compile records from the database that match theuser defined field value for each text prompt. As shown in Figure 20- 12, wildcards are available to select a larger range of field values fora text prompt.

    Numeric PromptsNumeric prompts are represented by a buttondisplaying the current numeric filter logic for a field. As shown inFigure 20 - 12, the TML RCR (Representative TML Corrosion Rate)numeric prompt is currently configured to only compile thoserecords that contain TMLs with a Representative Corrosion Rategreater than 15 MPY.

  • 7/29/2019 Chap 20 - Advanced Reporting

    15/34

    20-15

    To change a numeric prompts filtervalueclick on the numeric prompt logic button.TheNumeric Promptwindow, seen in Figure 20 - 13, will be accessed. To edit thenumeric prompt logichighlight the field in theCreate a new MS Word Ad H ocReportwindow and select theEditbutton, see step 6 for more details.

    Filter Value edit box Type in the desired filter value to complete the filter logicstatement, e.g. in Figure 20 - 13 the logic statement shows that only records that havea TML Representative Corrosion Rate greater than or equal (>=) to 15 MPY will bedisplayed on the report. For more details on the available filter logic statements seestep #5 in the Deigning a New Report section.

    Figure 20 - 13 Changing a Numeric Prompts Filter V alue

    OK button Select theOKbutton to save changes to the Numeric Prompt value.

    Inclusive Date Range Prompt Configure the beginning and ending date fields tofilter date fields assigned the Prompt for Field Value setting. Only records that haveassociated dates that fall within the configured inclusive date range will be displayedon the ad hoc report.

    4. Select theSend report to printer without pausingcheck box to print the reportBEFORE previewing the Ad Hoc report in MS Word.

    5. Click on theLaunch Reportbutton to compile the records from the UltraPIPEdatabase that meet the configured filtering logic, launch MS Word, and build the AdHoc report.

    6. Choose theDonebutton when you are finished viewing/printing the MS Word AdHoc report and return to theCustom MS Word Ad H oc Reportswindow, shownin Figure 20 - 11.

    Editing an Existing Report

    After creating a custom MS Word report, as described in the Design A New Report sectionabove, the report configuration will be saved in the UltraPIPE database for future use. Thissection of the MS Word Builder manual will step you through the process of editing the format ofexisting MS Word Ad Hoc reports stored in UltraPIPEs MS Word Builder application.

    1. Select theMS Word Bui lderoption from theReportsmenu,Or

  • 7/29/2019 Chap 20 - Advanced Reporting

    16/34

    20-16

    2. Select the icon from the toolbar.

    The window shown in Figure 20 - 14 will be displayed.

    Figure 20 - 14 Custom MS Word A d Hoc Reports Window

    1. Choose an existing Ad Hoc report from theExisting Ad H oc Reportspull downmenu. To create a new report, select theDesign N ew Reportbutton and followthe step-by-step instructions in theDesigning a New Reportsection.

    2. Select theEdi t Reportbutton to access theEdi t an Existing MS Word Ad H ocReportwindow, displayed in Figure 20 - 15.

    Figure 20 - 15 Editing an existing MS Word Ad Hoc Report

  • 7/29/2019 Chap 20 - Advanced Reporting

    17/34

    20-17

    3. Add new fields to the MS Word Ad Hoc Report. Select theAddbutton in the topright hand corner of theEdit an MS Word Ad H oc Reportwindow, see Figure 20 -15. TheAdd a field to the reportwindow will appear.

    Figure 20 - 16 A dding a Field from UltraPIPEs Database to a MS Word A d HocReport

    Database Use this combo box to choose an UltraPIPE MS Access file type. There aretwo file types available, UPIPE, and UPIPETBL. The UPIPE database contains all

    equipment information including the equipment master listing, corrosion monitoringdata, CAD link information, valve data, etc. The UPIPETBL contains the UltraPIPEsupport table information including component code tables, material code tables, andinspection personnel information.

    Table Choose a table from the selected MS Access file that contains the UltraPIPEfield to be added to the report. TheTable Descriptionsection describes whatUltraPIPE data is stored in the table being displayed, see Figure 20 - 16.

    Num Records This field displays the number of records stored in the selectedUltraPIPE database table.

    Table description This field describes the information that is contained in the selectedUltraPIPE database table.

    Field Select a field from the chosen UltraPIPE database table. The displayed namesare theactualfield names within the UltraPIPE database table.

    Field Type This field describes the data stored in the selected MS Access field. If thefield is a TEXT field then it will also indicate how many characters can be stored in the

  • 7/29/2019 Chap 20 - Advanced Reporting

    18/34

    20-18

    chosen field; i.e. TEXT-8 would indicate that the selected field stores up to 8 charactersof text.

    Field Title in Report Use this field to customize the field name for the MS Word AdHoc report, the field title and field name do not have to match. The field title can be upto 50 characters. UltraPIPE will store the field titles given to each field name forreference when making future MS Ad Hoc Reports.

    Prompt for Field Value Check this box to filter the information displayed on the MSWord Ad Hoc Report using this field. There are three types of filters provided for thesereports. The type of filter used depends on the type of data stored in the selected field;text filter, numeric filters, and an inclusive date range filter. For more details go to theLaunch Report section of this chapter.

    Hide Field in Report Choose this check box to hide the field on the report. The fieldwill be used as a filter, if thePrompt for Fieldcheck box is selected, but will not bedisplayed in the body of the report.

    OK button Click theOKbutton to add the selected field to the MS Ad Hoc Report.

    Cancel Select theCancelbutton to return to theEdit an MS Word Ad H oc Reportwindow WITHOUT adding a field to the Ad Hoc Report.

    4. Each field associated to the MS Word Ad Hoc Report it will appear in the FieldInformation list box, as seen in Figure 20 - 15. Below is a list of the column titles anda description of the information represented for each field added to the report.

    Database This column describes which UltraPIPE database file from which the fieldwas chosen.

    Table This column indicates which table, from the selected UltraPIPE database, fromwhich the field is being updated.

    Field name This column indicates the actual field name being referenced from theUltraPIPE database table.

    V This column denotes the view status of a field. A Y shows that theH ide Field onReportcheck box has NOT been checked; therefore this field will be viewed on thereport. An N indicates that theH ide Field on Reportcheck box HAS been checked;therefore this field will not be viewed in the report.

    S This column describes the Sort Order status of the field. An A would indicate anascending sort order setting and a D would indicate a descending sort order setting.The A or D will be followed by a number (A01, A02, A03 or D01, D02, D03)describing the priority the field plays in sorting the report records.

    P This column denotes which fields will be prompted for a value and used to filter theinformation for the AD Hoc report. A Y will appear in this column for each field that

  • 7/29/2019 Chap 20 - Advanced Reporting

    19/34

    20-19

    thePrompt for Field Valuecheck box was selected. An N will appear in this columnfor all fields that did not have thePrompt for Field Valuecheck box selected.

    DT This column applies to numeric fields only. If a numeric field is added to a report,this column will indicate two features. The first number in this column indicates thenumber of decimal places to be displayed on the report. The second number denotes thetype of filtering that has been selected for this numeric field. There are 7 types ofnumeric filters available;0Field=Number, 1FieldNumber, 5Number1

  • 7/29/2019 Chap 20 - Advanced Reporting

    20/34

    20-20

    The report will sort the records based on the order of fields listed in theSort Fieldslistbox. For more information on the MS Word Ad Hoc Reports sorting logic.

    Figure 20 - 17 Editing Sort Order L ogic for a MS Word A d Hoc Report

    - To move a field from the Report Fields list box to the Sort Fields list boxhighlight the field name and select theAdd ->button. You may also double click on thefield name in the Report Fields list box to move it to the Sort Fields list box.

    - To move a field from the Sort Field list box to the Report Field list boxhighlight the field name and select the

  • 7/29/2019 Chap 20 - Advanced Reporting

    21/34

    20-21

    OK button Click theOKbutton to save changes the sort order and return to theEditan MS Word Ad H oc Reportwindow, shown in Figure 20 - 15.

    Cancel Choose theCancelbutton to return to theEdi t an MS Word Ad H ocReportwindow without saving changes to the sort order.

    9. Edit the MS Word Ad Hoc Report Title. Choose theReport Titlebutton fromthe right side of theCreate a new MS Word Ad H oc Reportwindow. TheReportTitlewindow shown in Figure 20 - 18 will be displayed.

    Figure 20 - 18 Editing the MS Word Ad Hoc Report Title

    Report Title Edit the Report Title in this field, the title can be up to 80 characters inlength. The title entered here will be printed at the top of the MS Word Ad Hoc Report.

    OK button Select theOKbutton to save changes to the Report Title and return to theEdi t an MS Word Ad H oc Reportwindow.

    Cancel button Click on theCancelbutton to close theReport Ti tlewindow, withoutsaving changes to the report title, and return to theEdi t an MS Word Ad H oc Reportwindow.

    10.Edit the report Structured Query Language (SQL) logic. Click theSQLbutton toaccess theSQL statement to generate reportwindow shown in Figure 20 - 19.

    Ok button Click theOKbutton to save changes made to the SQL statement andreturn to theEdit an MS Word Ad H oc Reportwindow.

    Print button Select thePrintbutton to print a hard copy of the SQL statement.

    SpellCheck button Choose theSpellCheckbutton to check the spelling of thetext used in the SQL statement.

    Cancelbutton Pick theCancelbutton to return to the Edi t an MS Word Ad H ocReportwindow without saving changes made to the SQL statement.

  • 7/29/2019 Chap 20 - Advanced Reporting

    22/34

    20-22

    Figure 20 - 19 Editing the Structured Query language (SQL ) for the MS Word A dHoc Report

    11.Preview the changes made to the MS Word Ad Hoc Report. Select thePreviewbutton in the bottom right hand corner of theEdit an MS Word Ad H oc Reportwindow to display theLaunch Reportwindow shown in Figure 20 - 20.

    Before launching the MS Word Ad Hoc Report select, the desired filtering criteria foreach field assigned thePrompt for Field Valueflag. In the example shown in Figure 20- 20 all three field type prompts are available; text, numeric, and date prompts. For moreinformation, see the Launching MS Word Ad Hoc Reports section of this Chapter.

    Send report to printer without pausing Select this check box to print the reportBEFORE previewing the Ad Hoc report in MS Word.

    Launch Report button Click on theLaunch Reportbutton to compile therecords from the UltraPIPE database that meet the configured filtering logic, launch MSWord, and build the Ad Hoc report.

    Done button Choose theDonebutton when you are finished previewing your newMS Word Ad Hoc report and return to theCreate a new MS Word Ad H oc Reportwindow.

  • 7/29/2019 Chap 20 - Advanced Reporting

    23/34

    20-23

    Figure 20 - 20 Previewing changes made to an existing MS Word A d Hoc Report

    12.Save changes made to the MS Word Ad Hoc report. Select theOKbutton at thebottom of theEdit an MS Word Ad H oc Reportwindow to save changes to thereport.

    Select theCancelbutton to leave theEdi t an MS Word Ad H oc Reportwindowwithout saving changes made to the report. Before returning to the mainCustom MSWord Ad H oc Reportswindow, shown in Figure 20 - 15, a confirmation window willbe displayed. Select theYesbutton to abandon the new Ad Hoc report and return to theCustom MS Word Ad H oc Reportswindow or choose theNobutton to return to theCreate a new MS Word Ad H oc Reportwindow to save the new Ad Hoc report.

    Figure 20 - 21 Abandon changes to the Ad Hoc report confirmation window

  • 7/29/2019 Chap 20 - Advanced Reporting

    24/34

    20-24

    Copying an Existing Report

    After creating a custom MS Word report, as described in the Designing a New Report section, thereport configuration will be saved in the UltraPIPE database for future use. This section of theMS Word Builder manual will step you through the process of copying the format of an existingMS Word Ad Hoc reports stored in UltraPIPEs MS Word Builder application to a new MS

    Word Ad Hoc Report.

    1. Select theMS Word Bui lderoption from theReportsmenu

    Or

    2. Select the icon from the toolbar.

    The window shown in Figure 20 - 22 will be displayed.

    Figure 20 - 22 Custom MS Word A d Hoc Reports Window

    1. Select an existing Ad Hoc report from theExisting Ad H oc Reportspull downmenu. To create a new report, select theDesign N ew Reportbutton and followthe step-by-step instructions in theDesigning a New Reportsection.

    2. Choose theCopy Reportbutton to copy the format of the selected MS Word AdHoc Report to a new report. TheCopy an Ad H oc Reportwindow shown inFigure 20 - 23 will be accessed.

  • 7/29/2019 Chap 20 - Advanced Reporting

    25/34

    20-25

    Figure 20 - 23 Copying an existing MS Word Ad Hoc Report

    3. Enter the name of the new MS Word report into theN ew report namefield. Thenew report name can be up to 32 characters.

    4. Select theCopybutton to save the report format of the MS Word report displayed intheName of report to copyfield to the new report name.

    5. Choose theCancelbutton to exit theCopy an Ad H oc Reportwindow withoutcopying the selected report.

    Deleting an Existing Report

    After creating a custom MS Word report, as described in the Design A New Report sectionabove, the report configuration will be saved in the UltraPIPE database for future use. Thissection of the MS Word Builder manual will step you through the process of deleting an existingMS Word Ad Hoc reports stored in UltraPIPEs MS Word Builder application.

    1. Select theMS Word Bui lderoption from theReportsmenu

    Or

    2. Select the icon from the toolbar.

    The window shown in Figure 20 - 24 will be displayed.

  • 7/29/2019 Chap 20 - Advanced Reporting

    26/34

    20-26

    Figure 20 - 24 Custom MS Word A d Hoc Reports Window

    1. Choose an existing Ad Hoc report from theExisting Ad H oc Reportspull downmenu. To create a new report, select theDesign N ew Reportbutton and follow

    the step-by-step instructions in theDesigning a New Reportsection.

    2. Click on theDelete Reportbutton to remove the selectedMS Word Ad H ocReportfrom the UltraPIPE database. The window shown in Figure 20 - 25 willappear to confirm the deletion of the Ad Hoc report.

    Figure 20 - 25 Deleting an existing MS Word Ad Hoc Report ConfirmationWindow

    3. Select theYesbutton to continue deleting the Ad Hoc report or choose theN obutton to abort the deletion of the Ad Hoc report.

    Report Package

    The Report Package module provides you with the capability to record and save a sequence of

    multiple UltraPIPE text based reports normally printed as a package for a certain requirement.Once the sequence is recorded and saved to a Report Package Name, the same report packagecan be printed in the future with simplified procedures. A saved package can be printed withsome modification of the original report parameters when selected; but only slightly. The Area -Eq/Circ ID (including wildcard criteria) input and the date range of Date From to Date ToRange for schedule listings can be changed. A Package Copy feature simplifies creating similarpackages when these changes are not sufficient.

  • 7/29/2019 Chap 20 - Advanced Reporting

    27/34

    20-27

    Color Graphic Reports and Eq/Circ ID CAD Drawings cannot be included in a Report Package.

    In addition, there is a limitation when using multiple Crystal Fixed Format Text Reports in apackage. This is due to a limitation with the Crystal Program; which is out of the controlof UltraPIPE.The limitation can be avoided by using MS Word Fixed Format Text Reports.Not all mixes of multiple Crystal Fixed Format Text Reports in a package will cause the problem.If you want to use Crystal, then an experiment is required to test for the problem.

    When Crystal launches a report, it keeps a lock on the database that was used for the report. Thedatabase is not released for the next report until the first Crystal report is closed. This causes aproblem printing multiple reports that share a common database. For some Crystal reports,auxiliary database tables are used so the problem will not be only associated with theUPIPE.MDB file.

    If you have this problem the following two messages will appear:

    Figure 20 - 26- Error messages when multiple Crystal Fixed Format Text Reportsshare the same database.

    Note that you can easily edit an existing Report Package with this problem to use MS Word.Click on the Edi t Recording button on theReport Package Editwindow (ReferenceFigure 20-31 below) and change the first line of each report in the package:

    [ReportType] = [Crystal] change to [ReportType] = [Word]

    Use the following method to access the Report Package Option:

    Select theReport Packages>

    option from theReports

    menu as shown in Figure 20- 27.

  • 7/29/2019 Chap 20 - Advanced Reporting

    28/34

    20-28

    Figure 20 - 27 Selection the Report Package Option

    There are two options:Add/ Edi t/ Delete a Report PackageandRun a Report Packageavailable for selection as shown in Figure 20 - 27. These two options are discussed below.

    Add/Edit/Delete a Report Package

    This section will step you through the process of creating a new Report Package.

    Select theAdd/Edit/Delete a Report Package option from theReport Packagespull-down option as shown in Figure 20 - 27. The following window will display as shown in Figure20 - 28. If any Report Packages exist, the first Package in alphabetical order will display.

    Figure 20 - 28 A dd/ Edit/ Copy/ Run a Report Package Option

    The buttons on this window provide the following functionality:

    View- Provides a listing of all current Report Packages for review and selection.Clicking on View generates the following window:

  • 7/29/2019 Chap 20 - Advanced Reporting

    29/34

    20-29

    Figure 20 - 29 V iew Report Packages Option

    Add Package- Allows a user to assign a Name and Description to a ReportPackage and initiate the UltraPIPE recording mode that will record all reportprocedures until recording is stopped.

    Figure 20 - 30 A dd a Report Package Option

    The first step is to enter a suitable name and description for the package. Thenselect theStart Recordingbutton. When recording is initiated,allreportsequences are saved to a text file for duplication later.

  • 7/29/2019 Chap 20 - Advanced Reporting

    30/34

    20-30

    HELPFUL HINT

    Do not forget that the Record Mode will remain active whendesigning a Report Package until recording is manually stopped.

    As a reminder, UltraPIPE displays the following small window. The word

    Recording will also display on the bottom border of the UltraPIPE Main Window.

    Figure 20 - 30 Recording reminder window

    The recording will be saved as a text macro in an UltraPIPE Memo field. AllFixed Format Text Reports, all Inspection Activity Reports, and all MS WordBuilder Reports are eligible for a Report Package.

    HELPFUL HINT

    The new check box in the View/Print Inspection Activity Reportswindow called Show the most recent reports only allows a user todesign a Report Package that will automatically print the most recent

    Activity of any type.

    When the sequence of reports required for a Report Package is completed, select theStopbutton.

    Edit Package- Allows a user to Edit the selected Report Package two ways.

    Figure 20 - 31 Report Package Edit Option

  • 7/29/2019 Chap 20 - Advanced Reporting

    31/34

    20-31

    1. TheEdi t Recordingbutton allow for the review and edit of the actual text recordedfor a Report Package. An advanced user can make manual changes to tweak aReport Package.

    2. The Append Recording option will start the Recording mode and allow additionalreport sequences to be added or appended to the previous recording.

    Delete Package Allows a user to delete an existing package.

    Figure 20 - 32 Delete Report Packages Option

    Copy Package- Allows a user to easily create a similar package to an existingpackage. The Report Package Edit feature will then allow modifications to thepackage as required.

    Figure 20 - 33 Copy Package Option

    Run Package- This short-cut button allows a user to run a package immediatelyafter it is created or edited. For additional details, see the following section.

    Run a Report Package

    This section will step you through the process of running and existing Report Package.

    Select theRun Report Package option from theReport Packagespull-downoption. The following window will display as shown in Figure 20 - 34.

  • 7/29/2019 Chap 20 - Advanced Reporting

    32/34

    20-32

    Figure 20 - 34 Run an existing Report Package

    The buttons on this window provide the following functionality:

    Use Recorded Mode- This option will run the Report Package exactly asdesigned.

    Specify New Parameters- This option will allow the selected Report Package tobe modified for this output to some degree. The Area and Eq/Circ ID fields can bechanges as well as the Date Range for any fixed format text report with a date range.The window appears as follows with this option selected:

    Figure 20 - 35 Run an existing Report Package with Specify New Parameters

  • 7/29/2019 Chap 20 - Advanced Reporting

    33/34

    20-33

    Ad Hoc Reports

    The Ad Hoc Reports module provides you with the capability to develop custom reports orlistings based on user criteria of existing database fields as well as graphic representation of thisdata. In addition, the delivered fixed format text reports for Crystal can be modified with the

    Crystal Reports. The fields will include both raw data (i.e. design temperature, material code, size,etc.) and calculated information (corrosion rates, remaining life, etc.). Numeric fields allowspecific criteria or a range of values for an input. In addition, various operations can beperformed on numeric fields. Alphanumeric fields allow specific information with listings or awildcard input for any characters. Use either of the following methods to access ad hocreports:

    1. Select theAd H oc Reports option from theReportsmenu.

    Or

    2.

    Select the icon from the toolbar.Crystal Reports will be initialized. Refer to your Crystal Reports manual for more information onusing Crystal Reports.

    The UltraPIPE Ad-Hoc Option provides:

    1. An UltraPIPE menu item and short-cut icon to start the Crystal Reports program.

    2. Telephone and Fax Support for Crystal Reports related to use with UltraPIPE understandard support policy.

    UltraPIPE does NOT supply a license for Crystal Reports. You must purchase this separately.Crystal Standard V7.0 or later is required. Currently Crystal V7.0 Standard and Professional areavailable and the recommended version for new purchases. The Standard version is all that isrequired with the MS Access database used by UltraPIPE. The Professional version will alsowork with SQL databases like Oracle and SQL Server.

  • 7/29/2019 Chap 20 - Advanced Reporting

    34/34


Recommended