Honeywell DOC4000

User Guide Version 4.0

Table of Contents Getting Started ...... 1 Welcome to DOC4000 Automation Genome ...... 1 About PAS ...... 2 Document Conventions ...... 3 DOC4000 Resources ...... 4 DOC4000 Access and Navigation ...... 7 Configuring Internet Explorer...... 7 Launching DOC4000 ...... 8 Login Authentication ...... 8 Logging Out ...... 8 The DOC4000 Dashboard ...... 9 Changing Your Password ...... 10 Customizing the Home Page ...... 11 Using DOC4000 ...... 15 Exploring Assets ...... 15 Explore Overview ...... 15 Using the Asset Explorer ...... 16 Using the Hardware Overview ...... 17 Searching the Database ...... 18 Tracking Changes in Data ...... 20 Changes Overview ...... 20 Viewing Object Changes ...... 21 Acknowledging Changes to an Object ...... 24 Suppressing Object Changes ...... 24 Exporting and Printing Object Change Data ...... 29 Working with Defects ...... 30 Defects Overview ...... 30 Searching Defects ...... 31 Acknowledging Defects...... 32 Exporting and Printing Defects ...... 33 Assigning Defects ...... 34 Suppressing Defects ...... 35 Resolving Defects ...... 36 Querying Data ...... 37 Queries Overview ...... 37 Creating Change History Queries ...... 39 Creating Property Data Queries ...... 42 Creating Reference Queries ...... 45 Creating SQL Queries...... 47 Executing a Query ...... 49 Exporting and Printing Query Results ...... 50 Modifying a Query ...... 51 Deleting a Query ...... 52 Managing Spares ...... 53

iii DOC4000 User Guide

Spare Management Overview ...... 53 Creating/Modifying a Project ...... 54 Searching for Spares ...... 55 Reserving a Spare ...... 56 Searching for Reservations ...... 57 Releasing a Reservation ...... 58 Running Reports ...... 59 Reports Overview ...... 59 Configuring Printer Settings ...... 60 Creating a Report Package ...... 63 Adding Reports to a Report Package ...... 64 Running a Report Package ...... 65 Viewing Previously Run Reports ...... 66 Modifying a Report Package ...... 67 Deleting a Report Package ...... 68 Scheduling Reports ...... 69 Managing Workflows ...... 71 Management of Change (MOC) Overview ...... 71 Searching MOC ...... 72 Viewing Summaries ...... 74 Starting Cases ...... 76 Updating Cases ...... 78 Reassigning Cases ...... 80 Closing Cases ...... 81 Deleting Cases ...... 82 Using Recon ...... 83 Recon Overview ...... 83 Recon Information ...... 84 Recon Viewers ...... 90 Viewing Notes ...... 96 Notes Overview ...... 96 Appendix A - Asset Viewers ...... 97 Asset Viewers Overview ...... 97 Alarms Viewer ...... 99 CL File Viewer ...... 100 Controller Viewer ...... 101 Display Viewer ...... 102 E-Mail Viewer ...... 103 File Compare Viewer ...... 104 Integrity Viewer ...... 105 Logic Viewer ...... 106 Map Viewer ...... 107 Modifications Viewer ...... 110 Notes Viewer ...... 111 Program Viewer ...... 112 Properties Viewer ...... 113

iv Table of Contents

References Viewer ...... 114 Reserve Viewer ...... 115 User-Defined Viewer ...... 116 IP Addresses Viewer...... 117 Appendix B - Asset Model Specific Viewers ...... 118 DeltaV ...... 118 FoxIA ...... 119 TPS ...... 123 Index ...... 125

v

Getting Started

Welcome to DOC4000 Automation Genome

DOC4000 is the industry’s first complete enterprise automation asset management solution. DOC4000 includes the following functionality:  Import of system database configurations  Documentation and relationship inference of entities and applications  Automatic generation of control diagrams for visualization of control strategies  Application control and data integrity checking  Management of change reporting between multiple imports  Web browser-based access to data and information worldwide  Ability to generate custom queries  Central repository of data  Ability to generate custom reports  Ability to manage data integrity issues The solution spans all automation levels. Providing information contained within Level 1, Level 2, and Level 3 process automation systems to provide:  Integrated documentation  Change Tracking  Integrity audits

1 DOC4000 User Guide

About PAS

PAS (www.pas.com) improves the automation and operational effectiveness of oil and gas, petroleum refining, chemicals, pulp and paper, metals and mining, and power customers worldwide. We provide software and services that ensure safe running operations, maximize situational awareness, and reduce plant vulnerabilities. Our comprehensive portfolio includes solutions for Alarm Management, Automation Configuration Management, Control Loop Performance Optimization, and High- Performance Human-Machine Interfaces. PAS solutions are installed in over 1000 process industry plants worldwide.

Copyright ©2003-2011 PAS, Inc. All rights reserved worldwide. Printed in U.S.A. This document contains proprietary information of PAS, Inc., and is tendered subject to the condition that no copy or other reproduction be made in whole or in part, and that no use be made of information herein except for the purpose for which it is transmitted, without express written permission of PAS, Inc. PAS makes no representations or warranties with respect to the contents hereof and specifically disclaims any implied warranties of merchantability for any particular purpose. Furthermore, PAS reserves the right to revise this publication and to make changes in content hereof without obligation of PAS to notify any person of such revision. Trademarks DOC4000 is a trademark of PAS, Inc. Windows NT, Windows 2003, Windows XP, Windows, and Microsoft are registered trademarks of Microsoft Corporation. All other trademarks and registered trademarks belong to their respective owners. DOC4000 .4.0 PAS 16055 Space Center Blvd., Suite 600, Houston TX 77062 USA PAS Customer Support Web Address http://support.pas.com/RapidSupport PAS Product Information Phone 281 286-6565 Fax 281-286-6767 Web Address http://www.pas.com

2 Getting Started

Document Conventions

This section describes the types of conventions used throughout the DOC4000 documentation.

Typeface Meaning Example AaBbCc123 Menus, buttons, The Edit menu includes an option to Export to Excel. window names,

menu commands, check boxes, field names, column names, module names, and report/analysis names appear in boldface font. AaBbCc123 Book titles, new See the DOC4000 Administration Guide for more terms, and terms to information. be emphasized A cache is a copy that is stored locally. appear in italics. Do not save the file. AaBbCc123 A monospace font Type UtilityName to execute the utility. identifies command names, system calls, and data structures and types. AaBbCc123 In command syntax, Type italic-boldface font \Honeywell\DOC4000\FileName.exe

identifies variables in the Open box, where is the drive and that you must directory location where DOC4000 is installed (the default provide. location is C:\Program Files).

3 DOC4000 User Guide

DOC4000 Resources

Documentation for your software is available in a variety of formats. In-product Help In-product help provides access to all documentation and instructional content available at the time the software ships. It is available through the Help menu.  You can access in-product help by clicking the Help icon in the upper right corner of the DOC4000 window.

To open help sections and view topics: The DOC4000 help system is designed like a large online book with topics grouped into like sections. . - A plus sign represents a collapsed section. Clicking the graphic expands the topics in that section. . - A minus sign represents an expanded section, showing the topics contained in that section. Clicking this graphic collapses the section. . - This graphic represents a topic within a section of the help. Clicking this graphic opens the corresponding topic.

To print a help topic:  Right-click on the topic and select Print. Printed/Electronic Documentation Honeywell provides the following documents with your software. The documents are available on your installation media or from the PAS Support Portal  Integrity & DOC4000 Readiness Checklist  Integrity & DOC4000 Release Notes  DOC4000 Installation Guide  DOC4000 Upgrade Guide  DOC4000 Administration Guide  DOC4000 User Guide Customer Care PAS Technical Support Engineers can be contact in several ways to assist you. Telephone A 7/24 support line is available should you need help outside our regular business hours - 281-286- 6565 ext 2 E-mail [email protected]

4 Getting Started

Support Portal You can log into the PAS Support Portal at any time to enter new cases and track existing cases. http://support.pas.com/Rapidsupport

5

DOC4000 Access and Navigation

Configuring Internet Explorer

Prior to launching DOC4000 for the first time, some Internet Explorer security settings should be modified to make DOC4000 run properly. In particular, these settings help DOC4000 cache data correctly to:  refresh the query definition functionality,  create reports  reserve spares  acknowledging issues  change summary items Note: In addition to the settings below, popup blockers need to be disabled in Internet Explorer for DOC4000 to function properly. Various parts of the application may not display as expected if popup blockers are enabled. For users without permissions to change their Internet Explorer settings, either hold down the [Ctrl] key when clicking on a link that gets blocked OR right-click the link and select Open in a new window.

To configure Internet Explorer 6: 1. Start Internet Explorer. 2. Click the Tools menu and select Internet Options. 3. On the Internet Options dialog box, click the Settings button on the General tab. 4. On the Settings dialog box, select Every visit to the page. 5. Click OK. 6. On the Internet Options dialog box, click OK.

To configure Internet Explorer 7 or 8: 1. Start Internet Explorer. 2. Click the Tools menu and select Internet Options. 3. In the Browsing History section on the General tab, click the Settings button. 4. In the Check for newer versions of stored pages area, select Every time I visit the webpage. 5. On the Settings dialog box, select Every visit to the page. 6. Click OK. 7. On the Internet Options dialog box, click OK.

7 DOC4000 User Guide

Launching DOC4000

For more information on DOC4000 installation and administration, see the DOC4000 Installation Guide and the DOC4000 Administration Guide.

Login Authentication The authentication process occurs each time you launch DOC4000 or the DOC4000 Admin Utility. DOC4000 supports two modes of authentication (specified during installation).

Application When Application Authentication is used, users must login with a login Authentication name and password to launch DOC4000. Windows Authentication If Windows Authentication is used, users are not required to enter a login name and password to launch DOC4000.

To launch DOC4000: 1. In the Address box in Internet Explorer, type https://ServerName/DOC4000, where ServerName is the name of the web server where DOC4000 is hosted. 2. Click Go.  If Windows Authentication was selected during installation, the DOC4000 Dashboard will open automatically.  If Application Authentication was selected during installation, you will be required to type a user name and password on the Login page.

Logging Out If DOC4000 is configured to use Application Authentication, you can log out the currently logged in user.

To log out the currently logged in user: From the DOC4000 Dashboard, click the Log Out link in the upper-right corner (this link is not available if DOC4000 is configured to use Windows Authentication).

8 DOC4000 Access and Navigation

The DOC4000 Dashboard

The DOC4000 Dashboard provides navigation to all application areas. Each button at the top of the Dashboard provides different functionality. See "Using DOC4000" for more information on these areas.

9 DOC4000 User Guide

Changing Your Password

If DOC4000 is configured to use Application Authentication, you can change your password by using the Change Password icon.

To change your password: 1. On the DOC4000 Dashboard, click the Change Password icon.

2. On the Change Password window, type the existing password in the Old Password box. 3. In the New Password box, type the new password. 4. In the Confirm Password box, re-type the new password. 5. Click OK.

10 DOC4000 Access and Navigation

Customizing the Home Page

Navigation: DOC4000 Dashboard > Home The DOC4000 Home page is designed to be customized so that each user can specify what information is displayed. As part of the page configuration, modules are available to be added to the page. Once a module is added to the page, you can configure the module properties and display location. You also can choose to minimize modules or close them (which maintains their property information but temporarily removes them from the page).

Available Modules

Module Description PAS Blog Displays a link to the most recent posts on the PAS Blog. Defect Finder Displays defects for the selected asset. Local Weather Displays a weather report for the selected zip code. Report Last Import Displays the date and time of the last import for the selected asset. Query Displays the results of a predefined query. Change Tracker Displays a summary of changes for the selected asset. Spares/Reservations Displays spares and/or reservations for the selected asset. User Notes Displays notes entered for the selected asset. Report Packages Displays any report packages created for the selected asset. Key Performance Displays key performance indicators for the selected asset Indicators

To configure your Home page:

11 DOC4000 User Guide

1. On the Home page, click Home and select Edit Home. 2. Choose one of the available page layouts. 3. Click Home and select View Home. 4. Choose the zone where you would like to place a module and click the Click to add modules to this zone button for that zone. 5. From the Catalog dialog box, select one or more modules to add to the selected zone. 6. Click Add. 7. Edit the modules to complete their configuration.

To edit a module: 1. On the Home page, click the drop-down arrow for the module to edit and select Edit.

2. In the Configure Module area, make changes as needed to specify the properties for the module. Note that the properties for a module vary based on the module being edited. 3. Click OK.

To remove a module: 1. On the Home page, click on the drop-down arrow next to a module name. 2. Select Delete.

12 DOC4000 Access and Navigation

3. Click OK to confirm deletion.

To minimize a module: 1. On the Home page, click on the drop-down arrow next to a module name. 2. Select Minimize.

To restore a minimized module: 1. On the Home page, click on the drop-down arrow next to a module name. 2. Select Restore.

13

Using DOC4000

Exploring Assets

Explore Overview

Navigation: DOC4000 Dashboard > Explore The Explore page allows you to view assets and objects either by using a tree view to navigate through the various assets or by selecting an asset to view a hardware overview. The Explore page is divided into two tabs: Asset Explorer and Hardware Overview.

Explore Page Tabs

Tab Description The Asset Explorer tab is used to show a hierarchical list of assets. Objects are determined by the asset model to which they are assigned (or customized by the administrator). To expand an object, click the plus sign [+] beside the Asset Explorer object. Clicking on an object will display the properties of the object in one or more asset viewers (each asset viewer is represented by a tab in the right pane of the page). Click the Show Options button and click on the Show Spares checkbox to display any spare objects in the tree view. Hardware Select any asset to view its hardware overview. On the overview, click on any Overview component to view items under that component.

15 DOC4000 User Guide

Using the Asset Explorer

Navigation: Explore > Asset Explorer Assets are arranged in the Asset Explorer in a hierarchical structure based on the import structure. As you select a specific asset, details for the asset are displayed in the right pane in one or more Asset Viewers. The different Asset Viewers available are based on the asset type selected. Click each asset viewer's tab to view the asset's properties.

To view asset details: 1. From the DOC4000 Dashboard, click Explore. By default, the Asset Explorer displays on the page. 2. From the Asset Explorer, click the [+] signs next to each top-level asset until you locate the asset for which you would like to view details. 3. Click the tabs for the desired viewers to view asset details.

16 Using DOC4000

Using the Hardware Overview

Navigation: Explore > Hardware Overview When an asset is selected on the Hardware Overview tab, its hardware components are displayed. Clicking on any component displays the items under it.

To view hardware details: 1. From the DOC4000 Dashboard, click Explore, and select Hardware Overview. 2. Click the Hardware Overview tab. 3. Choose the desired asset.

17 DOC4000 User Guide

Searching the Database

Navigation: DOC4000 Dashboard > Search The Search page allows you to search the DOC4000 database or attached files. Searches can include:  text from any file (such as a program file) attached to an object.  text contained in an object property in the database.  an object name in the database. The search can be performed across all assets and all object types or across a selected asset. If an asset is selected, you can choose to search all object types within the asset or a single object type.

To perform a search: 1. From the DOC4000 Dashboard, click Search. 2. Select an asset or select . 3. If you selected , will be selected. If you selected a single asset, select either a single object to search or select . 4. Type the search string in the Search box. Refer to the search hints operators and wild cards supported below. 5. Click the Search button. 6. Click on any result to display its details in a viewer. Search Hints  Search strings are not case sensitive.  Various operators and wildcards are supported in searches and vary based on the type of search--object name searches or text searches.

18 Using DOC4000

 Database and file searches use the SQL Server full-text search engine, which dictates the rules regarding operator and wildcard usage.  Wildcards can be used only as suffixes in full-text searches (i.e., FC*).  Operators are not used in object name searches.  The search results can contain zero, one, or many items.  Each returned item contains a link to directly access the item. Operators Supported in Full-Text Searches

Operator Example Description OR Operators - The use of the OR operator is supported in a search string, raise OR lower The search string raise OR lower searches the database for entries that include forms of the words raise or lower. raise AND lower AND Operators - The use of the AND operator is supported in a search string. The search string raise AND lower searches the database for entries that include forms of both words raise and lower. The AND operator is not necessary and the search string raise lower would return the same results. "testing Phrases - The use of quotations marks in a search string is supported to method" search for a phrase. The search string "testing method" would search the database for entries including the phrase testing method. Word Proximity - The use of < and > signs around a group of words in a search string searches for words in close proximity to each other. The search string would search the database for an entry that contains the word drum in close proximity to the word level. +test Exact Word - The use of the + sign before a word indicates that the search should not include inflectional forms of the word. The search string +test searches the database for the word test without generating inflectional forms such as testing, tested, etc.. testing -method Word Exclusion - The use of the - minus sign before a word indicates that the search should not include inflectional forms of that word. The search string testing -method searches the database for entries containing inflectional forms of the word test but not the word method. sub* Prefix Searches - The use of the * asterisk symbol after a word searches the database for words that begin with the word. The search string sub* searches for words that begin with sub. ~assessment Thesaurus - The use of the ~ tilde symbol before a word indicates that the search should return results of synonyms for the word.

Wildcards Supported in Object Name Searches

Wildcard Example Description An asterisk * represents zero or more characters. The search string *.eb * searches for any object names ending in .eb. ? A question mark ? represents a single variable character in a search string. The search string 1?1 searches for object names beginning with 1 and ending with 1, such as 123 or 1h3.

19 DOC4000 User Guide

Tracking Changes in Data

Changes Overview

The Changes page allows you to view and acknowledge object change information. For example, you can view changes for any objects that have been added to, deleted from, or modified. You also can acknowledge changes and then filter the data to see only specific types of changes or only changes that have or have not been acknowledged.

20 Using DOC4000

Viewing Object Changes

Navigation: DOC4000 Dashboard > Changes When searching for changes, you are prompted to select a query type and other filter options. Query by Date Range Query by Import Summary Query by Rolling Range

To search for changes: 1. On the DOC4000 Dashboard, click Changes. 2. On the Changes page, select an asset. 3. Select the type of query in the Query by box:  Date Range: For Date Range queries, enter the start and end times for the range of time for which you want to view object changes.  Import Summary: For Import Summary queries, select from a list of summaries by clicking on the import summary for which you want to view objects. To view changes for multiple summaries, press and hold the [Ctrl] key while clicking on the summaries to include.  Rolling Range: For Rolling Range queries, indicate the amount of time from the current date backwards for which changes should be displayed (e.g., 2 Years). 4. For date and rolling ranges, select if you want to return changes from import and/or from user entry of custom properties by clicking in the appropriate checkboxes. 5. Click Load Types. 6. Select an object type. 7. Optionally, navigate to a specific object using the Asset Explorer.

21 DOC4000 User Guide

7. Click Set Filters. 8. On the Filter Change Records dialog box, select to include either acknowledged changes, unacknowledged changes, or both by selecting the corresponding options (Acknowledged and/or Unacknowledged).

8. Select to include either changes for objects that have been added to, objects that have been deleted from, or modified objects by selecting the corresponding options (Added, Modified, and/or Deleted). 9. Select to include changes that have been suppressed by selecting the Include option. Note that only changes to modified objects can be suppressed. 10. Click Close. 11. Click Get Changes. Changes Details

Column Description Ack This column allows you to select a changed item to acknowledge or unacknowledge. Object Name This column displays the name of the object with a change.

22 Using DOC4000

Action This column displays the type of change (e.g., Object Added, Object Modified, or Object Deleted). PropertyName For modified objects, the name of the property that was modified is displayed here. OldValue For modified objects, the old value is displayed in this column. NewValue For modified objects, the new value is displayed in this column. Date This column displays the date and time the object was added, changed, or deleted. Case ID This column displays an identifier for a case if the object has been assigned. User Name This column displays the user name of the DOC4000 user who added, modified, or deleted the object.

23 DOC4000 User Guide

Acknowledging Changes to an Object

Navigation: DOC4000 Dashboard > Changes After viewing object changes, you can acknowledge changes. When viewing acknowledged object changes, a flag is displayed in the Ack column and any comments entered during acknowledgment are displayed in the Comment column. You can also filter future change searches to exclude acknowledged changes.

Note: A flag appears to the left of the object name to indicate that it has been acknowledged.

To acknowledge object changes: 1. On the DOC4000 Dashboard, click Changes. 2. On the Changes page, search for object changes. 3. Select the object change to acknowledge by selecting the checkbox in the left column. 4. Click the Acknowledge button. 5. If desired, type a comment on the Acknowledge Change pane. 6. Click Save. 7. Click OK.

To remove acknowledgement of a changed object: 1. On the DOC4000 Dashboard, click Changes. 2. On the Changes page, search for acknowledged object changes to select them. 3. Choose Unacknowledge from the Choose an action box. 4. If desired, type a comment on the Unacknowledge Change pane. 5. Click Save. 6. Click OK.

Suppressing Object Changes

Navigation: DOC4000 Dashboard > Changes For properties, the changes can be suppressed, which means the changes will not appear unless the filtering option has been set to include suppressed changes.

24 Using DOC4000

To suppress changes: 1. On the DOC4000 Dashboard, click Changes. 2. On the Changes page, search for object changes. 3. Select the object change to suppress by selecting the checkbox in the left column. 4. Click the Suppress button. 5. On the Suppress Change dialog box, review the items to be suppressed in the Step 1 area. To remove an item from the list, click in the checkbox next to the name of the item and click the Remove Rows button. 6. In the Step 2 area, click on an existing suppressed change set or click the Create New Change Set button to create a new suppressed change set. If creating a new change set, type a name for the change set in the Description field, select the date range for which the changes should be suppressed, and type a comment if needed. 7. In the Step 3 area, click the Save button to save the changed items to the selected change set. 8. Close the dialog box by clicking the X in the upper-right corner.

25 DOC4000 User Guide

To remove a suppressed changes: 1. On the DOC4000 Dashboard, click Changes. 2. On the Changes page, lick the Suppress button. 3. On the Suppress Change dialog box, click on an existing suppressed change set in the Step 2 area. 4. In the Step 3 area, click the checkboxes next to any objects for which you want to remove suppression. 5. Click the Save Changes button. 6. Close the dialog box by clicking the X in the upper-right corner.

26 Using DOC4000

27 DOC4000 User Guide

28 Using DOC4000

Exporting and Printing Object Change Data

Navigation: DOC4000 Dashboard > Changes After searching for object changes, you can export the results to a Microsoft Excel spreadsheet or to a PDF viewer for printing.

To export change data to Microsoft Excel: 1. On the DOC4000 Dashboard, click Changes. 2. On the Changes page, search for object changes.

3. Click the Export to Excel icon. 4. Click Save. 5. On the Save As dialog box, browse to the location where the file should be saved and click Save.

To export change data to a PDF file for printing, saving, or e-mailing: 1. On the DOC4000 Dashboard, click Changes. 2. On the Changes page, search for object changes.

3. Click the Print icon.

29 DOC4000 User Guide

Working with Defects

Defects Overview

The Defects page allows you to view the results of a variety of integrity checks performed on selected systems after importing their configuration. Once defects have been found, you can acknowledge them, assign them to a user for action, suppress them, and mark them as resolved.

Defect Details When a search is completed, the resulting defects are displayed. Defect Details

Column Description Status The defect's current status (e.g., resolved, assigned, suppressed, etc.). Priority The defect's current priority (e.g., low, normal, or high). Object1 This object name to which the defect is related. Clicking the object name opens the object in the Integrity Viewer. Object2 If the defect is related to missing references, the secondary name to which the defect is related. Assigned To If the MOC case has been assigned, the person to whom it has been assigned. Title The description of the defect.

30 Using DOC4000

Searching Defects

Navigation: DOC4000 Dashboard > Defect Finder

To search defects: 1. On the DOC4000 Dashboard, click Defects. 2. On the Defects page, select an Asset. 3. Select a Defect Type. 4. Click Go.

To filter search criteria: 1. On the Defects page, select a column, and select the criteria. For example, select Acknowledged and select False to search for all unacknowledged defects. Available options include:  Acknowledged - Select True or False.  Resolved - Select True or False.  Assigned To - Select an operator and enter search text.  Priority - Select an operator and enter search text.  Object 1 - Select an operator and enter search text.  Object 2 - Select an operator and enter search text.  Title- Select an operator and enter search text. 2. To add additional search criteria, click Add Another Filter Criterion, and repeat Step 1. 3. Click Apply Filter.

31 DOC4000 User Guide

Acknowledging Defects

Navigation: DOC4000 Dashboard > Defects You can acknowledge defects to indicate that you have been made aware of them. When searching defects, you can choose to include or exclude acknowledged defects.

Note: A flag appears in the Status column for defects that have been acknowledged.

To acknowledge a defect: 1. After locating defects on the Defects page, select defects for acknowledgement by clicking their checkboxes (to the left of the Status column). 2. Click the Acknowledge button. 3. If desired, type a comment on the Acknowledge Defect pane. 4. Click Save. 5. Click OK on the message box informing you the defect is acknowledged.

To remove acknowledgement of a defect: 1. On the Defects page, select the applicable acknowledged defects. 2. Click the Unacknowledge button. 3. If desired, type a comment on the Unacknowledge Defect pane. 4. Click Save. 5. Click OK.

32 Using DOC4000

Exporting and Printing Defects

Navigation: DOC4000 Dashboard > Defects After locating defects, you can export the results to a Microsoft Excel or PDF file.

To export defects to Excel: 1. Complete a search for defects.

2. Click the Export to Excel button. 3. On the File Download dialog box, click Open to display the results in a Microsoft Excel spreadsheet or Save to save the spreadsheet.

To print and/or export defects to a PDF file: 1. Complete a search for defects.

2. Click the Print button. 3. The results are displayed in a PDF file viewer. 4. Click the Print icon to send the results to a printer. 5. Click the Save icon to save the file.

33 DOC4000 User Guide

Assigning Defects

Navigation: DOC4000 Dashboard > Defects After viewing defects, you can assign them to users. The user can then resolve, acknowledge, and/or suppress the defect.

Note: A flag appears in the Status column for all defects that are assigned.

To assign a defect to a user: 1. After locating defects on the Defects page, select defects for assignment by clicking their checkboxes (to the left of the Status column). 2. Click the Assign button. 3. Choose the user/group to which the defects should be assigned. 4. If desired, type any comments regarding the assignment. 5. Click Save. 6. Click OK.

To unassign defects: 1. On the Defects page, select the assigned defects. 2. Click the Unassign button. 3. If desired, type a comment on the Unassign Defects pane. 4. Click Save. 5. Click OK.

34 Using DOC4000

Suppressing Defects

Navigation: DOC4000 Dashboard > Defects After viewing defects, you can choose to suppress any defects found. Suppressing defects prevents them from being displayed in searches (unless you have elected to include suppressed items using search options).

Note: If you have elected to include suppressed items in your search, a flag appears in the Status column for suppressed defects.

To suppress a defect: 1. After locating defects on the Defects page, select defects for suppression by clicking their checkboxes (to the left of the Status column). 2. Click the Suppress button. 3. If desired, type a comment on the Suppress Defect pane. 4. Click Save. 5. Click OK.

To unsuppress a defect: 1. On the Defects page, select applicable suppressed defects. 2. Click the Unsuppress button. 3. If desired, type a comment on the Unsuppress Defect pane. 4. Click Save. 5. Click OK.

35 DOC4000 User Guide

Resolving Defects

Navigation: DOC4000 Dashboard > Defect Finder After viewing defects, you can flag a defect as resolved and indicate the manner in which the defect was corrected.

Note: A flag appears in the Status column to indicate if a defect has been resolved.

To mark an issue as resolved: 1. After locating defects on the Defects page, select defects to mark as resolved by clicking their checkboxes (to the left of the Status column). 2. Click the Resolve button. 3. If desired, type a comment on the Resolve Defect(s) pane. 4. Click Save. 5. Click OK.

To mark an issue as unresolved: 1. On the Defects page, select applicable resolved defects. 2. Click the Unresolve button. 3. If desired, type a comment on the Unresolve Defect(s) pane. 4. Click Save. 5. Click OK.

36 Using DOC4000

Querying Data

Queries Overview

DOC4000's Query Builder provides you with a powerful way to query the DOC4000 database. You can use Honeywell built-in queries or build and save custom queries to search references, MOC change logs, etc. You also can build queries using SQL statements and build compound queries (queries based on other queries). Custom queries can be private (accessible only to the creator of the query) or public (accessible to all users). Creating Queries When creating a new query, you are prompted to select the asset and the type of query. Purposes and parameters for each query type vary. Query Types

Type Description Change History Used to search for added objects, deleted objects, and changes to objects' properties Property Data Used to search for objects' property data Reference Query Used to search for references/connections between two object types. SQL (Advanced) Used to search for variety of objects and property data by using SQL.

To create a new query: 1. On the DOC4000 Dashboard, click the Queries button, and select Create/Edit Queries. 2. Select an asset, and the type of access for the query. 3. Select the type of query:  Change History - See Creating Change History Queries for more information

37 DOC4000 User Guide

 Property Data - See Creating Property Data Queries for more information  Reference Query - See Creating Reference Queries for more information  SQL (Advanced) - See Creating SQL Queries for more information on this query type 4. Click on the Create New Query link in the list.

38 Using DOC4000

Creating Change History Queries

Navigation: DOC4000 Dashboard > Queries > Create/Edit Queries Change History queries are used to search for added objects, deleted objects, and changes to objects' properties.

To create a new Change History query: 1. On the DOC4000 Dashboard, click the Queries button, and select Create/Edit Queries. 2. Select an asset, and the type of access for the query. 3. Select the Change History query type. 4. Click the Create New Query link in the list. 5. For Show Objects, indicate what types of records should be included in the query: Added, Modified, and/or Deleted. 6. Select an Object Type for the query. If the object type includes subtypes, click the Subtypes link to select which subtypes to include. (If the Subtypes link is available but no subtypes are selected, all subtypes will be included in the query.) 7. To filter the query results by date range or selected imports, click Import Summary. In the Query by box, indicate if the data should be limited to specific import summaries or to a specific date range.  If querying by Date Range, specify the Begin Date and the End Date for the query and click Update.  If querying by Import Summary, choose each import summary to include from the Available imports list and add them to the Chosen imports list. 8. Click the Property names link to select the properties to include in the query. If you do not specify properties, all the properties will be returned as columns in the result set.  Click on a Property Name, and then click on the right arrow to add the property to the Included in Results box.  To modify the sort order, click on a property in the Include in Results box and click the right arrow to add the property to the Sort by box. (Results are sorted by object name by default.)  Order the properties that will be returned and/or used to sort the results using the up and down arrow buttons.  Select the Show common property option to list all properties that have been designated as common. (Select a property and click on Add item to common properties to designate a property as common.) Common properties can be added to an object type to apply to all objects of that type (per asset).

39 DOC4000 User Guide

9. You can select criteria to be applied to the query to filter the results. If you do not specify criteria, all records will be returned. Click the Search criteria link to add search criteria, and then choose either Select from Properties or Use selection list.  Select from properties: Use this option to specify specific properties to include in the search criteria. a. Type the Object Name, Property Name, Old Value, New Value, if you want to include acknowledged or unacknowledged changes, and a comment. b. Click Add. c. Enter additional expressions and click AND or OR to concatenate the information to the existing expression. d. Click Update Criteria.  Use selection list: Use this option to select from a list of available objects, to save a list of selected objects, or to select a previously saved list of objects. o To copy objects from the clipboard in the search criteria:: a. From an application (such as Microsoft Excel or Word), copy the list of objects. Objects can be delimited by spaces, commas, semicolons, and the pipe (|) character.

b. Click the Paste from Clipboard button in the right side of the Search Criteria area. DOC4000 will validate that the list of objects is valid. If the objects are valid, they will appear in the List details list box. c. Click Create Criteria. d. Click Update Criteria to save changes to the search criteria. o To select objects to include in the search criteria: a. Select the objects to include from the Available objects list and click to add them to the List details box. b. Click Create Criteria. c. Click Update Criteria to save changes to the search criteria. o To add a new list: a. Choose Add New from the Select list name box. b. Type a name for the list in the Enter new selection list name box. c. Select the objects to include from the Available objects list and click to add them to the List details box. d. Click Save List. e. Click Create Criteria. f. Click Update Criteria to save changes to the search criteria. o To select an existing list: a. Choose the list from the Select list name box. b. Modify the list as necessary. If the list is modified, click Save List to save it. c. To use the list in the search criteria, click Create Criteria.

40 Using DOC4000

d. Click Update Criteria to save changes to the search criteria. 11. Click Run to view the query results. 12. To save the query, click Save As.  On the Save Query pane, type a name for the query in the text box.  Save the query as a private query by clicking on the Private option or make it available to all users by accepting the default Public option.  Select the Save with Asset Model option to denote that the query will be available for all assets of the same asset model type.  Click OK, and then click OK on the confirmation message.

41 DOC4000 User Guide

Creating Property Data Queries

Navigation: DOC4000 Dashboard > Queries > Create/Edit Queries Property Data queries are used to search for objects' property data.

To create a new Property Data query: 1. On the DOC4000 Dashboard, click the Queries button, and select Create/Edit Queries. 2. Select an asset, and the type of access for the query. 3. Select the Property Data query type. 4. Click the Create New Query link in the list. 5. Select an object type for the query. If the object type includes subtypes, click the Subtypes link to select which subtypes to include. (If the Subtypes link is available but no subtypes are selected, all subtypes will be included in the query.) 6. Click the Property names link to select the properties to include in the query. If you do not specify properties, all the properties will be returned as columns in the result set.  Click on a property name, and then click on the right arrow to add the property to the Included in Results box.  To modify the sort order, click on a property in the Include in Results box and click the right arrow to add the property to the Sort by box. (Results are sorted by object name by default.)  Order the properties that will be returned and/or used to sort the results using the up and down arrow buttons.  Select the Common property names only option to list all properties that have been designated as common. (Select a property and click on Add item to common properties to designate a property as common.) Common properties can be added to an object type to apply to all objects of that type (per asset). 7. You can select criteria to be applied to the query to filter the results. If you do not specify criteria, all records will be returned. Click the Search criteria link to add search criteria, and then choose either Select from Properties or Use selection list.  Select from Properties: Use this option to specify specific properties to include in the search criteria. a. Click on a property name in the list box. b. Click on an operator in the list box. c. Specify a value criterion in the text box.

42 Using DOC4000

d. Click Add. The criterion defined is displayed in the list box. e. Additional expressions can be entered by using AND or OR to concatenate the information to the existing expression.  Use selection list: Use this option to select from a list of available objects, to save a list of selected objects, or to select a previously saved list of objects. o To copy objects from the clipboard in the search criteria:: a. From an application (such as Microsoft Excel or Word), copy the list of objects. Objects can be delimited by spaces, commas, semicolons, and the pipe (|) character.

b. Click the Paste from Clipboard button in the right side of the Search Criteria area. DOC4000 will validate that the list of objects is valid. If the objects are valid, they will appear in the List details list box. c. Click Create Criteria. d. Click Update Criteria to save changes to the search criteria. o To select objects to include in the search criteria: a. Select the objects to include from the Available objects list and click to add them to the List details box. b. Click Create Criteria. c. Click Update Criteria to save changes to the search criteria. o To add a new list: a. Choose Add New from the Select list name box. b. Type a name for the list in the Enter new selection list name box. c. Select the objects to include from the Available objects list and click to add them to the List details box. d. Click Save List. e. Click Create Criteria. f. Click Update Criteria to save changes to the search criteria. o To select an existing list: a. Choose the list from the Select list name box. b. Modify the list as necessary. If the list is modified, click Save List to save it. c. To use the list in the search criteria, click Create Criteria. d. Click Update Criteria to save changes to the search criteria. 8. Click Run to view the query results. 9. To save the query, click Save As.  On the Save Query pane, type a name for the query in the text box.  Save the query as a private query by clicking on the Private option or make it available to all users by accepting the default Public option.  Select the Save with Asset Model option to denote that the query will be available for all assets of the same asset model type.

43 DOC4000 User Guide

 Click OK, and then click OK on the confirmation message.

44 Using DOC4000

Creating Reference Queries

Navigation: DOC4000 Dashboard > Queries > Create/Edit Queries Reference queries are used to search for references/connections between two object types.

To create a new Reference query: 1. On the DOC4000 Dashboard, click the Queries button, and select Create/Edit Queries. 2. Select an asset, and the type of access for the query. 3. Select the Reference Data query type. 4. Click the Create New Query link in the list. 5. Select an object type for the query. If the object type includes subtypes, click the Subtypes link to select which subtypes to include. (If the Subtypes link is available but no subtypes are selected, all subtypes will be included in the query.) 6. For Reference queries only, click the Reference Types link to see a list of available reference types for the object type.  Click on reference type, and then click on the right arrow to add it to the Included References Types box.  Select to either Show objects with references of selected types or to Show objects without references of selected types (show those objects that do not have references). 7. You can select criteria to be applied to the query to filter the results. If you do not specify criteria, all records will be returned. Click the Search criteria link to add search criteria.  To copy objects from the clipboard in the search criteria:: a. From an application (such as Microsoft Excel or Word), copy the list of objects. Objects can be delimited by spaces, commas, semicolons, and the pipe (|) character.

b. Click the Paste from Clipboard button in the right side of the Search Criteria area. DOC4000 will validate that the list of objects is valid. If the objects are valid, they will appear in the List details list box. c. Click Create Criteria. d. Click Update Criteria to save changes to the search criteria.  To select objects to include in the search criteria:

45 DOC4000 User Guide

a. Select the objects to include from the Available objects list and click to add them to the List details box. b. Click Create Criteria. c. Click Update Criteria to save changes to the search criteria.  To add a new list: a. Choose Add New from the Select list name box. b. Type a name for the list in the Enter new selection list name box. c. Choose if the list should be Public or Private.

d. Select the objects to include from the Available objects list and click to add them to the List details box. e. Click Save List. f. Click Create Criteria. g. Click Update Criteria to save changes to the search criteria.  To select an existing list: a. Choose the list from the Select list name box. b. Modify the list as necessary. If the list is modified, click Save List to save it. c. To use the list in the search criteria, click Create Criteria. d. Click Update Criteria to save changes to the search criteria. 8. Click Run to view the query results. 9. To save the query, click Save As.  On the Save Query pane, type a name for the query in the text box.  Save the query as a private query by clicking on the Private option or make it available to all users by accepting the default Public option.  Select the Save with Asset Model option to denote that the query will be available for all assets of the same asset model type.  Click OK, and then click OK on the confirmation message.

46 Using DOC4000

Creating SQL Queries

Navigation: DOC4000 Dashboard > Queries > Create/Edit Queries SQL queries are used to search for variety of objects and property data by using SQL.

To create a new SQL query: 1. On the DOC4000 Dashboard, click the Queries button, and select Create/Edit Queries. 2. Select an asset, and the type of access for the query. 3. Select the SQL query type. 4. Click the Create New Query link in the list. 5. Click on the SQL Query link. 6. From the Select datasource box, choose what data to use for the query: Object Type, Query, or External Data Source.  For External data source only, select the connection to the external datasource (i.e., LCN Main, LCN DS, etc.).  Select the tables to include in the query.  To search the cache instead of the database, check the Use Cache option for each table to include.  Click Add Selected to add the selected tables to the query.  Click Create SQL.  Click Update. 7. Click Run to view the query results. 8. To save the query, click Save As.  On the Save Query pane, type a name for the query in the text box.  Save the query as a private query by clicking on the Private option or make it available to all users by accepting the default Public option.

47 DOC4000 User Guide

 Select the Save with Asset Model option to denote that the query will be available for all assets of the same asset model type.  Click OK, and then click OK on the confirmation message.

48 Using DOC4000

Executing a Query

Navigation: DOC4000 Dashboard > Queries You can execute any previously defined and saved queries.

To run an existing query: 1. On the DOC4000 Dashboard, click the Queries button. By default, the Run Queries tab opens. 2. Select an Asset. 3. Select the desired Query Access. 4. Select the desired Query Type. 5. Select the Query Name to execute. 6. Click Run Query.

49 DOC4000 User Guide

Exporting and Printing Query Results

Navigation: DOC4000 Dashboard > Queries > Run After executing a query, you can export the results of the query to an Excel or PDF file.

To export results of a query to Excel: 1. On the DOC4000 Dashboard, click the Queries button.

2. After executing a query on the Run tab, click the Export to Excel button. 3. Click OK. 4. On the File Download dialog box, click Open to display the results in a Microsoft Excel spreadsheet or Save to save the spreadsheet.

To print and/or export query results to a PDF file: 1. On the DOC4000 Dashboard, click the Queries button.

2. After executing a query on the Run tab, click the Print button. 3. The query results are displayed in a PDF file viewer. 4. Click Print to send the results to a printer. 5. Click Save to save the file.

50 Using DOC4000

Modifying a Query

Navigation: DOC4000 Dashboard > Queries > Create/Edit Queries Existing queries can be modified from the Create/Edit Queries tab.

To modify a query: 1. On the DOC4000 Dashboard, click the Queries button, and select Create/Edit Queries. 2. Select an asset, and the type of access for the query. 3. Select the type of query. Existing queries for the selected asset, query access, and query type are listed in the Query Name box. 4. Click the name of the query to edit. 5. Modify the query parameters on the Query Definition pane. 6. Click Save to save the query or Save As to save the modified query with a new name.

51 DOC4000 User Guide

Deleting a Query

Navigation: DOC4000 Dashboard > Queries > Create/Edit Queries Queries that are no longer used can be deleted from DOC4000.

To delete a query: 1. On the DOC4000 Dashboard, click the Queries button, and select Create/Edit Queries. 2. Select an asset, and the type of access for the query. 3. Select the type of query. Existing queries for the selected asset, query access, and query type are listed in the Query Name box. 4. Select the query or queries to be deleted by clicking their checkboxes. 5. Click Delete Checked. 6. Click OK.

52 Using DOC4000

Managing Spares

Spare Management Overview

The Spares page identifies spare capacity of automation objects and can be used to reserve these spare objects. Search functionality is provided for finding spares and reserved spares.

53 DOC4000 User Guide

Creating/Modifying a Project

Navigation: DOC4000 Dashboard > Spares > Browse Projects Projects are entities that can be created to identify blocks of reserved objects. When reserving a spare, you can specify the project to which the reservation belongs. Deleting a project releases all reservations associated with the project.

To create a new project: 1. On the DOC4000 Dashboard, click the Spares button, and select Browse Projects. 2. Select an asset. 3. Select Create New from the Choose project box. 4. Type a name for the project. 5. Type a short description for the project. 6. Type any additional comments regarding the project. 7. Click Save. 8. Click OK on the confirmation message box.

To modify an existing project: 1. On the Browse Projects tab, select a project from the Choose project box. 2. Make changes as needed to the project description and/or comment. 3. Click Save. 4. Click OK on the confirmation message box.

To delete an existing project: 1. On the Browse Projects tab, select a project from the Choose project box. 2. Click Delete. 3. Click OK on the confirmation message box.

54 Using DOC4000

Searching for Spares

Navigation: DOC4000 Dashboard > Spares > Browse Spares Spare objects are used to reserve objects within the asset. Using this functionality, you can create an asset structure that contains components that will be used in the future.

To search for spare objects: 1. On the DOC4000 Dashboard, click the Spares button, and select Browse Spares. 2. Select an asset. 3. Select an object type (such as Spare Tag). 4. Select each of the types of spares to be returned:  Empty (spares that have not been reserved)  Filled (spares that are now permanent objects)  Reserved (spares that have been reserved) 5. Click Go.

55 DOC4000 User Guide

Reserving a Spare

Navigation: DOC4000 Dashboard > Spares > Browse Spares After locating spares, you can use the Reservation Information pane to reserve one or more spares under the same project.

To reserve spares: 1. On the DOC4000 Dashboard, click the Spares button. 2. On the Browse Spares tab, search for spares. 3. Select one or more spares from the results grid by clicking on their checkboxes. 4. Click the Reserve button. 5. In the Reservation Information pane, select the project under which the spare reservations will be classified. 6. From the Reservation name box, select an existing reservation name or add a new one. 7. Type a comment concerning why the spare objects are being reserved in the Comment box. 8. Click Save. 9. Click OK.

56 Using DOC4000

Searching for Reservations

Navigation: DOC4000 Dashboard > Spares > Browse Reservations When a spare object has been reserved, the object is associated with a project and a comment concerning the reason the reservation was made.

To search for spare reservations: 1. On the DOC4000 Dashboard, click the Spares button, and select Browse Reservations. 2. Select an asset. 3. Select a project name. 4. If needed, select the name of a reservation to further refine the results. 5. Click the Reservation Id to view additional details in the Properties, Reserve, and Notes viewers.

57 DOC4000 User Guide

Releasing a Reservation

Navigation: DOC4000 Dashboard > Spares > Browse Spares You can use the Reserve viewer to release a single spare object in DOC4000.

To release a reservation: 1. On the DOC4000 Dashboard, click the Spares button, and select Browse Reservations. 2. On the Browse Reservations tab, search for reserved spares. 3. Select a reserved spare from the results grid by clicking on its name. 4. Click the Reserve viewer. 5. Click Remove. 6. Click OK on the confirmation message box. (In order to see the reservation as released or removed, you have to click away from this object and then come back.)

58 Using DOC4000

Running Reports

Reports Overview

DOC4000's Reports area allows you to configure report packages, which are designed to include one or more reports, each with its own configuration. Once a report is created, users can run the report. In addition, reports can be scheduled to be sent as emails.

59 DOC4000 User Guide

Configuring Printer Settings

The Settings > Print Configuration tab is used to specify how user's reports should print by default and-to show various properties for printing control maps. Note that the paper size and page orientation specified here can be overwritten when sending reports to a printer. Note: Print configuration must be done prior to printing from another location in DOC4000.

To configure printer settings:

1. Click the Settings icon in the upper-right corner.

2. On the Settings page, click the Print Configuration tab. 3. From the Select Paper Size box, choose the default paper size to use when displaying reports. 4. From the Select Page Orientation box, choose to display reports in portrait or landscape view.

60 Using DOC4000

5. Type any information, labels, or titles to include as a header on the reports. 6. Use the Map Properties area to include or limit the amount of data displayed in various map reports configured via the printed form (e.g., Logic Map, Reference Map, etc.). Complete the following information:  Same Asset Only: Select this option if you want to exclude references to other assets in your control maps .  Show References to all Objects: By default, the input level and output level references are set at the level specified in the Input, Output Levels box only for the top-level object. Selecting this option will display the references to the level specified for all objects. The time required to redraw the control map will be increased significantly if this option is selected.  Choose how you want the control map to be displayed --across multiple pages or on a single page.  Choose how you want to print control maps -- to Visio or PDF files Note: Visio files only apply to Logic Map, Device Control Map, and Reference Map reports.  Specify the number of input,output reference levels to use. The maximum value recommended for input, output reference levels is 3/3.  The Map Signature Block is available only to the Logic Map, Device Control Map, and Reference Map. Follow the instructions in the configure Map Signature Block topic to assign a value to each place holder in your signature block template. Note: Map Properties only apply to map reports generated via the Reports module.

7. Click Save.

To configure Map Signature Block:

1. From the Place Holder box, choose each place holder from your signature block template and either choose a value or type a value into the Value box.

61 DOC4000 User Guide

Note: Place holder &LOGO is used only for displaying an image of type .bmp, .gif, .jpg, .jpeg, .png, .tif, and .tiff. The image is automatically resized to fit within the place holder. Enter the full path to the image file in the Value box. Place holder &F1 can be used for displaying image or text value.

2. Click Add to assign the value to the place holder. 3. Click Save.

62 Using DOC4000

Creating a Report Package

Navigation: DOC4000 Dashboard > Reports > Create/Edit Reports A report package can include one or more reports for a single asset, which are configured and printed separately from one another.

To create a report package: 1. On the DOC4000 Dashboard, click the Reports button, and select Create/Edit Reports. 2. Select an asset. 3. In the Choose a package to edit area, click on Create New Report Package. 4. On the Create New Package pane, type the name for the new report package. 5. Select to make the report Public (accessible to all users) or Private (accessible only by the current user). 6. Click Save Package.

63 DOC4000 User Guide

Adding Reports to a Report Package

Navigation: DOC4000 Dashboard > Reports > Create/Edit Reports Once you've created a report package, you can select the reports to include in the package and configure those reports to meet your specific needs.

To add and configure reports in a report package: 1. On the DOC4000 Dashboard, click the Reports button, and select Create/Edit Reports. 2. Select an asset. 3. Click on the report package in the Choose a package to edit area. 4. From the Available Reports list, click on a report to include in the report package and click the right arrow to add it to the Included Reports list. 5. Notice the report is now listed in the Included Reports list with the words Not Configured appended to its name. Click on the report and click the Configure button. (Reports added to report packages are not available to run until they have been configured.) 6. Configuration options specific to the selected report are displayed. Modify these options as necessary and click Save Config. 7. Complete the steps above to add any other reports to the report package. 8. To include a custom divider page in the report package, click on the Divider report from the Available Reports list and use the right arrow to add it to the Included Reports list. Click the Divider report from the Includes Reports list and click Configure to change the text that will appear as a title on the divider page. 9. Once all desired reports have been added to the report package, use the up and down arrow keys under the Included Reports list to indicate the order that the reports should be displayed in the table of contents when the report package is run.

64 Using DOC4000

Running a Report Package

Navigation: DOC4000 Dashboard > Reports > Run Reports When running a report package, you can select to print all reports in the package or individually selected reports.

To print a report package: 1. On the DOC4000 Dashboard, click the Reports button, and select Run Reports. 2. Click on a report package to run. 3. By default, the Include Dividers, Include table of contents, and Include cover sheet options are selected for all report packages. Clear any of these options to exclude those sections when generating the report packages:  Include dividers - Click to indicate a divider page containing the name of the next report should be inserted between each report section.  Include table of contents - Click to indicate a contents page should be created at the beginning of the report listing all sections of the report with their page numbers.  Include cover sheet - Click to indicate a cover page should be created at the beginning of the report. 4. Any individual reports included in the report package that have already been configured are displayed in the Configured Reports list. To run the report package including all reports, click Preview All. To run the report package including only selected reports, press and hold the [Ctrl] key while selecting each report to include and click Preview Selection. 5. The pane on the right displays all report sections generated as part of the package (after processing). The status of the process is auto-refreshed every five seconds while the package is being generated. 6. From the Report Name column, click the link for each report section to view. 7. Click Open to open the report in pdf format or Save to save the report. 8. Click Print from the report viewer to send the report to a printer or Save to save the report to another location.

65 DOC4000 User Guide

Viewing Previously Run Reports

Navigation: DOC4000 Dashboard > Reports > Run Reports After running a report package, you can view the generated reports.

To open a previously run report: 1. On the DOC4000 Dashboard, click the Reports button, and select View Reports. 2. Any report packages previously generated (that have not been deleted) are listed. From the Package Folder column, click on the report package to view. 3. The report sections included in the package when it was generated are displayed on the screen. Click on a Report Name link to view its contents.

66 Using DOC4000

Modifying a Report Package

Navigation: DOC4000 Dashboard > Reports > Create/Edit Reports

To edit a report package: 1. On the DOC4000 Dashboard, click the Reports button, and select Create/Edit Reports. 2. Select an asset. 3. Click on the report package in the Choose a Package to Edit area in the left pane. 4. Edit the report package properties in the right pane as needed.

67 DOC4000 User Guide

Deleting a Report Package

Navigation: DOC4000 Dashboard > Reports > Create/Edit Reports

To remove a report package: 1. On the DOC4000 Dashboard, click the Reports button, and select Create/Edit Reports. 2. Select an asset. 3. Click on the report package in the Choose a Package to Edit area in the left pane. 4. Click Delete Package button at the top of the right pane. 5. Click OK.

68 Using DOC4000

Scheduling Reports

Navigation: DOC4000 Dashboard > Reports > Schedule Reports A report package can be scheduled to be emailed to a distribution list on import of data or on a hourly, daily, or weekly schedule..

To schedule a report package: 1. On the DOC4000 Dashboard, click the Reports button, and select Schedule Reports. 2. Select an asset. 3. Click New. 4. In the Email area on the Subscriptions and Notifications pane, enter the email addresses of all recipients of the report package. Separate each email address with a comma. 5. Enter a comment in the Message text box that will be included in the Subject of the email. 6. In the Schedule area, select one of the following options:  Import - An email will be sent with the report package on import of data for the selected asset.  Schedule - An email will be sent on either an hourly, daily, or weekly basis. First enter the time that the report will be sent, the select the schedule: o Hourly - Select an integer between 1 and 23. For example, selecting 1 means the report will be emailed on an hourly basis. o Daily - Select an integer between 1 and 100. For example, selecting 2 means the report will be emailed every other day. o Weekly - Select an integer between 1 and 100, and then select the day of the week on which the report will be emailed. For example, selecting 4 and Monday means the report will be emailed on Monday every four weeks. 7. Select the report package to be emailed. 8. At the top of the pane, click Save As. 9. Enter a name for the schedule, and click Save.

To modify a schedule:

69 DOC4000 User Guide

1. On the DOC4000 Dashboard, click the Reports button, and select Schedule Reports. 2. Select an asset. 3. Click on the name of a schedule. 4. On the Subscriptions and Notifications pane, make changes as needed. 5. Click Save.

To delete a schedule: 1. On the DOC4000 Dashboard, click the Reports button, and select Schedule Reports. 2. Select an asset. 3. Click on the checkbox to the left of the Schedule Name column. 4. Click Delete. 5. Click OK to confirm deletion.

70 Using DOC4000

Managing Workflows

Management of Change (MOC) Overview

Navigation: DOC4000 Dashboard > MOC Management of Change allows you to document your site's specific procedures for managing changes with user-created/imported checklists, procedural states and transitions, and authorization signoffs. The workflow component of DOC4000 assists users in complying with OSHA 1910.119(l).

Note: Configuration is required to access this module.

To manipulate the MOC overview: Click the corresponding buttons to: • Show Options - Select this button for options to view cases. • Start a Case - Select this button to create a new case.

• ReAssign - Select this button to reassign case(s) to a different owner. • Enter text into the box and click the Search button to find all cases that match the string.

• Clear search - Select this button to clear string from the search box.

• Save Grid State - Select this button and save current column sorting or grouping within the grid.

• Select this button to clear the grid state. • Click the Case Identifier link to view or update the process.

71 DOC4000 User Guide

Searching MOC

Navigation: DOC4000 Dashboard > MOC By default all open cases are listed on the Management of Change page when opened. Closed cases can be listed in addition to open cases, and you can search for specific case identifiers.

To view open cases: On the Integrity Dashboard, click MOC. All cases in a state other than Closed and Deleted are listed on the page.

To view open, closed and/or deleted cases: 1. On the Management of Change (MOC) page, click the Show Options button. 2. Click on the Include Closed Cases and/or Include Deleted Cases checkboxes.

3. Click the Refresh button.

To view cases based on Date Started or Date Completed range: 1. On the Management of Change (MOC) page, click the Show Options button. 2. Click on the Date Started or Date Completed checkbox. 3. In the appropriate begin and end date fields, enter a date range or click the Calendar button to select from the pop-up calendar.

4. Click the Refresh button.

To search cases by case number: 1. On the Management of Change (MOC) page, type a case number in the text box to the left of the Search button. Wildcards can be used to search for all cases that match the string.

72 Using DOC4000

2. Click the Search button. 1. On the Management of Change page, type a case number in the text box to the left of the Search button. Wildcards can be used to search for all cases that match the string. 2. Click the Search button.

73 DOC4000 User Guide

Viewing Summaries

Navigation: DOC4000 Dashboard > MOC Management of Change (MOC) in DOC4000 includes the following statistical information for cases:  Number of open cases - a bar or trend chart graphing the number of cases that are in a state other than completed or closed over a specified time period.  Number of completed cases - a bar or trend chart graphing the number of cases that have been completed (including closed cases) over a specified time period.  Number of completed but not closed cases - a bar or trend chart graphing the number of cases that have been completed, but not closed, over a specified time period.  Duration of cases - a trend chart for the average number of days a case is open. Only cases that were active during the specified time period are graphed. Each chart includes the ability to group by a user-selected field (such as the Location field). The records that meet the criteria for the summary are listed at the bottom of the window.

To view a summary: 1. On the DOC4000 Dashboard, click MOC.

74 Using DOC4000

2. On the Management of Change (MOC) page, click the Summary button. 3. On the Summary window, select the type of summary to view. 4. In the Start Date and End Date fields, enter a date range or select from the popup calendar.

5. Click the Refresh Chart button. 6. Toggle between a bar chart and trend graph by clicking the option buttons. For bar charts, you can select primary and secondary fields by which to group. For trends, you can select the interval time period for the trend and a primary field by which to group. After changing any options, click Refresh Chart. 7. To save the current criteria as the default for each the Summary window is opened, click the Save button.

75 DOC4000 User Guide

Starting Cases

Navigation: DOC4000 Dashboard > MOC Management of Change (MOC) cases can be created to document your site's specific procedures for managing changes. When starting a case, a workflow that has been defined in the DOC4000 Admin Utility can be assigned to the case, along with a location. Workflows are comprised of states with transitions, much like a process flow diagram. Each workflow consists of a beginning and ending state with a "normal" path that includes defined transitions between each state. Alternate paths can be created. For example, the "normal" path may be that an issue is assigned, work is performed, and approved before completion. An alternate path may be that the work is rejected and must be redone, then sent back for approval.

To start a case: 1. On the DOC4000 Dashboard, click MOC. 2. On the Management of Change page, click the Start a Case button. 3. On the Start a New Case dialog box, select a workflow and location, and click OK. To start a case: 1. On the Integrity Dashboard, click MOC. 2. On the Management of Change page, click the Start a Case button. 3. On the Start a New Case dialog box, select a location, a category, and a workflow definition, and click OK.

Note: There might be more fields to be selected before selecting the workflow definition. This depends on the number of common fields, which are defined as Case Type filter. 4. Click on a Case Identifier link to open the MOC Case viewer for the case. 5. In the MOC Information area, type a name for the case and any additional information.

6. Click the Save button.

4. Click on a Case Identifier link to open the MOC Case viewer for the case. 5. In the MOC Information area, type a name for the case and any additional information.

6. Click the Save button.

76 Using DOC4000

77 DOC4000 User Guide

Updating Cases

Navigation: DOC4000 Dashboard > MOC When creating a Management of Change (MOC) case, a workflow can be assigned to the case that designates the steps that must be followed to document the case. Once the case has been created, it must be updated as it transitions from state-to-state in the workflow. Each state can be assigned a checklist of items that are completed before the workflow can transition to the next state. Checklists are assigned to workflows in the DOC4000 Admin Utility and may include required items such as the date and time when a piece of equipment was serviced. In order to transition to the next state, approval is required on the MOC Case tab. When all states are complete, approval is again required to close the case. The History pane at the bottom of the tab audits the date/time that each approval occurred.

To update a case: 1. On the DOC4000 Dashboard, click MOC. 2. On the Management of Change (MOC) page, click on a Case Identifier link to open the MOC Case viewer.

3. In the Progress and Checklists area on the MOC Case viewer, click on a checklist if one exists for the first state. If a checklist does not exist, go to Step 6.

4. On the Check List dialog box, complete each section. All required fields are denoted with a red asterisk (*) next to the field label. The types of fields on the checklist include:  Checkboxes - Click to indicate true.  Radio Options - Click only one option to select it.  Text Entry - Click in the text box and type any comment.  Dropdown List - Click the dropdown arrow to select a single value from the list.  Date Selector - Click the Calendar button to popup a calendar to select a date or type a date in the text box.  Attach File - Click the Browse button to upload a file.  Signature - Click the checkbox to indicate a signature. Click OK on the confirmation message box that informs you that once signed, you cannot undo the signature.  Proposed Changes - Click in the text box and type any additional comments concerning changes.  Reconciled Changes - Click in the text box and type any additional comments concerning changes.

78 Using DOC4000

5. When completed with the checklist, click the Save Your Changes button. 6. In the Transition Approvals area, click the checkbox to approve completion of the state. If the workflow has been configured to require specific signatures for approval, these users must complete this step.

7. Click Save.

79 DOC4000 User Guide

Reassigning Cases

Navigation: DOC4000 Dashboard > MOC The owner of Management of Change (MOC) cases can be changed.

To close a case: 1. On the DOC4000 Dashboard, click MOC. 2. On the Management of Change (MOC) page, select one or more cases and click the ReAssign button. 3. On the Change Owner dialog box, select the new owner and click OK.

The Owner field of the selected case(s) in the MOC grid is now updated with the name of the new owner.

80 Using DOC4000

Closing Cases

Navigation: DOC4000 Dashboard > MOC Once a Management of Change (MOC) case workflow has transitioned to the end state, the case is considered "Completed". The case can then be Closed. Although closed cases cannot be updated, the data and history for the case can be viewed and summary information graphed.

To close a case: 1. On the DOC4000 Dashboard, click MOC. 2. On the Management of Change (MOC) page, click on a Case Identifier link to open the MOC Case viewer. 3. In the Transition Approvals area on the MOC Case viewer, click on the Close checkbox.

Note: If the workflow has been configured to require specific signatures for approval, these users must complete this step. 4. Click Save.

81 DOC4000 User Guide

Deleting Cases

Navigation: DOC4000 Dashboard > MOC Management of Change (MOC) cases can be deleted. The deleted cases remain in the database and are viewable when selecting the Include Deleted Cases checkbox option.

To delete a case: 1. On the DOC4000 Dashboard, click MOC. 2. On the Management of Change page, click on a Case Identifier link to open the MOC Case viewer for the case.

3. At the bottom of the MOC Case viewer, click the Delete button. 4. Click OK to confirm deletion.

82 Using DOC4000

Using Recon

Recon Overview

Navigation: DOC4000 Dashboard > Recon Recon provides a plant-wide solution for monitoring network and PC assets. It shows firmware revisions and references across the system, facilitating a common operating environment. Recon also provides system health reporting on both the network and PCs, and includes both reactive monitors, such as hard drive capacity, and proactive alerts about incompatible or missing firmware/software updates. Recon monitors asset health by:  Maintaining an accurate inventory  Managing proper firmware and software versions, patches, and upgrades  Ensuring compliance with common operating environments  Identifying configuration and architectural defects  Ensuring accurate change tracking  Safeguarding system security and data integrity  Accurately detecting and troubleshooting IT and automation problems  Ensuring successful recovery from data disasters Recon efficiently facilitates common operating environment compliance by reporting on:  All software installed on each PC  Hardware, firmware, and software revisions and serial numbers for computers and other network hardware  Individual change histories for PC software and configuration  Whether specific hardware subsystems, such as com ports and USB ports, are enabled or disabled in compliance with established common operating environment rules  Network utilization statistics

83 DOC4000 User Guide

Recon Information Viewing Recon

Navigation: DOC4000 Dashboard > Recon The Recon page displays Recon information organized in a variety of formats.

Note: See the Recon Configuration Overview topic for more information on configuring Recon.

Note: See the Administration Guide for more information on configuring Recon. Recon Tabs

Tab Description The Overview tab displays a list of computers with COE exceptions, a list of

Overview computers scanned, and a list of computers not scanned.

COEs The COEs tab displays a list of common operating environments (defined in the Admin Utility) and a list of computers to which the COE is assigned.

Computers The Computers tab displays a list of computers by domain, collection group, or computer name.

WMI Classes The WMI Classes tab displays a list of the selected WMI classes (as defined in the Admin Utility).

Report Views The Report Views tab displays a list of reports that are specific to Recon.

84 Using DOC4000

Overview Tab

The Recon Overview tab displays any computers with common operating environment exceptions, a list of all computers scanned, and a list of any computers not scanned. Click the name of a scanned computer to display its details.

85 DOC4000 User Guide

COEs Tab

The COEs tab displays a list of common operating environments defined in the Admin Utility and a list of computers to which the COEs are assigned. Click a COE Name/Computer to view its details

86 Using DOC4000

Computers Tab

The Computers tab displays a list of computers by domain, collection group, or computer name. Domain Collection Group Computer Name

87 DOC4000 User Guide

WMI Classes Tab

The WMI Classes tab displays a list of the selected WMI classes as defined in the Admin Utility. Click a class to view its details.

88 Using DOC4000

Report Views Tab

The Report Views tab displays reports for Recon that can be run by selecting the report and a computer group on which to report, selecting any other options, and clicking View Report. The report displays in the right pane. Available reports regarding the cyber assets that are monitored by the module per group include:  Security - This report shows disabled users, enabled USB ports, enabled COM ports, shared drives, and security services that are not running.  Software Inventory - This report shows the monitored machine’s Manufacturer, Model, CPU, and RAM.  Upgrade Planning - This report shows the OS, CPU, RAM, Hard Disk, and Software name and Version of the selected software.  Vendor Compliance - This report shows the software name, version, and a compliance pass column that designates whether the version installed matches selected version.

89 DOC4000 User Guide

Recon Viewers COE Results Viewer

The COE Results viewer displays data in the event that actual common operating environment values do not match expected values.

90 Using DOC4000

Integrity Viewer

The Integrity viewer displays data defects for an object.

91 DOC4000 User Guide

Modifications Viewer

DOC4000 tracks the changes to all objects and maintains an audit trail in its database. The Modifications viewer displays the audit trail of the changes to the objects.

92 Using DOC4000

Properties Viewer (Recon)

The Properties viewer displays property names and values for the selected object.

93 DOC4000 User Guide

WMI Class Viewer

The WMI Class viewer displays details for a WMI data object sorted by computer.

94 Using DOC4000

WMI Data Viewer

The WMI Data viewer displays details for a WMI data object.

95 DOC4000 User Guide

Viewing Notes

Notes Overview

Navigation: DOC4000 Dashboard > Notes The Notes page displays a list of notes for the selected asset or for all assets.

To view notes: 1. On the DOC4000 Dashboard, click the Notes button. 2. Select an asset or choose . A list of notes is displayed including the object name, creation date, title, owner, asset, and type. 3. Click on any object name to view details. 4. Click the Notes tab to view the notes for the object. (Note the number of notes for the object is displayed as part of the Notes tab title.) 5. Click a specific note's title to view its detail.

96 Using DOC4000

Appendix A - Asset Viewers

Asset Viewers Overview

Asset viewers are used to view the details of a specific asset. When an asset is selected from the Explore or Search pages, the properties of the asset are shown in one or more viewers (each represented by a separate tab) in the right frame of the window. Asset viewers are also available from various other areas in the application. Icons in the upper-right corner of the window allow you to open the viewer manager in a new window (to allow for additional screen area) and to copy the link for the selected asset and viewer to the clipboard (to paste in other applications).

DOC4000 Asset Viewers Viewer Description

Controller You can use the Controller viewer to display information concerning controller.

Display The Display viewer is used for viewing an image document.

Integrity The Integrity viewer allows you to view data defects for an object. Logic The Logic viewer allows you to view logic from logic tags, device control tags, and multifunction controller blocks. The MFC Logic viewer is similar to the Logic viewer.

Map The Map viewer generates a control map for the selected object (if applicable).

Modifications DOC4000 tracks the changes to all objects and maintains an audit trail in its database. The Modifications viewer displays the audit trail of the changes to the objects.

Notes You can use the Notes viewer to display additional information concerning an object within DOC4000.

Program The Program viewer is used to view any text file, such as a program source file.

Properties The Properties viewer allows you to view the properties of a selected object and displays data in vertical columns.

References You can use the References viewer to view references to a selected object from other objects. Referenced objects are displayed under the respective

97 DOC4000 User Guide

headings as hyperlinks.

Reserve You can use the Reserve viewer to reserve a single spare object within DOC4000. You can select the project for which this asset is being reserved on this viewer.

User-Defined The User-Defined viewer allows you to add unique custom properties and values for those properties to any object.

98 Using DOC4000

Alarms Viewer

You can use the Alarms viewer to display all alarms for a tag.

To open the viewer: 1. On the DOC4000 Dashboard, click the Explore button. 2. On the Explore page, click on a tag object on the Asset Explorer. 3. Click on the Alarms tab.

99 DOC4000 User Guide

CL File Viewer

You can use the CL File viewer to display information concerning CL programs.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on a CL program object on the Asset Explorer. 3. Click on the CL File tab.

100 Using DOC4000

Controller Viewer

You can use the Controller viewer to display information concerning controllers.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on a controller on the Asset Explorer. 3. Click on the Controller tab.

101 DOC4000 User Guide

Display Viewer

The Display viewer is used for viewing an image document. You can use this viewer to view picture files in .BMP, .GIF and .TIF format.

To open the viewer: 1. On the DOC4000 Dashboard, click the Explore button. 2. On the Explore page, click on an object. If the object contains a display as a property, a Display viewer will appear. 3. Click on the Display viewer. The corresponding image is displayed.

102 Using DOC4000

E-Mail Viewer

The E-Mail viewer displays the contents of imported emails.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on applicable object. 3. Click the E-Mail tab.

103 DOC4000 User Guide

File Compare Viewer

The File Compare viewer is used for viewing differences between two versions of an ASCII file.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on an object. If the object is an ascii file (e.g., EB, EL, CL, TXT, etc.) a File MOC viewer is available. 3. Click the File Compare tab to see a list of versions of the file that include differences (if applicable). 4. Select the checkboxes next to any two versions of the file to compare. 5. Click the Compare button in the upper-right corner. 6. The contents of the file are displayed with differences highlighted. Deleted lines are highlighted in blue, changed lines are highlighted in red, and inserted lines are highlighted in green.

104 Using DOC4000

Integrity Viewer

The Integrity viewer allows you to view data defects of the same type for an object.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on an object. 3. Click on the Integrity tab.

105 DOC4000 User Guide

Logic Viewer

The Logic viewer displays logic from logic tags, device control tags, and multifunction controller blocks. The MFC Logic viewer is similar to the Logic viewer.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on an object type that has a logic block. 3. Click on the Logic tab. 4. Click the Print icon to print the map to a Visio file.

106 Using DOC4000

Map Viewer

The Map viewer generates a control map document for the selected object (if applicable). To speed up the map generation and to avoid map timeout issues, the maximum number of objects in a control map is set at 100. When the maximum number is reached, previously expanded object(s) are collapsed so that others can be expanded. An indication of the number of objects is located below the list objects in the Map Navigator panel.

To view a control map: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on an object. 3. Select an entity type object. 4. Click on the Map tab to view the control map details. a. Expand and collapse buttons are available to view objects inside container objects and/or other objects connected to an object. In the event that more than 100 objects are expanded in a map, any remaining buttons will change to buttons. Additional objects (outside of container objects) cannot be expanded until some objects are collapsed

107 DOC4000 User Guide

b. The objects inside a container object are small and their labels may be illegible. To quickly identify an object when its label is illegible, a tool tip showing the object’s FriendlyFullName is displayed when the mouse is over the object. Double-click an object to view its details, and a full-sized object will pop up. Double-click the pop-up object again to close it. Note that all objects are printed at full size when they are included in reports, but long labels are truncated and end with an ellipsis. Tool tips are available to show the full information. 5. Use the Map Navigator to select other objects connected to the currently selected object and Map Tools to manipulate the view and generate a report. Map Tools Several map tools are available to manipulate the map view. Hovering your mouse over an icon displays a tool tip indicating the function performed by that icon. Click the corresponding icons to zoom in, zoom out, zoom in on a selected area, navigate to objects connected to the selected asset, and pan across the map view. Once the desired view is available, the layout can be saved and/or a report generated from the map view.

To manipulate the map view:

Click the corresponding icons to:

• Zoom In – Select this tool to zoom in for a specific area.

• Zoom Out – To view the entire document, select this tool.

• Zoom Area –Select this tool and then drag ther mouse pointer over the designated area to zoom in. Repeat to zoom in again.

• Select this tool to return the document to its normal size.

• Select this tool to fit the document into the visible area. Objects will resize as needed.

• Select this tool to find and center the target object in the viewer relative to viewer area and document size. • Property filter - Select a property from the list to filter the map to include only objects which have the same selected property and value equal to that of the target object. • Latest report - Select the hyperlink to open the report file. • If objects are outside of the viewable area, use one or more available arrows to pan the map viewer. Click the arrows or click the left mouse button inside the viewer and drag toward any direction.

 To save map layouts:

108 Using DOC4000

1. Click the icon to save the layout as it is currently displayed. 2. Click the Apply to all users option to save the layout for all users.

3. Click the icon to delete the saved layout.

4. After changing the layout, click the icon to redraw the map using the saved layout.

5. Click the icon to redraw the map using current the current settings.

To generate a report from the map layout:

Note: Visio must be available on the application server to generate reports from control maps and Visio Viewer is required to view control map reports from client machines. 1. Click the icon to generate the report. Note that objects are not automatically resized in the Visio reports and are printed at full size. 2. A Reports folder is automatically created where control map reports are stored (on the server in the same location as the application directory).

109 DOC4000 User Guide

Modifications Viewer

DOC4000 tracks the changes to all objects and maintains an audit trail in its database. The Modifications viewer displays the audit trail of the changes to the objects.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on an object. 3. Click on the Modifications tab.

110 Using DOC4000

Notes Viewer

You can use the Notes viewer to display additional information concerning an object in DOC4000.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on an object. 3. Click on the Notes tab.

111 DOC4000 User Guide

Program Viewer

The Program viewer is used to view any text file, such as a program source file.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on an object. 3. Click on the Program tab.

112 Using DOC4000

Properties Viewer

The Properties viewer allows you to view the properties of a selected object and displays data in vertical columns.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on an object. 3. Click on the Properties tab.

113 DOC4000 User Guide

References Viewer

You can use the References viewer to view references to a selected object from other objects. Referenced objects are displayed under the respective headings as hyperlinks.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on an object. 3. Click the References tab. By default, all references for the selected object are displayed. To filter the results, clear the Inputs, Outputs, or Attachment options. 4. Only references for the selected asset are displayed by default. To display references for other assets, select the Other assets option.

114 Using DOC4000

Reserve Viewer

You can use the Reserve viewer to reserve a single spare object in DOC4000. You can select the project for which this asset is being reserved on this viewer.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on an object. 3. Click on the Reserve button.

115 DOC4000 User Guide

User-Defined Viewer

The User-Defined viewer allows you to add unique custom properties and values for those properties to any object.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on an object. 3. Click on the User-Defined tab. 4. To add a property click Add and enter the Property Name and enter a value for the property. 5. Click Save Changes.

Note: System Administrators can add user-defined properties as common, meaning that the property applies to all objects of that type (per asset).

116 Using DOC4000

IP Addresses Viewer This IP Addresses viewer displays ping information for a given range of computers in a plant area.

117 DOC4000 User Guide

Appendix B - Asset Model Specific Viewers

DeltaV SFC Viewer (Delta V/Fox IA)

The SFC viewer allows you to view the steps and transitions from the DeltaV Control Modules or Fox IA DEP, EXC and IND blocks.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Asset Explorer page, click on an applicable object type. 3. Click on the SFC tab.

118 Using DOC4000

FoxIA Flowchart Viewer

The Flowchart viewer is a graphical presentation of sequence programs. Logic and statements are represented by shapes. The sequence in which the programs are run is indicated by connecting arrows.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Asset Explorer page, click on an applicable object type. 3. Click on the Flowchart tab.

119 DOC4000 User Guide

Logic Viewer (Fox IA)

The Fox IA Logic viewer graphically displays the logic from CALC blocks, CALCA blocks, Logic blocks, and Math blocks.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Asset Explorer page, click on an applicable object type. 3. Click on the Logic tab.

120 Using DOC4000

Properties Viewer (Fox IA)

The Fox IA Properties viewer allows you to see property values and descriptions for Fox IA blocks.

To open the viewer: 1. On the DOC4000 Dashboard, click the Explore button. 2. On the Asset Explorer page, click on an applicable object type. 3. Click on the Properties tab.

121 DOC4000 User Guide

SFC Viewer (Delta V/Fox IA)

The SFC viewer allows you to view the steps and transitions from the DeltaV Control Modules or Fox IA DEP, EXC and IND blocks.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Asset Explorer page, click on an applicable object type. 3. Click on the SFC tab.

122 Using DOC4000

TPS Logic Viewer

The Logic viewer displays logic from logic tags, device control tags, and multifunction controller blocks. The MFC Logic viewer is similar to the Logic viewer.

To open the viewer: 1. On the DOC4000 Dashboard, click on the Explore button. 2. On the Explore page, click on an object type that has a logic block. 3. Click on the Logic tab. 4. Click the Print icon to print the map to a Visio file.

123

Index

A acknowledging ...... 32 acknowledging ...... 24, 32 assigning ...... 34 changes ...... 24 resolving ...... 36 integrity issues ...... 32 suppressing ...... 35 adding modules ...... 11 Integrity viewer ...... 105 addresses ...... 117 IP 117 Alarms viewer ...... 99 L assigning integrity issues ...... 34 logging in ...... 8 assigning workflows to MOC cases ...... 76 logging out ...... 8 C Logic viewer ...... 106, 123 change tracking ...... 20 FoxIA ...... 120 changing passwords ...... 10 M checklists ...... 71 Management of Change ...... 71 CL File viewer ...... 100 assigning workflows ...... 76 closing MOC cases ...... 81 closing cases ...... 81 completing MOC case checklists ...... 78 completing checklists ...... 78 Controller viewer ...... 101 deleting cases ...... 82 creating ...... 54, 63 searching for cases ...... 72 projects ...... 54 starting cases ...... 76 reports ...... 63 updating cases ...... 78 D viewing summaries ...... 74 data ...... 20 managing spares ...... 53 acknowledging changes ...... 24 Map viewer ...... 107 changes ...... 20 MOC ...... 71 querying ...... 37 assigning workflows ...... 76 deleting ...... 52, 68, 82 closing cases ...... 81 MOC cases ...... 82 completing checklists ...... 78 queries ...... 52 deleting cases ...... 82 reports ...... 68 searching for cases ...... 72 Display viewer ...... 102 starting cases ...... 76 E updating cases ...... 78 editing modules ...... 11 viewing summaries ...... 74 E-mail viewer ...... 103 Modifications viewer...... 110 executing queries ...... 49 modifying ...... 51, 54, 67 exporting results of queries ...... 50 projects ...... 54 F queries ...... 51 File Compare viewer ...... 104 reports ...... 67 Flowchart viewer (FoxIA) ...... 119 modules ...... 11 H N home page ...... 11 notes ...... 96 I Notes viewer ...... 111 Integrity Dashboard ...... 9 O integrity issues ...... 30, 31 objects ...... 56, 58

125 DOC4000 User Guide

P reservations ...... 57 passwords ...... 10 reserving ...... 56 printing reports ...... 59 searching for ...... 55 Program viewer ...... 112 starting MOC cases ...... 76 projects ...... 54 suppressing integrity issues ...... 35 properties ...... 116 U Properties viewer ...... 113 updating MOC cases ...... 78 Properties viewer (FoxIA) ...... 121 user-defined notes ...... 96 Q user-defined properties ...... 116 queries ...... 37, 49, 50, 51, 52 User-Defined viewer ...... 116 deleting ...... 52 V executing ...... 49 viewers ...... 97, 117 exporting results ...... 50 Alarms ...... 99 modifying ...... 51 CL File ...... 100 R Controller ...... 101 References viewer ...... 114 Display ...... 102 releasing spare objects ...... 58 E-mail ...... 103 reports ...... 59, 63, 65, 67, 68 File Compare ...... 104 creating ...... 63 Flowchart (FoxIA) ...... 119 deleting ...... 68 Integrity ...... 105 modifying ...... 67 Logic ...... 106, 123 running ...... 65 Logic (FoxIA) ...... 120 reservations ...... 57 Map ...... 107 Reserve viewer ...... 115 Modifications ...... 110 reserving spare objects ...... 56 Notes ...... 111 resolving integrity issues ...... 36 Program ...... 112 running reports ...... 65 Properties ...... 113 S Properties (FoxIA) ...... 121 searching References ...... 114 for reservations ...... 57 Reserve ...... 115 for spares ...... 55 SFC (DeltaV) ...... 118, 122 searching for MOC cases ...... 72 SFC (FoxIA) ...... 118, 122 Searching the Database ...... 18 User-Defined ...... 116 SFC viewer (DeltaV) ...... 118, 122 viewing ...... 31, 74 SFC viewer (FoxIA) ...... 118, 122 integrity issues ...... 31 spares ...... 53, 54 summaries of MOC cases ...... 74 managing ...... 53 W projects ...... 54 workflows ...... 71 releasing ...... 58 working with integrity issues ...... 30

126