IBM Maximo Asset Navigatorpublib.boulder.ibm.com/tividd/td/ITMANav/621_mx... · First Edition (January 2007) This edition applies to version 6, release 2, modification 1of IBM Maximo

Release 6.2.1

System Administration Guide

IBM Maximo Asset Navigator

First Edition (January 2007)This edition applies to version 6, release 2, modification 1of IBM Maximo Asset Navigator and to all subsequent releases and modifications until otherwise indicated in new editions.

Third-Party Technology: Certain Maximo products contain technology provided under license from third parties, as noted in the following table:

Open Source: Maximo contains computer software obtained from the public domain, known as "Open Source" ownership of which is attributed as follows: Portions © 2002, Steve Souza ([email protected]). Portions © 2000-2004, Jason Hunter & Brett McLaughlin. Portions © 2004-2005, The Apache Software Foundation (http://www.apache.org/).

© Copyright International Business Machines Corporation 2007. All rights reserved.

US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

IBM Product Third-Party Information

All Products Portions © 1996-2003 Visual Mining, Inc. Visual Mining™ NetCharts Server provided by Visual Mining, Inc.

IBM Maximo Portions © 1995-2004 Actuate Corporation.

Portions © 2005 BEA Systems, Inc. BEA WebLogic Server® provided by BEA Systems, Inc.

Portions © 1996-2005, i-net software GmbH. J-Integra for COM® v2.4. © 2004 Intrinsyc Software International, Inc.

Maximo Discovery MSDE Copyright © Microsoft® Corporation.

© 1998-2005 Centennial Software Limited.

IBM Maximo Asset Navigator Portions © 1993-2002 Snowbound™ Software Corporation. RasterMaster™ Raster imaging technology provided by Snowbound Software Corporation.

IBM Maximo Mobile Portions © 2005 DataMirror, Inc.

Portions © 2000-2005 Zaval Creative Engineering Group.

IBM Maximo Mobile SE Portions © 1996-2005 Syclo, LLC.

NoteBefore using this information and the product it supports, read the information in “Notices” on page Notices-1.

Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiAudience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiNotation Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiRelated Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viiiSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Chapter 1: Navigator System Administrator Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Starting the System Administration Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Navigator Control Center Main Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Known Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4

Chapter 2: Import Manuals, TOCs, and Index Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1Import Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2How to Import Manuals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4How to Import Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6How to Create the Selection Index Flat File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7How to Import a Selection Index From Flat File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10

Manual Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10TOC Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11Selection Index Log Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11

Import Part Data File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12

Chapter 3: Document Location Maintenance Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Locate A Single Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2Locate All Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4Visual Locate and Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5Update Document Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8

Chapter 4: Edit Selection Index Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1Viewing a Selection Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2File Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3Edit Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4Options Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

Chapter 5: Manual and Part Link Maintenance Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1Select Manual and Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

Delete Document from Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Move Document Within Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Update Document Page Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5Update Document Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5Link New Hotspot to Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5Update Document Hotspots in Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6

Add Part Number to Hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6Modify Quantity of Part Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11Delete Part Number from Hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11Add Common Part to Hotspot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12Modify Common Part Description/Qty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12Delete Common Part from Hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13

© Copyright IBM Corp. 2007 iii

Modify Go To Name of Hotspot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13Delete Go To Hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13Modify Go To Asset Hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14Delete Go To Asset Hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14Modify Go To Location Hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14Delete Go To Location Hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14Delete Entire Hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15Select Next Hotspot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15Display Parts List of Hotspot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-15Change Hotspot Label. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-16

Add, Modify, Delete Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-17View Asset Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19View Location Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20

Chapter 6: Part and Manufacturer Maintenance Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1Set Manufacturer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Add, Modify, Delete Manufacturer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3

Steps to Add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4Steps to Modify or Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4

Add, Modify, Delete Manufacturer Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5Steps to Add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6Steps to Modify or Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6

Supersede Manufacturer Part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7Supersede Internal Part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8Associate Manufacturer Part with Internal Part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10Disassociate Manufacturer Part from Internal Part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12Associate Internal Part with Manufacturer Part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13Disassociate Internal Part from Manufacturer Part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15

Chapter 7: Annotation Maintenance Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1QC Document Repair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

QC Document Repair Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2Image Manipulation Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3How to Add a Touchpoint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3

How to Delete a Touchpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4How to Change a Touchpoint Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4How to Move a Touchpoint Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4

Using the Data Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5Entering Data in the Data Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5

Entering Data Using a Spreadsheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-6Entering Data Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6Entering Data From a Spreadsheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6

Creating BOM/Hotspot Associations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7Using AutoIncrement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7Using Manual Association. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7How to Save and Quit the QC Document Repair Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7

Chapter 8: Edit TOC Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1Viewing a Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2File Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3Edit Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4Options Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7

Add/Edit a TOC Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8

Chapter 9: Security Maintenance Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1Add, Modify, Delete Users Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2

How to Add a User to the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3How to Modify a User's Security Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4

iv IBM Maximo Asset Navigator: System Administration Guide

How to Delete a User from the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5How to Modify Security Levels of Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6

Chapter 10: Show Documents Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1Document Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2Manual Options Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3

Select Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3Attributes Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4

Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4Display Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5

Print Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6Print Full Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6Print Portion of Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6

Chapter 11: Delete Manual Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1Delete a Manual Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2

Chapter 12: Pagenotes Maintenance Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1File Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-2Options Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-2

Show Page Notes for Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-3Show All Page Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4Review New/Modified Page Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4

Pagenote Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5How to Edit Page Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5How to Delete Page Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5How to Review Page Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5

Starting a Review Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-6Editing and Deleting a Page Note . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-7Printing Reviewed Page Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-7Print a Date Range of Page Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-8

Chapter 13: Export Manuals, TOCs, and Index Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1Export Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-2How to Export Manuals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-4How to Export Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-6How to Export a Selection Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-7Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-8

TOC Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-8Manual Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-8Selection Index Log Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-9

Chapter 14: Part Data Synchronization Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-1Setting Up for PDS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-3

Customer ASCII Parts File Layout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-3Navigator/Customer Manufacturer Code Cross Reference File Layout . . . . . . . . . . . . . . . . . . . . . . 14-4PDS PUP.INI File Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-5

Part Data Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-5Purging Part Numbers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9

Purge All Unlinked Manufacturer Part Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-9Purge Customer Part Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-10

Manufacturer Cross Reference Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-11Create Manufacturer Cross Reference File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-11Purge Manufacturer Cross Reference Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-12Create Manufacturer Cross Reference Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-12

Creating a Filtered Manufacturer Parts Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-14Create Filtered Manufacturer Parts Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-14

Running the Part Data Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-15

Contents v

Managing Large Changes to Oracle Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-16Understanding PDS Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-17

Report 10—New Internal Part Associations Made . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-17Report 20—No Xref Customer Manufacturer Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-18Report 25—Matched One Manufacturer Part and Code Exactly . . . . . . . . . . . . . . . . . . . . . . . . . . 14-18Report 30—Matched One Filtered Manufacturer Part and Code. . . . . . . . . . . . . . . . . . . . . . . . . . 14-19Report 40—Matched Multiple Filtered Manufacturer Parts and Code . . . . . . . . . . . . . . . . . . . . . 14-19Report 50—Matched Manufacturer Part(s) Only/No Associated Navigator Internal Part . . . . . . 14-20Report 52—Matched Manufacturer Part(s) Only/Same Associated Navigator Internal Part. . . . 14-21Report 54—Matched Manufacturer Part(s) Only/Different Associated Navigator Internal Part. 14-22Report 60—Duplicate Internal Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-23Report 70—Unmatched Customer Manufacturer Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-24

Chapter 15: Maximo Upload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1Running the Maximo Upload Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1Maximo Upload Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-8Restarting Maximo Upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-10

Appendix A: Data Synchronization Stored Procedures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1Database Table Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2

Configuration Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2Error Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4Report Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4

Oracle Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-5MM2UpdateInternalPartExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-5MM2DeleteInternalPartExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-6MM2AssocInternalAndOEMPartExt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7MM2AssocInternalAndOemPartNC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-9MM2DisassocOEMandInternalExt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-10MM2IsValidAssetNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11MM2AssocIPartToPsuedo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-12MM2DisassocIPartFromPsuedo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-13MM2UpdateInternalPartQty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-14MM2AddAsset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-15MM2DeleteAsset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-16

Appendix B: INI Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1Configurable Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

CUST.INI File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1IPCSYS.INI File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

File List and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-8CUST.INI File Sections and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-8IPCEXP.INI File Section and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-8IPCIMP.INI File Section and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-8IPCINTRL.INI File Application and Key Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-8IPCMAINT.INI File Application and Key Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-9VIEWERS.INI File Sections and Parameters (EXAMPLES) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-9IPCSYS.INI File Sections and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-9IPCWS.INI File Sections and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-11

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Notices-1

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-1

vi IBM Maximo Asset Navigator: System Administration Guide

About This Guide

This section explains how this guide can help you to use IBM® Maximo® Asset Navigator. It also provides information on other IBM Corporation resources available to you, such as additional documentation and support.

Audience

If you are a Navigator customer, read this guide for information on how to use Navigator.

Notation Conventions

This guide uses the following typographical conventions:

Bold type indicates elements of the user interface (display) including the following elements:! Buttons! Field names

Italic type is used to indicate documentation titles, and for emphasis.

This guide uses the following terms:

“Navigator” is the new name for this application. Previously, Navigator was known as “Illustrated Parts Catalog (IPC).” Some parts of the administrative tools still refer to the application as IPC.

Touchpoint/Hotspot. These terms mean the same thing. A touchpoint or a hotspot is a callout or reference on an illustration where you can click to select a part. The applications of the System Administrator generally refer to them as “touchpoints.” The Navigator application refers to them as “hotspots.”

Internal Part Number/Item Number. These terms mean the same thing.

System Administrator Application/System Administrator Utility. These terms mean the same thing.

© Copyright IBM Corp. 2007 vii

Related Documentation

Related Documentation

For more information about Maximo and the Navigator application, refer to the following documentation:

Document Description

IBM Maximo Navigator Installation Guide for Microsoft® SQL Server

Describes how to install and setup the Navigator application on a Maximo system using a Microsoft SQL Server database.

IBM Maximo Navigator Installation Guide for Oracle®

Describes how to install and setup the Navigator application on a Maximo system using an Oracle database.

IBM Maximo Asset Navigator Online Help

Is the primary source of information for using the Navigator application.

IBM Maximo Finance Manager’s Guide

Describes Maximo’s financial transactions and how to set up general ledger accounts.

IBM Maximo Installation Guide Describes how to install and configure the following software:

Application serverIBM Maximo

Actuate®

IBM Maximo Multisite Administrator’s Guide

Describes how to configure Maximo for a Multisite implementation.

IBM Maximo Online Help Provides step-by-step procedures for Maximo applications.

IBM Maximo Reconciliation Module Implementation Guide

Describes how to use the Maximo Reconciliation module to reconcile the two types of information that Maximo maintains about information technology (IT) assets: IT asset data and deployed asset data.

IBM Maximo Report Administration and Development Guide

Describes how to design and administer Maximo reports using Actuate.

IBM Maximo System Administrator’s Guide

Describes database configuration, security, and other administrative level applications and tasks.

IBM Maximo User’s Guide Provides an overview of the Maximo end user applications, and describes how the Maximo applications interact with each other.

viii IBM Maximo Asset Navigator: System Administration Guide

Support

Support

IBM Corporation users with a valid Annual Customer Support Plan (ACSP) can obtain product support online at Support Online: support.mro.com.

Support Online includes information about product releases, software patches, and documentation updates. To find the most current version of a document, refer to the Knowledge Base on this site.

IBM Maximo Workflow Implementation Guide

Provides information about using IBM Maximo to plan, design, build, test, implement, and manage Workflow processes.

IBM Maximo Enterprise Adapter (MEA) System Administrator's Guide

Describes how to configure and use the IBM MEA.

Document Description

About This Guide ix

http://support.mro.com

Support

x IBM Maximo Asset Navigator: System Administration Guide

The Navigator Control Center is where you access the various applications necessary to edit and maintain the Navigator application option for IBM Maximo. The Control Center has one main window from which Navigator applications can be started.

Starting the System Administration Tools

To start the Control Center application, complete the following steps:

1 Start the Control Center by double-clicking the Navigator Admin shortcut on the desktop.

NOTE If a Control Center shortcut was installed on the Start menu, you can click the Windows® Start button, and then click Navigator Admin.

2 On the main window, start an application by doing one of the following:

Click a function button.

Select an application from the Options menu.

3 In the security dialog box, enter your User ID and password, and click OK. The application launches.

NOTE Some applications run outside of the Control Center (PUP and IBM Maximo Upload) and do not require a User ID and password.

4 See the following chapters in this manual for using the Control Center’s applications.

Navigator Control Center Main Screen

The Control Center window contains a menu bar and function buttons.

Menu Bar The menu bar contains the following:

File — The only File command is Exit. See the Exit! menu below for a description.

Options — The Options commands are the same as the function buttons, which are described in subsequent chapters.

Navigator System Administrator Overview 1

© Copyright IBM Corp. 2007 1-1


! Import Manuals, TOCs, and Index! Document Location Maintenance! Edit Selection Index! Manual and Part Link Maintenance! Part and Manufacturer Maintenance! Annotation Maintenance! Edit Table of Contents! Security Maintenance! Show Documents! Delete Manual! Page Notes Maintenance! Export Manuals, TOCs, and Index! PUP! Maximo Upload

Exit! — A command that lets you quit the Control Center application.

Help — contains the following commands! Contents — Click to start the online help for this application.! How to Use Help — Click to start a general tutorial for how to use

online help.! About — Click to display a dialog box with technical and legal

information about the application. The About dialog box has a System Info button. Click System Info to display the Navigator System Info dialog box. It contains INI file locations and database schema and connect string information.

Main Page Buttons The main page has the following buttons:

Add/Create New Manual/Pages

This option allows a new manual, or a new page in an existing manual, to be created in an automated process by combining existing functionality to locate document(s), create part data, identify hotspot coordinates and create hotspot labels. This activity will predominantly take place within the Annotation Module.

A new option will be available to allow the manufacturer part data to be created externally in a standard spreadsheet which can then be imported into the Annotation Module in order to facilitate the automated association of part data to hotspots.

Add/Create Hotspots/BOM

This option presents the Select Manual/Document screen within the current Annotation Maintenance module.

Once the manual/document are identified, an option is available to allow the manufacturer part data to be created externally in a standard spreadsheet which can then be imported into the Annotation Module in order to facilitate the automated association of part data to hotspots.

Modify Hotspot Labels

This option presents the Select Manual/Document screen within the current Annotation Maintenance module. Once the manual/document are identified, existing functionality allows for manipulation of hotspot information (e.g. add, modify, delete, move) on a single existing document.

1-2 IBM Maximo Asset Navigator: System Administration Guide


Modify Part Number on Page

This option presents the Select Manual/Document screen within the current Manual and Part Link Maintenance module. Once the manual/document are identified the system automatically moves you to the available hotspot list (“Update Document Touchpoints in Manual”), where existing functionality allows for the selection of a hotspot, followed by manipulation of parts information (e.g. add, delete, change part type, etc.) on a single existing document.

Modify Manufacturer Part Description

This option opens the Set Manufacturer screen within the Part and Manufacturer Maintenance module. When a manufacturer is identified, the system moves your to the Add/Modify/Delete Manufacturer Parts option where existing functionality is utilized to modify manufacturer part descriptions.

Modify Quantity

This option presents the Select Manual/Document screen within the current Manual and Part Link Maintenance module. When the manual/document are identified, the system automatically moves your to the available hotspot list (“Update Document Touchpoints in Manual” list) where existing functionality allows for the selection of a hotspot and then a part number, followed by manipulation of the assigned quantity on a single existing document.

Modify Page Sequence

This option presents the Select Manual/Document screen within the current Manual and Part Link Maintenance module. When the manual/document are identified, the system automatically moves your to the dialog for the “Move Document within Manual” where existing functionality allows for the movement of the selected document within the selected manual.

Delete Manual

This option automatically opens the Delete Manual window within the Delete Manual module. When the manual name is identified, existing functionality is utilized to complete the intended deletion activity.

Delete Page in Manual

This option presents the Select Manual screen within the current Visual Locate and Link module which is contained within Document Location Maintenance. When the manual is identified, existing functionality allows for the deletion of the selected documents from the manual.

Navigator System Administrator Overview 1-3

Known Issues

Known Issues

The following are file formats currently allowed to be imported into this version of Navigator: BMP, JPG, and TIF.

The Visual Locate and Link window in the Document Location Maintenance application has a File menu selection, Enter Page Number for Selected Documents. This selection does not work in the current version of the application.

If the IBM Maximo Upload application is terminated prematurely, the data synchronization between Navigator and IBM Maximo will be left in a disabled state. Re-enabling it is a manual process involving using an SQL utility to set the Navigator table.column DataSyncConfig as follows: Update DataSyncConfig Set VALUE = YES where upper(ParamName) = AUTOSYNC


The Import Manuals, TOCs and Index application lets you import data from a flat file to a target database. For each option, Import Manuals, Table of Contents (TOCs), and Selection Index also creates a log file that contains key information regarding the option (for example, manual summary totals).

NOTE Selection Indexes and TOCs are not updated during the Import Manuals process.

Terminology Flat File — Files where data is stored. They are created by the Export Manuals, TOCs and Index application. See “Export Manuals, TOCs, and Index Application” on page 1.! Flat files that store manual data have a file name extension of .mld.

After manual flat files are imported, the file name extension is changed to .dxx.

! Flat files that store TOC data have a file name extension of .ftc. After TOC flat files are imported, the file name extension is changed to .txx.

! Flat files that store selection index data have a file name extension of .idx. After selection index flat files are imported, the file name extension is changed to .ixx.

NOTE The extensions change to prevent reprocessing flat files.

Source Database — The source of the information or data that is to be stored in the import flat files. Generally, this is the NavigatorNavigator database.

Target Database — This is the database that receives the information or data that has been stored in the import flat files.

Main Screen Overview The Import Manuals, TOCs and Index window contains a menu bar and function buttons. The menu bar contains the following:


Options — The Options commands are the same as the function buttons, which are described in this chapter.! Setup! Import Manuals! Import Table of Contents! Import Selection Index! Exit

Exit! — A command that lets you quit the application and return to the Control Center window.

Import Manuals, TOCs, and Index Application 2


Import Setup



information about the application.

Import Setup

The Setup command lets you view and modify paths for the Import functions. After you select Setup from the Options menu or click Options, the Import INI File Settings dialog box opens.

Import INI File Settings Dialog Box

TOC flat file path — Displays the path for the TOC flat file

TOC Log File Path — Displays the path for the log file generated when importing a TOC.

Manual Flat File Path — Displays the path for the Manual flat file.

Manual Log File Path — Displays the path for the log file generated when importing a manual.

Selection Index flat file path — Displays the path for the Selection Index flat file.

Selection Index Log File Path — Displays the path for the log file generated when importing a Selection Index.

Part File Path — Displays the path of the Part file.

Enter New File Path — Allow you to enter new paths for the selected flat file, log file, or part file.


Import Setup

Undo Changes — Cancels all changes that you made upon opening the Import INI File Settings window.

Save to INI — Replaces the parameters in the appropriate INI file with the paths displayed in the Import INI File Settings window.

Reset from INI — Replaces the displayed paths with the parameters set in the appropriate INI file.

OK — Saves any changes you made to the paths and closes the window.

Steps To make path changes to the TOC log file, the Manual flat file, the Manual log file, and/or the Part file, complete the following steps:

1 On the Options menu, click Setup.

2 Click Enter New File Path for the needed file path.

3 Select a new path from the Drives drop-down list and click OK.

4 Repeat steps 2 and 3 for each file path you want to change.

5 Click OK to save the changes and close the dialog box.

Import Manuals, TOCs, and Index Application 2-3

How to Import Manuals


The Import Manuals command lets you select manuals to import. This command is active only after the Select Flat File Path has been setup. Flat files that store manual data have a file name extension of .mld. After a manual flat file is imported, the file name extension is changed to .dxx.

After you select Import Manuals from the Options menu or click Import Manuals, the Import Manuals dialog box opens:

Import Manuals Dialog Box

Manuals Available — Displays the manuals currently stored in the designated flat file path. Each entry in the field acts as a toggle switch. Click a name once and it appears in the Manuals Selected field; click the name again and it is removed from the Manuals Selected field.

Manuals Selected — Displays the manuals selected to be imported from the flat files.

Select All Manuals — When selected, all of the manual entries in the Manuals Available field appear in the Manuals Selected field. When cleared, the Manuals Selected field is cleared.

OK — Click to import selected manuals to the designated target database. While importing, the window displays the full path and name of the log file, the name of the manual being processed, and the number of the manual out of the total number of manuals being processed (for example, 1 of 4).

NOTE To retrieve the log file, see the “Log Files” on page 10.



Clear — Clears the Manuals Selected field.

Cancel — Closes the dialog field without changes.

Steps To import manuals, complete the following steps:

1 On the Options menu, point to Import and click Manuals.

2 From the Manuals Available field, select the manuals to be imported. Or to import all of the manuals listed, select the Select All Manuals field.

3 Click OK. Selected manuals are imported to the designated target database. While importing, the window displays the full path and name of the log file, the name of the manual being processed, and the number of the manual out of the total number of manuals being processed (for example, 1 of 4). When the import is complete, a message box opens stating how many manuals were successfully imported.

4 Click OK. If any errors occurred during the import, another message box opens stating this and asking you to check your log file.


Managing Large Changes to Oracle Databases

The SQL script listed here (analyzeonly_schema.sql) computes statistics on the entire schema instead of table by table. Note that the script does not need to be updated when tables are added or dropped.

The script should be run whenever there is a large change to the database, such as importing manuals. This increases the efficiency of any Oracle operations used by Navigator. Use Oracle’s SQL*Plus® utility to run the script. Before running it, change the “IPC” in the script to the applicable schema name.

SET SERVEROUTPUT ONBEGIN DBMS_OUTPUT.ENABLE(2000000);dbms_utility.analyze_schema('IPC','compute');END;/


How to Import Table of Contents

How to Import Table of Contents

The Import TOCs command lets you select a manual’s tables of contents to import. This command is active only after the Select Flat File Path has been setup. Flat files that store TOC data have a file name extension of .FTC. After a TOC flat file is imported, the file name extension is changed to .TXX.

After you select Import Table of Contents from the Options menu or click Import Table of Contents, the Import TOCs dialog box opens:

Import TOCs Dialog Box

TOCs Available — Displays the manuals with TOCs currently stored in the designated flat file path. Each entry in the field acts as a toggle switch. Click a name once and it appears in the TOC Selected field; click the name again and it is removed from the TOC Selected field.

TOCs Selected — Displays the TOCs selected to be imported from the flat files.

Select All TOCs — When selected, all of the TOC entries in the TOC Available field appear in the TOC Selected field. When cleared, the TOC Selected field is cleared.

OK — Click to import selected TOCs to the designated target database. While importing, the window displays the full path and name of the log file, the name of the TOC being processed, and the number of the TOC out of the total number of TOCs being processed (for example, 1 of 4).


Clear — Clears the TOCs Selected field.


How to Create the Selection Index Flat File

Cancel — Closes the dialog box without changes.

Steps To import tables of contents, complete the following steps:

1 On the Options menu, point to Import and click Table of Contents.

2 From the TOCs Available field, select the TOCs to be imported. Or to import all of the TOCs listed, select the Select All TOCs field.

3 Click OK. Selected TOCs are imported to the designated target database. While importing, the window displays the full path and name of the log file, the name of the TOC being processed, and the number of the TOC out of the total number of TOCs being processed (for example, 1 of 4). When the import is complete, a message box opens stating how many TOCs were successfully imported.



How to Create the Selection Index Flat File

A Selection Index Import Flat File is a standard text file. It can be created with a standard ASCII text editor. (The flat file name extension must be .idx. After it is imported, the file name extension changes to .ixx.) Each line of the file is the complete index path (including descriptions) to a manual or document. The following is an example of the format for an index path:

Name|Level1 Desc1[;Level1 Desc2]|Level2 Desc1

Name — the name of the manual for the path being described.

Leveln Desc1 — the first line of the index entry description.

Leveln Desc2 — the second line of the index entry description.

[ ] — indicates optional fields.

| — marks the end of an index level and the beginning of a new index level. This character may be changed in the IPCSYS.INI file.

; — marks the end of the first line of an index level description and the beginning of the second line of an index level description. This character may be changed in the IPCSYS.INI file.

Inserting a “return” ends the index line (<CR><LF>).

Example PC0001|MANUFACTURER|ACMEPC0001|PROCESS|LINE|12345JB0009|MANUFACTURER|JOHNSON BROWNJB0009|ASSET NUMBER|4752JB0009|LINE|JB-786678;LABELS


How to Import a Selection Index From Flat File


The Import Selection Index From Flat File command lets you select a selection index to import. This command is active only after the Select Flat File Path has been setup. Flat files that store the selection index data must have a file name extension of .idx.

After you select Import Selection Index from the Options menu or click Import Selection Index, the Import Selection Index dialog box opens:

Import Selection Index Dialog Box

Indices Available — Displays a list of the existing selection indices available to import. Each entry in the field acts as a toggle switch. Click a name once and it appears in the Indices Selected field; click the name again and it is removed from the Indices Selected field.

Indices Selected — Displays the indices selected to be imported from the flat files.

Select All Indices — When selected, all of the index entries in the Indices Available field appear in the Indices Selected field. When cleared, the Indices Selected field is cleared.

OK — Click to import selected indices to the designated target database. While importing, the window displays the full path and name of the log file, the name of the index being processed, and the number of the index out of the total number of indices being processed (for example, 1 of 4).


Clear — Clears the Indices Selected field.




While importing a Selection Index the following information is displayed:

The name of the selection index flat file being imported.

The number of lines in the file.

The current line number being processed.

After the file is imported, a message opens stating the following items:

The number of lines processed.

The number of errors encountered during the import process.

The success or failure of the import process.

Steps To import a selection index, complete the following steps:

1 On the Options menu, point to Import and click Select Index.

2 From the Indices Available field, select the indices to be imported. Or to import all of the indices listed, select the Select All Indices field.

3 Click OK. Selected indices are imported to the designated target database. While importing, the window displays the full path and name of the log file, the name of the index being processed, and the number of the index out of the total number of indices being processed (for example, 1 of 4). When the import is complete, a message box opens stating how many indices were successfully imported.




Log Files

Log Files

Log files are created during the import processes so that you can monitor the processes. The log files are stored in a path designated in the IPCSYS.INI file and can be viewed through any type of text editing application. Note the following:

If the manual import has no errors, the file that gets generated has an “.iml” extension.

If the manual import has errors, the file that gets generated has an “.err” extension.

Manual Log Files

One log file is created for each manual that is imported. The log files are stored at the path determined in the Setup function. Each log displays the following information:

the type of import process

the day, date, time, and year

the manual name

the number of pages

the number of parts

the number of touchpoints

a list of the total number of manuals, pages, parts, and touchpoints processed

any errors that occurred

any messages

Example The following is an example of a log file created while importing manual BJ0001.

Importing Manuals Mon Nov 29 08:35:28 1999Importing Manual BJ0001 3 Pages 3 Parts 2 Touchpoints

Final Totals 1 Manuals 3 Pages 3 Parts 2 Touchpoints


Log Files

TOC Log Files

One log file is created for each TOC that is imported. The log files are stored at the path determined in the Setup function. Each log displays the following information:

the type of import process


the manual name

the number of records written (1 record = 1 TOC entry of any level)

the number of manuals successfully processed


any messages

Example The following is an example of a log file created while importing the table of contents for manual BJ0001.

Importing Single Manual TOCs Mon Nov 29 08:35:28 1999Importing Manual BJ0001 1 Records Written1 Manuals imported

Selection Index Log Files

One log file is created for the import process, and it includes data regarding the selection index imported. The log files are stored at the path determined in the Setup function. This log displays the following information:


the path and filename of the selection index processed

the total number of lines in the selection index successfully processed


any messages

Example The following is an example of a log file created while importing the selection index SEL18.IDX.

Mon Nov 29 08:35:28 1999

Importing Selection Index from File 'C:\AllenBaker\SELECT~1\Sel18.IDX'.

Total Lines = 97


Import Part Data File

Import Part Data File

The Import Part Data File is an ASCII file that stores information regarding all of the manufacturer parts that were added to a target database as a result of an import process. (Manufacturer parts associated with an imported manual that are not in the target database prior to the import process are added at the time of import.) The Import Part Data File is for use with CMMS systems.

Import Part Data Files are stored in a path designated in the IPCSYS.INI file. An Import Part Data File file name is in the following form:

XXXXXXXX.fip

where XXXXXXXX is the same name as the log file name. Whether this file is created is specified in the [IMPORT] section of the MM2SYS.INI file. This file may also be specified to store customer parts instead of manufacturer parts.


The Document Location Maintenance application creates a table of direct pointers to documents in manuals within Navigator. These direct pointers are the directory paths that allow users to view documents. This function must be used during initial installation of the system and whenever new pages are added to a manual (new or existing).

Main Screen Overview The Document Location Maintenance window contains a menu bar and function buttons. The menu bar contains the following:


Options — The Options commands are the same as the function buttons, which are described in this chapter.! Locate a Single Manual! Locate All Documents! Visual Locate and Link! Update Document Locations

Exit! — A command that lets you exit the current level of the application and return to the previous level. If you are at the main window, the Exit function quits the application and returns to the Control Center window.




Document Location Maintenance Application 3


Locate A Single Manual


The Locate A Single Manual function lets you locate a single manual. This function should be used when creating a new manual or updating an existing manual.

NOTE Use this function only when all documents in the manual have a five numerical-character sequential format (for example, 00001.tif, 00002.bmp...).

After you select Locating a Single Manual from the Options menu or click Locating a Single Manual, the Locate Documents of Manual dialog box opens:

Locate Documents of Manual Dialog Box

Select Manual to Locate — Where you select the manual name. The files in this list are in the directory identified by the first key under [cuslist] in the INI file specified by the imageloc environmental variable.


OK — Accepts the manual name selected in the Select Manual to Locate field and starts the locating process. If a manual name was not selected, a message box opens indicating that you must select a manual.

Steps To locate a single manual, complete the following steps:

1 On the Options menu, click Locating a Single Manual.

2 From the Select Manual to Locate field, select a manual.

NOTE Manuals only appear on the list after they have been created using the Manual and Part Link Maintenance application or the Visual Locate and Link application.



3 Click OK. The locating process begins, and the Locate Documents Data message box opens.

Document Count — The running total of the number of documents in the manual.

New Document — The running total of the number of new documents that have been added to the manual.

Update Document — The running total of the number of documents that have been updated in the manual.

Cancel — Cancels the locating process.

4 After the manual is located, another message box opens. Click OK to close the box.

Customer — The person or department who originally imported the manual.

Total — The number of documents in the manual.

Added — The number of new documents added to the manual.

Modified — The number of updated documents in the manual.

# of Errors logged — These can be found under the filename hasherr.log. The location of this log is determined by the WSINI environmental variable. You can view this log file with Notepad or another text editor.

Document Location Maintenance Application 3-3

Locate All Documents

Locate All Documents

The Locate All Documents function lets you locate all of the manuals in the database.

NOTE Use this function only when all documents in the manuals have a five numerical-character sequential format (for example, 00001.tif, 00002.bmp...).

Steps To locate all of the manuals in the database, complete the following steps:

1 On the Options menu, click Locate All Documents. The locating process begins, and the Locate Documents Data message box opens.

Document Count — The running total of the number of documents in the manuals.

New Documents — The running total of the number of new documents that have been added to the manuals.

Update Documents — The running total of the number of documents that have been updated in the manuals.

Cancel — Cancels the locating process.

2 After the manuals are located, another message box opens. Click OK to close the message box.

Customer — The person or department who originally imported the manual.

Total — The number of documents in the manuals.

Added — The number of new documents added to the manuals.

Modified — The number of updated documents in the manuals.

# of Errors logged — These can be found under the filename hasherr.log. The location of this log is determined by the WSINI environmental variable. You can view this log file with Notepad or another text editor.


Visual Locate and Link


The Visual Locate and Link function lets you locate and link files from their native directories into Navigator manuals. You can select documents for a manual and decide the sequence of the documents. This function handles raster files (BMP, JPG, and TIF) and the ability to assign optional page numbers.

Use this function to control where documents are stored and how the files are named. There are three main parts to Visual Locate and Link: selecting the files, grouping the files, and establishing their sequence.

After you select Visual Locate and Link from the Options menu or click Visual Locate and Link, the Select Manual dialog box opens:

Select Manual Dialog Box

Select Manual — Where you select the manual to which you want to add visually located and linked documents. Click the arrow to display a list of the available manuals. You can select the manual from this list or you type a manual name. The first four characters of the manual name must represent an existing manufacturer.

OK — Accepts the manual name selected in the Select Manual field and displays the Visual Locate and Link window.


Steps To select a manual for visual locating and linking, complete the following steps:

1 On the Options menu, click Visual Locate and Link.

2 From the Select Manual field, select a manual or type a manual name.

3 Click OK. The Select File — Locate and Link dialog box opens.



Visual Locate and Link Screen

The Visual Locate and Link window contains the Visual Locate and Link menu bar and the Select Files — Locate and Link window.

The menu bar contains the following items:

File — Along with the Exit function, this menu contains the following menu item:! Enter Page Number for Selected Documents — Not applicable

at this time.! Exit — This quits the Visual Locate and Link function and returns

to the Document Location Maintenance window.

Edit — This contains two menu items! Cut — This removes the currently selected text and saves it to a

buffer (usually the clipboard).! Paste — This inserts next to the cursor the text from the previous

“Cut.” You can only paste into the Select Files — Locate and Link dialog box.

Exit! — This quits the Visual Locate and Link function and returns to the Document Location Maintenance window.

The Select Files – Locate and Link dialog box is used to display all of the documents to be grouped in a manual. This is where you can add or remove files and move files to establish the sequence of documents. This window contains the following items:



Grouped Files — Lists all of the selected documents to locate and link for the current manual. You can add, remove, or reorder files.

Select All Files — Click to select all of the files in the Grouped Files field.

OK — Updates the locations of the new documents and links them in the order they appear in the Grouped Files field.

Clear — Clears all of the currently selected files in the Grouped Files field.

Cancel — Returns the Grouped Files list to its original state — empty for a new manual, the original selections for an existing manual.

Add More Files — displays an Open window that lets you select one or more documents to add to the grouped files.

4 To visually locate and link files to select and group the files, complete the following steps:

a Select Add More Files. The Open dialog box opens.

b Select the drive and directory using the Look in field.

c Select the file type from the Types of Files field.

d Type in the file name of the file you want to select, or select files from the Look in field. Select up to 20 files. To select more than one file in a sequence, hold SHIFT as you select the first and last files in the sequence. To select more than one file not in a sequence, hold CTRL as you select the files.

e Click OK. The file(s) are listed in the Grouped Files field.

5 To sequence the files in the order you want, complete the following steps:

a Decide the order of the files. Generally, this is the order they appear in the actual manual.

b Use the Cut and Paste functions to arrange the files in the Grouped Files field.

6 Click OK.


Update Document Locations

Update Document Locations

The Update Document Locations function lets you relocate manuals from one root path to another.

After you select Update Document Locations from the Options menu or click Update Document Locations, the Update Document Locations dialog box opens:

Update Document Locations Dialog Box

Root Path area — Lists the root path(s) of the document location(s).

Relocate — Opens the Browse for Folder dialog box. This dialog box is similar to the Windows® Explorer application. It displays drives, directories, and files in a “tree” list. See the Windows online help for more information.

Exit — Closes the dialog box.

Steps To update document locations, complete the following steps:

1 On the Options menu, click Update Document Locations.

2 Select the root directory of the documents you want to relocate.

3 Click Relocate. The Browse for Folder dialog box opens.

4 Select the path where you want to relocate the documents.

5 Click OK.

6 Click Yes to confirm the relocation.

7 When relocation is complete, click OK.


The Edit Selection Index application lets you edit the Navigator Selection Index. You can rearrange an index, assign new descriptions or change them, and print the entire index or a portion of it.

The Edit Selection Index window contains a menu bar and the window is split into two panes: left and right. The menu bar contains the following:

File — See “File Functions” on page 3.

Edit — See “Edit Functions” on page 4.

Options — See “Options Functions” on page 7.





Edit Selection Index Application 4


Viewing a Selection Index

Viewing a Selection Index

The Selection Index is displayed in the left pane. It is displayed in a hierarchical fashion to indicate the levels of the index and what items are included in each level.

The top level of the Selection Index is Navigator’s first window of the Selection Index. All of the items in the next level are beneath the item at the second level. Each entry in the second level can then hold additional entries at a third level, and so on. An entry that contains hidden entries at the next level is indicated by a “plus” symbol. If all of the entries are displayed below an entry, a “minus” sign appears beside the entry.

The right pane displays information for the entry selected (selected) in the left pane. Buttons are displayed at the top of this pane. These buttons “label” the entry information. Clicking a button opens a dialog box to edit the entry’s information.

The Edit Selection Index application contains the following buttons:

Description 1 — Shows the first line of the selection index entry’s label.

Description 2 — Shows the second line of the selection index entry’s label.

Manual — Shows the name of the selected manual. This is empty if the entry does not directly open a document.

Document — Shows the document within the manual that is opened from this entry. This is empty if the entry does not directly open a document.

Example of Viewing a Selection Index


File Functions

File Functions

File menu functions are for printing and quitting the application.

Print All — Prints the entire Selection Index. The printout includes a title that shows the name of the index and the type of print, “Entire Index.” The printout also shows the day, date, time, and year that it was printed.

To print an entire Selection Index, click Print All on the File menu or press CTRL+P. (You may need to select a printer.) A dialog box opens indicating that the entire index is printing and where it is printing. To cancel the print, click Cancel.

Print Subtree — Prints a portion of the Selection Index. A “subtree” is an entry and all of the entries within it. The printout includes a title that shows the name of the index and the type of print, “Portion Selected.” The printout also shows the day, date, time, and year that it was printed.

To print a subtree, complete the following steps:

1 Select the entry at the highest level of the subtree you want to print.

2 Click Print Subtree on the File menu or press CTRL+T. (You may have to select a printer.) A dialog box opens indicating that a page of the index is printing and where it is printing. To cancel the print, click Cancel.

Exit — Quits the application and returns to the main menu window. If you are exiting a Selection Index that you have modified, the system checks it for errors. If it finds an error, the index entry with the error is selected. You must correct the error before quitting.

To quit the Edit Selection Index application, click Exit on the File menu, click the Exit! menu, or press ESC.

Edit Selection Index Application 4-3

Edit Functions

Edit Functions

Edit functions are for editing the structure of the Selection Index and the entry information.

Edit Cur. Entry — The Edit Current Entry function opens a dialog box that lets you edit the selected entry’s information. See “Options Functions” on page 7.

Cut Tree — The Cut Tree function removes the selected entry and all of the entries within it and stores it in the clipboard until something else is either cut or copied to the clipboard.

To cut an entry and its contents, complete the following steps:

1 Select the entry at the highest level of the tree you want to cut.

2 On the Edit menu, click Cut Tree or press CTRL+X.

Copy Entry — The Copy Entry function copies the selected entry and stores it in the clipboard until something else is either cut or copied to the clipboard.

To copy an entry, complete the following steps:

1 Select the entry you want to copy.

2 On the Edit menu, click Cut Entry or press CTRL+N.

Copy Tree — The Copy Tree function copies the selected entry and all of the entries within it, and stores it in the clipboard until something else is either cut or copied to the clipboard.

To copy an entry and its contents, complete the following steps:

1 Select the entry at the highest level of the tree you want to copy.

2 On the Edit menu, click Cut Tree or press CTRL+C.

Paste After — The Paste After function places the information in the clipboard into the Selection Index after (or within) the currently selected entry. Be sure the contents in the clipboard are what you want to paste!

To paste the contents of the clipboard into the Selection Index, complete the following steps:

1 Select the entry you want to paste into.

2 On the Edit menu, click Paste After or press CTRL+V.

Delete Tree — The Delete Tree function removes the selected entry and all of the entries within it but does not store it in the clipboard. This function cannot be undone!

To delete an entry and its contents, complete the following steps:


Edit Functions


2 On the Edit menu, click Delete Tree or press CTRL+D.

Find — The Find function locates contents within entry labels (descriptions), manual names, or page names that match a specific character string. This function begins its search at the currently selected entry and continues with its search until it reaches the last entry of the currently displayed index.

The Find function can search for all entry contents that match a specific character string or it can search for entry contents that are case specific to the character string. Case specific means that all of the characters within the character string must match the upper-case letters (capitals) and lower-case letters exactly.

Once the Find function is selected, a dialog box opens where you enter search information. Use the TAB key to move to each item in the dialog box. This dialog box contains the following items:

! Find — Type the character string that you want to locate.

! Search — Select the type of entry information: labels, manuals, or pages.

! Case Sensitive — Choose whether to make your search case sensitive. If selected, the search is case sensitive. If the field is cleared, the search is not case sensitive.

! OK — Starts the search and finds the next entry field that contains a match with the character string and selects the matching character string.

! Cancel — Cancels the search for the character string and closes the dialog box.

To find a character string, complete the following steps:

1 Select the entry where you want to start your search.

2 On the Edit menu, click Find or press CTRL+F. A dialog box opens.

3 Enter the character string you want to find. If you want to make your search case sensitive, select the Case Sensitive check box.

4 Select a search button.

5 Click OK. The first character string to match is selected. If there is no match, the right message bar shows “String not found.”

Find Next — The Find Next function finds the next entry that contains a match with the character string previously entered for the Find function. It then selects the matching character string.

To find the next occurrence of a previously entered character string, on the Edit menu, click Find Next or press CTRL+G.


Edit Functions

Replace — The Replace function locates a character string and replace it with a new character string. This function begins its search at the currently selected entry and continues with its search until it reaches the last entry of the currently displayed index.

Once the Replace function is selected, a dialog box opens. Use the TAB key to move to each item in the dialog box. This dialog box contains the following items:


! Replace — Type the character string that will replace the old character string.


! OK — Starts the search for the “Find” character string.


To replace a character string, complete the following steps:


2 On the Edit menu, click Replace or press CTRL+R. A dialog box opens.

3 In the Find field, type the character string you want to find.

4 Press TAB.

5 Enter the character string you want to use to replace the one found.

6 Select a search button.

7 Click OK. If there is a match, the Find and Replace Query dialog box opens.

8 Select one of the following Find and Replace Query buttons.

Replace/Next — Replaces the currently selected character string with the new character string and locates and selects the next occurrence of the old character string.

Replace All — Replaces all occurrences of the old character string with the new character string.

Next — Does not replace the currently selected character string and locates and selects the next occurrence of the old character string.

Cancel — Cancel the Replace function and closes the Find and Replace Query dialog box.


Options Functions

9 At the end of a Replace function, a dialog box lists the number of successful replacements and the number of replacements that failed. Click OK.

NOTE A string replacement fails if the replacement string does not fit in the field.

Options Functions

Options functions can be used to add new entries to the Selection Index.

Add New Entry — Opens the appropriate dialog box to allow you to enter a new entry for the Selection Index.

Add Multiple Entries — Opens the appropriate dialog box to allow you to enter a new entry for the Selection Index. Once an entry is entered and accepted, the dialog box opens again to allow you to enter another entry at the same level as the previous entry.

Adding or editing a Selection Index entry is done in the Selection Index’s Editing dialog box.

Selection Index Editing Dialog Box

NOTE An entry only requires information to be entered in Description 1 entry line for it to be a valid entry.

Description 1 — Enter the first line of the entry label. To assign the manual’s description automatically, check the Manual Name check box after a manual is selected.

Description 2 — Enter the second line of the entry label. To assign the manual’s description automatically, check the Manual Name check box after a manual is selected.

Manual Button — Click to automatically display the selected manual’s description in the Description entry lines. You may edit the description.

Manual — Select the manual for the document that the entry automatically opens.

Document — Select the document that the entry automatically opens.


Options Functions

OK — Accepts the entry information and closes the dialog box.

Cancel — Does not accept the entry information and closes the dialog box.

Clear — Clears all of the information in the dialog box.

Steps to Add To add a Selection Index entry, complete the following steps:

1 Select the Selection Index entry to contain the new entry.

2 Decide whether to add a single entry or more than one entry.

To add a single entry, on the Options menu, click Add New Entry or press CTRL+A. A dialog box opens.

To add more than one entry, on the Options menu, click Add Multiple Entries or press CTRL+M. A dialog box opens.

3 In the Description boxes, type the description for the entry label.

4 To open a document when selected automatically, select the manual from the Manual list. If not, go to step 7.

5 If you want to use the manual’s description for the entry label, click the button next to the Manual list.

6 From the Document list, select the document to automatically open from the Selection Index entry.

7 Click OK.

Steps to Edit To edit a Selection Index entry, complete the following steps:

1 Select the Selection Index entry to edit.

2 To add a single entry, on the Edit menu, click Edit Cur. Entry or press CTRL+E. A dialog box opens.

3 Edit any of the information in the dialog box.

NOTE Clearing the Manual list clears all of the information.

4 Click OK.


The Manual and Part Link Maintenance application provides a means for document maintenance within Navigator. It lets you add, update, or edit hotspots and hotspot information, add, delete, or move documents, and update document page numbers.

The Manual and Part Link Maintenance window contains a title bar, a menu bar, and function buttons. The title bar displays the name of the application or the name of the current document. The menu bar contains the following:


Options — The Options commands are the same as the function buttons, which are described in this chapter.! Select Manual and Document! Add/Modify/Delete Manual! View Asset Information! View Location Information! Exit





Manual and Part Link Maintenance Application 5


Select Manual and Document


The Select Manual and Document function lets you select the manual and document on which you want to perform maintenance. Once a manual is selected, the documents for that manual are listed by their Document IDs and their paths and filenames. If a document has unlinked hotspots, “Unlinked” appears in the TPs column. If a document itself is not linked to the manual, “Unlinked” appears in the Page column.

To select a manual and document, complete the following steps:

1 Click Select Manual and Document. This opens a Select Manual and Document dialog box.

2 Type the exact character string of the manual you want to select in the entry field. (The manual name must be eight characters long and already exist in the database.) Or, select the manual from the list of manuals provided in the drop-down list. A list of documents for the selected manual appears.

3 Select the document from the Select a document list.

4 Click OK. The document appears and one of the following three events occurs.

If the document is linked and does not have any new hotspots to be linked, you may choose a function from the Document Options.

If the document is linked and has new hotspots to be linked, you are automatically prompted to link new hotspots to the document. (See “Link New Hotspot to Document” on page 5.)

If the document is unlinked, you are automatically prompted to ! select where the document is placed within the manual (See “Move

Document Within Manual” on page 4.), and ! enter the page number (See “Update Document Page Number” on

page 5.).

Once the document is linked, you can choose a function from the Document Options, or you are automatically prompted to link new hotspots to the document. (See “Link New Hotspot to Document” on page 5.)

Document Options The Document Options functions allow you to perform hotspot maintenance, document maintenance, and navigation of the manual for the current document.

The following Document Options functions allow hotspot maintenance:! Update Document Hotspots in Manual (ALT+T). See “Update

Document Hotspots in Manual” on page 6.! Link New Hotspot to Document (ALT+W). See “Link New Hotspot to

Document” on page 5.

The following Document Options functions allow document maintenance:! Delete Document from Manual (CTRL+D). See “Delete Document from

Manual” on page 4.



! Move Document within Manual (ALT+V). See “Move Document Within Manual” on page 4.

! Update Document Page Number (ALT+G). See “Update Document Page Number” on page 5.

! Update Document Size (ALT+S). See “Update Document Size” on page 5.

NOTE Because hotspot maintenance occurs after document maintenance, the hotspot maintenance functions are described in this document after document maintenance functions.

The following Document Options functions allow manual navigation:! Next Page (Page Down)! Previous Page (Page Up)

Image Manipulation for Documents

When Document Options are open, an additional set of menu items appear under Image Pan/Zoom. These functions allow for better viewing of the document.

Zoom In (+) — Lets you enlarge a document. This function is useful if the document you are viewing contains a lot of small details.

Zoom Out (-) — Lets you reduce the size of a document. This function is useful if the document you are viewing is large and does not fit on the screen.

Scale to Fit (F7) — Lets you fit the entire document on the screen. This is the default when the document is first displayed.

Rotate Left (/) — Lets you rotate the entire document 90 degrees counter-clockwise.

Rotate Right (*) — Lets you rotate the entire document 90 degrees clockwise.

Invert (Shift+F5) — Lets you view the document with the colors inverted.

Exiting Document Options To exit Document Options, choose one of the following from the File menu:

To go to the Select a Manual window, click Return to Document List.

To go to the Manual and Part Link Maintenance window, click Return to Manual_Part Link menu.

To go to the Control Center window, click Return to Main Menu.

Manual and Part Link Maintenance Application 5-3


Delete Document from Manual

The Delete Document from Manual function lets you remove the current document from its manual. This function not only removes the document from the manual, but also removes all hotspots associated with the annotation labels on the document.

To remove a document from a manual, complete the following steps:

1 On the Document Options menu, click Delete Document from Manual or press CTRL+D. A confirmation dialog box opens.

2 Confirm that the document name matches the document to be removed from the manual.

3 If you want to delete the document, click Yes or press ENTER. The document is removed and the application returns to the Options functions. If you don't want to delete the document, click No, and the dialog box is removed.

Move Document Within Manual

The Move Document within Manual function lets you move the current document to any page in the manual. When this function is selected, a Move Document within Manual dialog box opens that shows the three different options for moving a document within a manual. You can either place the document at the beginning of the manual, at the end of the manual, or after a specific document in the manual.

Beginning of Manual — Places the document at the beginning of the manual.

End of Manual — Places the document at the end of the manual.

Name of Preceding Document — Lets you type in the name of the document that will precede (come before) the current document.

OK — Moves the document.

Cancel — Cancels the function and removes the dialog box.

To move a document within a manual, complete the following steps:

NOTE If at any time you want to cancel this function, click Cancel and the application removes the dialog box.

1 On the Document Options menu, click Move Document within Manual or press ALT+V. The appropriate dialog box opens.

2 Select an option that indicates where the document is to be placed. If necessary, enter the preceding document's name.

3 Click OK or press ENTER. If the current document is to be placed after a specific document, the preceding document appears with a confirmation



dialog box. Confirm that the displayed document will precede the document you are moving or placing. Click Yes or press ENTER.

Update Document Page Number

The Update Document Page Number function lets you name or re-name the current document page number. When this function is selected, an Update Document Page Number dialog box opens, which shows the current page number. The New Page entry line is where the new page number is typed. The cursor automatically appears at the beginning of this entry line when the dialog box opens.

To update a document page number, complete the following steps:

NOTE If at any time you want to cancel this function, click Cancel and the application removes the dialog box.

1 On the Document Options menu, click Update Document Page Number menu or press ALT+G. The Update Document Page Number dialog box opens.

2 Type the new page number in the New Page entry line.

3 Click OK or press ENTER. If nothing is typed in the New Page entry line, the document will not have a page number.

Update Document Size

The Update Document Size function is not a selectable option in this version of Navigator.

Link New Hotspot to Document

The Link New Hotspot to Document function lets you link a new hotspot to the current document. A hotspot is an annotation label that has one or more parts linked to it. When this function is selected, an Add New Hotspot to Document dialog box opens that lists all of the annotation labels for the current document.

Only the annotation labels that have no part or quantity information associated with them are displayed. If all of the annotation labels have part and quantity information associated with them, a message appears stating that there are no callouts (available annotation labels) for the document.

To add hotspots to the current document, complete the following steps:

1 Select the annotation label you want to convert to a hotspot.

2 Click OK or press ENTER. This opens the Hotspot Label dialog box. (See “Add Part Number to Hotspot” on page 6.)

TIP Double-click the annotation label in Step 1 instead of selecting it.



Update Document Hotspots in Manual

The Update Document Hotspots in Manual function lets you add parts to hotspots on the current document, or modify or delete the hotspots that are associated with the current document. When this function is selected, an Update Document Hotspots in Manual dialog box opens that lists the current hotspots. If an annotation label does not have one or more parts associated with hotspot, no hotspot label is listed for it.

Once this function is complete, Hotspot Options is active.

To update document hotspots and to open the Hotspot Options functions, complete the following steps:

1 On the Document Options menu, click Update Document Hotspot in Manual or press ALT+T. The Update Document Hotspots in Manual dialog box opens.

2 Select the hotspot you want to update.

3 Click OK or press ENTER. This opens Hotspot Options.

TIP Double-click the annotation label in Step 2 instead of selecting it.

Add Part Number to Hotspot

The Add Part Number to Hotspot function lets you add existing part numbers or new part numbers to hotspots that already exist on the current document. When this function is selected, a Hotspot Label dialog box opens. This dialog box asks for part information.

To open a Hotspot Label dialog box, on the Hotspot Options menu, click Add Part Number to Hotspot or press ALT+P.



Hotspot Label Dialog Box The Hotspot Label dialog box lets you add (link) a part number to a hotspot. The Hotspot Label dialog box contains the following items:

Hotspot Label Dialog Box

Multiple Mfr. Code — If selected, indicates that you want to select a manufacturer other than the current manufacturer (for the manual). The Navigator Manufacturer code for the selected manufacturer is listed beside this box.

Customer Vendor Code — Where you select the customer vendor code for the manufacturer of the part you are entering. Select a code from the down arrow list. If the customer vendor code does not exist in the list, select the select 0000 – Unlisted Customer Vendor Code. After a part number is entered, you can then enter a description for the unlisted vendor code.

Part Number — Where you enter the part number. If the part is a manufacturer part and it does not exist in the database, you are prompted to enter the necessary information to add it.

Part Description — Where the part description appears.

Quantity — Where you enter the quantity of parts for the manufacturer, internal, or common hotspot. A quantity must be entered to add a part to a hotspot.



Part Type — Options: (If selected...)

! Manufacturer — Indicates that you are adding a manufacturer part number. If the part number entered has an internal part number associated with it, the hotspot is green or blue. (See the next bullet point, “Internal.”) Color indicates the type of hotspot only when at the Hotspot Options level.

NOTE This option is the default.

! Internal — Indicates that you are adding an internal part number. The hotspot is green if the part is stocked by Maximo. The hotspot is blue if the part is not stocked by Maximo. Color indicates the type of hotspot only when at Hotspot Options level.

NOTE An internal part may have been associated to a manufacturer part through the Part and Manufacturer Maintenance application.

! Common — Opens the Common Part dialog box that requires you to enter a common part description and quantity. Once they have been entered, click Add and the Add Manufacturer/Internal Part Number to Hotspot dialog box returns.

NOTE If the current hotspot contains any internal parts, the hotspot is green. If there are no internal parts, the hotspot for common part is blue.

! Go To — Opens a Go To Information dialog box that requires you to enter the manual and document names that the hotspot will “go to.” The manual name defaults to the currently open manual and can be modified if the “go to” document is in a different existing manual. Once the manual and document has been entered, click Add and the next hotspot is selected. (The document name must have 5 numeric-characters.) The hotspot is a red label or a red transparent triangle or square. A Go To hotspot can have no other part information associated with it.

! Go To Asset — Opens an Associate Asset dialog box that requires you to enter or select the asset number that the hotspot will “go to.” Once you have selected the asset number, click OK. If you would like to edit the second description line, press TAB and repeat this step. The hotspot is a red label or a red transparent triangle. A Go To Asset hotspot can have no other part information associated with it.

! Go To Location — Opens an Associate Location dialog box that requires you to enter or select the location that the hotspot will “go to.” Once you have selected the location, click OK. Location information itself can only be modified from within Maximo. The hotspot is a red label or a red transparent square. A Go To Location hotspot can have no other part information associated with it.

Undo Prev. TP — Automatically removes the data entry for the previous hotspot. This button becomes inactive if there are no hotspots previous to the current hotspot.

Use TP Label — Automatically enters the hotspot label in the Part Number entry line. The hotspot label is then used as the part number.



OK — Adds the part number, part description, and quantity to the hotspot. If all entry lines are clear, this button closes the Hotspot Label dialog box and the application returns to the previous function.

Clear — Clears all of the entry lines in the dialog box, and it resets the part type to the Manufacturer option and the Navigator Manufacturer Code to the manufacturer for the manual.

Adding a New Document If you are adding a new document to the manual, the Hotspot Label dialog box opens for every annotation label that is located on the document.

NOTE If the document does not contain any annotation labels, ALT+F4 lets you quit this function.

Annotation labels have a hotspot label color that corresponds to the type of hotspot it is. An internal part number has a green hotspot, a manufacturer part number has a blue hotspot, and a goto hotspot is red.

You may add any number of parts to a hotspot. Once all the parts are added to a hotspot, click OK to add parts to the next available hotspot. After all of the needed hotspots and parts have been added to the portion of the document being viewed, clear the entry lines in the dialog box and click OK. The following confirmation dialog box opens.

All Hotspots on Document Linked? dialog box opens and asks for you to check that all of the hotspot labels on the entire document have been added to the document. If they have been added, click Yes or press ENTER. If they haven't been added, click No and a dialog box opens that lets you log a message.

To log a message, type in the message in the appropriate entry line and click Add. The message can be a maximum of 80 characters. The message can be retrieved through the Error Log Report application located in the main menu.

After this confirmation window is completed, the application returns to the Options functions and remains in the current manual.

To add a part number to a hotspot through the Hotspot Label dialog box, complete the following steps:

1 If you want to use a different manufacturer than the one for the manual, select the Multiple Mfr. Mode field. If not, go to step 3.

2 Select the customer vendor code from the Customer Vendor Code drop down list. If the code is not in the list, select 0000 – Unlisted Customer Vendor Code.



3 Select the Part Type option.

If you select Go To, a Go To Information dialog box opens. Do the following:

a Enter a Go To name for the Go To hotspot. (The Go To name must be five numeric-characters long.)

b Click Add. This closes the function. If adding a document, the next hotspot is selected. Return to Step 1. If no more hotspots exist, go to Step 9.

If you select Go To Asset, an Associate Asset dialog box opens. Do the following:

a Select the asset number from the Asset Number drop-down list.

b Click OK. If you would like to edit the second description line, press TAB and repeat this step.

If you select Common, the Common Part dialog box for the selected hotspot opens:

a Enter the description in the Description entry line or select one of the four descriptions from the scroll box. (If at any time you want to cancel this function, click Quit. If at any time you want to clear all of the entry lines, click Clear.)

b Press TAB. The cursor moves to either the second Description entry line or the Quantity entry line. If the cursor is at the second Description entry line and you want to enter another description, type it and then press TAB; otherwise, press TAB to move the cursor to the Quantity entry line.

c Enter the quantity.

d Click Add or press ENTER. The common part is added to the hotspot. If you want to add more parts to the selected hotspot, return to Step 1. Otherwise, go to Step 9.

4 Enter the part number in the Part Number entry line, or click Use TP Label to use the hotspot label as the part number.

5 Press TAB. If you selected the unlisted customer vendor code, the Enter Unlisted Vendor Code dialog box opens. Enter a code description and click OK.

If the part exists in the database, the associated description appears in the Description entry line.

If the part does not exist in the database, see “Add, Modify, Delete Manufacturer Parts” on page 5. Internal parts must be added through Maximo.

6 Once the part description is entered, move the cursor to the Quantity entry line.

7 Enter the quantity of parts.



8 Click OK. This adds the part number to the hotspot. Repeat Steps 1 through 8 for each part number you want to add to the hotspot.

9 Once all the parts are added to a hotspot, click OK to close the Hotspot Label dialog box. If adding a new document, the next hotspot is selected. Return to Step 1. If no more hotspots exist, clear the entry lines in the dialog box and click OK.

NOTE If the document does not contain any annotation labels, ALT+F4 lets you quit this function.

Modify Quantity of Part Number

The Modify Quantity of Part Number function lets you change the quantity for hotspot part numbers that already exist on the current document.

To modify a quantity, complete the following steps:

1 On the Hotspot Options menu, click Modify Quantity of Part Number. This opens a dialog box for the selected hotspot.

2 Select the Part Type option. (Only Mfr and Internal are active.) The corresponding part numbers and manufacturer is listed in the Hotspot Parts List.

3 Select the part number.

4 Click OK or press ENTER. This opens the Modify Quantity of Part Number dialog box. This dialog box also shows the current quantity.

5 Enter the new quantity in the New Quantity entry line.

6 Click OK or press ENTER. The new quantity replaces the old quantity.

Delete Part Number from Hotspot

The Delete Part Number from Hotspot function lets you remove a part number from a hotspot that already exists on the current document.

To remove a part number, complete the following steps:

1 On the Hotspot Options menu, click Delete Part Number from Hotspot. This opens a dialog box for the selected hotspot.

2 Select the Part Type option. (Only Mfr and Internal are active.) The corresponding part numbers is listed in the Hotspot Parts List.

3 Select the part number.

4 Click OK or press ENTER. This opens a confirmation dialog box showing the deleted part number.

5 Confirm the part number to delete. If you want to delete the part number, click Yes or press ENTER. The part number is removed from the hotspot. If you do not want to delete the part number, click No.



Add Common Part to Hotspot

The Add Common Part to Hotspot function lets you add a common part description and quantity to a hotspot that already exist on the current document.

To add a common part, complete the following steps:

Note If at any time you want to cancel this function, click Quit. If at any time you want to clear all of the entry lines, click Clear.

1 On the Hotspot Options menu, click Add Common Part to Hotspot. This opens the Add Common Part to Hotspot dialog box for the selected hotspot.

2 Enter the description in the Description entry line or select one of the four provided descriptions from the scroll box located under the down arrow button.

3 Press TAB. This moves the cursor to either the second Description entry line or the Quantity entry line. If the cursor is at the second Description entry line and you want to enter more descriptions, enter more and press TAB, otherwise press TAB to move the cursor to the Quantity entry line.

4 Enter the quantity.

5 Click Add. The common part is added to the hotspot.

Modify Common Part Description/Qty

The Modify Common Part Description/Qty function lets you change a common part description and/or quantity of a hotspot that already exists on the current document.

To modify a common part description and/or quantity, complete the following steps:

1 On the Hotspot Options menu, click Modify Common Part Description/Qty or press ALT+J. This opens a dialog box for the selected hotspot.

2 Select the part description.

3 Click OK or press ENTER. This opens the Common Part dialog box for the selected hotspot. This dialog box shows the common part description and quantity.

4 Edit the description in the Description entry line.

5 Press TAB. This moves the cursor to either the second Description entry line or the Quantity entry line. If the cursor is at the second Description entry line and you want to edit the description, edit the description and then press TAB, otherwise press TAB to move the cursor to the Quantity entry line.

6 Edit the quantity.



7 Click Add. The common part description and/or quantity is changed.

Delete Common Part from Hotspot

The Delete Common Part from Hotspot function lets you remove a common part from a hotspot that already exists on the current document.

To delete a common part, complete the following steps:

1 On the Hotspot Options menu, click Delete Common Part from Hotspot or press ALT+K. This opens a dialog box for the selected hotspot.

2 Select the part description.

3 Click OK or press ENTER. This opens a confirmation dialog box. This dialog box shows the common part to be deleted.

4 Confirm the common part description is the one you want to delete. If you want to delete the common part, click Yes or press ENTER. The common part is removed from the hotspot. If you do not want to delete the common part, click No.

Modify Go To Name of Hotspot

The Modify Go To Name of Hotspot function lets you change a Go To name of a Go To Hotspot that already exists on the current document.

To modify a Go To name, complete the following steps:

1 On the Hotspot Options menu, click Modify Go To Name of Hotspot or press ALT+Y. This opens the Modify Go To Name of Hotspot dialog box for the selected hotspot. This dialog box selects the current Go To name.

2 Enter a different Go To name in the appropriate entry line. It must be five characters long.

3 Click OK or press ENTER. The Go To name is changed.

Delete Go To Hotspot

The Delete Go To Hotspot function lets you remove an entire Go To Hotspot that already exists on the current document.

To delete a Go To hotspot, complete the following steps:

1 On the Hotspot Options menu, click Delete Go To Hotspot or press ALT+Z. This opens a confirmation dialog box. This dialog box shows the Go To hotspot to be deleted.

2 Check the Go To name to be sure it is the one you want to delete. If you want to delete the Go To hotspot, click Yes or press ENTER. The Go To hotspot is removed from the document. If you do not want to delete the Go To hotspot, click No.



Modify Go To Asset Hotspot

The Modify Go To Asset Hotspot function lets you change a Go To Asset hotspot that already exists on the current document.

To modify a Go To Asset hotspot, complete the following steps:

1 On the Hotspot Options menu, click Modify Go To Asset Hotspot or press CTRL+M. This opens the Associate Asset dialog box for the selected hotspot.

2 Select a different asset number or enter a new asset number in the Asset Number entry line.

3 Click OK or press ENTER.

Delete Go To Asset Hotspot

The Delete Go To Asset Hotspot function lets you remove an entire Go To Asset hotspot that already exists on the current document.

To delete a Go To Asset hotspot, complete the following steps:

1 On the Hotspot Options menu, click Delete Go To Asset Hotspot or press CTRL+T. This opens a confirmation dialog box. This dialog box shows the Go To Asset hotspot to be deleted.

2 Check the Go To Asset name to be sure it is the one you want to delete. If you want to delete it, click Yes or press ENTER. The Go To Asset hotspot is removed from the document. If you do not want to delete it, click No.

Modify Go To Location Hotspot

The Modify Go To Location Hotspot function lets you change a Go To Location hotspot that already exists on the current document.

To modify a Go To Location hotspot, complete the following steps:

1 On the Hotspot Options menu, click Modify Go To Location Hotspot. This opens the Associate Location dialog box for the selected hotspot.

2 Select a different location number or enter a new location number in the Location Number entry line.


Delete Go To Location Hotspot

The Delete Go To Location Hotspot function lets you remove an entire Go To Location hotspot that already exists on the current document.

To delete a Go To Location hotspot, complete the following steps:

1 On the Hotspot Options menu, click Delete Go To Location Hotspot. This opens a confirmation dialog box. This dialog box shows the Go To Location hotspot to be deleted.



2 Check the Go To Location name to be sure it is the one you want to delete. If you want to delete it, click Yes or press ENTER. The Go To Location hotspot is removed from the document. If you do not want to delete it, click No.

Delete Entire Hotspot

The Delete Entire Hotspot function lets you remove an entire hotspot that already exists on the current document. Once an entire hotspot is deleted, the user is returned to the Document Options menu.

To delete a hotspot, complete the following steps:

1 On the Hotspot Options menu, click Delete Entire Hotspot or press CTRL+E. This opens a confirmation dialog box. This dialog box shows the hotspot to be deleted.

2 Check the hotspot to be sure it is the one you want to delete. If you want to delete the hotspot, click Yes or press ENTER. The hotspot is removed from the document. If you do not want to delete the hotspot, click No.

Select Next Hotspot

The Select Next Hotspot function lets you select a new hotspot that already exists on the current document without exiting the Hotspot Options functions.

To select a new hotspot, complete the following steps:

1 On the Hotspot Options menu, click Select Next Hotspot. The Select Next Hotspot dialog box opens.

2 Select the hotspot you want to update.

3 Click OK or press ENTER. This selects the hotspot.

Tip Double-click the hotspot in Step 2 instead of selecting it.

Display Parts List of Hotspot

The Display Parts List of Hotspot function displays the parts list for a hotspot that already exists on the current document. The parts list also contains three buttons: Page Up, Page Down, and Cancel.

Page Up — opens the previous window of the parts list. This button is only available if the currently displayed parts list window is not the first window.

Page Down — opens the next window of the parts list. This button is only available if the currently displayed parts list window is not the last window.

Cancel — removes the parts list from the window.

To display a hotspot's parts list, complete the following steps:

1 On the Hotspot Options menu, click Display Parts List of Hotspot or press the F8 key. The hotspot's parts list opens.



2 To remove the parts list, press the F8 key or click Cancel.

Change Hotspot Label

The Change Hotspot Label function opens the Change Label dialog box that lets you change a label. Once this button is selected, you may select any label to be changed. The Change Label dialog box contains the following items:

enter new label — Where you enter the new label.

change all occurrences — Changes all occurrences of the selected label to the new label if the field active and selected. If the field is inactive, only one occurrence of the label exists.

OK — Changes the label.

Cancel — Closes the Change Label dialog box.

To change a hotspot label, complete the following steps:

1 On the Hotspot Options menu, click Change Hotspot Label or press CTRL+L.

2 Select the hotspot label to be changed. This opens the Change Label dialog box.

3 Enter the new label in the entry line.

4 Click OK. The label is changed.


Add, Modify, Delete Manual


The Add, Modify, Delete Manual function lets you add a new manual to the database, to modify an existing manual description, and to add (or delete) asset numbers to an existing manual. When this function is selected, an Add, Modify, Delete Manual dialog box opens.

Add, Modify, Delete Manual Dialog Box

Manual Name — Where the currently selected manual name appears or where you enter the character string of the manual name. The manual name must be four alpha-numeric characters long.

NOTE The manual last selected in the Select Manual and Document function is automatically displayed when this window is first displayed.

Manual Description — Where the manual description appears. Each description entry line character string can be a maximum of 40 characters long.

Asset Number — Where you enter asset numbers for the manual. The asset number character string can be a maximum of 15 characters long. This data is optional.

Current Asset Number List — Where the asset numbers and details associated with the manual are listed. If there are more asset numbers than what fits in the field, a scroll bar is available to scroll through the list.

Delete Asset Number from List — Removes the selected asset number from the Current Asset Number List.

Asset Detail — Opens the View Asset dialog box that lets you view details for the selected asset number.



Location — Where you enter locations in the manual. The location character string can be a maximum of 15 characters long. This data is optional.

Current Locations — Where the locations and details associated with the locations are listed. If there are more locations than what fits in the field, a scroll bar is available to scroll through the list.

Delete Location Number from List — Removes the selected location from the Current Location List.

Location Detail — Opens the View Location dialog box that lets you view details for the selected location.

Add — Adds a new manual, its description, and any associated asset numbers to the database.

Modify — Saves the changes made to an existing manual description and adds or deletes asset numbers. It also clears all of the entry lines.

Delete — Removes the manual, its description, and any associated asset numbers from the database. Once this button is selected, a confirmation dialog box opens asking if you are sure you want to delete the manual. If you want to delete, click Yes or press ENTER. Otherwise, click No and the dialog box remains open.

Clear — Clears all of the entry lines.

Quit — Removes the dialog box. If you click Quit when the entry lines contain data, a confirmation dialog box opens asking you if you want to exit. If you want to exit, click Yes or press ENTER. Otherwise, click No and the dialog box remains open.

Steps to Add To add a new manual description and asset numbers, complete the following steps:

1 On the Options menu, click Add, Modify, Delete Manual. The appropriate dialog box opens.

2 Enter an new name.

3 Press TAB. Edit the manual description. If you would like to add a second description line, press TAB and repeat this step.

Steps to Modify or Delete To modify or delete an existing manual description and asset numbers, complete the following steps:

1 On the Options menu, click Add, Modify, Delete Manual. The appropriate dialog box opens.

2 Enter an existing manual name.

3 Press TAB. This opens the current manual name and description and it moves the cursor to the first Manual Description entry line.


View Asset Information

4 If you want to delete the manual, click Delete. A confirmation dialog box opens asking if you are sure you want to delete the asset. click Yes or press ENTER.

5 Edit the manual description. If you would like to edit the second description line, press TAB and repeat this step.

View Asset Information

The View Asset Information function lets you view assets. You must use Maximo to add, modify, or delete asset. When this function is selected, the Associate Asset dialog box opens.

Associate Asset Dialog Box

Asset Number — Where the unique number that identifies the asset appears. (This is read from the database and cannot be changed.)

Asset Description — Where the asset description appears. (This is read from the database and cannot be changed.)

Asset Type — Where an optional asset type identifier appears. (This is read from the database and cannot be changed.)

Manuals Available — Where you select an existing manual to associate with the asset.

Current Associated Manual List — Where you can view all manuals associated with the asset and select manuals to disassociate from the asset.

Remove Manual from List — Disassociates manuals selected in the Current Associated Manual List field.

Modify — Saves the changes made to an existing asset number’s description and/or its location. It also clears all of the entry lines.



View Location Information

Quit — Closes the dialog box. If you click Quit when the entry lines contain data, a confirmation dialog box opens asking you if you want to exit. If you want to exit, click Yes or press ENTER. Otherwise, click No and the dialog box remains open.

Steps to View Asset Information

To view asset information, complete the following steps:

NOTE If at any time you want to clear all of the entry lines, click Clear. If at any time you want to quit this function, click Quit.

1 On the Options menu, click View Asset Information or press CTRL+A. The Associate Asset dialog box opens.

2 Enter an existing asset number.

3 Press TAB. This opens the current asset number and its description.


The View Location Information function lets you associate an asset to a location in a facility. You must use Maximo to add, modify, or delete a location. When this function is selected, the Associate Location dialog box opens.

Associate Location Dialog Box

Location Number — Where the unique number that identifies the location appears. (This is read from the database and cannot be changed.)

Location Description — Where the location description appears. (This is read from the database and cannot be changed.)

Location Type — Where an optional location type identifier appears. (This is read from the database and cannot be changed.)

Manuals Available — Where you select an existing manual to associate with the location.



Current Associated Manual List — Where you can view all manuals associated with the location and select manuals to disassociate from the location.

Remove Manual from List — Disassociates manuals selected in the Current Associated Manual List field.

Modify — Saves the changes made to an existing location number’s description and/or its asset. It also clears all of the entry lines.


Quit — Closes the dialog box. If you click Quit when the entry lines contain data, a confirmation dialog box opens asking you if you want to exit. If you want to exit, click Yes or press ENTER. Otherwise, click No and the dialog box remains open.

Steps to View Location Information

To view location information, complete the following steps:

NOTE If at any time you want to clear all of the entry lines, click Clear. If at any time you want to quit this function, click Quit.

1 On the Options menu, click View Location Information. The Associate Location dialog box opens.

2 Enter an existing location number.

3 Press TAB. This opens the current location number and its description.




The Part and Manufacturer Maintenance application lets you add, modify, and delete manufacturers, manufacturer parts, alternate suppliers, and alternate supplier parts and descriptions. This application also lets you supersede manufacturer and internal parts, and associate and disassociate manufacturer parts with internal parts.

All Part and Manufacturer Maintenance screens contain a title bar and a menu bar, and function buttons. The title bar is located along the top of the window, and either displays the name of the application or “Part and Manufacturer Maintenance” if you are entering parts data. It also displays the current manufacturer of the parts. (If you are entering only internal parts data, the title bar states that there is no current manufacturer.) The menu bar contains the following:


Options — The Options commands are the same as the function buttons, which are described in this chapter.! Set Manufacturer! Add, Modify, Delete Manufacturer! Add, Modify, Delete Manufacturer Parts! Supersede Manufacturer Part! Supersede Internal Part ! Associate Manufacturer Part with Internal Part ! Disassociate Manufacturer Part from Internal Part! Associate Internal Part with Manufacturer Part ! Disassociate Internal Part from Manufacturer Part


Help — Contains the following commands:! Contents — Click to start the online help for this application.! How to Use Help — Click to start a general tutorial for how to use



Part and Manufacturer Maintenance Application 6


Set Manufacturer

Set Manufacturer

The Set Manufacturer function lets you select a manufacturer for manufacturer part maintenance. Once you have set a manufacturer you can use any of the functions without having to reset the manufacturer for each function. The functions that require you to set the manufacturer are Add, Modify, Delete Manufacturer Parts; Supersede Manufacturer Part; Associate Manufacturer Part with Internal Part; Disassociate Manufacturer Part from Internal Part; Associate Internal Part with Manufacturer Part; and Disassociate Internal Part from Manufacturer Part. Once a manufacturer is set, this function also lets you change the currently set manufacturer.

When this function is selected, a Set Manufacturer dialog box opens.

Set Manufacturer Dialog Box

Manufacturer Code — Where you enter the four-character code of the manufacturer.

Manufacturer Code and Name — Where the manufacturer codes and names are displayed. You may select the manufacturer code and name from this list.

OK — Sets the manufacturer.

Quit — Removes the dialog box.

To set a manufacturer, complete the following steps:

1 On the Options menu, click Set Manufacturer or press ALT+S. The Set Manufacturer dialog box opens.

2 Type the manufacturer code and name or select it from the list. (The manufacturer code must be four characters long.)


Add, Modify, Delete Manufacturer

3 Click OK or press ENTER. The manufacturer remains the same until you change it or exit the application.

NOTE The manufacturer name set in this function appears in the Associate Internal Part with Manufacturer Part and Disassociate Internal Part from Manufacturer Part functions.


The Add, Modify, Delete Manufacturer function lets you add a new manufacturer to the database, to modify an existing manufacturer, and to delete an existing manufacturer from the database. When this function is selected, a Add, Modify, Delete Manufacturer dialog box opens.

Add, Modify, Delete Manufacturer Dialog Box

Manufacturer Code — Where you enter the four-character code of the manufacturer.

Manufacturer Name — Where the name of the manufacturer appears. The manufacturer name character string ranges from one character to 25 characters long.

Add — Adds a new manufacturer code and name to the database.

Modify — Saves changes made to an existing manufacturer name. Only the name of a manufacturer can be changed. The manufacturer code becomes inactive.

Delete — Removes a manufacturer code and name from the database. Once this button is selected a confirmation dialog box opens asking if you are sure you want to delete the manufacturer. If you want to delete, click Yes or press ENTER. Otherwise, click No and the dialog box remains open.

Clear — Clears both entry lines.

Quit – Removes the dialog box. If you click Quit when the entry lines contain data, a confirmation dialog box opens asking you if you want to exit. If you want to exit, click Yes or press ENTER. Otherwise, click No and the dialog box remains open.

Part and Manufacturer Maintenance Application 6-3


Steps to Add

To add a manufacturer to the database, complete the following steps:

NOTE If at any time you want to clear all of the entry lines, click Clear. If at any time you want to exit this function, click Quit.

1 On the Options menu, click Add, Modify, Delete Manufacturer or press the ALT+M. The Add, Modify, Delete Manufacturer dialog box opens.

2 Type a new manufacturer code. (The manufacturer code must be four characters long.)

3 Press TAB. This moves the cursor to the Manufacturer Name entry line. The Add button becomes active.

4 Type a new manufacturer name.

5 Click Add or press TAB before pressing ENTER.

Steps to Modify or Delete

To modify or delete an existing manufacturer name, complete the following steps:


1 On the Options menu, click Add, Modify, Delete Manufacturer or press ALT+M. The Add, Modify, Delete Manufacturer dialog box opens.

2 Type an existing manufacturer code. (The manufacturer code must be four characters long.)

3 Press TAB. The current manufacturer name appears, and the cursor moves to the Manufacturer Name entry line. The Modify button and the Delete button become active.

If you want to modify the manufacturer name, continue to Step 4.

If you want to delete the manufacturer, click Delete. A confirmation dialog box opens asking if you are sure you want to delete the manufacturer. Click Yes or press ENTER.

4 Edit the manufacturer name.

5 Click Modify or press TAB before pressing ENTER.


Add, Modify, Delete Manufacturer Parts


The Add, Modify, Delete Manufacturer Parts function lets you add a new manufacturer part to database, to modify an existing manufacturer part, and to delete an existing manufacturer part from the database.

Note The manufacturer must be set for Add, Modify, Delete Manufacturer Parts to be active.

When this function is selected, an Add, Modify, Delete Manufacturer Parts dialog box opens.

Add, Modify, Delete Manufacturer Parts Dialog Box

Manufacturer Part Number — Where you enter the character string of the manufacturer part number. A part number character string can be up to 60 characters long.

Manufacturer Part Description — Where the manufacturer part description appears. A part description character string can be a maximum of 40 characters long.

Add — Adds a new manufacturer part and description to the database.

Modify — Saves the changes made to an existing manufacturer part description.

Delete — Removes a manufacturer part number and description from the database. Once this button is selected, a confirmation dialog box opens asking if you are sure you want to delete the part. If you want to delete, click Yes or press ENTER. Otherwise, click No and the Manufacturer Part dialog box remains open.


Quit — Removes the dialog box. If you click Quit when the entry lines contain data, a confirmation dialog box opens asking you if you want to exit. If you want to exit, click Yes or press ENTER. Otherwise, click No and the Manufacturer Part dialog box remains open.



Steps to Add

To add a new manufacturer part to the database, complete the following steps:


1 On the Options menu, click Add, Modify, Delete Manufacturer Parts or press ALT+P. The Add, Modify, Delete Manufacturer Parts dialog box opens.

2 Type a new manufacturer part number.

3 Press TAB. The cursor moves to the Manufacturer Part Description entry line. The Add button becomes active.

4 Type a part description.

5 Click Add.

Steps to Modify or Delete

To modify or delete an existing manufacturer part description, complete the following steps:


1 On the Options menu, click Add, Modify, Delete Manufacturer Parts or press ALT+P. The Add, Modify, Delete Manufacturer Parts dialog box opens.

2 Type an existing manufacturer part number.

3 Press TAB. The current manufacturer part number and description appears and the cursor moves to the Manufacturer Part Description entry line. The Modify button and the Delete button become active. If you want to delete the part, click Delete. A confirmation dialog box opens asking if you are sure you want to delete the part. Click Yes or press ENTER.

4 Edit the part description.

5 Click Modify.


Supersede Manufacturer Part

Supersede Manufacturer Part

The Supersede Manufacturer Part function lets you replace the existing manufacturer part number with a new manufacturer part number.

Note The manufacturer must be set for Supersede Manufacturer Part to be active.

When this function is selected, a Supersede Manufacturer Part dialog box opens.

Supersede Manufacturer Part Dialog Box

Manufacturer Part Number — Where you enter the character string of the manufacturer part number. A part number character string can be up to 60 characters long. Once entered, this entry line data becomes inactive.

Manufacturer Part Description — Where the manufacturer part description appears. A part description character string can be a maximum of 40 characters long. Once entered, this entry line data becomes inactive.

New Manufacturer Part Number — Where you enter the character string of the new manufacturer part number. A part number character string can range from one character to 20 characters long.

OK — Supersedes the manufacturer part number with the new manufacturer part number.


Quit — Exits the function and removes the dialog box.

To supersede an existing manufacturer part number, complete the following steps:


1 On the Options menu, click Supersede Manufacturer Part or press CTRL+P. The Supersede Manufacturer Part dialog box opens.


Supersede Internal Part


3 Press TAB. The part description appears in the Manufacturer Part Description entry line and the cursor moves to the New Manufacturer Part Number entry line.

4 Type a new manufacturer part number.

5 Click OK or press TAB before pressing ENTER.

a If the manufacturer part number does not exist and this button is selected, a dialog box opens stating that the part number does not exist. Click OK and re-enter an existing manufacturer part number in the Manufacturer Part Number entry line.

b If the new part number already exists in the database, a dialog box opens stating that the part number already exists. Click OK and re-enter a unique manufacturer part number in the New Manufacturer Part Number entry line.


The Supersede Internal Part function lets you replace the existing internal part number with a new internal part number. When this function is selected, a Supersede Internal Part dialog box opens.

Supersede Internal Part Dialog Box

Internal Part Number — Where you enter the character string of the internal part number. A part number character string can range from one character to 20 characters long. Once entered, this entry line data becomes inactive.

Internal Part Description — Where the internal part description appears. A part description character string can be a maximum of 40 characters long. Once entered, this entry line data becomes inactive.

New Internal Part Number — Where you enter the character string of the new internal part number. A part number character string can range from one character to 20 characters long.



OK — Supersedes the internal part number with the new internal part number.


Quit — Removes the dialog box.

To supersede an existing internal part number, complete the following steps:


1 On the Options menu, click Supersede Internal Part or press CTRL+I. The Supersede Internal Part dialog box opens.

2 Type an existing internal part number.

3 Press TAB. The part description appears in the Internal Part Description entry line and the cursor moves to the New Internal Part Number entry line.

4 Type a new internal part number.

5 Click OK or press TAB before pressing ENTER.

a If the internal part number does not exist and this button is selected, a dialog box opens stating that the part number does not exist. Click OK and re-enter an existing internal part number in the Internal Part Number entry line.

b If the new part number already exists in the database, a dialog box opens stating that the part number already exists. Click OK and re-enter a unique internal part number in the New Internal Part Number entry line.


Associate Manufacturer Part with Internal Part


The Associate Manufacturer Part with Internal Part function lets you associate an existing manufacturer part with an existing internal part. When this function is selected, an Associate Manufacturer Part with Internal Part dialog box opens.

Associate Manufacturer Part with Internal Part Dialog Box

Internal Part Number — Where you enter the character string of the internal part number. A part number character string can range from one character to 20 characters long. If the internal part number does not exist, a dialog box opens stating that the part number does not exist. Click OK and re-enter an existing internal part number.

Internal Part Description — Where the internal part description appears. Once entered, this entry line data becomes inactive.

Manufacturer Part Number — Where you enter the character string of the manufacturer part number. A part number character string can be up to 60 characters long. If the manufacturer part number does not exist, a dialog box opens stating that the part number does not exist. Click OK and re-enter an existing manufacturer part number.

Manufacturer Part Description — Where the manufacturer part description opens. Once entered, this entry line data becomes inactive.

Current Manufacturer Parts Association — Where all manufacturer parts associated to the internal part number are listed. This field lists the four-character manufacturer code, the manufacturer part number, and the manufacturer part description.

OK — Associates the manufacturer part number with the internal part number, clears the Manufacturer Part Number and Manufacturer Part Description entry lines, and places the cursor at the end of the Internal Part Number entry line.




Quit — Removes the dialog box. If you click Quit when the entry lines contain data, a confirmation dialog box opens asking you if you are finished with part association activities. If you are finished, click Yes or press ENTER. Otherwise, click No and the Associate Manufacturer Part with Internal Part dialog box remains open.

To associate a manufacturer part with an internal part, complete the following steps:


1 On the Options menu, click Associate Manufacturer Part with Internal Part or press CTRL+A. The Associate Manufacturer Part with Internal Part dialog box opens.


3 Press TAB. The part description appears in the Internal Part Description entry line and the cursor moves to the Manufacturer Part Number entry line.



6 Repeat steps 2 through 5 for each association.


Disassociate Manufacturer Part from Internal Part

Disassociate Manufacturer Part from Internal Part

The Disassociate Manufacturer Part from Internal Part function lets you disassociate an existing manufacturer part from an existing internal part. When this function is selected, a Disassociate Manufacturer Part from Internal Part dialog box opens.

Disassociate Manufacturer Part with Internal Part Dialog Box


Internal Part Description — Where the internal part description appears. Once entered, this entry line data becomes inactive.

Current Manufacturer Parts Association — Where all manufacture parts associated to the internal part number are listed. This field lists the four character manufacturer code, the manufacturer part number, and the manufacturer part description.

OK — Disassociates the manufacturer part number from the internal part number, and it clears the Manufacturer Part Number and Manufacturer Part Description entry lines and places the cursor at the end of the Internal Part Number entry line.


Quit — Removes the dialog box. If you click Quit when the entry lines contain data, a confirmation dialog box opens asking you if you are finished with part association activities. If you are finished, click Yes or press ENTER. Otherwise, click No and the Disassociate Manufacturer Part from Internal Part dialog box remains open.

To disassociate a manufacturer part from an internal part, complete the following steps:



Associate Internal Part with Manufacturer Part

1 On the Options menu, click Disassociate Manufacturer Part from Internal Part or press CTRL+D. The Disassociate Manufacturer Part from Internal Part dialog box opens.


3 Press TAB. The part description appears in the Internal Part Description entry. All associated manufacturer parts appear in the Current Manufacturer Parts Associations field.

4 In the Current Manufacturer Parts Associations field, select the manufacturer part you want to disassociate.



The Associate Internal Part with Manufacturer Part function lets you associate an existing internal part with an existing manufacturer part. When this function is selected, an Associate Internal Part with Manufacturer Part dialog box opens.

NOTE Maximo and the Navigator application option refer to “internal” parts as “items.” The manufacturer currently set by the Set Manufacturer function appears where <Current Manufacturer> is documented.

Associate Manufacturer Part with Manufacturer Part Dialog Box

<Current Manufacturer> Part Number — Where you enter the character string of the manufacturer part number. A part number character string can be up to 60 characters long. If the manufacturer part number does not exist, a dialog box opens stating that the part number does not exist. Click OK and re-enter an existing manufacturer part number.



<Current Manufacturer> Description — Where the manufacturer part description appears. Once entered, this entry line data becomes inactive.


Internal Description — Where the internal part description appears. Once entered, this entry line data becomes inactive.

Current Internal Associations — Where all internal parts associated to the manufacturer part number are listed. This field lists the internal part number and part description.

Associate — Associates the internal part number with the manufacturer part number, clears the Internal Part Number and Internal Description entry lines, and places the cursor at the end of the Manufacturer Part Number entry line.


Quit — Removes the dialog box. If you click Quit when the entry lines contain data, a confirmation dialog box opens asking you if you are finished with part association activities. If you are finished, click Yes or press ENTER. Otherwise, click No and the Associate Internal Part with Manufacturer Part dialog box remains open.

To associate an internal part with a manufacturer part, complete the following steps:


1 On the Options menu, click Associate Internal Part with Manufacturer Part or press SHIFT+A. The Associate Internal Part with Manufacturer Part dialog box opens.

2 Type an existing manufacturer part number in the <Current Manufacturer> Part Number entry line.

3 Press TAB. The part description appears in the <Current Manufacturer> Description entry line and the cursor moves to the Internal Part Number entry line.


5 Click Associate.

6 Repeat steps 2 through 5 for each association.


Disassociate Internal Part from Manufacturer Part


The Disassociate Internal Part from Manufacturer Part function lets you disassociate an existing internal part from an existing manufacturer part. When this function is selected, a Disassociate Manufacturer Part from Internal Part dialog box opens.

NOTE Maximo and the Navigator application option refer to “internal” parts as “items.” The manufacturer currently set by the Set Manufacturer function appears where <Current Manufacturer> is documented.

Disassociate Manufacturer Part with Manufacturer Part Dialog Box

<Current Manufacturer> Part Number — Where you enter the character string of the manufacturer part number. A part number character string can be up to 60 characters long. If the manufacturer part number does not exist, a dialog box opens stating that the part number does not exist. Click OK and re-enter an existing manufacturer part number.

<Current Manufacturer> Description — Where the manufacturer part description appears. Once entered, this entry line data becomes inactive.

Current Internal Associations — Where all internal parts associated to the manufacturer part number are listed. This field lists the internal part number and description.

Disassociate — Disassociates the manufacturer part number from the internal part number, and it clears the Manufacturer Part Number and Manufacturer Description entry lines and places the cursor at the end of the Internal Part Number entry line.




Quit — Removes the dialog box. If you click Quit when the entry lines contain data, a confirmation dialog box opens asking you if you are finished with part association activities. If you are finished, click Yes or press ENTER. Otherwise, click No and the Disassociate Internal Part from Manufacturer Part dialog box remains open.

To disassociate an internal part from a manufacturer part, complete the following steps:


1 On the Options menu, click Disassociate Internal Part from Manufacturer Part or press SHIFT+D. The Disassociate Internal Part from Manufacturer Part dialog box opens.


3 Press TAB. The part description appears in the <Current Manufacturer> Description entry. All associated internal parts appear in the Current Internal Associations field.

4 In the Current Internal Associations field, select the internal part you want to disassociate.

5 Click Disassociate.


The Annotation Maintenance application provides a way to maintain document annotations. It lets you add new touchpoints to or delete existing touchpoints from an existing document. This application is designed for low volume annotation maintenance.

The Annotation Maintenance window contains a title bar and a menu bar. The title bar displays the name of the application. It is located along the top of the window. The menu bar contains the following:


Options — The only Option command is the QC Document Command, which is described in this chapter.





QC Document Repair

The QC Document Repair function lets you perform all of the Annotation Maintenance “Quality Control” functions. It lets you add touchpoints to an existing document, as well as delete touchpoints from the document.

Upon opening Annotation Maintenance, you are prompted to select a manual and document. This prompt contains the following items:

Select a Manual — Lets you select the manual for which you want to perform QC Document Repair. Once selected, the Select a Document drop-down list displays all available documents for the selected manual.

Select a Document — Lets you select the exact document to open.

OK — Displays the selected document and lets you perform annotation maintenance.

Exit — Closes Annotation Maintenance.

Annotation Maintenance Application 7


QC Document Repair

Clear — Clears all of the entry lines for the drop-down lists.

To open a document for annotation maintenance, complete the following steps:

1 Select a manual from the Select a Manual drop-down list.

2 Select a document from the Select a Document drop-down list.

3 Click OK. This displays the selected document.

QC Document Repair Screen

Once a document is displayed, the QC Document Repair window contains the following items:

Next Frame – To display the next frame of the document. Frames become available when you zoom into the document. See “Image Manipulation Functions” on page 3. Documents display in frames from left to right. The corresponding key for this button is PAGE DOWN.

Previous Frame — To display the previous frame of the document. Frames become available when you zoom into the document. See “Image Manipulation Functions” on page 3. Documents display in frames from left to right. The corresponding key for this button is PAGE UP.

Add Label — To add a name to a blank annotation label. When this button is selected, an Annotation Label dialog box opens. (Right-clicking the mouse also opens the Annotation Label dialog box.) This window lets you enter a name for the annotation label. The Enter button accepts the name. (A named annotation label is considered a touchpoint.) This button is not active unless you are in Add Mode.

Doc Finished — To save the changes you have made to the currently displayed document and exit the function.

Add Mode — To allow you to add annotation labels to the document and name them.

Delete Mode v To allow you to delete touchpoints from the document. A Verify Delete dialog box opens, allowing you to verify the touchpoint to be deleted. The OK button deletes the touchpoint. The Cancel button cancels the delete function. To delete a touchpoint, it must not have any part information associated (linked) to it. Data can be “un-linked” from a touchpoint by using the Manual and Part Link Maintenance application. (See “Manual and Part Link Maintenance Application” on page 1.)

Delete All — To delete all of the annotation on the currently displayed document.

Change Label — To allow you to change the label for a touchpoint. The Change Label dialog box opens, allowing you to enter in the new label (with the option of changing all occurrences of the label) for the selected touchpoint.

Move Label — To allow you to move a touchpoint from its location to anywhere on the current document.


Image Manipulation Functions

Next Page — To display the next available document in the manual. This button is inactive 1) if there are unlabeled annotations on the current document and/or 2) if no documents are available after the current document.

Prev Page — To display the next available document in the manual. This button is inactive under one or both of the following conditions:

! There are unlabeled annotations on the current document.

! No documents are available before the current document.

Message — Located under the Delete Mode button. It displays what mode you are in: “Repair,” “Repair Add,” or “Repair Delete.”

Image Manipulation Functions

The following is a list of functions that allow you to manipulate the image document for better viewing. This is usually done before selecting the Add Mode or Delete Mode.

Zoom In — Press the plus (+) key to enlarge the document. (Not available in Add Mode.)

Zoom Out — Press the minus (-) key to reduce the document. (Not available in Add Mode.)

Rotate Left — Press the forward slash or division symbol (/) key to rotate the document 90 degrees counter-clockwise.

Rotate Right — Press the asterisk or multiplication symbol (*) key to rotate the document 90 degrees clockwise.

Home — To display the top left frame of the originally scanned document. Therefore, if the document was rotated 90 degrees to the right, the top right portion of the screen appears. (Not available in Add Mode.)

How to Add a Touchpoint

To add a touchpoint to the currently displayed document, complete the following steps:

1 Use the Image Manipulation functions, if necessary.

2 Select Add Mode. The Add Labels button becomes active.

3 Locate the position for the annotation label.

4 Place the pointer at the needed position and click the mouse.

5 Click Add Label, or right-click the mouse button. This displays the Annotation Label dialog box.

Annotation Maintenance Application 7-3

How to Add a Touchpoint

6 Enter a unique name in the entry line.

7 Click Enter. The annotation label is named and becomes a touchpoint.

How to Delete a Touchpoint

To delete a touchpoint from the currently displayed document, complete the following steps:

1 Be sure that no part information is associated with the touchpoint. (See “Manual and Part Link Maintenance Application” on page 1.)


3 Click Delete Mode.

4 Select the touchpoint you want to remove. This displays the Verify Delete dialog box.

5 Verify the touchpoint to be deleted.

6 If you want to delete the selected touchpoint, click OK. If you do not want to delete the selected touchpoint, click Cancel.

How to Change a Touchpoint Label

To change the label for a touchpoint on the currently displayed document, complete the following steps:



3 Select Change Label.

4 Select the touchpoint you want to change. This displays the Change Label dialog box.

5 Enter in the new label in the Enter New Label entry line.

6 If you want to change all occurrences of the label, select the Check box to change ALL Occurrences check box.

7 Click OK. If you do not want to change the selected touchpoint, click Cancel.

How to Move a Touchpoint Label

To move a touchpoint from its current location to a new location on the currently displayed document, complete the following steps:


Using the Data Window



3 Select Move Label.

4 Place the mouse pointer over the touchpoint label you want to move.

5 Click and hold the right mouse button and drag the pointer to the needed location on the currently displayed document.

6 Release the right mouse button. This places the touchpoint label in this location.


You use the Data Window to build the bill of materials (BOM). To access the Data Window, select Options—Open Data Window.

You can build the BOM by either adding each item individually or by copying and pasting from a spreadsheet. You may combine the two methods in a session.

You can also create BOM/hotspot associations manually or by using Autoincrement. Both of these methods may also be combined in a Data Window.

Data Window Options The data Data Window has the following buttons and options:

Load Data—When clicked, the data is checked for integrity before being loaded to the database. Error messages are displayed in the lower part of the Data Window. If you get an error message, correct it and click Load Data again. Repeat this until you do not receive any more error messages.OK—When clicked, closes the Data Window.Cancel—When clicked, closes the Data Window.Add New Row—When clicked, adds a blank row to the table for data entry.Clear Grid—When clicked, clears all data from the table.Save Errors to Logfile—When clicked AutoIncrement Through Labels—When selected, automatically creates BOM/hotspot associations.Keep on Top—When selected, keeps the Data Window on top of all other windows.

Entering Data in the Data Window

Use the following guidelines for entering data in the Data Window.

You can enter data in either lower- or upper-case. All entries are converted to upper-case when the data is saved to the database.All fields are editable until the data is saved to the database.Each row with data must contain a label.



A row can contain either part information or goto information, but not both.A row can contain only one type of goto information.The Manufacturer's Code must already be in the database.You can use the data window to update quantities.You can use the data window to add a new Label to an Item with an existing Manufacturer's Part Number.You cannot overwrite existing database information for manufacturer parts or item numbers.Data loaded to a page but not associated to a hotspot will be added to the BOM as an unassociated part.

Entering Data Using a Spreadsheet

When entering data using a spreadsheet, the following also apply:

The spreadsheet must have the same columns as the data window, and in the same sequence.Information can be pasted in from different spreadsheets.BOM data can be pasted for a single grid square, a single column, a single row, or a complete BOM.

Entering Data Manually

To enter data into the Data Window manually, complete the following steps:

1 Type the information into a blank row.

2 Click Add New Row to add a blank row and continue adding new data as necessary.

3 Click Load Data, when finished, to upload the data to the database.

4 Create any BOM/Hotspot associations using either manual or AutoIncrementing methods.

Entering Data From a Spreadsheet

To enter data from a spreadsheet, complete the following steps:

1 Ensure that the spreadsheet has the same columns, in the same sequence, as the data window.

2 Copy the data from the spreadsheet that is being pasted into the data window.

3 Click in the Label column of a blank row in the data window, where you want to insert the spreadsheet data.

4 Paste the copied data to the data window.

5 Continue adding new data as necessary.

6 Click Load Data, when finished, to upload the data to the database.

7 Create any BOM/Hotspot associations using either manual or AutoIncrementing methods.



Creating BOM/Hotspot Associations

You can create BOM/Hotspot associations either manually, or by using AutoIncrement. Each method is described below.

Using AutoIncrement

Select AutoIncrement Through Labels on the Navigator Data Window to automatically create BOM/hotspot associations.

When this option is selected, the label in the row of data where the cursor is, becomes the first active hotspot label. A left click on any portion of the image then determines the x,y coordinate for that hotspot label, automatically assigning the label value from the data window and linking the part information to the hotspot. The system automatically increments to the next label on the list. This routine continues for all the remaining rows of data in the data window that have been “loaded” into the database, or until the AutoIncrement field is cleared.

AutoIncrement automatically disables when the last label on the list has been processed. If the AutoIncrement is not started at the top row of the list, AutoIncrement will stop at the end of the list, leaving the rows above the starting point in an unassociated condition. If additional x,y coordinates are clicked on the image, the last autoincremented label will be the label for the new hotspots until a new row of data is selected.

Autoincrementing may also be accomplished by right-clicking on the image to assign the x,y coordinate.

You can close the window by clicking OK or Cancel. All unprocessed data in the data window will be lost, although data loaded to the database remains as unassociated data.

Using Manual Association

Left clicking on any row of the data window, followed by left clicking on the image will determine the x,y coordinate for hotspot placement. This process automatically assigns the label from that row of the data window as the label of the newly created hotspot and associate the corresponding part information to the hotspot. Additional hotspots can be created for the same label by clicking additional x,y positions on the image. Clicking a different row in the data window will create a hotspot for another label value.

You can close the window by clicking OK or Cancel. All unprocessed data in the data window will be lost, although data loaded to the database remains as unassociated data.

How to Save and Quit the QC Document Repair Function

To save changes and quit the QC Document Repair function, click Doc Finished.




The Edit Table of Contents (TOC) application lets you edit the table of contents for an existing manual. You can rearrange table of contents, assign new descriptions or change them, and print the entire table of contents or a portion of it.

The Edit Selection Index window contains a menu bar and the window is split into two panes: left and right. The menu bar contains the following:


Edit — See “Edit Functions” on page 4.






Edit TOC Application 8


Viewing a Table of Contents

Viewing a Table of Contents

When the Edit TOC application starts it automatically prompts you to select a manual. To select a manual to edit its TOC, complete the following steps:

1 Select the manual by either scrolling though the list or entering the manual name on the entry line.

2 Click OK. The corresponding TOC displays in the left pane of the TOC Screen.

The manual’s TOC is displayed in the left window. It is displayed in a hierarchical fashion to indicate the levels of the TOC and what items are included in each level.

The top level of the TOC is the manual’s name. All of the items in the next level are shown beneath the item at the second level. Each entry in the second level can then hold additional entries at a third level, and so on. An entry that contains hidden entries at the next level is indicated by a “plus” symbol. If all of the entries are displayed below an entry, a “minus” sign appears beside the entry.

The right window displays the entry information for the entry that is selected in the left window. Buttons are displayed along the top of this window. These buttons “label” the entry information. Selecting a button opens a dialog box to edit the entry’s information.

The Edit TOC application contains the following buttons:

Description 1 — Shows the first line of the TOC entry’s label.

Description 2 — Shows the second line of the TOC entry’s label.

Manual — Shows the name of the selected manual. This is empty if the entry does not directly open a document.

Document — Shows the document within the manual that is opened from this entry. This is empty if the entry does not directly open a document.

Example of Viewing a Table of Contents


File Functions

File Functions

A File function can be reached from either the File menu or shortcut keys. The following sections list and describe each File function.

Close TOC — Saves the current TOC and closes it.

To save changes to the current TOC and close it, on the File menu, click Close TOC. The TOC window closes and the Select Manual to Edit dialog box opens.

Print All — Prints the entire TOC. The printout of the TOC includes a title with the name of the TOC and the type of print, “Entire TOC.” The printout also includes the day, date, time, and year that it was printed.

To print an entire TOC, on the File menu, click Print All or press CTRL+P. (You may need to select a printer.) A message box opens indicating that the entire TOC is printing and where it is printing. To cancel the print, click Cancel.

Print Subtree — Prints only a portion of the TOC. A “subtree” is considered an entry and all of the entries within it. For example, in the sample graphic “Example of Viewing a Table of Contents” on page 2, you could print the “subtree” Entry 02. The printout would list Entry 02 and all of the entries within it—TOC02. The printout of the TOC includes a title with the name of the TOC and the type of print, “Portion Selected.” The printout also shows the day, date, time, and year that it was printed.

To print a subtree, complete the following steps:

1 Select the entry at the highest level of the subtree you want to print.

2 On the File menu, click Print Subtree or press CTRL+T. (You may have to select a printer.) A message box opens indicating that a page of the TOC is printing and where it is printing. To cancel the print, click Cancel.

Exit — Quits the application and returns to the main menu window.

If you are exiting a TOC that you have modified, the system checks it for errors. If it finds an error, it will not exit, and the TOC with the error will be selected. You must correct the error before exiting.

To exit Edit TOC, click Exit from the File menu, click Exit!, or press the ESC key.

Edit TOC Application 8-3

Edit Functions

Edit Functions

Edit functions can be used to edit the structure of a TOC and to edit entry information.

Edit Cur. Entry — The Edit Cur. Entry function opens a dialog box that lets you edit the selected entry’s information. See “Add/Edit a TOC Entry” on page 8.

Cut Tree — The Cut Tree function removes the selected entry and all of the entries within it and stores it in the clipboard until something else is either cut or copied to the clipboard.

To cut an entry and its contents, complete the following steps:


2 On the Edit menu, click Cut Tree or press CTRL+X.

Copy Entry — The Copy Entry function copies only the selected entry and stores it to the clipboard until something else is either cut or copied to the clipboard.

To copy an entry, complete the following steps:

1 Select the entry you want to copy.

2 On the Edit menu, click Copy Entry or press CTRL+N.

Copy Tree — The Copy Tree function copies the selected entry and all of the entries within it and stores it in the clipboard until something else is either cut or copied to the clipboard.

To copy an entry and its contents, complete the following steps:

1 Select the entry at the highest level of the tree you want to copy.

2 On the Edit menu, click Copy Tree or press CTRL+C.

Paste After — The Paste After function places the information in the clipboard into the TOC after (or within) the currently selected entry. Be sure the contents in the clipboard are what you want to paste!

To paste the contents of the clipboard into the TOC, complete the following steps:

1 Select the entry you want to paste into.

2 On the Edit menu, click Paste After or press CTRL+V.

Delete Tree — The Delete Tree function removes the selected entry and all of the entries within it but does not store it in the clipboard. This function can not be undone!

To delete an entry and its contents, complete the following steps:


Edit Functions


2 On the Edit menu, click Delete Tree or press CTRL+D. The selected contents are permanently removed.

Find — The Find function locates contents within entry labels (descriptions), manual names, or page names that match a specific character string. This function begins its search at the currently selected entry and continues with its search until it reaches the last entry of the currently displayed TOC.

The Find function can search for all entry contents that match a specific character string or it can search for entry contents that are case specific to the character string. Case specific means that all of the characters within the character string must match the upper-case letters (capitals) and lower-case letters exactly.

Once the Find function is selected, a dialog box opens allowing you to enter your search information. Use the TAB key to move to each item in the dialog box. This dialog box contains the following items:


! Search — You can only search in one type of entry information: labels, manuals, or pages. Select the appropriate button for your search.

! Case Sensitive — Choose whether to make your search case sensitive. If selected, the search is case sensitive. If the check box is cleared, the search is not case sensitive.

! OK — Starts the search and finds the next entry field that contains a match with the character string and selects the matching character string.

! Cancel v Cancels the search for the character string and closes the dialog box.

To find a character string, complete the following steps:


2 On the Edit menu, click Find or press CTRL+F. A dialog box opens.

3 Enter the character string you want to find. If you want to make your search case sensitive, select the Case Sensitive check box.

4 Select the appropriate search option.

5 Click OK. The first character string to match is located and selected. If there is no match the right message bar shows “String not found.”

Find Next — The Find Next function finds the next entry that contains a match with the character string previously entered for the Find function. It then highlights the matching character string.

To find the next occurrence of the character string previously entered, on the Edit menu, click Find Next or press CTRL+G.


Edit Functions

Replace — The Replace function locates a character string and replace it with a new character string. This function begins its search at the currently selected entry and continues with its search until it reaches the last entry of the currently displayed TOC.

Once the Replace function is selected, a dialog box opens. Use the TAB key to move to each item in the dialog box. This dialog box contains the following items:


! Replace — Type the character string that will replace the old character string.


! OK — Starts the search for the “Find” character string.


To replace a character string, complete the following steps:


2 On the Edit menu, click Replace or press CTRL+R. A dialog box opens.

3 Enter the character string you want to find.

4 Press TAB.

5 Enter the character string you want to use to replace the one found.

6 Select the appropriate search option.

7 Click OK. If there is a match, the old character string is located and selected, and a Find and Replace Query dialog box opens.

8 Choose and select one of the following Find and Replace Query buttons listed below.

Replace/Next — Replaces the currently selected character string with the new character string and locates and select the next occurrence of the old character string.

Replace All — Replaces all occurrences of the old character string with the new character string.

Next — Does not replace the currently selected character string and locates and select the next occurrence of the old character string.

Cancel — Cancels the Replace function and remove the Find and Replace Query dialog box.


Options Functions

9 At the end of a Replace function, a dialog box lists the number of successful replacements and the number of replacements that failed. Click OK.

Options Functions

Options functions can be used to add new entries to the TOC. The following sections list and describe each Options function.

Add New Entry — The Add New Entry function opens the appropriate dialog box to allow you to enter a new entry for the TOC. See “Add/Edit a TOC Entry” on page 8.

Add Multiple Entries — The Add Multiple Entries function opens the appropriate dialog box to allow you to enter a new entry for the TOC. Once an entry is entered and accepted, the dialog box opens again to allow you to enter another entry at the same level as the previous entry. See “Add/Edit a TOC Entry” on page 8.

Verify TP Parts Docs — The Verify TP Parts Docs function lets you check the existing table of contents to make sure that at least one entry exists for each touchpointed parts document. When selected, this function displays a window that states one of the following conditions:

! all the touchpointed parts documents have entries,

! no touchpointed parts documents exist in the current table of contents, or

! it lists the touchpointed parts documents that do not have entries.

To check the TOC to ensure that at least one entry exists for each touchpointed parts document, on the Options menu, click Verify TP Parts Docs.

Create TOC for Parts Docs — The Create TOC for Parts Docs function lets you check the existing table of contents to make sure that at least one entry exists for each touchpointed parts document, as well as to automatically create new entries at the top of the current table of contents for each touchpointed parts document. When selected, this function displays a window that states one of the following conditions:

! all the touchpointed parts documents have entries,

! no touchpointed parts documents exist in the current table of contents, or

! it lists the touchpointed parts documents that do not have entries.

If the function lists documents, it then lets you automatically create table of contents entries for each of the listed documents. These entries are given generic names. After you have saved the TOC, you can open Display Manual and use the new generic entries to display the documents. Once you know which documents these are, you can then edit the generic entries and rename them properly. See “Add/Edit a TOC Entry” on page 8.


Options Functions

To check the TOC for an entry for each touchpointed parts document and then create entries, complete the following steps:

1 On the Options menu, click Create TOC for Parts Docs.

2 If you choose to create entries for the listed documents, click Yes. The entries are then created.

Add/Edit a TOC Entry

Adding or editing a TOC is done in the TOC Editing dialog box.

TOC Editing Dialog Box

NOTE An entry only requires information to be entered in Description 1 entry line for it to be a valid entry.

Description 1 — Enter the first line of the entry label.

Description 2 entry line — Enter the second line of the entry label.

Doc. Name drop-down list — Select the document that the entry will automatically open.

OK — Accepts the entry information and closes the dialog box.

Cancel — Does not accept the entry information and closes the dialog box.

Clear — Clears all of the information in the dialog box.

Steps to Add To add a TOC entry, complete the following steps:

1 Select the TOC entry to contain the new entry.

2 Decide whether to add a single entry or more than one entry.

To add a single entry, on the Options menu, click Add New Entry or press CTRL+A. A dialog box opens.

To add more than one entry, on the Options menu, click Add Multiple Entries or press CTRL+M. A dialog box opens.

3 Enter the description for the entry label in the Description entry lines.


Options Functions

4 If the entry is to open a document in Display Manual when selected, select the document to open from the Doc. Name drop-down list.

5 Once all of the information is correct, click OK.

Steps to Edit To edit a TOC entry, complete the following steps:

1 Select the TOC entry to edit.

2 Either click an entry information button in the right window, on the Edit menu, click Edit Cur. Entry or press CTRL+E.

3 Edit any of the information in the dialog box.

4 Once all of the information is correct, click OK.


Options Functions


The Security application lets you add users to the database, delete users from the database, and modify the security data for existing users. Security is only effective for applications and functions of Navigator that require security clearance. If an application or function requires a security clearance a dialog box opens that requires you to enter your user ID and password.

The Add, Modify, Delete Security dialog box opens as soon as the application is started.

Add, Modify, Delete Security Data Dialog Box

Security Maintenance Application 9


Add, Modify, Delete Users Function


The Add, Modify, Delete Users function lets you update existing user's security data, add users to the database, and delete users from the database. This window contains the following items:

User ID — Type the user ID. A user ID must be the first set of data entered. If the user ID already exists, all of the entry lines will automatically contain the data that is associated with the user ID. If the user ID does not exist, the rest of the data must be entered. The character string for the user ID can be a maximum of 15 characters long. The minimum length for a valid user ID is determined by the MINIMUM USER ID=X parameter in the IPCSYS.INI file.

Down Arrow — Lets you display a list of existing user ID's. This button is located on the right side of the user ID entry line. Press the Down Arrow button to display the list of existing user ID's. If there is more than one full list of user ID's, a scroll bar becomes available. You may select a user from the User ID list. A selected user ID appears in the User ID entry line.

Password — Type the current password for the user. The character string for the password can be a maximum of 15 characters long. The minimum length is determined by the MINIMUM PASSWORD LENGTH=X parameter in the IPCSYS.INI file.

Password Verify — Type the current password a second time for verification.

User Name — Type the name of the user. The character string for the user name ranges from zero characters to 25 characters long.

Department — Type the department where the user is located. The character string for the department ranges from zero characters to 15 characters long.

Password change frequency — Type the number of days before the system will force a user password to be changed. The frequency default is 90 days. If all of the characters in this entry line are erased, the value for the frequency will be 0 (zero).

Security Level — Where the user's level of security is indicated. Security levels range from 0 to 10, with 10 being the highest security level and giving clearance for all applications and functions. 0 (zero) will only allow the user to open the applications and functions that require no security clearance. The Security Level default is level 5. If all of the characters in this entry line are erased, the Security Level will be level 0 (zero). A user cannot increase his/her own security level, and they can only give other users a security level equal to or less than their own security level.

Add — Adds a new user's security data.

Delete — Deletes a user's security data.

Modify — Saves the changes you have made to a user's security data.




Quit — Closes the dialog box and quits the application.

Help — Displays Help.

About — Displays the current release level.

To open the Add, Modify, Delete Security Data dialog box, on the Options menu, click the Add, Modify, Delete Users. Once open, the cursor will be placed at the beginning of the User ID entry line.

How to Add a User to the Database

The following is a set of instructions to add a new user to the database.

To add a new user to the database, complete the following steps:

1 Enter the user ID in the User ID entry line or select it from the Down Arrow drop-down list located underneath the entry line.

2 Press TAB. This moves the cursor to the Password entry line.

3 Enter the password. The password appears as asterisks.

4 Press TAB. This moves the cursor to the Password Verify entry line.

5 Enter the password again.

6 Press TAB. This moves the cursor to the User Name entry line. If the password is not the same as the first password, the system beeps and the message bar instructs you to re-enter the password. Select the password with the mouse and repeat Step 5 and Step 6. If the password is the same as the first password, continue with Step 7.

7 Enter the user's name.

8 Press TAB. This moves the cursor to the Department entry line.

9 Enter the department where the user is located.

10 Press TAB. This moves the cursor to the Password change frequency entry line.

11 Enter the password change frequency (in days).

12 Press TAB. This moves the cursor to the Security level entry line.

13 Enter the security level for the user.

14 Click Add or press TAB before pressing the ENTER key.

Security Maintenance Application 9-3


How to Modify a User's Security Data

The following is a set of instructions to modify security data for an existing user.

To modify a user's security data, complete the following steps:

1 Enter the user ID in the User ID entry line or select it from the Down Arrow drop-down list.

2 Press TAB. This displays all of the corresponding data in the entry lines and place the cursor at the beginning of the Password entry line.

3 Edit the password.

4 Press TAB. This moves the cursor to the Password Verify entry line.

5 Edit the password again.

6 Press TAB. This moves the cursor to the User Name entry line. If the password is not the same as the first password, the system beeps and the message bar instructs you to re-enter the password. Select the password with the mouse and repeat Step 5 and Step 6. If the password is the same as the first password, continue with Step 7.

7 Edit the user's name.

8 Press TAB. This moves the cursor to the Department entry line.

9 Edit the department where the user is located.

10 Press TAB. This moves the cursor to the Password change frequency entry line.

11 Edit the password change frequency (in days).

12 Press TAB. This moves the cursor to the Security level entry line.

13 Edit the security level for the user.

14 Click Modify or press TAB three times before pressing the ENTER key.



How to Delete a User from the Database

The following is a set of instructions to delete a user from the database.

To delete a user's security data, complete the following steps:

1 Enter the user ID in the User ID entry line or select it from the Down Arrow drop-down list.

2 Press TAB. This enters all of the corresponding data in the entry lines and place the cursor at the beginning of the Password entry line.

3 Click Delete. A confirmation dialog box opens stating that a user will be deleted from the database, and ask if you want to continue. If you want to delete the user, click Yes. Otherwise, click No.

Security Maintenance Application 9-5

How to Modify Security Levels of Functions

How to Modify Security Levels of Functions

The System Administrator can modify the security levels of any of the Control Center applications. These security levels are held in the OPERATION table. If the application has a level of 0, no password is required. If a value higher than zero is found, the user is prompted for a password. The user security level is then compared to the operation security level. If the user security level is equal to or higher than the operation security level, the application is enabled.

Below is a complete listing of the Control Center default entries in the OPERATION table. Select lines may be used to update the Navigator database using the site's database update tool, such as SQL*PLUS for Oracle. Or, the entire list may be entered into a file, edited and then used as input to the database update tool.

Navigator Default Operation Table Entries

UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'SECURITY UPDATE';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'ANNOTATION CAPTURE';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'QA ANNOTATION CAPTURE';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'PARTS DATA ENTRY';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'PARTS DATA UPDATE';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'LINK PARTS DATA TO TPS';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'LINK UPDATE';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'LINK MAINTENANCE';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'LINK MAINTENANCE UPDATE';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'IMPORT EXPORT UTILITIES';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'DATABASE UTILITIES';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'ERROR LOG REPORT';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'STATS REPORT';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'SHOW PAGE NOTES';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'WORKSTATION INIT';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'DELETE BOOKMARKS';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'EDIT SEL INDEX AND TOC';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'MANUAL AND PARTS MAINT';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'TEXT DOCUMENT CREATION';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'PART CROSS REFERENCE';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'DISPLAY MANUAL';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'ADD PAGE NOTE';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'ADD TP NOTE';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'ADD A BOOKMARK';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'QUERY BY MFGR NUMBER';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'QUERY BY INTRL NUMBER';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'QUERY BY NOUN';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'QUERY BY DESC';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'QUERY BY ASSET';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'DISPLAY ASSETS';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'PARTS FILE INQUIRY';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'HASH UPDATE';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'SELECTION INDEX';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'SHOW DOCUMENTS';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'DELETE NOTES';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'DISPLAY SETTINGS';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'RESET MANUAL RESTART INFO';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'EDIT PAGE NOTE';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'DELETE PAGE NOTE';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'EDIT TP NOTE';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'DELETE TP NOTE';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'BROWSE OR PRINT PAGE NOTES';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'MODIFY OR DELETE PAGE NOTES';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'LICENSE INFORMATION';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'MODIFY PASSWORD';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'BATCH DATA ENTRY';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'INTRL ASSOC PARTS SEARCH';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'PRINT FROM PART NUMBER INQUIRY';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'PRINT FROM SEARCH FUNCTIONS';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'PRINT FROM DOCUMENT VIEWER';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'REDLINE VIEWER';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'BATCH CREATION';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'QC LINK';UPDATE OPERATION SET SECURITY_LEVEL = '0' WHERE NAME = 'KEY PART';UPDATE OPERATION SET SECURITY_LEVEL = '10' WHERE NAME = 'MFR CODE RENAME';


The Show Documents application lets you view all documents in your Navigator database, to display their attributes, and to print either all of them or a portion of them.

The Show Documents window contains a title bar and a menu bar. The title bar displays the name of the application and the name of the currently displayed document. It is located along the top of the window. The menu bar is located directly under the title bar. The menu bar contains the following:


Manual Options — See “Manual Options Functions” on page 3.

Document Options — See “Document Options” on page 2.

Attributes — See “Attributes Functions” on page 4.

Print — See “Print Functions” on page 6.





Show Documents Application 10


Document Options

Document Options

The Document Options allow image manipulation. These functions are the same as those of the Display Manual application. These functions allow you to manipulate a document for better viewing and/or printing. The following is a list of the functions and their corresponding function keys.

All TPs On/Off — F5

Zoom Up — plus sign (+)

Zoom Down — minus sign (-)

Scale to Fit — F7

Pan Left — left arrow key (only if the document is zoomed up)

Pan Right — right arrow key (only if the document is zoomed up)

Pan Up — up arrow key (only if the document is zoomed up)

Pan Down — down arrow key (only if the document is zoomed up)

Invert On/Off — SHIFT+F5

Rotate Left — division symbol or forward slash (/)

Rotate Right — multiplication symbol or asterisk (*)


Manual Options Functions

Manual Options Functions

The Options Functions can be reached from the Options menu. There are three Manual Options functions: Select Document, Page Forward (Page Down key), and Page Backward (Page Up key).

Select Document

The Select Document function lets you display a document by selecting a manual and, optionally, a document number. This function is useful if you do not know the document number of the document that you want to display. Once it is selected, the Specify Manual dialog box opens:

Select Document Dialog Box

Select Manual — Type a manual name or use the drop-down list to select a manual. A manual name consists of two alpha-characters and four numeric-characters; two letters and four single-digit numbers.

Document Number — Type the number of the document that you want to display. The character string for the document number must be five characters long. This entry line is optional. If no document number is entered, “00001” will be the default document number. If the document number that was entered does not exist, an error message appears. Click OK and re-enter an existing document number.

OK — Displays the specified manual and document.

Cancel — Cancel the function and close the dialog box.

To display a document using the Specify Manual function, complete the following steps:

1 On the Options menu, click Select Document. Once open, the cursor appears at the beginning of the Manual Name entry line.

2 Type an existing manual name or select one from the drop-down list. If you do not want to enter a document number, go to Step 5. Otherwise, continue with Step 3.

Show Documents Application 10-3

Attributes Functions

3 Press TAB. This moves the cursor to the beginning of the Document Number entry line.

4 Enter a document number.

5 Click OK or press ENTER. If any error message boxes are displayed, follow the instructions, if any are given, and click OK. Repeat all of the steps: Otherwise, the document opens.

Use the Page Backward command to page backward through the manual.

Use the Page Forward command to page forward through the manual.


The Attributes Functions can be reached from the Attributes menu. There are two Attributes functions: Document Attributes, and Display Attributes. These functions are active only when a document is currently displayed.

Document Attributes

The Document Attributes function displays information about the image of the currently displayed document and the original document that was scanned. When selected, the Document Information message box opens:

Document Information Message Box

DPI — Resolution, dots per inch, of the original document that was scanned.

Compression — Type of image that is displayed.! Line art will have the following values: 4202, 4203, 4205, & 4206.! Grayscales will have the following values: 5900 & 5901.! Color images will have the following value: 6301.

Bits/Pixel — Bits per pixel or the number of colors or grayscale levels. The current values for this attribute should be either 1 or 8.



Inverted — If YES, the displayed document is inverted from the originally scanned document. If NO, the displayed document is not inverted from the originally scanned document.

Width — Width of the document in pixels.

Height — Height of the document in pixels.

Document Size — Gives the standard drafting type size for the scanned document. The following is a list of the standard drafting type sizes:! A: 8.5 X 11! B: 11 X 17! C: 17 X 22! D: 22 x 34! E: 34 X 44! J: anything larger than an E.

OK — Closes the Document Information dialog box.

Display Attributes

The Display Attributes function displays the settings for the currently displayed document. Once it is selected, the Display Settings message box opens:

Display Settings Message Box

Orientation — Gives the degrees of rotation of the displayed document from the original scanned orientation.

Inverted — If YES, the displayed document is inverted from the originally scanned document. If NO, the displayed document is not inverted from the originally scanned document.

Display Position — How the document is displayed on the screen.

Font Size — Not applicable.

Document Size — Gives the standard drafting type size for the scanned document. The following is a list of the standard drafting type sizes:! A: 8.5 X 11! B: 11 X 17! C: 17 X 22! D: 22 x 34! E: 34 X 44! J: anything larger than an E.

Show Documents Application 10-5

Print Functions

Initial Display — How the document is displayed on the screen. The following is a list of display options.

Scale to Fit — The image is reduced to fit on the screen.

One to one — The image is shown at its actual size.

Zoom Ratio — The Zoom level of the document when it is initially displayed.

OK — Closes the Display Settings message box.

To display the settings for the currently displayed document, on the Attributes menu, click Display Attributes.

Print Functions

The Print Functions can be reached from the Print menu. There are two Print functions: Print Full Document and Print Portion of Document. These functions are active only when a document is currently displayed.

Print Full Document

The Print Full Document function prints the entire current document. To print an entire document, complete the following steps:

1 On the Print menu, click Print Full Document. If there is more than one printer, the Select Printer for Document dialog box opens. Otherwise, the document is printed.

2 Select the appropriate printer.

3 Click OK. The document is printed.

TIP Double-click the appropriate printer in Step 2 instead of selecting it.)

Print Portion of Document The Print Portion of Document function prints the displayed portion of the current document.To print a portion of the document, complete the following steps:

1 On the Print menu, click Print Portion of Document. If there is more than one printer, the Select Printer for Document dialog box opens. Otherwise, the portion of the document is printed.

2 Select the appropriate printer.

3 Click OK. The document prints.

TIP Double-click the appropriate printer in Step 2 instead of selecting it.)


The Delete Manual application lets you delete a whole manual from the Navigator database.

The Delete Manual window contains a title bar and a menu bar. The title bar displays the name of the application. The menu bar contains the following:


Options — The only Options command is Delete a Manual. See “Delete a Manual Function” on page 2.





Delete Manual Application 11


Delete a Manual Function

Delete a Manual Function

The Delete a Manual function lets you locate a single manual and delete it from the Navigator database. After you select Delete a Manual from the Options menu, the Delete a Manual dialog box opens:

Delete a Manual Dialog Box

Select Manual — Type the name of the manual you want to delete or select the manual from the drop-down list.

Also Delete — Boxes that allow you to choose information to delete in addition to the manual.! Image Files! Index and TOC Entries! Annotations and Path! All Unlinked Mfr Part Numbers in the System

OK — Opens a message box asking if you are sure you want to delete the manual. Click Yes to delete the manual. Click No to return to the dialog box without deleting the manual.

Clear — Clears the name of the manual in the Select Manual field.

Cancel – Cancels the function and closes the dialog box without changes.

To delete a manual, complete the following steps:

1 On the Options menu, click Delete a Manual.

2 From the Select Manual field, select a manual or type a manual name.

3 Click OK. A message box opens.

4 Click Yes to delete the manual. Click No to return to the dialog box without deleting the manual.


The Pagenotes Maintenance application lets you display and edit existing page notes for documents.

The Pagenotes Maintenance window contains a title bar and a menu bar. The title bar displays either the name of the application or what document is currently displayed. It is located along the top of the window. The menu bar contains the following:







NOTE When in this application, you can use the PAGE UP and PAGE DOWN keyboard keys to display the pagenotes for each document that has page notes associated with it.

PAGE UP — Displays the document and page notes that are previous to the currently displayed document and page notes. If you reach the beginning of the manual, a dialog box opens stating this. And, if you reach the beginning of the first manual of all that are displayed, the dialog box will state that all manuals have been processed in the reverse direction. Click OK or press ENTER.

PAGE DOWN — Displays the document and page notes that follow the currently displayed document and page notes. If you reach the end of the manual, a dialog box opens stating this. And, if you reach the end of the last manual of all that are displayed, the dialog box will state that all manuals have been processed in the forward direction. Click OK or press ENTER.

Pagenotes Maintenance Application 12


File Functions

File Functions

The File functions can be reached through the File menu. The three Options functions are Print Last Review Page Note, Print Range of Reviewed Page Notes, and Exit.

Print Last Review Page Note — See “Printing Reviewed Page Notes” on page 7.

Print Range of Reviewed Page Notes — See “Print a Date Range of Page Notes” on page 8.

Exit — The Exit function closes the application and returns to the main menu window.

If you are exiting a TOC that you have modified, the system checks it for errors. If it finds an error, it will not exit, and the TOC with the error will be selected. You must correct the error before exiting.

To exit Edit TOC, on the File menu, click Exit, click Exit!, or press the ESC key.

Options Functions

The Options functions can be reached through the Options menu or by shortcut keys or function key. The three Options functions are Show Page Notes for Manual, Show All Page Notes, and Review New/Modified Page Notes.


Options Functions

Show Page Notes for Manual

The Show Page Notes for Manual function lets you edit page notes that are associated with documents in a single manual. Once this function is selected, the Specify Manual dialog box opens:

Specify Manual Dialog Box

Manual Name — Type the name of the manual whose page notes you want to display. A manual name must consist of two alpha-characters and four numeric-characters; two letters and four single-digit numbers. The drop down list button is next to the entry line and displays a list of the available manuals. You may also select the manual from this list.

OK — Retrieves and displays the first document within the manual that has page notes associated with it.

Quit — Closes the dialog box and cancels the function.

To display page notes associated with documents in a single manual, complete the following steps:

1 On the Options menu, click Show Page Notes for Manual.

2 Enter a manual name or select a manual from the drop down list. (A manual name must consist of two alpha-characters and four numeric-characters; two letters and four single-digit numbers.)

3 Click OK or press ENTER. If the manual does not exist, an error message box opens. Click OK and repeat Step 2 and Step 3. To edit the page notes, see “How to Edit Page Notes” on page 5.

Pagenotes Maintenance Application 12-3

Options Functions

Show All Page Notes

The Show All Page Notes function lets you edit page notes that are associated with documents for all of the manuals in the database.

To display page notes associated with documents for all manuals, on the Options menu, click Show All Page Notes. To edit the page notes, see “How to Edit Page Notes” on page 5.

Review New/Modified Page Notes

The Review New/Modified Page Notes function lets you review new page notes and any page notes that have been modified. While reviewing a page note, you may also edit it. This is available in the Review Page Notes window

To display the Review Page Notes window and enable the reviewing functions, on the Options menu, click Review New/Modified Page Notes. To review page notes, see “How to Review Page Notes” on page 5.


Pagenote Procedures

Pagenote Procedures

How to Edit Page Notes

When a document and its page notes are displayed, the page notes are located in the Page Notes dialog box located at the bottom of the window. This dialog box contain the following items:

Page notes dialog box – is where the notes are displayed and can be edited using basic text editing functions.

Save Changes – saves the changes you have made to the page notes during the edit session. This button becomes active after the note has been modified.

To edit page notes, complete the following steps:

1 Edit the note.

2 Click Save Changes to save the changes to the note.

How to Delete Page Notes

Deleting page notes is a secured function located in Display Manual. It also can be done while reviewing page notes. (See “How to Review Page Notes” on page 5 for more information.)

To delete a page note, complete the following steps:

1 Open the page note in Display Manual.

2 Press SHIFT+DELETE. This displays the User ID and Password dialog box.

3 Enter your user ID and password. Click OK. This displays a delete confirmation dialog box.

4 Click Yes. The page note is deleted.

5 Close the Page Note dialog box.

How to Review Page Notes

There are three steps to reviewing page notes: starting a review session, editing/deleting page notes, and printing page notes. These three steps are described in the following sections.

Once you have started a review session the Review Page Notes window is displayed. This window contains the following items:

Status Bar — This is located at the bottom of the window and is used to display status information. While retrieving page notes, this displays the


Pagenote Procedures

current manual being processed and the last page note processed. While displaying page notes, this displays the date of the last modification to the page note and the date of the last time the page note was reviewed.

Page Note — This window is located above the status bar and has an edit window where the page notes are displayed and edited. The Home key moves the cursor to the top of the window. The End key moves the cursor to the bottom of the window. Use the Page Up/Page Down keys to page up and down in the window. This window also contains the following two buttons:

Save Note — This saves any changes you make to the page note. It is inactive (grayed) if you have not made any changes to the page note.

Delete Note — This deletes the page note from the database.

Document — This window is located above the Page Note window and it displays the document for the currently displayed page notes.

Quit — Ends the Review New/Modified Page Notes session and returns to the Pagenotes Maintenance window.

Previous Note — Displays the previously reviewed page note. This button is inactive if the currently displayed page note is the first page note for the session. The SHIFT+PAGEUP key sequence also performs this function.

Next Note — Displays the next page note to review. This button is inactive if the currently displayed page note is the last page note for the session. The SHIFT+PAGEDOWN key sequence also performs this function.

Print Note — Prints the page note currently displayed.

Print Doc — Prints the document currently displayed.

Starting a Review Session

When starting a Review New/Modified Page Notes session, you are first prompted to set the review start date.

Review Start Date — This is where you enter the month, date, and year (either MM-DD-YY or MM-DD-YYYY) for the needed starting date for the current session of the function.

OK — This accepts the start date entered and begins the session at that date.

Clear — This clears the Review Start Date entry line.

Cancel — This does not start a Review New/Modified Page Notes session and returns to the Pagenotes Maintenance window.

To start a review session, complete the following steps:

1 Enter the date in the Review Start Date entry line of the Set Review Start Date dialog box.


Pagenote Procedures

2 Click OK. This displays the first page note for the session.

Editing and Deleting a Page Note

To edit a page note, complete the following steps:

1 Make any changes to the page note in the Page Note window. Once you make a change, the Save Note button becomes active.

2 Once you are satisfied with the changes, click Save Note.

To delete a page note, click Delete Note. This permanently removes the page note from the database.

Printing Reviewed Page Notes

The following is a list of print options available while reviewing page notes.

Print the currently displayed page note.

Print the currently displayed document.

Print all of the page notes from the current session.

Print all of the page notes for a specified date range.

Print a Page Note: Steps To print one reviewed page note, complete the following steps:

1 Use the Previous Note and Next Note buttons to display the reviewed page note.

2 Click Print Note.

Print a Document: Steps To print one reviewed page note, complete the following steps:

1 Use the Previous Note and Next Note buttons to display the reviewed page note and document.

2 Click Print Doc.

Print a Session's Page Notes: Steps

To print all of the reviewed page notes in the current session, On the File menu, click Print Session Page Notes.


Pagenote Procedures

Print a Date Range of Page Notes

The Print Range of Reviewed Page Notes function lets you specify a date range for the page notes you want to print in the Set Print Date Range dialog box. This dialog box contains the following items:

From — This is where you enter the month, date, and year (either MM-DD-YY or MM-DD-YYYY) for the needed starting date for the page notes to be printed. All of the page notes modified or reviewed on this date are included in the printing process.

To — This is where you enter the month, date, and year (either MM-DD-YY or MM-DD-YYYY) for the needed ending date for the page notes to be printed. All of the page notes modified or reviewed on this date are included in the printing process.

OK — This prints all of the page notes in the specified date range.

Clear — This clears the From and the To entry lines.

Cancel — This cancels the print function and returns to the Review Page Note window.

To print page notes for a specified date range, complete the following steps:

1 On the File menu, click Print Range of Reviewed Page Notes. This displays the Set Print Date dialog box.

2 Enter the starting date for the date range in the From entry line.

3 Enter the ending date for the date range in the To entry line.

4 Click OK.


The Export Manuals, TOCs, and Index application lets you export data from a source database to a flat file. For each function, Export Manuals, TOCs and Index also creates a log file that contains key information regarding the function (for example, manual summary totals).

The initial Export Manuals, TOCs and Index window displays a menu bar. The menu bar contains the following:

The Import Manuals, TOCs and Index window contains a menu bar and function buttons. The menu bar contains the following:


Options — The Options commands are the same as the function buttons, which are described in this chapter.! Setup! Export Manuals! Export Table of Contents! Export Selection Index! Exit





Export Manuals, TOCs, and Index Application 13


Export Setup

Export Setup

The Setup function lets you view and modify paths for the Export functions. This is done in the Export INI File Settings dialog box.

NOTE All field default settings are defined in the [EXPORT] section of the IPCSYS.INI file. See “Export” on page 4 for more information.

Export INI File Settings Dialog Box

TOC flat file path — Displays the path for the TOC flat file.

TOC Log File Path — Displays the path for the log file generated when exporting a TOC.

Manual Flat File Path — Displays the path for the Manual flat file.

Manual Log — Displays the path for the log file generated when exporting a TOC.

Sel. Index Flat File Path — Displays the path for the Selection Index flat file.

Sel. Index Log — Displays the path for the log file generated when exporting a Selection Index.

Enter New File Path — Allow you to enter new paths for the selected flat file, log file, or part file.

Export Nouns — Exports nouns associated with a source document for the Export Manuals function. (This feature is not applicable for this version of Navigator.)


Export Setup

Export Page Notes — Exports page notes associated with a source document for the Export Manuals function.

Export Asset Information — Exports asset information associated with a source document for the Export Manuals function.

Export Location Information — Exports location information associated with a source document for the Export Manuals function.

Export Internal Parts — Exports internal parts associated with a source document for the Export Manuals function.

Export Touchpoint Notes — Exports touchpoint notes associated with a source document for the Export Manuals function.

Export Superseded Parts — Exports superseded parts associated with a source document for the Export Manuals function.

Undo Changes — Cancels all changes that you made upon opening the Export INI File Settings window.

Save to INI — Replaces the parameters in the appropriate INI file with the paths displayed in the Export INI File Settings window.

Reset from INI — Replaces the displayed paths with the parameters set in the appropriate INI file.

OK — Saves any changes you made to the paths and closes the window.

To make path changes for the TOC flat file, the TOC log file, the Manual flat file, the Manual log file, the Selection Index flat file, the Selection Index log file, and/or associated information for the Export Manual function, complete the following steps:

1 On the Options menu, click Setup.

2 Select Enter New File Path for the file path.

3 Enter the new path and click OK.

4 Repeat steps 2 and 3 for each file path you want to change.

5 Determine the associated information you want included for the Export Manual function and check the appropriate boxes.

NOTE These boxes are overridden by any selections made in the Export Manuals function. See “How to Export Manuals” on page 4 for more information.

6 Click OK to save the changes and close the window.

Export Manuals, TOCs, and Index Application 13-3

How to Export Manuals


The Export Manuals function lets you select complete manuals to export. Each complete manual exported resides in its own, separate flat file. The file name extension for these files is.mld. When selected, the Export Complete Manuals dialog box opens:

Export Complete Manuals Dialog Box

Manuals Available — Displays a list of existing manual names and descriptions of source manuals. If there is more than one full list of manuals, a scroll bar becomes available. Each manual entry in the Manuals Available field acts as a toggle switch. Therefore, if a manual is selected once, it is displayed in the Manuals Selected field; if the same manual is selected again, it will be removed from the Manuals Selected field.

Manuals Selected — Displays the selected manuals to be exported.

Select All Manuals — Displays all of the manual entries in the Manuals Available field in the Manuals Selected field. If de-selected, the Manuals Selected field will be cleared.

Completely replace target manual — Has no effect.

Include Options — Allow you to export specific data associated with a source document, such as:! Noun Names ! Internal Parts! Asset! Page Notes! Touchpoint Notes! Superseded Parts! Locations

OK — Accepts the manual selections and export them to the designated flat file.

Clear — Clears the Manuals Selected field and return all boxes to their default position as defined in the [EXPORT] section of the IPCSYS.INI file.



Cancel — Removes the dialog box and cancel the function.

To export complete manuals, complete the following steps:

1 On the Options menu, click Export Complete Manuals. This displays the Export Complete Manuals dialog box.

2 From the Manuals Available field, select the manual entries to be exported, OR if you want to export all of the manuals listed, select the Select All Manuals field.

3 Select any of the Include Options boxes desired.

NOTE These boxes override any selections made in the Setup function. See “Export Setup” on page 2 for more information.

4 Click OK. This exports all of the manuals listed to the designated flat file.

5 When the export is complete, a message box opens stating how many manuals were successfully exported. Click OK.


How to Export Table of Contents

How to Export Table of Contents

The Export Table of Contents function lets you select multiple manuals' tables of contents to export. Each manual's table of contents exported will reside in its own, separate flat file. The file name extension for these files is .ftc. When selected, the Export Table of Contents dialog box opens:

Export Table of Contents Dialog Box

TOCs Available — Displays a list of existing manual names and descriptions of source manual TOCs. If there is more than one full list of manuals, a scroll bar becomes available. Each manual entry in the TOCs Available field acts as a toggle switch. Therefore, if a manual is selected once, it is displayed in the TOCs Selected field; if the same manual is selected again, it will be removed from the TOCs Selected field.

TOCs Selected — Displays the selected manuals tables of contents to be exported.

Select All TOCs — Displays all of the manual entries in the TOCs Available field in the TOCs Selected field. If not selected, the TOCs Selected field is cleared.

OK — Accepts the manuals' tables of contents selections and export them to the designated flat files. While exporting, the window displays the full path and name of the log file, the name of the manual being processed, and the number of the manual out of the total number of manuals being processed (for example, 1 of 4).

Clear — Clears the TOCs Selected field.

Cancel — Removes the dialog box and cancel the function.

To export multiple manuals' tables of contents, complete the following steps:


How to Export a Selection Index

1 Select Export Multiple Manual TOCs from the Options menu. This displays the Export Multiple Manual TOC dialog box.

2 From the TOCs Available field, select the manual entries to be exported, OR if you want to export all of the manuals' tables of contents listed, select the Select All TOCs field.

3 Click OK. This exports all of the manual table of contents listed to the designated flat files, and it displays the full path and name of the log file, the name of the manual being processed, and the number of the manual out of the total number of manuals being processed (for example, 1 of 4).

4 When the export is complete, a message box opens stating this. Click OK.

How to Export a Selection Index

This function lets you export the default Navigator selection index for your Navigator database.

NOTE The default Navigator selection index is designated in the [ORACLE] section of the IPCSYS.INI file. See “Oracle” on page 7 for more information.

To export the default Navigator selection index, complete the following steps:

1 On the Options menu, click Export Sel. Index. This instantaneously exports the default Navigator selection index.

2 Once complete, a message box opens stating that the export was successful. Click OK.

The exported files can be found in the path specified in the IPCEXP.INI file. See “IPCEXP.INI File Section and Parameters” on page 8 for more information.


Log Files

Log Files

Log files are created during the export processes so that you can monitor the processes. The log files are stored in a path designated in the IPCSYS.INI file.

TOC Log Files

One log file is created for each export process and includes data regarding all of the TOCs selected for a single process. The log files are stored at the path determined in the Setup function. Each log displays the following information:

the type of export process


the manual name

the number of records written (1 record = 1 TOC entry of any level)

the number of manuals successfully processed


any messages

The following is an example of a log file created while exporting the table of contents for manual BJ0001.

Exporting Single Manual TOCs Mon Nov 29 08:35:28 1999

Exporting Manual BJ00011 Records Written

1 Manuals exported

Manual Log Files

One log file is created for each export process and includes data regarding all of the manuals selected for a single process. The log files are stored at the path determined in the Setup function. Export log files have an “.eml” file extension. Each log displays the following information:

the type of export process


the manual name

the number of pages

the number of parts

the number of touchpoints


Log Files

a list of the total number of manuals, pages, parts, and touchpoints processed


any messages

The following is an example of a log file created while exporting a portion of the manual BJ0001.

Exporting ManualsMon Nov 29 08:35:28 1999

Exporting Manual BJ0001 3 Pages 3 Parts 2 Touchpoints

Final Totals 1 Manuals 3 Pages 3 Parts 2 Touchpoints

Selection Index Log Files

One log file is created for the export process, and it includes data regarding the selection index exported. The log files are stored at the path determined in the Setup function. This log displays the following information:


the path and filename of the selection index processed

the total number of lines in the selection index successfully processed


any messages

The following is an example of a log file created while exporting the selection index SEL18.IDX.

Mon Nov 29 08:35:28 1999

Exporting Selection Index from File 'C:\AllenBaker\SELECT~1\Sel18.IDX'.

Total Lines = 97


Log Files


The Part Data Synchronization (PDS) application provides a quick and reliable method of loading customer internal part information that would otherwise need to be entered by hand. This application uses the customer’s manufacturer codes and part numbers to find matches with manufacturer part numbers that exist in the Navigator database. If a match is found, PDS then loads the customer internal part information into the Navigator database. PDS may also be used to load customer’s internal parts that are not associated with a manufacturer. In essence, PDS synchronizes the Navigator database with the customer’s inventory system parts database.

The PDS user interface consists of a menu bar, menu screens, and PDS function screens. This menu bar is displayed for each window of PDS—although, certain options may be inactive or grayed out, depending on the current window. Menu screens contain buttons that you use to select the PDS function. Function screens allow you to execute the PDS function.

The menu bar contains three menus: File, Options, and Reports. The File menu contains one item, Exit, which is used to exit (or quit) the PDS utility program. The keyboard shortcut for the Exit menu item is ALT+F4.

The Options menu contains items that represent main menu window buttons and subsequent menu window buttons. Below is the hierarchy of the Options menu items:

Setup — Not yet available, but will be used to modify your PUP.INI file [PUP-PDS] parameter settings.

Purge Part Numbers — Displays a submenu consisting of the following functions:

! Purge All Unlinked Manufacturer Part Numbers – Displays the Purge All Unlinked Manufacturer Part Numbers function window.

! Purge Customer Part Numbers — Displays the Purge Customer Part Numbers function window.

Part Data Synchronization Application 14


Manufacturer Cross Reference Functions — Displays a submenu consisting of the following functions:

! Create Manufacturer Cross Reference File — Displays the Create Manufacturer Cross Reference File function window.

! Purge Manufacturer Cross Reference Database — Displays the Purge Manufacturer Cross Reference Database function window.

! Create Manufacturer Cross Reference Database — Displays the Create Manufacturer Cross Reference Database function window.

Create Filtered Manufacturer Parts Database — Displays the Create Filtered Manufacturer Parts Database function window.

Run Part Data Synchronization – Displays the Run Part Data Synchronization function window.

The PDS Main Menu window contains six buttons, five of which either display another menu window or the corresponding function window. (See the corresponding menu items listed above in the PDS Menu Bar description.) The Quit button exits the PDS utility program.

Each menu window beyond the Main Menu contains functions specific to your Main Menu selection, and contains two common buttons:

Return — Returns to the previously displayed window.

Quit — Exits the PDS utility program.

PDS Function screens display the name of the selected function, a list of information specific to the function, and up to five common function buttons:

Run — Starts the selected function.

Pause — Pauses the function while it is running. (This button is not available for Manufacturer Cross Reference functions.)

Resume — Resumes running the function after it has been paused. (This button is not available for Manufacturer Cross Reference functions.)

Stop — Stops the function and does not allow you to resume running the function. (This button is not available for Manufacturer Cross Reference functions.) All data processed to the point when the Stop button is pressed appears on the various output reports and will be added to the Navigator parts database.

Return — Returns to the previously displayed window.

Most functions list counters that keep track of the data for the specific function. Some functions may also have a progress bar that displays the percentage of input data that has been processed.


Setting Up for PDS

Below is the logical sequence for performing PDS functions. See each function’s section for more information.

1 First, you should purge all un-linked manufacturer parts from the Navigator database. You may also want to purge any un-linked customer internal part numbers.

2 Purge the Manufacturer Cross Reference Database and then create a new Manufacturer Cross Reference Database.

3 Run Part Data Synchronization.

Setting Up for PDS

Before using the PDS utility, you must prepare your input data. Two essential steps must be completed: create a parts file from your inventory system, and create a cross reference file of Navigator manufacturer codes and descriptions to customer manufacturer codes and descriptions. These two files work together with PDS to update the Navigator database with customer parts information.

Customer ASCII Parts File Layout

You must run a query against your inventory system parts database to create the ASCII Parts File. This file is then used in conjunction with the Navigator/Customer Manufacturer Code Cross Reference File to update the Navigator database.

The Customer ASCII Parts File can consist of either delimited variable length records or fixed length records with the following information:

NOTE Positions are for fixed length field/records.

The following is a list of requirements for this file.

If the file contains fixed length records, all fields must be left justified and blank filled.

The file should be sorted in ascending sequence using the first four fields. (Customer manufacturer code—primary sort field, Customer manufacturer name, Manufacturer part number, Internal part number.)

Field Description Length Positions

Customer manufacturer code (optional) 40 001 - 040

Customer manufacturer name (optional) 25 041 - 065

Manufacturer part number (optional) 60 066 - 125

Internal part number (required) 60 126 - 185

Part description (required) 250 186 - 495

Part Data Synchronization Application 14-3

Setting Up for PDS

If the source database part description field is greater than 250 characters in length, it must be truncated before writing it to the output file.

If the source database contains multiple manufacturers code/part number associations to a single customer internal part number, the output file will include a separate record for each manufacturer part/internal part association.

Navigator/Customer Manufacturer Code Cross Reference File Layout

The Navigator/Customer Manufacturer Code Cross Reference File is used to cross reference the customer manufacturer codes in the Customer ASCII Parts File with Navigator manufacturer codes in the Navigator database(s). The Navigator/Customer Manufacturer Code Cross Reference File can consist of either delimited variable length records or fixed length records with the following information:

NOTE Positions are for fixed length field/records.

The following is a list of requirements for this file.

If the file contains fixed length records, all fields must be left justified and blank filled.

The file should be sorted by customer manufacturer code within customer manufacturer name in ascending sequence.

Each Navigator manufacturer code may be associated with one or more customer manufacturer codes. For example, Navigator manufacturer code ALLE can be associated with customer manufacturer codes 123456 (Allen Bradley) and 246802 (JCI).

Each customer manufacturer code must be associated with one and only one Navigator manufacturer code.

A customer’s manufacturer name may not agree with the associated Navigator manufacturer name. For example, customer manufacturer name CENTRICO can be associated with Navigator manufacturer name WESTFALIA.

As a starting point for creating this file, it may be useful to create an ASCII file containing fixed length records or variable length pipe (|) delimited records from your inventory system. Each record would contain the following four fields: 1) customer manufacturer code—if it is four alpha numeric characters or less—or the first four characters of the customer manufacturer name, 2) first 25 characters of the customer manufacturer name, 3) customer manufacturer code, 4) customer manufacturer name.

Field Description Length Positions

Navigator manufacturer code 4 001 - 004

Navigator manufacturer name 25 005 - 029

Customer manufacturer code 40 030 - 069

Customer manufacturer name 40 070 - 109


Setting Up for PDS

PDS PUP.INI File Settings

Once you determine your file formats, and you understand which data appears on which report, you need to determine your PDS PUP.INI file settings under the [PUP-PDS] section. See “Understanding PDS Reports” on page 14-17.

Part Data Synchronization

1 Specify the database mode as exclusive (DATABASE MODE=X) or shared (DATABASE MODE=S).

2 Specify whether the Navigator/Customer Manufacturer Code Cross Reference File contains delimited (OEMCODES FILE FORMAT=DELIMITED) or fixed length (OEMCODES FILE FORMAT=FIXED) records.

3 Specify the character delimiter for a delimited Navigator/Customer Manufacturer Code Cross Reference File (OEMCODES FILE DELIMITER=”|”). This setting is ignored if the file contains fixed length records.

4 Specify the complete path (including filename) for the Navigator/Customer Manufacturer Code Cross Reference File. (OEMCODES FILE PATH=...)

5 Specify whether the Customer ASCII Parts File contains delimited (OEMPARTS FILE FORMAT=DELIMITED) or fixed length (OEMPARTS FILE FORMAT=FIXED) records.

6 Specify the delimiter for a delimited Customer ASCII Parts File (OEMPARTS FILE DELIMITER=”|”). This setting is ignored if the file contains a fixed length record.

7 Specify the complete path (including filename) for the Customer ASCII Parts File. (OEMPARTS FILE PATH=...)

8 Specify whether the data in a specific report text file should be loaded into the Navigator parts database (OEMPARTS LOAD PDSRPRTxx=YES), or not (OEMPARTS LOAD PDSRPRTxx=NO) The xx is the report number; 20, 30, 40, 50, 60, 70.

NOTE All data on Report 25 is automatically loaded.

9 Specify whether the internal part data in the PDS report 50 text file should be automatically loaded into the Navigator parts database (OEMPARTS LOAD PDSRPRT50=AUTO ASSOCIATE), to be asked to load and associate (OEMPARTS LOAD PDSRPRT50=ASK TO ASSOCIATE), or not loaded (OEMPARTS LOAD PDSRPRT50=NO).


Setting Up for PDS

10 Specify whether customer internal part numbers found on report 60 should be associated with corresponding customer manufacturer part numbers in the Navigator database (ASSOCIATE PDSRPRT60=YES), or not (ASSOCIATE PDSRPRT60=NO).

NOTE Navigator allows for multiple associations known as “many to many” part relationships. This is when an internal customer part number can be associated to more than one manufacturer part number and a manufacturer part number can be associated to more than one internal customer part number.

11 Specify whether the program writes report data to report tables, PUPREPORTxx – where xx is the report number, in a relational database (TABLE OUTPUT = YES), or not (TABLE OUTPUT = NO).

NOTE Existing data is purged from a report table only if new data is generated for that report when running Parts Data Synchronization. The default setting is TABLE OUTPUT = NO.

12 Specify whether the program writes report data to flat files (ASCII text files) named PDSRPTxx.TXT, where xx is the report number (FLAT FILE OUTPUT=YES), or not (FLAT FILE OUTPUT=NO). The default setting is FLAT FILE OUTPUT=YES.

13 Specify the complete path for PDS output reports. (OEMPARTS REPORT PATH=...) These reports are named pdsrptxx.txt where xx is the report number.

14 Specify the delimiter used to separate columns in PDS generated TXT reports. (REPORT COLUMN DELIMITER=...) These delimited reports allow the creation of report generation functions in Excel®, Access®, and Crystal ReportsTM without having multiple configurations to handle “short” and “long” reports. (Short reports can have a maximum of 20 characters for part numbers and 40 characters for part descriptions. Long reports can have a maximum of 60 characters for part numbers and 250 characters for part descriptions.)

15 Specify the program executable that displays the reports (OEMPARTS VIEWER PATH PDSRPTxx) and any parameters that are passed on to that display program (OEMPARTS VIEWER PARM PDSRPTxx) where xx is the report number. Alternatively, default executables and/or parameters may be used. Contact your IBM System Engineer for more information about default parameters.

NOTE The example below shows the Crystal Reports solution.

16 Specify the complete path (including filename) for the PDS log file. (PUPPDS LOG FILE PATH=...) This report is named puppds.txt.

17 In addition to checking unfiltered manufacturer part numbers, specify whether you want to use filtered parts (USE FILTERED PARTS=YES), or not (USE FILTERED PARTS=NO).


Setting Up for PDS

18 Specify whether Report 20 records should be further analyzed (ANALYZE REPORT 20=YES), or not (ANALYZE REPORT 20=NO) for further inclusion on Report 50. If yes is specified, each Report 20 record will be further analyzed to see if the corresponding filtered customer manufacturer part number matches any filtered Navigator manufacturer part numbers. If so, the input record appears on both PDS Report 20 and Report 50.

19 Specify the minimum length for customer manufacturer part number to be considered for output Report 50 (MIN CUST OEM PART LEN=X). The X is the number of characters.

20 Specify whether unused Navigator manufacturer codes should be purged from the Navigator manufacturer code database table when the manufacturer code cross reference database table is purged (PURGE MFR CODES=YES), or not (PURGE MFR CODES=NO). The default is PURGE MFR CODES=NO. An Navigator manufacturer code is unused if no parts or manuals are associated to it.

21 Specify whether all internal parts (PURGE INTERNAL EXCEPTION = NONE), all internal parts except those associated to manufacturer parts (PURGE INTERNAL EXCEPTION = MFR), or all internal parts except those associated to manufacturer parts that are associated to touchpoints (PURGE INTERNAL EXCEPTION = TP) should be purged from the Navigator parts database. This parameter applies to the ‘PUP – Purge Internal Part Numbers’ option. The only exception to these internal part purging rules is that internal parts, linked by themselves to one or more touchpoints, will never be purged from the Navigator parts database.

22 If the customer provided manufacturer code does not exist in the Navigator manufacturer code cross reference database table, specify whether to automatically generate Navigator manufacturer codes (GENERATE MFR CODES=YES), or not (GENERATE MFR CODES=NO). The default is GENERATE MFR CODES=NO. If GENERATE MFR CODES=YES, records that would normally be included in Report 20 would be included in one or more of the other reports.

23 If GENERATE MFR CODES=YES (see above parameter), define valid character set for the four positions in the generated manufacturer code. (MMII MFR CODE # = n) Where # represents the code position, 1 through 4, and n are the available characters used to generate the code for the given position. For example, if MMII MFR CODE 1 = XYZ, and all other positions of the Navigator manufacturer code are “0123456789,” the first generated Navigator manufacturer code would be Z000, the second would be Z001, etc. The last available generated Navigator manufacturer code would be Z999.


Setting Up for PDS

For Example: DATABASE MODE=XOEMCODES FILE FORMAT=DELIMITEDOEMCODES FILE DELIMITER=”|”OEMCODES FILE PATH=F:\IPC\PUP\FILES\OEMCODE.DATOEMPARTS FILE FORMAT=FIXEDOEMPARTS FILE DELIMITER=”|”OEMPARTS FILE PATH=F:\IPC\PUP\FILES\IPDRECS.DATOEMPARTS LOAD PDSRPT20=NOOEMPARTS LOAD PDSRPT30=NOOEMPARTS LOAD PDSRPT40=NOOEMPARTS LOAD PDSRPT50=NO OEMPARTS LOAD PDSRPT52=NOOEMPARTS LOAD PDSRPT54=NOOEMPARTS LOAD PDSRPT60=NOOEMPARTS LOAD PDSRPT70=NOASSOCIATE PDSRPT60 PARTS=NOTABLE OUTPUT = NOFLAT FILE OUTPUT=YESOEM REPORT PATH=c:\crw\reportsREPORT COLUMN DELIMITER = |OEMPARTS VIEWER PATH DEFAULT=WRDPAD.EXEOEMPARTS VIEWER PATH PDSRPT10=F:\IPC\PUP\REPORTS\PDSRPT10.EXEOEMPARTS VIEWER PARM PDSRPT10=F:\IPC\PUP\REPORTS\PDSRPT10.TXTOEMPARTS VIEWER PATH PDSRPT20=F:\IPC\PUP\REPORTS\PDSRPT20.EXEOEMPARTS VIEWER PARM PDSRPT20=F:\IPC\PUP\REPORTS\PDSRPT20.TXTOEMPARTS VIEWER PATH PDSRPT25=F:\IPC\PUP\REPORTS\PDSRPT25.EXEOEMPARTS VIEWER PARM PDSRPT25=F:\IPC\PUP\REPORTS\PDSRPT25.TXTOEMPARTS VIEWER PATH PDSRPT30=F:\IPC\PUP\REPORTS\PDSRPT30.EXEOEMPARTS VIEWER PARM PDSRPT30=F:\IPC\PUP\REPORTS\PDSRPT30.TXTOEMPARTS VIEWER PATH PDSRPT40=F:\IPC\PUP\REPORTS\PDSRPT40.EXEOEMPARTS VIEWER PARM PDSRPT40=F:\IPC\PUP\REPORTS\PDSRPT40.TXTOEMPARTS VIEWER PATH PDSRPT50=F:\IPC\PUP\REPORTS\PDSRPT50.EXEOEMPARTS VIEWER PARM PDSRPT50=F:\IPC\PUP\REPORTS\PDSRPT50.TXTOEMPARTS VIEWER PATH PDSRPT52=F:\IPC\PUP\REPORTS\PDSRPT52.EXEOEMPARTS VIEWER PARM PDSRPT52=F:\IPC\PUP\REPORTS\PDSRPT52.TXTOEMPARTS VIEWER PATH PDSRPT54=F:\IPC\PUP\REPORTS\PDSRPT54.EXEOEMPARTS VIEWER PARM PDSRPT54=F:\IPC\PUP\REPORTS\PDSRPT54.TXTOEMPARTS VIEWER PATH PDSRPT60=F:\IPC\PUP\REPORTS\PDSRPT60.EXEOEMPARTS VIEWER PARM PDSRPT60=F:\IPC\PUP\REPORTS\PDSRPT60.TXTOEMPARTS VIEWER PATH PDSRPT70=F:\IPC\PUP\REPORTS\PDSRPT70.EXEOEMPARTS VIEWER PARM PDSRPT70=F:\IPC\PUP\REPORTS\PDSRPT70.TXTPUPPDS LOG FILE PATH=f:\IPC\pup\logsUSE FILTERED PARTS=YESANALYZE REPORT 20=YESMIN CUST OEM PART LEN=4PURGE MFR CODES=YESPURGE INTERNAL EXCEPTION=MFRGENERATE MFR CODES=YESMMII MFR CODE 1=ZMMII MFR CODE 2=0123456789MMII MFR CODE 3=0123456789MMII MFR CODE 4=0123456789


Purging Part Numbers


There are two part number purging functions: Purge All Unlinked Manufacturer Part Numbers and Purge Customer Part Numbers. These purge functions help you to “clean up” the Navigator database before re-synchronizing your part data.

Purge All Unlinked Manufacturer Part Numbers

This function purges (removes) all of the manufacturer part numbers in the database that are not linked to any touchpoints. Purging these part numbers before running PDS ensures that no unlinked manufacturer part numbers remain in the Navigator database. When a manufacturer part number is removed from the Navigator parts database, the corresponding filtered part number is also removed from the Navigator filtered parts database.

CAUTION Once this function is selected, a warning message box opens stating that once this function is complete you cannot undo it. In other words, once part numbers are purged from the database, you cannot retrieve them. Therefore, make sure that your Navigator databases are backed up before running this (or any other) PDS function.

The Purge All Unlinked Manufacturer Part Numbers function window contains all five function window buttons, displays a progress indicator, and lists the following counters:

Manufacturer Parts Read — A counter that lists the number of manufacturer parts read from the Navigator parts database.

Manufacturer Parts Deleted — A counter that lists the number of manufacturer parts that were purged from the Navigator parts database.

Manufacturer Parts Found Linked and Not Deleted — A counter that lists the number of manufacturer parts that were not purged because they were linked to one or more touchpoints.

Manufacturer Superseded Parts Deleted — A counter that lists the number of superseded parts (part numbers replaced by new part numbers and no longer in use) that were purged from the Navigator parts database.

Manufacturer Filtered Parts Deleted — A counter that lists the number of “filtered” part numbers that were purged from the Navigator parts database. See “Create Filtered Manufacturer Parts Database” on page 14-14 for more information about filtered part numbers.

To purge all unlinked manufacturer part numbers from the Navigator parts database, complete these steps:

1 On the PDS Main menu, click Purge Part Numbers. This displays the Purge Part Numbers menu window.

2 Click Purge All Unlinked Manufacturer Part Numbers. The warning message box opens.



3 If you wish to continue, click Continue. The corresponding function window opens. (If you do not wish to purge manufacturer part numbers, click Cancel.)

4 Click Run.

Purge Customer Part Numbers

This function purges (removes) all of the customer (internal) part numbers in the Navigator parts database that are not linked directly to touchpoints. Purging these part numbers before running PDS ensures no customer (internal) part numbers from previous PDS runs remain in the Navigator parts database except those directly linked to touchpoints.

CAUTION Once this function is selected, a warning message box opens stating that once this function is complete you cannot undo it. In other words, once part numbers are purged from the database, you cannot retrieve them. Therefore, make sure that your Navigator databases are backed up before running this (or any other) PDS function.

The Purge Customer Part Numbers function window contains all five function window buttons and lists the following counters:

Customer Parts Read — A counter that lists the number of customer (internal) parts read from your Navigator parts database.

Customer Parts Deleted — A counter that lists the number of customer internal parts that were purged from the Navigator parts database.

Customer Parts Found Linked and Not Deleted — A counter that lists the number of customer internal parts that were not purged because they were linked directly to one or more touchpoints.

Customer Superseded Parts Deleted — A counter that lists the number of customer (internal) superseded parts (part numbers replaced by new part numbers and no longer in use) that were purged from the database.

To purge customer (internal) part numbers from the Navigator parts database, complete these steps:

1 On the PDS Main menu, click Purge Part Numbers from. This displays the Purge Part Numbers menu window.

2 Click Purge Customer Part Numbers. The warning message box opens.

3 If you wish to continue, click Continue. The corresponding function window opens. (If you do not wish to purge customer (internal) part numbers, click Cancel.)

4 Click Run.


Manufacturer Cross Reference Functions


Manufacturer Cross Reference functions allow you to create a manufacturer cross reference file, purge (remove) all records from the manufacturer cross reference database, and then create a manufacturer cross reference database or update an existing manufacturer cross reference database.

Create Manufacturer Cross Reference File

This function is used to create a fixed or variable length record ASCII file (OEMCODE.XXX) from an existing Manufacturer Cross Reference (OEMCODE) database. If you currently have a fixed length OEMCODE.XXX file and you wish to change to a variable length (pipe delimited) file format for ease of ongoing maintenance, perform the following steps:

1 Run the Create Manufacturer Cross Reference (OEMCODE) Database function using the fixed length OEMCODE.XXX file.

2 Modify the PUP.INI file [PUP-PDS] section as follows:

OEMCODES FILE FORMAT = DELIMITEDOEMCODES FILE DELIMITER = “|”OEMCODES FILE PATH = d:\IPC\pup\files\oemcodes.var

NOTE For the OEMCodes file path, replace “d:\IPC” with the actual installed location.

3 Run the Create Manufacturer Cross Reference File function.

The Create Manufacturer Cross Reference File function window contains two function window buttons, Run and Return, and lists the following counters:

IPC Codes – A counter that lists the number of Navigator manufacturer codes found in the Navigator database.

Customer Manufacturer Codes – A counter that lists the number of customer manufacturer codes that are cross referenced to Navigator manufacturer codes.

To create a manufacturer cross reference file, complete these steps:

1 On the PDS Main menu, click Manufacturer Cross Reference Functions. This displays the Manufacturer Cross Reference menu window.

2 Click Create Manufacturer Cross Reference File. The corresponding function window opens.

3 Click Run.

NOTE See “Navigator/Customer Manufacturer Code Cross Reference File Layout” on page 14-4 for the format required to complete this file.



Purge Manufacturer Cross Reference Database

This function purges the Manufacturer Cross Reference Database, removing all data from the database. When an Navigator manufacturer code is removed from the Manufacturer Cross Reference Database, the code is also removed from the Navigator Manufacturer Code database if no manufacturer part numbers exist for the corresponding manufacturer code.

CAUTION Once this function is selected, a warning message box opens stating that once this function is complete you cannot undo it. In other words, once records are purged from the database, you cannot retrieve them. Therefore, make sure that your Navigator databases are backed up before running this (or any other) PDS function.

The Purge Manufacturer Cross Reference Database function window contains two function window buttons, Run and Return.

To purge the manufacturer cross reference database, complete these steps:


2 Click Purge Manufacturer Cross Reference Database. The warning message box opens.

3 If you wish to continue, click Continue. The corresponding function window opens. (If you do not wish to purge the database, click Cancel.)

4 Click Run.

Create Manufacturer Cross Reference Database

This function uses the Manufacturer Cross Reference File to update or create a new Manufacturer Cross Reference Database. The Create Manufacturer Cross Reference Database function window contains all five function window buttons, displays a progress indicator, and lists the following counters:

Input Records Read — A counter that lists the number of data records read from the ASCII flat file.

New IPC Manufacturer Codes and Descriptions — A counter that lists the number of new Navigator manufacturer codes and descriptions that were added to the manufacturer database.

Updated IPC Manufacturer Descriptions — A counter that lists the number of Navigator manufacturer descriptions in the database that were updated with a new description.

New XRef IPC Manufacturer Codes — A counter that lists the number of new Navigator manufacturer codes that were added to the cross reference database.



New XRef Customer Manufacturer Codes and Descriptions — A counter that lists the number of new customer manufacturer codes and descriptions that were added to the cross reference database.

Updated XRef Customer Manufacturer Descriptions — A counter that lists the number of customer manufacturer descriptions in the cross reference database that were updated with a new description.

Input Data Errors — A counter that lists the number of errors that occurred while loading the data in the Manufacturer Cross Reference Database. These error records will be listed in the PUPPDS log file. For example, an input record that would result in an error would be a customer manufacturer code that was cross referenced to more than one Navigator manufacturer code.

To create the manufacturer cross reference database, complete these steps:


2 Click Create Manufacturer Cross Reference Database. The corresponding function window opens.

3 Click Run.


Creating a Filtered Manufacturer Parts Database

Creating a Filtered Manufacturer Parts Database

Creating a filtered Navigator manufacturer parts database creates a new parts database where all spaces and non-alphanumeric characters are removed from each manufacturer part number. By removing dashes, slashes, spaces, or any other non-alphanumeric characters, PDS can then find more matches. For example, a customer manufacturer part number may be “32-104,” where the Navigator database has “3201-4” and “32 104” for manufacturer part numbers. After filtering the Navigator manufacturer part numbers, both of these part numbers would then “match” the customer’s filtered part number during the PDS run. Any matches made during the PDS run should then be reviewed to determine whether the Navigator part numbers matches the customer’s part number.

See the following:

“Report 30—Matched One Filtered Manufacturer Part and Code” on page 14-19“Report 40—Matched Multiple Filtered Manufacturer Parts and Code” on page 14-19“Report 50—Matched Manufacturer Part(s) Only/No Associated Navigator Internal Part” on page 14-20“Report 52—Matched Manufacturer Part(s) Only/Same Associated Navigator Internal Part” on page 14-21“Report 54—Matched Manufacturer Part(s) Only/Different Associated Navigator Internal Part” on page 14-22.

Create Filtered Manufacturer Parts Database

The Create Filtered Manufacturer Parts Database function is used to filter the Navigator database. This function window contains all five function window buttons, displays a progress indicator, and lists the following counters:

IPC Mfr. Part Records Read — A counter that lists the number of Navigator manufacturer parts that were found in the Navigator parts database.

IPC Filtered Mfr. Part Records Written — A counter that lists the number of Navigator manufacturer part numbers that were filtered and loaded into the Navigator filtered parts database.

To create a filtered manufacturer parts database, complete these steps:

1 On the PDS Main menu, click Create Filtered Manufacturer Parts Database. This displays the corresponding function window.

2 Click Run.


Running the Part Data Synchronization

Running the Part Data Synchronization

The Run Part Data Synchronization function synchronizes the Navigator parts database with the customer’s inventory system parts database. The Run Part Data Synchronization function window contains all five function window buttons, displays a progress indicator, and lists the following counters:

Input Records Read — A counter that lists the number of customer internal parts data records processed by the function.

New Customer Manufacturer Parts Added — A counter that lists the total number of new customer manufacturer parts that were added to the Navigator database.

New Internal Parts Added — A counter that lists the total number of new internal parts added to the Navigator database.

Nouns Added — A counter that lists the total number of noun names added to the Navigator database. (This feature is not applicable to this version of Navigator.)

Existing Internal Part Associations Found — A counter that lists the total number of internal part associations already existing (from previous PUP-PDS runs) in the Navigator database.

Updated Internal Part Descriptions — A counter that lists the number of internal part descriptions that were updated in the Navigator database.

Minutes Remaining — The approximate time remaining before the part data synchronization run is complete.

TIP Before running Part Data Synchronization, you need to determine which parts should be loaded into the Navigator database. Parts are loaded into the database according to which report they fall under. Read “Understanding PDS Reports” on page 14-17 and then set the appropriate parameters in the PUP.INI file.

To run part data synchronization, complete these steps:

1 Set the appropriate parameters in the PUP.INI file. See “PDS PUP.INI File Settings” on page 14-5.

2 On the PDS Main menu, click Run Part Data Synchronization. This displays the corresponding function window.

3 Click Run.




The below SQL script (analyzeonly_schema.sql) computes statistics on the entire schema instead of table by table. Note that the script doesn't need to be updated when tables are added or dropped.

The script should be run whenever there is a large change to the database, such as running Part Data Synchronization. This increases the efficiency of any Oracle operations used by Navigator. To run the script change the “IPC” in the script to the applicable schema name.

SET SERVEROUTPUT ONBEGIN DBMS_OUTPUT.ENABLE(2000000);dbms_utility.analyze_schema('IPC','compute');END;/


Understanding PDS Reports


PDS generates a series of reports as it synchronizes the customer part data with the Navigator data. Reports 20 through 70 determine the part data that is loaded into the Navigator database. In the PUP.INI file, you can set which report’s data are loaded and which report’s data are not loaded. See “PDS PUP.INI File Settings” on page 14-5.

Retrieving Data from Report Tables within Database

PDS has the capability to write report data to report tables within a relational database. You may then use any database tool to retrieve report data from the report tables, PUPREPORTxx – where xx is the report number.

Existing data is purged from a report table only if new data is generated for that report when running Parts Data Synchronization. To activate this functionality, see “PDS PUP.INI File Settings” on page 14-5.

Report 10—New Internal Part Associations Made

Report 10 gives a summary of the number of manufacturer parts and new internal part associations made during the part data synchronization run. This report lists the following information for each manufacturer:

Customer Manufacturer Code

Cross Referenced Customer Manufacturer Description

Navigator Manufacturer Code

Navigator Manufacturer Description

Total Customer Input Records (for the corresponding manufacturer)

Total New Associations (how many new internal parts were associated) to existing manufacturer parts and then added to the Navigator parts database

This report is useful because it lets you see:

How many new matches occurred between customer manufacturer part numbers and Navigator manufacturer part numbers.

How many of those customer internal parts were new and added to the Navigator parts database.



Report 20—No Xref Customer Manufacturer Code

Report 20 lists the customer manufacturer codes that did not match with any manufacturer codes in the Navigator manufacturer code cross reference database. It includes the following summary information:


Customer Manufacturer Description

Total Number of Records in the IPDRECS.DAT File for This Undefined Manufacturer Code

You can use this report to determine which customer manufacturer codes should be added to the ASCII flat file (OEMCODE.DAT) of manufacturer code cross references. These customer manufacturer codes can be loaded into the Navigator parts database. See “PDS PUP.INI File Settings” on page 14-5.

Report 25—Matched One Manufacturer Part and Code Exactly

For a record to be listed on Report 25, it must meet the following conditions:

The customer manufacturer code must cross reference to an Navigator manufacturer code.

The customer manufacturer part number matches exactly with a single unfiltered Navigator manufacturer part number The associated internal part information will always be added to the Navigator parts database.

This report lists the following information for each exact match:

Input Record Number



Matched Customer Manufacturer Part Number

Customer Internal Part Number (the customer internal part number associated with the customer manufacturer part number)

Customer Internal Part Description

Navigator Manufacturer Part Number

Navigator Manufacturer Part Description


Navigator Manufacturer Name

Report 25 is useful because it lists all of the parts that synchronize initially. All records on Report 25 are automatically loaded into the database.



Report 30—Matched One Filtered Manufacturer Part and Code

For records to be listed on Report 30, it must meet the following conditions:


The customer manufacturer code and part number do not match any Navigator manufacturer code and part number exactly.

The Navigator filtered parts database must exist.

The customer manufacturer code and filtered part number match one, and only one, Navigator manufacturer code and filtered part number.

This report lists the following information for each match:

Input Record Number



Matched Customer Manufacturer Part Number (unfiltered format)



Navigator Manufacturer Part Number (unfiltered format)




These records can be loaded into the Navigator parts database. See “PDS PUP.INI File Settings” on page 14-5.

Report 40—Matched Multiple Filtered Manufacturer Parts and Code

For records a be listed on Report 40, it must meet the following conditions:


The customer manufacturer code and part number do not match any Navigator manufacturer code and part number exactly.

The Navigator filtered parts database must exist.

The customer manufacturer code and filtered part number match the Navigator manufacturer code and two or more filtered manufacturer part numbers.



This report lists the following information for each match:

Input Record Number










These records can be loaded into the Navigator parts database. See “PDS PUP.INI File Settings” on page 14-5.

Report 50—Matched Manufacturer Part(s) Only/No Associated Navigator Internal Part

Report 50 lists each match (without using the Navigator manufacturer code) between a customer manufacturer part number and a Navigator manufacturer part number that does not have an associated internal part number. This report file includes the following information:

Input Record Number


Cross Referenced Customer Manufacturer Name

Customer Manufacturer Part Number

Customer Internal Part Number


Navigator Manufacturer Part Number




Cross Referenced Navigator Manufacturer Code



Cross Referenced Navigator Manufacturer Name

Use this report to determine whether or not the manufacturer part number matches actually are correct matches. Correct matches should be determined by comparing the customer internal part description and Navigator manufacturer part description. If a number of filtered manufacturer parts match Navigator filtered manufacturer parts for a given Navigator manufacturer code, it might indicate a new or updated customer manufacturer code cross reference for the OEMCODE ASCII file before running PUP-PDS again. These records can be loaded into the Navigator parts database. See “PDS PUP.INI File Settings” on page 14-5.

NOTE If the Navigator manufacturer part number has the character string “(F)” in front of the part number, it means that both the customer manufacturer part number and the Navigator manufacturer part number had to be filtered before they matched.

Report 52—Matched Manufacturer Part(s) Only/Same Associated Navigator Internal Part

Report 52 lists each match (without using the Navigator manufacturer code) between a customer manufacturer part number and a Navigator manufacturer part number that already has an associated Navigator internal part number. The associated Navigator internal part number matches the customer provided internal part number. This report file includes the following information:

Input Record Number



Cross-Referenced Navigator Manufacturer Code (the Navigator manufacturer code that is cross referenced to the customer manufacturer code)






Navigator Associated Internal Part Number

Navigator Associated Internal Part Description

Navigator Associated Manufacturer Code (associated with the matched Navigator Mfr. Part Number)



Use this report to determine which customer manufacturer part numbers have previously been matched and already have the customer internal part number associated to the corresponding Navigator manufacturer part number. These records can be loaded into the Navigator parts database. See “PDS PUP.INI File Settings” on page 14-5.


Report 54—Matched Manufacturer Part(s) Only/Different Associated Navigator Internal Part

Report 54 lists each match (without using the Navigator manufacturer code) between a customer manufacturer part number and a Navigator manufacturer part number that already has an associated Navigator internal part number. The associated Navigator internal part number is different from the customer provided internal part number. This report file includes the following information:

Input Record Number



Cross-Referenced Navigator Manufacturer Code (the Navigator manufacturer code that is cross referenced to the customer manufacturer code)






Navigator Associated Internal Part Number

Navigator Associated Internal Part Description

Navigator Associated Manufacturer Code (associated with the matched Navigator Mfr. Part Number)

Use this report to determine which customer manufacturer part numbers have previously been matched and, as a result, a different customer internal part number has already been loaded into the Navigator database and associated to the corresponding Navigator manufacturer part number.

Use this report to determine which customer manufacturer part numbers have previously been matched and already have a different customer internal



part number associated to the corresponding Navigator manufacturer part number. These records can be loaded into the Navigator parts database. See “PDS PUP.INI File Settings” on page 14-5.


Report 60—Duplicate Internal Parts

Report 60 lists the new customer manufacturer part numbers that are associated to another customer internal part number. This report lists the following information for each match:

Input Record Number



New Customer Internal Part Number (the new customer internal part number associated with the customer manufacturer part number)

New Customer Internal Part Description

Existing Internal Part Number (which differs from the new customer internal part number)

Existing Customer Internal Part Description





Use this report to determine whether or not the customer’s inventory system contains two internal part numbers for the same manufacturer part. Duplicate customer internal part numbers should be determined by comparing the new customer internal part description with the existing internal part description and the Navigator manufacturer part description. These records can be loaded into the Navigator parts database. See “PDS PUP.INI File Settings” on page 14-5.

NOTE If the Navigator manufacturer part number has the character string “(F)” in front of the part number, it means that both the customer manufacturer part number and the Navigator manufacturer part number had to be filtered before they matched and caused a duplicate internal part number situation.



Report 70—Unmatched Customer Manufacturer Parts

Report 70 lists all of the customer manufacturer parts that did not match any Navigator manufacturer parts. This report lists the following information:

Input Record Number



Customer Manufacturer Part Number

Customer Internal Part Number




When Navigator is initially installed and the manufacturer part numbers from only a few parts manuals have been converted to Navigator format, most of the input records from a customer’s inventory system will be initially listed on this report. These customer manufacturer and internal parts can be loaded into the Navigator parts database. See “PDS PUP.INI File Settings” on page 14-5, allowing users to use Navigator to requisition any part from the storeroom.

NOTE Records that only contain internal part information are also on this report. You must load Report 70 to load internal parts that do not have any manufacturer information associated with them.


The Maximo Upload application loads Navigator information into Maximo. It updates the Maximo database with part number information and associates part information to Maximo asset numbers. When you click the Maximo Upload button, the Maximo Upload application opens in a new window.

NOTE The Maximo Upload application must be closed for data synchronization to occur.

Running the Maximo Upload Application

To run the Maximo Upload application, complete the following steps:

1 On the Control Center main menu, click Maximo Upload or from the Options menu, click Maximo Upload. A new window opens for the Maximo Upload application. The Login dialog box opens over top.

Login Dialog Box

Maximo Upload 15



2 Type the necessary information for logging in to the Maximo Upload application.

Navigator Host — The name of database server with the Navigator schema.

Navigator Port — The port where Oracle is running.

Navigator Instance — The name of the Oracle database instance for the database server.

Navigator User ID — An alphanumeric string to identify users who access the individual applications of the Control Center.

Navigator Password — An alphanumeric string that goes with the Navigator User ID to allow access to the individual applications of the Control Center.

Maximo Host — The name of the server running the Maximo server applications.

Maximo User ID — An alphanumeric string to identify users who access the Maximo application.

Maximo Password — An alphanumeric string that goes with the Navigator User ID to allow access to the Maximo application.

Location — The Maximo location to use when creating new rows in Maximo tables.

Autogen — (optional) An identifier used as a suffix for ITEMNUM description. It indicates the ITEMNUM was created by this application.

NOTE Maximo uses an asterisk (*) to indicate non-stocked parts.

Almost No Updates — Indicates whether part updates should be saved or discarded. This lets you run through the process of loading parts and then removes the changes. This can be used to ensure that all the Navigator parts match corresponding Maximo parts.

Issue Unit — Standard quantity by which the item is issued from the storeroom, such as each or roll.

Database Vendor — The type of database engine Maximo is using for this installation, Oracle or Microsoft SQL Server (MS SQL).

OK — Click to go to the Maximo Upload window.

Cancel — Click to close the dialog box and quit the application.



Example Data for Login Dialog Box

NOTE The Navigator connect information is for the Navigator database. The Maximo connect information is to connect to the Maximo application server (MXServer).

For the MAXIMO Host field, include the name of the MXServer (which can be found in the maximo.properties file, parameter mxe.name= ) if different than MXServer in the MAXIMO Host field (for example dellflatjtk/MXServer-139-sqs).

For the Autogen field, whatever you type in the field will be appended to any item description that is created during the load process.

You cannot use “maximo” as a Maximo User ID.

Maximo Upload 15-3


3 Click OK. If there are no errors, the Login dialog box closes and the Maximo Upload Utility Startup Progress dialog box opens.

Maximo Upload Utility Startup Progress Dialog Box

4 Wait for the Maximo Upload application to start. Check marks appear in the boxes as the application completes each task. When complete, the Maximo Upload Utility window opens.

NOTE You can click Cancel at any time to exit the application.

Maximo Upload Utility Screen — Unprocessed Asset Tab



NOTE The Maximo Upload Utility window has two tabs: one for unprocessed assets and one for previously processed assets. After an asset is processed, it is removed from the unprocessed tab and displayed on the processed tab (if the Almost No Updates value is set to “False.”) Although you may reprocess assets on the previously processed tab, displaying the information in this manner helps to discern which assets have already been processed during previous upload procedures.

This application also lets you determine whether to create new internal item numbers using the defined suffix, or to load only the item numbers that already exist in the Maximo database. The Autogen value determines what the suffix is.

5 Click the needed tab, Unprocessed Asset or Unprocessed Location.

6 Select Upload options:

a Select a Load Part option:

Click Create New Item Numbers if you want to load new items numbers into the Maximo database. The Set to STOCKED check box becomes available.! Select the check box to have the status of the new item set to

“stocked” when it is created.! Do not select the check box to have the status of the new item

set to “non-stocked” when it is created.

Click Load Only Existing Numbers if you only want to load item numbers that already exist in the Maximo database.

b Select a Part Type option:

Click Use Navigator True Part Number if symbols and/or punctuation should be included in the part number.

Click Use Navigator Filtered Part Number if symbols and/or punctuation should be removed from the part number.

c From the Settings menu, select Set Options for Part Quantity. The Set Options for Sparepart Quantity dialog box opens:

Set Options for Sparepart Quantity

Maximo Upload 15-5


d For Standard and Pseudo Manuals, select whether to process or skip and then define the quantity for each. A Standard Manual is a copy of a real manual for an asset. A Pseudo Manual is a parts list for an asset.

e Click OK.

7 Click the rows for asset or locations that you would like to process.

To select more than one asset or location in a series, hold SHIFT and select the first and last rows in the series.

To select more than one asset or location not in a series, press and hold CTRL and select rows.

To select all asset or locations, click Select All.

8 Click Start Processing. A confirmation dialog box opens.

NOTE The Start Processing button is active only if a Load Part option is selected and at least one asset or location number is selected.

Confirmation Dialog Box



9 If the information is not correct, click Go Back. If the information is correct, click Continue. Upload information displays while the Navigator part information for the selected asset or locations is loaded into the Maximo database.

Progress Dialog Box

10 When complete, click Finished. (There may be a short wait for this to be completed.)

11 To quit the Maximo Upload application, on the File menu, click Exit.

Maximo Upload 15-7

Maximo Upload Log Files


The Maximo Upload application generates two log files: uploadErrorLog.txt and uploadInfoLog.txt. Both files are in the directory where the Maximo Upload executable exists. Typically, this is: C:\program files\navigatorutils

If Navigator finds an item number (internal part number) in its database that is not in the Maximo database, it writes this as an error in the uploadErrorLog.txt log file. All updates associated with the asset in process when the error occurs are removed from the Maximo system. Navigator then proceeds to the next asset number.

In addition to any errors reported while running Maximo Upload, the uploadInfoLog.txt log file displays information on updates done for each asset number and totals for the run. The log file has, per asset number, the following information:

Item numbers generated for the appropriate manufacturer code and part number

Total rows inserted in COMPANIES table.

Total rows inserted in the ITEMS table.

Total rows inserted in the Navigator ALTPART table.

Total rows inserted in INVENTORY table.

Total rows inserted in INVVENDOR table.

Total rows inserted in SPAREPART table.

Sample uploadInfoLog.txt File Output

MAXIMO UPLOAD UTILITY Processing Info Log Jan 3, 2002 1:05:56 PM

Successfully Opened Connection to MAXIMO AppServer @ evectra_kathi as maximoSuccessfully Opened Connection to Navigator Database as ipc @ orcl.evectra_kathi:1521Retrieving All IPC Asset Numbers from the Asset TableThere are 5 UnMatchedAssets in NavigatorThe SPAREPART.QUANTITY for standard manuals is 1.The SPAREPART.QUANTITY for pseudo manuals is 1.New ITEMNUM numbers will be generated.You have selected 1 Asset Number for processingINVENTORY.MODELNUM and INVVENDOR.MODLENUM from Navigator True Part Number.Asset: 232512 Processing BeginItemNum : 1219 created for Mfgr Code: NB02 And Mfgr Part: M03C-4016-BItemNum : 1220 created for Mfgr Code: SH53 And Mfgr Part: O2025-1800ItemNum : 1221 created for Mfgr Code: SH53 And Mfgr Part: N2025-1300 EGItemNum : 1222 created for Mfgr Code: P011 And Mfgr Part: CDD-2AS14C-24ItemNum : 1223 created for Mfgr Code: NB02 And Mfgr Part: M03B-5012-AItemNum : 1224 created for Mfgr Code: NB02 And Mfgr Part: M03B-1309-BItemNum : 1225 created for Mfgr Code: NB02 And Mfgr Part: M03B-1308-BItemNum : 1226 created for Mfgr Code: NB02 And Mfgr Part: M03B-1316-BItemNum : 1227 created for Mfgr Code: NB02 And Mfgr Part: M03B-2015-DItemNum : 1228 created for Mfgr Code: NB02 And Mfgr Part: M03C-1315-BItemNum : 1229 created for Mfgr Code: BA13 And Mfgr Part: P616MItemNum : 1230 created for Mfgr Code: NB02 And Mfgr Part: M03B-4048-AItemNum : 1231 created for Mfgr Code: NB02 And Mfgr Part: M03C-4005-DItemNum : 1232 created for Mfgr Code: PH02 And Mfgr Part: CH-2A-19-C5ItemNum : 1233 created for Mfgr Code: P011 And Mfgr Part: CBB-2A14C13ItemNum : 1234 created for Mfgr Code: HE51 And Mfgr Part: R00-271-9000ItemNum : 1235 created for Mfgr Code: S066 And Mfgr Part: 234410BM



ItemNum : 1236 created for Mfgr Code: S066 And Mfgr Part: 234407...ItemNum : 1622 created for Mfgr Code: X025 And Mfgr Part: 712126ItemNum : 1623 created for Mfgr Code: NB02 And Mfgr Part: M03B-1342-BItemNum : 1624 created for Mfgr Code: NB02 And Mfgr Part: M03B-1343-BItemNum : 1625 created for Mfgr Code: NB02 And Mfgr Part: M03B-1344-BAsset: 232512 Processing Done

Statistics for 232512 SHAVER, GEAR, NATIONAL BROACH, RED RING Navigator Parts Processed: 407 Navigator Items Not Found: 0 Navigator Inserted ALTPART: 407 Navigator Updated Associations: 407 MAXIMO Inserted ITEM: 407 MAXIMO Inserted COMPANIES: 32 MAXIMO Inserted INVENTORY: 407 MAXIMO Inserted INVVENDOR: 407 MAXIMO Inserted SPAREPART: 407

Grand Total Navigator Parts Processed: 407 Navigator Items Not Found: 0 Navigator Inserted ALTPART: 407 Navigator Updated Associations: 407 MAXIMO Inserted ITEM: 407 MAXIMO Inserted COMPANIES: 32 MAXIMO Inserted INVENTORY: 407 MAXIMO Inserted INVVENDOR: 407 MAXIMO Inserted SPAREPART: 407

Processing FinishedRetrieving All IPC Asset Numbers from the Asset TableThere are 5 UnMatchedAssets in Navigator

Maximo Upload 15-9

Restarting Maximo Upload

Restarting Maximo Upload

By default, you can only run the Maximo Upload application from one machine at one time. When the application is started, the server reads and stores the machine name and its IP address until the machine quits the application.

If the Maximo Upload application is running and you attempt to run it from a different machine, you get this error:

This Application is already running on the server by Host Machine: <Machine name> with IPAddress: <IPAddress>. This application will be Terminated.

However, if Maximo Upload is running on one machine and that machine has a program error (freezes or crashes), and if you attempt to run it again, you get this error:

This Application is already running on the server by Host Machine: <Machine name> with IPAddress: <IPAddress>. Running this application may cause data corruption. Select ' Continue ' if you wish to accept this risk or Select ' Exit ' to terminate this Application.

If you want to restart Maximo Upload, do the following:

1 Make sure Maximo Upload is not running. (If the application is still running properly, on the File menu, click Exit.)

2 Reset the Maximo Upload application.

NOTE If you get the error message prompting you to “Continue” or “Exit”, click Exit.

a Start a Command Prompt.

b Navigate to the directory containing the Maximo Upload executable. For example,

c:\>cd Program Files\navigatorutils

c Type the command line: MaximoUpload reset <maximoserver> <maximoid> <maximopassword>. For example,

c:\Program Files\navigatorutils>MaximoUpload reset mktg19_pc maximo maximo

d Press ENTER.


To ensure that part (item) data retrieved from Maximo and Navigator are the same, data are synchronized. Maximo is considered the master; therefore, part data that are changed within Maximo are automatically updated in Navigator.

Data synchronization should occur near real-time and with as little user intervention as possible. Two areas of Maximo have been identified as areas where synchronization is required:

Items — When a user modifies items in the Item table, they are operating on parts in general. Asset identification is not taken into consideration. Therefore, when Navigator is updated with changes, the changes are applied in general against the Navigator internal parts table.

Asset — When a user adds assets, modifies asset descriptions, or deletes asset, it generally is updated in Navigator. The only exception is if the user deletes an asset that is pointed to by a goto asset touchpoint in Navigator. These assets are not deleted. However, a note is inserted into the datasync table “DATASYNCREPORT” with the asset number in the ASSETNUM column.

NOTE The Maximo Upload application turns data synchronization off when active and then turns data synchronization on when it complete running.

This appendix contains the software specifications for all required Oracle functions necessary for Maximo/Navigator Data Synchronization. It describes each function as follows:

Database table definitionsInterface descriptionsFunction descriptionsParametersReturn Codes

Data Synchronization Stored Procedures A

© Copyright IBM Corp. 2007 A-1

Database Table Definitions


Configuration Table

DataSyncConfig

The following parameters and values are currently inserted into the DataSyncConfig table.

Column DataType Size Nulls?

ParamName VARCHAR2 60 N

Value VARCHAR2 128 N

Parameter Value(s) Definition

AUTOSYNC Yes or No If AUTOSYNC=YES, data synchronization is enabled. If AUTOSYNC=NO, data synchronization is disabled. The default is AUTOSYNC=YES.

LOAD NO CODE PARTS

Yes or No If LOAD NO CODE PARTS=YES, parts with no manufacturer code specified are loaded into Navigator. The existing Navigator manufacturer code is used for the part. If not Navigator manufacturer code exists, the DEFAULT NULL MFR CODE is used. See below. If LOAD NO CODE PARTS=NO, parts with no manufacturer code specified are not loaded into Navigator. The default is LOAD NO CODE PARTS=YES.

REMOVEOEMFLAG 1 = true; 0 = false

If REMOVEOEMFLAG=1, manufacturer part information is deleted if it has been disassociated from a deleted internal (Maximo item) number and it is not associated with any other parts. If REMOVEOEMFLAG=0, manufacturer part information is not deleted if it has been disassociated from a deleted internal (Maximo item) number and it is not associated with any other parts. The default is REMOVEOEMFLAG=1.

A-2 IBM Maximo Asset Navigator: System Administration Guide


DEFAULT NULL MFR CODE

Four-character alphanumeric manufacturer code

The default code that is used in Navigator for Maximo items (internal parts) that do not have manufacturer information in Maximo and none can be found in Navigator. The default is DEFAULT NULL MFR CODE=ZZOO.

DEFAULT NULL MFR DESC

<text> The default description that is used in Navigator for Maximo items (internal parts) that do not have manufacturer information in Maximo and none can be found in Navigator. The default is DEFAULT NULL MFR DESC=MFR CODE FOR MAXIMO PARTS.

MFR CODE LETTER Single character

The single character that precedes all AutoGenerated Navigator Codes. The default is MFR CODE LETTER=Z.

COMPSETID <text> This is the company set associated with Navigator usage.

ITEMSETID <text> This is the item set associated with Navigator usage.

ORGID <text> This is the organization identification associated with Navigator usage.

SITEID <text> This is the site identification associated with Navigator usage.

Parameter Value(s) Definition

Data Synchronization Stored Procedures A-3


Error Table

DataSyncErrors

Report Table

DataSyncReport


DateTime DATE N

ItemNumber VARCHAR2 60 Y

AssetNum VARCHAR2 30 Y

TransCode VARCHAR2 10 Y

FunctionName VARCHAR2 60 N

OracleError NUMBER 38 N

MMIIError NUMBER 10 N

ErrorMsg1 VARCHAR2 256 Y

ErrorMsg2 VARCHAR2 256 Y


DateTime DATE

InternalPart VARCHAR2 60 N

MfrPart VARCHAR2 60 N

MfrCode VARCHAR2 4 Y

XrefCode VARCHAR2 60 Y

MatchPart VARCHAR2 60 Y

Matchcode VARCHAR2 4 Y

PartsAssociated VARCHAR2 1 N

assetnum VARCHAR2 30 Y


Oracle Functions

Oracle Functions

MM2UpdateInternalPartExt

Interface function MM2UpdateInternalPartExt(OracleError in out integer,InInternalPartNumber in altpart.alt_num%type,InternalPartDesc in altpart.alt_desc%type,InternalIsStocked in integer,ErrMsg1 in out varchar2,ErrMsg2 in out varchar2) return number;

Description The Internal Part is either added to Navigator or the description and stock values are updated if the internal part is already in Navigator.

NOTE This functionality is available by invoking MM2UpdateInternalPart(…).

For each Mfr Part associated with the Internal Part, the description is checked to see if it is the same as the Internal Part Description. If the descriptions are the same, the Mfr Part description is updated with the new Internal Part Description.

Parameters Description

Return Codes

Parameter Name Type Description

OracleError INTEGER Returns Oracle Error Code if oracle error occurs during execution

InInternalPartNumber VARCHAR2 Item/Internal Number to be modified

InternalPartDesc VARCHAR2 Item/Internal Number New Description

InternalIsStocked INTEGER 1 – Stocked

0 – Not Stocked

ErrMsg1 VARCHAR2 Text Description of error


Return Code Value Description

OK 0 no errors encountered

ERROR_INVALID_IPART 10 invalid internal part number

ERROR_INVALID_IPARTDESC 11 invalid internal part description


Oracle Functions

MM2DeleteInternalPartExt

Interface function MM2DeleteInternalPartExt(OracleError in out integer,InInternalPartNumber in altpart.alt_num%type,ErrMsg1 in out varchar2,ErrMsg2 in out varchar2) return number;

Description The Item is deleted from Navigator. All Navigator associations to Mfr Parts, touchpoints, etc. are removed.

If the internal part is associated to a mfr part associated to a document, a common part is added to the document’s touchpoint indicating the Internal Part was removed.

If the internal part is associated to a document directly, a common part is added to the document’s touchpoint indicated the internal part was removed.

If the internal part was associated to a mfr part and the mfr part is no longer associated to any other data, the mfr part is also deleted if the configuration file is configured to remove “loose” mfr parts.

NOTE Both Navigator Manuals and PseudoManuals are processed by this function.


Return Codes

ERROR_INVALID_ISSTOCKED 17 invalid is stocked parameter

ERROR_ADDING_IPART 23 error adding the internal part

ERROR_UPDATING_IPART 24 error updating the internal part










Oracle Functions

MM2AssocInternalAndOEMPartExt

Interface function MM2AssocInternalAndOEMPartExt(OracleError in out integer,InInternalPartNumber in altpart.alt_num%type,InternalPartDesc in altpart.alt_desc%type,InternalIsStocked in integer,MfrPartNumber in part.part_number%type,MfrCode in varchar2,MfrCodeDesc in varchar2,ErrMsg1 in out varchar2,ErrMsg2 in out varchar2) return number;

Description The function determines if the Mfr Code is a valid Navigator code (i.e., four characters in length). If it is, the function adds the Mfr Code and Mfr Code Description, if it is not already in Navigator. If the Mfr Code is not a valid Navigator code the function searches for the code in the Mfr Code cross reference Table. If it is not found, the function generates a unique Navigator Mfr Code. The function adds the Mfr Code and the generated Navigator Mfr Code to the Mfr Code cross-reference table. The generated Navigator code is added to the Navigator tables.

If the Internal Part does not exist, the Internal Part is added to Navigator with the supplied description and stocked value.

The function determines if the Mfr Part already exists in Navigator, if it does not, the Mfr Part is added to Navigator and associated to the Internal Part. The system will check for an exact match or a match on the filtered part number.

If a single match is found, the existing Mfr Part is associated to the Internal Part.

If multiple matches are found, the information is logged to the Report Table.


ERROR_DEL_IPART 30 error deleting the Internal Part



Oracle Functions


Return Codes






0 – Not Stocked

MfrPartNumber VARCHAR2 Mfr Part to be associated with Internal Part

MfrCode VARCHAR2 MfrCode of Mfr Part

MfrCodeDesc VARCHAR2 Mfr Code Description









ERROR_ADDING_CODE 50 error adding the Mfr Code

ERROR_ADDING_OEM_PART 21 Error adding the Mfr Part

ERROR_ASSOC_PARTS 31 Error associating the Internal and Mfr Part


Oracle Functions

MM2AssocInternalAndOemPartNC

Interface function MM2AssocInternalAndOemPartNC(OracleError in out integer,InInternalPartNumber in altpart.alt_num%type,InternalPartDesc in altpart.alt_desc%type,InternalIsStocked in integer,MfrPartNumber in part.part_number%type,ErrMsg1 in out varchar2,ErrMsg2 in out varchar2) return number;

Description If the Internal Part does not exist, the Internal Part is added to Navigator with the supplied description and stocked value.

The function determines if a part exists in Navigator using only the part number and not the combination of Mfr Part and Code.

1 If a single match is found, the information is recorded in the Report Table and if the Configuration Table indicates to Load No Code Parts, the Internal Part is associated to the Mfr Part found.

2 If more than one match is found, the information is recorded in the Report Table.

3 If no match is found, the information is recorded in the Report Table, and if the Configuration Table indicates to Load No Code Parts, the Mfr Part is added using the No Code Mfr Code specified in the Configuration Table and is associated to the Internal Part.







0 – Not Stocked





Oracle Functions

Return Codes

MM2DisassocOEMandInternalExt

Interface function MM2DisassocOEMandInternaExt(OracleError in out integer,InInternalPartNumber in altpart.alt_num%type,OEMPartNumber in part.part_number%type,OEMCode in part.mfgr_code%type,ErrMsg1 in out varchar2,ErrMsg2 in out varchar2) return number;

Description The manufacturer part is disassociated from the internal part number if it is associated. If the OEM Code is null, the system will determine if there is manufacturer associated using just the manufacturer number.

Parameters






ERROR_INVALID_OEMPART 12 invalid Mfr Part Number


ERROR_ADDING_OEM_PART 21 Error adding the Mfr Part

ERROR_ASSOC_PARTS 31 Error associating the Internal and Mfr Part





MfrCode VARCHAR2 MfrCode of Mfr Part




Oracle Functions

Return Codes

MM2IsValidAssetNum

Interface function MM2IsValidAssetNum(OracleError in out integer,AssetNum in asset.asset_number%type,ErrMsg1 in out varchar2,ErrMsg2 in out varchar2) return number;

Description The function determines if the Asset Number exists in MM2. This can be used to determine if further processing is required.


Return Codes




ERROR_INVALID_OEMPART 12 invalid Mfr Part Number

ERROR_DISASSOC_PARTS 29 Error associating the Internal and Mfr Part



AssetNum VARCHAR2 Asset Number




OK 0 Asset Exists

INFO_ASSET_NOT_FOUND 402 Asset Does Not Exist

ERROR_INVALID_ASSET_NUMBER

200 Invalid Asset Number


Oracle Functions

MM2AssocIPartToPsuedo

Interface function MM2AssoclPartToPseudo(OracleError in out integer,InInternalPartNumber in altpart.alt_num%type,Quantity in integer,AssetNum in asset.asset_number%type,ErrMsg1 in out varchar2,ErrMsg2 in out varchar2) return number;

Description This function will be released as a stub until IBM can determine best way to implement. The stub will always return IPC_IT_PROCS.OK.


Return Codes




Quantity INTEGER Spare Part Table quantity value for Item/Internal Number

MnlName VARCHAR2 PseudoManual Name/Id to associate Item/Internal Part to

AssetNum VARCHAR2 Asset Number to Associate Item/Internal Part




OK 0 Asset Exists





ERROR_ASSOC_IPART_MNL 61 Error Associating Internal Part to Pseudo Manual


Oracle Functions

MM2DisassocIPartFromPsuedo

Interface function MM2DisassocIPartFromPseudo(OracleError in out integer,InInternalPartNumber in altpart.alt_num%type,AssetNum in asset.asset_number%type,ErrMsg1 in out varchar2,ErrMsg2 in out varchar2) return number;



Return Codes








OK 0 Asset Exists


INFO_ASSET_MANUAL_NOT_ASSOC

401 No PseudoManuals found with the Internal Part for the Asset




ERROR_DISASSOC_IPART_MNL

62 Error removing Internal Part from Pseudo Manual


Oracle Functions

MM2UpdateInternalPartQty

Interface function MM2UpdateInernalPartQty(OracleError in out integer,InInternalPartNumber in altpart.alt_num%type,AssetNum in asset.asset_number%type,NewQty in integer,ErrMsg1 in out varchar2,ErrMsg2 in out varchar2) return number;


The function verifies if the Asset and Internal Part exist in Navigator, if either do not, no further processing occurs. The function verifies the internal part is associated to the Asset via the Maximo Pseudo Manuals. If it is not, the function MM2AssoclPartToPseudois called.

The function updates the quantity amount for the internal part number in the Maximo Pseudo Manual for the asset.


Return Codes





NewQty INTEGER New Quantity for Item/Internal Number




OK 0 Asset Exists





ERROR_DISASSOC_IPART_MNL

62 Error removing Internal Part from Pseudo Manual


Oracle Functions

MM2AddAsset

Interface function MM2AddAsset(OracleError in out integer,InAssetNumber in asset.asset_number%type,InAssetDesc in asset.asset_desc%type,InAssetLoc in asset.location%type,ErrMsg1 in out varchar2,ErrMsg2 in out varchar2) return number;

Description The input asset is added to Navigator. If the asset number is already in Navigator, the description and location are updated.


Return Codes



InAssetDescription Asset description

InAssetLocation Asset location

InAssetNumber Asset to be added or modified in Navigator




OK 0 Asset Exists


200 Invalid asset number supplied

ERROR_ADDING_ASSET 300 Error Adding Asset

ERROR_UPDATING_ASSET 303 Error Updating Asset


Oracle Functions

MM2DeleteAsset

Interface function MM2DeleteAsset(OracleError in out integer,InAssetNumber in asset.asset_number%type,

ErrMsg1 in out varchar2,ErrMsg2 in out varchar2) return number;

Description The input asset is deleted from Navigator. The only exception is if the user deletes asset that is pointed to by a goto asset touchpoint in Navigator. These assets are not deleted. However, a note is inserted into the datasync table “DATASYNCREPORT” with the asset number in the ASSETNUM column.


Return Codes



InAssetNumber Asset to be added or modified in Navigator




OK 0 Asset Exists


200 Invalid asset number supplied

ERROR_DISASSOCIATING_ASSET

305 Error Disassociating Asset

ERROR_REMOVING_ASSET 301 Unknown Error Removing Asset

ERROR_ASSET_REFERENCED_BY_TP

310 Error Deleting Asset because of a goto asset touchpoint.


Configurable Parameters

CUST.INI File

This file contains the directory path of the manuals and valid filename extensions for each viewer. If the manuals are moved to a different path or drive, this file must be updated to reflect the new location and then the Locate All Documents function must be run to create a new file of pointers to the pages of each manual. See “Locate All Documents” on page 4.

[CUSTLIST]IPC-PRODUCTION=<d>:\NAVIGATOR\manuals

Parameter: Specify the location (path) of the Navigator production manuals. (IPC-PRODUCTION=...)

[DOCUMENT EXTENSIONS]RASTER=TIF, BMP, JPG

Parameters: Specify the document extensions for raster documents (RASTER=...).

IPCSYS.INI File

This file contains customized options that are used by all workstations running Navigator. You may customize the following options:

Application Logging Option [APP LOGGING]USE = YESFATAL ERROR MESSAGE 1="THE SYSTEM HAS BECOME VERY UNSTABLE."FATAL ERROR MESSAGE 2="PLEASE REBOOT THE SYSTEM. ALSO,"FATAL ERROR MESSAGE 3="PLEASE CONTACT YOUR NAVIGATOR SYSTEM ADMIN "

INI Files B

© Copyright IBM Corp. 2007 B-1


Parameters:

Specify whether to enable logging when an application is started and terminated (USE = YES) or not (USE = NO). The default is (USE = NO). The data is logged to the Application Usage Log. The path of this file is designated by the WSINI environmental variable. The file name consists of the first seven characters of the DBUSERID environmental variable with a .log extension. An entry in the log consists of the DBUSERID, WORKSTATION ID, application name, and time the application was started or terminated.

Specify the message displayed if Navigator gets a break in the network. (FATAL ERROR MESSAGE X=”xxxx”) Where X is the line of the message (with a maximum of four lines) and xxxx is the message (with a maximum of 40 characters).

Customizing Options [CUSTOMIZATION]ASSET = EquipmentINTERNAL = ACME Co.IMAGE DOCUMENT NOTICE = Copyrighted by ACME Co.TEXT DOCUMENT NOTICE = Copyrighted by ACME Co.COMMON PART DESCRIPTION = Acme Common PartLONG MANUFACTURER PART NUMBER=NOMFR FIELD=DESCMFR DESC SIZE=15MFR HEADER=ManufacturerMULTIPLE VENDORS=YESTPLOG=<d>:\IPC\ini\missoem.logINTERNAL TO MFR PART=MANY

Parameters:

Customize the text used for “Asset.” (ASSET = ...) The value entered replaces all occurrences of “Asset.” The maximum number of characters for the value is 10 characters. If no value is entered, the default is “Asset.” The value is case sensitive; what is entered is exactly how it is displayed.

Customize the text used for “Internal.” (INTERNAL = ...) The value entered replaces all occurrences of “Internal.” The maximum number of characters for the value is 10 characters. If no value is entered, the default is “Internal.” The value is case sensitive; what is entered is exactly how it is displayed.

Specify a custom notice on image documents (IMAGE DOCUMENT NOTICE = ...) and/or text documents (TEXT DOCUMENT NOTICE = ...) that are printed. The maximum number of characters for the value is 80 characters. The value is case sensitive; what is entered is exactly how it is displayed.

Specify a custom common part description (COMMON PART DESCRIPTION = ...) to be added to the common part description selection list in Manual and Part Link Maintenance. The maximum number of characters for the value is 40 characters. The value is case sensitive; what is entered is exactly how it is displayed.

Specify whether manufacturer part numbers can be a maximum of 60 characters (LONG MANUFACTURER PART NUMBER=YES), or not (LONG MANUFACTURER PART NUMBER=NO). If not, the maximum number of characters is 20.

B-2 IBM Maximo Asset Navigator: System Administration Guide


Since multiple manufacturers can be displayed for one manual, specify whether to display the 4-character manufacturer code (MFR FIELD=CODE), the manufacturer description code (MFR FIELD=DESC), or neither code (MFR FIELD=NONE) with each part on a parts requisition list. The default is (MFR FIELD=NONE).

Specify the maximum number of manufacturer description characters to be displayed when (MFR FIELD=DESC). (MFR DESC SIZE=n) where n is the maximum number. The default is (MFR DESC SIZE=10).

Specify the text to be used as the column header for the manufacturer data in a parts requisition list. (MFR HEADER=…) The default is (MFR HEADER=Manufacturer).

Specify whether to support multiple vendors (MULTIPLE VENDORS=YES), or not (MULTIPLE VENDORS=NO). The default is (MULTIPLE VENDORS=YES).

Specify the path for the touchpoint log (TPLOG = ...) that contains touchpoint identification information when the unidentified manufacturer code is selected.

Specify whether to display multiple internal parts associated with a manufacturer part (INTERNAL TO MFR PART=MANY), or to display only the primary internal part associated with a manufacturer part (INTERNAL TO MFR PART=ONE). The default is (INTERNAL TO MFR PART=MANY).

Document Viewer Options [DOCUMENT VIEWER]GOTO ASSET TP DISPLAY=LABELGOTO LOCATION HOTSPOT DISPLAY=TRANSPARENT SQUAREGOTO TP DISPLAY=LABELBITONAL=OFFANTIALIAS=OFF

Parameters:

Specify whether to display Goto Asset touchpoints as white text on a red label (GOTO ASSET TP DISPLAY=LABEL), or as a transparent red triangle (GOTO ASSET TP DISPLAY=TRIANGLE). The default setting is (GOTO ASSET TP DISPLAY=LABEL).

Specify whether to display Goto Location touchpoints as white text on a red label (GOTO LOCATION HOTSPOT DISPLAY=LABEL), or as a transparent red square (GOTO LOCATION HOTSPOT DISPLAY=TRANSPARENT SQUARE). The default setting is (GOTO LOCATION HOTSPOT DISPLAY=TRANSPARENT SQUARE).

Specify whether to display Goto touchpoints as white text on a red label (GOTO TP DISPLAY=LABEL), or as a transparent red dot (GOTO TP DISPLAY=CIRCLE). The default setting is (GOTO TP DISPLAY=LABEL).

Specify whether to display printing options when printing a document (PRINT OPTIONS=YES), or not (PRINT OPTIONS=NO). The default setting is (PRINT OPTIONS=NO).

Specify to display raster images using bitonal scaling (BITONAL=ON) or not (BITONAL=OFF). Bitonal always retains the horizontal and vertical when scaling. It allows for a better quality image, but slows down performance.

INI Files B-3


Specify to display raster images using antialiasing with four shades of gray (ANTIALIAS=4), 16 shades of gray (ANTIALIAS=16), or not (ANTIALIAS=OFF). Antialiasing with 16 shades allows for the highest quality, but is the slowest in performance.

Edit TOC Options [EDIT TOC]TOUCHPOINTED DOCUMENTS PROMPT=YESCREATE MISSING ENTRIES=YESTOP LEVEL NAME=”**PARTS**”

Parameters:

Specify whether to be prompted to verify touchpoints and create TOC entries for the touchpointed parts documents (TOUCHPOINTED DOCUMENTS PROMPT =YES), or not (TOUCHPOINTED DOCUMENTS PROMPT =NO). The default is (TOUCHPOINTED DOCUMENTS PROMPT =NO).

Specify whether you are given the option to create TOC entries for missing touchpointed parts documents (CREATE MISSING ENTRIES=YES), or not (CREATE MISSING ENTRIES=NO). The default is (CREATE MISSING ENTRIES=YES).

Specify the name of the Level 01 entry under which existing entries for all touchpointed parts documents are copied. (TOP LEVEL NAME=xxx) A maximum of 40 characters is allowed. The default is (TOP LEVEL NAME="**PARTS**").

Export [EXPORT]EXPORT INCLUDE NOUN = YesEXPORT INCLUDE INTERNAL = YesEXPORT INCLUDE ASSET = YesEXPORT INCLUDE IPC LOCATION = YesEXPORT INCLUDE PAGENOTE = YesEXPORT INCLUDE TPNOTE = YesEXPORT INCLUDE SUPERSEDED = YesEXPORT MANUAL LOG PATH = <d>:\NAVIGATOR\EXPORTM\LOGSEXPORT MANUAL FLAT PATH = <d>:\NAVIGATOR\EXPORTM\MANUALSEXPORT TOC LOG PATH = <d>:\NAVIGATOR\EXPORTT\LOGSEXPORT TOC FLAT PATH = <d>:\NAVIGATOR\EXPORTT\TOCSEXPORT INDEX LOG PATH=<D>:\SILOGEXPORT INDEX FLAT PATH=<D>:\SIFLAT

Parameters:

Specify the default setting for the Noun Names check box option in the Export Manual window. If (EXPORT INCLUDE NOUN = YES), the check box is selected. If (EXPORT INCLUDE NOUN = NO), the check box is not selected.

Specify the default setting for the Internal Parts check box option in the Export Manual window. If (EXPORT INCLUDE INTERNAL = YES), the check box is selected. If (EXPORT INCLUDE INTERNAL = NO), the check box is not selected.

Specify the default setting for the Asset check box option in the Export Manual window. If (EXPORT INCLUDE ASSET = YES), the check box is selected. If (EXPORT INCLUDE ASSET = NO), the check box is not selected.



Specify the default setting for the Locations check box option in the Export Manual window. If (EXPORT INCLUDE IPC LOCATION = YES), the check box is selected. If (EXPORT INCLUDE IPC LOCATION = NO), the check box is not selected.

Specify the default setting for the Page Notes check box option in the Export Manual window. If (EXPORT INCLUDE PAGENOTE = YES), the check box is selected. If (EXPORT INCLUDE PAGENOTE = NO), the check box is not selected.

Specify the default setting for the Touchpoint Notes check box option in the Export Manual window. If (EXPORT INCLUDE TPNOTE = YES), the check box is selected. If (EXPORT INCLUDE TPNOTE = NO), the check box is not selected.

Specify the default setting for the Superseded Parts check box option in the Export Manual window. If (EXPORT INCLUDE SUPERSEDED = YES), the check box is selected. If (EXPORT INCLUDE SUPERSEDED = NO), the check box is not selected.

Specify the export default path for manual flat files (EXPORT MANUAL FLAT FILE = <d>:\pathname). The value is not case sensitive.

Specify the export default path for manual log files (EXPORT MANUAL LOG PATH = <d>:\pathname). The value is not case sensitive.

Specify the export default path for TOC flat files (EXPORT TOC FLAT PATH = <d>:\pathname). The value is not case sensitive.

Specify the export default path for TOC log files (EXPORT TOC LOG PATH = <d>:\pathname). The value is not case sensitive.

Specify the export default path for selection index log files (EXPORT INDEX LOG PATH = <d>:\pathname). The value is not case sensitive.

Specify the export default path for selection index flat files (EXPORT INDEX FLAT PATH = <d>:\pathname). The value is not case sensitive.

NOTE The default selection index is the selection index that is exported. See “Oracle” on page 7 for the SELECTION_INDEX parameter in the IPCSYS.INI file.

Import IMPORT MANUAL LOG PATH = <d>:\MNLLOGIMPORT MANUAL FLAT PATH = <d>:\MNLFLATIMPORT TOC LOG PATH = <d>:\TOCLOGIMPORT TOC FLAT PATH = <d>:\TOCFLATIMPORT INDEX LOG PATH=<D>:\SILOGIMPORT INDEX FLAT PATH=<D>:\SIFLATCREATE PART FILE = NoPART FILE PATH = <d>:\PRTFLPTHINDEX LEVEL DELIMITER = |INDEX DESC DELIMITER = ;

Parameters:

Specify the import default path for manual flat files (IMPORT MANUAL FLAT PATH = <d>:\pathname). The value is not case sensitive.

INI Files B-5


Specify the import default path for manual log files (IMPORT MANUAL LOG PATH = <d>:\pathname). The value is not case sensitive.

Specify the import default path for TOC flat files (IMPORT TOC FLAT PATH = <d>:\pathname). The value is not case sensitive.

Specify the import default path for TOC log files (IMPORT TOC LOG PATH = <d>:\pathname). The value is not case sensitive.

Specify the import default path for selection index log files (IMPORT INDEX LOG PATH = <d>:\pathname). The value is not case sensitive.

Specify the import default path for selection index flat files (IMPORT INDEX FLAT PATH = <d>:\pathname). The value is not case sensitive.

Specify whether a Flat File is to be created with all of the manufacturer parts imported into the Navigator database (CREATE PART FILE = All), to be created with all of the manufacturer parts imported that are not already existing in the Navigator database (CREATE PART FILE = New), or not to be created (CREATE PART FILE = No). The value is not case sensitive.

NOTE The Flat File is an ASCII file that contains information on all OEM parts that were added to a database as a result of running the Import Manual function. Only OEM parts associated with an imported manual that are currently not in the target database are added to the target database at the time of the import process.

Specify the path for the Flat File of imported manufacturer parts. (PART FILE PATH = <d>:\pathname)

Specify the delimiter character that is used between index level entries in the Selection Index Import Flat File. (INDEX LEVEL DELIMITER = ...). A single character must be specified. If this is not specified, a vertical bar “|“ is used as the default.

NOTE The Selection Index Import Flat File is an ASCII file where each line of the file is the complete index path to a manual or document. See “How to Create the Selection Index Flat File” on page 7.

Specify the index description delimiter character that is used between index level descriptions for the Selection Index Import Flat File. This must be specified if you have more than one line of description for each index level entry. (INDEX DESC DELIMITER = ...). A single character is specified. If this is not specified, it is assumed that there is only one line of a description for an index level entry.

Licensing & Format Options These two sections [GENERAL] and [LICENSE], and [LOGONERRSTRING] are logically grouped together since they all deal with licensing and formatting issues.

[GENERAL]TICKET = <d>:\NAVIGATOR\LICENSE\IPCUSERS.LIC

Parameter: Specify the location of the license file. (TICKET = ...) NOTE: The logon window is automatically bypassed if using a site license.



[LICENSE]ACCESS_FREQ = 5LICENSE_CHK_FREQ = 300

Parameters:

Specify how often, in minutes, the time of the last database access should be updated in a user's license. (ACCESS_FREQ = ...)

Specify how often, in seconds, a user's license should be checked for validity. (LICENSE_CHK_FREQ = ...)

[LOGINERRSTRING]MESSAGE = "Contact Joe Smith at 555-1234"

Parameter: Append a personal message to a licensing error message. (MESSAGE = ...)

Oracle [ORACLE]SELECTION_INDEX=IPC DEFAULT INDEX

Parameter: Specify the name given the Selection Index root entry in the Navigator. (SELECTION_INDEX=...)

PUP-PDS Path [PUP-PDS]PATH=<d>:\IPC\pup\files\pup.ini

Parameter: Specify the path for the PUP.INI file. (PATH=...).

Security Options If the [SECURITY] application is omitted from the IPCSYS.INI file, the minimum character lengths for the password and the user ID will default to three characters.

[SECURITY]MINIMUM PASSWORD LENGTH = 4MINIMUM USER ID LENGTH = 5AUTOLOGIN = NO

Parameters:

Specify the minimum character length of the password (MINIMUM PASSWORD LENGTH = X). The range of values for the password length ranges between one character and 15 characters. If nothing is entered for the minimum password length, the length will default to three characters.

Specify the minimum character length of the user ID (MINIMUM USER ID LENGTH = X). The range of values for the user ID length ranges between one character and 15 characters. If nothing is entered for the minimum user ID length, the length will default to three characters.

Specify to enable automatic logging in (AUTOLOGIN = YES), or not (AUTOLOGIN = NO). If AUTOLOGIN = YES, the system prompts the user for a user ID and password when the user attempts to access an Control Center application. Once logged in, the user can access any Control Center application for which they have security clearance. If AUTOLOGIN = NO, the system prompts the user for a user ID and password during the startup of each Control Center application. The default is AUTOLOGIN = NO.

INI Files B-7

File List and Parameters


CUST.INI File Sections and Parameters

[CUSTLIST]IPC-PRODUCTION =

[DOCUMENT EXTENSIONS]RASTER =

IPCEXP.INI File Section and Parameters

NOTE If this file does not exist, these parameters should be included in the IPCSYS.INI file.

[EXPORT]EXPORT INCLUDE NOUN = EXPORT INCLUDE INTERNAL = EXPORT INCLUDE ASSET = EXPORT INCLUDE IPC LOCATION =EXPORT INCLUDE PAGENOTE = EXPORT INCLUDE TPNOTE = EXPORT INCLUDE ALTSUP = EXPORT INCLUDE SUPERSEDED = EXPORT INCLUDE BINEXPORT MANUAL LOG PATH = EXPORT MANUAL FLAT PATH = EXPORT TOC LOG PATH = EXPORT TOC FLAT PATH = EXPORT INDEX LOG PATH =EXPORT INDEX FLAT PATH =

IPCIMP.INI File Section and Parameters

NOTE If this file does not exist, these parameters should be included in the IPCSYS.INI file.

[IMPORT]IMPORT MANUAL LOG PATH = IMPORT MANUAL FLAT PATH = IMPORT TOC LOG PATH = IMPORT TOC FLAT PATH = IMPORT INDEX LOG PATH =IMPORT INDEX FLAT PATH = CREATE PART FILE = PART FILE PATH = INDEX LEVEL DELIMITER = INDEX DESC DELIMITER =

IPCINTRL.INI File Application and Key Name

[PAGE NOTE REVIEW]LAST DATE =



IPCMAINT.INI File Application and Key Names

[MAINTENANCE MODE]USE=MAINTENANCE=CHECK FREQUENCY=MAINTENANCE APP=RESTART CHECK TIME=START IPC APP=MAINTMSG1=MAINTMSG2=MAINTMSG3=MAINTMSG4=

VIEWERS.INI File Sections and Parameters (EXAMPLES)

[DOC]TYPE=VIEWER=PATH=

[PDF]TYPE=VIEWER=PATH=

IPCSYS.INI File Sections and Parameters

[APP LOGGING]USE = FATAL ERROR MESSAGE <X>=

[CUSTOMIZATION]ASSET = INTERNAL = IMAGE DOCUMENT NOTICE = TEXT DOCUMENT NOTICE = COMMON PART DESCRIPTION = LONG MANUFACTURER PART NUMBER=MFR FIELD=MFR DESC SIZE=MFR HEADER=MULTIPLE VENDORS=TPLOG=BYPASS THE LOGIN SCREEN = INTERNAL TO MFR PART=KEYPART RADIO BUTTON=SEARCH RESULTS LINE SPACING=LONG PART DESCRIPTION = LONG PART DESCRIPTION WIDTH = LONG PART DESCRIPTION LINES =

[DOCUMENT VIEWER]GOTO ASSET TP DISPLAY=GOTO LOCATION HOTSPOT DISPLAY=GOTO TP DISPLAY=BITONAL=ANITALIAS=

INI Files B-9


[EDIT TOC]TOUCHPOINTED DOCUMENTS PROMPT =CREATE MISSING ENTRIES=TOP LEVEL NAME=

[EXPORT]FILE=

[IMPORT]FILE=

[GENERAL]TICKET = INTERNAL MASK = JUSTIFY = LOG CONCURRENT USERS = DELETE USERS = DELETE TIME =

[LICENSE]ACCESS_FREQ = LICENSE_CHK_FREQ =

[LOGINERRSTRING]MESSAGE =

[LOGON BITMAP]LOGO=HEIGHT SIZE=WIDTH SIZE=DISPLAY=

[MAINTENANCE MODE]FILE=

[MINMAX]ENABLED=

[ORACLE]SELECTION_INDEX=CONTEXT=CONTEXT SEARCH=

[PARTS LIST LOAD]INTERNAL ASSOCIATION=PARTS LIST=FORMAT=GENERATE MFR CODES=AUTOGENSEED=AUTOPLLMNLSEED=

[REQUISITION INFO]DOUBLESPACE = PARTDESC = USEMFGRDESC = CRAFTID = WORKORDER = ASSETNUM = IDPROMPT = IDHEADER =

[PART DATA UPDATE UTILITY]



WORK DIRECTORY = SAVE DIRECTORY = ERROR LOG DIRECTORY = DEFAULT PROCESS MODE = CHARACTERS TO IGNORE =

[PUP-PDS]PATH=

[RENAME MFR]RENAME =

[SECURITY]MINIMUM PASSWORD LENGTH = MINIMUM USER ID LENGTH = AUTOLOGIN =

[STATISTICS]WRITE INTERVAL =

IPCWS.INI File Sections and Parameters

[CDD]PATH =

NOTE This may also be in the IPCSYS.INI file.

[CUSTOMBUTTONS]BUTTONSINUSE=BUTTON1=BUTTON2=BUTTON3=BUTTON4=BUTTON5=BUTTON6=BUTTON7=

[CUSTOMIZATION]VISUAL LOCATE FILE EXTENSION =

[DISABLE FUNCTIONS]QUICK MAINTENANCE = REDLINE EDITOR = SHOW REDLINES = VISUAL LOCATE = KEYPART =

[DOCUMENT VIEWER]GOTO ASSET TP DISPLAY=LABELGOTO TP DISPLAY=LABELGOTO TP ON PRL=YESDISPLAY INVERTED = PRINT AS DISPLAYED = PRINT COLORS ON WHITE =PRINT BLACK ON WHITE =BITONAL =ANTIALIAS =

[EXTERNAL VIEWERS]

INI Files B-11


PATH =AUTOLAUNCH=

[ORACLE]SELECTION_INDEX=CONTEXT=CONTEXT SEARCH=

[PRIVILEGES]EXITPRIV = SWITCHPRIV = MINIMIZE MAINMENU =

[STATISTICS]WRITE INTERVAL =

[TIMEOUT]MINUTES =


Notices

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia CorporationLicensing2-31 Roppongi 3-chome, Minato-kuTokyo 106-0032, Japan

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law:

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those

© Copyright IBM Corp. 2007 Notices-1

Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Corporation2Z4A/10111400 Burnet RoadAustin, TX 78758 U.S.A.

Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.

The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.

Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.

If you are viewing this information softcopy, the photographs and color illustrations may not appear.

Trademarks

AIX, IBM, IBM Corporation, the IBM logo, Tivoli, and WebSphere are registered trademarks of the International Business Machines Corporation in the United States, other countries, or both.

Intel, the Intel logo, and Pentium are registered trademarks of the Intel Corporation in the United States, other countries, or both.

Microsoft, Windows, and Internet Explorer are registered trademarks of Microsoft Corporation in the United States, other countries, or both.

Notices-2 IBM Maximo Asset Navigator: System Administration Guide

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

Sun, Sun Microsystems, the Sun logo, and Solaris are trademarks of Sun Microsystems, Inc.

Linux is a trademark of Linus Torvalds in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other countries.

Other company, product, and service names may be trademarks or service marks of others.

Notices-3

Notices-4 IBM Maximo Asset Navigator: System Administration Guide

Index

A

add a touchpoint 7-3Add Common Part to Touchpoint 5-12Add Part Number to Touchpoint 5-6Add, Modify, Delete Manual 5-17adding an entry

selection index 4-7Annotation Maintenance

application 7-1screen 7-1

Application Logging Option B-1AutoIncrement 7-7

B

BOM/Hotspot Associations, Creating 7-7

C

Change Touchpoint Label 5-16Creating BOM/Hotspot Associations 7-7customer support i-ixCustomization Options B-2

D

Data WindowEntering Data 7-5Options 7-5Using 7-5

delete a touchpoint 7-4Delete Common Part from Touchpoint 5-13Delete Document from Manual 5-4Delete Entire Touchpoint 5-15Delete Go To Touchpoint 5-13, 5-14Delete Page Notes 12-5Delete Part Number from Touchpoint 5-11deleting a page note 12-7Display Parts List of Touchpoint 5-15Document Location Maintenance

application 3-1screen 3-1

Document Locationsupdate 3-8

Document Viewer Options B-3

E

Edit Current Entry 4-4, 8-4Edit Page Notes 12-5Edit Selection Index 4-1Edit Selection Index/TOC

Add Multiple Entries 8-7Add New Entry 8-7Copy Entry 4-4, 8-4Copy Tree 4-4, 8-4Create TOC for Parts Docs 8-7Cut Tree 4-4, 8-4Delete Tree 4-4, 8-4Find function 4-5, 8-5Find Next function 4-5, 8-5Paste After 4-4, 8-4Replace function 4-6, 8-6Verify TP Parts Docs 8-7

Edit TOC Options B-4editing a page note 12-7editing an entry

selection index 4-7Export B-4Export a Selection Index 13-7Export Manuals 13-4Export Setup 13-2Export Table of Contents 13-6

F

Flat File 2-1

I

Image Manipulation 5-3Import B-5Import a Selection Index 2-8

create flat file 2-7Import Manuals 2-4Import Part Data File 2-12Import Setup 2-2Internal Part

associate with manufacturer part 6-13disassociate from manufacturer part 6-15supersede 6-8

© Copyright IBM Corp. 2007 Index-1

Index

L

Licensing & Format Options B-6Link New Touchpoint to Document 5-5Locate All Documents 3-4log files 2-10, 13-8

manual 2-10, 13-8selection index 13-9table of contents 2-11, 13-8

M

Manual Log Files 2-10, 13-8Manufacturer

add, modify, and delete 6-3Manufacturer Part

associate with internal part 6-10disassociate from internal part 6-12supersede 6-7

Manufacturer Partsadd, modify, and delete 6-5

Modify Common Part Description/Qty 5-12Modify Go To Name of Touchpoint 5-13, 5-14Modify Quantity of Part Number 5-11Move Document within Manual 5-4

O

online support i-ixOracle B-7

P

page notesdelete 12-5edit 12-5Print a Date Range of Page Notes 12-8Print a Document 12-7Print a Page Note 12-7Print a Session's Page Notes 12-7review 12-5review new/modified page notes 12-4show all 12-4show for manual 12-3

Part and Manufacturer MaintenanceAdd, Modify, Delete Manufacturer 6-3Add, Modify, Delete Manufacturer Parts 6-5application 6-1Associate Internal Part with Manufacturer Part 6-13Associate Manufacturer Part with Internal Part 6-10Disassociate Internal Part from Manufacturer Part 6-15Disassociate Manufacturer Part from Internal Part 6-12screens 6-1Set Manufacturer 6-2Supersede Internal Part 6-8Supersede Manufacturer Part 6-7

print

full document 10-6portion of document 10-6selection index 4-3table of contents 4-3

printingReviewed Page Notes 12-7

PUP-PDS Path B-7

Q

QC Document Repair 7-1add a touchpoint 7-3change a touchpoint label 7-4delete a touchpoint 7-4image manipulation functions 7-3move a touchpoint label 7-4screen 7-2

R

Review New/Modified Page Notes 12-4Review Page Notes 12-5Review Session

starting 12-6

S

Security 9-1Add a User to the Database 9-3Add, Modify, Delete Users 9-2Delete a User from the Database 9-5Modify a User's Security Data 9-4Modify Security Levels of Functions 9-6

Security Options B-7Select Manual and Document 5-2Select Next Touchpoint 5-15Selection Index

adding or deleting an entry 4-7Selection Index Log Files 13-9Setup

export 13-2Import 2-2

Show All Page Notes 12-4Show Documents 10-1

Display Attributes 10-5Document Attributes 10-4Print Full Document 10-6Print Portion of Document 10-6

Show Page Notes for Manual 12-3Source Database 2-1support, online i-ix

Index-2 IBM Maximo Asset Navigator: System Administration Guide

Index

T

Target Database 2-1TOC Log Files 2-11, 13-8

U

Update Document Locations 3-8Update Document Page Number 5-5Update Document Touchpoints in Manual 5-6users

add, modify, or delete 9-2

V

viewingselection index 4-2, 8-2table of contents 4-2, 8-2

Visual Locate and Link 3-5

Index-3

Index

Index-4 IBM Maximo Asset Navigator: System Administration Guide