Plant Design System (PDS)

Reference Data Auditing Tool

Version 2010 (V11)

November 2009

DPDS3-PE-200047C

Copyright
Copyright 1984-2009 Intergraph Corporation. All Rights Reserved.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains
confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and
international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.

U.S. Government Restricted Rights Legend

Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was developed at
private expense and is "restricted computer software" submitted with restricted rights in accordance with subparagraphs (a) through (d) of the
Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal Acquisition Regulations ("FAR") and its successors,
and is unpublished and all rights are reserved under the copyright laws of the United States. For units of the Department of Defense ("DoD"):
This is "commercial computer software" as defined at DFARS 252.227-7014 and the rights of the Government are as specified at DFARS
227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
P.O. Box 240000
Huntsville, AL 35813
Street address: 170 Graphics Drive, Madison, AL 35758

Terms of Use
Use of this software product is subject to the End User License Agreement and Limited Product Warranty ("EULA") delivered with this
software product unless the licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid
signed license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use of this
software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives licensee permission to
print a reasonable number of copies of the documentation as defined in the applicable license agreement and delivered with the software
product for licensee's internal, non-commercial use. The documentation may not be printed for resale or redistribution.

Warranties and Liabilities

All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software or
applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this document or its
contents shall be considered or deemed a modification or amendment of such warranties. Intergraph believes the information in this
publication is accurate as of its publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable technical
product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software discussed in this document is furnished under a license and may be used or copied only in accordance with the terms of this
license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by Intergraph or its
affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS TO THE
USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data. Users should
verify for themselves that the data is accurate and suitable for their project work.

Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, FrameWorks, I-Convert, I-Export, I-Sketch, SmartMarine, IntelliShip, INtools, ISOGEN,
MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of Intergraph
Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered trademarks of Microsoft
Corporation. Oracle, JD Edwards, PeopleSoft, and Retek are registered trademarks of Oracle Corporation and/or its affiliates. MicroStation is
a registered trademark of Bentley Systems Inc, all rights reserved. Other brands and product names are trademarks of their respective owners.

Contents
PDS Reference Data Auditing Tool........................................................................................................... 3
Introduction ............................................................................................................................................ 3
Audit Tools Interface ............................................................................................................................. 3
File Menu......................................................................................................................................... 4
Audit Menu ...................................................................................................................................... 5
View Menu .................................................................................................................................... 10
Help Menu ..................................................................................................................................... 12
Batch Job Dialog Box .......................................................................................................................... 12
Index .......................................................................................................................................................... 13

Plant Design System (PDS) Reference Data Auditing Tool

Contents

ii

Plant Design System (PDS) Reference Data Auditing Tool

SECTION 1

PDS Reference Data Auditing Tool

In This Section
Introduction.................................................................................... 3
Audit Tools Interface ..................................................................... 3
Batch Job Dialog Box .................................................................... 12

Introduction
The PDS Reference Data Auditing Tool utility allows PDS users to audit and report the
discrepancies between the active project reference database and an archived dataset. The utility
can transfer data over an FTP connection, so that the project database and archive dataset can
reside at different PDS project sites. The utility can also be used to maintain data integrity
among models and drawings at different workshare sites.
Because of the amount of reference data processed during an audit, the Audit Tool utility
performs the audit and file transfer operations in batch mode. You can run these batch operations
immediately or schedule them to run at a later time.
The Audit Tool utility stores audit parameters in configuration files, which allow users to
perform periodic audits without repeating audit setup for each run. It also stores the results of
the audits in report files, which can be viewed, filtered, emailed, or printed from within the
utility interface.

Audit Tools Interface

This section describes the Audit Tool interface. The Audit Tool commands are available from
the toolbar and from menus on the PDS Reference Data Auditing Tool dialog box.
New Configuration Opens a default new configuration, as if the user had just started the
utility.
Open Configuration Opens an existing configuration (.cfg) file.
Save Configuration Saves the current configuration file. If you have not previously saved the
configuration file, the system prompts you for a file name and location.
FTP Login Specifies the location of the remote PDS site, and the login name and password
used to access the remote site.
Browse FTP Folders Allows you to view and select folders on the remote PDS site and the
archive dataset location.
Select Reference Data Specifies which reference data to compare between the project and the
archive dataset.
File Transfer Copies the specified remote archive dataset to the local directory using an FTP
connection.

Plant Design System (PDS) Reference Data Auditing Tool

PDS Reference Data Auditing Tool

Audit Mode 1 Copies the remote archive dataset over an FTP connection to the local
computer, and then compares the local project database to the transferred archive dataset.
Audit Mode 2 Compares the local project database to a local archive dataset.
Audit Mode 3 Compares the model and drawing data in the local project database to the
model and drawing data in a local archive dataset.
View Audit Report Displays the Audit Report Viewer, which allows you to view, sort, print,
email, or save audit report data.
View Batch Log Displays the Batch Log viewer, which allows you to view and print existing
batch log files.
Help Displays the Audit Tool Help file.
Exit Closes the Audit Tool utility.
Project Specifies the active project.

File Menu
The commands on the File menu allow you to open and save configuration files, and exit the
Audit Tool.

Commands
New Configuration File (on page 4)
Open Configuration File (on page 4)
Save Configuration (on page 4)
Save Configuration As (on page 5)
Exit (on page 5)

Ne w Co n fig u ra tion File

This command changes the audit configuration to a default configuration, clearing any existing
settings. Audit configuration files contain all the settings involved in a reference data audit
operation, and allow you to save these settings in order to perform repeated audits without reentering information each time.

Op e n Co n fig u ra tio n File

This command opens a previously saved audit configuration file.

Plant Design System (PDS) Reference Data Auditing Tool

PDS Reference Data Auditing Tool

S a ve Co n fig u ra tion
This command saves the current configuration file. If you have not previously saved the
configuration file, the system prompts you for a file name and location.

S a ve Co n fig u ra tion As
This command saves the current configuration with a different file name.

Exit
This command closes the Audit Tool utility.

Audit Menu
The commands on the Audit menu allow you to transfer archive dataset files, select reference
data for comparison, and audit and report the discrepancies between the active project reference
database and an archived dataset.

Commands
FTP Login (on page 5)
Browse FTP Folders (on page 5)
Select Reference Data (on page 6)
File Transfer (on page 6)
Audit Mode 1 (on page 7)
Audit Mode 2 (on page 8)
Audit Mode 3 (on page 9)

FTP Lo g in
This command specifies the location of the remote PDS site, and the user name and password
used to access the site.

Options
Remote Host The name of the computer on which the remote PDS archive dataset resides.
Username The username used to access the remote computer.
Password The password used to access the remote computer.
OK Saves the remote host name, username, and password to the current configuration file, and
attempts to log in to the remote computer.
Cancel Closes the FTP Login dialog box without saving the login information.

Plant Design System (PDS) Reference Data Auditing Tool

PDS Reference Data Auditing Tool

Bro ws e FTP Fo ld ers

This command allows you to view folders on the remote PDS site and the local archive dataset
location.

Options
Archive Dataset Location Specifies the location of the local archive dataset.
Remote PDS Site Specifies the location of the remote PDS site.
CD Changes the active directory on the remote computer.
OK Writes the local and remote directory settings to the configuration file and closes the
dialog box.
Cancel Closes the dialog box without writing the local and remote directory settings to the
configuration file.

S e le c t Re fere n c e Da ta
This command allows you to specify the reference data compared when using Audit Mode 1 or
Audit Mode 2.

Options
Reference Data The reference database tables available for comparison. The check box
beside each table name determines whether the table is compared in the audit. Select the check
box to compare the table, or clear the check box to remove the table from the comparison.
Select All Selects all tables for comparison.
Unselect All Clears all tables, so that none are compared in the audit.
OK Writes the reference data settings to the configuration file and closes the dialog box.
Cancel Closes the dialog box without writing the reference data settings to the configuration
file.

File Tra n s fer

This command copies the specified remote archive dataset to the local directory.

Options
Remote PDS Site The name of the computer on which the remote PDS archive dataset resides.
Remote Path The directory path containing the remote PDS archive dataset on the remote
computer.
Local Archive Directory The location of the local archive dataset.
Submit Batch Job Displays the Batch Job dialog box, which allows you to run the File
Transfer command immediately or at a specified time.
Before Using This Command
Ensure that the remote site has run a PDS project archive and consolidated the archived data set
into a single directory.

Plant Design System (PDS) Reference Data Auditing Tool

PDS Reference Data Auditing Tool

Steps:
1. Click Start > Programs > PD_Shell > Audit Tools.
2. The PDS Reference Data Auditing Tool interface displays.
3. Select a project.
4. Click Audit > Audit Setup > File Transfer.
The Login to Remote FTP Site dialog box displays.
5. Type the remote computer name, username and password.
6. Click OK.
The system logs in to the remote computer and the Set Local and Remote(FTP) Locations
dialog box displays.
7. Select the destination directory on the local computer.
8. Select the source directory on the remote computer.
9. Click OK.
The File Transfer Get Archive from a given FTP Location dialog box displays.
10. Click Submit Batch Job.
The Batch Job dialog box displays.
11. Click Now to submit the batch job immediately, or click Later to set a time for the batch file
transfer to begin.
12. Click Save to save the current configuration.
13. Click Submit.
The batch job is added to the batch queue or scheduled, depending on the selected batch
submission option.

Au d it Mo d e 1
This command copies the remote archive dataset over an FTP connection to the local computer,
and then compares the local project database to the transferred archive dataset.

Options
Remote PDS Site The name of the computer on which the remote PDS archive dataset resides.
Remote Path The directory path containing the remote PDS archive dataset on the remote
computer.
Local Archive Directory The destination of the local copy of the remote archive dataset.
Reference Data Displays the Reference Data dialog box, which allows you to specify the
reference data compared between the local project and the remote archive dataset.
Submit Batch Job Displays the Batch Job dialog box, which allows you to run the Audit
command immediately or at a specified time.
Before Using This Command
Ensure that the remote site has run a PDS project archive and consolidated the archived data set
into a single directory.
Steps:
1. Click Start > Programs > PD_Shell > Audit Tools.

Plant Design System (PDS) Reference Data Auditing Tool

PDS Reference Data Auditing Tool

2.
3.
4.
5.

6.
7.
8.
9.
10.
11.
12.
13.
14.
15.

The PDS Reference Data Auditing Tool interface displays.

Select a project.
Click Audit > Audit Setup > Audit Mode 1.
The Login to Remote FTP Site dialog box displays.
Type the remote computer name, username and password.
Click OK.
The system logs in to the remote computer and the Set Local and Remote(FTP) Locations
dialog box displays.
Select the destination directory on the local computer.
Select the source directory on the remote computer.
Click OK.
The Mode 1 Project Vs Transferred Remote Archive dialog box displays.
Click Reference Data.
The Select Reference Data for Audit dialog box displays.
Select the reference data to compare between the remote archive and the local project
database.
Click OK.
Click Submit Batch Job.
The Batch Job dialog box displays.
Click Now to submit the batch job immediately, or click Later to set a time for the batch file
transfer to begin.
Click Save to save the current configuration.
Click Submit.
The batch job is added to the batch queue or scheduled, depending on the selected batch
submission option.

Au d it Mo d e 2
This command compares the local project database to a local archive dataset.

Options
Archive Dataset Locations Specifies the location of the local archive dataset.
Reference Data Displays the Reference Data dialog box, which allows you to specify the
reference data compared between the local project and the remote archive dataset.
Submit Batch Job Displays the Batch Job dialog box, which allows you to run the Audit
command immediately or at a specified time.
Before Using This Command
Ensure that the archived data set has been consolidated into a single directory.
Steps:
1. Click Start > Programs > PD_Shell > Audit Tools.
The PDS Reference Data Auditing Tool interface displays.
2. Select a project.
8

Plant Design System (PDS) Reference Data Auditing Tool

PDS Reference Data Auditing Tool

3. Click Audit > Audit Setup > Audit Mode 2.
The Mode 2 Project Vs Local Archive dialog box displays.
4. Select the location of the archive dataset on the local computer.
5. Click Reference Data.
The Select Reference Data for Audit dialog box displays.
6. Select the reference data to compare between the archive dataset and the local project
database.
7. Click OK.
8. Click Submit Batch Job.
The Batch Job dialog box displays.
9. Click Now to submit the batch job immediately, or click Later to set a time for the batch file
transfer to begin.
10. Click Save to save the current configuration.
11. Click Submit.
The batch job is added to the batch queue or scheduled, depending on the selected batch
submission option.

Au d it Mo d e 3
This command compares the model and drawing data in the local project database to the model
and drawing data in a local archive dataset. This command can be used to maintain data integrity
for models and drawings in workshare projects.

Options
Archive Dataset Locations Specifies the location of the local archive dataset.
Submit Batch Job Displays the Batch Job dialog box, which allows you to run the Audit
command immediately or at a specified time.
Before Using This Command
Ensure that the archived dataset has been consolidated into a single directory.
Steps:
1. Click Start > Programs > PD_Shell > Audit Tools.
The PDS Reference Data Auditing Tool interface displays.
2. Select a project.
3. Click Audit > Audit Setup > Audit Mode 3.
The Mode 3 Project Vs Local Archive dialog box displays.
4. Select the location of the archive dataset on the local computer.
5. Click Submit Batch Job.
The Batch Job dialog box displays.
6. Click Now to submit the batch job immediately, or click Later to set a time for the batch file
transfer to begin.
7. Click Save to save the current configuration.

Plant Design System (PDS) Reference Data Auditing Tool

PDS Reference Data Auditing Tool

8. Click Submit.
The batch job is added to the batch queue or scheduled, depending on the selected batch
submission option.

View Menu
The commands on the View menu allow you to access, print, and save Audit Reports and batch
log files.

Commands
Audit Report (on page 10)
View/Analyze Audit Mode 3 Report (on page 10)
Batch Log File (on page 11)

Au d it Re p o rt
This command opens the Audit Report Viewer, which is used to view, save and print the audit
output report generated by the Audit batch job.

Options
Open Audit Report Displays the Open Audit Report File dialog box, which allows you to
select and open a previously generated Audit Report file. Opening an Audit Mode 3 Report
displays the View/Analyze Audit Mode-3 Report dialog box.
Save Audit Report To File Saves the current audit report file.
Print View Content Prints the current contents of the View Audit Report dialog box.
Send A Mail Sends the report to an email recipient as an attachment.
View All Displays a list of the records in both the local and remote dataset.
Record in Local Not in Remote Data Set Displays a list of the records in the local data set,
but not contained in the remote data set.
Record in Both Dataset, But Different Displays a list of the records contained in both the
local and remote data sets whose values are different.
Record in Remote Dataset, Not in Local Dataset Displays a list of the records contained in
the remote dataset, but not in the local dataset.
Filter Reference Data Displays the Reference Data dialog box, which allows you to specify
the reference data displayed in the View Audit Report dialog box.

Vie w/An a lyze Au dit Mo d e 3 Re p o rt

This dialog box displays a report generated using Audit Mode 3. This report contains data for all
models and drawings in the local archive dataset and the active project database.

Options
Drawings/Models list Specifies whether to display models or drawings in the report view.
Conflict Data list Specifies which drawings or models to display in the report view. The
available options are Only In Project, In Conflict, and Only in Archive. The Only In Project
option displays models or drawings that appear in the project, but not in the archive. The In
10

Plant Design System (PDS) Reference Data Auditing Tool

PDS Reference Data Auditing Tool

Conflict option displays models or drawings with conflicting data. The Only In Archive option
displays models or drawings that appear in the archive, but not in the project.
View As HTML Displays the current contents of the Detailed Display of Conflicts as an
HTML file in a Web browser. The report can be printed from the Web browser itself. For reports
displaying models or drawings in conflict, the conflicting attributes, which display in red in the
Detailed Display, appear in a bold typeface for easy identification on a printed report.
Save As HTML Saves the current contents of the Detailed Display of Conflicts to an HTML
file.
Attribute Name A list of model or drawing database attributes. Attributes that are in conflict
display in red. The check box beside the attribute name determines whether the attribute is
displayed as a column in the Detailed Display of Conflicts. To display only the attributes in
conflict, right click in the Attributes to Show/Compare Filter view and click Select Differing
Attributes Only. The displayed attributes list is remembered even in case of a switch between
Models/Drawings.
Project Filter Filters the Detailed Display of Conflicts by attribute value from the project
database. To enter a project filter, select the attribute row, and then click the Project Filter field
in the row. This field is case sensitive.
Archive Filter Filters the Detailed Display of Conflicts by attribute value from the archive
dataset. To enter an archive filter, select the attribute row, and then click the Archive Filter field
in the row. This field is case sensitive. This option is only available in case of In Conflict
Report
Detailed Display of Conflicts This area displays the model or drawing data from the project
database and archive dataset, as specified by the other fields on the dialog box. Model or
drawing data in conflict between the project and archive appear in red. The first column in the
display indicates whether the model or drawing is in the project (P) or archive (A). To change
the order of the attribute columns, select a column title and drag it to the new location. The same
column order is used in the HTML view. Column order is reset with any changes that require a
refresh of columns in the Detailed Display, such as changing the Models/Drawings option, or
adding or removing attributes in the display.
Changes in the data section of the Mode 3 report output file, which begins right after the
Time of Generation line, can generate unpredictable results and should be avoided. However,
you can add text to appear in HTML output by inserting lines into the Mode 3 report file right
before the Time of Generation line. Any new lines of text must be in the following format: Text
: text
For example,
Reason : OffSite data out of sync in Master site.
Action taken : Updated Master site with latest archives from owning satellite sites.

Plant Design System (PDS) Reference Data Auditing Tool

11

PDS Reference Data Auditing Tool

Ba tc h Lo g File
This command allows you to open and print existing batch log files.

Open Log File Displays the Open Log File dialog box, which allows you to select and open
a batch log file.
Print Log File Prints the current batch log file.

Help Menu
The commands on the Help menu allow you to open the Audit Tools Help file and display
information about the Audit Tools utility.

Commands
Contents (on page 12)
About Audit Tools (on page 12)

Co n te n ts
This command opens the Audit Tool utility Help file.

Ab o u t Au d it To o ls
This command displays the About Audit Tools dialog box.

Options
OK Closes the About Audit Tools dialog box.
System Information Displays the Windows System Information dialog box.

Batch Job Dialog Box

This dialog box submits the batch jobs for the File Transfer and Audit commands.
Report File Specifies the location of the audit output report file.
Batch Queue Specifies the batch queue used to run the batch job.
Save Configuration Allows you to save the current configuration file. You must save the
configuration file before submitting the batch job.
View Configuration Displays the current configuration file settings in a read-only dialog box.
Now Submits the batch job as soon as you click the Submit button.
Later Displays the Submit At options, allowing you to specify a date and time to run the batch
job.
Submit Submits the batch job for immediate or delayed processing, depending on the other
options on the dialog box.
Cancel Closes the dialog box without submitting the batch job.
Submit At Specifies the date and time to submit the batch job.

12

Plant Design System (PDS) Reference Data Auditing Tool

Index
A
About Audit Tools 12
Audit Menu 5
Audit Mode 1 7
Audit Mode 2 8
Audit Mode 3 9
Audit Report 10
Audit Tools Interface 3

B
Batch Job Dialog Box 12
Batch Log File 12
Browse FTP Folders 6

PDS Reference Data Auditing Tool Utility

3

S
Save Configuration 5
Save Configuration As 5
Select Reference Data 6

V
View Menu 10
View/Analyze Audit Mode 3 Report 10

C
Contents 12

E
Exit 5

F
File Menu 4
File Transfer 6
FTP Login 5

H
Help Menu 12

I
Introduction 3

N
New Configuration File 4

O
Open Configuration File 4

P
PDS Reference Data Auditing Tool 3

Plant Design System (PDS) Reference Data Auditing Tool

13