Industrial IT. 800xA - Asset Optimization System Version 4.1. Configuration

Transcription

1 Industrial IT 800xA - Asset Optimization System Version 4.1 Configuration

2

3 Industrial IT 800xA - Asset Optimization System Version 4.1 Configuration

4 NOTICE The information in this document is subject to change without notice and should not be construed as a commitment by ABB. ABB assumes no responsibility for any errors that may appear in this document. In no event shall ABB be liable for direct, indirect, special, incidental or consequential damages of any nature or kind arising from the use of this document, nor shall ABB be liable for incidental or consequential damages arising from use of any software or hardware described in this document. This document and parts thereof must not be reproduced or copied without written permission from ABB, and the contents thereof must not be imparted to a third party nor used for any unauthorized purpose. The software or hardware described in this document is furnished under a license and may be used, copied, or disclosed only in accordance with the terms of such license. This product meets the requirements specified in EMC Directive 89/336/EEC and in Low Voltage Directive 72/23/EEC. Copyright by ABB. All rights reserved. Release: May 2005 Document number: 3BUA000118R4101 TRADEMARKS All rights to trademarks reside with their respective owners.

5 TABLE OF CONTENTS About This Book General...19 Intended User...19 Documentation of Third Party Software...19 Use of Warning, Caution, Information, and Tip Icons...19 Document Conventions...20 Terminology...22 Related Documentation...29 Section 1 - Introduction Product Overview...31 Maintenance Workplace and Asset Structure...34 Asset Health Condition Reporting...35 Asset Viewer...36 Asset Reporter...38 Asset Monitoring...40 Basic Asset Monitors...42 IT Asset Monitors Generated by PC, Network and Software Monitoring...43 HART Asset Monitors...45 FOUNDATION Fieldbus Asset Monitors...45 PROFIBUS Asset Monitors...46 Seamless Interaction Between Process, Maintenance, and Calibration...46 Maximo Integration...47 Active Work Orders View...48 Work Order History View...50 Equipment Status View BUA000118R4101 5

6 Table of Contents Preventive Maintenance Schedule View Spare Parts/Availability of Spare Parts Views...52 Create Fault Report Form/Submit Fault Report Fault Report Viewer/Submit Fault Report...54 SAP/PM Integration Active Work Orders View...56 Work Order History View...58 Equipment Status View Preventive Maintenance Schedule View Create Fault Report Form/Submit Fault Report Fault Report Viewer/Submit Fault Report...60 DMS Calibration Integration DMS Division Aspect...63 DMS Aspect...64 DMS Asset Monitor Aspect...64 Calibration Event List Aspect...65 Parameter Mapping Aspect Asset Optimization Reporting...67 AO Asset Condition History Report AO Calibration Report...68 AO Running Time Report xA - Asset Optimization for Process Portal B...69 Process Portal B Provider Aspect...69 Process Portal B Connectivity Software Section 2 - System Setup Introduction Setting Up Aspect Defaults Asset Optimization Server Configuration...72 Loading Asset Monitor Configurations to an AO Server...75 Asset Monitor Startup Parameters Connecting to a Process Portal B Node...79 Maximo Server Connection Properties BUA000118R4101

7 Table of Contents SAP/PM Server Connection Properties...86 Mapping Between the 800xA System and the CMMS...89 Maximo Integration...89 SAP/PM Integration...90 Alarm Behavior Upon Fault Report Submittal...93 User Privileges...94 Maximo User Credentials...94 SAP User Credentials...96 Allowing 800xA System Users Access to DMS...97 Primary Structures...97 Managing Data Source Connections...99 Managing the Connection Between the 800xA System and the DMS System..102 Defining the AOWebServerNode Defining Alarm Behavior Section 3 - Configuration Introduction Asset Monitors Asset Monitor Configuration Asset Monitor Tab Conditions Tab Asset Parameters Tab Input Records Tab Output Records Tab Logic Tab Asset Monitor Bulk Data Manager Support Asset Monitor Tab Data Conditions Tab Data Asset Parameters Tab Data Input Records Tab Data Loading a Single Asset Monitor Asset Monitor Configuration Macros Asset Condition Reporting BUA000118R4101 7

8 Table of Contents Asset Reporter Asset Viewer Maximo Integration Mapping the 800xA System Object to the Maximo Equipment CMMS Views SAP/PM Integration Mapping the 800xA System Object to the SAP/PM Equipment CMMS Views DMS Calibration Integration Creating the DMS HART Device Object Structure Configuration Scenarios Configuration Scenario A - HART Device Integration System Extension Installed, Devices Connected via Hart Capable I/O Configuration Scenario B - HART Device Integration System Extension not Installed, Devices Connected via non-hart Capable I/O, or Conventional Devices Updating DMS System Objects with 800xA System Object Device Data Synchronizing 800xA System DMS Division with DMS System DMS Division 156 Notifying 800xA System Users that Calibration is Due Additional DMS Calibration Integration Configuration Considerations Authentication Authentication for the AO Server Authentication for the Asset Monitor Aspect Authentication for the DMS Division Alarm Grouping Asset Optimization Reporting Configuration AO Asset Condition History Report Parameters AO Calibration Report Parameters AO Running Time Report Parameters Exporting Reports Section 4 - Basic Asset Monitor Library Introduction BUA000118R4101

9 Table of Contents Bad Quality Check Bool Check Flow Delta Limit Check (High, HighLow, and Low) Running Time Check XY Profile Deviation Section 5 - PC, Network and Software Monitoring Setup Overview PC, Network and Software Monitoring Server Configuration IT OPC Server Network Object Editing the OPC Data Source Definition Asset Optimization Asset Monitoring Aspects Copying the AM Service Data Source Aspect IT General Setup Aspect Predefined IT Assets Assigning Predefined IT Assets Adding IT Devices to Existing IT Assets Activating Changes to IT Assets Creating IT Assets and IT Devices Section 6 - IT Asset and IT Device Library Overview IT Assets Asset Generic Computer Node Light Asset - Light Generic Computer Node Computer Assets Process Status and Alarm List Light Generic Computer Process Assets Alarm List Computer Assets Asset - Batch Client Light Asset - Batch Client Asset - Batch Primary Server with Client Light Asset - Batch Primary Server with Client BUA000118R4101 9

10 Table of Contents Asset - Batch Secondary Server with Client Light Asset - Batch Secondary Server with Client Asset - Inform IT Calculations Light Asset - Inform IT Calculations Asset - Inform IT Complete Light Asset - Inform IT Complete Asset - Inform IT Display Light Asset - Inform IT Display Asset - Inform IT History Light Asset - Inform IT History Asset - Inform IT ODA Light Asset - Inform IT ODA Asset - Inform IT Scheduler Light Asset - Inform IT Scheduler Asset - Inform IT SoftPoint Server Light Asset - Inform IT SoftPoint Server Asset - 800xA AS Light Asset - 800xA AS Asset - 800xA Client Light Asset - 800xA Client Asset - 800xA Combined AS-CS Light Asset - 800xA Combined AS-CS Asset - 800xA CS Light Asset - 800xA CS Asset - PPB Client Light Asset - PPB Client Asset - PPB Config Server Light Asset - PPB Config Server Asset - PPB Harmony RTDS with Client Light Asset - PPB Harmony RTDS with Client Asset - PPB Historian Light Asset - PPB Historian BUA000118R4101

11 Table of Contents Asset - PPB Melody RTDS with Client Light Asset - PPB Melody RTDS with Client Asset - PPB OPC RTDS with Client Light Asset - PPB OPC RTDS with Client Inform IT Performance Assets Asset - hsmsgserver Messages In per Minute Asset - hsmsgserver Messages in Queue Asset - hsmsgserver Messages Out per Minute Asset - PDL Messages In per Minute Asset - PDL Messages in Queue Asset - PDL Messages Out per Minute Asset - Disk Free Asset - Failures Asset - Storages Asset - DA Collection Asset - HDA Collection Asset - Generic Network Interface Asset - Generic Printer Network Monitoring Asset - Network Utilization Asset - Node to Node Utilization Asset - Single Node Utilization Asset - Cisco 12-Port Switch Light Asset - Cisco 12-Port Switch Asset - Cisco 24-Port Switch Light Asset - Cisco 24-Port Switch Asset - Cisco 48-Port Switch Light Asset - Cisco 48-Port Switch Asset - Hirschmann Mach 3000 Switch Light Asset - Hirschmann Mach 3000 Switch Asset - Hirschmann RS2 Switch Light Asset - Hirschmann RS2 Switch BUA000118R

12 Table of Contents IT Device Library Alarm Device - Generic Interface Alarm Status Device - Generic Interface Alert Status Device - Generic Interface Status Alarm Device - Network Utilization Alarm Status Device - Network Utilization Alert Status Device - Network Utilization (Bytes per s) Status Status Device - Network Utilization (Percent) Status Alarm Device - Node to Node Utilization Alarm Status Device - Node to Node Utilization Alert Status Device - Node To Node Utilization (Bytes per s) Status Status Device - Node To Node Utilization (Percent) Status Alarm Device - Node Utilization Alarm Status Device - Node Utilization Alert Status Device - Node Utilization (Bytes per s) Status Status Device - Node Utilization (Percent) Status Alarm Device - Performance Counter Alarm (Alarm) Status Device - Performance Counter Alert (Performance Alert) Alarm Device - Performance Counter Alarm (Reversed) (Reversed Alarm) Status Device - Performance Counter (Reversed) Alert (Reversed Performance Alert) 321 Status Device - Performance Counter Status (Value) Alarm Device - Computer CPU Alarm Status Device - Computer CPU Alert Status Device - Computer CPU Status Light Alarm Device - Light Computer CPU Alarm Light Status Device - Light Computer CPU Alert Alarm Device - Computer General Alarm (Auto) Light Alarm Device - Light Computer General Alarm (Auto) Light Status Device - Light Computer General Alert Alarm Device - Computer General Alarm Status Device - Computer General Alert BUA000118R4101

13 Table of Contents Status Device - Computer General Status Alarm Device - Computer Process Alarm Status Device - Computer Process Alert Status Device - Computer Process Status Light Status Device - Light Computer Process Alert Light Status Device - Light Computer Process Status Alarm Device - Computer Process Alarm (Compact) Light Alarm Device - Light Computer Process Alarm (Compact) Alarm Device - Computer Process Alarm (Auto) Alarm Device - Computer Process Alarm (Min) Alarm Device - Disk Drive Alarm Status Device - Disk Drive Alert Status Device - Disk Drive Status Alarm Device - Disk Volume Alarm Status Device - Disk Volume Alert Status Device - Disk Volume Status Light Alarm Device - Light Disk Volume Alarm Light Status Device - Light Disk Volume Alert Alarm Device - Printer Alarm Status Device - Printer Alert Status Device - Printer Status Alarm Device - Cisco 12-Port Switch Alarm Status Device - Cisco 12-Port Switch Alert Status Device - Cisco 12-Port Switch Status Light Alarm Device - Light Cisco 12-Port Switch Alarm Light Status Device - Light Cisco 12-Port Switch Alert Alarm Device - Cisco 24-Port Switch Alarm Status Device - Cisco 24-Port Switch Alert Status Device - Cisco 24-Port Switch Status Light Alarm Device - Light Cisco 24-Port Switch Alarm Light Status Device - Light Cisco 24-Port Switch Alert Alarm Device - Cisco 48-Port Switch Alarm BUA000118R

14 Table of Contents Status Device - Cisco 48-Port Switch Alert Status Device - Cisco 48-Port Switch Status Light Alarm Device - Light Cisco 48-Port Switch Alarm Light Status Device - Light Cisco 48-Port Switch Alert Alarm Device - Hirschmann 8-Port Alarm Status Device - Hirschmann 8-Port Alert Status Device - Hirschmann 8-Port Status Light Alarm Device - Light Hirschmann 8-Port Alarm Light Status Device - Light Hirschmann 8-Port Alert Alarm Device - Hirschmann n-port Alarm Light Alarm Device - Light Hirschmann n-port Alarm Alarm Device - Hirschmann Power Supply Alarm Status Device - Hirschmann Power Supply Alert Status Device - Hirschmann Power Supply Status Light Alarm Device - Light Hirschmann Power Supply Alarm Light Status Device - Light Hirschmann Power Supply Alert Status Device - Hirschmann Mach 3000 Base Status Alarm Device - Hirschmann RS2 Alarm Status Device - Hirschmann RS2 Alert Status Device - Hirschmann RS2 Status Light Alarm Device - Light Hirschmann RS2 Alarm Light Status Device - Light Hirschmann RS2 Alert Section 7 - Network and Device Scanning Tool Introduction Using the Network and Device Scanning Tool File Menu Editing Project Properties Creating a New Project Opening an Existing Project Net Scan Window Edit IP Ranges Edit Community Names BUA000118R4101

15 Table of Contents Set Object ID (OID) Root Scan IP Address/Range SNMP Get Info SNMP Walk Check Loaded MIB Support Verify SMIR Support Hide/Remove Selected Hide/Remove Unreachable Show All Reset Tree Create Namespace View Menu Compilation Wizard Window MIB Process Menu Compile into SMIR Delete from SMIR List SMIR Section 8 - Creating Custom IT Devices and IT Assets Introduction Key Concepts Windows Management Instrumentation (WMI) Simple Network Management Protocol (SNMP) PC, Network and Software Monitoring Scripting PC, Network and Software Monitoring Assemblies Script and Assembly Load Hierarchy PC, Network and Software Monitoring OPC Item Syntax Creating IT Devices and IT Assets Creating a New IT Device Configuring an IT Device Configuration Aspect Tokens Items BUA000118R

16 Table of Contents Asset Optimization Settings Creating a New IT Asset Backing up and Restoring Custom IT Devices and IT Assets Assemblies, Scripts, and Resources MIB Files WMI Repository Appendix A - CMMS Definition Files Introduction Sample MxDef File Sample SAPDef File Appendix B - HART Generic Device Asset Monitor Introduction Software Requirements Control Network Environment HART Device Integration Package Setup Configuration Optional Configuration Conditions Assessed Appendix C - HART ABB 2600T-264 Asset Monitor Introduction HART ABB 2600T-264 Asset Monitor Setup Configuration Conditions Assessed Appendix D - HART ABB TB82PH-pH Asset Monitor Introduction HART ABB TB82PH-pH Asset Monitor Setup BUA000118R4101

17 Table of Contents Configuration Conditions Assessed Appendix E - FF Generic Device Asset Monitor Introduction Software Requirements Control Network Environment FF Device Integration Package Setup Configuration Conditions Assessed Appendix F - FF ABB 264-H1 Asset Monitor Introduction FF ABB 264-H1 Asset Monitor Setup Configuration Conditions Assessed Appendix G - FF ABB FV4000-FS4000-H1 Asset Monitor Introduction FF ABB FV4000-FS4000-H1 Asset Monitor Setup Configuration Conditions Assessed Appendix H - FF ABB FXE4000-H1 Asset Monitor Introduction FF ABB FXE4000-H1 Asset Monitor Setup Configuration Conditions Assessed Appendix I - FF ABB TB82PH-H1 Asset Monitor 3BUA000118R

18 Table of Contents Introduction FF ABB TB82PH-H1 Asset Monitor Setup Configuration Conditions Assessed Appendix J - FF ABB TF02-TF202-H1 Asset Monitor Introduction FF ABB TF02-TF202-H1 Asset Monitor Setup Configuration Conditions Assessed Appendix K - PROFIBUS Channel Asset Monitor Introduction Software Requirements Control Network Environment PROFIBUS Device Integration Package Setup Configuration Conditions Assessed INDEX 18 3BUA000118R4101

19 About This Book General This instruction describes setup and configuration activities for Asset Optimization Asset Monitoring, Maximo Integration, SAP/PM Integration, DMS Calibration Integration, and PC, Network and Software Monitoring (PNSM). This product functionality consists of system extensions to the Industrial IT 800xA System product. Intended User This instruction is intended for application engineers performing system setup and/or configuration. As a reader of this instruction you should have knowledge of configuration and engineering of process automation systems. It is recommended that application engineers participate in ABB training courses for the Industrial IT 800xA System. Documentation of Third Party Software This instruction documents third party software to the extent that it applies to Asset Optimization. Specific information relating to the installation, setup, configuration, and operation of third party software can be found in the manufacturer s documentation. Use of Warning, Caution, Information, and Tip Icons This publication includes Warning, Caution, and Information where appropriate to point out safety related or other important information. It also includes Tip to 3BUA000118R

20 Document Conventions About This Book point out useful hints to the reader. The corresponding symbols should be interpreted as follows: Electrical warning icon indicates the presence of a hazard which could result in electrical shock. Warning icon indicates the presence of a hazard which could result in personal injury. Caution icon indicates important information or warning related to the concept discussed in the text. It might indicate the presence of a hazard which could result in corruption of software or damage to equipment/property. Information icon alerts the reader to pertinent facts and conditions. Tip icon indicates advice on, for example, how to design your project or how to use a certain function Although Warning hazards are related to personal injury, and Caution hazards are associated with equipment or property damage, it should be understood that operation of damaged equipment could, under certain operational conditions, result in degraded process performance leading to personal injury or death. Therefore, comply fully with all Warning and Caution notices. Document Conventions The following conventions are used for the presentation of material: The words in names of screen elements (for example, the title in the title bar of a window, the label for a field of a dialog) are initially capitalized. Capital letters are used for the name of a keyboard key if it is labeled on the keyboard. For example, press the ENTER key. Lowercase letters are used for the name of a keyboard key that is not labeled on the keyboard. For example, the space bar, comma key, and so on. Press CTRL+C indicates that you must hold down the CTRL key while pressing the C key (to copy a selected object in this case). 20 3BUA000118R4101

21 About This Book Document Conventions Press ESC E C indicates that you press and release each key in sequence (to copy a selected object in this case). The names of push and toggle buttons are boldfaced. For example, click OK. The names of menus and menu items are boldfaced. For example, the File menu. The following convention is used for menu operations: MenuName > MenuItem > CascadedMenuItem. For example: select File > New > Type. The Start menu name always refers to the Start menu on the Windows Task Bar. System prompts/messages are shown in the Courier font, and user responses/input are in the boldfaced Courier font. For example, if you enter a value out of range, the following message is displayed: Entered value is not valid. The value must be 0 to 30. You may be told to enter the string TIC132 in a field. The string is shown as follows in the procedure: TIC132 Variables are shown using lowercase letters. sequence name 3BUA000118R

22 Terminology About This Book Terminology The following is a list of terms associated with Asset Optimization and Industrial IT that you should be familiar with. Table 1. Terminology ACD Alarm Term/Acronym Alarm acknowledgement AO AO Main Server AO Server AOWebServerNode Description Asset Condition Document. Contains all information necessary to describe an asset condition. Generated by the Asset Monitor. Abnormal state of a condition associated with an Aspect Object. For example, the object FC101 may have the following conditions associated with it: HighAlarm, HighHighAlarm, Normal, LowAlarm, and LowLowAlarm. An alarm is active as long as the abnormal state of the corresponding condition persists. An alarm is unacknowledged until a user acknowledges it. User action to confirm the recognition of an alarm. Acknowledgement changes the state of an alarm from unacknowledged to acknowledged. Asset Optimization. Refer to AOWebServerNode. A server that runs the AO Server services: AssetMonitoring Service, Asset Monitoring Engine, repository for Fault Reports document, and AO Internet Information Service webs. An AO Server designated to be the web server for AO Internet enabled views. This node is where the Maximo Connectivity software, if required, must be installed. One AO Server in the 800xA System must be designated to be the AOWebServerNode. This is referred to as the AO Main Server. 22 3BUA000118R4101

23 About This Book Terminology Table 1. Terminology (Continued) Term/Acronym Application Server Aspect Aspect category Aspect Object Aspect Server Aspect system Description Server that runs system applications, such as Batch Management, Asset Optimization, and Information Management. Can also run third party and user provided applications. Description of some properties of a real world entity. The properties described could be mechanical layout, how the object is controlled, a live video image, name of the object, etc. In Process Portal A, it is an aspect residing in an object. Some examples of aspects are circuit diagrams, process displays, and control logic. Specialization of an aspect type. For example, the Asset Monitors aspect type includes all of the Basic Asset Monitor aspect categories. Representations of real world entities that a user interacts with, such as valves, reactors, products, material, production orders, batches, customer accounts, etc. Different facets of these real world entities are modeled as aspects. An Aspect Object is not an object in a strict sense, e.g. like a COM object, but rather a container of references to implementations of its aspects. A server that runs the central functions of the Aspect Object architecture, such as Aspect Directory, Structure and Name Server, Cross Referencing, File Set Distribution, etc. Contains all Aspect Objects and their aspects. A software system, which implements one or several aspect types by providing one or several aspect system objects. 3BUA000118R

24 Terminology About This Book Table 1. Terminology (Continued) Asset Monitoring Engine Asset Monitoring Service Authentication Citrix Server COM Term/Acronym Connectivity Server Context menu DMS Action List Description Application responsible for retrieving data from, and interacting with, multiple data servers (real-time data servers, OLE for Process Control (OPC ) Servers, etc.). It analyzes the data and when necessary, issues an ACD and notifies the 800xA System of the detected condition. Responsible for publishing ACDs generated by the builtin AO Engine and any other engines (such as DMS) capable of generating Asset Condition Documents. The process by which the system validates the user's logon information. A user's name and password are compared against an authorized list. If the system detects a match, access is granted to the extent specified in the permissions list for that user. See Terminal Server for thin client access. Microsoft Component Object Model. A software architecture that allows applications to be built from binary software components. Provides access to controllers and other sources for real-time data, historical data, and alarm and event data. Runs services related to OPC-DA, OPC-AE, OPC-HDA, and SysMsg. Several Connectivity Servers may exist in a system, each serving one set of data sources, for example 800M/C Controllers. Appears when you right-click on an Aspect Object or an aspect. Lists aspect operations, actions, aspects, and global operations. List of Action Items; such as devices with assigned calibration procedures that need calibration. Action Lists provide a means of organizing Action Items in calibration routes/daily tasks. 24 3BUA000118R4101

25 About This Book Terminology Table 1. Terminology (Continued) Term/Acronym DMS Division DPC Engineering Workplace Event Fieldbus Fieldbus device Description Highest level entity that can be modeled. A DMS Division entity can be as small as a single device all they way up to an entire enterprise. Examples of Divisions are: Geographical Site Plant (Unit) Area System Documenting Process Calibrator. Portable intelligent field calibrator designed for in situ (field) calibration, reducing the time required to execute a calibration procedure. The MFT 4000 is such a device. Provides tools for system wide engineering. For example, for controller code and graphics building. A detectable occurrence, which is of significance to an Aspect Object. May or may not be associated with a condition. For example, the transitions into HighAlarm and Normal conditions are events, that are associated with conditions. However, operator actions, system configuration changes, and system errors are examples of events, that are not related to specific conditions. OPC Clients may subscribe to be notified of the occurrence of specified events. Used to interconnect field devices, such as I/O modules, smart sensors and actuators, variable speed drives, PLCs, or small single loop devices; and to connect these devices to the 800xA System. Device connected through an 800xA System supported fieldbus. Examples are remote I/O and smart sensors and actuators, but also controllers, robots, variable speed drives, etc., when these devices are connected through a supported fieldbus. 3BUA000118R

26 Terminology About This Book HSI Human System Interface. Maintenance Workplace Provides a user interface for maintenance personnel to support their daily workflow most efficiently. Meriam DMS MFT 4000 MIB MOF MSU Node Operator Workplace PC Term/Acronym Table 1. Terminology (Continued) Meriam Process Technologies Device Management System (DMS) database software. Provides calibration management through the companion MFT 4000 Series Calibrator/HART Communicator, and MFC 4100 HART Communicator. Multifunctional Modular Calibrator / HART Communicator (DPC). Management Information Base. A file or data store containing information about managed SNMP elements, such as hosts, routers, etc. Managed Object Format. Description Most severe unacknowledged condition. The most severe unacknowledged condition for the current object. Remains in Fault Report Viewer until acknowledged, dismissed, submitted with the Dismiss after successful submittal check box checked in the Submit Fault Report view, or superseded by a more severe unacknowledged condition. A computer communicating on a network e.g. the Internet, Plant, Control or I/O network. Each node typically has a unique node address with a format depending on the network it is connected to. Provides a user interface to the HSI for efficient control and supervision of processes. Personal Computer. Computer running the Windows operating system. 26 3BUA000118R4101

27 About This Book Terminology Permission Plant Explorer Workplace PPA Process Portal A. PPB Process Portal B. Primary Structures Process Portal Product suite Server Term/Acronym Single node engineering system Table 1. Terminology (Continued) Description A permission (or access mask) groups a set of operations that require the same authority. For each operation defined for an aspect, the aspect category specifies the permission needed to use that operation. Application that is used to create, delete, and organize objects and aspects within the 800xA System. The Plant Explorer Workplace organizes the objects in structures according to functionality, location, etc. Also used to browse and search the structures of the plant. Structures in which most operators and application engineers will perform most of their work. The Primary Structures include the Control, Functional, Location, Object Type, User, and Workplace Structures. Collection of software that forms the basis for Industrial IT, and provides the development and execution environment for 800xA System compliant products. Contains functionality for efficient control and supervision of an automated process. Key functions are presentation of graphics, process dialogs, and presentation of alarms and trends. Products with similar functionality are kept together in a suite. Suites names have a superscripted IT suffix. Examples: Optimize IT, Operate IT, Control IT, Produce IT, etc. A node that runs one or several Afw Services. Supports engineering of Process Portal A, Asset Optimization, Batch Management, Information Management and certain connectivities. 3BUA000118R

28 Terminology About This Book Table 1. Terminology (Continued) Single node system SNMP Structure System Term/Acronym System extension System product Terminal Server for thin client access Thin client Description Supports connectivity to AC800M and either PROFIBUS/HART or FOUNDATION Fieldbus devices. Simple Network Management Protocol. A network management standard that defines a strategy for managing TCP/IP and Internet Packet Exchange (IPX) networks. A hierarchical tree organization of Aspect Objects that describes the dependencies between the real objects. An Aspect Object can exist in multiple structures, for example both in a Functional Structure and in a Location Structure. Collects all data of an engineering project. Administrated by the Configuration Wizard. Consists of one or more applications that are bundled as an extension to one or several existing system products. A system extension can only be installed if (one of) the corresponding system products has been previously installed. Consists of applications bundled together with relevant parts of the 800xA System. Several system products can be installed on the same physical node. Enables remote access to 800xA System functions from one or more PC clients that do not have 800xA System software installed. Web browser connected to the Internet (or intranet). Does not require any ABB-related preloaded software. Supports ActiveX controls, but communicates with 800xA System only through Internet technologies. Internet Explorer is used as browser. 28 3BUA000118R4101

29 About This Book Related Documentation Table 1. Terminology (Continued) Term/Acronym View WMI Workplace Description Aspects can have several ways to be presented depending on the task performed, like viewing or configuration. Each presentation form is called a view. Windows Management Instrumentation. A scalable system management infrastructure that uses a single consistent, standards-based, extensible, object-oriented interface. WMI provides software developers with a standard way to interact with system management information. 1. User interactive functions that are combined for a particular use, e.g., Operator Workplace, Engineering Workplace, etc. 2. Node that runs one or several workplace applications. Related Documentation The following is a listing of documentation related to Asset Optimization and the Industrial IT 800xA System. This table is not meant to be all inclusive. Table 2. Related Documentation Category Title Description Installation Industrial IT, 800xA - System, Installation Industrial IT, 800xA - System, Post Installation Setup Industrial IT, 800xA - System, Upgrade and Installation 3BSE034678R4101 3BUA000156R4101 3BSE036342R4101 3BUA000118R

30 Related Documentation About This Book Table 2. Related Documentation (Continued) Category Title Description Software Other Industrial IT, 800xA - Asset Optimization, Operation Operate IT, Process Portal Version B2.0, 800xA - Asset Optimization for Process Portal B Industrial IT, 800xA - Information Management, Operation Industrial IT, 800xA - Asset Optimization, Release Notes 3BUA000150R4101 WBPEEUI220799A0 3BUF001094R4101 3BUA000119R BUA000118R4101

31 Section 1 Introduction Product Overview Industrial IT 800xA - Asset Optimization consists of system extensions to the 800xA System product. Asset Optimization functionality includes Asset Condition Reporting, Asset Monitoring, CMMS (Computerized Maintenance Management System) Integration, and Calibration Integration to the 800xA System. This optimizes the use of plant equipment and processes. When integrated with SMS and Messaging, Asset Optimization provides a method for sending messages based on alarm and event information to user devices such as mobile telephones, accounts, and pagers. When integrated with FOUNDATION Fieldbus, HART, or PROFIBUS Device Integration, Asset Optimization provides a method for detecting field device problems. The 800xA System supports two CMMS, Maximo and SAP/PM. The supported functionality varies between Maximo Integration and SAP/PM Integration. The 800xA System supports Calibration Integration for Meriam Process Technologies Device Management System (DMS) software. Asset Optimization brings maintenance management to the operator environment to provide a single window interface for all asset management related operations. This allows plant personnel to collect, compare, and monitor asset data to accurately assess equipment conditions in real time. For maintenance personnel, Asset Optimization provides a default Maintenance Workplace that supports daily maintenance activities in a most efficient way. The combination of innovative automation architecture plus advanced information technologies, including integrated fieldbus solutions, allows Asset Optimization to monitor and optimize all plant assets in real time. This includes field devices, control systems, and automation elements, as well as major assets such as heaters and generators. 3BUA000118R

32 Product Overview Section 1 Introduction This architecture provides the required infrastructure to monitor and record asset performance over the entire life span of the asset. Information subsequently can be used to set future performance and profitability goals and to assist managers in making these decisions. Asset Optimization significantly reduces costly production interruptions by enabling predictive maintenance. It records the maintenance history of an asset and identifies potential problems to help avert unscheduled shutdowns, maximize uptime, and operate closer to plant design limits. Plant managers have the opportunity to collect, compare, and monitor data on field devices and larger equipment to accurately assess equipment operating performance in real time. As a result, faltering performance can be uncovered before breakdowns occur, and maintenance can be scheduled accordingly. The Asset Optimization software provides for the following functionality: Maintenance Workplace and Asset Structure. Asset Health Condition Reporting. Asset Viewer. Asset Reporter. Asset Monitoring. Basic Asset Monitors. IT Asset Monitors Generated by PC, Network and Software Monitoring. HART Asset Monitors. FOUNDATION Fieldbus Asset Monitors. PROFIBUS Asset Monitors. DMS Asset Monitors. Seamless Interaction Between Process, Maintenance, and Calibration. Maximo Integration. SAP/PM Integration. DMS Calibration Integration. Asset Optimization Reporting. 800xA - Asset Optimization for Process Portal B. 32 3BUA000118R4101

33 Section 1 Introduction Product Overview Figure 1 shows the interaction between the various functional components of Asset Optimization. Figure 1. Asset Optimization Functionality 3BUA000118R

34 Maintenance Workplace and Asset Structure Section 1 Introduction Maintenance Workplace and Asset Structure Asset Optimization information can be accessed from any workplace in the 800xA System. The Maintenance Workplace is a default Workplace for Maintenance personnel. It is basically a Plant Explorer Workplace with an Alarm Band that shows Asset Monitoring Alarms for default Asset groups (Figure 2). Figure 2. Maintenance Workplace TC07772A The Asset Structure provides the possibility for maintenance personnel to group and arrange plant assets in the way it is needed for efficient daily work. Control topology constraints can be overcome and even devices with different fieldbus protocols can be grouped together if they require similar maintenance procedures. 34 3BUA000118R4101

35 Section 1 Introduction Asset Health Condition Reporting The Asset Structure comes by default with five major groups of Assets: Drives. Field Instruments. IT Assets. Motors. Process Equipment. Asset Health Condition Reporting The Asset Health Condition Reporting system provides the infrastructure that reports asset status/condition information to notify operators and maintenance personnel when an abnormal condition calls for a maintenance action. Asset Optimization provides Asset Condition Reporting via the Asset Viewer and Asset Reporter. The Asset Tree, visible in the Asset Viewer, shows the status of associated plant objects (assets) based on Plant Explorer hierarchies. Assets can be control system hardware components, control system networks, control system devices, fieldbus networks, fieldbus components, machines, pumps, motors, process equipment (boiler, reactor), etc. Condition Monitoring systems can report accessed asset conditions into the Asset Health Condition Reporting infrastructure, Asset Viewer and Asset Reporter. Condition Monitoring systems include Asset Monitoring and DMS Calibration Integration. 3BUA000118R

36 Asset Viewer Section 1 Introduction Asset Viewer The Asset Viewer (Figure 3), when added to an object, allows the Asset Tree to be displayed. Asset Tree indicators propagate the most severe condition up the Asset Tree. Asset Tree indicators distinguish the level of severity using OPC-DA and Asset Monitor severity range (1 to 1,000). Each Asset Tree indicator represents composite severity of an object and all children beneath the object for the current structure. TC04692D Figure 3. Asset Viewer Table 3 shows and describes the Asset Tree severity indicator icons. Table 3. Asset Tree Severity Indicator Icons Icon Description No Asset Reporter or Asset Monitor associated with the asset, or Asset Monitor is disabled or has never been downloaded. Normal subcondition. 36 3BUA000118R4101

37 Section 1 Introduction Asset Viewer Table 3. Asset Tree Severity Indicator Icons (Continued) Icon Description Non-normal subcondition with severity between 0 and 250. Non-normal subcondition with severity between 251 and 500. Non-normal subcondition with severity between 501 and 750. Non-normal subcondition with severity between 751 and 1,000. In addition to displaying composite severity for each asset, the Asset Tree displays, and propagates up the tree, the quality of the condition (or the Asset Monitor itself, i.e. bad configuration), as well as Fault Report availability. Fault Report availability is indicated by bold text (fault reporting requires Maximo Integration functionality). Right-clicking on the item of interest produces a context menu such as the one shown in Figure 3. Context menus permit Fault Report submission directly from within the Asset Viewer. Table 4 shows and describes the quality indicator overlay icons that appear over the Asset Tree severity indicator icons to represent quality. Table 4. Quality Indicator Overlay Icons Icon None Description Good quality. Uncertain quality. Bad quality. The Asset Viewer is accessible within the Plant Explorer Workplace and the Operator Workplace on the AO Main Server node and 800xA System Client nodes. It is also accessible as a web-enabled view on non-800xa systems. When the Asset 3BUA000118R

38 Asset Reporter Section 1 Introduction Viewer is active in the 800xA System Client nodes, the status of the assets in the view update automatically when values change. The status of the assets in the view update automatically when values change. Web-enabled views require a manual refresh to update the view. The Asset Tree and the Fault Reports are updated with a certain delay based on the size of the queue in the AssetMonitoring Service. This can be accessed by viewing the Service Queue Stats: row under the Runtime Statistics tab in the AO Server aspect. A queue of 1000 ACDs translates into a delay of approximately 15 minutes from the time the ACD has been exposed in the 800xA System as an Alarm/OPC Property. Asset Reporter The Asset Reporter is a detailed view of all asset monitor conditions for an asset. It displays the severity indicator for an object itself. It displays information available to it from all Asset Monitors and their corresponding current subconditions. For each condition, the Asset Reporter will provide information about current subconditions, severity, Asset Monitor status, Fault Report availability, and Work Order availability. 38 3BUA000118R4101

39 Section 1 Introduction Asset Reporter Right-clicking on the item of interest produces a context menu such as the one shown in Figure 4. Figure 4. Asset Reporter TC04725D Table 5 lists the color scheme that appears in the Severity column of the Asset Reporter and how the colors relate to the subcondition severity levels. Gray Table 5. Asset Reporter Color Scheme Color Subcondition Severity Level Normal White 1 to 250 Blue 251 to 500 Yellow 501 to 750 Red 751 to 1,000 3BUA000118R

40 Asset Monitoring Section 1 Introduction Asset Monitoring The Asset Reporter must be added to each object for which it is desired to propagate up the Asset Tree in the Asset Viewer. Asset Reporters that are on objects with no Asset Monitor display an empty table. These are usually placeholders for propagation up the Asset Tree in the Asset Viewer. The Asset Reporter is accessible within the Plant Explorer Workplace, Operator Workplace, and Maintenance Workplace on the 800xA System nodes. It is also accessible as a web-enabled view on non-800xa systems. When the Asset Reporter is active in the 800xA System clients, the status of the assets in the view update automatically when values change. Web-enabled views require a manual refresh to update the view. An Asset Monitor is an application responsible for retrieving data from, and interacting with, multiple data servers (real-time data servers, OPC-DA servers, etc.). It analyzes the data and when necessary, issues an Asset Condition Document (ACD) and notifies the 800xA System of the detected condition. An ACD contains all information necessary to describe an asset condition, such as: Subcondition, Possible Cause, and Suggested Action. Asset Monitor generated ACDs are presented by the Fault Report Submitter to optionally generate a work order for maintenance purposes. Asset Monitors can detect problems that may not affect the process variables, but do affect the maintenance status of an asset or process. They support the diagnosis of problems to identify and locate the problem source and to offer correction possibilities. Asset Monitors can exist in any part of the plant hierarchy, such as the device, loop, equipment, area, process, plant, or enterprise. They can be written for higher level assets (parents) that are themselves composed of many subassets (children). Asset Monitors need not be associated with a single physical asset. They can acquire data from many sources to implement predictive maintenance functions. Therefore, Asset Monitors may require access to multiple data sources in the system. Asset Monitoring includes an Asset Optimization and AO Server object. The Asset Optimization object appears in the Control Structure and consists of AO Server child objects, an Asset Optimization Configuration Properties aspect, an Asset 40 3BUA000118R4101

41 Section 1 Introduction Asset Monitoring Optimization Event Log aspect, and AO Engine Asset Monitor Data Source definition aspects. The AO Server object consists of an Asset Optimization Server aspect, an AM Service Data Source Definition aspect, and AM Engine Properties. The AO Server object represents a node in the system that has been designated to run one Asset Monitoring Service and one AO Engine. The Asset Monitoring Service is responsible for publishing Asset Condition Documents generated by the built-in AO Engine and any other engines (such as DMS) capable of generating Asset Condition Documents. The AO Engine provides the execution environment for the Asset Monitor logic. The Asset Optimization Configuration Properties aspect defines the AoWebServerNode node name. The Asset Optimization Event Log is useful for troubleshooting as it logs the activities from the AssetMonitoring Services and the AO Engines. A preconfigured AO Engine Asset Monitor Data Source definition aspect, Afw OPC-DA Asset Monitor Data Source, points to the 800xA System OPC Server. The Afw OPC-DA Asset Monitor Data Source provides access to the configured data server by identifying the data server type and its connection parameters. The defined data server is used by Asset Monitors to access the OPC item values that are needed to assess the current asset conditions. The AO Engine uses the parameters defined in the Asset Monitor Data Source aspect to connect to the specified OPC servers. The Asset Optimization Server aspect is the main interface entry point for the following functions: Enable/disable the related Asset Monitoring service provider. Load the asset monitors configured to the AO Engine and/or any engines that use this Asset Monitoring service. Manage the configuration of Asset Monitor aspects. Display runtime status and statistics for the Asset Monitoring service and AO Engine. The AM Service Data Source Definition aspect provides the link between the Asset Monitor Properties control connection and the related Asset Monitoring service group. 3BUA000118R

42 Basic Asset Monitors Section 1 Introduction Basic Asset Monitors Asset Monitoring consists of the following: Basic Asset Monitors. Requires licensing for Asset Optimization Asset Monitoring functionality. IT Asset Monitors Generated by PC, Network and Software Monitoring. Requires licensing for Asset Optimization Asset Monitoring and PC, Network and Software Monitoring. The PC, Network and Software Monitoring software can independently monitor the status of Information Technology (IT) Assets. By default, IT Asset status is viewable via the 800xA System Status Viewer, or through the standard faceplates provided with each of the predefined IT Assets. When used in conjunction with Asset Optimization Asset Monitoring, alarms can be generated based on error conditions, and IT Asset status is viewable via the Asset Viewer and Asset Reporter. HART Asset Monitors. Requires licensing for Asset Optimization Asset Monitoring and HART Device Integration system functionality. FOUNDATION Fieldbus Asset Monitors. Requires licensing for Asset Optimization Asset Monitoring and FOUNDATION Fieldbus Device Integration system functionality. PROFIBUS Asset Monitors. Requires licensing for Asset Optimization Asset Monitoring and PROFIBUS Device Integration system functionality. DMS Asset Monitors: Requires licensing for Asset Optimization DMS Calibration Integration only. No license for Asset Optimization Asset Monitoring is required. Refer to DMS Calibration Integration on page 62. Asset Optimization Asset Monitoring provides the following Basic Asset Monitors: Bad Quality Check. Reports the quality status (good, bad, uncertain) represented by the value of the monitored Input Record. Bool Check. Monitors a signal with two states: normal and alarm. Notifies if the signal is in alarm state. Flow Delta. Monitors the difference between two numeric values (e.g. steam flow and feedwater flow) and notifies if the difference exceeds a configured percentage of the first value. 42 3BUA000118R4101

43 Section 1 Introduction IT Asset Monitors Generated by PC, Network and Software Monitoring High Limit Check. Monitors a process value and notifies if it exceeds configured limit values that include the high limit value and the high limit value plus a negative offset value. HighLow Limit Check. Monitors a process value and notifies if it exceeds configured limit values that include the high limit value, the high limit value plus a negative offset value, the low limit value, and the low limit value plus a positive offset value. Low Limit Check. Monitors a process value and notifies if it exceeds configured limit values that include the low limit value and the low limit value plus a positive offset value. Running Time Check. Monitors the accumulated runtime hours of a device and notifies, for preventive maintenance, that the runtime has accumulated up to a configured limit. XY Profile Deviation. Compares a two-dimensional value against a baseline function and notifies if the deviation from the baseline is less than or greater than the configured limit. IT Asset Monitors Generated by PC, Network and Software Monitoring The PC, Network and Software Monitoring (PNSM) software can independently monitor the status of Information Technology (IT) Assets. By default, IT Asset status is viewable via the 800xA System Status Viewer, or through the standard faceplates provided with each of the predefined IT Assets. When used in conjunction with Asset Optimization Asset Monitoring, alarms can be generated based on error conditions, and IT Asset status is viewable via the Asset Viewer and Asset Reporter. Standard PCs and networking equipment are used extensively in automation systems. Correct behavior of these parts of the system has a significant impact on the performance and reliability of the automation system as a whole. Watching for indications of impending problems, via continuous monitoring of the equipment, makes it possible to be proactive and ensure optimum system availability. The PC, Network and Software Monitoring package provides a set of predefined IT Assets that represent common devices and system processes within the 800xA System (for example printers, computers, switches, and software programs). These IT Assets provide data from the simple (printer out of paper), to the sophisticated (detection of a slow memory leak in a computer). When problems are detected (or 3BUA000118R

44 IT Asset Monitors Generated by PC, Network and Software Monitoring Section 1 Introduction anticipated), the software can automatically generate alarms, informing the user of the problem. The PC, Network and Software Monitoring package also provides two tools that are installed as part of the base package or can be loaded independently, as determined by the network and configuration designs. The Network and Device Scanning Tool lets a user retrieve and interpret information from SNMP enabled devices. This information is then used to determine what is of importance in the operation of the device, and whether the data is readable by WMI for use in PNSM Assets. The Network Monitoring Tool allows users to monitor traffic on a network segment, for a given node or traffic between nodes. The predefined IT Assets monitor the items listed in Table 6: Table 6. Predefined IT Asset Functionality Type Networked assets Computer assets Software assets Monitored Generic Network Interface Hirschmann Switch Cisco Switch Generic Printer Network Monitor 800xA nodes PPB nodes Batch nodes Inform IT nodes Generic computer Inform IT performance Generic computer processes The software package also provides faceplates for all Assets, showing overall status and key indicators (refer to Industrial IT, 800xA - Asset Optimization, Operation). 44 3BUA000118R4101

45 Section 1 Introduction HART Asset Monitors HART Asset Monitors Creation of customized assets is supported allowing users to create IT Asset and IT Device configurations that are tailored to their unique devices or components. Asset Optimization Asset Monitoring with HART Device Integration system functionality provides two types of HART Device Asset Monitors: HART Generic Device Asset Monitor: Reads, via OPC-DA, HART_RESPONSE_BYTE1 to assess the following conditions: Device malfunction. Configuration changed. Cold start. More status available. Analog output current fixed. Analog Output Saturated. Nonprimary Variable Out of Limits. Primary Variable Out of Limits. HART Device Specific Asset Monitors: Extend the functionality of the HART Generic Device Asset Monitor by assessing device specific conditions. Refer to the HART Device Library documentation for details. FOUNDATION Fieldbus Asset Monitors Asset Optimization Asset Monitoring with FOUNDATION Fieldbus Device Integration system functionality provides two types of FOUNDATION Fieldbus Device Asset Monitors: FF Generic Device Asset Monitor: Reads, via OPC-DA: Resource Block: MODE_BLK.Actual and BLOCK_ERR. Transducer Blocks: BLOCK_ERR. to assess the following conditions: Device out of service or initializing. Blocks out of service or powering up. Input or output failure. Block configuration error or link configuration error. 3BUA000118R

46 PROFIBUS Asset Monitors Section 1 Introduction Data or memory error. Device requires maintenance. Fault state set. Readback check failed. Unspecified error. FF Device Specific Asset Monitors: Extend the functionality of the FF Generic Device Asset Monitor by assessing device specific conditions. Refer to the FF Device Library documentation for details. PROFIBUS Asset Monitors Asset Optimization Asset Monitoring with PROFIBUS Device Integration system functionality provides two types of PROFIBUS Device Asset Monitors: PROFIBUS PA Channel Asset Monitor: Reads, via OPC-DA: PROFIBUS_StatusByte1. to assess the following conditions: Signal quality. Block alarm. Limit. Basic PROFIBUS PA Device Asset Monitor: Extends the functionality of PROFIBUS Asset Monitoring by accessing device specific conditions. Refer to the PROFIBUS Device Library documentation for details. Seamless Interaction Between Process, Maintenance, and Calibration Asset Optimization uses CMMS Integration and DMS Calibration Integration to make information within the CMMS system and Meriam Process Technologies Device Management System (DMS) database software transparently accessible to users in the process control, maintenance, and calibration management system environments. CMMS Integration establishes the link that removes the barrier to information exchange between the CMMS and the process control system environments. One of the issues that traditionally inhibits free interchange between these functional areas 46 3BUA000118R4101

47 Section 1 Introduction Maximo Integration is their different naming conventions: an asset often has one name in the operations environment and another in the maintenance environment. This is because these systems have vastly different focuses, purposes, and needs that their naming conventions must satisfy. CMMS Integration removes these barriers by pointing to the right context, regardless of the naming convention. CMMS Integration brings maintenance management to the operator environment to give a single window interface for multiple systems. Context menus on process graphics, the Alarm and Event List, etc. provide access to several views and actions for the specific CMMS item. This allows plant personnel to collect, compare, and monitor field device data to accurately assess equipment conditions in real time. The 800xA System supports two CMMS: Maximo Integration on page 47. SAP/PM Integration on page 56. The supported functionality varies between Maximo Integration and SAP/PM Integration. Maximo Integration Maximo Integration includes a Maximo Equipment ID aspect, a Maximo Credentials aspect, and CMMS Views aspects. The Fault Report Submitter aspect, which is part of the Asset Optimization Server system extension, makes it possible to submit Fault Reports to the Maximo and DMS systems. The Maximo Equipment ID provides information for mapping the 800xA System object to the Maximo equipment in the CMMS database for a particular Maximo Server. Multiple Maximo Equipment IDs can be associated with the same asset, thus providing the ability to map to more than one piece of equipment defined in Maximo. Maximo Credentials contains the Maximo user credentials used to access the Maximo Server by the specific 800xA user. The CMMS Views consist of the following: Active Work Orders View. Work Order History View. Equipment Status View. Preventive Maintenance Schedule View. Spare Parts/Availability of Spare Parts Views. 3BUA000118R

48 Maximo Integration Section 1 Introduction Maximo Portal Views. For every entry in the CMMS view, it is possible to navigate to related Maximo portal view. The Maximo portal view is a web view that allows direct interaction with the Maximo data if the user has appropriate rights. Change to the data is possible. The Fault Report Submitter consists of the following: Create Fault Report Form/Submit Fault Report. Fault Report Viewer/Submit Fault Report. The CMMS views shown here consist of 800xA System views and Maximo portal views. The supporting text indicates which type of view is being shown. The Maximo portal views consist of views from Maximo and Maximo 5.1 to show the compatibility of Maximo Integration with several Maximo versions. When different, the figure caption indicates which version of Maximo generated the view. Active Work Orders View The Active Work Orders view lists all active Work Orders in the CMMS for a particular asset or group of assets. Figure 5 shows the 800xA System Active Work Orders view. Clicking a column header sorts the list with respect to that header topic. Figure xA System Active Work Orders View (Maximo Integration) TC04852B 48 3BUA000118R4101

49 Section 1 Introduction Maximo Integration The Work Order column contains links to the CMMS. Clicking on a link opens a portal that contains a CMMS view of the selected Work Order (Figure 6). Figure 6. Maximo 5.1 Active Work Order Portal TC04853C 3BUA000118R

50 Maximo Integration Section 1 Introduction Work Order History View The Work Order History view lists the history of all Work Orders in the CMMS for a particular asset or group of assets. Figure 7 shows the 800xA System Work Order History view. Clicking a column header sorts the list with respect to that header topic. Figure xA System Work Order History View (Maximo Integration) TC04858B The Work Order column contains links to the CMMS. Clicking on a link opens a portal that contains a CMMS view of the selected Work Order (Figure 8). TC04859A Figure 8. Maximo Work Order History Portal 50 3BUA000118R4101

51 Section 1 Introduction Maximo Integration Equipment Status View The Equipment Status view allows viewing of data returned from a status assessment of an asset or group of assets. Figure 9 shows the 800xA System Equipment Status view. Clicking a column header sorts the list with respect to that header topic. Figure xA System Equipment Status View (Maximo Integration) TC04854B Preventive Maintenance Schedule View The Preventive Maintenance Schedule view lists the preventive maintenance schedule for an asset or group of assets. Figure 10 shows the 800xA System Preventive Maintenance Schedule view. Clicking a column header sorts the list with respect to that header topic. TC04855B Figure xA System Preventive Maintenance Schedule View (Maximo Integration) 3BUA000118R

52 Maximo Integration Section 1 Introduction Spare Parts/Availability of Spare Parts Views The Spare Parts view lists spare parts in the CMMS for a particular asset or group of assets. Figure 11 shows the 800xA System Spare Parts view. Clicking a column header sorts the list with respect to that header topic. The Item Number column contains links to the Availability of Spare Parts view that shows the location, quantity available, measurement unit, and cost of the selected spare part. Clicking on a link produces an Availability of Spare Parts view such as the one shown in Figure 12. Clicking a column header sorts the list with respect to that header topic. Figure xA System Spare Parts View (Maximo Integration) TC04856B TC04857B Figure xA System Availability of Spare Parts View (Maximo Integration) 52 3BUA000118R4101

53 Section 1 Introduction Maximo Integration Create Fault Report Form/Submit Fault Report These functions are made possible by the Fault Report Submitter. The Create Fault Report Form makes it possible to create a new Fault Report for the selected asset without an Asset Condition Document (ACD) being generated by an Asset Monitor. After filling in the fields with the appropriate information and clicking Submit Fault Report, the Submit Status: field indicates whether or not submission of the Fault Report succeeds. If it is unsuccessful, an error message will appear in the Submit Status: field. Upon successful submission, a Work Order is created in the CMMS. There are three different Create Fault Report Forms: one for submission to the Maximo system only, one for submission to the DMS system only, and one for submission to both systems. The form that comes up depends on the configuration of your system. The example in Figure 13 shows the Create Fault Report Form for submission to both systems. TC05365A Figure 13. Create Fault Report Form (for Submission to Maximo and DMS Systems) 3BUA000118R

54 Maximo Integration Section 1 Introduction Fault Report Viewer/Submit Fault Report These functions are made possible by the Fault Report Submitter. When an Asset Monitor generates an ACD, a Fault Report is created automatically. The Fault Report Viewer (Figure 14) makes it possible to see all Fault Reports for a selected object. Figure 14. Fault Report Viewer TC05000C The FR State column shows the status of Fault Reports at any instance in time. Since Asset Monitors can report on multiple conditions for each asset, the FR State column can either be the current conditions of the asset, or the Most Severe Unacknowledged (MSU) conditions of the asset. If a condition of lesser severity than the current condition is received, the new condition replaces the current condition which becomes the MSU. If a condition of greater severity than the current condition is received, the new condition replaces the current condition and the MSU is automatically dismissed. If there is no current condition Fault Report, the asset is normal or has bad (or uncertain) quality. The Dismiss after successful submittal check box in the Submit Fault Report view is a configurable option. If it is unchecked, the Fault Report is retained with a Fault Report status of submitted. It can be dismissed later or automatically replaced with subsequent Fault Reports. 54 3BUA000118R4101

55 Section 1 Introduction Maximo Integration Right-clicking anywhere in a Fault Report row produces a context menu with the option to dismiss the Fault Report or submit it. Selecting Dismiss deletes the selected Fault Report from the Asset Optimization system. It also acknowledges the alarm in the Alarm and Event List. This function will not acknowledge alarms in Process Portal B (refer to 800xA - Asset Optimization for Process Portal B on page 69). Selecting Submit launches the Submit Fault Report view. There are three different Submit Fault Report views: one for submission to the Maximo system only, one for submission to the DMS system only, and one for submission to both systems. The view that comes up depends on the configuration of your system. The example in Figure 15 shows the Submit Fault Report View for submission to both systems. TC05353A Figure 15. Submit Fault Report View (for Submission to Maximo and DMS Systems) 3BUA000118R

56 SAP/PM Integration Section 1 Introduction SAP/PM Integration SAP/PM Integration includes a SAP Equipment ID aspect, a SAP Credentials aspect, and CMMS Views aspects. The Fault Report Submitter aspect, which is part of the Asset Optimization Server system extension, makes it possible to submit Fault Reports to the SAP/PM and DMS systems. The SAP Equipment ID provides information for mapping the 800xA System object to the SAP/PM equipment in the CMMS database for a particular SAP/PM Server. Multiple SAP Equipment IDs can be associated with the same asset, thus providing the ability to map to more than one piece of equipment defined in SAP/PM. SAP Credentials contains the SAP/PM user credentials used to access the SAP/PM Server by the specific 800xA user. The CMMS views shown here consist of 800xA System views. The CMMS Views consist of the following: Active Work Orders View. Work Order History View. Equipment Status View. Preventive Maintenance Schedule View. The Fault Report Submitter consists of the following: Create Fault Report Form/Submit Fault Report. Fault Report Viewer/Submit Fault Report. Active Work Orders View The Active Work Orders view lists all active Work Orders in the CMMS for a particular asset or group of assets. 56 3BUA000118R4101

57 Section 1 Introduction SAP/PM Integration Figure 16 shows the 800xA System Active Work Orders view. Clicking a column header sorts the list with respect to that header topic. Figure xA System Active Work Orders View (SAP/PM Integration) TC06086A 3BUA000118R

58 SAP/PM Integration Section 1 Introduction Work Order History View The Work Order History view lists the history of all Work Orders in the CMMS for a particular asset or group of assets. Figure 17 shows the 800xA System Work Order History view. Clicking a column header sorts the list with respect to that header topic. Figure xA System Work Order History View (SAP/PM Integration) Equipment Status View TC06087A The Equipment Status view allows viewing of data returned from a status assessment of an asset or group of assets. Figure 18 shows the 800xA System Equipment Status view. Clicking a column header sorts the list with respect to that header topic. TC06088A Figure xA System Equipment Status View (SAP/PM Integration) 58 3BUA000118R4101

59 Section 1 Introduction SAP/PM Integration Preventive Maintenance Schedule View The Preventive Maintenance Schedule view lists the preventive maintenance schedule for an asset or group of assets. Figure 19 shows the 800xA System Preventive Maintenance Schedule view. Clicking a column header sorts the list with respect to that header topic. Figure xA System Preventive Maintenance Schedule View (SAP/PM Integration) TC07770A Create Fault Report Form/Submit Fault Report These functions are made possible by the Fault Report Submitter. The Create Fault Report Form makes it possible to create a new Fault Report for the selected asset without an Asset Condition Document (ACD) being generated by an Asset Monitor. After filling in the fields with the appropriate information and clicking Submit Fault Report, the Submit Status: field indicates whether or not submission of the Fault Report succeeds. If it is unsuccessful, an error message will appear in the Submit Status: field. Upon successful submission, a Work Order is created in the CMMS. There are three different Create Fault Report Forms: one for submission to the SAP/PM system only, one for submission to the DMS system only, and one for submission to both systems. The form that comes up depends on the configuration of your system. 3BUA000118R

60 SAP/PM Integration Section 1 Introduction Fault Report Viewer/Submit Fault Report These functions are made possible by the Fault Report Submitter. When an Asset Monitor generates an ACD, a Fault Report is created automatically. The Fault Report Viewer (Figure 20) makes it possible to see all Fault Reports for a selected object. Figure 20. Fault Report Viewer TC06090A The FR State column shows the status of Fault Reports at any instance in time. Since Asset Monitors can report on multiple conditions for each asset, the FR State column can either be the current conditions of the asset, or the Most Severe Unacknowledged (MSU) conditions of the asset. If a condition of lesser severity than the current condition is received, the new condition replaces the current condition which becomes the MSU. If a condition of greater severity than the current condition is received, the new condition replaces the current condition and the MSU is automatically dismissed. If there is no current condition Fault Report, the asset is normal or has bad (or uncertain) quality. The Dismiss after successful submittal check box in the Submit Fault Report view is a configurable option. If it is unchecked, the Fault Report is retained with a Fault Report status of submitted. It can be dismissed later or automatically replaced with subsequent Fault Reports. Right-clicking anywhere in a Fault Report row produces a context menu with the option to dismiss the Fault Report or submit it. Selecting Dismiss deletes the 60 3BUA000118R4101

61 Section 1 Introduction SAP/PM Integration selected Fault Report from the Asset Optimization system. It also acknowledges the alarm in the Alarm and Event List. This function will not acknowledge alarms in Process Portal B (refer to 800xA - Asset Optimization for Process Portal B on page 69). Selecting Submit launches the Submit Fault Report view. There are three different Submit Fault Report views: one for submission to the SAP/PM system only, one for submission to the DMS system only, and one for submission to both systems. The view that comes up depends on the configuration of your system. The example in Figure 21 shows the Submit Fault Report View for submission to both systems. TC06091A Figure 21. Submit Fault Report View (for Submission to SAP/PM and DMS Systems) 3BUA000118R

62 DMS Calibration Integration Section 1 Introduction DMS Calibration Integration Calibration management is an important facet of the plant maintenance strategy. By streamlining calibration workflow, quality of the process/product is improved while cost is reduced. In many cases, calibration is a manual operation that is scheduled haphazardly, through trial and error. Assessing field device data to determine the optimal schedule eliminates problems of late or unnecessary calibrations. Information such as historical data, fault analysis, process analysis, and the calibration strategy can be used to create a calibration trigger, which initiates a calibration Work Order. A Work Order can be sent to a CMMS and the Fault Report Submitter supports an interface into DMS Calibration Integration (refer to Figure 15 and Figure 21). DMS Calibration Integration brings a calibration management solution, for HART or conventional 4-20 ma devices, to the operator environment by integrating Meriam Process Technologies Device Management System (DMS) database software with Asset Optimization. It provides a single window interface to DMS as the DMS aspect system supports calling DMS driven aspects from different objects within the 800xA System. It manages data exchange between DMS and the 800xA System for items such as alarms, synchronization of topology, device instances, and device specific parameters needed for calibration. Usually Fieldbus Builder PROFIBUS/HART manages and owns the HART device configuration. All device parameters that are needed in the DMS system and the MFT to run a calibration procedure are stored in the 800xA System and are propagated into the DMS system. DMS does not store configuration information for those devices. Device configuration data from the MFT or the MFC is not loaded back into the DMS system or the 800xA System. If the configuration of the HART device is not managed by Fieldbus Builder, the DMS system owns the device configuration and stores the data. Device configuration data from the MFT or MFC can be loaded back into the DMS system. The device information will not be available as a property in the 800xA System. DMS Calibration Integration allows plant personnel to monitor field devices for calibration information and opens the workflow towards the CMMS. Work orders required for calibration procedures are submitted to either the DMS system only, or the DMS system and CMMS (if Maximo or SAP Connectivity system extension is installed) using the Fault Report Submitter. DMS Calibration Integration supports: Calibration Administration (DMS). 62 3BUA000118R4101

63 Section 1 Introduction DMS Calibration Integration Classification of devices and descriptions of general calibration procedures for different device types. Calibration schedule for devices in a plant. Calibration history and reports per device. Calculation of device specific calibration steps depending on device specific parameterization. Generation of Work Orders and instructions for devices due for calibration. Calibration process in the field with a hand-held calibrator and HART communicator: Providing a device TAG specific instruction list for calibration. Logging of all executed steps for documentation purposes. Generation of the precise signals required to calibrate the device. Device trim to bring the device into calibration limits. Reporting of the results. Calibration Condition Monitoring. Notification of device due or overdue for calibration. This condition participates in the Asset Condition Reporting infrastructure. DMS Calibration Integration consists of the DMS aspect system. It contains the following: DMS Division Aspect. DMS Aspect. DMS Asset Monitor Aspect. Parameter Mapping Aspect. Calibration Event List Aspect. DMS Division Aspect A DMS Division is a high level entity used to group related devices. A DMS Division can be as small as a single device or as large as the entire enterprise. DMS Calibration Integration allows for the mapping of one or more DMS Divisions into 800xA Object Structures. The 800xA System connects on only one DMS server. Typically one DMS Division is mapped to an 800xA object representing the Control Network in the Control Structure. When the DMS Division aspect is created in the 3BUA000118R

64 DMS Calibration Integration Section 1 Introduction 800xA System, it connects to a corresponding DMS Division in the DMS system (if it is not already connected to another 800xA System object) or creates and connects to one if the corresponding DMS Division is not already there. By default, the DMS Division name is the same as the 800xA System object name. DMS Aspect One DMS aspect represents one device belonging to the DMS Division. This aspect allows the DMS Workplace pointing to that device to be opened from the 800xA System (Figure 22). Figure 22. DMS View TC05319B DMS Asset Monitor Aspect The DMS Asset Monitor provides notification in the 800xA System when DMS determines that there are devices due for calibration. DMS Asset Monitors are running in the external engine and rely upon the Meriam DMS server running. DMS 64 3BUA000118R4101

65 Section 1 Introduction DMS Calibration Integration Asset Monitor data is served by the AO Server (in the same way as all other Asset Monitors). Calibration Event List Aspect The Calibration Event List displays the current status of the actions taken, such as unscheduled, scheduled, work in progress, approved, etc. Parameter Mapping Aspect The Parameter Mapping aspect is a General Properties aspect named Parameter Mapping. Device Objects, (or any other objects containing a DMS aspect) can have one and only one Parameter Mapping aspect. The Process Portal A owns configuration check box is in the Config view of the DMS aspect, as shown in Figure 23. When the Process Portal A owns Figure 23. Process Portal A Owns Configuration Check Box TC07821A configuration check box is selected, the 800xA System with the HART Device Integration package performs the HART device configuration and stores the configuration data. The data is needed in the DMS system to perform calibrations. This aspect synchronizes the 800xA (Process Portal A) information with the DMS system. However, device configurations stored in the MFT or the MFC can not be loaded into the DMS System in that case. Configuration changes in the device need to uploaded into the 800xA System by the Device Type Manager (DTM). The Parameter Mapping aspect either: 3BUA000118R

66 DMS Calibration Integration Section 1 Introduction Contains up-to-date device configuration data, as hard coded property values in this aspect, to be uploaded into the DMS system. References, via macro definition, up-to-date device configuration data stored in 800xA properties, to be uploaded to the DMS System. The device configuration is usually provided by the Device Management aspect (the Device Type Manager (DTM)). Refer to Figure 24. Figure 24. Parameter Mapping with Check Box Selected TC07822A 66 3BUA000118R4101

67 Section 1 Introduction Asset Optimization Reporting When the Process Portal A owns configuration check box is deselected, the Parameter Mapping aspect provides information on ma device model and revision. In this case, device configurations stored in the MFT or the MFC can be loaded and stored in the DMS system. Refer to Figure 25. Figure 25. Parameter Mapping with Check Box Deselected However, in all case device configuration information from DMS can not be uploaded into the 800xA System. Asset Optimization Reporting TC07823A The 800xA System provides three Asset Optimization Report Templates that summarize important maintenance information to provide maintenance engineers with comprehensive data to make decisions. The Asset Optimization Report Templates are preconfigured as Microsoft Excel spreadsheet (.xls) files. These spreadsheets are used as templates for the Asset Optimization Reports and contain logic for extracting the Alarm and Event data and properties from the specified Asset Optimization objects. After the report data is read, it is formatted in the spreadsheet using Excel functions (pivot table) and sorted appropriately. To execute the reports, the Scheduling Definition and Action aspects must be configured. The reports can be executed automatically according to a certain schedule or on demand by clicking RUN NOW in the Scheduler Definition aspect. The Asset Optimization Report Templates are: AO Asset Condition History Report. AO Calibration Report. AO Running Time Report. 3BUA000118R

68 AO Asset Condition History Report Section 1 Introduction These reports are implemented as a Microsoft Excel (.xls) files. The templates are used in conjunction with the Inform IT Scheduler system extension. Reports are run manually and can be scheduled periodically as defined in the Scheduling Definition aspect. Report data is retrieved through DataDirect macros or by using custom macros written in Visual BASIC. All report parameters are defined in a second configuration sheet. When data is collected and formatted, the reports can be optionally printed or historized, if Information Management is installed and appropriately configured. The Asset Optimization Report Template implementation requires that the following 800xA System features be installed on the target Aspect System: Asset Optimization: required as a source for the report data. Scheduler: required for the report template to be triggered, run, and stored. DataDirect (Excel add-in): required for retrieving data from the Aspect System. Information Management: required if long term archiving of reports is required. AO Asset Condition History Report The AO Asset Condition History Report provides, for every asset, a detailed listing of all asset maintenance conditions that have been active in a time interval, and counts the number of faults per each condition. This report is based on an Alarm and Event list (Event type) configured to display Asset Conditions. The AO Asset Condition History Report identifies repeating asset condition offenders and highlights critical assets with high failure rates. This report can be used to define a proactive maintenance strategy. AO Calibration Report The AO Calibration Report lists, for every device, all calibration events with the time that the event occurred and shows the current calibration state on top of the list. This report is based on an Alarm and Event list (Event type) configured to display calibration events. The AO Calibration Report helps to identify the current calibration state for every device for; example, waiting for approval, due for calibration, work in progress, etc. 68 3BUA000118R4101

69 Section 1 Introduction AO Running Time Report AO Running Time Report The AO Running Time Report lists all assets in a given structure with a Runtime Asset Monitor. It shows, per asset, the configured runtime limit value, the hours of operation, indication that the runtime limit is active, and the date of the last Asset Monitor reset. Furthermore, it calculates the remaining time of operation until the runtime limit is reached based on the current calculated average runtime rate. The AO Running Time Report allows sorting by tag, object type, runtime limit, and alarm active. 800xA - Asset Optimization for Process Portal B 800xA - Asset Optimization for Process Portal B adds Asset Optimization functionality to Process Portal B systems. Asset Monitoring information is available as a context menu on PPB TAGs and active Asset Conditions are reported into Process Portal B Alarm and Event systems. Furthermore, Asset Optimization enables the integration of Computerized Maintenance Management Systems and provides CMMS specific information through the context menu of a PPB TAG. Refer to Operate IT, Process Portal Version B2.0, 800xA - Asset Optimization for Process Portal B for installation and Process Portal B node configuration. The Asset Optimization software components include: Process Portal B Provider Aspect. Process Portal B Connectivity Software. Process Portal B Provider Aspect The Process Portal B Provider is an 800xA System aspect that sends asset condition events to a Process Portal B node. Typically, the Process Portal B Provider Aspect is configured on an 800xA System single node with operational 800xA System software and Asset Optimization software. Process Portal B Connectivity Software The Process Portal B Connectivity software must be installed on one Process Portal B node for single or multinode Process Portal B systems. With this software installed, the Process Portal B system will have the following functionality: Asset health condition monitoring capabilities. 3BUA000118R

70 Process Portal B Connectivity Software Section 1 Introduction Maximo Integration. SAP/PM Integration. Asset condition reporting and alarming into Process Portal B Maintenance Alarm Group. 70 3BUA000118R4101

71 Section 2 System Setup Introduction This section contains system setup procedures applicable to all system extensions; however, procedures specific to PC, Network and Software Monitoring are located in Section 5, PC, Network and Software Monitoring Setup. This section contains procedures for the following: Setting Up Aspect Defaults. Asset Monitor Startup Parameters. Connecting to a Process Portal B Node. Maximo Server Connection Properties. SAP/PM Server Connection Properties. Mapping Between the 800xA System and the CMMS. Alarm Behavior Upon Fault Report Submittal. User Privileges. Maximo User Credentials. SAP User Credentials. Allowing 800xA System Users Access to DMS. Primary Structures. Managing Data Source Connections. Managing the Connection Between the 800xA System and the DMS System. Defining the AOWebServerNode. Defining Alarm Behavior. When creating aspects, it is possible to add a description and name the aspect as desired. If the aspect is not named, the aspect category name is used and displayed in the Aspect List Area. Unless otherwise noted, the procedures in this instruction use the aspect category name. 3BUA000118R

72 Setting Up Aspect Defaults Section 2 System Setup Setting Up Aspect Defaults The following procedures must be performed to set up the aspects in the Aspect System Structure: Asset Optimization Server Configuration. Loading Asset Monitor Configurations to an AO Server. Asset Monitor Startup Parameters. Connecting to a Process Portal B Node. Maximo Server Connection Properties. SAP/PM Server Connection Properties. Mapping Between the 800xA System and the CMMS. Alarm Behavior Upon Fault Report Submittal. Setting up these aspects in the Aspect System Structure provides default values for each instance of that aspect applied to individual objects in the Primary Structures. Asset Optimization Server Configuration Each AO Server Object should be added under the Asset Optimization Object in the Control Structure. An AO Server object in the Control Structure represents one AO Server node. This is an 800xA System Connectivity Server running the AO Server software. An AO Server node runs the following services: AssetMonitoring Service: This service collects the Asset Condition Documents (ACDs) generated by Asset Monitoring Engines and publishes them in the 800xA platform as OPC-DA properties, Soft Alarms, Asset Tree node status, and Fault Reports AO Asset Monitoring Engine: Provides the execution environment for the AO Asset Monitor logic. For each Asset Monitor loaded in this engine it provides the required runtime data via the connected OPC Servers and exposes the generated ACDs to the AssetMonitoring service in this AO Server. Fault Reports Repository Manager: Maintains the Fault Reports generated by the Asset Monitoring Engines and exposes them to the user for further processing. AO Internet Information Service Webs: Exposes Asset Optimization data to Web Clients. 72 3BUA000118R4101

73 Section 2 System Setup Asset Optimization Server Configuration Third Party Asset Monitoring Engine: The AO Server can also process ACDs generated by third party Asset Monitoring Engines. One example is Meriam DMS Calibration System that provides Calibration Due ACDs for the configured assets. To Configure an AO Server: 1. Open a Plant Explorer Workplace. 2. Use the Structure Selector to select the Control Structure. 3. Use the Object Browser to navigate to: Root, Domain > Asset Optimization, Asset Optimization > AO Server 1, AO Server 4. Select Asset Optimization Server in the Aspect List Area. 5. Click on the View Selector and select Config View to open the Config View in the Preview Area as shown in Figure 26. Figure 26. Asset Optimization Server Aspect TC07791A 3BUA000118R

74 Asset Optimization Server Configuration Section 2 System Setup 6. The fields in the Asset Optimization Server Config View are defined as follows: Configurable fields: Alarm Severity (1-1000): Used to report AO Server problems in the 800xA Alarm and Event System. Default Asset Optimization Server: Only one AO Server in the system can be selected to be the default. All Asset Monitors assigned to the default AO Server will be linked to the AO Server designated to be the default. Informational fields: Service Group: The name of the AssetMonitoring Service group object in the Service Structure. Service Provider: the name of the AssetMonitoring Service provider object under the selected AssetMonitoring Service group. Provider Hostname: The 800xA System node where the AssetMonitoring Service provider has been configured to run. 7. Make the changes to the configurable fields and click Apply to save them. 8. Click Navigate to Data Source Definition to replace the current view with the AM Service Data Source Definition aspect in the same object as shown in Figure 27. This aspects directly links the AO Server object with one AssetMonitoring Service Provider on an 800xA System node. Figure 27. AM Service Data Source Definition Aspect TC07792A 74 3BUA000118R4101

75 Section 2 System Setup Loading Asset Monitor Configurations to an AO Server Loading Asset Monitor Configurations to an AO Server 1. Open a Plant Explorer Workplace. 2. Use the Structure Selector to open the Control Structure. 3. Use the Object Browser to navigate to: Root, Domain > Asset Optimization, Asset Optimization > AO Server 1, AO Server 4. Select Asset Optimization Server in the Aspect List Area. 5. Select the Asset Monitors tab in the Preview Area as shown in Figure 28. Figure 28. Asset Optimization Server Aspect TC06062A 6. Make sure that the Asset Monitor aspects to be loaded are assigned to the target Asset Optimization Server and that they are enabled. 3BUA000118R

76 Loading Asset Monitor Configurations to an AO Server Section 2 System Setup 7. To load the configured Asset Monitor aspects to the Asset Optimization Server, click Load all AMs. For configurations in excess of 500 Asset Monitors, the Load all AMs operation must be performed from the same node where the AssetMonitoring Service resides. Additionally, the Windows logged on user must belong to the 800xA System Application Engineer group. 8. To load only selected Asset Monitor aspects: a. Enable AMs Assigned to this AO Srv. b. Select the desired Asset monitors. c. Right-click and select Load Selected Asset Monitors from the context menu that appears. It is also possible to load a single Asset Monitor from the Asset Monitor aspect itself. Refer to Loading a Single Asset Monitor on page 132 for more information. 9. If the load operation fails: a. Select the AO Server tab. b. Click Navigate to AssetMonitoring Service Provider. c. Disable the related AssetMonitoring Service. d. Wait 30 seconds. e. Go back to the Asset Monitors tab and try to load again. a. Go back to the AO Server tab. b. Click Navigate to AssetMonitoring Service Provider. c. Enable the related AssetMonitoring Service. 10. To verify the current Asset Monitor configuration status: a. Select the Asset Monitors tab. b. Enable AMs Assigned to this AO Srv. This operation, which may take a few minutes, will populate the list of all the Asset Monitors in the system that are assigned to this AO Server. 76 3BUA000118R4101

77 Section 2 System Setup Asset Monitor Startup Parameters c. Each Asset Monitor in the list will display its current configuration status among one of the following: NotInControlStructure: Object containing the Asset Monitor aspect is not inserted in the Control Structure. This is an invalid configuration and must be fixed by inserting the Object once in the Control Structure. Configured: Asset Monitor aspect configuration is not loaded to an AO Server. Modified: Asset Monitor aspect configuration was modified since last loaded to an AO Server. Disabled: Asset Monitor aspect is not enabled; is not (and will not be) loaded to an AO Server. Loaded: Current Asset Monitor aspect configuration has been loaded to an AO Server. Disabling an Asset Monitor followed by an incremental load will result in a quality of Bad (out of service) if the AO Server is running during the load. If an AO Server is assigned to a different AssetMonitoring Service group (by modifying the AM Service Data Source Definition) then a Load all AMs operation is required for each AO Server in the system. Configuration changes to an Asset Monitor aspect (including Enable/Disable and assigning to a different AO Server) will become active after the Asset Monitor aspect is loaded. Asset Monitor Startup Parameters Some Asset Monitors may use startup parameters to modify the behavior of the Asset Monitor, or to provide global configuration values (refer to Section 4, Basic Asset Monitor Library for more information). Startup parameters can only be modified under the Logic tab in the Config view of the Asset Monitor category in the Aspect System Structure. Configuration of the startup parameters applies to every instance of the Asset Monitor in the Primary Structures. This procedure uses the Running Time Check Asset Monitor as an example. To configure the startup parameters: 1. Use the Structure Selector to open the Aspect System Structure. 3BUA000118R

78 Asset Monitor Startup Parameters Section 2 System Setup 2. Navigate to: Asset Monitoring, Aspect System > Asset Monitors, Aspect Type > Running Time Check, Aspect Category 3. Click Running Time Check in the Aspect List Area to produce the Config view in the Preview Area. 4. Click the Logic tab to produce the view shown in Figure 29. Figure 29. Asset Monitor Startup Parameters TC05037B 5. The Value in the OutPutRecord_ReportingTime_min row defaults to 10 minutes. This value is a positive real number representing the minimum time interval between subsequent Output Record updates to the user interface. The scope of this parameter is to reduce the load on the system by limiting the update rate. Modify the Value in the Startup Parameters: frame as desired. 6. Click Apply. 78 3BUA000118R4101

79 Section 2 System Setup Connecting to a Process Portal B Node Connecting to a Process Portal B Node Add the Process Portal B Provider aspect to 800xA System Objects to provide Process Portal B notification for them. Process Portal B alarm notification will not be enabled on an object in the 800xA System if the Process Portal B Provider aspect is not added to that Object. 800xA - Asset Optimization for Process Portal B adds Asset Optimization functionality to Process Portal B systems. Asset Monitoring information is available as a context menu on PPB TAGs and active Asset Conditions are reported into Process Portal B Alarm and Event systems. Furthermore, Asset Optimization enables the integration of Computerized Maintenance Management Systems and provides CMMS specific information through the context menu of a PPB TAG. Refer to Operate IT, Process Portal Version B2.0, 800xA - Asset Optimization for Process Portal B for installation and Process Portal B node configuration. To configure the Process Portal B Provider aspect: 1. Use the Structure Selector to open the Aspect System Structure. 2. Navigate to: Asset Monitoring, Aspect System > Process Portal B Provider, Aspect Type > Process Portal B Provider, Aspect Category 3. Right-click Process Portal B Provider, Aspect Category and select Process Portal B Provider from the context menu that appears. This opens the Process Portal B Provider shown in Figure 30. Figure 30. Process Portal B Provider TC04668C 3BUA000118R

80 Maximo Server Connection Properties Section 2 System Setup 4. Fill in the fields with the appropriate information: Name: Name of the Process Portal B node on which Asset Optimization Process Portal B Connectivity is installed. Service Account: Service account information on Process Portal B node. Password: Password of the service account on Process Portal B node. Confirm Password: Re-enter password entered in Password field. 5. Click Apply to save the entered information. This information will now appear in every Process Portal B Provider added to objects in the Primary Structures. To connect to more than one Process Portal B system, create another Process Portal B Provider (naming it something other than the original) on the Process Portal B Provider Aspect Category in the Aspect System Structure and define its parameters. Maximo Server Connection Properties The Maximo Equipment ID contains the information needed to access the Maximo Server and must be set up in the Aspect System Structure to provide CMMS System identification information (Provider Properties). Each instance of the aspect applied to individual objects in the Primary Structures references this information. The Maximo Equipment ID provides information for mapping the 800xA System object to the Maximo equipment in the CMMS database for a particular Maximo Server. Multiple Maximo Equipment IDs can be associated with the same asset, thus providing the ability to map to more than one piece of equipment defined in Maximo. 1. Use the Structure Selector to select the Aspect System Structure. 2. Navigate to: Maximo Connectivity, Aspect System > Maximo Equipment ID, Aspect Type > Maximo Equipment ID, Aspect Category 80 3BUA000118R4101

81 Section 2 System Setup Maximo Server Connection Properties 3. Click on Maximo Equipment ID in the Aspect List Area to produce the default view of the Maximo Equipment ID in the Preview Area as shown in Figure 31. Figure 31. Maximo Equipment ID TC04850C 4. The Asset Information frame requires no action during setup. It is used when the Maximo Equipment ID is added to individual assets in the Primary Structures. 3BUA000118R

82 Maximo Server Connection Properties Section 2 System Setup 5. Table 7 lists and describes the properties in the CMMS Information frame and the Maximo Equipment ID Provider Properties. Table 7. Maximo Equipment ID CMMS Information Frame Provider Properties Default Value Description CMMS System Does not appear Maximo The type of CMMS. MRO Server Name MRO Server Version Application Server Name ServerName MustDefine The DNS/IP name/address of the Maximo Server node. ServerVersion 5.1 The version of the Maximo software being used (4.1, 4.1.1, or 5.1). AppServer MXServer The name of the service used for the Java RMI/SDK connection. MRO WebServer MROWebServer MustDefine The DNS/IP name/address of the server for the Maximo web interface. MRO Site Name MROSite BEDFORD The name associated with the data set to view on the specified Maximo application server (Server Name). Use Credentials UseCredentials True or False Determines whether or not the Maximo Credentials configured on the current user are used to submit a Fault Report. 82 3BUA000118R4101

83 Section 2 System Setup Maximo Server Connection Properties 6. Click Edit Category Data and the view changes to access the Maximo Equipment ID Provider Properties shown in Figure 32. Figure 32. Maximo Equipment ID Provider Properties TC04851C 7. Click in the Value column of the desired row to change the value. a. Change the Value column of the ServerName row to the DNS/IP name/address of the Maximo Server node. b. If required, change the Value column of the ServerVersion row to the Maximo version being used. c. The AppServer parameter defines the name of the service used for the Java RMI/SDK connection. If required, change the Value column of the AppServer row to the proper value. d. Change the Value column of the MROWebServer row to the DNS/IP name/address of the server for the Maximo web interface. 3BUA000118R

84 Maximo Server Connection Properties Section 2 System Setup e. If required, change the Value column of the MROSite row to the name associated with the data set to view on the specified MRO application server. f. If required, change the Value column of the UseCredentials row from True to anything other than True (usually False). A value of True means that the Maximo Credentials on the current user are used for the submittal of Fault Reports. A value of False means that the Maximo Credentials on the current user are not used and the User Name and Password are required to submit a Fault Report. Table 8 lists the effect of the UseCredentials value on the submission of Fault Reports. Does not exist means that the MxDef file was edited to remove that field from the Fault Report Forms. Table 8. Effect of UseCredentials Value on Fault Report Submission UseCredentials Value User Name Password Submit Status True Blank Blank Yes Correct Incorrect No Incorrect Incorrect No Correct Correct Yes Blank Does not exist Yes Correct Does not exist No Does not exist Blank Yes Does not exist Correct No Does not exist Does not exist Yes 84 3BUA000118R4101

85 Section 2 System Setup Maximo Server Connection Properties Table 8. Effect of UseCredentials Value on Fault Report Submission (Continued) UseCredentials Value False Blank Blank No NOTE: 1. High security setting. User Name Password Submit Status Correct Incorrect No Incorrect Incorrect No Correct 1 Correct 1 Yes 1 Blank Does not exist No Correct Does not exist No Does not exist Blank No Does not exist Correct No Does not exist Does not exist No 8. Click Apply. 9. Click the back arrow in the Preview Area to return to the initial Maximo Equipment ID aspect view and verify that the correct information appears in the CMMS Information frame. The fields and values that appear in the Create Fault Report Form and Submit Fault Report view are dependent on the contents of MxDefMOMAppFR_Submit.xml Maximo Definition (MxDef) file. Refer to Mapping Between the 800xA System and the CMMS on page 89 for information on accessing and editing the MxDef files. 3BUA000118R

86 SAP/PM Server Connection Properties Section 2 System Setup SAP/PM Server Connection Properties The SAP Equipment ID contains the information needed to access the SAP/PM Server and must be set up in the Aspect System Structure to provide CMMS System identification information (Provider Properties). Each instance of the aspect applied to individual objects in the Primary Structures references this information. The SAP Equipment ID provides information for mapping the 800xA System object to the SAP/PM equipment in the CMMS database for a particular SAP/PM Server. Multiple SAP Equipment IDs can be associated with the same asset, thus providing the ability to map to more than one piece of equipment defined in SAP/PM. 1. Use the Structure Selector to select the Aspect System Structure. 2. Navigate to: SAP Connectivity, Aspect System > SAP Equipment ID, Aspect Type > SAP Equipment ID, Aspect Category 3. Click on SAP Equipment ID in the Aspect List Area to produce the default view of the SAP Equipment ID in the Preview Area as shown in Figure 33. Figure 33. SAP Equipment ID TC07793A 86 3BUA000118R4101

87 Section 2 System Setup SAP/PM Server Connection Properties 4. The Asset Information frame requires no action during setup. It is used when the SAP Equipment ID is added to individual assets in the Primary Structures. 5. Table 9 lists and describes the properties in the CMMS Information frame and the SAP Equipment ID Provider Properties. Table 9. SAP Equipment ID CMMS Information Frame Provider Properties Default Value Description CMMS Type Does not appear SAP-PM Module The type of CMMS. Server IP Address SAP Server Version SAP Router Address SAP AOWebServer Use SAP Credentials ServerAddr MustDefine The DNS/IP name/address of the SAP/PM Server node. ServerVersion 4.7 The version of the SAP/PM software being used. ServerRouter (null string) IP address of an SAP/PM server that acts as a webfarm router and will direct request traffic to available SAP/PM server resources (SAP/PM server nodes). For single server SAP/PM systems, this is usually (a null string). SAPWebServer [AoWebServer] The DNS/IP name/address of the AO server for the SAP/PM web interface. UseCredentials True Determines whether or not the SAP/PM Credentials configured on the current user are used to submit a Fault Report. 3BUA000118R

88 SAP/PM Server Connection Properties Section 2 System Setup 6. Click Edit Category Data and the view changes to access the SAP Equipment ID Provider Properties shown in Figure 34. Figure 34. SAP Equipment ID Provider Properties TC07794A 7. Click in the Value column of the desired row to change the value. a. Change the Value column of the ServerName row to the DNS/IP name/address of the SAP/PM Server node. b. If required, change the Value column of the ServerVersion row to the SAP/PM version being used. c. Information needed for SAP/PM Router Address d. Change the Value column of the SAPWebServer row to the DNS/IP name/address of the server for the SAP/PM web interface. e. If required, change the Value column of the UseCredentials row from True to anything other than True (usually False). A value of True means that the SAP/PM Credentials on the current user are used for the submittal of Fault Reports. A value of False means that the SAP/PM Credentials on 88 3BUA000118R4101

89 Section 2 System Setup Mapping Between the 800xA System and the CMMS the current user are not used and the User Name and Password are required to submit a Fault Report. Table 8 lists the effect of the UseCredentials value on the submission of Fault Reports. Does not exist means that the SAP/PM Definition file was edited to remove that field from the Fault Report Forms. 8. Click Apply. 9. Click the back arrow in the Preview Area to return to the initial SAP Equipment ID aspect view and verify that the correct information appears in the CMMS Information frame. The fields and values that appear in the Create Fault Report Form and Submit Fault Report view are dependent on the contents of SapDef_FaultReportView.xml SAP/PM Definition file. Refer to Mapping Between the 800xA System and the CMMS on page 89 for information on accessing and editing the SAP/PM Definition files. Mapping Between the 800xA System and the CMMS The MxDef files (Maximo) and SAP/PM Definition (SAPDef) files (for SAP/PM) provide the mapping between the 800xA System environment and the CMMS system. Maximo Integration The Maximo Integration information can be found on Asset Optimization Server nodes. Reference the Service Structure for the name of the Asset Optimization Server. 1. The MxDef files provide the mapping between the 800xA System environment and the Maximo system. Do not edit the MxDef files without an extensive knowledge of the Maximo SDK for Business Components documentation. Do not edit the MxDef files without a close consulting association with MRO Software Inc. personnel to determine what fields are required. Editing these files without the required knowledge and experience may result in problems with the Maximo system and CMMS interface to the Maximo system. 3BUA000118R

90 Mapping Between the 800xA System and the CMMS Section 2 System Setup Perform the following procedure if changes are made to the MxDef files, in order to prevent the customized MxDef files from being overwritten during an upgrade or reinstallation of Asset Optimization. The software will first look in the subdirectories created in the procedure for the MxDef files before looking in the default MxDef file location. 2. Assuming the default directory was selected during Asset Optimization installation, the MxDef files supplied with Asset Optimization are located in:...\program Files\ABB Industrial IT\Optimize IT\ Asset Optimization\ABBAO\Services\MOM\MxDefs 3. If changes are made to the MxDef files, create and save them in the following location (assuming the default directory was selected during Asset Optimization installation): Where:...\Program Files\ABB Industrial IT\Optimize IT\ Asset Optimization\ABBAO\Services\MOM\MxDefs\ <server_name>\<app_server> <server_name>\<app_server> is the combination of the MRO Server Name and the MRO Application Server Name fields from the Maximo Equipment ID aspect. These fields are configured in the Aspect System Structure in the Maximo Equipment ID aspect. The resultant path to the customized MxDef files will look like, for example:...\program Files\ABB Industrial IT\Optimize IT\Asset Optimization\ABBAO\Services\MOM\MxDefs\Maximo5\MxServer This allows for customization of MxDef files on the Maximo Server level as well as on the Maximo Application Server level. Refer to Maximo documentation for an explanation of Maximo Application Servers. SAP/PM Integration The SAP/PM Integration information can be found on Asset Optimization Server nodes. Reference the Service Structure for the Asset Optimization Server. 1. Although the SAP/PM system is separate from the 800xA system, it is a good idea to back up the system in use. Follow SAP/PM standard practices for the third party SAP/PM system backup. 90 3BUA000118R4101

91 Section 2 System Setup Mapping Between the 800xA System and the CMMS 2. The SAPDef files provide the mapping between the 800xA System environment and the SAP/PM system. Do not edit the SAPDef files without a close consulting association with SAP, AG personnel to determine what fields are required. Editing these files without the required knowledge and experience may result in problems with the SAP/PM system and CMMS interface to the SAP/PM system. 3. Assuming the default directory was selected during Asset Optimization installation, the SAPDef files supplied with Asset Optimization are located in:...\program Files\ABB Industrial IT\Optimize IT\ Asset Optimization\AoAIPSAPWebSrv\SAPXML 4. Save these files. If changes were made to the default files, save them as well. Appendix A, CMMS Definition Files contains code for an MxDef file and a SAP/PM Definition file included with Asset Optimization. The MxDef files for the basic CMMS views (Active Work Orders, Work Order History, Equipment Status, Preventive Maintenance Schedule, Spare Parts, Availability of Spare Parts) provide the information on the data to retrieve and display. Each attribute for display has a definition record: <AttrDef> <Attr>description</Attr> <Caption>WO Description</Caption> <Map>ABBACD/Condition/SuggestedAction</Map> </DefaultValue> <Type>string</Type> <FieldLen>50</FieldLen> <Edit>True</Edit> </AttrDef> <Attr>description</Attr> tag: Defines the data field to retrieve from the Maximo system. <Caption>WO Description</Caption> tag: Defines the column heading for the view. <Type>string</Type> tag: Defines the data type being retrieved from the Maximo system. 3BUA000118R

92 Mapping Between the 800xA System and the CMMS Section 2 System Setup <FieldLen>50</FieldLen>: Field length tag used to truncate the data from the ACD to a length less than or equal to FieldLen. This restriction on field length is a result of the database storage size (in characters) of the fields in a Maximo Work Order (specifically in the Waiting for Approval state (WAPPR). Each Maximo field has its own attributes, so a knowledge of the Maximo Work Order is necessary in setting these limits (refer to Maximo documentation). A FieldLen of 0 is interpreted by the Asset Optimization web server as meaning no practical limit. The MxDef file for the Fault Report Submitter provides the information on the data to display, defines the data inputs/edit characteristics, and the data destination for the creation of a Work Order in the Maximo system. The <Attr>, <Caption>, and <type> XML tags are identical to those in the other MxDef files. The <Edit> tag enables editing of particular fields as displayed on the various Fault Report submission UIs (Create Fault Report and Submit Fault Report). The <Map> tag is the information token used to fill in the displayed field in the Create Fault Report and Submit Fault Report UI forms (browser-based UI forms/pages). This map is the method for making information existing in the Fault Reports available to the Fault Report Viewer/Fault Report Submitter visible in the submission displays (Create Fault Report and Submit Fault Report) and available to send to the CMMS in a Fault Report. The mapping is the <Attr> tag that represents a data element in a Fault Report object in the particular CMMS. The <DefaultValue> tag is a typed value that is used in the mapping functions if the token does not exist in the Fault Report data that is available to the Fault Report Viewer/Fault Report Submitter, or if the tokenized data does exist but is null or blank in the Fault Report data. Therefore, the DefaultValue is used if the token does not exist or supplies no useful data. Thus, if in a configuration, one wishes to use the DefaultValue in place of the values that may be available from the Asset Monitors via the Fault Report Viewer/Fault Report Submitter, one could configure the <Map> tag as blank or to a token known to not exist in the Fault Report data, e.g. <Map>notused</Map>. The database attribute <Attr> AUFNR is used to link into the SAP/PM system and MUST be part of the request in the SAPDef xml definition file. AUFNR represents the Order number in the SAP/PM system. 92 3BUA000118R4101

93 Section 2 System Setup Alarm Behavior Upon Fault Report Submittal When configuring the Active Work Order SAPDef file (SapDef_GetWONO.xml), the number of requested <Attr>s should be kept below 250 and there should be no duplication of requested <Attr>s. That is, the file should contain one and only one of each of the <Attr>s that are required. Alarm Behavior Upon Fault Report Submittal The Fault Report Submitter must be set up in the Aspect System Structure to provide default values for each instance of it applied to individual objects in the Primary Structures. 1. Use the Structure Selector to select the Aspect System Structure. 2. Navigate to: CMMS Views, Aspect System > Fault Report Submitter, Aspect Type > Fault Report Submitter, Aspect Category Click on Fault Report Submitter in the Aspect List Area to produce the config view of the Fault Report Submitter in the Preview Area as shown in Figure 35. Figure 35. Fault Report Submitter TC05003B 3BUA000118R

94 User Privileges Section 2 System Setup 3. The only setup required is to check or uncheck the Automatically dismiss Fault Report after successful submittal check box. This check box controls the default setting in the Submit Fault Report view. Checking the check box (and leaving it checked in the Submit Fault Report view) deletes the current condition from the system when it is successfully submitted. It also acknowledges the alarm in the Alarm and Event List and dismisses it if the Alarm and Event List is configured to do so. This function will not acknowledge alarms in Process Portal B. User Privileges The User Structure holds the defined users and user groups allowed to work in the system. Adding users and defining user roles is performed using the Configuration Wizard. All users must have a related Windows user account. The User object contains information about a user and what the user is allowed to do within the system. It also contains data specific to the user, such as profile configuration values. The User Structure contains two levels under the root object: the first level holds User Groups, and the second holds Users. The Everyone - IndustrialITUser User Group contains all Users. Users can be added to the system and to User Groups using the Configuration Wizard. Refer to the appropriate 800xA System documentation for detailed information on creating User Groups, adding Users, and the User Structure. An authenticated web user (usually the logged on Windows user) must also be an 800xA user to access the Asset Optimization web-enabled views (e.g. from the Process Portal B Asset Optimization context menu). Maximo User Credentials Each User can contain Maximo Credentials. The Maximo Credentials contains the Maximo user credentials used to access the Maximo Server by the specific 800xA System user. This procedure describes how to create Maximo Credentials on a User. 1. Use the Structure Selector to select the User Structure. 2. Navigate to the desired user. 94 3BUA000118R4101

95 Section 2 System Setup Maximo User Credentials 1. Right-click on the user and select New Aspect... from the context menu that appears. 2. The New Aspect dialog appears. Navigate to and select Maximo Credentials from the list that appears to produce the view shown in Figure Click Create. TC04861B Figure 36. New Aspect Dialog (Maximo Credentials) 4. Right-click on the desired user and select Maximo Credentials from the context menu that appears. This opens the Maximo Credentials shown in Figure 37. Figure 37. Maximo Credentials Aspect TC04862C 3BUA000118R

96 SAP User Credentials Section 2 System Setup SAP User Credentials 5. Enter the user name and password information for the selected user for access to the CMMS. 6. Click Apply. Each User can contain SAP Credentials. The SAP User Credentials contains the SAP user credentials used to access the SAP/PM Server by the specific 800xA System user. This procedure describes how to create SAP Credentials on a User. 1. Use the Structure Selector to select the User Structure. 2. Navigate to the desired user. 3. Right-click on the user and select New Aspect... from the context menu that appears. 4. The New Aspect dialog appears. Navigate to and select SAP Credentials from the list that appears. 5. Click Create. 6. Right-click on the desired user and select SAP Credentials from the context menu that appears. This opens the SAP Credentials shown in Figure 38. Figure 38. SAP Credentials Aspect TC04862C 96 3BUA000118R4101

97 Section 2 System Setup Allowing 800xA System Users Access to DMS 7. Enter the user name and password information for the selected user for access to the CMMS. 8. Click Apply. Allowing 800xA System Users Access to DMS Use the following guidelines when creating 800xA System users in the DMS system: Users must be both Windows and 800xA System users. Do not prefix the DMS user name with the Windows domain name or the computer name. The DMS system must be configured to allow 800xA System users access via the provided Asset Optimization aspects. 1. Launch the DMS Client application to produce the Login to DMS dialog. 2. Log in as the system administrator. 3. Refer to Meriam Process Technologies Device Management System User s Guide to: Create all of the desired 800xA users in the DMS system. Set up division security. Assign access rights (permissions) to users. Define division roles and groups. Join users to groups, etc. Assigning access rights (permissions) to users, defining division roles and groups, and joining users to groups must be done after each division creation. Primary Structures The following structures are called Primary Structures, because it is assumed that most operators and application engineers will perform the majority of their work within these structures. Asset Structure. Control Structure. Functional Structure. Location Structure. 3BUA000118R

98 Primary Structures Section 2 System Setup Object Type Structure. User Structure. Workplace Structure. These structures are built by placing objects into the structures according to their hierarchical relations. The object is a key concept in the Plant Explorer Workplace. The Plant Explorer Workplace is where the most basic elements of the system are created. These are the simple objects. Simple objects can be placed directly into a structure, but they can also be parts of other objects called composite objects. Simple objects can be pipes or valves or other basic elements used to build a more complex unit. Composite objects, which can contain several other simple objects, are called parent objects. They are composed of a number of subordinate objects, called children or descendents. When a new object is created, the parent object can be selected, to which the new object will be a child. Building the various structures is beyond the scope of this instruction. Refer to the appropriate Industrial IT 800xA documentation for detailed information and definitions of the various structures. 98 3BUA000118R4101

99 Section 2 System Setup Managing Data Source Connections When the various structures are set up as desired, it may become necessary to move some Asset Optimization aspects to other areas in the structures by using the drag-and-drop method. Do not attempt to move any Asset Optimization aspects when the Asset Monitoring Server is running, as this will result in the following loss of configuration: Asset Monitoring Server: Do not move. All aspects referencing moved Asset Monitoring Server point to nothing. Asset Monitor Data Source: Do not move. All aspects referencing moved Asset Monitor Data Source point to invalid Global Unique Identifiers (GUIDs). Asset Reporter and Asset Viewer: No problems. CMMS Views: Must also move the associated Maximo Equipment ID. To avoid these problems, copy and paste the aspects to the desired location, and then delete them from the original location. When an object containing Asset Monitors is moved using the drag-and-drop method, reload each Asset Monitor in the object to make them aware of their new location. Managing Data Source Connections Asset Monitoring Engines manage connections to the data sources required by the Asset Monitors. The data sources are specified during Asset Monitor configuration under the Input Records Tab. Each data source is defined by one Asset Monitor Data Source aspect. The Asset Monitor Data Source identifies the data server type and its connection parameters. The defined data server is used by the Asset Monitors to access the OPC item values that are needed to assess the current asset conditions. Renaming an Asset Monitor Data Source aspect to the same name as an existing Asset Monitor Data Source aspect is not a valid configuration. The Asset Optimization Server system extension provides an Asset Optimization Object that is placed in the root of the Control Structure. After Asset Optimization installation, the Asset Optimization Object automatically contains one Afw OPC-DA Asset Monitor Data Source. 3BUA000118R

100 Managing Data Source Connections Section 2 System Setup The Afw OPC-DA Asset Monitor Data Source is contained in the Asset Optimization Object located in the root of the Control Structure. This Asset Monitoring Engine Data Source is preconfigured, during Asset Optimization installation, to be the default data source for Asset Monitors. This data source points to the 800xA System OPC Server located in the same node where the Asset Monitoring Engine is running (OPC Sever Node = localhost). This procedure provides access to the Config view of the Afw OPC-DA Asset Monitor Data Source. ABB recommends using the default values. 1. Use the Structure Selector to select the Control Structure. 2. Navigate to: Root, Domain > Asset Optimization, Asset Optimization 3. Select Afw OPC-DA Asset Monitor Data Source in the Aspect List Area to produce the Config view of the Afw OPC-DA Asset Monitor Data Source in the Preview Area as shown in Figure 39. Figure 39. Afw OPC-DA Asset Monitor Data Source Setup TC04667C The fields in the Asset Monitor Data Source are defined as follows: Server Type: Defines the application program interface (API) used for connectivity (e.g. OPC DA). Description: Data source description BUA000118R4101

101 Section 2 System Setup Managing Data Source Connections Enable Write Access: Global switch to control write permission. Makes it possible to write values from an Asset Monitor. Default Data Source: Leave this check box checked to mark the selected data source as the default during Asset Monitor configuration. Connection Parameters: Server type specific information required to connect to the data source. Browse OPC servers (OPC Specific Connectivity): If the logon user has OPC browsing privileges on the selected OPC server node, clicking Browse OPC servers lists available OPC servers in the specified node. The connection parameters for an OPC DA server are: OPC Server Node: The hostname or address of the node hosting the OPC server. If the OPC Server Name is ABB.AfwOpcDaSurrogate, then the OPC Server Node must be set to localhost. OPC Server Name: The ProgID of the OPC server to connect to. Whenever possible the OPC Server Name should be set to ABB.AfwOpcDaSurrogate since this OPC Server provides access to any other OPC servers integrated in the 800xA System. OPC Group Update Rate (ms): Used by the OPC server for performance/scalability tuning purposes. Refer to the specific OPC server documentation for more information. If a different OPC Group Update Rate is needed (i.e., for ABB.AfwOpcDaSurrogate) do not modify the default settings. Create a new Asset Monitor Data Source instead. This will avoid imposing the new settings on all Asset Monitors pointing to the default data source. 3BUA000118R

102 Managing the Connection Between the 800xA System and the DMS System Section 2 System 4. If changes have been made, click Apply to save the entered data. OPC connectivity to an OPC server located on a different node than the Asset Monitoring Server Engine uses DCOM protocol. Table 10 is a brief troubleshooting guide for typical OPC-DCOM connectivity problems. Refer to the specific OPC server documentation for additional troubleshooting. Table 10. OPC-DCOM Connectivity Troubleshooting Guide Problem Incorrect network protocol Incorrect Launch/Access user credential Some OPC servers need to run under a specific user account (e.g. interactive user or a specific NT account) Solution Use dcomcnfg.exe and make sure that TCP/IP is specified in the Default Protocol tab of both nodes. Ideally TCP/IP should be the first in the list unless other applications have different needs. Use dcomcnfg.exe to add the identity used by the 800xA Service Account in the Launch/Access lists (Security tab) for the OPC server. Use dcomcnfg.exe to modify the OPC server application identity settings (Identity tab) and select the appropriate user. Managing the Connection Between the 800xA System and the DMS System A DMS Division is a high level entity used to group related devices. A DMS Division can be as small as a single device or as large as the entire enterprise. Asset Optimization DMS Calibration Integration allows for the mapping of one or more DMS Divisions into 800xA Object Structures. Typically one DMS Division is mapped to an 800xA System object representing the Control Network in the Control Structure (requires AC800M Connect). If the HART Device Integration system extension is installed, the Control Network object will contain the DMS Division aspect. When the DMS Division aspect is created in the 800xA System, it connects to a corresponding DMS Division in the DMS system (if it is not already connected to another 800xA System object) or creates and connects to one if the corresponding 102 3BUA000118R4101

103 Section 2 System Setup Managing the Connection Between the 800xA System and the DMS DMS Division is not already there. By default, the DMS Division name is the same as the 800xA System object name. All 800xA System users must be configured as a DMS user to access DMS information. The system engineer configuring DMS in the 800xA System must also have Division Creation privileges in the DMS system. Refer to Meriam Process Technologies Device Management System User s Guide for detailed information. The 800xA Service User must be set up as a user in the DMS system for each DMS Division. Once the DMS Division has been created in the DMS system, the creating user will be added as an administrator for that DMS Division. All other 800xA System users must be added to the DMS Division manually. Refer to Meriam Process Technologies Device Management System User s Guide for detailed information. Creating a DMS Division differs depending on which system extensions are installed: Fieldbus Builder P/H and HART Device Integration system extensions not installed: DMS Division aspect must be manually created. Fieldbus Builder P/H system extension installed, HART Device Integration system extension not installed: Add Control Network object to root of Control Structure and manually create the DMS Division aspect on the Control Network object. Fieldbus P/H and HART Device Integration system extensions installed: Add Control Network object to root of Control Structure and the DMS Division aspect is automatically created on the Control Network Object. After creating the DMS Division aspect, set it up as follows: 1. Use the Structure Selector to select the Control Structure. 2. Select DMS Division in the Aspect List Area. 3BUA000118R

104 Managing the Connection Between the 800xA System and the DMS System Section 2 System 3. Click on the View Selector and select Config to open the Config view in the Preview Area to produce the view shown in Figure 40. Figure 40. DMS Division Setup TC05355A 4. The fields in the DMS Division are defined as follows: Division Root Structure: Defaults to the Control Network. This represents the structure in which the DMS Division maps all device descendants to the corresponding DMS devices. Each device in the 800xA System that belongs to the DMS Division is represented by a DMS aspect in the child node in this structure. This value represent the hierarchy that is mapped to the DMS system. All objects under the current object in this structure will be part of this DMS Division. DMS Server Location: Points to the DMS Server node. The DMS Client installation prompts for this value. Do not set the DMS Server Location to on a multinode system. It must be set to point the DMS Server node. This value is set during DMS Client installation and should not be set here BUA000118R4101

105 Section 2 System Setup Managing the Connection Between the 800xA System and the DMS DMS Division Name: Defaults to the 800xA System object name on which the DMS Division was created. This can be changed to map to an object named differently in the DMS system. 5. A Service Account must be added as a valid user for the DMS Division. Select: Division > Roles > Create New Role as shown in Figure 41. Figure 41. Adding a Service Account for the DMS Division TC08110A 3BUA000118R

106 Managing the Connection Between the 800xA System and the DMS System Section 2 System 6. Configure the role as shown in Figure 42. TC08111A Figure 42. Configuring the DMS Role 7. A Service Group must be added. Select: Division > Groups > Create New Group as shown in Figure BUA000118R4101

107 Section 2 System Setup Managing the Connection Between the 800xA System and the DMS TC08112A Figure 43. Adding a Service Group for the DMS Division 8. Add 800xA Service account to this new 800xAServiceGroup by going to the User Membership tab. 9. Use the Role Association tab to associate the 800xAServiceGroup with the new 800xAServiceRole, as shown in Figure 44. TC08114A Figure 44. Associating the 800xAServiceGroup with the 800xAServiceRole Refer to DMS Calibration Integration on page 145 for configuration procedures. 3BUA000118R

108 Defining the AOWebServerNode Section 2 System Setup Defining the AOWebServerNode This property must be configured in order for Asset Optimization views to work. AOWebServer Node is the location of the ABBAO Web. In a multinode system with one AO Server node, this property must be configured to be the AO Server node. If the multinode system has more than one AO Server node, any AO Server can be specified as the AOWebServerNode. However, the Maximo SDK must be loaded on the AOWebServerNode. If custom MxDef files exist, they also must be on the AOWebServerNode. 1. Open a Plant Explorer Workplace. 2. Use the Structure Selector to open the Control Structure. 3. Use the Object Browser to navigate to: Root, Domain > Asset Optimization, Asset Optimization 4. Select Asset Optimization Configuration Properties in the Aspect List Area to open the Asset Optimization Configuration Properties aspect in the Preview Area. 5. Configure the hostname or address of the AOWebServerNode in the Value column. 6. Click Apply. Defining Alarm Behavior 1. Use the Structure Selector to open the Service Structure in the Plant Explorer. 2. Use the Object Browser to navigate to: Services > Alarm & Event, Service > SoftAlarms, Service Group 3. Select Service Group Definition in the Aspect List Area BUA000118R4101

109 Section 2 System Setup Defining Alarm Behavior 4. Click the Special Configuration tab as shown in Figure 45. Figure 45. Soft Alarm Service TC04619B 5. Checking the New Alarm When Condition Gets Active check box causes each inactive to active state change to result in a new alarm that will appear in the Alarm and Event List. Unchecking the check box causes only one line for every event to appear in the alarm and event list, representing the current state of the event. The recommended setting is to not check the New Alarm When Condition Gets Active check box. 6. If changes were made, click Apply to save the entered data. 3BUA000118R

110 Defining Alarm Behavior Section 2 System Setup 110 3BUA000118R4101

111 Section 3 Configuration Introduction This section contains configuration procedures applicable to all system extensions; however, procedures specific to PC, Network and Software Monitoring are located in Section 5, PC, Network and Software Monitoring Setup, Section 6, IT Asset and IT Device Library, Section 7, Network and Device Scanning Tool, and Section 8, Creating Custom IT Devices and IT Assets. This section describes the configuration steps required to add Asset Optimization functionality to an 800xA System automation solution. Asset Monitors provide automatic detection and reporting of changes in the monitored asset conditions. From a configuration point of view, an asset is represented by an 800xA System object. This object can contain a number of Asset Monitors to assess relevant asset condition states. Asset Monitors integrate seamlessly with the 800xA Alarm and Event system and SMS and Messaging, as well as Asset Optimization Maximo Integration and DMS Calibration Integration, and PC, Network and Software Monitoring. A library of Basic Asset Monitors is provided with the Asset Optimization Asset Monitoring functionality when this functionality is licensed. This library can be extended using the Asset Monitor Software Development Toolkit, which can be obtained from ABB Product Development. 3BUA000118R

112 Asset Monitors Section 3 Configuration Asset Monitors This section provides procedures for configuring: Asset Monitors. Provides an overview of the tabs available for Asset Monitor configuration. Refer to Section 4, Basic Asset Monitor Library for detailed information on each Asset Monitor. Refer to Section 5, PC, Network and Software Monitoring Setup for information on monitoring IT equipment and details on PC, Network and Software Monitoring. Asset Monitor Configuration Macros. Can be used when configuring Asset Monitors. They provide parametric configuration capabilities that are useful when designing Object Types. Asset Condition Reporting including the Asset Reporter and Asset Viewer. Maximo Integration including Mapping the 800xA System Object to the Maximo Equipment and CMMS Views. SAP/PM Integration including Mapping the 800xA System Object to the SAP/PM Equipment and CMMS Views. DMS Calibration Integration. Authentication. Alarm Grouping. Asset Optimization Reporting Configuration. When creating aspects, it is possible to add a description and name to the aspect as desired. If the aspect is not named, the aspect category name is used and displayed in the Aspect List Area. Unless otherwise noted, the procedures in this instruction use the aspect category name. Asset Monitoring configuration can be performed on any 800xA System node on which the Asset Optimization software has been installed. To optimize the system engineering and minimize configuration effort, the 800xA System provides the capability to create object types that are used as templates to build the actual project configuration for the specific site BUA000118R4101

113 Section 3 Configuration Asset Monitors Each Object represents a category of assets (e.g. a pump) used in the project specific configuration. The actual project configuration is composed of hierarchies of objects that are instances of previously defined Object Types. The following example shows an object type for a pump that may include the aspects shown in Figure 46. Figure 46. Pump Object Type Definition TC05032B As shown in the figure, every object of this type will have: Two Asset Monitors: a Runtime Asset Monitor to monitor the pump hours of operation and a High Limit Check to monitor the lube oil temperature. The Runtime Asset Monitor in this example has been renamed and does not match the category name of Running Time Check. CMMS Views: Active Work Orders, Work Order History, Equipment Status, Spare Parts, and Preventive Maintenance Schedule. 3BUA000118R

114 Asset Monitors Section 3 Configuration Maximo Equipment ID: Defines the corresponding equipment ID in the configured Maximo system. Fault Reporter Submitter: To submit Asset Monitor generated Fault Reports or to create a new Work Order in the CMMS system. Runtime Faceplate and Runtime Faceplate Element: Constitute the faceplate. Used to reset the pump hours of operation when the pump is serviced (refer to Industrial IT, 800xA - Asset Optimization, Operation for more information). 800xA provides inheritance for objects aspects so that changes on Object Types can be carried out automatically to all instances without the need to do the same change on all instances. The default granularity of inheritance within the 800xA System is an aspect. If an aspect needs to be modified on the instance of that object, then its configuration inheritance is broken. At times, customization of aspect configuration on instance level is necessary for Asset Monitor aspects. An example of such case would be: An Object Type representing a type of pump having a Runtime Asset Monitor aspect may require adjusting the runtime limit at the instance level depending on the need of the particular pump instance. Asset Monitor aspects provide a special inheritance behavior to allow modified aspect data on the instance level without stopping inheritance for other parts of the same aspect. It is possible to modify aspect configuration data for certain sections of an Asset Monitor aspect while still keeping inheritance for those configuration sections that do not need customization. This functionality increases the granularity of inheritance from the entire aspect to the following Asset Monitor configuration sections: Asset Monitor Tab: Execution Interval, Asset Monitor URL and Alarm Severity. Condition Tab: For each Condition following SubCondition fields: Subcondition Name. Description. Severity BUA000118R4101

115 Section 3 Configuration Asset Monitors Corrective Action Taken. Possible Cause. Suggested Action. Asset Parameters Tab: Asset Parameters Values. Input Records Tab: Fields: Data Source Aspect. Data Source Item. The inheritance functionality of Asset Monitoring aspects is enhanced for this release. Prior to SV 4.1 all instances of Asset Monitor aspects inherited their configuration from the Aspect Category. Inheritance from Object Types was not supported by those versions. When Asset Monitor aspects were modified at the Object Type level, the customized configurations were copied during the instance instantiation time. Asset Monitors created in new instances of the Object Type had the Overwrite Category check box selected for all information that was different from the category. All parts of the aspect that had not been modified were still inheriting from the Aspect Category. Inheritance can be maintained by configuring the Asset Monitor aspect at the Asset Monitor Category level. However, if a product upgrade to SV 4.1 is planned, it is not recommended to do so because SV 4.1 introduces inheritance from Object Types for all objects where instances and Object Types have the same configuration. If a modified Asset Monitor Category is needed it is recommended to use the Asset Monitor SDK to create a new category or to copy an existing Asset Monitor Category, rename it and modify the needed aspect parameter. Modification of Asset Monitor categories that come with the product installation or the Device Libraries is not recommended because the modification will be lost with any future product upgrade. SV 4.1 introduces inheritance for Asset Monitor aspects also from Object Types. Configuration on the Object Type level is inherited to the instances so that modifications at the Object Type level are instantaneously propagated to all existing instances. The Asset Monitor Tab of the Asset Monitor aspect clearly identifies the inheritance source. The Configuration Inheritance field indicates if the 3BUA000118R

116 Asset Monitors Section 3 Configuration information is inherited from an Object Type or directly from the Asset Monitor Category. Use of Asset Monitor aspects on Object Types is the preferred way of engineering if the customized object type with its Asset Monitor aspect will be used on several instances in the project. It is recommended for users to perform as much configuration as possible at the Object Type level to minimize or even eliminate the engineering effort for the Asset Monitoring aspect during TAG-specific instantiation of the Object Type. Configuration of Asset Monitor Aspects on Object Types: Create the objects in the Object Type Structure and add the needed Asset Monitor aspects. Configure the Asset Monitor aspects on the Object Type as far as possible by deselecting the Inherit Configuration check box and entering the Object Type specific information. Refer to Asset Monitor Tab on page 120 through Logic Tab on page 128 for specific instructions on configuring the items under the various tabs in the Asset Monitor aspect. By deselecting the Inherit Configuration check box the information will not be inherited from the category anymore regardless of whether or not it was edited. It is possible to reselect the Inherit Configuration check box if it is necessary to go back to the original information. The manually edited data will be overwritten. Open the Object Type Definition aspect on the new Object Type and select Copy to all instances in the Aspect Control tab for the newly added Asset Monitor aspects. This setting translates into copying the Asset Monitor aspects to all of its object instances, but these instance Asset Monitors will, by default, inherit from the Object Type. Whenever the Object Type gets instantiated, the Asset Monitor for this particular TAG will inherit its information from the Object Type. An instance specific modification of an Asset Monitor aspect coming from an Object Type is still possible by deselecting the Inherit Configuration check box on the specific TAB of the instance BUA000118R4101

117 Section 3 Configuration Asset Monitors Configuration of Asset Monitor Aspects Directly on the Instances (Inheritance from Category) In case there are only a few objects of the same type in a project or there is no object type available, Asset Monitor aspects can be directly added on Object instances in the Control Structure. Add the Asset Monitor aspects to the object and configure the Asset Monitor aspect by deselecting the Inherit Configuration check box and making required customization. Refer to Asset Monitor Tab on page 120 through Logic Tab on page 128 for specific instructions on configuring the items under the various tabs in the Asset Monitor aspect. By deselecting the Inherit Configuration check box the information will not be inherited from the category regardless of whether or not it was edited. It is possible to reselect the Inherit Configuration check box if it is necessary to go back to the original information. The manually edited data will be overwritten. Asset Optimization Asset Monitoring provides the following library of Basic Asset Monitors (refer to Section 4, Basic Asset Monitor Library for descriptions and configuration procedures for each of the Basic Asset Monitors): Bad Quality Check. Bool Check. Flow Delta. Limit Check (High, HighLow, and Low). Running Time Check. XY Profile Deviation. 3BUA000118R

118 Asset Monitors Section 3 Configuration For each Asset Monitor in the library there is a corresponding Asset Monitor Aspect Category as shown in Figure 47. Asset Monitors placed on an Object Type are not considered part of the active configuration. Their definition will not be loaded to the AO Server. TC05031B Figure 47. Asset Monitor Aspect Categories The Config view of each category of Asset Monitor contains the same tabs. They are summarized in Table 11. Table 11. Asset Monitor Config View Tabs Tab Description Configurable 1 All Asset Common to Monitors 2 Asset Monitor Allows selection of the AO Server assignment, Logic Execution Interval, and Asset URL. In Asset Monitor instances the Asset Monitor tab also provides information about Asset Monitor lifecycle such as: Configuration Changed time, Configuration Downloaded time, and Configuration Downloaded AO Server. The Asset Monitor tab also provides an indication of the source of inherited configuration. Yes Yes 118 3BUA000118R4101

119 Section 3 Configuration Asset Monitor Configuration Table 11. Asset Monitor Config View Tabs (Continued) Tab Description Configurable 1 All Asset Common to Monitors 2 Conditions Asset Parameters Input Records Output Records Logic Contains a list of conditions monitored by the logic and a list of subconditions defining each condition. Contains asset specific information needed by the condition assessment logic for execution. Contains asset related measurement records needed by the condition assessment logic for execution, usually pointing to OPC items. Contains Output Records included in the ACD. No Yes Contains monitoring logic definition and Asset Monitor startup parameters. Yes Yes Yes No 3 Yes No No Yes NOTES: 1. No changes will take place until the Asset Monitor is downloaded. 2. The configuration procedures for the tabs that are common to all Asset Monitors are not repeated in Section 4, Basic Asset Monitor Library. 3. The startup parameters of the Logic tab can be set up only in the Aspect System Structure. Refer to Asset Monitor Startup Parameters on page 77 for more information. Asset Monitor Configuration Asset Monitor configuration can be local or inherited from its configuration parent. To customize Asset Monitor configuration (make it local) it may be required to selectively break configuration inheritance on those areas of configuration that need customization. The configuration inheritance source, which can be ascertained by looking at the Asset Monitor tab in the Asset Monitor Config View, shows the source of the inherited configuration for a particular Asset Monitor. The inherited configuration source is automatically selected as follows: The Asset Monitor aspect in Asset Monitor Category object never inherits configuration. 3BUA000118R

120 Asset Monitor Tab Section 3 Configuration Asset Monitor Tab An Asset Monitor aspect in an Object Type always inherits its configuration from the corresponding Asset Monitor Category: Inherits from Asset Monitor category. An Asset Monitors aspect defined in an object instance inherits configuration from either: 1. Corresponding Object Type: if the Asset Monitor was created via selecting the Copy to all instances check box on the Object Type > Type Definition Aspect > Aspect Control tab: Inherits from Object Type's Asset Monitor. 2. Corresponding Asset Monitor Category: if the condition in Step 1 is not met: Inherits from Asset Monitor Category. The source of inherited configuration applies to the entire Asset Monitor Configuration, not just the Asset Monitor tab. Asset Monitor configuration changes do not take effect in the AO Server until the Asset Monitor is explicitly loaded. The first configuration tab in the Asset Monitor Configuration view is the Asset Monitor tab. Figure 48 shows the Asset Monitor tab of the Bool Check Asset Monitor. Figure 48. Asset Monitor Tab TC05009D 120 3BUA000118R4101

121 Section 3 Configuration Asset Monitor Tab The Asset Monitor tab configuration procedure and content is the same for all Asset Monitor categories, although the values entered may differ. This procedure is intended for use when configuring all Asset Monitors. To configure the Asset Monitor tab: 1. Server Assignment frame: a. Configure Server Assignment by selecting AO Server designated to execute the Asset Monitor logic from the Assigned to drop-down list box. If Default is selected, then the AO Server designated to be the default will be used upon configuration load. b. Select the Enable in Server check box to include this Asset Monitor in the next AM Configuration Load to the specified AO Engine. If the Enable in Server check box is deselected then the next AM Configuration Load will remove (if previously loaded) this Asset Monitor from the specified AO Engine. Server Assignment configuration is never inherited from the parent. The AO Server that an Asset Monitor is assigned to is always the same for all Asset Monitors within one object. Upon creation of the new Asset Monitor on the object, the consensus AO Server value is assigned to it. If no other Asset Monitors exist on the object the parent value is copied. When a new Asset Monitor is created via Copy/Paste from the existing aspect, it will always be set to Enable in Server, no matter what this value was in the original aspect. 2. Asset Monitor frame: a. Select the Inherit configuration check box to use the inherited configuration or deselect it to customize the following configuration parameters. Logic Execution Interval: The requested time interval in seconds between subsequent Asset Monitor logic executions in the AO Engine. The execution interval may be longer than the configured one on heavily loaded systems. Asset URL: Address of a web page providing asset relevant information. When this configuration parameter is specified the Diagnostics menu entry is enabled in the Asset Monitor and Asset Reporter views. 3BUA000118R

122 Conditions Tab Section 3 Configuration Conditions Tab Asset Monitor Failure Alarm Severity: The alarm severity used in alarming the abnormal status of an Asset Monitor. b. Click Apply to save the configuration changes. 3. Asset Monitor lifecycle frame: This section provides information about the current configuration state of the Asset Monitor as it relates to the one loaded in the designated AO Server: Configuration Changed: The time when configuration was last changed. Configuration Downloaded at: The time when configuration was last loaded to an AO Server. This field shows <ZERO TIME> if the Asset Monitor configuration is not loaded to an AO Server. Configuration Downloaded to: The AO Server to which the Asset Monitor configuration was last loaded. This field is blank if the Asset Monitor configuration is not loaded to an AO Server. The Conditions tab contains the definition of the condition or conditions that are assessed and reported by the specific Asset Monitor. The main functionality of the Asset Monitor is to monitor the operating parameters of an asset and report the current subcondition for each defined condition. Each condition is defined by a set of subconditions. The subconditions for a given condition are mutually exclusive. Subcondition ENUM 0 always represents the normal condition state. A transition to the normal state will deactivate the associated alarm in the Alarm and Event List. The only subconditions that generate a Fault Report in the Fault Report Submitter are those that are not normal with good quality status. Asset Monitor conditions are defined in the Asset Monitor Category. It is only possible to modify the Condition label by clicking Edit Condition Label next to that Condition label. However, it is possible to customize the SubCondition fields at the Asset Monitor Category, Object Type, and instance level BUA000118R4101

123 Section 3 Configuration Conditions Tab To customize the SubCondition fields of a condition in Asset Monitors, it is necessary to break the selected Condition configuration inheritance by deselecting the Inherit configuration check box. After breaking inheritance (deselecting the Inherit configuration check box) on one condition and modifying its data, first click Apply if it is intended to restore inheritance (select the Inherit configuration check box) on the different condition. This step is necessary to avoid a loss of newly edited data on the first condition. Figure 49 shows the Conditions tab of the Bool Check Asset Monitor with the Inherit configuration check box selected. Figure 49. Conditions Tab TC05024D For each condition, the columns used to define its subconditions are defined as follows: ENUM: Integer that uniquely identifies the subcondition to the Asset Monitor logic. This field can not be customized. SubCondition: Subcondition name. Description: Subcondition description. Severity: Subcondition severity. This is also used when notifying the Alarm and Event List of a transition to this subcondition. 3BUA000118R

124 Asset Parameters Tab Section 3 Configuration Asset Parameters Tab CorrectiveActionTaken: The Asset Monitor may report an action that was taken by the system to reduce the effect of this state (e.g. emergency shutdown initiated). Possible Cause: Reports the diagnosis leading to this state (e.g. high vibration). Suggested Action: Provides hints on how to react (e.g. schedule maintenance). Advanced Asset Monitors may dynamically provide the content of the subcondition fields and override user configured defaults. It is possible to define configuration macros for the conditions definition. Refer to Asset Monitor Configuration Macros on page 134 for more information. The Asset Parameters tab contains configuration parameters used to provide additional asset information required by the Asset Monitor algorithm. Refer to the specific Asset Monitor in Section 4, Basic Asset Monitor Library for more information. It is possible to define configuration macros for the Asset Parameter values. Refer to Asset Monitor Configuration Macros on page 134 for more information. Asset Monitor Asset Parameters are defined by the Asset Monitor category. However, it is possible to customize those parameter values at the Asset Monitor Category, Object Type, and instance level. To customize Asset Parameter values in Asset Monitors, it is necessary to break the Asset Parameters configuration inheritance by deselecting the Inherit configuration check box. Figure 50 shows the Asset Parameters tab of the Bool Check Asset Monitor with the Inherit configuration check box selected BUA000118R4101

125 Section 3 Configuration Asset Parameters Tab TC05025D Figure 50. Asset Parameters Tab 3BUA000118R

126 Input Records Tab Section 3 Configuration Input Records Tab The Input Records tab contains the definition of data items (i.e. OPC items) used by the Asset Monitor to assess the current asset condition. Figure 51 shows the Input Records tab of the Bool Check Asset Monitor. Figure 51. Input Records Tab TC05038D Asset Monitor Input Records are defined by the Asset Monitor category. However, it is possible to customize such Input Records Data Source Aspect and Data Source Item at the Asset Monitor Category, Object Type, and instance level. To customize Input Records in Asset Monitors it is necessary to break the Input Records configuration inheritance by deselecting the Inherit configuration check box. The columns in the Input Records tab are the same for all Asset Monitors and are defined as follows: ID: Input Record indentifier. Description: Input Record description. Units: Input record expected engineering units. Discrete: Boolean value. True indicates that this Input Record value should be graphed using a stair step plot as opposed to using a point interpolation BUA000118R4101

127 Section 3 Configuration Input Records Tab Data Source Aspect: Provides a pick list to select one of the available Asset Monitor Data Sources defining the data server (i.e. OPC server) from which to read the value. If Default is selected, then the Asset Monitor Data Source designated as the default will be selected upon configuration download to the Asset Monitoring Server. Multiple Asset Monitor Data Sources can be configured to point to the same OPC Server. Each Asset Monitor Data Source can have a different OPC Group Update Rate to optimize the load on the subsystem from which the data originates. Asset Monitor Data Source aspects are usually located in the Asset Optimization Object. Data Source Item: Identifies the item (i.e. OPC item ID) in the data server from which to read the value. If the Asset Monitor Data Source aspect points to the ABB.AfwOpcDaSurrogate, the Data Source Item can be selected with the aid of the PPA Object Properties Browser. Click Open Properties Browser to open the PPA Object Properties Browser similar to the one shown in Figure 52. Figure 52. PPA Object Properties Browser TC05352A 3BUA000118R

128 Output Records Tab Section 3 Configuration Output Records Tab To use the Object Properties Browser: 1. Navigate to the PPA Object containing the property that needs to be associated to the input record. 2. Select the aspect containing the property. 3. Browse the Aspect Properties in the bottom right frame and select the desired property. 4. Copy the name of the property from the PPA Object Properties Browser into the Data Source Item of the appropriate Input Record. By default the PPA Properties Browser provides a property name preceded by the fully qualified object name. If the property resides in the same object as the Asset Monitor, it is possible to replace the object name with%id%. Refer to Asset Monitor Configuration Macros on page 134 for more information. The Output Records tab has no configurable values. It is for information only and shows the Output Records, if any, that will be included in an ACD. Output Records usually contain logic calculated values such as accumulated runtime and other defining information for the asset condition. Output Record values are published in the object where the Asset Monitor resides via the AssetMonitorProperties Control Connection aspect. Logic Tab The Logic tab has no configurable values in the Primary Structures. It shows the monitoring logic definition and the Asset Monitor startup parameters. The startup parameters of the Logic tab can be customized only in the selected Asset Monitor category object in the Aspect System Structure. Refer to Asset Monitor Startup Parameters on page 77 for more information. Asset Monitor Bulk Data Manager Support Asset Monitors can be Added/Deleted/Modified using the Bulk Data Manager (BDM) 800xA engineering Excel add-in BUA000118R4101

129 Section 3 Configuration Asset Monitor Bulk Data Manager Support When an Asset Monitor aspect is dragged into a BDM enabled Excel spreadsheet a pick list will expose all of the Asset Monitor configuration properties. Asset Monitors of different categories may have a different set of configuration properties for Conditions, Asset Parameters, Input Records, and Output Records. Figure 53 shows a sample of Configuration properties for a Bool Check Asset Monitor. Select the Hide write-protected properties option to only show updatable configuration properties. If invalid values or values for Read-only fields are entered, BDM will not apply such values to the referenced Asset Monitor upon configuration save. Furthermore, an error message will be displayed in the Errors worksheet of Excel. TC08114A Figure 53. Bulk Data Manager Configuration Properties Example 3BUA000118R

130 Asset Monitor Tab Data Section 3 Configuration Asset Monitor Tab Data The fields listed in Table 12, which represent properties in the Asset Monitor tab of the Asset Monitor aspect Config View are enabled in BDM. Table 12. Asset Monitor Tab BDM Properties Property Name Notes Access AOServer This field contains one of the following strings: The name of an AO Server formatted as ObjectName:Aspect Name (e.g. AO Server1:Asset Optimization Server) The string Default to reference the AO Server designated as the default in the system. R/W OnLine Enable in Server. Values: True, False R/W ConfigurationParent Inherited configuration source R AssetMonitorInheritFromParent Inherit configuration switch. Values: True, False R/W AlarmSeverity Range: integer 1 to 1000 R/(W) 1 LogicExecutionIntervalSec Logic Execution Interval in seconds. Range: integer greater or equal to 1 R/(W) 1 AssetMonitorURL Asset Monitor URL String R/(W) 1 NOTE: 1. This field is read only if AssetMonitorInheritFromParent is True. Conditions Tab Data The fields listed in Table 13, which represent properties in the Conditions tab of the Asset Monitor aspect Config View are enabled in BDM. Table 13. Conditions Tab BDM Properties Property Name Notes Access <ConditionName>.InheritFromParent Inherit configuration switch. Values: True, False R/W 130 3BUA000118R4101

131 Section 3 Configuration Asset Parameters Tab Data Table 13. Conditions Tab BDM Properties (Continued) Property Name Notes Access <ConditionName>. <SubConditionEnum>.SubCondition <ConditionName>. <SubConditionEnum>.Description <ConditionName>. <SubConditionEnum>.PossibleCause <ConditionName>. <SubConditionEnum>.SuggestedAction <ConditionName>. <SubConditionEnum>.CorrectiveActionTaken <ConditionName>. <SubConditionEnum>.Severity NOTE: 1. This field is read only if <ConditionName>.InheritFromParent is True. Asset Parameters Tab Data SubCondition Names must be unique within a Condition and not empty. R/(W) 1 SubCondition Description string R/(W) 1 SubCondition PossibleCause string R/(W) 1 SubCondition SuggestedAction string R/(W) 1 SubCondition CorrectiveActionTaken string SubCondition Severity. Range: integer 1 to 1000 There can be one or more Conditions defined in an Asset Monitor. Each Condition can have two or more SubConditions defined. R/(W) 1 R/(W) 1 The fields listed in Table 14, which represent properties in the Asset Parameters tab of the Asset Monitor aspect Config View are enabled in BDM. Table 14. Asset Parameters Tab BDM Properties Property Name Notes Access AssetParamsInheritFromParent Inherit configuration switch. Values: True, False AssetParams.<AssetParam Name> Asset Parameter string Value R/(W) 1 NOTE: 1. This field is read only if AssetParamsInheritFromParent is True. R/W 3BUA000118R

132 Input Records Tab Data Section 3 Configuration There can be zero or more Asset Parameters defined in an Asset Monitor. Input Records Tab Data The fields listed in Table 15, which represent properties in the Input Records tab of the Asset Monitor aspect Config View are enabled in BDM. Table 15. Input Records Tab BDM Properties Property Name Notes Access InputRecords.InheritConfiguration Inherit configuration switch. Values: True, False R/W InputRecords. <InputRecordName>.DataSource InputRecords. <InputRecordName>.DataItemID This field contains one of the following strings: R/(W) 1 The name of an Asset Monitor Data Source formatted as ObjectName:Aspect Name (e.g. Asset Optimization:Afw OPC-DA Asset Monitor Data Source) The string Default to reference the Asset Monitor Data Source designated as the Default in the system. The string None for unused optional Input Records. Data Item ID string R/(W) 1 NOTE: 1. This field is read only if InputRecords.InheritConfiguration is True. There can be zero or more Input Records defined in an Asset Monitor. Loading a Single Asset Monitor It is possible to incrementally load a single Asset Monitor from its aspect context menu. This action will perform exactly the same operation as selecting a single asset monitor from the Asset Monitors tab in the Asset Optimization Server aspect (refer to Loading Asset Monitor Configurations to an AO Server on page BUA000118R4101

133 Section 3 Configuration Loading a Single Asset Monitor 1. Right-click on the Asset Monitor Aspect in the Aspect List Area and select Load AM Configuration from the context menu that appears as shown in Figure 54. Figure 54. Load AM Configuration TC07795B 3BUA000118R

134 Asset Monitor Configuration Macros Section 3 Configuration 2. If the configuration of the Asset Monitor has not changed since the previous load, the message stating that the configuration is up to date appears. If the user chooses to continue, the selected Asset Monitor s configuration (the same as currently loaded) will be reloaded to the AO Server. Click Continue to load or Abort to quit. 3. If the configuration of the Asset Monitor has changed (excluding AO Server field) since the previous load, a message stating that the Asset Monitor will be updated appears. If the user chooses to continue, the selected Asset Monitor s new configuration will be reloaded to the AO Server. Click Continue to load or Abort to quit. 4. If the configuration of the Asset Monitor has changed, including AO Server, since the previous load a message stating that the Asset Monitor will be removed from one AO Server and added to the another AO Server appears. If the user chooses to continue, the selected Asset Monitor s new configuration, as well as all other enabled Asset Monitor aspects on the object, will be reloaded to the AO Server. Click Continue to load or Abort to quit. 5. If the Asset Monitor has been disabled since the previous load a message stating that the Asset Monitor will be removed appears. If the user chooses to continue, the selected Asset Monitor will be removed from the AO Server. Click Continue to remove the Asset Monitor or Abort to quit. 6. When the operation is complete, a message stating that the configuration has been activated appears. Click OK to continue. 7. The Configuration Loaded information will be updated for the Asset Monitor aspect as shown in Figure 55. Figure 55. Configuration Downloaded Information TC07801A Asset Monitor Configuration Macros Asset Monitor Configuration macros can be used when configuring Asset Monitors. They provide parametric configuration capabilities that are useful when designing Object Types BUA000118R4101

135 Section 3 Configuration Asset Monitor Configuration Macros Macros are strings delimited by the % character that can be used in the following fields during Asset Monitor Configuration: Conditions definition (Conditions Tab). Asset Parameter Values (Asset Parameters Tab). Input Records Data Source Items (Input Records Tab). Macros contain the name of the 800xA System object property whose value is substituted in their place upon configuration download to the Asset Monitoring Server Engine. The following are examples of possible macro syntax: %<PropertyName>%, example: %HighLow Limit Check.ProcessValue% %<ObjectName>:<PropertyName>%, example: %AMTestObject1:HighLow Limit Check.ProcessValue% %:<AspectName>:<PropertyName>%, example: %:General Properties:HighLow Limit Check.ProcessValue% %<ObjectName>:<AspectName>:<PropertyName>%, example: %AMTestObject1:General Properties:HighLow Limit Check.ProcessValue% %<qualifiedobjectname>:<propertyname>%, example: %[Control Structure]Asset Monitoring Server/AMTestObject1:General Properties:HighLow Limit Check.ProcessValue% %ID%/[Structure Name]ChildObjectName:AspectName:PropertyName {54816BAA-D371-4D55-9DEC-D3E44643EA92}/[Control Structure]child1:GeneralProerties:CHILDPROPERTY where: <ObjectName> is a placeholder for the name of a specific object in the system. <AspectName> is a placeholder for the name of a specific aspect in the system. <PropertyName> is a placeholder for a specific property in the system. 3BUA000118R

136 Asset Condition Reporting Section 3 Configuration %ID% (where %ID% is a special macro that returns the 800xA System object Global Unique Identifier (GUID) on which the Asset Monitor resides). The following are examples of possible macros: 1. %Name% or %:Name:Name% - returns the object name on which the Asset Monitor resides. 2. %ID%:PV - returns {69E932E D86-B235-DB A}:PV %ID% can be used in place of the 800xA System object name when specifying OPC items in the 800xA System OPC server. Asset Condition Reporting Asset Optimization provides asset condition reporting and monitoring status via the Asset Viewer, Asset Reporter, Fault Report Viewer (refer to Industrial IT 800xA - Asset Optimization Operation for information on the Fault Report Viewer), and the items accessible through their context menus. Asset Reporter Status reporting to a parent object in the Asset Tree is not refreshed if a child object with a severity level is deleted. The Asset Reporter must be added to each object that requires an Asset Tree indicator in the Asset Viewer. The information in the Asset Reporter represents composite severity of an object and all children beneath it for the current structure. Therefore, the Asset Reporter must be added to each object in the current structure if it is desired to propagate the information up from the children to the parents. If the chain is broken, the information will only be propagated up to the last object for which there is an Asset Reporter. 1. Use the Structure Selector to open a Primary Structure. 2. Use the Object Browser to navigate to the desired object. 3. Right-click on the object and select New Aspect... from the context menu that appears BUA000118R4101

137 Section 3 Configuration Asset Viewer 4. The New Aspect dialog appears. Navigate to and select Asset Reporter from the list that appears to produce the view shown in Figure Click Create. Asset Viewer TC04714C Figure 56. New Aspect Dialog (Asset Reporter) 6. Repeat the procedure for each object that requires an Asset Reporter. 7. No further action is required to configure the Asset Reporter. The Asset Viewer, when added to an object, allows the Asset Tree to be displayed. When displayed, the Asset Tree shows the condition of that object and all its children. 1. Use the Structure Selector to open a Primary Structure. 2. Use the Object Browser to navigate to the desired object. 3. Right-click on the object and select New Aspect... from the context menu that appears. 3BUA000118R

138 Maximo Integration Section 3 Configuration 4. The New Aspect dialog appears. Navigate to and select Asset Viewer from the list that appears to produce the view shown in Figure Click Create. Figure 57. New Aspect Dialog (Asset Viewer) 6. Repeat the procedure for each object that requires an Asset Viewer. 7. No further action is required to configure the Asset Viewer. Maximo Integration TC04715C In order to make CMMS Connectivity operational, it is necessary to perform the following procedures: Mapping the 800xA System Object to the Maximo Equipment. CMMS Views. Mapping the 800xA System Object to the Maximo Equipment The Maximo Equipment ID provides information for mapping the 800xA System object to the Maximo equipment in the CMMS database for a particular Maximo Server. Multiple Maximo Equipment IDs can be associated with the same asset, thus providing the ability to map to more than one piece of equipment defined in Maximo BUA000118R4101

139 Section 3 Configuration Mapping the 800xA System Object to the Maximo Equipment 1. Use the Object Browser to navigate to an asset that requires a Maximo Equipment ID. 2. Right-click on the asset and select New Aspect... from the context menu that appears. 3. The New Aspect dialog appears. Navigate to and select Maximo Equipment ID from the list that appears to produce the view shown in Figure Click Create. TC04869C Figure 58. New Aspect Dialog (Maximo Equipment ID) 3BUA000118R

140 Mapping the 800xA System Object to the Maximo Equipment Section 3 Configuration 5. Right-click on the asset and select Maximo Equipment ID from the context menu that appears. This opens the Maximo Equipment ID like the one shown in Figure 59. The items in the CMMS Information frame are grayed out and cannot be changed in this structure. For descriptions of, and the procedure to change this information, refer to Maximo Server Connection Properties on page 80. Figure 59. Maximo Equipment ID TC04849C 6. If the Primary Structure was set up so that the asset name matches the Equipment Number in the Maximo Server, leave the Equipment: field as it is. If the asset name does not match the Equipment Number in the Maximo Server, deselect the Use Default Asset Name check box and change the Equipment: field to match the Equipment ID in the Maximo Server. 7. If changes were made in Step 6, click Apply. 8. Repeat the procedure for each asset that requires a Maximo Equipment ID BUA000118R4101

141 Section 3 Configuration CMMS Views CMMS Views The CMMS Views consist of (refer to Seamless Interaction Between Process, Maintenance, and Calibration on page 46 for descriptions of each of these views): View Active Work Orders. View Work Order History. View Equipment Status. View Preventive Maintenance Schedule. View Spare Parts/View Availability of Spare Parts. The Fault Report Submitter, which is part of the Asset Optimization Server system extension, makes it possible to submit Fault Reports to the Maximo and DMS systems. These aspects can be added to Object Types. This allows objects to be created with these aspects already added. Refer to the appropriate Industrial IT 800xA documentation for information on creating Object Types. Before any CMMS Views are added to a particular object, all of the views are available in the list in the New Aspect dialog. Each time one of these views is added to the particular asset, it is removed from the list. This ensures that the same view is not added to a single asset more than once. The procedure for adding all CMMS Views is the same. The following steps tell how to add the views. 1. Use the Object Browser to navigate to an asset that requires one of the CMMS Views. 2. Right-click on the asset and select New Aspect... from the context menu that appears. 3BUA000118R

142 SAP/PM Integration Section 3 Configuration 3. The New Aspect dialog appears. Navigate to and expand CMMS Views and all the items underneath it from the list that appears to produce the view shown in Figure Select the desired view and click Create. Figure 60. New Aspect Dialog (CMMS Views) 5. Repeat Step 2 through Step 4 for each view that is required for the selected asset. 6. Repeat Step 1 through Step 5 for each asset that requires these views. 7. No further action is required to configure the selected views. Refer to Industrial IT 800xA - Asset Optimization Operation for information on the operational capabilities of the CMMS Views. SAP/PM Integration TC04863B In order to make CMMS Connectivity operational, it is necessary to perform the following procedures: Mapping the 800xA System Object to the SAP/PM Equipment. CMMS Views BUA000118R4101

143 Section 3 Configuration Mapping the 800xA System Object to the SAP/PM Equipment Mapping the 800xA System Object to the SAP/PM Equipment The SAP Equipment ID provides information for mapping the 800xA System object to the SAP/PM equipment in the CMMS database for a particular SAP/PM Server. Multiple SAP Equipment IDs can be associated with the same asset, thus providing the ability to map to more than one piece of equipment defined in SAP/PM. 1. Use the Object Browser to navigate to an asset that requires a SAP Equipment ID. 2. Right-click on the asset and select New Aspect... from the context menu that appears. 3. The New Aspect dialog appears. Navigate to and select SAP Equipment ID from the list that appears. 4. Click Create. 5. Right-click on the asset and select SAP Equipment ID from the context menu that appears. This opens the SAP Equipment ID like the one shown in Figure 61. The items in the CMMS Information frame are grayed out and cannot be changed in this structure. For descriptions of, and the procedure to change this information, refer to SAP/PM Server Connection Properties on page 86. Figure 61. SAP Equipment ID TC06092A 3BUA000118R

144 CMMS Views Section 3 Configuration CMMS Views 6. If the Primary Structure was set up so that the asset name matches the Equipment Number in the SAP/PM Server, leave the Equipment: field as it is. If the asset name does not match the Equipment Number in the SAP/PM Server, deselect the Use Default Asset Name check box and change the Equipment: field to match the Equipment ID in the SAP/PM Server. 7. If changes were made in Step 6, click Apply. 8. Repeat the procedure for each asset that requires a SAP Equipment ID. The CMMS Views consist of (refer to SAP/PM Integration on page 56 for descriptions of each of these views): View Active Work Orders. View Work Order History. View Equipment Status. View Preventive Maintenance Schedule. The Fault Report Submitter, which is part of the Asset Optimization Server system extension, makes it possible to submit Fault Reports to the SAP/PM and DMS systems. These aspects can be added to Object Types. This allows objects to be created with these aspects already added. Refer to the appropriate Industrial IT 800xA documentation for information on creating Object Types. Before any CMMS Views are added to a particular object, all of the views are available in the list in the New Aspect dialog. Each time one of these views is added to the particular asset, it is removed from the list. This ensures that the same view is not added to a single asset more than once. The procedure for adding all CMMS Views is the same. The following steps tell how to add the views. 1. Use the Object Browser to navigate to an asset that requires one of the CMMS Views. 2. Right-click on the asset and select New Aspect... from the context menu that appears BUA000118R4101

145 Section 3 Configuration DMS Calibration Integration 3. The New Aspect dialog appears. Navigate to and expand CMMS Views and all the items underneath it from the list that appears to produce the view shown in Figure Select the desired view and click Create. Figure 62. New Aspect Dialog (CMMS Views) 5. Repeat Step 2 through Step 4 for each view that is required for the selected asset. 6. Repeat Step 1 through Step 5 for each asset that requires these views. 7. No further action is required to configure the selected views. Refer to Industrial IT 800xA - Asset Optimization Operation for information on the operational capabilities of the CMMS Views. DMS Calibration Integration TC04863B Configuring DMS Calibration Integration includes: Creating the DMS HART Device Object Structure. Configuration Scenarios. 3BUA000118R

146 Creating the DMS HART Device Object Structure Section 3 Configuration Synchronizing 800xA System DMS Division with DMS System DMS Division. Notifying 800xA System Users that Calibration is Due. Additional DMS Calibration Integration Configuration Considerations. Creating the DMS HART Device Object Structure The selected 800xA System structure must be populated with objects representing the devices after the DMS Division is set up (refer to Managing the Connection Between the 800xA System and the DMS System on page 102). Copying and pasting 800xA System objects containing DMS aspects are not linked to objects in the DMS system. Make sure to rename the pasted object before synchronizing if another object with the same name exists in the DMS Division. To properly copy and paste 800xA System objects containing DMS aspects: 1. Copy and paste the object. 2. Rename the pasted object. 3. Perform a PPA DMS Sync (refer to Synchronizing 800xA System DMS Division with DMS System DMS Division on page 156) An 800xA System object must contain, at a minimum, the following aspects in order for it to represent a DMS HART device: DMS. DMS Asset Monitor. Calibration Event List. Parameter Mapping. To point a Parameter Mapping property to the value of a different 800xA System property, use macro expressions such as %name%. Refer to Asset Monitor Configuration Macros on page 134 for more information. Additionally, this 800xA System object must: Be in the structure identified in the DMS Division aspect configuration view BUA000118R4101

147 Section 3 Configuration Configuration Scenarios Be a descendant in the structure of the object containing the DMS Division aspect. When the DMS aspect is created, it will attempt to create a corresponding object in the DMS system. If for any reason creation of the DMS device fails, the DMS aspect will be unmapped until a manual synchronization is performed (refer to Synchronizing 800xA System DMS Division with DMS System DMS Division on page 156). Configuration Scenarios There are two supported configuration scenarios. Configuration procedures differ depending on the scenario. Configuration Scenario A - HART Device Integration System Extension Installed, Devices Connected via Hart Capable I/O The HART Device Integration system extension provides Object Types used to instantiate different kinds of HART devices in the configuration. These Object Types are preconfigured with the aspects required for DMS Calibration Integration (DMS, DMS Asset Monitor, and Parameter Mapping). Since HART capable I/O is used, up-to-date information is available in the 800xA System objects via the Device Management (DTM)/Fieldbus Management aspects. This device configuration is then used to update the DMS system. DMS aspect configuration is set to Process Portal A owns configuration. To configure DMS Calibration Integration under Configuration Scenario A: 1. Use the Object Browser to navigate to the desired place in the structure to add a new HART Device Object Type. 2. Right-click and select New Object... from the context menu that appears. 3. The New Object dialog appears. Navigate to and expand Field Devices. 4. Expand the desired group beneath Field Devices and select the desired Object Type. 3BUA000118R

148 Configuration Scenarios Section 3 Configuration 5. Fill in the Name field, and click Create. Never delete devices created in the 800xA System from the DMS client (this would create orphans). if it is necessary to delete devices from the DMS system only, it must be done by deleting the DMS aspect for the corresponding device in the 800xA System. 6. Refer to the proper appendix in this instruction and configure the new HART device. 7. Select DMS in the Aspect List Area. This produces the Main View in the Preview Area. The View Selector menu has three options: DMS Config View, Main View, and Config View. Refer to Meriam Process Technologies Device Management System User s Guide for information on the DMS Config View and Main View. 8. Use the View Selector to select Config View to produce the DMS Config View shown in Figure 63. The Config View allows you to specify whether the device configuration data resides in the DMS system or if it is stored in the Process Portal A (800xA System) object (Figure 64). Figure 63. DMS Config View TC05357A 9. Verify that the Process Portal A owns configuration check box is checked. This check box should be checked when: The object contains a Device Management aspect (the DTM) with up-todate device configuration data, as is the case in this configuration scenario. Up-to-date device configuration data is stored in the Parameter Mapping aspect BUA000118R4101

149 Section 3 Configuration Configuration Scenarios TC07822A Figure 64. Parameter Mapping with Process Portal A Owns Configuration Selected Up-to-date device configuration data is stored in the 800xA System properties referenced by the Parameter Mapping aspect via macro definition. The check box is not checked for conventional 4-20 ma devices or when the devices are not connected via HART capable I/O. For those cases, the DMS system downloads the device configuration data automatically for conventional 4-20 ma devices and owns all of the device configuration data. 10. Select DMS Asset Monitor in the Aspect List Area. This produces the Main View in the Preview Area. The Main View shows the current calibration status. 11. Use the View Selector to select Config View. 3BUA000118R

150 Configuration Scenarios Section 3 Configuration 12. No configuration is needed; however: a. If necessary, it is possible to change the Monitoring Server for the DMS Asset Monitor aspect (refer to Figure 65). The logic scan interval is not used for the DMS Asset Monitor as the information is being provided by the DMS server. Figure 65. DMS Asset Monitor Aspect TC07824B 150 3BUA000118R4101

151 Section 3 Configuration Configuration Scenarios b. It is possible to customize the text generated by a calibration alarm (e.g. override the SuggestedAction field). To do so, select the Conditions tab to produce the view shown in Figure 66, click in the desired field, and change the text. Figure 66. DMS Asset Monitor Config View TC05358B 13. Click Apply when complete. 14. It is required to incrementally or fully download the DMS Asset Monitors for the configuration changes to become active. At this point in the procedure, the DMS aspect is initialized with a generic configuration. 15. Update the device data in the 800xA System object to reflect the actual device configuration. Use the Fieldbus Management aspect to perform an upload or download as required. The Device Management aspect will now contain up-todate information. 16. Refer to and complete the procedure under Updating DMS System Objects with 800xA System Object Device Data on page 155. Configuration Scenario B - HART Device Integration System Extension not Installed, Devices Connected via non-hart Capable I/O, or Conventional Devices In this configuration scenario, there is no electronic mechanism to update the device data in the 800xA System object. Therefore, the Process Portal A owns 3BUA000118R

152 Configuration Scenarios Section 3 Configuration configuration check box is not checked in the DMS aspect Config View. Device data must be entered in the DMS system via the DMS aspect. To configure DMS Calibration Integration under Configuration Scenario B: 1. Create an 800xA object representing the chosen Object Type. 2. Use the Object Browser to navigate to the desired place in the structure to add the new object. 3. Right-click and select New Object... from the context menu that appears. 4. The New Object dialog appears. Navigate to and select the new object. 5. Fill in the Name field, and click Create. When creating an object type for Conventional 4-20 ma devices, the Parameter Mapping aspect must be created and configured. The MODELNAME and MODELREV fields must be configured. Refer to Figure 68 for more information. 6. If the required DMS aspects are not defined in the Object Type, they must be manually created on the object. To do so, perform Step 7 through Step 23. If they are defined in the Object Type, skip to and perform Step 15 through Step Use the Object Browser to navigate to the new object. 8. Right-click on the object and select New Aspect... from the context menu that appears. 9. The New Aspect dialog appears. Navigate to and select DMS from the list that appears. 10. Click Create. 11. Use the Object Browser to navigate to the new object. 12. Right-click on the object and select New Aspect... from the context menu that appears. 13. The New Aspect dialog appears. Navigate to select DMS Asset Monitor from the list that appears BUA000118R4101

153 Section 3 Configuration Configuration Scenarios 14. Click Create. Never delete the devices created in DMS as a result of 800xA System operation from the DMS Client. If it is necessary to delete these devices in the DMS Client, this must be done by deleting the DMS aspect in the 800xA System. 15. Select DMS in the Aspect List Area. This produces the Main View in the Preview Area. The View Selector menu has three options: DMS Config View, Main View, and Config View. Refer to Meriam Process Technologies Device Management System User s Guide for information on the DMS Config View and Main View. 16. Use the View Selector to select Config View to produce the DMS Config View shown in Figure 67. The Config View allows you to specify whether the device configuration data resides in the DMS (Figure 68) system or if it is stored in the Process Portal A (800xA System) object. Figure 67. DMS Config View TC05362A TC07823A Figure 68. Parameter Mapping with Process Portal A Owns Configuration Deselected 3BUA000118R

154 Configuration Scenarios Section 3 Configuration 17. Deselect the Process Portal A owns configuration check box. The check box is not selected for conventional 4-20 ma devices. The DMS system downloads the device configuration data automatically for conventional 4-20 ma devices and owns all of the device configuration data. 18. Select DMS Asset Monitor in the Aspect List Area. This produces the Main View in the Preview Area. The Main View shows the current calibration status. 19. Use the View Selector to select Config View. 20. No configuration is needed; however: a. If necessary, it is possible to change the Monitoring Server for the DMS Asset Monitor aspect (refer to Figure 65). The logic scan interval is not used for the DMS Asset Monitor as the information is being provided by the DMS server. Figure 69. DMS Asset Monitor Aspect TC08115A 154 3BUA000118R4101

155 Section 3 Configuration Updating DMS System Objects with 800xA System Object Device Data b. It is possible to customize the text generated by a calibration alarm (e.g. override the SuggestedAction field). To do so, select the Conditions tab to produce the view shown in Figure 66, click in the desired field, and change the text. Figure 70. DMS Asset Monitor Config View TC08116A 21. Click Apply when complete. 22. Before configuration changes take effect, it is necessary to download the DMS Asset Monitor for this Object. At this point in the procedure, the DMS aspect is initialized with a generic configuration. 23. Update the device data in the DMS system via the DMS aspect. Updating DMS System Objects with 800xA System Object Device Data DMS model synchronization applies only when the DMS aspect configuration is set to Process Portal A owns configuration. This allows synchronization of the 800xA System configuration with the DMS system or vice versa, depending on whether the 800xA System configuration was performed first or if the DMS system configuration was performed first. Perform this step only after DTM has been uploaded with the configuration data. The data updated in the DMS system is: LAST_CONFIG_DATE. 3BUA000118R

156 Synchronizing 800xA System DMS Division with DMS System DMS Division Section 3 DEVICEID. MANUFACTURERID. DEVICETYPEID. DEVICEREV. DMS model synchronization is also triggered when a device is added to the Action List. There are two ways to perform the DMS model synchronization. It can be done on an individual object, or it can be done on every object under a specific DMS Division. To perform DMS model synchronization on an individual object: 1. Use the Object Browser to navigate to and select the desired object. 2. Navigate to and select the DMS aspect for that object in the Aspect List Area. 3. Right-click the DMS aspect and select Synchronize DMS model from the context menu that appears. To perform DMS model synchronization on every object under a specific DMS Division: 1. Navigate to and select the DMS Division aspect in the Aspect List Area. 2. Right-click the DMS Division aspect and select Synchronize DMS models for this division from the context menu that appears. Synchronizing 800xA System DMS Division with DMS System DMS Division This procedure is not usually necessary. If the DMS system is online during 800xA System configuration, the DMS system to 800xA System object links are automatically established when each new DMS aspect is created. The cases that this procedure applies to are: The DMS system was not installed/configured during 800xA System configuration. Synchronization is necessary with a DMS system that already exists. Error messages were received during Device/Division creation. AoWebServerNode has not changed properly. If synchronization is necessary: 1. Navigate to the DMS Division aspect BUA000118R4101

157 Section 3 Configuration Notifying 800xA System Users that Calibration is Due 2. Use the View Selector to select Config View. a. Click PPA DMS Sync to create a corresponding object in the DMS system based on the 800xA System configuration. If objects with the same name are found, a link to the existing object is established. b. Click DMS PPA Sync to link existing DMS objects to 800xA objects having the same name. Notifying 800xA System Users that Calibration is Due DMS Calibration Integration provides a mechanism to notify 800xA System users that a device requires calibration. These alarms are generated according to the configuration that resides in the DMS system. By default, once a day these alarm are synchronized with the 800xA System, so they are seamlessly integrated with the 800xA Alarm and Event system. Use the Scheduled Tasks feature in Windows Control Panel to change the default. Alarm synchronization can also be performed on demand. Refer to Meriam Process Technologies Device Management System User s Guide for detailed information. Additional DMS Calibration Integration Configuration Considerations Authentication Refer to Meriam Process Technologies Device Management System User s Guide and perform these additional DMS system configuration activities in order to have a fully operational system: Add Action Lists. Add calibration procedures. Assign calibration procedure to devices. Set calibration schedule. Register DPCs. etc. To configure authentication, refer to the appropriate 800xA System documentation to enable logover features. 3BUA000118R

158 Authentication for the AO Server Section 3 Configuration Authentication for the AO Server 1. Use the Structure Selector to open the Aspect System Structure. 2. Navigate to Asset Optimization Server object and enable appropriate authentication for all the required operations as shown in Figure 71. Figure 71. Enabling Authentication Authentication for the Asset Monitor Aspect TC07825B For the Asset Optimization Aspect Category, never enable the Re- Authentication Required and Double Authentication Required check boxes in the aspect Category definition aspect shown in Figure 72. Use the Apply Configuration Changes option instead (Figure 71). 1. Use the Structure Selector to open the Aspect System Structure. 2. Navigate to the Asset Monitor aspect for which it is desired to enable Authentication. 3. Make sure Authentication is not checked on the Aspect Category Definition. Asset Monitors use custom authentication configuration BUA000118R4101

159 Section 3 Configuration Authentication for the Asset Monitor Aspect Figure 72. Asset Optimization Server Aspect Category Definition TC07826A 3BUA000118R

160 Authentication for the Asset Monitor Aspect Section 3 Configuration 4. Create a new Authenticate Config Aspect (Figure 73). TC07827A Figure 73. New Aspect Dialog (Authenticate Config Aspect) 5. Enable appropriate authentication for all the required operations (Figure 74). Figure 74. Authenticate Config Aspect (Asset Monitor) TC07828A For all Asset Monitor aspect categories, never enable Re-Authentication Required and Double Authentication Required in the aspect Category definition aspect shown in Figure 72. Use the Apply Configuration Changes option instead (Figure 74) BUA000118R4101

161 Section 3 Configuration Authentication for the DMS Division Authentication for the DMS Division 1. Use the Structure Selector to open the Aspect System Structure. 2. Navigate to the DMS Division Object. 3. Enable appropriate authentication for all the required operations (Figure 75). Figure 75. Authenticate Config Aspect (DMS Division) TC07829A 4. For the DMS Division aspect category, if desired, enable the Re- Authentication Required and Double Authentication Required check boxes in the aspect Category definition aspect as shown in Figure 76. Figure 76. DMS Division Aspect Category Definition TC07830A 3BUA000118R

162 Alarm Grouping Section 3 Configuration Alarm Grouping When the actions configured for authentication are attempted, a dialog will appear asking for the required user names and passwords. Alarm and Event Lists are part of the base 800xA System and are added to objects when building the various structures. Building the various structures in the 800xA System is beyond the scope of this instruction. Refer to the appropriate Industrial IT 800xA documentation for detailed information on the various 800xA System structures. The Alarm and Event Lists are used to group alarm points together. They define the group of events being sent to the same group of people. For ease of use, take advantage of the defined structures to group the assets. All child objects in the structure can be defined as being included. Operators can view Alarm and Event Lists according to the selected filter and presentation settings. These settings can be changed. For example, a list can be sorted by clicking on a column header, resizing columns, or moving them by using drag and drop. Filtering and presentation functions allow alarms to be viewed in dedicated ways. For example, a list can be configured to show all alarms or only those alarms relevant for the associated object and its descendents. Acknowledging and silencing alarms can be done within a list, for one or more selected alarms, or for multiple alarms per page or entire lists. Object alarms can be acknowledged through process graphics displays. Refer to Industrial IT 800xA - Asset Optimization Operation, and other appropriate 800xA System documentation for more information on acknowledging alarms. Up to 1,000 priorities can be defined with acknowledge and unacknowledged colors. To configure an Alarm and Event List: 1. Use the Object Browser to navigate to an object with an Alarm and Event List to configure. 2. Select Alarm and Event List in the Aspect List Area BUA000118R4101

163 Section 3 Configuration Alarm Grouping 3. Click the View Configuration button as shown in Figure 77 and the Alarm and Event List Configuration dialog shown in Figure 78 appears. VIEW CONFIGURATION T05051B Figure 77. View Configuration Figure 78. Alarm and Event List Configuration Dialog TC04704B 3BUA000118R

164 Asset Optimization Reporting Configuration Section 3 Configuration 4. Click Help or refer to the appropriate Industrial IT 800xA System documentation to configure the properties under the various tabs in the Alarm and Event List Configuration dialog. 5. Click Apply and then close the dialog. 6. Repeat the procedure for all other Alarm and Event Lists. Asset Optimization Reporting Configuration These procedures provide general guidelines for configuring Asset Optimization Reports. For detailed information, refer to the Creating Reports and Scheduling sections in Industrial IT, 800xA - Information Management, Operation. Asset Optimization Reporting provides a preconfigured Job Description for each of the Asset Optimization Report Templates in the system. Each Asset Optimization Report Job Description must be configured prior to reporting. Asset Optimization Report Templates are configured in the Scheduling Structure. 1. Open a Plant Explorer Workplace. 2. Use the Structure Selector to open the Scheduling Structure in the Plant Explorer Workplace. 3. Use the Object Browser to navigate to: Schedules and Jobs > Job Descriptions, Job Folder > AO Asset Condition History, Job Description 164 3BUA000118R4101

165 Section 3 Configuration Asset Optimization Reporting Configuration 4. Select Scheduling Definition in the Aspect List Area to produce the Scheduling Definition aspect view, with the Schedule tab selected, in the Preview Area as shown in Figure 79. This procedure describes configuration to automatically run reports on a configured schedule. The Run Now button is used to run reports as desired. For more information on operator actions, refer to Industrial IT, 800xA - Asset Optimization, Operation. Figure 79. Scheduling Definition Aspect TC07774A 5. Select the type of schedule desired (cyclic, periodic, weekly, or monthly) in the Schedule: drop-down list box. 6. Depending on the schedule type selected, the bottom half of the aspect view will change. Fill in the fields as desired to complete the configuration for that schedule type. 3BUA000118R

166 Asset Optimization Reporting Configuration Section 3 Configuration 7. Select the Enabled check box. This check box must be enabled in order for reports to run automatically. 8. Select the server that will execute a given job in the Service Group: dropdown list box. The default is the primary service group which is the first service group created, not necessarily the first one listed in the Service Structure. To avoid unexpected results, it is recommended to specify a server where the report will run. 9. The Action Aspect must also be configured for each report type. This defines the input parameters for the report and how the report will be retained and optionally printed or archived using Information Management. Select Action Aspect in the Aspect List Area to produce the Action Aspect view in the Aspect Preview Area as shown in Figure 80. Figure 80. Action Aspect TC07776A 10. Select Report Action from the Action: drop-down list box BUA000118R4101

167 Section 3 Configuration Asset Optimization Reporting Configuration 11. If desired, a timeout value may be specified in the Time Limit (seconds): field, but in most situations the default values for the Time Limit (seconds), Isolated:, Priority:, Attempts:, and System Messages: fields should be used. 12. Select the report template to be used. Click... next to the Report Template Path: field and select the desired Asset Optimization Report template. The location of the templates is shown in Figure 81. Figure 81. Asset Optimization Report Template Location. TC07777A 13. There are Report Parameters to configure for each report type. These are displayed after clicking Add Parameter. The parameters for each report type are described in the topics immediately following this procedure: AO Asset Condition History Report Parameters on page 168. AO Calibration Report Parameters on page 169. AO Running Time Report Parameters on page Select the appropriate parameter to change and click Modify to edit the parameter in the Value column, leaving the parameter name in the Name column intact. 3BUA000118R

168 AO Asset Condition History Report Parameters Section 3 Configuration 15. When the modifications to the desired reports are complete, click Close and continue to Exporting Reports on page 171. AO Asset Condition History Report Parameters The AO Asset Condition History Report Template (refer to Figure 82) requires configuration of the following parameters: StartDate: Start time (oldest event) in mm/dd/yyyy hh:mm am/pm format. EndDate: End time (newest event) in mm/dd/yyyy hh:mm am/pm format. AEObjPath: Path to object with the configured AO Asset Condition Event aspect (Alarm and Event aspect type) that is the source of the report data. The default Asset Condition Event List aspect is found under the AO Asset Condition Report Template object. MaxRows: Maximum number of rows to retrieve for this report. ReportTitle: Title to appear in the header of the printed report. TC07778A Figure 82. AO Asset Condition History Report Parameters 168 3BUA000118R4101

169 Section 3 Configuration AO Calibration Report Parameters AO Calibration Report Parameters The AO Calibration Report Template (refer to Figure 83) requires configuration of the following parameters: StartDate: Start time (oldest event) in mm/dd/yyyy hh:mm am/pm format. EndDate: Time (newest event) in mm/dd/yyyy hh:mm am/pm format. AEObjPath: Path to object with the configured AO Asset Condition Event aspect (Alarm and Event aspect type) that is the source of the report data. The default Calibration Event List aspect is found under the AO Calibration Report Template object. MaxRows: Maximum number of rows to retrieve for this report. ReportTitle: Title to appear in the header of the printed report. Figure 83. AO Calibration Report Parameters TC07779A 3BUA000118R

170 AO Running Time Report Parameters Section 3 Configuration AO Running Time Report Parameters The AO Running Time Report Template (refer to Figure 84) requires configuration of the following parameters: Structure: Name of the structure in which to start the object search (usually the Asset Structure). RootObject: Name of the root object under the structure to start the object search. AEObjPath: Path to object with the configured AO Asset Condition Event aspect (Alarm and Event aspect type) that is the source of the report data. The default Asset Condition Event List aspect is found under the AO Asset Condition Report Template object. AspectType: Objects with this aspect type to be included in the report, usually the Runtime Asset Monitor. ReportTitle: Title to appear in the header of the printed report. Figure 84. AO Running Time Report Parameters TC07780A 170 3BUA000118R4101

171 Section 3 Configuration Exporting Reports Exporting Reports Reports are saved on the local system by exporting. 1. Select the Export Paths: check box in the Action Aspect view in the Preview Area. 2. Click Add Object Path to save the reports in the Aspect system. These will be retained under: Reports > folder name in the Scheduling Structure. These may then be later reviewed and/or printed by any clients on the system that have Microsoft Excel installed locally. 3. If required, output reports can also be saved to a local file folder. Click Add File Path to configure the output folder and file name. The print area is predefined in the Excel spreadsheet. This can be modified and saved in the template if required. This definition is used when the Printer check box is selected and a printer selected from the drop-down list box in the Action Aspect. Refer to Industrial IT, 800xA - Asset Optimization, Operation for information on reviewing reports, printing reports, etc. 3BUA000118R

172 Exporting Reports Section 3 Configuration 172 3BUA000118R4101

173 Section 4 Basic Asset Monitor Library Introduction This section contains procedures for creating and configuring the Asset Monitors contained in the Basic Asset Monitor Library. The Basic Asset Monitor Library is provided with the Asset Optimization Asset Monitoring license feature. The Config view of each Asset Monitor has six tabs provided for configuration. These procedures contain only those tabs with configuration procedures that are unique to each Asset Monitor. Refer to Asset Monitors on page 112 for descriptions of all the tabs, and procedures for configuring those that are common to all Asset Monitors. The Asset Monitors contained in the Basic Asset Monitor Library are: Bad Quality Check. Bool Check. Flow Delta. Limit Check (High, HighLow, and Low). Running Time Check. XY Profile Deviation. Bad Quality Check The Bad Quality Check Asset Monitor notifies if there is a bad or uncertain quality indication from a control system input. The following details creation and configuration of a single instance of the Bad Quality Check Asset Monitor. The procedure must be repeated for each asset. 1. Use the Object Browser to navigate to an asset that requires a Bad Quality Check Asset Monitor. 2. Right-click on the asset and select New Aspect... from the context menu that appears. 3BUA000118R

174 Bad Quality Check Section 4 Basic Asset Monitor Library 3. The New Aspect dialog appears. a. Check the Show all check box and uncheck the List presentation check box. b. Navigate to and select Bad Quality Check from the list that appears c. Click Create. 4. Click the added Asset Monitor in the Aspect List Area to produce the default view of the Asset Monitor in the Preview Area. 5. Click on the View Selector and select Config to open the Config view in the Preview Area. 6. The view appears with the Asset Monitor tab selected. If needed, customize the items in the Asset Monitor tab as described under Asset Monitor Tab on page If needed, configure the items in the Conditions tab as described under Conditions Tab on page Click Apply. 9. To change the Asset Parameters for this instance of the Asset Monitor, click the Asset Parameters tab. The view shown in Figure 85 appears. All of the Asset Parameters listed can be changed. Figure 85. Asset Parameters Tab (Bad Quality Check) TC05021D a. The values are used for the following: ExecutionsRequiredForTrigger: Positive integer representing the number of subsequent executions required to recognize a change in the OPC quality Input Record value. Tune this parameter to filter out 174 3BUA000118R4101

175 Section 4 Basic Asset Monitor Library Bad Quality Check momentary quality value changes. For example, the initial subscription to an OPC item may return a bad quality value. Inhibit_Value: Inhibit value is set to True by default. When the Inhibit Input Record value is equal to this value, the Asset Monitor is disabled and its condition is set to Normal goodlocaloverride. b. Change the fields to the desired values. 10. Click Apply. 11. Click the Input Records tab and the view shown in Figure 86 appears. The view shown has values configured. TC05022D Figure 86. Configured Input Records Tab (Bad Quality Check) 12. Click on the Data Source Aspect column and select the OPC server from which to receive the data. This is a data source that was created in Managing Data Source Connections on page Fill in the Data Source Item column with the OPC item providing the value to be monitored. 14. Click Apply. If either the Data Source Aspect or Data Source Item fields of the Inhibit Input Record are left blank, the inhibit functionality is disabled. 15. The Output Records and Logic tabs are common to all Asset Monitors. Refer to Output Records Tab and Logic Tab on page 128 for more information. 3BUA000118R

176 Bool Check Section 4 Basic Asset Monitor Library Bool Check The Bool Check Asset Monitor monitors a signal with two states: normal and alarm. It notifies if the signal is in alarm state. The following details creation and configuration of a single instance of the Bool Check Asset Monitor. The procedure must be repeated for each asset. 1. Use the Object Browser to navigate to an asset that requires a Bool Check Asset Monitor. 2. Right-click on the asset and select New Aspect... from the context menu that appears. 3. The New Aspect dialog appears. a. Check the Show all check box and uncheck the List presentation check box. b. Navigate to and select Bool Check from the list that appears. c. Click Create. 4. Click the added Asset Monitor in the Aspect List Area to produce the default view of the Asset Monitor in the Preview Area. 5. Click on the View Selector and select Config to open the Config view in the Preview Area. 6. The view appears with the Asset Monitor tab selected. If needed, customize the items in the Asset Monitor tab as described under Asset Monitor Tab on page If needed, configure the items in the Conditions tab as described under Conditions Tab on page Click Apply BUA000118R4101

177 Section 4 Basic Asset Monitor Library Bool Check 9. To change the Asset Parameters for this instance of the Asset Monitor, click the Asset Parameters tab. The view shown in Figure 87 appears. All of the Asset Parameters listed can be changed. Figure 87. Asset Parameters Tab (Bool Check) TC08117A a. The values are used for the following: Normal_Value: This value is set to False by default, but could be set to any value like 50 or Running. If the Signal Input Record value matches this value, condition is set to normal. Otherwise, condition is set to alarm. Inhibit_Value: Inhibit value is set to True by default. When the Inhibit Input Record value is equal to this value, the Asset Monitor is disabled and its condition is set to Normal goodlocaloverride. Change the fields to the desired values. 10. Click Apply. 3BUA000118R

178 Bool Check Section 4 Basic Asset Monitor Library 11. Click the Input Records tab and the view shown in Figure 88 appears. The view shown has values configured. Figure 88. Configured Input Records Tab (Bool Check) TC08118A 12. Click on the Data Source Aspect column and select the OPC server from which to receive the data. This is a data source that was created in Managing Data Source Connections on page Fill in the Data Source Item column with the OPC items providing the value to be monitored. 14. Click Apply. If either the Data Source Aspect or Data Source Item fields of the Inhibit Input Record are left blank, the inhibit functionality is disabled. 15. The Output Records and Logic tabs are common to all Asset Monitors. Refer to Output Records Tab and Logic Tab on page 128 for more information BUA000118R4101

179 Section 4 Basic Asset Monitor Library Flow Delta Flow Delta The Flow Delta Asset Monitor monitors the difference between two numeric values (i.e. steam flow and feedwater flow) and notifies if the difference exceeds a configured percentage of the first value. The following details creation and configuration of a single instance of the Flow Delta Asset Monitor. The procedure must be repeated for each asset. 1. Use the Object Browser to navigate to an asset that requires a Flow Delta Asset Monitor. 2. Right-click on the asset and select New Aspect... from the context menu that appears. 3. The New Aspect dialog appears. a. Check the Show all check box and uncheck the List presentation check box. b. Navigate to and select Flow Delta from the list that appears. c. Click Create. 4. Click the added Asset Monitor in the Aspect List Area to produce the default view of the Asset Monitor in the Preview Area. 5. Click on the View Selector and select Config to open the Config view in the Preview Area. 6. The view appears with the Asset Monitor tab selected. If needed, customize the items in the Asset Monitor tab as described under Asset Monitor Tab on page If needed, configure the items in the Conditions tab as described under Conditions Tab on page Click Apply. 3BUA000118R

180 Flow Delta Section 4 Basic Asset Monitor Library 9. To change the Asset Parameters for this instance of the Asset Monitor, click the Asset Parameters tab. The view shown in Figure 89 appears. All of the Asset Parameters listed can be changed. Figure 89. Asset Parameters Tab (Flow Delta) a. The values are used for the following: AllowablePercentDeviation: This value defaults to 5% and is used to calculate the difference between the two Input Records: Feedwater Flow and Steam Flow. If the difference is more than five percent, or whatever is configured, an ACD and alarm are generated. If: Then: TC05029D Feedwater Flow Steam Flow 100 > Feedwater Flow AllowablePercentDeviation SubCondition Else: = LimitExceeded SubCondition = WithinLimit (normal) Inhibit_Value: Inhibit value is set to True by default. When the Inhibit Input Record value is equal to this value, the Asset Monitor is disabled and its condition is set to Normal goodlocaloverride. Change the fields to the desired values. 10. Click Apply BUA000118R4101

181 Section 4 Basic Asset Monitor Library Limit Check (High, HighLow, and Low) 11. Click the Input Records tab and the view shown in Figure 90 appears. The view shown has values configured. Figure 90. Configured Input Records Tab (Flow Delta) 12. Click on the Data Source Aspect column and select the OPC server from which to receive the data. This is a data source that was created in Managing Data Source Connections on page Fill in the Data Source Item column with the OPC item providing the value to be monitored. 14. Click Apply. If either the Data Source Aspect or Data Source Item fields of the Inhibit Input Record are left blank, the inhibit functionality is disabled. 15. The Output Records and Logic tabs are common to all Asset Monitors. Refer to Output Records Tab and Logic Tab on page 128 for more information. Limit Check (High, HighLow, and Low) TC05030D The High Limit Check Asset Monitor monitors a process value and notifies if it exceeds configured limit values that include the high limit value and the high limit value plus a negative offset value. The HighLow Limit Check Asset Monitor 3BUA000118R

182 Limit Check (High, HighLow, and Low) Section 4 Basic Asset Monitor Library monitors a process value and notifies if it exceeds configured limit values that include the high limit value, the high limit value plus a negative offset value, the low limit value, and the low limit value plus a positive offset value. The Low Limit Check Asset Monitor monitors a process value and notifies if it exceeds configured limit values that include the low limit value and the low limit value plus a positive offset value. The following details creation and configuration of a single instance of the HighLow Limit Check Asset Monitor. The procedures for configuring the High Limit Check and Low Limit Check Asset Monitors are essentially the same. Any differences will be referenced in the procedure. The procedure must be repeated for each asset. 1. Use the Object Browser to navigate to an asset that requires a HighLow, High, or Low Limit Check Asset Monitor. 2. Right-click on the asset and select New Aspect... from the context menu that appears. 3. The New Aspect dialog appears. a. Check the Show all check box and uncheck the List presentation check box. b. Navigate to and select HighLow Limit Check, High Limit Check, or Low Limit Check from the list that appears. c. Click Create. 4. Click the added Asset Monitor in the Aspect List Area to produce the default view of the Asset Monitor in the Preview Area. 5. Click on the View Selector and select Config to open the Config view in the Preview Area. 6. The view appears with the Asset Monitor tab selected. If needed, customize the items in the Asset Monitor tab as described under Asset Monitor Tab on page If needed, configure the items in the Conditions tab as described under Conditions Tab on page BUA000118R4101

183 Section 4 Basic Asset Monitor Library Limit Check (High, HighLow, and Low) There are two tabs in this view, a HighLimit tab and a LowLimit tab. If this were a High Limit or Low Limit Check Asset Monitor, there would be only a single Limit tab. 8. Click Apply. 9. To change the Asset Parameters for this instance of the Asset Monitor, click the Asset Parameters tab. The view shown in Figure 91 appears showing the default values. All of the Asset Parameters listed can be changed. Figure 91. Asset Parameters Tab (HighLow Limit Check) TC04687D The Asset Parameter values shown in Figure 91 reflect the HighLow Limit Check Asset Monitor. The values for the High Limit Check and Low Limit Check Asset Monitors contain only those applicable to each. a. The Inhibit value is set to True by default. When the Inhibit Input Record value is equal to this value, the Asset Monitor is disabled and its condition is set to Normal goodlocaloverride. b. By default the values for Range/Upper, Range/Lower, ConditionConfig/HighLimit/Value and ConditionConfig/LowLimit/Value are dynamically read from the Input Record specified in the Value column. Optionally, a fixed numeric value can be entered in the Value column. 3BUA000118R

184 Limit Check (High, HighLow, and Low) Section 4 Basic Asset Monitor Library c. The values for ConditionConfig/HighLimit/OffsetValue and ConditionConfig/LowLimit/OffsetValue can be dynamic (from Input Record), a percentage, or a fixed numeric value. The value for ConditionConfig/HighLimit/OffsetValue must be a negative number. The value for ConditionConfig/LowLimit/OffsetValue must be a positive number. 10. Click Apply. If a percentage is chosen, then the HighOffset subcondition limit is defined by: ConditionConfig/HighLimit/Value ( Range/Upper Range/Lower) ConditionConfig/HighLimit/OffsetValue 100 and the LowOffset subcondition limit is defined by: ConditionConfig/LowLimit/Value + ( Range/Upper Range/Lower) ConditionConfig/LowLimit/OffsetValue 100 If a fixed numeric value is chosen, then the HighOffset subcondition limit is defined by: ConditionConfig/HighLimit/Value + ConditionConfig/HighLimit/OffsetValue and the LowOffset subcondition limit is defined by: ConditionConfig/LowLimit/Value + ConditionConfig/LowLimit/OffsetValue 184 3BUA000118R4101

185 Section 4 Basic Asset Monitor Library Limit Check (High, HighLow, and Low) 11. Click the Input Records tab and the view shown in Figure 92 appears. The view shown has values configured. The Input Records shown in Figure 92 reflect the HighLow Limit Check Asset Monitor. The values for the High Limit Check and Low Limit Check Asset Monitors contain only those applicable to each. TC04689E Figure 92. Configured Input Records Tab (HighLow Limit Check) 12. Click on the Data Source Aspect column and select the OPC server from which to receive the data. This is a data source that was created in Managing Data Source Connections on page If any of the values in the ID column were changed to fixed numeric values under the Asset Parameters tab, the Data Source Aspect column for those values can be left at the default value of None. If any values were not changed, the Data Source Aspect column for those values must be changed to the selected OPC server from which to receive the data. This is a data source that was created in Managing Data Source Connections on page Click Apply. 15. Fill in the Data Source Item column with the OPC item providing the value to be monitored. 3BUA000118R

186 Running Time Check Section 4 Basic Asset Monitor Library 16. Click Apply. If either the Data Source Aspect or Data Source Item fields of the Inhibit Input Record are left blank, the inhibit functionality is disabled. 17. The Output Records and Logic tabs are common to all Asset Monitors. Refer to Output Records Tab and Logic Tab on page 128 for more information. Running Time Check The Running Time check Asset Monitor monitors the accumulated runtime hours of a device and notifies, for preventive maintenance, that the runtime has accumulated up to a configured limit. The following details creation and configuration of a single instance of the Running Time Check Asset Monitor. The procedure must be repeated for each asset. 1. Use the Object Browser to navigate to an asset that requires a Running Time Check Asset Monitor. 2. Right-click on the asset and select New Aspect... from the context menu that appears. 3. The New Aspect dialog appears. a. Check the Show all check box and uncheck the List presentation check box. b. Navigate to and select Running Time Check from the list that appears. c. Click Create. For illustration purposes, and to be consistent with the Runtime Asset Monitor Object Type, the Running Time Check Asset Monitor in this procedure has been renamed from the category name to Runtime Asset Monitor. 4. Click the added Asset Monitor in the Aspect List Area to produce the default view of the Asset Monitor in the Preview Area. 5. Click on the View Selector and select Config to open the Config view in the Preview Area BUA000118R4101

187 Section 4 Basic Asset Monitor Library Running Time Check 6. The view appears with the Asset Monitor tab selected. If needed, customize the items in the Asset Monitor tab as described under Asset Monitor Tab on page If needed, configure the items in the Conditions tab as described under Conditions Tab on page Click Apply. 9. To change the Asset Parameters for this instance of the Asset Monitor, click the Asset Parameters tab. The view shown in Figure 93 appears. All of the Asset Parameters listed can be changed. Figure 93. Asset Parameters Tab (Running Time Check) TC05013D a. The values are used for the following: Hours_Running_Limit: The default value is set to 24. When the AdjustedHoursRunning Output Record exceeds this value, the Runtime Asset Monitor will set the RunTime Limit Reached condition to Yes. Percent_Of_HoursUnaccounted_applied_to_AdjustedHoursRunning: This value can range from 0 to 100 and is set to account for time when the Asset Monitor is unable to monitor the running status of the asset; for example, if the Monitoring Server is shut down. RunningStatusValue: The default is set to True. Total running time is accumulated when this value is equal to the RunningStatus Input Record value. Change the fields to the desired values. 3BUA000118R

188 Running Time Check Section 4 Basic Asset Monitor Library 10. Click Apply. 11. Click the Input Records tab and the view shown in Figure 94 appears. The view shown has values configured. ResetSignal and HoursResetBias are configured by default. TC05014D Figure 94. Configured Input Records Tab (Running Time Check) 12. Click on the Data Source Aspect column and select the OPC server from which to receive the data. This is a data source that was created in Managing Data Source Connections on page Fill in the Data Source Item column with the OPC item providing the value to be monitored. 14. Click Apply. This Asset Monitor requires write access to be enabled on the Data Source used for the ResetSignal and HoursResetBias Input Records BUA000118R4101

189 Section 4 Basic Asset Monitor Library Running Time Check The Runtime Asset Monitor generates four Output Records. The Output Records tab of an example Runtime Asset Monitor is shown in Figure 95. Figure 95. Output Records Tab (Runtime Asset Monitor) TC05039B The fields are defined as follows: HoursRunning: Provides the number of hours accumulated while the RunningStatus Input Record value matched the RunningStatusValue Asset Parameter. AdjustedHoursRunning: Provides an adjusted HoursRunning estimate based on the following function: C D A = B Where: A = AdjustedHoursRunning B = HoursRunning C = HoursUnaccounted D = Percent_Of_HoursUnaccounted_applied_to_AdjustedHoursRunning 3BUA000118R

190 Running Time Check Section 4 Basic Asset Monitor Library HoursUnaccounted: Provides the number of hours accumulated while the Asset Monitor was not able to monitor the RunningStatus Input Record value. LastReset: Date and time of the last HoursRunning reset. The Running Time Check Asset Monitor uses a tunable startup parameter. Refer to Asset Monitor Startup Parameters on page 77 for more information. The Runtime Asset Monitor requires a user interface to reset the runtime. Therefore, a Runtime Asset Monitor Object Type is provided to instantiate an object containing the Runtime Asset Monitor. This Object Type also includes additional user interface components. Figure 96 shows the Runtime Asset Monitor faceplate. Figure 96. Runtime Asset Monitor Faceplate To reset the runtime using the faceplate: 1. Click the button next to Reset Hrs.: to set the initial runtime hours. TC05034A 190 3BUA000118R4101

191 Section 4 Basic Asset Monitor Library XY Profile Deviation 2. Click Reset. The Runtime Asset Monitor Object Type includes four Runtime aspects as shown in Figure 97. Figure 97. Runtime Asset Monitor Object Type Where: Runtime Asset Monitor: Represents one Running Time Check Asset Monitor. Runtime Faceplate and Runtime Faceplate Element: Constitute the faceplate. Runtime Properties: Contains two supporting General Properties (OPC items) used to link the faceplate operation to the Asset Monitor. XY Profile Deviation TC05033A Renaming the Runtime Asset Monitor or Runtime property will break the links between such aspects and the related Runtime Faceplate Element. A new Runtime Faceplate Element can be deployed that points to the new aspect names. Refer to Industrial IT, 800xA - System, Upgrade and Installation for backup and restore procedures for Running Time Check data. The XY Profile Deviation Asset Monitor compares a two-dimensional value (a point in a Cartesian plane) against a baseline function and notifies if the deviation from the baseline is less than or greater than the configured limit. 3BUA000118R

192 XY Profile Deviation Section 4 Basic Asset Monitor Library The XY Profile Deviation Asset Monitor uses an external Excel configuration file. This file contains the definition of a XY reference function and related High and Low profiles. When defining the XY reference profile function, the X values must be in ascending order with no duplicate X values. When the operating point lies outside the defined reference profile (Xpoint is less than reference profile Xmin or Xpoint is greater than reference profile Xmax), the High and Low profiles will be set to be parallel to the extrapolated reference profile (same slope as the slope of the last defined reference profile segment). The following details creation and configuration of a single instance of the XY Profile Deviation Asset Monitor. The procedure must be repeated for each asset. 1. Use the Object Browser to navigate to an asset that requires an XY Profile Deviation Asset Monitor. 2. Right-click on the asset and select New Aspect... from the context menu that appears. 3. The New Aspect dialog appears. a. Check the Show all check box and uncheck the List presentation check box. b. Navigate to and select XY Profile Deviation from the list that appears. c. Click Create. 4. Click the added Asset Monitor in the Aspect List Area to produce the default view of the Asset Monitor in the Preview Area. 5. Click on the View Selector and select Config to open the Config view in the Preview Area. 6. The view appears with the Asset Monitor tab selected. If needed, customize the items in the Asset Monitor tab as described under Asset Monitor Tab on page If needed, configure the items in the Conditions tab as described under Conditions Tab on page Click Apply BUA000118R4101

193 Section 4 Basic Asset Monitor Library XY Profile Deviation 9. To change the Asset Parameters for this instance of the Asset Monitor, click the Asset Parameters tab. The view shown in Figure 98 appears. All of the Asset Parameters listed can be changed. TC05017D Figure 98. Asset Parameters Tab (XY Profile Deviation) a. The values are used for the following: XY_Reference_Profile_FileName: This value contains the file name (without a path) of the Excel workbook containing the baseline XY profile with relative allowable deviations (High and Low Limit profiles). The Excel files containing the XY profiles must reside in the following directory: Installdrive:\Program Files\ABB Industrial IT\Optimize IT\Asset Optimization\AssetMonitorEnvironment\Bin\XY_Reference_Profiles A sample XY profile is provided in the XY_Reference_Profiles directory. It is recommended to copy TestProfile.xls, rename it, and modify it as required. Figure 99 shows the sample XY profile. 3BUA000118R

194 XY Profile Deviation Section 4 Basic Asset Monitor Library TC05040A Figure 99. Sample XY Profile Inhibit_Value: Inhibit value is set to True by default. When the Inhibit Input Record value is equal to this value, the Asset Monitor is disabled and its condition is set to Normal goodlocaloverride. Change the fields to the desired values. 10. Click Apply BUA000118R4101

195 Section 4 Basic Asset Monitor Library XY Profile Deviation 11. Click the Input Records tab and the view shown in Figure 100 appears. The view shown has values configured. Figure 100. Configured Input Records Tab (XY Profile Deviation) TC05018D 12. For each Input Record, click on the Data Source Aspect column and select the OPC server from which to receive the data. This is a data source that was created in Managing Data Source Connections on page Fill in the Data Source Item column with the OPC item providing the value to be monitored. 14. Click Apply. If either the Data Source Aspect or Data Source Item fields of the Inhibit Input Record are left blank, the inhibit functionality is disabled. Refer to Industrial IT, 800xA System, Upgrade and Installation for backup and restore procedures for XY Profile Deviation data. Refer to Industrial IT, 800xA - Asset Optimization, Release Notes for details on the X and Y values in the XY Profile Deviation Asset Monitor. 3BUA000118R

196 XY Profile Deviation Section 4 Basic Asset Monitor Library 196 3BUA000118R4101

197 Section 5 PC, Network and Software Monitoring Setup Overview Standard PC and network equipment is used extensively in automation systems. The correct behavior and status of this equipment has a significant impact on the performance, reliability, and functional availability of an automation system and thus the industrial process being controlled. The PC, Network and Software Monitoring software can independently monitor the status of Information Technology (IT) Assets. By default, IT Asset status is viewable via the 800xA System Status Viewer, or through the standard faceplates provided with each of the predefined IT Assets. When used in conjunction with Asset Optimization Asset Monitoring, alarms can be generated based on error conditions, and IT Asset status is viewable via the Asset Viewer and Asset Reporter. Once in the 800xA System, the data can be used to: Generate alarms. Produce historical reports. Update live trends and graphics. PC, Network and Software Monitoring is comprised of the following components: An OPC Server (PC, Network and Software Monitoring Server) that supplies IT Asset data to the system. A set of IT Aspect types that access the IT status data inside the Operator Workplace making the IT status data available to any 800xA System client application. A set of predefined Object Types that allow a user to easily set up monitoring for many commonly used devices. 3BUA000118R

198 Overview Section 5 PC, Network and Software Monitoring Setup An interface to Asset Optimization Asset Monitoring that generates alarms based on the state of the IT assets. Although Asset Optimization is referenced throughout this section, the functionality is not available unless Asset Optimization Asset Monitoring has been installed and a license has been purchased. The Network and Device Scanning Tool that enables users to scan the network for SNMP enabled devices and compile Management Information Base (MIB) files. A set of tools to allow the user to create new objects for monitoring IT devices not in the predefined set (refer to Section 8, Creating Custom IT Devices and IT Assets). Data comes into the system via Windows Management Instrumentation (WMI) technology. WMI is a standard interface for IT instrumentation, and it supports a number of communications protocols, including the Simple Network Management Protocol (SNMP). SNMP is the standard communications protocol used to monitor and manage network devices. The PC, Network and Software Monitoring Server uses WMI to access live status information that is sent to the Operator Workplace via the standard OPC interface. The Operator Workplace makes the data available for use by any part of the system. It is accessible via properties on the asset objects configured in the Operator Workplace. Asset Optimization Asset Monitoring uses these properties to access the data, and determine if alarm conditions exist by using user-entered configuration data. If any assets are in alarm, Asset Optimization Asset Monitoring generates alarm messages back to the Operator Workplace where they are integrated into the normal alarm stream and displayed using the standard alarm display tools BUA000118R4101

199 Section 5 PC, Network and Software Monitoring Setup Overview The architecture drawing shown in Figure 101 illustrates this design. TC05104B Figure 101. PC, Network and Software Monitoring Architecture PC, Network and Software Monitoring uses the following terms to define its structure: IT Assets: Represent real things such as computers, routers, switches, printers, etc. Typically specified using an IP address. IT Devices: Components of IT Assets. Parts of the IT Asset that have information to monitor. May be a physical device (e.g. network card) or a software component (e.g. Operator Workplace). IT Assets typically consist of multiple IT Devices. The same IT Device may exist in different types of IT Assets (e.g. the same process may run on different computer configurations). 3BUA000118R

200 PC, Network and Software Monitoring Server Configuration Section 5 PC, Network and Software Properties: Individual monitorable data elements on an IT Device (e.g. error rate on a particular port on a particular switch). Many properties may exist on a single IT Device. PC, Network and Software Monitoring Server Configuration Every PC, Network and Software Monitoring installation must have at least one IT OPC Server Network object. This object has the following functions: Manage the connectivity to the PC, Network and Software Monitoring Server. Manage the link between the PC, Network and Software Monitoring system and Asset Optimization Asset Monitoring. Provide IT Asset regeneration capabilities. The following items require set up in the PC, Network and Software Monitoring system: IT OPC Server Network Object. Editing the OPC Data Source Definition. Asset Optimization Asset Monitoring Aspects. IT General Setup Aspect. IT OPC Server Network Object There should already be an IT OPC Network Object defined in the default configuration. If so, continue to Editing the OPC Data Source Definition on page 201. To create a new IT OPC Server Network: 1. Use the Structure Selector to open the Control Structure. 2. Right-click on Root, Domain and select New Object... from the context menu that appears. 3. The New Object dialog appears. Select IT OPC Server Network (under 3- rd party OPC server support group) and click Next. 4. Leave the Connector with CSLib button on BUA000118R4101

201 Section 5 PC, Network and Software Monitoring Setup Editing the OPC Data Source Definition 5. Click Add and select the appropriate service provider from the list. 6. Click Create. Editing the OPC Data Source Definition To edit the OPC data source definition: 1. Use the Structure Selector to open the Control Structure. 2. Use the Object Browser to navigate to and select IT OPC Server Network in the Aspect Object Area. 3. Right-click on OPC Data Source Definition in the Aspect List Area and select Config View from the context menu that appears. 4. Click New in the Preview Area. 5. Click Add and select the appropriate service provider from the list. 6. Click OK twice. 7. Click Apply. Asset Optimization Asset Monitoring Aspects When using PC, Network and Software Monitoring with Asset Optimization Asset Monitoring the software must communicate with two Asset Optimization Asset Monitoring aspects, the Asset Optimization Server and the Asset Monitor Data Source, in order to generate alarms. The procedures for setting up the required Asset Optimization Asset Monitoring aspects are in the Managing Data Source Connections on page 99 and Loading Asset Monitor Configurations to an AO Server on page 75. Copying the AM Service Data Source Aspect The AM Service Data Source Definition aspect must be copied into the IT OPC Server Network Object. 1. Use the Structure Selector to open the Control Structure. 2. Use the Object Browser to navigate to: 3BUA000118R

202 IT General Setup Aspect Section 5 PC, Network and Software Monitoring Setup Root, Domain > Asset Optimization, Asset Optimization > AO Server 1, AO Server 3. Right-click on AM Service Data Source Definition in the Aspect List Area and select Copy from the context menu that appears. 4. Use the Object Browser to navigate to: Root, Domain > IT Server, IT OPC Server Network 5. Right-click in the Aspect List Area and select Paste from the context menu that appears. IT General Setup Aspect There should already be an IT General Setup aspect defined. To bypass creating it and go straight to configuration, skip to Step 6. The IT General Setup aspect is used to point the IT OPC Server Network object to the Asset Optimization Asset Monitoring Server and Asset Monitor Data Source. 1. Use the Structure Selector to open the Control Structure. 2. Use the Object Browser to navigate IT Server, IT OPC Server Network. 3. Right-click on IT Server, IT OPC Server Network and select New Aspect... from the context menu that appears. 4. The New Aspect dialog appears. a. Check the Show all check box and uncheck the List presentation check box. b. Navigate to and select IT General Setup from the list that appears. 5. Click Create BUA000118R4101

203 Section 5 PC, Network and Software Monitoring Setup IT General Setup Aspect 6. Select IT General Setup in the Aspect List Area. Figure 102 shows a configured IT General Setup aspect. Figure 102. IT General Setup Aspect TC05108C The fields in the IT General Setup aspect are defined as follows: Name: There are Name fields in the Asset Optimization Monitoring Server frame and the Asset Optimization Data Source frame. Select the proper Asset Optimization Server and Asset Monitor Data Source from the drop-down list boxes. Interval: Value in seconds that defines how often the logic will be executed on automatically created Asset Monitor aspects. Refresh Monitoring Server when Control Connection in Asset is modified: If this check box is checked, populating the IT Control Connection from the IT Device Manager causes the same effect as 3BUA000118R

204 Predefined IT Assets Section 5 PC, Network and Software Monitoring Setup clicking Load all AMs or Load Selected Asset Monitors from the Asset Monitors tab of the Asset Optimization Server aspect. Refreshing the Monitoring Server on any IT Asset modification may cause a high CPU load after each IT Asset change. Populate Control Connections: Clicking on this button will populate the IT Control Connection for each of the IT Assets below this aspect. Create Asset Monitors: Clicking on this button will create IT Asset Monitor aspects for each of the IT Assets below this aspect. An IT General Setup aspect can also be created inside an individual IT Asset object. The values used at this level will override the IT General Setup at the OPC Server network level, for this IT Asset only. Predefined IT Assets PC, Network and Software Monitoring has several predefined IT Assets. Each IT Asset is made up of a number of IT Devices, and each IT Device appears as a separate aspect on the IT Asset. Each IT Asset also has an IT General Property aspect used to configure parameters on the IT Asset that are common to all of its IT Devices. Assigning Predefined IT Assets To assign a predefined IT Asset: 1. Use the Structure Selector to open the Control Structure. 2. Use the Object Browser to navigate to IT Server, IT OPC Server Network. 3. Right-click on IT Server, IT OPC Server Network and select New Object... from the context menu that appears. 4. The New Object dialog appears. a. Uncheck the Show all and List presentation check boxes BUA000118R4101

205 Section 5 PC, Network and Software Monitoring Setup Assigning Predefined IT Assets b. Navigate to and expand IT Assets as shown in Figure 103. Figure 103. New Object Dialog (IT Assets) TC05109B c. Select the desired Asset (Cisco 12-port Switch in this example). d. Type a name for the Asset in the Name field. 5. Click Create. Configuration of IT Assets varies depending on the type of IT Asset. Refer to Section 6, IT Asset and IT Device Library for descriptions and additional information for the general and device-specific values that can be modified. Use the IT General Property aspect to configure parameters on the IT Asset that are common to all of its IT Devices. For example, the IP address of the IT Asset is typically configured via the IT General Property. To configure the IT General Property: 6. With the new object highlighted, a list of aspects in the right-hand window is visible. 7. Use the Structure Selector to open the Control Structure. 3BUA000118R

206 Assigning Predefined IT Assets Section 5 PC, Network and Software Monitoring Setup 8. Use the Object Browser to navigate to the desired IT Asset. 9. Select IT General Property in the Aspect List Area to produce a view in the Preview Area such as the one shown in Figure 104. Figure 104. IT General Property TC05110B 10. Click in the Value column and type in the new value per the information from Section 6, IT Asset and IT Device Library. 11. Click Apply to accept the changes. The individual IT Device aspects on the IT Asset are used to configure devicespecific parameters. This is also where alarm limits are typically specified. To configure device-specific properties: 206 3BUA000118R4101

207 Section 5 PC, Network and Software Monitoring Setup Assigning Predefined IT Assets 12. Select the desired IT Device (a hard disk device in this example) in the Aspect List Area to produce a view in the Preview Area such as the one shown in Figure 105. Figure 105. IT Device Configuration TC05111B 13. Select the desired IT Device property from the list in the Token Configuration frame. Some properties are common to all IT Devices on this IT Asset, and can only be changed from the IT General Property aspect. The rest are device-specific, and can be modified here. 14. Type in the new property value in the Token Value field. 15. Click Accept. 16. To change more IT Device properties, repeat Step 13 through Step 15. 3BUA000118R

208 Adding IT Devices to Existing IT Assets Section 5 PC, Network and Software Monitoring Setup 17. Click Apply when all changes are complete. When changes to general and device-specific properties are completed, they must be activated by repopulating the IT control connection and restarting Asset Monitoring. Refer to Activating Changes to IT Assets on page 210 for the procedure. Adding IT Devices to Existing IT Assets Customizing existing IT Assets is accomplished by adding additional IT Devices to them. To add an IT Device to an existing IT Asset: 1. Use the Structure Selector to open the Control Structure. 2. Use the Object Browser to navigate to the desired IT Asset. 3. Right-click on the IT Asset and select New Aspect... from the context menu that appears. 4. The New Aspect dialog appears. a. Check the Show all check box and uncheck the List presentation check box. b. Navigate to and select IT Device from the list that appears. To avoid confusion between more than one IT Device, delete the default name in the Name field and type in a new, unique name. If the IT Device is going to have an Alarm or Alert IT Device configuration assigned to it, then its name must end in Alarm or Alert respectively. This is important or the IT Faceplates will not display properly. Refer to the Predefined IT Assets on page 204 as an example. c. Click Create. 5. Select the new IT Device in the Aspect List Area BUA000118R4101

209 Section 5 PC, Network and Software Monitoring Setup Adding IT Devices to Existing IT Assets 6. Click... to the right of the Current IT Device Configuration field to open the Choose IT Device Configuration dialog as shown in Figure 106. Figure 106. Adding an IT Device TC05113B 7. Choose the desired Device from the drop-down list box and click OK. 8. Refer to Assigning Predefined IT Assets on page 204 to configure the new IT Device. When changes are completed, they must be activated by repopulating the IT control connection, rebuilding the Asset Monitor and restarting Asset Monitoring. Refer to Activating Changes to IT Assets on page 210 for the procedure. 3BUA000118R

210 Activating Changes to IT Assets Section 5 PC, Network and Software Monitoring Setup Activating Changes to IT Assets Before any changes to an IT Asset can take effect, the changes must be activated. Activation accomplishes the following: Rebuilds the list of properties available from the IT Asset, making them available to other applications within the Operator Workplace. Recreates the structures required for Asset Optimization to run. Passes new alarm limit parameters to the alarm detection logic. Reconnects the Asset Optimization Server to the assets being monitored. To activate changes: 1. Use the Structure Selector to open the Control Structure. 2. Use the Object Browser to navigate to the desired IT Asset. 3. Select IT Device Manager in the Aspect List Area to produce the IT Device Manager Config view in the Preview Area as shown in Figure 107. TC05114B Figure 107. IT Device Manager Config View The buttons and fields in the IT Device Manager Config view are defined as follows: Populate: Populates the IT Control Connection aspect with items from the IT Devices that are in the asset BUA000118R4101

211 Section 5 PC, Network and Software Monitoring Setup Activating Changes to IT Assets Generate: Creates the IT Asset Monitor aspect, Asset Viewer, Asset Reporter, and AssetMonitorProperties aspects from the Asset Optimization part of the IT Devices that are in the asset. Use Alarm Summary Configuration checkbox and drop-down list box: Used to define whether all alarms should be passed to the Asset Optimization system or just a summary of the alarms as one alarm. This option is used if there are many alarms in an asset and they do not all need to be passed to the Asset Optimization system individually. If the checkbox is checked, the drop-down list box contains the reference for the Summary Alarm Object. The Summary Alarm Object is contained in the Object Type Structure in the IT Devices Configurations/IT System Status Object Type Group. The SummaryAlarm object defines the alarm message that will be passed to the Asset Optimization system. 4. If changes were made to IT Devices or the IT General Property, click Populate in the IT Control Connection frame. 5. If the Alarm Summary option is required, check the Use Alarm Summary Configuration check box and choose the Summary Alarm Object reference from the drop-down list box. 6. If IT Assets were created and/or new IT Devices were added to IT Assets, click Generate in the IT Asset Monitor frame. 7. Select the Asset Optimization Server that is referenced in the IT General Setup aspect. 8. Click the Asset Monitors tab. 9. Click on the Radio button to the left of AMs Assigned to this AO Srv. 10. A list of Asset Monitors appears at the bottom of the display. 11. Click on the line with the name of the IT Asset object that you created the IT Asset Monitor for. 12. Right-click and select Load Selected Asset Monitors from the context menu that appears. 3BUA000118R

212 Creating IT Assets and IT Devices Section 5 PC, Network and Software Monitoring Setup Creating IT Assets and IT Devices The PC, Network and Software Monitoring product provides tools that allow a user to create custom IT Assets and IT Devices. This is necessary when existing IT Devices need to be enhanced to monitor additional data, or if new devices need to be monitored that do not have predefined IT Devices. Refer to Section 7, Network and Device Scanning Tool and Section 8, Creating Custom IT Devices and IT Assets to create new IT Devices BUA000118R4101

213 Section 6 IT Asset and IT Device Library Overview This section describes the standard IT Assets and IT Devices supplied within PC, Network and Software Monitoring. The section is divided into two main subsections: IT Assets: Describes the IT Assets and lists the IT Devices that comprise them. It also describes the user-settable parameters in the IT Devices and the IT General Properties indicating which parameters need to be changed when configuring the IT Assets. IT Device Library on page 309: Describes the individual IT Devices and their properties. Care should be taken when entering tokens for IT Assets that are IP addresses e.g. the Host token for an 800xA CS asset when Host is an IP address. On Connectivity Servers that are running the Windows 2000 Server operating systems the IP address may be misinterpreted. On Windows 2000 Server computers, IP addresses with a leading zero will be interpreted as being octal numbers. For example will represent the decimal IP address When specifying individual decimal numbers that make up an IP address, the numbers should always be entered without leading zeros e.g This restriction does not apply to Window XP or Windows Server 2003 where numbers with leading zeros are treated as decimal numbers. 3BUA000118R

214 IT Assets Section 6 IT Asset and IT Device Library IT Assets The IT Assets described in this section are: Asset Generic Computer Node on page 216. Light Asset - Light Generic Computer Node on page 220. Computer Assets Process Status and Alarm List on page 221. Light Generic Computer Process Assets Alarm List on page 224. Computer Assets on page 228. Asset - Batch Client on page 228. Light Asset - Batch Client on page 229. Asset - Batch Primary Server with Client on page 230. Light Asset - Batch Primary Server with Client on page 231. Asset - Batch Secondary Server with Client on page 232. Light Asset - Batch Secondary Server with Client on page 232. Asset - Inform IT Calculations on page 234. Light Asset - Inform IT Calculations on page 234. Asset - Inform IT Complete on page 235. Light Asset - Inform IT Complete on page 236. Asset - Inform IT Display on page 237. Light Asset - Inform IT Display on page 237. Asset - Inform IT History on page 238. Light Asset - Inform IT History on page 239. Asset - Inform IT ODA on page 240. Light Asset - Inform IT ODA on page 240. Asset - Inform IT Scheduler on page 241. Light Asset - Inform IT Scheduler on page 241. Asset - Inform IT SoftPoint Server on page 242. Light Asset - Inform IT SoftPoint Server on page 242. Asset - 800xA AS on page 243. Light Asset - 800xA AS on page 244. Asset - 800xA Client on page 245. Light Asset - 800xA Client on page 245. Asset - 800xA Combined AS-CS on page 246. Light Asset - 800xA Combined AS-CS on page 247. Asset - 800xA CS on page 248. Light Asset - 800xA CS on page 249. Asset - PPB Client on page 250. Light Asset - PPB Client on page 251. Asset - PPB Config Server on page BUA000118R4101

215 Section 6 IT Asset and IT Device Library IT Assets Light Asset - PPB Config Server on page 252. Asset - PPB Harmony RTDS with Client on page 253. Light Asset - PPB Harmony RTDS with Client on page 254. Asset - PPB Historian on page 255. Light Asset - PPB Historian on page 255. Asset - PPB Melody RTDS with Client on page 256. Light Asset - PPB Melody RTDS with Client on page 257. Asset - PPB OPC RTDS with Client on page 258. Light Asset - PPB OPC RTDS with Client on page 259. Inform IT Performance Assets on page 260. Asset - hsmsgserver Messages In per Minute on page 260. Asset - hsmsgserver Messages in Queue on page 261. Asset - hsmsgserver Messages Out per Minute on page 264. Asset - PDL Messages In per Minute on page 266. Asset - PDL Messages in Queue on page 268. Asset - PDL Messages Out per Minute on page 270. Asset - Disk Free on page 272. Asset - Failures on page 274. Asset - Storages on page 276. Asset - DA Collection on page 278. Asset - HDA Collection on page 280. Asset - Generic Network Interface on page 282. Asset - Generic Printer on page 284. Network Monitoring on page 285. Asset - Network Utilization on page 285. Asset - Node to Node Utilization on page 289. Asset - Single Node Utilization on page 293. Asset - Cisco 12-Port Switch on page 296. Light Asset - Cisco 12-Port Switch on page 297. Asset - Cisco 24-Port Switch on page 298. Light Asset - Cisco 24-Port Switch on page 299. Asset - Cisco 48-Port Switch on page 300. Light Asset - Cisco 48-Port Switch on page 301. Asset - Hirschmann Mach 3000 Switch on page 302. Light Asset - Hirschmann Mach 3000 Switch on page 304. Asset - Hirschmann RS2 Switch on page 307. Light Asset - Hirschmann RS2 Switch on page BUA000118R

216 Asset Generic Computer Node Section 6 IT Asset and IT Device Library Asset Generic Computer Node Description: Represents a typical personal computer running Microsoft Windows. Includes basic status and alarm detection for the computer processor and hard drive performance, as well as memory and resource consumption. Assets can be customized by adding additional Disk Devices. Table 16 lists the Generic Computer Node Asset Devices. Table 16. Generic Computer Node Asset Device List Device Name IT Device Description Alarms CPU Alarm Computer CPU Alarm Generates an alarm when the CPU utilization becomes too high. Disk C Alarm Disk Drive 0 Alarm General Computer Alarm Status CPU Status CPU Alert Disk C Status Disk C Alert Disk Drive 0 Status Disk Volume Alarm Generates an alarm when the C disk drive partition becomes too full. Disk Drive Alarm Generates an alarm when the system detects any kind of problem with the physical hard drive. Only disk drive 0 is monitored. Computer General Alarm (Auto) Computer CPU Status Computer CPU Alert Disk Volume Status Disk Volume Alert Disk Drive Status Generates one or more alarms based on several factors. This device will automatically detect trends in resource usage and generate alarms when it anticipates a problem. Provides the current CPU loading percentage. Generates an alert when the CPU utilization becomes too high. Provides the C disk partition usage as a percentage of the total. Generates an alert when the C disk drive partition becomes too full. Provides model and status data for a hard drive BUA000118R4101

217 Section 6 IT Asset and IT Device Library Asset Generic Computer Node Device Name IT Device Description Status (continued) Disk Drive 0 Alert Disk Drive Alert Generates an alert when the system detects any kind of problem with the physical hard drive. Only disk drive 0 is monitored. General Computer Status General Computer Alert Table 16. Generic Computer Node Asset Device List (Continued) Computer General Status Computer General Alert Provides general status data for a computer, such as virtual memory usages, etc. Generates one or more alerts based on several factors. This device will automatically detect trends in resource usage and generate alerts when it anticipates a problem. Table 17 lists the IT General Properties for the Generic Computer Node Asset. Table 17. IT General Properties for Generic Computer Node Asset Name Default Value Description Host localhost Change this to the name or IP address of the computer to monitor. NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. IT Device Tokens are properties used by the PC, Network and Software Monitoring system to pass configuration information to the OPC server. Table 18 lists the Modifiable IT Device Token Configuration for the Generic Computer Node Asset. Table 18. Modifiable IT Device Token Configuration for Generic Computer Node Asset IT Device Name CPU Alarm Modifiable Tokens Default Value Description CPUOverload::LowLimit 80% The CPU load limit at which an alarm is generated. The value at which the system is still functional, but is being stressed beyond its normal means. 3BUA000118R

218 Asset Generic Computer Node Section 6 IT Asset and IT Device Library Table 18. Modifiable IT Device Token Configuration for Generic Computer Node Asset (Continued) IT Device Name CPU Alarm (cont) Modifiable Tokens Default Value Description CPUOverload::MediumLimit 90% The CPU load limit at which a medium alarm is generated. The value at which the system is probably starting to experience significant performance problems. CPUOverload::HighLimit 100% The CPU load limit which a high alarm is generated. The value at which a serious problem is occurring. This limit will only be reached if the CPU usage is at 100% for 10 seconds or more. CPU Alert Common Tokens::LowLimit 80% The CPU load limit at which an event is generated. The value at which the system is still functional, but is being stressed beyond its normal means. Disk C Alarm Common Tokens::MediumLimit 90% The CPU load limit at which a medium event is generated. The value at which the system is probably starting to experience significant performance problems. Common Tokens::HighLimit 100% The CPU load limit at which a high event is generated. The value at which a serious problem is occurring. This limit will only be reached if the CPU usage is at 100% for 10 seconds or more. Common Tokens::Drive c: The drive letter that is being monitored. FreeSpace::WarningLimit 5% The percentage of hard disk free disk space required before a Free Space warning alarm occurs. FreeSpace::SeriousLimit 3% The percentage of hard disk free disk space required before a Free Space serious alarm occurs. FreeSpace::CriticalLimit 1% The percentage of hard disk free disk space required before a Free Space critical alarm occurs BUA000118R4101

219 Section 6 IT Asset and IT Device Library Asset Generic Computer Node Table 18. Modifiable IT Device Token Configuration for Generic Computer Node Asset (Continued) IT Device Name Disk C Alert Disk C Status General Computer Alarm General Computer Alert Modifiable Tokens Default Value Description Common Tokens::Drive c: The drive letter that is being monitored. Common Tokens::WarningLimit Common Tokens::SeriousLimit Common Tokens::CriticalLimit 5% The percentage of hard disk free disk space required before a Free Space warning alert occurs. 3% The percentage of hard disk free disk space required before a Free Space serious alert occurs. 1% The percentage of hard disk free disk space required before a Free Space critical alert occurs. Common Tokens::Drive c: The drive letter that is being monitored. VM-Absolute::WarningLimit 5% The value at which the system is still functional, but is being stressed beyond its normal means, issuing an alarm. VM-Absolute::ErrorLimit 2% The value at which the system is probably starting to experience significant performance problems issuing an alarm. Common Tokens::WarningLimit 5% The value at which the system is still functional, but is being stressed beyond its normal means, issuing an alert. Common Tokens::ErrorLimit 2% The value at which the system is probably starting to experience significant performance problems, issuing an alert. 3BUA000118R

220 Light Asset - Light Generic Computer Node Section 6 IT Asset and IT Device Library Light Asset - Light Generic Computer Node A Light Generic Computer Node Asset is available providing basic alarm detection for the Generic Computer Node Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset Generic Computer Node on page 216 to set up the Light Generic Computer Node Asset. Refer to Table 18 to complete the Light Generic Computer Node Asset configuration BUA000118R4101

221 Section 6 IT Asset and IT Device Library Computer Assets Process Status and Alarm List Computer Assets Process Status and Alarm List Description: The following Device Name list represents the status and alarm detection of a key software process associated with a specific node type. This set of devices is repeatedly used for each of the processes in all of the Computer Assets. Table 19 lists the Software Process Devices. Table 19. Software Process Device List Device Name IT Device Description Alarms: Process.exe Alarm Status: Process.exe Alert Process.exe Status Computer Process Alarm (Compact) Computer Process Alert Computer Process Status Generates an alarm when a problem is detected with the process. Provides summaries of the state of several key indicators within the process. Provides the values of several indicators within the process. Table 20 lists the Modifiable IT Device Token Configurations for Software Processes. Table 20. Modifiable IT Device Token Configurations for Software Processes IT Device Name Modifiable Tokens Default Value Description Software Processes, for example: CommonTokens::ProcessName AfwADServer.exe (for example) AfwADServer.exe Alarm, AfwADServer.exe Alert, AfwADServer.exe Status The Process name to be monitored. If this is Windows 2000 the name may be different to allow for the shorter character length. Do not change this name. 3BUA000118R

222 Computer Assets Process Status and Alarm List Section 6 IT Asset and IT Device Library Table 20. Modifiable IT Device Token Configurations for Software Processes (Continued) IT Device Name Modifiable Tokens Default Value Description Software Processes (continued) ProcessHealth::WarningIncrease 10 The number of continuous sample increases that will cause a warning for threads, handles or VM levels. Values are averaged over a 15 minute interval, so a value of 10 implies a 150 minute period of continually increasing resource usage before the warning occurs. ProcessHealth::ErrorIncrease 20 The number of continuous sample increases that will cause an error for threads, handles or VM levels. Values are averaged over a 15 minute interval, so a value of 20 implies a 300 minute period of continually increasing resource usage before the error occurs. ProcessHealth::CPUWarningLimit 85% The sustained CPU load that indicates a warning situation. ProcessHealth::CPUErrorLimit 95% The sustained CPU load that indicates a serious problem BUA000118R4101

223 Section 6 IT Asset and IT Device Library Computer Assets Process Status and Alarm List Table 20. Modifiable IT Device Token Configurations for Software Processes (Continued) IT Device Name Modifiable Tokens Default Value Description Software Processes (continued) CommonTokens::WarningIncrease 10 Number of continuous sample increases that will cause a warning for threads, handles or VM levels. Values are averaged over 15 minute interval, so a value of 10 implies a 150 minute period of continually increasing resource usage before warning occurs. CommonTokens::ErrorIncrease 20 Number of continuous sample increases that will cause an error for threads, handles or VM levels. Values are averaged over a 15 minute interval, so a value of 20 implies a 300 minute period of continually increasing resource usage before the error occurs. CommonTokens::CPUWarningLimit 85% The sustained CPU load that indicates a warning situation. CommonTokens::CPUErrorLimit 95% The sustained CPU load that indicates a serious problem. CommonTokens::SampleAverages 6 The number of samples used to calculate the CPU moving average. 3BUA000118R

224 Light Generic Computer Process Assets Alarm List Section 6 IT Asset and IT Device Library Light Generic Computer Process Assets Alarm List Description: The following Device Name list represents the alarm detection of a key software process associated with a specific node type. This set of devices is repeatedly used for each of the processes in all of the Light Computer Assets. Table 21 lists the Light Generic Computer Asset Processes. Table 21. Light Generic Computer Asset Process List Device Name IT Device Description Alarms: Process.exe Alarm Status: Process.exe Alert Process.exe Status Light Computer Process Alarm (Compact) Light Computer Process Alert Light Computer Process Status Generates an alarm when a problem is detected with the process. Provides summaries of the state of several key indicators within the process. Provides the values of several indicators within the process. Table 22 lists the IT General Properties for Light Processes. Table 22. IT General Properties for Light Processes Name Default Value Description Host localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows BUA000118R4101

225 Section 6 IT Asset and IT Device Library Light Generic Computer Process Assets Alarm List Table 23 lists the Modifiable IT Device Token Configurations for Light Software Processes. Table 23. Modifiable IT Device Token Configurations for Light Software Processes IT Device Name Modifiable Tokens Default Value Description Process.exe Alarm CommonTokens::ProcessName The Process name to be monitored. If this is Windows 2000 the name may be different to allow for the shorter character length. ProcessHealth::WarningIncrease 10 The number of continuous sample increases that will cause a warning for threads, handles or VM levels. Values are averaged over a 15 minute interval, so a value of 10 implies a 150 minute period of continually increasing resource usage before the warning occurs. ProcessHealth::ErrorIncrease 20 The number of continuous sample increases that will cause an error for threads, handles or VM levels. Values are averaged over a 15 minute interval, so a value of 20 implies a 300 minute period of continually increasing resource usage before the error occurs. ProcessHealth::CPUWarningLimit 85% The sustained CPU load that indicates a warning situation. ProcessHealth::CPUErrorLimit 95% The sustained CPU load that indicates a serious problem. 3BUA000118R

226 Light Generic Computer Process Assets Alarm List Section 6 IT Asset and IT Device Library Table 23. Modifiable IT Device Token Configurations for Light Software Processes (Continued) IT Device Name Modifiable Tokens Default Value Description Process.exe Alert CommonTokens::ProcessName The Process name to be monitored. If this is Windows 2000 the name may be different to allow for the shorter character length. CommonTokens::WarningIncrease 10 The number of continuous sample increases that will cause a warning for threads, handles or VM levels. Values are averaged over a 15 minute interval, so a value of 10 implies a 150 minute period of continually increasing resource usage before the warning occurs. CommonTokens::ErrorIncrease 20 The number of continuous sample increases that will cause an error for threads, handles or VM levels. Values are averaged over a 15 minute interval, so a value of 20 implies a 300 minute period of continually increasing resource usage before the error occurs. CommonTokens::CPUWarningLimit 85% The sustained CPU load that indicates a warning situation. CommonTokens::CPUErrorLimit 95% The sustained CPU load that indicates a serious problem BUA000118R4101

227 Section 6 IT Asset and IT Device Library Light Generic Computer Process Assets Alarm List Table 23. Modifiable IT Device Token Configurations for Light Software Processes (Continued) IT Device Name Process.exe Alert (continued) Modifiable Tokens Default Value Description CommonTokens::SampleAverages 6 The number of samples used to calculate the CPU moving average. Process.exe Status CommonTokens::ProcessName The Process name to be monitored. If this is Windows 2000 the name may be different to allow for the shorter character length. 3BUA000118R

228 Computer Assets Section 6 IT Asset and IT Device Library Computer Assets Description: A superset of the Generic Computer, the Computer Assets monitor all of the status and alarm detection properties of the Generic Computer Asset, plus key software processes associated with each type of node. They can be customized in the same way as the Generic Computer Asset and have additional software processes added as required. Asset - Batch Client The Batch Client Asset contains the Generic Computer subset plus the processes listed in the Batch Client Software Process Name List. Batch Client Software Process Name List. Batch_netRouter.exe Batch_nwkser.exe Table 24 lists the IT General Properties for the Batch Client Asset. Table 24. IT General Properties for Batch Client Asset Name Default Value Description Host localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows Refer to Table 18 and Table 20 to complete the Batch Client Asset configuration BUA000118R4101

229 Section 6 IT Asset and IT Device Library Computer Assets Light Asset - Batch Client A Light Batch Client Asset is available providing basic alarm detection for the Computer Asset and the Batch Client Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for Asset - Batch Client on page 228 to set up the Light Batch Client Asset. 3BUA000118R

230 Computer Assets Section 6 IT Asset and IT Device Library Asset - Batch Primary Server with Client Description: The Batch Primary Server with Client Asset contains the Generic Computer subset plus the processes listed in the Batch Primary Server with Client Software Process Name List. Batch Primary Server with Client Software Process Name List. Batch_batch.exe Batch_bmscache.exe Batch_netRouter.exe Batch_nwkser.exe Batch_phased.exe Batch_recipem.exe Batch_Service.exe Batch_tab.exe Batch_tabi.exe Batch_unitm.exe BatchOPCAeServer.exe Table 25 lists the IT General Properties for Batch Primary Server with Client Asset. Table 25. IT General Properties for Batch Primary Server with Client Asset Name Default Value Description Host localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows BUA000118R4101

231 Section 6 IT Asset and IT Device Library Computer Assets Refer to Table 18 and Table 20 to complete the Batch Primary Server with Client Asset configuration. Light Asset - Batch Primary Server with Client A Light Batch Primary Server with Client Asset is available providing basic alarm detection for the Computer Asset and the Batch Primary Server with Client Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for Asset - Batch Primary Server with Client on page 230 to set up the Light Batch Primary Server with Client Asset. 3BUA000118R

232 Computer Assets Section 6 IT Asset and IT Device Library Asset - Batch Secondary Server with Client Description: The Batch Secondary Server with Client Asset contains the Generic Computer subset plus the processes listed in the Batch Secondary Server with Client Process Name List. Batch Secondary Server with Client Process Name List. Batch_netRouter.exe Batch_nwkser.exe Batch_Service.exe BatchOPCAeServer.exe Table 26 lists the IT General Properties for the Batch Secondary Server with Client Asset. Table 26. IT General Properties for Batch Secondary Server with Client Asset Name Default Value Description Host localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows Refer to Table 18 and Table 20 to complete the Batch Secondary Server with Client Asset configuration. Light Asset - Batch Secondary Server with Client A Light Batch Secondary Server with Client Asset is available providing basic alarm detection for the Computer Asset and the Batch Secondary Server with Client 232 3BUA000118R4101

233 Section 6 IT Asset and IT Device Library Computer Assets Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for Asset - Batch Secondary Server with Client on page 232 to set up the Light Batch Secondary Server with Client Asset. 3BUA000118R

234 Computer Assets Section 6 IT Asset and IT Device Library Asset - Inform IT Calculations Description: The Inform IT Calculations Asset contains only the software processes listed in the Inform IT Calculations Software Process Name List (not the Generic Computer subset) and is to be used with the Asset - Inform IT History on page 238. Inform IT Calculations Software Process Name List. CalculationService.exe Table 27 lists the IT General Properties for the Inform IT Calculations Asset. Table 27. IT General Properties for Inform IT Calculations Asset Name Default Value Description Host localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows Refer to Table 20 to complete the Inform IT Calculations configuration. Light Asset - Inform IT Calculations A Light Inform IT Calculations Asset is available providing basic alarm detection for the Inform IT Calculations Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - Inform IT Calculations on page 234 to set up the Light Inform IT Calculations Asset BUA000118R4101

235 Section 6 IT Asset and IT Device Library Computer Assets Asset - Inform IT Complete Description: The Inform IT Complete Asset contains the Generic Computer subset plus the processes listed in the Inform IT Complete Software Process Name List. Inform IT Complete Software Process Name List. AdsAbsDeployMgr.exe AdsCsCommSrv.exe AdsScadaSrv.exe AfwScheduler.exe CalculationService.exe EHOPCAEServer.exe hsadmin.exe hsarchiveservice.exe hscfgserver.exe hscollection.exe hseventlogcollector.exe hshdaserver.exe hshistorysync.exe hslogman.exe hsmsgserver.exe hspdlstorage.exe hsprofileserver.exe hsretrieval.exe hsserver.exe hsstorage.exe hssuperipc.exe odaserver.exe odaservice.exe omfcleanup.exe omfnameproc.exe omfpm.exe omfservice.exe omftimer.exe omonamebroker.exe omonodebroker.exe omoservice.exe 3BUA000118R

236 Computer Assets Section 6 IT Asset and IT Device Library omostoragedomain.exe omotypedirectory.exe PAS_Service.exe PdlApiSrv.exe SesServer.exe Table 28 lists the IT General Properties for the Inform IT Complete Asset. Table 28. IT General Properties for Inform IT Complete Asset Name Default Value Description Host localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. Refer to Table 18 and Table 20 to complete the Inform IT Complete Asset configuration. Light Asset - Inform IT Complete A Light Inform IT Complete Asset is available providing basic alarm detection for the Computer Asset and the Inform IT Complete Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - Inform IT Complete on page 235 to set up the Light Inform IT Complete Asset BUA000118R4101

237 Section 6 IT Asset and IT Device Library Computer Assets Asset - Inform IT Display Description: The Inform IT Display Asset contains only the software processes listed in the Inform IT Display Software Process Name List (not the Generic Computer subset) and is to be used with the Asset - Inform IT History on page 238. Inform IT Display Software Process Name List. ADSdpADO.exe ADSdpDCS.exe ADSdpDDR.exe ADSdpLOG.exe ADSdpOPC.exe ADSdpOPCHDA.exe ADSS.exe ADSspCOM.exe Table 29 lists the IT General Properties for the Inform IT Display Asset. Table 29. IT General Properties for Inform IT Display Asset Name Default Value Description Host localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows Refer to Table 20 to complete the Inform IT Display configuration. Light Asset - Inform IT Display A Light Inform IT Display Asset is available providing basic alarm detection for the Inform IT Display Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - Inform IT Display on page 237 to set up the Light Inform IT Display Asset. 3BUA000118R

238 Computer Assets Section 6 IT Asset and IT Device Library Asset - Inform IT History Description: The Inform IT History Asset contains the Generic Computer subset plus the processes listed in the Inform IT History Software Process Name List. Inform IT History Software Process Name List. EHOPCAEServer.exe hsadmin.exe hsarchiveservice.exe hscfgserver.exe hscollection.exe hseventlogcollector.exe hshdaserver.exe hshistorysync.exe hslogman.exe hsmsgserver.exe hspdlstorage.exe hsprofileserver.exe hsretrieval.exe hsserver.exe hsstorage.exe hssuperipc.exe omfcleanup.exe omfnameproc.exe omfpm.exe omfservice.exe omftimer.exe omonamebroker.exe omonodebroker.exe omoservice.exe omostoragedomain.exe omotypedirectory.exe PAS_Service.exe PdlApiSrv.exe SesServer.exe Table 30 lists the IT General Properties for the Inform IT History Asset BUA000118R4101

239 Section 6 IT Asset and IT Device Library Computer Assets Table 30. IT General Properties for the Inform IT History Asset Name Default Value Description Host localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. Refer to Table 18 and Table 20 to complete the Inform IT History configuration. Light Asset - Inform IT History A Light Inform IT History Asset is available providing basic alarm detection for the Computer Asset and the Inform IT History Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - Inform IT History on page 238 to set up the Light Inform IT History Asset. 3BUA000118R

240 Computer Assets Section 6 IT Asset and IT Device Library Asset - Inform IT ODA Description: This Asset contains only the software processes listed in the Inform IT ODA Software Process Name List (not the Generic Computer subset) and is to be used with the Asset - Inform IT History on page 238. Inform IT ODA Software Process Name List. odaserver.exe odaservice.exe Table 31 lists the IT General Properties for the Inform IT ODA Asset. Table 31. IT General Properties for Inform IT ODA Asset Name Default Value Description Host localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows Refer to Table 20 to complete the Inform IT ODA Asset configuration. Light Asset - Inform IT ODA A Light Inform IT ODA Asset is available providing basic alarm detection for the Inform IT ODA Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - Inform IT ODA on page 240 to set up the Light Inform IT ODA Asset BUA000118R4101

241 Section 6 IT Asset and IT Device Library Computer Assets Asset - Inform IT Scheduler Description: The Inform IT Scheduler Asset contains only the software processes listed in the Inform IT Scheduler Software Process Name List (not the Generic Computer subset) and is to be used with the Asset - Inform IT History on page 238. Inform IT Scheduler Software Process Name List. Afwscheduler.exe Table 32 lists the IT General Properties for the Inform IT Scheduler Asset. Table 32. IT General Properties for Inform IT Scheduler Asset Name Default Value Description Host localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows Refer to Table 20 to complete the Inform IT Scheduler Asset configuration. Light Asset - Inform IT Scheduler A Light Inform IT Scheduler Asset is available providing basic alarm detection for the Inform IT Scheduler Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - Inform IT Scheduler on page 241 to set up the Light Inform IT Scheduler Asset. 3BUA000118R

242 Computer Assets Section 6 IT Asset and IT Device Library Asset - Inform IT SoftPoint Server Description: This Asset contains only the software processes listed in the Inform IT SoftPoint Server Software Process Name List (not the Generic Computer subset) and is to be used with the Asset - Inform IT History on page 238. Inform IT SoftPoint Server Software Process Name List. AdsAbsDeployMgr.exe AdsCsCommSrv.exe AdsScadaSrv.exe Table 33 lists the IT General Properties for the Inform IT SoftPoint Server Asset. Table 33. IT General Properties for Inform IT Softpoint Server Asset Name Default Value Description Host localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows Refer to Table 20 to complete the Inform IT SoftPoint Server Asset configuration. Light Asset - Inform IT SoftPoint Server A Light Inform IT SoftPoint Server Asset is available providing basic alarm detection for the Inform IT SoftPoint Server Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - Inform IT SoftPoint Server on page 242 to set up the Light Inform IT SoftPoint Server Asset BUA000118R4101

243 Section 6 IT Asset and IT Device Library Computer Assets Asset - 800xA AS Description: The 800xA AS Asset contains the Generic Computer subset plus the processes listed in the 800xA AS Software Process Name List. 800xA AS Software Process Name List. AbbClientLicenseProvider.exe AdvAeAlarmManager.exe AdvAeEventCollector.exe AdvAeSoftAlarms.exe AfwADServer.exe AfwBackupService.exe AfwFsdNode.exe AfwFsdSrv.exe AfwServiceManager.exe AfwSMClient.exe AfwSysMsgSrv.exe AfwTimeSrvHdlr.exe AfwXRefSrv.exe Table 34 lists the IT General Properties for the 800xA AS Asset. Table 34. IT General Properties for 800xA AS Asset Name Default Value Description Host Localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows BUA000118R

244 Computer Assets Section 6 IT Asset and IT Device Library Refer to Table 18 and Table 20 to complete the 800xA AS Asset configuration. Light Asset - 800xA AS A Light 800xA AS Asset is available providing basic alarm detection for the Computer Asset and the 800xA AS Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - 800xA AS on page 243 to set up the Light 800xA AS Asset BUA000118R4101

245 Section 6 IT Asset and IT Device Library Computer Assets Asset - 800xA Client Description: The 800xA Client Asset contains the Generic Computer subset plus the processes listed in the 800xA Client Software Process Name List. 800xA Client Software Process Name List. AbbClientLicenseProvider.exe AfwFsdNode.exe AfwSMClient.exe Table 35 lists the IT General Properties for the 800xA Client Asset. Table 35. IT General Properties for 800xA Client Asset Name Default Value Description Host Localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows Refer to Table 18 and Table 20 to complete the 800xA Client Asset configuration. Light Asset - 800xA Client A Light 800xA Client Asset is available providing basic alarm detection for the Computer Asset and the 800xA Client Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - 800xA Client on page 245 to set up the Light 800xA Client Asset. 3BUA000118R

246 Computer Assets Section 6 IT Asset and IT Device Library Asset - 800xA Combined AS-CS Description: The 800xA Combined AS-CS Asset contains the Generic Computer subset plus the processes listed in the 800xA Combined AS-CS Software Process Name List. 800xA Combined AS-CS Software Process Name List. AbbClientLicenseProvider.exe AdvAeAlarmManager.exe AdvAeEventCollector.exe #0 AdvAeEventCollector.exe #1 AdvAeLogger.exe AdvAeSoftAlarms.exe AdvEAEngine.exe AdvHtHistorySrv.exe AfwADServer.exe AfwBackupService.exe AfwFsdNode.exe AfwFsdSrv.exe AfwServiceManager.exe AfwSMClient.exe AfwSysMsgSrv.exe AfwTimeSrvHdlr.exe AfwXRefSrv.exe A process name with a #n after it, where n is the instance number, indicates an instance of the process. Example: process.exe would be treated the same as process.exe #0 but process.exe #1 would be a second instance of the same process. Table 36 lists the IT General Properties for the 800xA Combined AS-CS Asset. Table 36. IT General Properties for 800xA Combined AS-CS Asset Name Default Value Description Host Localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value BUA000118R4101

247 Section 6 IT Asset and IT Device Library Computer Assets Table 36. IT General Properties for 800xA Combined AS-CS Asset (Continued) Name Default Value Description NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows Refer to Table 18 and Table 20 to complete the 800xA Combined AS-CS Asset configuration. Light Asset - 800xA Combined AS-CS A Light 800xA Combined AS-CS Asset is available providing basic alarm detection for the Computer Asset and the 800xA Combined AS-CS Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - 800xA Combined AS-CS on page 246 to set up the Light 800xA Combined AS-CS Asset. 3BUA000118R

248 Computer Assets Section 6 IT Asset and IT Device Library Asset - 800xA CS Description: The 800xA CS Asset contains the Generic Computer subset plus the processes listed in the 800xA CS Software Process Name List. 800xA CS Software Process Name List. AbbClientLicenseProvider.exe AdvAeEventCollector.exe AdvAeLogger.exe AdvEAEngine.exe AdvHtHistorySrv.exe AfwFsdNode.exe AfwServiceManager.exe AfwSMClient.exe Table 37 lists the IT General Properties for the 800xA CS Asset. Table 37. IT General Properties for 800xA CS Asset Name Default Value Description Host Localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows Refer to Table 18 and Table 20 to complete the 800xA CS Asset configuration BUA000118R4101

249 Section 6 IT Asset and IT Device Library Computer Assets Light Asset - 800xA CS A Light 800xA CS Asset is available providing basic alarm detection for the Computer Asset and the 800xA CS Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - 800xA CS on page 248 to set up the Light 800xA CS Asset. 3BUA000118R

250 Computer Assets Section 6 IT Asset and IT Device Library Asset - PPB Client Description: The PPB Client Asset contains the Generic Computer subset plus the processes listed in the PPB Client Software Process Name List. PPB Client Software Process Name List. EBDataSyncService.exe EbEventconServer.exe #0 EBServerBroker.exe A process name with a #n after it, where n is the instance number, indicates an instance of the process. Example: process.exe would be treated the same as process.exe #0 but process.exe #1 would be a second instance of the same process. Table 38 lists the IT General Properties for the PPB Client Asset. Table 38. IT General Properties for PPB Client Asset Name Default Value Description Host Localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows Refer to Table 18 and Table 20 to complete the PPB Client Asset configuration BUA000118R4101

251 Section 6 IT Asset and IT Device Library Computer Assets Light Asset - PPB Client A Light PPB Client Asset is available providing basic alarm detection for the Computer Asset and the PPB Client Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - PPB Client on page 250 to set up the Light PPB Client Asset. 3BUA000118R

252 Computer Assets Section 6 IT Asset and IT Device Library Asset - PPB Config Server Description: The PPB Config Server Asset contains the Generic Computer subset plus the processes listed in the PPB Config Server Software Process Name List. PPB Config Server Software Process Name List. EBDataSyncService.exe EBServerBroker.exe Table 39 lists the IT General Properties for the 800xA AS Asset. Table 39. IT General Properties for PPB Config Server Asset Name Default Value Description Host Localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows Refer to Table 18 and Table 20 to complete the PPB Config Server Asset configuration. Light Asset - PPB Config Server A Light PPB Config Server Asset is available providing basic alarm detection for the Computer Asset and the PPB Config Server Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - PPB Config Server on page 252 to set up the Light PPB Config Server Asset BUA000118R4101

253 Section 6 IT Asset and IT Device Library Computer Assets Asset - PPB Harmony RTDS with Client Description: The PPB Harmony RTDS with Client Asset contains the Generic Computer subset plus the processes listed in the PPB Harmony RTDS with Client Process Name List. PPB Harmony RTDS with Client Process Name List. EBDataSyncService.exe EbEventconServer.exe #0 EbEventconServer.exe #1 EbI90Server.exe EBServerBroker.exe EbSystemServer.exe SOAPSymTagAtomSrv.exe A process name with a #n after it, where n is the instance number, indicates an instance of the process. Example: process.exe would be treated the same as process.exe #0 but process.exe #1 would be a second instance of the same process. Table 40 lists the IT General Properties for the PPB Harmony RTDS with Client Asset. Table 40. IT General Properties for PPB Harmony RTDS with Client Asset Name Default Value Description Host Localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows BUA000118R

254 Computer Assets Section 6 IT Asset and IT Device Library Refer to Table 18 and Table 20 to complete the PPB Harmony RTDS with Client Asset configuration. Light Asset - PPB Harmony RTDS with Client A Light PPB Harmony RTDS with Client Asset is available providing basic alarm detection for the Computer Asset and the PPB Harmony RTDS with Client Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - PPB Harmony RTDS with Client on page 253 to set up the Light PPB Harmony RTDS with Client Asset BUA000118R4101

255 Section 6 IT Asset and IT Device Library Computer Assets Asset - PPB Historian Description: The PPB Historian Asset contains the Generic Computer subset plus the processes listed in the PPB Historian Software Process Name List. PPB Historian Software Process Name List. EBDataSyncService.exe EBHistorianServer.exe EBServerBroker.exe Table 41 lists the IT General Properties for the PPB Historian Asset. Table 41. IT General Properties for PPB Historian Asset Name Default Value Description Host Localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows Refer to Table 18 and Table 20 to complete the PPB Historian Asset configuration. Light Asset - PPB Historian A Light PPB Historian Asset is available providing basic alarm detection for the Computer Asset and the PPB Historian Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - PPB Historian on page 255 to set up the Light PPB Historian Asset. 3BUA000118R

256 Computer Assets Section 6 IT Asset and IT Device Library Asset - PPB Melody RTDS with Client Description: The PPB Melody RTDS with Client Asset contains the Generic Computer subset plus the processes listed in the PPB Melody RTDS with Client Software Process Name List. PPB Melody RTDS with Client Software Process Name List. EBDataSyncService.exe EbEventconServer.exe #0 EbEventconServer.exe #1 EbMelodyServer.exe EBServerBroker.exe EbSystemServer.exe SOAPSymTagAtomSrv.exe A process name with a #n after it, where n is the instance number, indicates an instance of the process. Example: process.exe would be treated the same as process.exe #0 but process.exe #1 would be a second instance of the same process. Table 42 lists the IT General Properties for the PPB Melody RTDS with Client Asset. Table 42. IT General Properties for PPB Melody RTDS with Client Asset Name Default Value Description Host Localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows BUA000118R4101

257 Section 6 IT Asset and IT Device Library Computer Assets Refer to Table 18 and Table 20 to complete the PPB Melody RTDS with Client Asset configuration. Light Asset - PPB Melody RTDS with Client A Light PPB Melody RTDS with Client Asset is available providing basic alarm detection for the Computer Asset and the PPB Melody RTDS with Client Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - PPB Melody RTDS with Client on page 256 to set up the Light PPB Melody RTDS with Client Asset. 3BUA000118R

258 Computer Assets Section 6 IT Asset and IT Device Library Asset - PPB OPC RTDS with Client Description: The PPB OPC RTDS with Client contains the Generic Computer subset plus the processes listed in the PPB OPC RTDS with Client Software Process Name List. PPB OPC RTDS with Client Software Process Name List. EBDataSyncService.exe EbEventconServer.exe #0 EbEventconServer.exe #1 EbOPCServer.exe EBServerBroker.exe EbSystemServer.exe SOAPSymTagAtomSrv.exe A process name with a #n after it, where n is the instance number, indicates an instance of the process. Example: process.exe would be treated the same as process.exe #0 but process.exe #1 would be a second instance of the same process. Table 43 lists the IT General Properties for the PPB OPC RTDS with Client Asset. Table 43. IT General Properties for PPB OPC RTDS with Client Asset Name Default Value Description Host Localhost Change this to the name or IP address of the computer to monitor. SettlingTime 30 The amount of time (30 minutes) to allow the system to settle before establishing a baseline for alarming. This is the recommended minimum value. NumberCPUs 1 Change this to match the number of CPUs on the computer being monitored. This can be determined by checking the hardware configuration. OSType XP The operating system of the process to be monitored. If W2K is entered into the field then Windows 2000 is used, any other value will cause XP to be used. Note: XP may be used for Windows BUA000118R4101

259 Section 6 IT Asset and IT Device Library Computer Assets Refer to Table 18 and Table 20 to complete the PPB OPC RTDS with Client Asset configuration. Light Asset - PPB OPC RTDS with Client A Light PPB OPC RTDS with Client Asset is available providing basic alarm detection for the Computer Asset and the PPB OPC RTDS with Client Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - PPB OPC RTDS with Client on page 258 to set up the Light PPB OPC RTDS with Client Asset. 3BUA000118R

260 Inform IT Performance Assets Section 6 IT Asset and IT Device Library Inform IT Performance Assets The basic categories of Inform IT Performance Assets are: IM API Counters. IM Archive Counters. IM Storage Counters. IM Collection Counters. Each Inform IT Performance Asset listed in this section will indicate to which category it belongs. Alarms Asset - hsmsgserver Messages In per Minute Description: This Asset provides status information and alarming for the rate of speed of messages received by the History Message Server. Table 44 lists IT Devices for the hsmsgserver Messages In per Minute Performance Counter. Table 44. hsmsgserver Messages In per Minute Performance Counter IT Device List Device Name IT Device Description Message per Minute Status Message per Minute Message per Minute Performance Counter Alarm Performance Counter Alert Performance Counter Status Generates an alarm when the performance counter has reached or exceeded its acceptable limits. Generates an alert when the performance counter has reached or exceeded its acceptable limits. Provides the current value of the performance counter BUA000118R4101

261 Section 6 IT Asset and IT Device Library Inform IT Performance Assets Table 45 lists the IT General Properties for the hsmsgserver Messages In per Minute Performance Counter. Table 45. IT General Properties for hsmsgserver Messages In per Minute Performance Counter Name Default Value 1 Description Host Localhost Change this to the name or IP address of the computer to monitor. Category IM API Counters For System Use Do not modify. The Windows performance monitor category that this counter can be found in. Counter Msg / Minute In For System Use Do not modify. The number of messages per minute received by the History Message Server. The typical maximum value is 30 messages per second. Instance hsmsgserver Msgs per minute For System Use Do not modify. Windows performance name that this counter belongs to. LowLevel 3600 Default low alarm limit, value at which the system is still functional but is being stressed beyond its normal capabilities. This is the recommended minimum value. MediumLevel 3650 Default medium alarm limit, value at which the system is starting to experience significant performance problems. This is the recommended minimum value. HighLevel 3700 Default high alarm limit, value at which a serious problem is occurring. This is the recommended minimum value. Condition IM hsmsgserver Messages In / Minute are High For System Use Do not modify. An alarm would mean that the messages in per minute are higher than design limits. NOTE: 1. All bold entries in the Default Value column are for system use only. DO NOT modify the values in the Default Value column. Asset - hsmsgserver Messages in Queue Description: This Asset provides status information and alarming for the number of unprocessed messages in the History Message Server queue. 3BUA000118R

262 Inform IT Performance Assets Section 6 IT Asset and IT Device Library Table 46 lists IT Devices for the hsmsgserver Messages In Queue Performance Counter. Table 46. hsmsgserver Messages in Queue Performance Counter IT Device List Alarms Device Name IT Device Description Message per Minute Status Message per Minute Message per Minute Performance Counter Alarm Performance Counter Alert Performance Counter Status Generates an alarm when the performance counter has reached or exceeded its acceptable limits. Generates an alert when the performance counter has reached or exceeded its acceptable limits. Provides the current value of the performance counter. Table 47 lists the IT General Properties for the hsmsgserver Messages In Queue Performance Counter. Table 47. IT General Properties for hsmsgserver Messages In Queue Performance Counter Name Default Value 1 Description Host localhost Change this to the name or IP address of the computer to monitor. Category IM API Counters For System Use Do not modify. The Windows performance monitor category that this counter can be found in. Counter Msgs in Queue For System Use Do not modify. The number of messages in the queue. Instance hsmsgserver Msgs per minute For System Use Do not modify. Windows performance name that this counter belongs to. LowLevel 3600 Default low alarm limit, value at which the system is still functional but is being stressed beyond its normal capabilities. This is the recommended minimum value BUA000118R4101

263 Section 6 IT Asset and IT Device Library Inform IT Performance Assets Table 47. IT General Properties for hsmsgserver Messages In Queue Performance Counter (Continued) Name Default Value 1 Description MediumLevel 3650 Default medium alarm limit, value at which the system is starting to experience significant performance problems. This is the recommended minimum value. HighLevel 3700 Default high alarm limit, value at which a serious problem is occurring. This is the recommended minimum value. Condition IM hsmsgserver Messages in Queue are High For System Use Do not modify. An alarm indicates that the messages in the queue are higher than design limits and the queue is filling up and may overflow. NOTE: 1. All bold entries in the Default Value column are for system use only. DO NOT modify the values in the Default Value column. 3BUA000118R

264 Inform IT Performance Assets Section 6 IT Asset and IT Device Library Alarms Asset - hsmsgserver Messages Out per Minute Description: This Asset provides status information and alarming for the rate of speed of messages sent by the History Message Server. Table 48 lists IT Devices for the hsmsgserver Messages Out per Minute Performance Counter. Table 48. hsmsgserver Messages Out per Minute Performance Counter IT Device List Device Name IT Device Description Message per Minute Status Message per Minute Message per Minute Performance Counter Alarm Performance Counter Alert Performance Counter Status Generates an alarm when the performance counter has reached or exceeded its acceptable limits. Generates an alert when the performance counter has reached or exceeded its acceptable limits. Provides the current value of the performance counter. Table 49 lists the IT General Properties for the hsmsgserver Messages Out per Minute Performance Counter. Table 49. IT General Properties for hsmsgserver Messages Out per Minute Performance Counter Name Default Value 1 Description Host localhost Change this to the name or IP address of the computer to monitor. Category IM API Counters For System Use Do not modify. The Windows performance monitor category that this counter can be found in. Counter Msgs/Minute Out For System Use Do not modify. The number of messages processed per minute. Instance hsmsgserver Msgs per minute For System Use Do not modify. Windows performance name that this counter belongs to 264 3BUA000118R4101

265 Section 6 IT Asset and IT Device Library Inform IT Performance Assets Table 49. IT General Properties for hsmsgserver Messages Out per Minute Performance Counter (Continued) Name Default Value 1 Description LowLevel 3600 Default low alarm limit, value at which the system is still functional but is being stressed beyond its normal capabilities. This is the recommended minimum value. MediumLevel 3650 Default medium alarm limit, value at which the system is starting to experience significant performance problems. This is the recommended minimum value. HighLevel 3700 Default high alarm limit, value at which a serious problem is occurring. This is the recommended minimum value. Condition IM hsmsgserver Msgs Messages Out/ Minutes are high For System Use Do not modify. An alarm indicates that the messages per minute out are higher than design limits. NOTE: 1. All bold entries in the Default Value column are for system use only. DO NOT modify the values in the Default Value column. 3BUA000118R

266 Inform IT Performance Assets Section 6 IT Asset and IT Device Library Alarms Asset - PDL Messages In per Minute Description: This Asset provides status information and alarming for the rate of speed of messages received by the Production Data Logger. Table 50 lists IT Devices for the PDL Messages In per Minute Performance Counter. Table 50. PDL Messages In per Minute Performance Counter IT Device List Device Name IT Device Description Message per Minute Status Message per Minute Message per Minute Performance Counter Alarm Performance Counter Alert Performance Counter Status Generates an alarm when the performance counter has reached or exceeded its acceptable limits. Generates an alert when the performance counter has reached or exceeded its acceptable limits. Provides the current value of the performance counter. Table 51 lists the IT General Properties for the PDL Messages In per Minute Performance Counter. Table 51. IT General Properties for PDL Messages In per Minute Performance Counter Name Default Value 1 Description Host localhost Change this to the name or IP address of the computer to monitor. Category IM API Counters For System Use Do not modify. The Windows performance monitor category that this counter can be found in. Counter Msgs/Minute In For System Use Do not modify. The number of messages received per minute. The typical maximum value is 30 messages per second BUA000118R4101

267 Section 6 IT Asset and IT Device Library Inform IT Performance Assets Table 51. IT General Properties for PDL Messages In per Minute Performance Counter (Continued) Instance Name Default Value 1 Description PDL Msgs per minute For System Use Do not modify. Windows performance name that this counter belongs to LowLevel 3600 Default low alarm limit, value at which the system is still functional but is being stressed beyond its normal capabilities. This is the recommended minimum value. MediumLevel 3650 Default medium alarm limit, value at which the system is starting to experience significant performance problems. This is the recommended minimum value. HighLevel 3700 Default high alarm limit, value at which a serious problem is occurring. This is the recommended minimum value. Condition IM PDL Messages in / Minutes are High For System Use Do not modify. An alarm indicates that the messages per minutes in are higher than design limits. NOTE: 1. All bold entries in the Default Value column are for system use only. DO NOT modify the values in the Default Value column. 3BUA000118R

268 Inform IT Performance Assets Section 6 IT Asset and IT Device Library Alarms Asset - PDL Messages in Queue Description: This Asset provides status information and alarming for the number of unprocessed messages in the Production Data Logger queue. Table 52 lists IT Devices for the PDL Messages In Queue Performance Counter. Table 52. PDL Messages In Queue Performance Counter IT Device List Device Name IT Device Description Message per Minute Status Message per Minute Message per Minute Performance Counter Alarm Performance Counter Alert Performance Counter Status Generates an alarm when the performance counter has reached or exceeded its acceptable limits. Generates an alert when the performance counter has reached or exceeded its acceptable limits. Provides the current value of the performance counter. Table 53 lists the IT General Properties for the PDL Messages in Queue Performance Counter. Table 53. IT General Properties for PDL Messages in Queue Performance Counter Name Default Value Description Host localhost Change this to the name or IP address of the computer to monitor. Category IM API Counters For System Use Do not modify. The Windows performance monitor category that this counter can be found in. Counter Msgs in Queue For System Use Do not modify. The number of messages remaining to be processed. Instance PDL Msgs per minute For System Use Do not modify. Windows performance name that this counter belongs to BUA000118R4101

269 Section 6 IT Asset and IT Device Library Inform IT Performance Assets Table 53. IT General Properties for PDL Messages in Queue Performance Counter (Continued) Name Default Value Description LowLevel 3600 Default low alarm limit, value at which the system is still functional but is being stressed beyond its normal capabilities. This is the recommended minimum value. MediumLevel 3650 Default medium alarm limit, value at which the system is starting to experience significant performance problems. This is the recommended minimum value. HighLevel 3700 Default high alarm limit, value at which a serious problem is occurring. This is the recommended minimum value. Condition IM PDL Messages in Queue are High For System Use Do not modify. An alarm indicates that the messages in the queue are higher than design limits and the queue is filling up and may overflow. NOTE: 1. All bold entries in the Default Value column are for system use only. DO NOT modify the values in the Default Value column. 3BUA000118R

270 Inform IT Performance Assets Section 6 IT Asset and IT Device Library Alarms Asset - PDL Messages Out per Minute Description: This Asset provides status information and alarming for the rate of speed of messages sent by the Production Data Logger. Table 54 lists IT Devices for the PDL Messages Out per Minute Performance Counter. Table 54. PDL Messages Out per Minute Performance Counter IT Device List Device Name IT Device Description Message per Minute Status Message per Minute Message per Minute Performance Counter Alarm Performance Counter Alert Performance Counter Status Generates an alarm when the performance counter has reached or exceeded its acceptable limits. Generates an alert when the performance counter has reached or exceeded its acceptable limits. Provides the current value of the performance counter. Table 55 lists the IT General Properties for the PDL Messages Out per Minute Performance Counter. Table 55. IT General Properties for PDL Messages Out per Minute Performance Counter Name Default Value Description Host localhost Change this to the name or IP address of the computer to monitor. Category IM API Counters For System Use Do not modify. The Windows performance monitor category that this counter can be found in. Counter Instance Msgs /Minute Out PDL Msgs per minute For System Use Do not modify. The number of messages processed per minute. For System Use Do not modify. Windows performance name that this counter belongs to 270 3BUA000118R4101

271 Section 6 IT Asset and IT Device Library Inform IT Performance Assets Table 55. IT General Properties for PDL Messages Out per Minute Performance Counter (Continued) Name Default Value Description LowLevel 3600 Default low alarm limit, value at which the system is still functional but is being stressed beyond its normal capabilities. This is the recommended minimum value. MediumLevel 3650 Default medium alarm limit, value at which the system is starting to experience significant performance problems. This is the recommended minimum value. HighLevel 3700 Default high alarm limit, value at which a serious problem is occurring. This is the recommended minimum value. Condition IM PDL Messages Out/ Minutes are High For System Use Do not modify. An alarm indicates that the messages per minute out are higher than design limits. NOTE: 1. All bold entries in the Default Value column are for system use only. DO NOT modify the values in the Default Value column. 3BUA000118R

272 Inform IT Performance Assets Section 6 IT Asset and IT Device Library Asset - Disk Free Description: This Asset displays the amount of space that is left on either the hard disk or removable media that is being used for archiving historical data. Table 56 lists IT Devices for the Disk Free Asset. Table 56. Disk Free Asset IT Device List Device Name IT Device Description Alarms Free Disk Space Performance Counter Alarm (Reversed) Generates an alarm when the performance counter has reached or exceeded its acceptable limits. Status Free Disk Space Free Disk Space Performance Counter Alert (Reversed) Performance Counter Status Generates an alert when the performance counter has reached or exceeded its acceptable limits. Provides the current value of the performance counter. Table 57 lists the IT General Properties for the Disk Free Asset. Table 57. IT General Properties for Disk Free Asset Name Default Value 1 Description Host localhost Change this to the name or IP address of the computer to monitor. Category IM Archive Counters For System Use Do not modify. The category that this counter can be found in. Counter Disk Free For System Use Do not modify. Percentage disk free space left on either the hard drive or removable media. Instance IM Archive For System Use Do not modify. Used for archiving historical data. WarningLevel 15 Default warning alarm limit. The percentage of hard disk space required before a Free Space Warning alarm occurs BUA000118R4101

273 Section 6 IT Asset and IT Device Library Inform IT Performance Assets SeriousLevel 10 Default serious alarm limit. The percentage of hard disk space required before a Free Space Serious alarm occurs. CriticalLevel 5 Default critical alarm limit. The percentage of hard disk space required before a Free Space Critical alarm occurs. Condition Table 57. IT General Properties for Disk Free Asset (Continued) Name Default Value 1 Description IM Archive Disk Free Space Low For System Use Do not modify. An alarm indicates that the percent free space is lower than the set limits. NOTE: 1. All bold entries in the Default Value column are for system use only. DO NOT modify the values in the Default Value column. 3BUA000118R

274 Inform IT Performance Assets Section 6 IT Asset and IT Device Library Asset - Failures Description: This Asset provides status information and alarming for the number of Archive Failures since the last reboot on the computer in which Archiving is being executed. Table 58 lists IT Devices for the Failures Asset. Table 58. Failures Asset IT Device List Device Name IT Device Description Alarms Archive Failure Alarm Performance Counter Alarm Generates an alarm when the performance counter has reached or exceeded its acceptable limits. Status Archive Failure Alert Failures Since Last Reboot Performance Counter Alert Performance Counter Status Generates an alert when the performance counter has reached or exceeded its acceptable limits. Provides the current value of the performance counter. Table 59 lists the IT General Properties for the Failures Asset. Table 59. IT General Properties for Failures Asset Name Default Value 1 Description Host Localhost Change this to the name or IP address of the computer to monitor. Category IM Archive Counters For System Use Do not modify. The category that this counter can be found in. Counter Failures For System Use Do not modify. Failures since last reboot. Instance IM Archive For System Use Do not modify. Used for archiving data. LowLevel 10 Default low alarm limit. The number of archive failures before a low alarm occurs BUA000118R4101

275 Section 6 IT Asset and IT Device Library Inform IT Performance Assets MediumLevel 20 Default medium alarm limit. The number of archive failures before a medium alarm occurs. HighLevel 30 Default high alarm limit. The number of archive failures before a high alarm occurs. Condition Table 59. IT General Properties for Failures Asset (Continued) Name Default Value 1 Description IM Archive Failures are High For System Use Do not modify. An alarm indicates that more failures have occurred then expected. NOTE: 1. All bold entries in the Default Value column are for system use only. DO NOT modify the values in the Default Value column. 3BUA000118R

276 Inform IT Performance Assets Section 6 IT Asset and IT Device Library Asset - Storages Description: This Asset provides status information and alarming for the rate of speed of numeric data points being stored for historical purposes. Table 60 lists IT Devices for the Storages Asset. Table 60. Storages Asset IT Device List Device Name IT Device Description Alarms Storages Alarm Performance Counter Alarm Generates an alarm when the performance counter has reached or exceeded its acceptable limits. Status Storages Alert Messages per Minute Performance Counter Alert Performance Counter Status Generates an alert when the performance counter has reached or exceeded its acceptable limits. Provides the current value of the performance counter. Table 61 lists the IT General Properties for the Storages Asset. Table 61. IT General Properties for Storages Asset Name Default Value 1 Description Host Localhost Change this to the name or IP address of the computer to monitor. Category IM Storage Counters For System Use Do not modify. The category that this counter can be found in. Counter Pts/minute For System Use Do not modify. The number of numeric data points being stored to history per minute. Instance IM Storage For System Use Do not modify. Windows performance name that this counter belongs to. LowLevel Default low alarm limit. If the number of numeric data being stored to history goes above the default limit a low alarm occurs BUA000118R4101

277 Section 6 IT Asset and IT Device Library Inform IT Performance Assets MediumLevel Default medium alarm limit. If the number of numeric data being stored to history goes above the default limit a medium alarm occurs. HighLevel Default high alarm limit. If the number of numeric data being stored to history goes above the default limit a high alarm occurs. Condition Table 61. IT General Properties for Storages Asset (Continued) Name Default Value 1 Description IM Storages are High For System Use Do not modify. An alarm indicates that more failures have occurred then expected. NOTE: 1. All bold entries in the Default Value column are for system use only. DO NOT modify the values in the Default Value column. 3BUA000118R

278 Inform IT Performance Assets Section 6 IT Asset and IT Device Library Asset - DA Collection Description: This Asset provides status information and alarming for the rate of speed of data collection by the DA Server. Table 62 lists IT Devices for the DA Collection Asset. Table 62. DA Collection Asset IT Device List Device Name IT Device Description Alarms DA Collection Alarm Performance Counter Alarm Generates an alarm when the performance counter has reached or exceeded its acceptable limits. Status DA Collection Alert Points Collected per Minute Performance Counter Alert Performance Counter Status Generates an alert when the performance counter has reached or exceeded its acceptable limits. Provides the current value of the performance counter. Table 63 lists the IT General Properties for the DA Collection Asset. Table 63. IT General Properties for DA Collection Asset Name Default Value Description Host Localhost Change this to the name or IP address of the computer to monitor. Category IM Collection Counters For System Use Do not modify. The category that this counter can be found in. Counter Pts/Minute For System Use Do not modify. The number of points per minute being collected from the 800xA DA server. Instance IM DA_Collection For System Use Do not modify. Windows performance name the counter belongs to. LowLevel Default low alarm limit. The number of DA points collected before a low alarm occurs BUA000118R4101

279 Section 6 IT Asset and IT Device Library Inform IT Performance Assets MediumLevel Default medium alarm limit. The number of DA points collected before a medium alarm occurs. HighLevel Default high alarm limit. The number of DA points collected before a high alarm occurs. Condition Table 63. IT General Properties for DA Collection Asset (Continued) Name Default Value Description IM DA Collection is High For System Use Do not modify. An alarm indicates that the DA points per minute are higher than the default limits. NOTE: 1. All bold entries in the Default Value column are for system use only. DO NOT modify the values in the Default Value column. 3BUA000118R

280 Inform IT Performance Assets Section 6 IT Asset and IT Device Library Asset - HDA Collection Description: This Asset provides status information and alarming for the rate of speed of data collection by the HDA Server. Table 64 lists IT Devices for the HDA Collection Asset. Table 64. HDA Collection Asset IT Device List Device Name IT Device Description Alarms HDA Collection Alarm Performance Counter Alarm Generates an alarm when the performance counter has reached or exceeded its acceptable limits. Status HDA Collection Alert Points Collected per Minute Performance Counter Alert Performance Counter Status Generates an alert when the performance counter has reached or exceeded its acceptable limits. Provides the current value of the performance counter. Table 65 lists the IT General Properties for the HDA Collection Asset. Table 65. IT General Properties for HDA Collection Asset Name Default Value Description Host Localhost Change this to the name or IP address of the computer to monitor. Category IM Collection Counters For System Use Do not modify. The category that this counter can be found in. Counter Pts/Minute For System Use Do not modify. The number of points per minute being collected from the 800xA HDA server. Instance IM HDA_Collection For System Use Do not modify. Windows performance name the counter belongs to. LowLevel Default low alarm limit. The number of HDA points collected before a low alarm occurs BUA000118R4101

281 Section 6 IT Asset and IT Device Library Inform IT Performance Assets MediumLevel Default medium alarm limit. The number of HDA points collected before a medium alarm occurs. HighLevel Default high alarm limit. The number of HDA points collected before a high alarm occurs. Condition Table 65. IT General Properties for HDA Collection Asset (Continued) Name Default Value Description IM HDA Collection is High For System Use Do not modify. An alarm indicates that the HDA points per minute are higher than the default limits. NOTE: 1. All bold entries in the Default Value column are for system use only. DO NOT modify the values in the Default Value column. 3BUA000118R

282 Asset - Generic Network Interface Section 6 IT Asset and IT Device Library Asset - Generic Network Interface Description: This Asset provides status information and alarming for a network interface card in a computer. Table 66 lists IT Devices for the Generic Network Interface Asset. Table 66. Generic Network Interface Asset IT Device List Device Name IT Device Description Alarms Network Interface Alarm Generic Interface Alarm Generates an alarm when an abnormal condition occurs. Status Network Interface Alert Generic Interface Alert Generates an alert when an abnormal condition occurs. Network Interface Status Generic Interface Status Returns the status of key attributes of a network interface. Table 67 lists the IT General Properties for the Disk Free Asset. Table 67. IT General Properties for Generic Network Interface Asset Name Default Value Description Host Localhost Change this to the name or IP address of the computer where the network interface is installed that you want to monitor. In order to complete the configuration requirements for the Generic Network Interface Asset, identify the Device ID number using the WMI Object Browser. A free download of the WMI Administrative Tools, including the WMI Object Browser is available at: 1. The first step in finding the Device ID is determining the Device Name. Depending on the operation system, select either: Start > Settings > Network and Dial-up Connections 282 3BUA000118R4101

283 Section 6 IT Asset and IT Device Library Asset - Generic Network Interface -or- Start > Connect To > Show All Connections The Local Area Connection lists the device names of the network cards that are enabled within the computer. For example, Intel(R) PRO/1000 MT Network Connection. This is the name to search for in the WMI Object Browser. 2. Launch the WMI Object Browser. Select: Start > All Programs > WMI Tools > WMI Object Browser 3. Navigate to and select the following directory: root\cimv2\win32_systemdevices\win32_networkadapter The right-hand pane displays information regarding the network cards. 4. Scroll through the columns on the right and locate the Name column. 5. Find the row with the Device Name that was determined in Step Scroll to the left, back to the DeviceID column (the first column) to find the corresponding Device ID number. This number is the WMI key that is entered in the IT Device Token Configuration (refer to Table 68). Table 68. Modifiable IT Device Token Configurations for Generic Network Interface IT Device Name Network Interface Alarm Network Interface Alert Network Interface Status Modifiable Tokens Default Value 1 Description CommonTokens::DeviceID CommonTokens::DeviceID CommonTokens::DeviceID NOTE: 1. Blank cells in the Default Value column indicate that a value must be entered. Enter the WMI key that identifies the network interface. Enter the WMI key that identifies the network interface. This will be the same number as used in the Network Interface Alarm default value. Enter the WMI key that identifies the network interface. This will be the same number as used in the Network Interface Alarm default value. 3BUA000118R

284 Asset - Generic Printer Section 6 IT Asset and IT Device Library Asset - Generic Printer Alarms Description: This Asset represents a typical network printer. It includes basic status information, and alarm detection for items such as out of paper. Models tested: HP Laserjet 5M, Xerox Document Center 470ST. Table 69 lists the IT Devices for the Generic Printer Asset. Table 69. Generic Printer IT Device List Device Name IT Device Description Printer Alarm Printer Alarm Generates alarms for low toner, paper jammed, etc. Status Printer Alert Printer Alert Generates alerts for low toner, paper jammed, etc. Printer Status Printer Status Provides key status information pertaining to the printer, such as name, location, printer status, etc. Table 69 lists the IT General Properties for the Generic Printer Asset. Table 70. IT General Properties for Generic Printer Asset Name Default Value 1 Description Host Localhost Leave this name as the default local host. Community Public Change the SNMP community name for the device being monitored. This name is equivalent to a password allowing communication. Check with network personnel responsible for configuring this device to determine the name. IP Address Enter the IP address of the printer being monitored. NOTE: 1. Blank cells in the Default Value column indicate that a value must be entered BUA000118R4101

285 Section 6 IT Asset and IT Device Library Network Monitoring Network Monitoring Asset - Network Utilization Description: The Network Utilization Asset monitors network traffic on the network segment. Table 71 lists IT Devices for the Network Utilization Asset. Table 71. Network Utilization Asset IT Device List Device Name IT Device Description Alarms Network Alarm Network Utilization Alarm Alarms when the utilization exceeds the nominal bandwidth at three thresholds. Status Network Alert Network Utilization Alert Alerts when the utilization exceeds the nominal bandwidth at three thresholds. Network Utilization (Bytes per s) Status Network Utilization (Percent) Status Network Utilization (Bytes per s) Status Network Utilization (Percent) Status Utilization in bytes per second. Utilization in percent of nominal bandwidth. Table 72 lists the IT General Properties for the Network Utilization Asset. Table 72. IT General Properties for Network Utilization Asset Name Default Value 1,2 Description Host Enter the name or IP address of the computer where the network monitor is running. IP Address Enter the IP address of the network adapter that is connected to the target network. Family All The IP protocol family. This is the recommended value. Protocol All The IP protocol. This is the recommended value. Application All The IP application. This is the recommended value. 3BUA000118R

286 Network Monitoring Section 6 IT Asset and IT Device Library Table 72. IT General Properties for Network Utilization Asset (Continued) Name Default Value 1,2 Description Port This must be left blank. The Port used by the network monitor. NOTES: 1. Blank cells in the Default Value column indicate that a value must be entered. 2. Shaded cells in the Default Value column indicate that the value must be left blank. Table 73 lists the modifiable IT Device Token Configurations for the Network Utilization Asset. Table 73. Modifiable IT Device Token Configurations for Network Utilization Asset IT Device Name Network Alarm Modifiable Tokens Default Value Description CommonTokens::Family All The IP protocol family. This is the recommended value. CommonTokens::Protocol All The IP protocol. This is the recommended value. CommonTokens::Application All The IP application. This is the recommended value. CommonTokens::LowLevel 25% The low level network utilization threshold, exceeding the default value causes an alarm. CommonTokens::MediumLevel 50% The medium level network utilization threshold, exceeding the default value causes an alarm. CommonTokens::HighLevel 75% The high level network utilization threshold, exceeding the default value causes an alarm. CommonTokens::SampleCount 15 The number of samples used to average the utilization calculation BUA000118R4101

287 Section 6 IT Asset and IT Device Library Network Monitoring Table 73. Modifiable IT Device Token Configurations for Network Utilization Asset (Continued) IT Device Name Network Alert CommonTokens::Family All The IP protocol family. This is the recommended value. CommonTokens::Protocol All The IP protocol. This is the recommended value. CommonTokens::Application All The IP application. This is the recommended value. CommonTokens::LowLevel 25% The low level network utilization threshold, exceeding the default value causes an alert. CommonTokens::MediumLevel 50% The medium level network utilization threshold, exceeding the default value causes an alert. CommonTokens::HighLevel 75% The high level network utilization threshold, exceeding the default value causes an alert. CommonTokens::SampleCount 15 The number of samples used to average the utilization calculation. Network Utilization (Bytes per s) Status Modifiable Tokens Network Utilization (Bytes per s) Status::Family Network Utilization (Bytes per s) Status::Protocol Network Utilization (Bytes per s) Status::Application Network Utilization (Bytes per s) Status::SampleCount Default Value Description All The IP protocol family. This is the recommended value. All The IP protocol. This is the recommended value. All The IP application. This is the recommended value. 15 The number of samples used to average the utilization calculation. 3BUA000118R

288 Network Monitoring Section 6 IT Asset and IT Device Library Table 73. Modifiable IT Device Token Configurations for Network Utilization Asset (Continued) IT Device Name Network Utilization (Percent) Status Modifiable Tokens Network Utilization (Percent) Status::Family Network Utilization (Percent) Status::Protocol Network Utilization (Percent) Status::Application Network Utilization (Percent) Status::SampleCount Default Value All All All Description The IP protocol family. This is the recommended value. The IP protocol. This is the recommended value. The IP application. This is the recommended value. 15 The number of samples used to average the utilization calculation BUA000118R4101

289 Section 6 IT Asset and IT Device Library Network Monitoring Asset - Node to Node Utilization Description: The Node to Node Utilization Asset monitors traffic between two specific nodes. Table 74 lists IT Devices for the Node to Node Utilization Asset. Table 74. Node to Node Utilization Asset IT Device List Device Name IT Device Description Alarms Node to Node Alarm Node to Node Utilization Alarm Alarms when the utilization exceeds the nominal bandwidth at three thresholds. Status Node to Node Alert Node to Node Utilization (Bytes per s) Node to Node Utilization (Percent) Host Node to Node Utilization Alert Node to Node Utilization (Bytes per s) Status Node to Node Utilization (Percent) Alerts when the utilization exceeds the nominal bandwidth at three thresholds. Node to Node utilization in bytes per sec. Node to Node utilization in percent of nominal bandwidth. Table 75 lists the IT General Properties for the Node to Node Utilization Asset. Table 75. IT General Properties for Node to Node Utilization Asset Name Default Value 1,2 Description IP Address Port Enter the name or IP address of the host computer where the network monitor is running. Enter the IP address of the network adapter on the host computer that is connected to the target network. This must be left blank. The Port used by the network monitor. NOTES: 1. Blank cells in the Default Value column indicate that a value must be entered. 2. Shaded cells in the Default Value column indicate that the value must be left blank. 3BUA000118R

290 Network Monitoring Section 6 IT Asset and IT Device Library Table 76 lists the modifiable IT Device Token Configurations for the Node to Node Utilization Asset. Table 76. Modifiable IT Device Token Configurations for Node to Node Utilization Asset IT Device Name Node to Node Alarm Node to Node Alert Modifiable Tokens Default Value 1 Description CommonTokens::Node1 Enter the computer name or IP address of the first computer that is being monitored. CommonTokens::Node2 Enter the computer name or IP address of the second computer that is being monitored. CommonTokens::Family All The IP protocol family. This is the recommended value. CommonTokens::Protocol All The IP protocol. This is the recommended value. CommonTokens::Application All The IP application. This is the recommended value. CommonTokens::LowLevel 25% The low level network utilization threshold, exceeding the default value causes an alarm. CommonTokens::MediumLevel 50% The medium level network utilization threshold, exceeding the default value causes an alarm. CommonTokens::HighLevel 75% The high level network utilization threshold, exceeding the default value causes an alarm. CommonTokens::SampleCount 15 The number of samples used to average the utilization calculation. CommonTokens::Node1 Enter the computer name or IP address of the first computer that is being monitored. CommonTokens::Node2 Enter the computer name or IP address of the second computer that is being monitored BUA000118R4101

291 Section 6 IT Asset and IT Device Library Network Monitoring Table 76. Modifiable IT Device Token Configurations for Node to Node Utilization Asset (Continued) IT Device Name Node to Node Alert (cont) Node to Node Utilization (Bytes per s) Status Modifiable Tokens Default Value 1 Description CommonTokens::Family All The IP protocol family. This is the recommended value. CommonTokens::Protocol All The IP protocol. This is the recommended value. CommonTokens::Application All The IP application. This is the recommended value. CommonTokens::LowLevel 25% The low level network utilization threshold, exceeding the default value causes an alert. CommonTokens::MediumLevel 50% The medium level network utilization threshold, exceeding the default value causes an alert. CommonTokens::HighLevel 75% The high level network utilization threshold, exceeding the default value causes an alert. CommonTokens::SampleCount 15 The number of samples used to average the utilization calculation. Status::Family All The IP protocol family. This is the recommended value. Status::Protocol All The IP protocol. This is the recommended value. Status::Application All The IP application. This is the recommended value. Status::SampleCount 15 The number of samples used to average the utilization calculation. Status::Node1 Enter the computer name or IP address of the first computer that is being monitored. Status::Node2 Enter the computer name or IP address of the second computer that is being monitored. 3BUA000118R

292 Network Monitoring Section 6 IT Asset and IT Device Library Table 76. Modifiable IT Device Token Configurations for Node to Node Utilization Asset (Continued) IT Device Name Node to Node Utilization (Percent) Status Modifiable Tokens Default Value 1 Description Status::Family All The IP protocol family. This is the recommended value. Status::Protocol All The IP protocol. This is the recommended value. Status::Application All The IP application. This is the recommended value. Status::SampleCount 15 The number of samples used to average the utilization calculation. Status::Node1 Status::Node2 NOTE: 1. Blank cells in the Default Value column indicate that a value must be entered. Enter the computer name or IP address of the first computer that is being monitored. Enter the computer name or IP address of the second computer that is being monitored BUA000118R4101

293 Section 6 IT Asset and IT Device Library Network Monitoring Asset - Single Node Utilization Description: The Single Node Utilization Asset monitors traffic on a single node. Table 77 lists IT Devices for the Single Node Utilization Asset. Table 77. Single Utilization Asset IT Device List Device Name IT Device Description Alarms Node Alarm Node Utilization Alarm Alarms when the utilization exceeds the nominal bandwidth at three thresholds. Status Node Alert Node Utilization Alert Alerts when the utilization exceeds the nominal bandwidth at three thresholds. Node Utilization (Bytes per s) Status Node Utilization (Bytes per s) Node to Node utilization in bytes per sec. Node Utilization (Percent) Status Node Utilization (Percent) Node utilization in percent of nominal bandwidth. Table 78 lists the IT General Properties for the Single Node Utilization Asset. Table 78. IT General Properties for Single Node Utilization Asset Name Default Value 1,2 Description Host Enter the name or IP address of the host computer that the network monitor is running. IP Address Enter the IP address of the network adapter on the host computer that is connected to the target network. Port This must be left blank. The Port used by the network monitor. NOTES: 1. Blank cells in the Default Value column indicate that a value must be entered. 2. Shaded cells in the Default Value column indicate that the value must be left blank. 3BUA000118R

294 Network Monitoring Section 6 IT Asset and IT Device Library IT Device Name Table 79 lists the modifiable IT Device Token Configurations for the Single Node Utilization Asset. Table 79. Modifiable IT Device Token Configurations for Single Node Utilization Asset Modifiable Tokens Default Value 1 Description Node Alarm CommonTokens::Node Enter the computer name or IP address that is being monitored. CommonTokens::Family All The IP protocol family. This is the recommended value. CommonTokens::Protocol All The IP protocol. This is the recommended value. CommonTokens::Application All The IP application. This is the recommended value. CommonTokens::LowLevel 25% The low level network utilization threshold, exceeding the default value causes an alarm. CommonTokens::MediumLevel 50% The medium level network utilization threshold, exceeding the default value causes an alarm. CommonTokens::HighLevel 75% The high level network utilization threshold, exceeding the default value causes an alarm. CommonTokens::SampleCount 15 The number of samples used to average the utilization calculation. Node Alert CommonTokens::Node Enter the computer name or IP address that is being monitored. CommonTokens::Family All The IP protocol family. This is the recommended value. CommonTokens::Protocol All The IP protocol. This is the recommended value. CommonTokens::Application All The IP application. This is the recommended value BUA000118R4101

295 Section 6 IT Asset and IT Device Library Network Monitoring Table 79. Modifiable IT Device Token Configurations for Single Node Utilization Asset (Continued) IT Device Name Node Alert (cont) Node Utilization (Bytes per s) Status Node Utilization (Percent) Status Modifiable Tokens Default Value 1 Description CommonTokens::LowLevel 25% The low level network utilization threshold, exceeding the default value causes an alert. CommonTokens::MediumLevel 50% The medium level network utilization threshold, exceeding the default value causes an alert. CommonTokens::HighLevel 75% The high level network utilization threshold, exceeding the default value causes an alert. CommonTokens::SampleCount 15 The number of samples used to average the utilization calculation. Status::Family All The IP protocol family. This is the recommended value. Status::Protocol All The IP protocol. This is the recommended value. Status::Application All The IP application. This is the recommended value. Status::SampleCount 15 The number of samples used to average the utilization calculation. Status::Node Enter the computer name or IP address that is being monitored. Status::Family All The IP protocol family. This is the recommended value. Status::Protocol All The IP protocol. This is the recommended value. Status::Application All The IP application. This is the recommended value. Status::SampleCount 15 The number of samples used to average the utilization calculation. Status::Node Enter the computer name or IP address that is being monitored. NOTE: 1. Blank cells in the Default Value column indicate that a value must be entered. 3BUA000118R

296 Asset - Cisco 12-Port Switch Section 6 IT Asset and IT Device Library Asset - Cisco 12-Port Switch Description: This Asset represents the Cisco 12-Port Switch device. It generates alarms when a port problem occurs or optionally when a port is disconnected. Indicates typical switch related data such as port speed, traffic counters, and in and out error counters. Table 80 lists IT Devices for the Cisco 12-Port Switch Asset. Table 80. Cisco 12-Port Switch Asset IT Device List Device Name IT Device Description Alarms Cisco 12-Port Switch Alarm Status Cisco 12-Port Switch Alert Cisco 12-Port Switch Status Cisco 12-Port Switch Alarm Cisco 12-Port Switch Alert Cisco 12-Port Switch Status Alarms when any port in the switch is faulty or disconnected. Alerts when any port in the switch is faulty or disconnected. Returns the status of key attributes. Table 81 lists the IT General Properties for the Cisco 12-Port Switch Asset. Table 81. IT General Properties for Cisco 12-Port Switch Asset Name Default Value 1 Description Host localhost Change this to the name or IP address of the computer making the status requests to the switch. This is typically the same computer running the monitoring software. This is not the IP address of the switch. IP Address Enter the IP address of the switch being monitored. Community public Change the SNMP community name for the device being monitored. This name is equivalent to a password allowing communication. Check with network personnel responsible for configuring this device to determine the name BUA000118R4101

297 Section 6 IT Asset and IT Device Library Light Asset - Cisco 12-Port Switch Table 81. IT General Properties for Cisco 12-Port Switch Asset (Continued) Name Default Value 1 Description AlarmOnOpenPort false If true, an alarm will be generated if a port becomes disconnected. If false, disconnected ports are not treated as error conditions. False is the default. ErrorRateLimit 5 The number of errors per second on a specific port above which the port is identified as being faulty. ConsecutiveErrorCount 5 The number of consecutive error update periods that a fault port remains at fault before the problem is signaled back to the client as an event. NOTE: 1. Blank cells in the Default Value column indicate that a value must be entered. Light Asset - Cisco 12-Port Switch A Light Cisco 12-Port Switch Asset is available providing basic alarm detection for the Cisco 12-Port Switch Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - Cisco 12-Port Switch on page 296 to set up the Light Cisco 12-Port Switch Asset. 3BUA000118R

298 Asset - Cisco 24-Port Switch Section 6 IT Asset and IT Device Library Asset - Cisco 24-Port Switch Description: This Asset represents the Cisco 24-Port Switch device. It generates alarms when a port problem occurs or optionally when a port is disconnected. Indicates typical switch related data such as port speed, traffic counters, and in and out error counters. Table 82 lists IT Devices for the Cisco 24-Port Switch Asset. Table 82. Cisco 24-Port Switch Asset IT Device List Device Name IT Device Description Alarms Cisco 24-Port Switch Alarm Status Cisco 24-Port Switch Alert Cisco 24-Port Switch Status Cisco 24-Port Switch Alarm Cisco 24-Port Switch Alert Cisco 24-Port Switch Status Alarms when any port in the switch is faulty or disconnected. Alerts when any port in the switch is faulty or disconnected. Returns the status of key attributes. Table 83 lists the IT General Properties for the Cisco 24-Port Switch Asset. Table 83. IT General Properties for Cisco 24-Port Switch Asset Name Default Value 1 Description Host localhost Change this to the name or IP address of the computer making the status requests to the switch. This is typically the same computer running the monitoring software. This is not the IP address of the switch. IP Address Enter the IP address of the switch being monitored. Community public Change the SNMP community name for the device being monitored. This name is equivalent to a password allowing communication. Check with network personnel responsible for configuring this device to determine the name BUA000118R4101

299 Section 6 IT Asset and IT Device Library Light Asset - Cisco 24-Port Switch Table 83. IT General Properties for Cisco 24-Port Switch Asset (Continued) Name Default Value 1 Description AlarmOnOpenPort false If true, an alarm will be generated if a port becomes disconnected. If false, disconnected ports are not treated as error conditions. False is the default. ErrorRateLimit 5 The number of errors per second on a specific port above which the port is identified as being faulty. ConsecutiveErrorCount 5 The number of consecutive error update periods that a fault port remains at fault before the problem is signaled back to the client as an event. NOTE: 1. Blank cells in the Default Value column indicate that a value must be entered. Light Asset - Cisco 24-Port Switch A Light Cisco 24-Port Switch Asset is available providing basic alarm detection for the Cisco 24-Port Switch Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - Cisco 24-Port Switch on page 298 to set up the Light Cisco 24-Port Switch Asset. 3BUA000118R

300 Asset - Cisco 48-Port Switch Section 6 IT Asset and IT Device Library Asset - Cisco 48-Port Switch Description: This Asset represents the Cisco 48-Port Switch device. It generates alarms when a port problem occurs or optionally when a port is disconnected. Indicates typical switch related data such as port speed, traffic counters, and in and out error counters. Table 84 lists IT Devices for the Cisco 48-Port Switch Asset. Table 84. Cisco 48-Port Switch Asset IT Device List Device Name IT Device Description Alarms Cisco 48-Port Switch Alarm Status Cisco 48-Port Switch Alert Cisco 48-Port Switch Status Cisco 48-Port Switch Alarm Cisco 48-Port Switch Alert Cisco 48-Port Switch Status Alarms when any port in the switch is faulty or disconnected. Alerts when any port in the switch is faulty or disconnected. Returns the status of key attributes. Table 85 lists the IT General Properties for the Cisco 48-Port Switch Asset. Table 85. IT General Properties for Cisco 48-Port Switch Asset Name Default Value 1 Description Host localhost Change this to the name or IP address of the computer making the status requests to the switch. This is typically the same computer running the monitoring software. This is not the IP address of the switch. IP Address Enter the IP address of the switch being monitored. Community public Change the SNMP community name for the device being monitored. This name is equivalent to a password allowing communication. Check with network personnel responsible for configuring this device to determine the name BUA000118R4101

301 Section 6 IT Asset and IT Device Library Light Asset - Cisco 48-Port Switch Table 85. IT General Properties for Cisco 48-Port Switch Asset (Continued) Name Default Value 1 Description AlarmOnOpenPort false If true, an alarm will be generated if a port becomes disconnected. If false, disconnected ports are not treated as error conditions. False is the default. ErrorRateLimit 5 The number of errors per second on a specific port above which the port is identified as being faulty. ConsecutiveErrorCount 5 The number of consecutive error update periods that a fault port remains at fault before the problem is signaled back to the client as an event. NOTE: 1. Blank cells in the Default Value column indicate that a value must be entered. Light Asset - Cisco 48-Port Switch A Light Cisco 48-Port Switch Asset is available providing basic alarm detection for the Cisco 48-Port Switch Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - Cisco 48-Port Switch on page 300 to set up the Light Cisco 48-Port Switch Asset. 3BUA000118R

302 Asset - Hirschmann Mach 3000 Switch Section 6 IT Asset and IT Device Library Asset - Hirschmann Mach 3000 Switch Description: This Asset represents the Hirschmann Mach 3000 switch device. It generates alarms when a port or power problem occur. Indicates typical switch related data such as port speed and traffic counters. Table 86 lists IT Devices for the Hirschmann Mach 3000 Switch Asset. Table 86. Hirschmann Mach 3000 Switch Asset IT Device List Device Name IT Device Description Alarms Hirschmann Module 1 Alarm Hirschmann PS 1 Alarm Status Hirschmann Module 1 Alert Hirschmann n-port Alarm Hirschmann Power Supply Alarm Hirschmann 8-Port Alert Hirschmann PS 1 Alert Hirschmann Power Supply Alert Hirschmann Base Status Hirschmann Module 1 Status Hirschmann PS 1 Status Hirschmann Mach 3000 Base Status Hirschmann 8-Port Status Hirschmann Power Supply Status Generates a single summary alarm if any problems are detected on this module or port range. Generates an alarm if any problems are found on the specified power supply. Generates an alert if a problem is detected on this module or an individual port. Generates an alert if any problems are found on the specified power supply. Returns the basic status attributes. Generates an alert if a problem is detected on this module or an individual port. Generates an alert if any problems are found on the specified power supply BUA000118R4101

303 Section 6 IT Asset and IT Device Library Asset - Hirschmann Mach 3000 Switch Table 87 lists the IT General Properties for the Hirschmann Mach 3000 Switch Asset. Table 87. IT General Properties for Hirschmann Mach 3000 Switch Asset Name Default Value 1 Description Host localhost Change this to the name or IP address of the computer making the status requests to the switch. This is typically the same computer running the monitoring software. This is not the IP address of the switch. IP Address Enter the IP address of the switch being monitored. Community public Change the SNMP community name for the device being monitored. This name is equivalent to a password allowing communication. Check with network personnel responsible for configuring this device to determine the name. AlarmOnOpenPort true Will enable or disable alarming on a disconnected port. NOTE: 1. Blank cells in the Default Value column indicate that a value must be entered. Table 88 lists the Modifiable IT Device Token Configurations for the Hirschmann Mach 3000 Switch Asset. Table 88. Modifiable IT Device Token Configurations for a Hirschmann Mach 3000 Switch Asset IT Device Name Modifiable Tokens Default Value 1 Description Hirschmann Module 1 Alarm PortHealth::StartPortIndex PortHealth::NumberPorts Enter the first port index for the module. Enter the number of ports in the module. Hirschmann Module 1 Alert CommonToken::PortIndex-1 - CommonToken::PortIndex-8 Enter the index number of the port in the overall Hirschmann switch. 3BUA000118R

304 Light Asset - Hirschmann Mach 3000 Switch Section 6 IT Asset and IT Device Library IT Device Name Hirschmann Module 1 Status Hirschmann PS 1 Alarm Hirschmann PS 1 Alert Hirschmann PS 1 Status Table 88. Modifiable IT Device Token Configurations for a Hirschmann Mach 3000 Switch Asset (Continued) Modifiable Tokens CommonToken::PortIndex-1 - CommonToken::PortIndex-8 Light Asset - Hirschmann Mach 3000 Switch Default Value 1 Enter the index number of the port in the overall Hirschmann switch. Alarm::Enable True Enables alarm detection on the specified power supply. Alarm::PowerSupplyIndex 1 Indicates the power supply index. CommonTokens::Enable True Enables alarm detection on the specified power supply. CommonTokens::PowerSupplyIndex 1 Indicates the power supply index. PowerSupplyStatus:: 1 Indicates the power supply index. PowerSupplyIndex NOTE: 1. Blank cells in the Default Value column indicate that a value must be entered. Description Description: This Light Asset represents a Hirschmann Mach 3000 Switch device. IT generates alarms when a port or power problem occurs. It indicates typical switch related data such as port speed and traffic counters. Table 89 lists IT Devices for the Light Hirschmann Mach 3000 Switch Asset. Table 89. Light Hirschmann Mach 3000 Switch Asset IT Device List Device Name IT Device Description Alarms Hirschmann Module 1 Alarm Hirschmann PS 1 Alarm Status Light Hirschmann n-port Alarm Light Hirschmann Power Supply Alarm Generates a single summary alarm if any problems are detected on this module or port range. Generates an alarm if any problems are found on the specified power supply BUA000118R4101

305 Section 6 IT Asset and IT Device Library Light Asset - Hirschmann Mach 3000 Switch Table 89. Light Hirschmann Mach 3000 Switch Asset IT Device List (Continued) Device Name IT Device Description Hirschmann Module 1 Alert Light Hirschmann 8-Port Alert Hirschmann PS 1 Alert Light Hirschmann Power Supply Alert Hirschmann Base Status Hirschmann Mach 3000 Base Status Generates an alert if a problem is detected on this module or an individual port. Generates an alert if any problems are found on the specified power supply. Returns the basic status attributes. Table 90 lists the IT General Properties for the Light Hirschmann Mach 3000 Switch Asset. Table 90. IT General Properties for Light Hirschmann Mach 3000 Switch Asset Name Default Value 1 Description Host localhost Change this to the name or IP address of the computer making the status requests to the switch. This is typically the same computer running the monitoring software. This is not the IP address of the switch. IP Address Enter the IP address of the switch being monitored. Community public Change the SNMP community name for the device being monitored. This name is equivalent to a password allowing communication. Check with network personnel responsible for configuring this device to determine the name. AlarmOnOpenPort true Will enable or disable alarming on a disconnected port. NOTE: 1. Blank cells in the Default Value column indicate that a value must be entered. 3BUA000118R

306 Light Asset - Hirschmann Mach 3000 Switch Section 6 IT Asset and IT Device Library IT Device Name Hirschmann Module 1 Alarm Hirschmann Module 1 Alert Hirschmann PS 1 Alarm Hirschmann PS 1 Alert Table 91 lists the Modifiable IT Device Token Configurations for the Light Hirschmann Mach 3000 Switch Asset. Table 91. Modifiable IT Device Token Configurations for a Light Hirschmann Mach 3000 Switch Asset Modifiable Tokens PortHealth::StartPortIndex PortHealth::NumberPorts CommonToken::PortIndex-1 - CommonToken::PortIndex-8 Default Value 1 Description Enter the first port index for the module. Enter the number of ports in the module. Enter the index number of the port in the overall Hirschmann switch. Alarm::Enable True Enables alarm detection on the specified power supply. Alarm::PowerSupplyIndex 1 Indicates the power supply index. CommonTokens::Enable True Enables alarm detection on the specified power supply. CommonTokens::PowerSupplyIndex 1 Indicates the power supply index. NOTE: 1. Blank cells in the Default Value column indicate that a value must be entered BUA000118R4101

307 Section 6 IT Asset and IT Device Library Asset - Hirschmann RS2 Switch Asset - Hirschmann RS2 Switch Description: This Asset represents the Hirschmann RS2 switch device. It generates alarms when a port or power problem occur. Indicates typical switch related data such as port speed and traffic counters. Table 92 lists IT Devices for the Hirschmann RS2 Switch Asset. Table 92. Hirschmann RS2 Switch Asset IT Device List Device Name IT Device Description Alarms Hirschmann Alarm Hirschmann RS2 Alarm Generates alarms on port and power supply problems. Status Hirschmann Alert Hirschmann RS2 Alert Generates alerts on port and power supply problems. Hirschmann Status Hirschmann RS2 Status Returns the status of key attributes. Table 93 lists the IT General Properties for the Hirschmann RS2 Switch Asset. Table 93. IT General Properties for Hirschmann RS2 Switch Asset Name Default Value 1 Description Host localhost Change this to the name or IP address of the computer making the status requests to the switch. This is typically the same computer running the monitoring software. This is not the IP address of the switch. IP Address Enter the IP address of the switch being monitored. Community public Change the SNMP community name for the device being monitored. This name is equivalent to a password allowing communication. Check with network personnel responsible for configuring this device to determine the name. NOTE: 1. Blank cells in the Default Value column indicate that a value must be entered. 3BUA000118R

308 Light Asset - Hirschmann RS2 Switch Section 6 IT Asset and IT Device Library IT Device Name Hirschmann Alarm Hirschmann Alert Table 94 lists the Modifiable IT Device Token Configurations for the Hirschmann RS2 Switch Asset. Table 94. Modifiable IT Device Token Configurations for a Hirschmann RS2 Switch Asset Modifiable Tokens PowerSupply-1::Enable PowerSupply-2::Enable Port-1-AlarmOnOpen Port-7-AlarmOnOpen Port-1::Enable Port-7::Enable CommonTokens::Enable- PowerSupply-1 CommonTokens::Enable- PowerSupply-2 CommonTokens::Enable-Port-1- AlarmOnOpen CommonTokens::Enable-Port-7- AlarmOnOpen CommonTokens::Enable Port-1 CommonTokens::Enable Port-7 Default Value 1 True True True True True True NOTE: 1. Blank cells in the Default Value column indicate that a value must be entered. Description Enables alarm detection on the specified power supply. Enables alarming on the port when it is not connected. Otherwise, alarms are only generated when problems occur on connected ports. Enables alarm detection on the specified port. Enables alert detection on the specified power supply. Enables alerting on the port when it is not connected. Otherwise, alerts are only generated when problems occur on connected ports. Enables alert detection on the specified port. Light Asset - Hirschmann RS2 Switch A Light Hirschmann RS2 Switch Asset is available providing basic alarm detection for the Hirschmann RS2 Switch Asset. Status information is not returned. The data is subscribed at a slower rate (60 seconds) when using Light Assets. Follow the configuration procedures for the Asset - Hirschmann RS2 Switch on page 307 to set up the Light Hirschmann RS2 Switch Asset BUA000118R4101

309 Section 6 IT Asset and IT Device Library IT Device Library IT Device Library IT Devices are used to compose the IT Assets. They can also be added into existing IT Asset objects when required. There are three distinct IT Devices: Alarm Devices: Devices that generate alarms when failure conditions exist. Properties defined in Alarm Devices return alarm definition strings for use by Asset Optimization to generate alarms. Alarm Devices are always driven by scripts. The returned properties are used for the purpose of being processed into alarms by Asset Optimization. Alert Devices: Devices that generate alerts when failure conditions exist. Properties defined in Alert Devices return Alert Strings or Alert Numeric Values for use by the Auto-Populate IT Faceplate. The faceplate displays the Alert Strings and uses the Alert Numeric Value to determine the color of the string. Alert Devices are always driven by scripts. Status Devices: Devices that return only status information, no alarms. Properties defined in Status Devices typically return Boolean, numeric, or string values. Status devices may be driven by either WMI data directly, or via scripts. The Alarm Devices described in this section are: Alarm Device - Generic Interface Alarm on page 312. Alarm Device - Network Utilization Alarm on page 314. Alarm Device - Node to Node Utilization Alarm on page 316. Alarm Device - Node Utilization Alarm on page 318. Alarm Device - Performance Counter Alarm (Alarm) on page 320. Alarm Device - Performance Counter Alarm (Reversed) (Reversed Alarm) on page 321. Alarm Device - Computer CPU Alarm on page 323. Light Alarm Device - Light Computer CPU Alarm on page 324. Alarm Device - Computer General Alarm (Auto) on page 326. Light Alarm Device - Light Computer General Alarm (Auto) on page 327. Alarm Device - Computer General Alarm on page 329. Alarm Device - Computer Process Alarm on page 331. Alarm Device - Computer Process Alarm (Compact) on page 336. Light Alarm Device - Light Computer Process Alarm (Compact) on page BUA000118R

310 IT Device Library Section 6 IT Asset and IT Device Library Alarm Device - Computer Process Alarm (Auto) on page 338. Alarm Device - Computer Process Alarm (Min) on page 340. Alarm Device - Disk Drive Alarm on page 341. Alarm Device - Disk Volume Alarm on page 343. Light Alarm Device - Light Disk Volume Alarm on page 344. Alarm Device - Printer Alarm on page 346. Alarm Device - Cisco 12-Port Switch Alarm on page 350. Light Alarm Device - Light Cisco 12-Port Switch Alarm on page 352. Alarm Device - Cisco 24-Port Switch Alarm on page 353. Light Alarm Device - Light Cisco 24-Port Switch Alarm on page 355. Alarm Device - Cisco 48-Port Switch Alarm on page 356. Light Alarm Device - Light Cisco 48-Port Switch Alarm on page 358. Alarm Device - Hirschmann 8-Port Alarm on page 359. Light Alarm Device - Light Hirschmann 8-Port Alarm on page 361. Alarm Device - Hirschmann n-port Alarm on page 362. Light Alarm Device - Light Hirschmann n-port Alarm on page 362. Alarm Device - Hirschmann Power Supply Alarm on page 363. Light Alarm Device - Light Hirschmann Power Supply Alarm on page 364. Alarm Device - Hirschmann RS2 Alarm on page 367. Light Alarm Device - Light Hirschmann RS2 Alarm on page 371. The Status Devices described in this section are: Status Device - Generic Interface Alert on page 312. Status Device - Generic Interface Status on page 312. Status Device - Network Utilization Alert on page 314. Status Device - Network Utilization (Bytes per s) Status on page 314. Status Device - Network Utilization (Percent) Status on page 315. Status Device - Node to Node Utilization Alert on page 316. Status Device - Node To Node Utilization (Bytes per s) Status on page 316. Status Device - Node To Node Utilization (Percent) Status on page 317. Status Device - Node Utilization Alert on page 318. Status Device - Node Utilization (Bytes per s) Status on page 318. Status Device - Node Utilization (Percent) Status on page 319. Status Device - Performance Counter Alert (Performance Alert) on page 320. Status Device - Performance Counter (Reversed) Alert (Reversed Performance Alert) on page 321. Status Device - Performance Counter Status (Value) on page BUA000118R4101

311 Section 6 IT Asset and IT Device Library IT Device Library Status Device - Computer CPU Alert on page 323. Status Device - Computer CPU Status on page 323. Light Status Device - Light Computer CPU Alert on page 324. Light Status Device - Light Computer General Alert on page 328. Status Device - Computer General Alert on page 329. Status Device - Computer General Status on page 330. Status Device - Computer Process Alert on page 332. Status Device - Computer Process Status on page 333. Light Status Device - Light Computer Process Alert on page 334. Light Status Device - Light Computer Process Status on page 334. Status Device - Disk Drive Alert on page 341. Status Device - Disk Drive Status on page 341. Status Device - Disk Volume Alert on page 343. Status Device - Disk Volume Status on page 344. Light Status Device - Light Disk Volume Alert on page 345. Status Device - Printer Alert on page 347. Status Device - Printer Status on page 349. Status Device - Cisco 12-Port Switch Alert on page 350. Status Device - Cisco 12-Port Switch Status on page 351. Light Status Device - Light Cisco 12-Port Switch Alert on page 352. Status Device - Cisco 24-Port Switch Alert on page 353. Status Device - Cisco 24-Port Switch Status on page 354. Light Status Device - Light Cisco 24-Port Switch Alert on page 355. Status Device - Cisco 48-Port Switch Alert on page 356. Status Device - Cisco 48-Port Switch Status on page 357. Light Status Device - Light Cisco 48-Port Switch Alert on page 358. Status Device - Hirschmann 8-Port Alert on page 359. Status Device - Hirschmann 8-Port Status on page 360. Light Status Device - Light Hirschmann 8-Port Alert on page 361. Status Device - Hirschmann Power Supply Alert on page 363. Status Device - Hirschmann Power Supply Status on page 364. Light Status Device - Light Hirschmann Power Supply Alert on page 365. Status Device - Hirschmann Mach 3000 Base Status on page 366. Status Device - Hirschmann RS2 Alert on page 369. Status Device - Hirschmann RS2 Status on page 369. Light Status Device - Light Hirschmann RS2 Alert on page BUA000118R

312 Alarm Device - Generic Interface Alarm Section 6 IT Asset and IT Device Library Alarm Device - Generic Interface Alarm Description: The alarm status of the device. Table 95 lists the Generic Interface Alarm Conditions/Subconditions. Table 95. Generic Interface Alarm Conditions/Subconditions Conditions Subconditions Generated Description Status Normal The network adapter is functioning normally. Bad The network interface hardware may have been removed or the remote computer may not be available. Status Device - Generic Interface Alert Description: Current value or status of the interface adapter. Table 96 lists the Generic Interface Alert properties. Table 96. Generic Interface Alert Properties Property Data Type Description Status String The status of the network interface adapter. Value-Status Numeric A numeric representation of the current state of the network interface adapter. Status Device - Generic Interface Status Description: Current value or status of the interface adapter. Table 97 lists the Generic Interface Status properties. Table 97. Generic Interface Status Properties Property Data Type Description Name String The string describes the name of the network interface adapter. AdapterType The string describes the type of network medium BUA000118R4101

313 Section 6 IT Asset and IT Device Library Status Device - Generic Interface Status Table 97. Generic Interface Status Properties (Continued) Property Data Type Description Description String The string provides the description of the device. MACAddress (continued) The string provides the unique 48-bit identifier for the network interface. DeviceID This string uniquely identifies the network adapter. Index Numeric The network adapter index on the computer. Availability The status of the device. ConfigManagerErrorCode The Win32 Config Manager error code. 3BUA000118R

314 Alarm Device - Network Utilization Alarm Section 6 IT Asset and IT Device Library Alarm Device - Network Utilization Alarm Description: Generates alarms when there is excessive network utilization on the network segment. Table 98 lists the Network Utilization Alarm Conditions/Subconditions. Table 98. Network Utilization Alarm Conditions/Subconditions Conditions Subconditions Generated Description Utilization Normal Network Utilization is running within normal range limits. Bad Bad Input. LowUtilization The network utilization is above the low threshold. MediumUtilization The network utilization is above the medium threshold. HighUtilization Status Device - Network Utilization Alert The network utilization is above the high threshold. Description: Current value or status of network utilization Table 99 lists the Network Utilization Alert properties. Table 99. Network Utilization Alert Properties Property Data Type Description ValueUtilization Numeric A numeric representation of the current state of the network utilization. Utilization String A string describing the current state of the network utilization. Status Device - Network Utilization (Bytes per s) Status Description: Current status of network utilization via bytes per second BUA000118R4101

315 Section 6 IT Asset and IT Device Library Status Device - Network Utilization (Percent) Status Table 100 lists the Network Utilization (Bytes per s) Status properties. Table 100. Network Utilization (Bytes per s) Status Properties Property Data Type Description Numeric Network Utilization (Bytes per s) Status Status Device - Network Utilization (Percent) Status A numeric representation of the current status of the network utilization. Description: Returns key status values on the utilization of the percentage of nominal bandwidth used. Table 101 lists the Network Utilization (Percent) Status properties. Table 101. Network Utilization (Percent) Status Properties Property Data Type Description Numeric Network Utilization (Percent) Status A numeric representation of the current state of the utilization of the network. 3BUA000118R

316 Alarm Device - Node to Node Utilization Alarm Section 6 IT Asset and IT Device Library Alarm Device - Node to Node Utilization Alarm Description: Generates alarms when there is excessive network utilization between nodes. Table 102 lists the Node to Node Utilization Alarm Conditions/Subconditions. Table 102. Node to Node Utilization Alarm Conditions/Subconditions Conditions Subconditions Generated Description Between Nodes Normal Network Utilization is running within normal range limits. Bad Bad Input. LowUtilization The network utilization is above the low threshold. MediumUtilization The network utilization is above the medium threshold. HighUtilization Status Device - Node to Node Utilization Alert The network utilization is above the high threshold. Description: Current value or status of network utilization between nodes. Table 103 lists the Node to Node Utilization Alert properties. Table 103. Node to Node Utilization Alert Properties Property Data Type Description Numeric Value-Between Nodes A numeric representation of the current state of the network utilization between nodes. Between Nodes String A string describing the current state of the network utilization between nodes. Status Device - Node To Node Utilization (Bytes per s) Status Description: Returns key status values on the utilization of the network between nodes in bytes per second BUA000118R4101

317 Section 6 IT Asset and IT Device Library Status Device - Node To Node Utilization (Percent) Status Table 104 lists the Node to Node Utilization (Byte per s) Status properties. Table 104. Node to Node Utilization (Byte per s) Status Properties Property Data Type Description Status Numeric A numeric representation of the current state of the utilization of the network between nodes. Status Device - Node To Node Utilization (Percent) Status Description: Returns key status information on the utilization of the network between nodes. Table 105 lists the Node to Node Utilization (Percent) Status properties. Table 105. Node to Node Utilization (Percent) Status Properties Property Data Type Description Status Numeric A numeric representation of the current state of the utilization of the network between nodes. 3BUA000118R

318 Alarm Device - Node Utilization Alarm Section 6 IT Asset and IT Device Library Alarm Device - Node Utilization Alarm Description: Generates alarms when there is excessive network utilization on a single node. Table 106 lists the Node Utilization Alarm Conditions/Subconditions. Table 106. Node Utilization Alarm Conditions/Subconditions Conditions Subconditions Generated Description Single Node Normal Network utilization is running within normal range limits. Bad LowUtilization MediumUtilization HighUtilization Status Device - Node Utilization Alert Bad Input. Description: Current value or status of the network utilization on a single node. Table 107 lists the Node Utilization Alert properties. Status Device - Node Utilization (Bytes per s) Status The network utilization is above the low threshold. The network utilization is above the medium threshold. The network utilization is above the high threshold. Table 107. Node Utilization Alert Properties Property Data Type Description ValueSingleNode Numeric A numeric representation of the current state of the network utilization on a single node. SingleNode String A string describing the current state of the network utilization on a single node. Description: Current status of a single node utilization of bandwidth in bytes per second BUA000118R4101

319 Section 6 IT Asset and IT Device Library Status Device - Node Utilization (Percent) Status Table 108 lists the Node Utilization (Byte per s) Status properties. Table 108. Node Utilization (Byte per s) Status Properties Property Data Type Description Status Numeric A numeric representation of the current state of the utilization of the network of a single node. Status Device - Node Utilization (Percent) Status Description: Current status of a single node utilization in percent of nominal bandwidth. Table 109 lists the Node Utilization (Percent) Status properties. Table 109. Node Utilization (Percent) Status Properties Property Data Type Description Status Numeric A numeric representation of the current state of the utilization of the network of a single node. 3BUA000118R

320 Alarm Device - Performance Counter Alarm (Alarm) Section 6 IT Asset and IT Device Library Alarm Device - Performance Counter Alarm (Alarm) Description: Generates alarms when the Windows Performance Counter has exceeded pre-configured alarm limits. Table 110 lists the Performance Counter Alarm (Alarm) Conditions/Subconditions. Table 110. Performance Counter Alarm (Alarm) Conditions/Subconditions Conditions Subconditions Generated Description PerformanceAlarm Normal The performance counter is running within normal range limits. Bad Bad Input. LowUtilization The performance counter is above the low threshold. MediumUtilization The performance counter is above the medium threshold. HighUtilization The performance counter is above the high threshold. Status Device - Performance Counter Alert (Performance Alert) Description: Generates alerts based on Windows Performance Counter limits. Table 111 lists the Performance Counter Alert (Performance Alert) properties. Table 111. Performance Counter Alert (Performance Alert) Properties Property Data Type Description Value-Alert Numeric A numeric representation of the Windows Performance Counter value. Alert String A string describing the alert condition when the value exceeds the limit BUA000118R4101

321 Section 6 IT Asset and IT Device Library Alarm Device - Performance Counter Alarm (Reversed) Alarm Device - Performance Counter Alarm (Reversed) (Reversed Alarm) Description: Generates alarms when the Windows Performance Counter is lower then the pre-configured threshold level. Table 111 lists the Performance Counter Alarm (Reversed) (Reversed Alarm) Conditions/Subconditions. Table 112. Performance Counter Alarm (Reversed) (Reversed Alarm) Conditions/Subconditions Conditions Subconditions Generated Description PerformanceAlarm Normal The performance counter is running within normal range limits. Bad Bad Input. Warning The performance counter is above the warning limit. Serious The performance counter is in a serious condition. Critical The performance counter is in a critical condition. Status Device - Performance Counter (Reversed) Alert (Reversed Performance Alert) Description: Generates alerts based on Windows Performance Counter limits. Table 113 lists the Performance Counter (Reversed) Alert (Reversed Performance Alert) properties. Table 113. Performance Counter (Reversed) Alert (Reversed Performance Alert) Properties Property Data Type Description Value-Alert Numeric A numeric representation of the Windows Performance Counter value. Alert String A string describing when the value falls below the limit. 3BUA000118R

322 Status Device - Performance Counter Status (Value) Section 6 IT Asset and IT Device Library Status Device - Performance Counter Status (Value) Description: Current Value of the Windows Performance Monitor Counter. Table 114 lists the Performance Counter Status (Value) properties. Table 114. Performance Counter Status (Value) Properties Property Data Type Description Counter Status Numeric A numeric representation of the Windows Performance Counter value BUA000118R4101

323 Section 6 IT Asset and IT Device Library Alarm Device - Computer CPU Alarm Alarm Device - Computer CPU Alarm Description: Generates an alarm when the CPU utilization becomes too high. The usage is averaged over the update period, which is 10 seconds, as a minimum. This means that CPU spikes are automatically leveled. Table 115 lists the Computer CPU Alarm Conditions/Subconditions. Table 115. Computer CPU Alarm Conditions/Subconditions Conditions Subconditions Generated Description CPUOverload Normal CPU(s) utilization is within acceptable range. Bad No CPU(s) loading data is available. Warning CPU utilization has reached or exceeded the Low Limit. Serious Critical Status Device - Computer CPU Alert Description: Generates alerts based on CPU utilization. Table 116 lists the Computer CPU Alert properties. Status Device - Computer CPU Status CPU utilization has reached or exceeded the Medium Limit. CPU utilization has reached or exceeded the High Limit and is in critical overload condition. Table 116. Computer CPU Alert Properties Property Data Type Description CPUOverload String A string describing the current state of the computer CPU. Value- CPUOverload Numeric A numeric representation of the current state of the computer CPU. Description: Provides the current value of the CPU load. 3BUA000118R

324 Light Alarm Device - Light Computer CPU Alarm Section 6 IT Asset and IT Device Library Table 117 lists the Computer CPU Status properties. Table 117. Computer CPU Status Properties Property Data Type Description CPULoad Numeric The CPU load from the given computer. This load is the running average CPU load over 4 update periods. This update period must be a least 15 seconds. Light Alarm Device - Light Computer CPU Alarm Description: Generates one or more alarms based on the CPU utilization. Table 118 lists the Light Computer CPU Alarm Conditions/Subconditions. Table 118. Light Computer CPU Alarm Conditions/Subconditions Conditions Subconditions Generated Description CPUOverload Normal CPU(s) utilization is within acceptable range. Bad No CPU(s) loading data is available. Warning CPU utilization has reached or exceeded the Low Limit. Serious Critical Light Status Device - Light Computer CPU Alert CPU utilization has reached or exceeded the Medium Limit. CPU utilization has reached or exceeded the High Limit and is in critical overload condition. Description: Generates alerts based on CPU utilization BUA000118R4101

325 Section 6 IT Asset and IT Device Library Light Status Device - Light Computer CPU Alert Table 119 lists the Light Computer CPU Alert properties. Table 119. Light Computer CPU Alert Properties Property Data Type Description CPUOverload String A string describing the current state of the computer CPU. Value- CPUOverload Numeric A numeric representation of the current state of the computer CPU. 3BUA000118R

326 Alarm Device - Computer General Alarm (Auto) Section 6 IT Asset and IT Device Library Alarm Device - Computer General Alarm (Auto) Description: Generates one or more alarms based on checking the individual resource usage of a given software process. This device automatically detects trends in resource usage and generates alarms when it anticipates a problem. Table 120 lists the Computer General Alarm (Auto) Conditions/Subconditions. Table 120. Computer General Alarm (Auto) Conditions/Subconditions Conditions Subconditions Generated Description Handles Normal Handle usage is within the acceptable range. Bad No Handle usage data is available. Warning The number of Handles used by the system has reached or exceeded the Handle warning limit. Error The number of Handles used by the system has reached or exceeded the Handle error limit. VM-Absolute Normal Virtual memory (VM) usage is within the acceptable range. Bad Warning Error No VM usage data is available. VM usage has reached or exceeded the warning limit. VM usage has reached or exceeded the error limit. Threads Normal Thread usage is within the acceptable range. Bad No Thread usage data is available. Warning The number of Threads used by the system has reached or exceeded the Thread warning limit. Error The number of Threads used by the system has reached or exceeded the Thread error limit. VM-Trend Normal Virtual memory (VM) usage is within the acceptable range. Bad No VM usage data is available. Warning The system has observed a sustained upward trend in the VM used over the span of 2 ½ hours. Error The system has observed a sustained upward trend in the VM used over the span of 5 hours BUA000118R4101

327 Section 6 IT Asset and IT Device LibraryLight Alarm Device - Light Computer General Alarm (Auto) Light Alarm Device - Light Computer General Alarm (Auto) Table 121 lists the Light Computer General Alarm (Auto) Conditions/Subconditions. Table 121. Light Computer General Alarm (Auto) Conditions/Subconditions Conditions Subconditions Generated Description Handles Normal Handle usage is within the acceptable range. Bad No Handle usage data is available. Warning The number of Handles used by the system has reached or exceeded the Handle warning limit. Error The number of Handles used by the system has reached or exceeded the Handle error limit. VM-Absolute Normal Virtual memory (VM) usage is within the acceptable range. Bad No VM usage data is available. Warning VM usage has reached or exceeded the warning limit. Error VM usage has reached or exceeded the error limit. Threads Normal Thread usage is within the acceptable range. Bad No Thread usage data is available. Warning The number of Threads used by the system has reached or exceeded the Thread warning limit. Error The number of Threads used by the system has reached or exceeded the Thread error limit. VM-Trend Normal Virtual memory (VM) usage is within the acceptable range. Bad No VM usage data is available. Warning The system has observed a sustained upward trend in the VM used over the span of 2 ½ hours. Error The system has observed a sustained upward trend in the VM used over the span of 5 hours. 3BUA000118R

328 Light Status Device - Light Computer General Alert Section 6 IT Asset and IT Device Library Light Status Device - Light Computer General Alert Description: Generates one or more alerts based on checking against absolute limits. Table 122 lists the Light Computer General Alert properties. Table 122. Light Computer General Alert Properties Property Data Type Description Handles String A string describing the current state of the Handles. Threads A string describing the current state of the Threads. VM-Absolute A string describing the current state of the VM-Absolute. VM-Trend A string describing the current state of the VM-Trend. Value-Handles Numeric A numeric representation of the current state of the Handles. Value-Threads A numeric representation of the current state of the Threads. Value-VM- Absolute Value-VM-Trend A numeric representation of the current state of the VM- Absolute. A numeric representation of the current state of the VM- Trend BUA000118R4101

329 Section 6 IT Asset and IT Device Library Alarm Device - Computer General Alarm Alarm Device - Computer General Alarm Description: Generates one or more alarms based on checking the individual resource usage of a given software process. Table 123 lists the Computer General Alarm Conditions/Subconditions. Table 123. Computer General Alarm Conditions/Subconditions Conditions Subconditions Generated Description Handles Normal Handle usage is within the acceptable range. Bad No Handle usage data is available. Warning The number of Handles used by the system has reached or exceeded the Handle warning limit. Error The number of Handles used by the system has reached or exceeded the Handle error limit. VM-Absolute Normal Virtual memory (VM) usage is within the acceptable range. Bad No VM usage data is available. Warning VM usage has reached or exceeded the warning limit. Error VM usage has reached or exceeded the error limit. Threads Normal Thread usage is within the acceptable range. Bad No Thread usage data is available. Warning The number of Threads used by the system has reached or exceeded the Thread warning limit. Error The number of Threads used by the system has reached or exceeded the Thread error limit. Status Device - Computer General Alert Description: Generates one or more alerts based on checking against absolute limits. 3BUA000118R

330 Status Device - Computer General Status Section 6 IT Asset and IT Device Library Table 124 lists the Computer General Alert properties. Table 124. Computer General Alert Properties Property Data Type Description Handles String A string describing the current state of the Handles. Threads VM-Absolute VM-Trend Status Device - Computer General Status A string describing the current state of the Threads. A string describing the current state of the VM-Absolute. A string describing the current state of the VM-Trend. Value-Handles Numeric A numeric representation of the current state of the Handles. Value-Threads A numeric representation of the current state of the Threads. Value-VM- Absolute Value-VM-Trend A numeric representation of the current state of the VM- Absolute. A numeric representation of the current state of the VM- Trend. Description: Returns several key status values for a given computer Table 125 lists the Computer General Status properties. Table 125. Computer General Status Properties Property Data Type Description HandleCount Numeric The total number of Handles currently in use on this computer. VM The total amount of Virtual Memory currently in use on this computer (in bytes). VMMAX The total amount of Virtual Memory available on this computer (in bytes). ThreadCount The total number of Threads currently in use on this computer BUA000118R4101

331 Section 6 IT Asset and IT Device Library Alarm Device - Computer Process Alarm Alarm Device - Computer Process Alarm Description: Generates one or more alarms based on checking the individual resource usage of a given software process. This device automatically detects trends in resource usage and generates alarms when it anticipates a problem. Table 126 lists the Computer Process Alarm Conditions/Subconditions. Table 126. Computer Process Alarm Conditions/Subconditions Conditions Subconditions Generated Description Handles Normal Handle usage is within the acceptable range. Bad No Handle usage data is available. Warning The system has observed a sustained upward trend in the number of Handles used over the span of 2 ½ hours. Error The system has observed a sustained upward trend in the number of Handles used over the span of 5 hours. VM Normal Virtual Memory (VM) usage is within the acceptable range. Bad No VM usage data is available. Warning The system has observed a sustained upward trend in the VM used over the span of 2 ½ hours. Error The system has observed a sustained upward trend in the VM used over the span of 5 hours. Threads Normal Thread usage is within the acceptable range. Bad No Thread usage data is available. Warning The system has observed a sustained upward trend in the number of Threads used over the span of 2 ½ hours. Error The system has observed a sustained upward trend in the number of Threads used over the span of 5 hours. 3BUA000118R

332 Status Device - Computer Process Alert Section 6 IT Asset and IT Device Library Conditions Table 126. Computer Process Alarm Conditions/Subconditions (Continued) CPULoad Normal CPU(s) utilization is within the acceptable range. Bad Low Subconditions Generated Status Device - Computer Process Alert Description No CPU(s) loading data is available. CPU utilization has reached or exceeded the Low limit. Medium CPU utilization has reached or exceeded the Medium limit. High CPU utilization has reached or exceeded the High limit. ProcessExists Normal The given process is running. Bad No data is available. Error The process is not running on the specified computer. Description: Returns a set of strings (Normal, Bad, Warning, or Error) indicating the health of several software process attributes. Table 127 lists the Computer Process Alert properties. Table 127. Computer Process Alert Properties Property Data Type Description Handles String The string indicating the state of the Handles resource on the given software process. Memory The string indicating the state of the Memory resource on the given software process. Threads The string indicating the state of the Threads resource on the given software process. CPULoad The string indicating the state of the CPU usage by the given software process BUA000118R4101

333 Section 6 IT Asset and IT Device Library Status Device - Computer Process Status Table 127. Computer Process Alert Properties (Continued) Property Data Type Description Value-Handles Numeric The numeric representation of the current state of the Handles resource on the given software process. Value-Memory The numeric representation of the current state of the Memory resource on the given software process. Value-Threads The numeric representation of the current state of the Threads resource on the given software process. Value-CPULoad The numeric representation of the current state of the CPU usage on the given software process. Status Device - Computer Process Status Description: Returns several key status values for a given software process. Table 128 lists the Computer Process Status properties. Table 128. Computer Process Status Properties Property Data Type Description HandleCount Numeric The total number of Handles currently in use by this software process. VM The total amount of Virtual Memory currently in use by this software process. ProcessId The process ID of the given software process. ThreadCount The total number of Threads currently in use by this software process. CPULoad The percentage load this software process is putting on the CPU. ProcessName String The name of the given process. 3BUA000118R

334 Light Status Device - Light Computer Process Alert Section 6 IT Asset and IT Device Library Light Status Device - Light Computer Process Alert Description: Returns a set of strings indicating the health of several software process attributes. Table 129 lists the Light Computer Process Alert properties. Table 129. Light Computer Process Alert Properties Property Data Type Description Handles String The string indicating the state of the Handles resource on the given software process. Memory The string indicating the state of the Memory resource on the given software process. Threads The string indicating the state of the Threads resource on the given software process. CPULoad The string indicating the state of the CPU usage by the given software process. Value-Handles Numeric The numeric representation of the current state of the Handles resource on the given software process. Value-Memory The numeric representation of the current state of the Memory resource on the given software process. Value-Threads The numeric representation of the current state of the Threads resource on the given software process. Value-CPULoad The numeric representation of the current state of the CPU usage on the given software process. Light Status Device - Light Computer Process Status Description: Returns several key status values for a given software process BUA000118R4101

335 Section 6 IT Asset and IT Device Library Light Status Device - Light Computer Process Status Table 130 lists the Light Computer Process Status properties. Table 130. Light Computer Process Status Properties Property Data Type Description HandleCount Numeric The total number of Handles currently in use by this software process. VM The total amount of Virtual Memory currently in use by this software process. ProcessID The process ID of the given software process. ThreadCount The total number of Threads currently in use by this software process. CPULoad The percentage load this software process is putting on the CPU. ProcessName String The name of the given process. 3BUA000118R

336 Alarm Device - Computer Process Alarm (Compact) Section 6 IT Asset and IT Device Library Alarm Device - Computer Process Alarm (Compact) Description: Generates a single alarm based on the combination of several checks done on a given software process. The device automatically detects trends in resource usage and generates alarms when it anticipates a problem. Table 131 lists the Computer Process Alarm (Compact) Conditions/Subconditions. Table 131. Computer Process Alarm (Compact) Conditions/Subconditions Conditions Subconditions Generated Description ProcessHealth Normal Process is functioning normally. Bad The device was not properly configured. No process name was given. ProcessNotRunning The given process is not running. MemoryLeak The system has observed a sustained upward trend in the amount of Virtual Memory used by the process. HandleLeak The system has observed a sustained upward trend in the number of Handles used by the process. ThreadsLeak The system has observed a sustained upward trend in the number of Threads used by the process. CPUOverLoad The system has observed a sustained period of high CPU usage BUA000118R4101

337 Section 6 IT Asset and IT Device Library Light Alarm Device - Light Computer Process Alarm Light Alarm Device - Light Computer Process Alarm (Compact) Description: Generates a single alarm based on the combination of several checks done on a given software process. The device automatically detects trends in resource usage and generates alarms when it anticipates a problem. Table 132 lists the Light Computer Process Alarm (Compact) Conditions/Subconditions. Table 132. Light Computer Process Alarm (Compact) Conditions/Subconditions Conditions Subconditions Generated Description ProcessHealth Normal Process is functioning normally. Bad The device was not properly configured. No process name was given. ProcessNotRunning The given process is not running. MemoryLeak The system has observed a sustained upward trend in the amount of Virtual Memory used by the process. HandleLeak The system has observed a sustained upward trend in the number of Handles used by the process. ThreadsLeak The system has observed a sustained upward trend in the number of Threads used by the process. CPUOverLoad The system has observed a sustained period of high CPU usage. 3BUA000118R

338 Alarm Device - Computer Process Alarm (Auto) Section 6 IT Asset and IT Device Library Alarm Device - Computer Process Alarm (Auto) Description: Generates one or more alarms based on checking the individual resource usage of a given software process. This device automatically detects trends in resource usage and generates alarms when it anticipates a problem. Table 133 lists the Computer Process Alarm (Auto) Conditions/Subconditions. Table 133. Computer Process Alarm (Auto) Conditions/Subconditions Conditions Subconditions Generated Description Handles Normal Handle usage is within the acceptable range. Bad No Handle usage data is available. Warning The system has observed a sustained upward trend in the number of Handles used over the span of 2 ½ hours. Error The system has observed a sustained upward trend in the number of Handles used over the span of 5 hours. VM Normal Virtual Memory (VM) usage is within the acceptable range. Bad No VM usage data is available. Warning The system has observed a sustained upward trend in the VM used over the span of 2 ½ hours. Error The system has observed a sustained upward trend in the VM used over the span of 5 hours. Threads Normal Thread usage is within the acceptable range. Bad No Thread usage data is available. Warning The system has observed a sustained upward trend in the number of Threads used over the span of 2 ½ hours. Error The system has observed a sustained upward trend in the number of Threads used over the span of 5 hours BUA000118R4101

339 Section 6 IT Asset and IT Device Library Alarm Device - Computer Process Alarm (Auto) Table 133. Computer Process Alarm (Auto) Conditions/Subconditions (Continued) Conditions CPULoad Normal CPU(s) utilization is within the acceptable range. Bad Low Subconditions Generated Description No CPU(s) loading data is available. CPU utilization has reached or exceeded the Low limit. Medium CPU utilization has reached or exceeded the Medium limit. High CPU utilization has reached or exceeded the High limit. ProcessExists Normal The given process is running. Bad No data is available. Error The process is not running on the specified computer. 3BUA000118R

340 Alarm Device - Computer Process Alarm (Min) Section 6 IT Asset and IT Device Library Alarm Device - Computer Process Alarm (Min) Description: Generates a single alarm based only on whether or not a given process is running. Table 134 lists the Computer Process Alarm (Min) Conditions/Subconditions. Table 134. Computer Process Alarm (Min) Conditions/Subconditions Conditions Subconditions Generated Description ProcessExists Normal The given process is running. Bad There is no data available. Error The process is not running on the specified computer BUA000118R4101

341 Section 6 IT Asset and IT Device Library Alarm Device - Disk Drive Alarm Alarm Device - Disk Drive Alarm Description: Generates a single alarm based on the health of a given hard drive, as computed by the device driver. Table 135 lists the Disk Drive Alarm Conditions/Subconditions. Status Device - Disk Drive Alert Description: Generates a single alert based on the health of a given hard drive, as computed by the device driver. Table 136 lists the Disk Drive Alert Conditions/Subconditions. Status Device - Disk Drive Status Table 135. Disk Drive Alarm Conditions/Subconditions Conditions Subconditions Generated Description Status Normal The given hard drive is functioning normally. Bad There is no hard drive status available. Error The device driver has detected a problem with the hard drive. Table 136. Disk Drive Alert Conditions/Subconditions Property Data Type Description Status String A string describing the current state of the physical disk drive. Value-Status Numeric A numeric representation of the current state of the physical disk drive. Description: Returns several key status values for a given disk drive. 3BUA000118R

342 Status Device - Disk Drive Status Section 6 IT Asset and IT Device Library Table 137 lists the Disk Drive Status Conditions/Subconditions. Table 137. Disk Drive Status Conditions/Subconditions Property Data Type Description Partitions Numeric The number of partitions on the given drive. Model String The model number of the given drive. Manufacturer The manufacturer of the given drive. Description A description of the given drive. ErrorDescription A description of the existing error condition on the given drive, if any. LastErrorCode Numeric The error code of the existing error condition on the given drive, if any. Status String The overall status of the given drive. DeviceId The windows device identifier for the given drive (e.g. \.\PHYSICALDRIVE0 ). Size Numeric The size, in bytes, of a given drive BUA000118R4101

343 Section 6 IT Asset and IT Device Library Alarm Device - Disk Volume Alarm Alarm Device - Disk Volume Alarm Description: Generates an alarm when the amount of available hard disk space goes below a certain limit. Table 138 lists the Disk Volume Alarm Conditions/Subconditions. Table 138. Disk Volume Alarm Conditions/Subconditions Conditions Subconditions Generated Description FreeSpace Normal The free space on the given hard drive is within the acceptable range. Bad Hard drive information is not available. Warning The amount of free space available has reached or gone below the warning limit. Serious The amount of free space available has reached or gone below the serious limit. Critical The amount of free space available has reached or gone below the critical limit. Status Device - Disk Volume Alert Description: Generates an alert when the amount of available hard disk space goes below a certain limit. Table 139 lists the Disk Volume Alert properties. Table 139. Disk Volume Alert Properties Property Data Type Description FreeSpace String A string describing the free space of the logical disk drive. Value-FreeSpace Numeric A numeric representation of the free space of the logical disk drive. 3BUA000118R

344 Status Device - Disk Volume Status Section 6 IT Asset and IT Device Library Status Device - Disk Volume Status Description: Returns the percentage free of a given hard drive partition. Table 140 lists the Disk Volume Status properties. Table 140. Disk Volume Status Properties Property Data Type Description FreeSpace Numeric A percentage free of a given hard drive. Light Alarm Device - Light Disk Volume Alarm Description: Generates an alarm when the amount of available hard disk space goes below a certain limit. Table 141 lists the Light Disk Volume Alarm Conditions/Subconditions. Table 141. Light Disk Volume Alarm Conditions/Subconditions Conditions Subconditions Generated Description FreeSpace Normal The free space on the given hard drive is within the acceptable range. Bad Hard drive information is not available Warning The amount of free space available has reached or gone below the warning limit. Serious The amount of free space available has reached or gone below the serious limit. Critical The amount of free space available has reached or gone below the critical limit BUA000118R4101

345 Section 6 IT Asset and IT Device Library Light Status Device - Light Disk Volume Alert Light Status Device - Light Disk Volume Alert Description: Generates an alert when the amount of available hard disk space goes below a certain limit. Table 142 lists the Light Disk Volume Alert properties. Table 142. Light Disk Volume Alert Properties Property Data Type Description FreeSpace String A string describing the state of the physical disk drive. Value-FreeSpace Numeric A numeric representation of the current state of the physical disk drive. 3BUA000118R

346 Alarm Device - Printer Alarm Section 6 IT Asset and IT Device Library Alarm Device - Printer Alarm Description: Generates several printer alarm possibilities based on the status of a given network printer. Table 143 lists the Printer Alarm Conditions/Subconditions. Table 143. Printer Alarm Conditions/Subconditions Conditions Subconditions Generated Description Available Normal The printer can be seen on the network. Bad There is no data available. Alarm The printer cannot be seen on the network. Service Request Normal No Service Request problem has been indicated by the printer. Bad The printer Service Request status cannot be accessed. Active The printer has indicated that service is necessary. Offline Normal No Offline problem has been indicated by the printer. Bad The printer Offline status cannot be accessed. Active The printer has indicated that it is offline. Jammed Normal No Paper Jammed problem has been indicated by the printer. Bad The printer Jammed status cannot be accessed. Active The printer has indicated that it has a paper jam. DoorOpen Normal No DoorOpen problem has been indicated by the printer. Bad The printer DoorOpen status cannot be accessed. Active The printer has indicated that one of its access doors is open preventing proper operation. NoToner Normal There has not been a NoToner problem indicated by the printer. Bad The printer NoToner status cannot be accessed. Active The printer has indicated that it is out of toner BUA000118R4101

347 Section 6 IT Asset and IT Device Library Status Device - Printer Alert Conditions Table 143. Printer Alarm Conditions/Subconditions (Continued) Subconditions Generated LowToner Normal There has not been a LowToner problem indicated by the printer. Bad The printer LowToner status cannot be accessed. Active The printer has indicated that it is low on toner. NoPaper Normal There has not been a NoPaper problem indicated by the printer. Bad The printer NoPaper status cannot be accessed. Active The printer has indicated that it is out of paper. LowPaper Normal There has not been a LowPaper problem indicated by the printer. Bad The printer LowPaper status cannot be accessed. Active The printer has indicated that it is low on paper. Status Device - Printer Alert Description: Generates several printer alert possibilities based on the status of a given network printer. Table 144 lists the Printer Alert properties. Table 144. Printer Alert Properties Description Property Data Type Description Available String A string describing the current state of the printer availability. DoorOpen A string describing the current state of the printer DoorOpen. Jammed A string describing the current state of the printer Jammed. LowPaper A string describing the current state of the printer LowPaper. 3BUA000118R

348 Status Device - Printer Alert Section 6 IT Asset and IT Device Library LowToner String (continued) A string describing the current state of the printer LowToner. NoPaper A string describing the current state of the printer NoPaper. NoToner A string describing the current state of the printer NoToner. Offline A string describing the current state of the printer Offline. ServiceRequest A string describing the current state of the printer ServiceRequest. Value-Available Numeric A numeric representation of the current state of the printer availability. Value-DoorOpen A numeric representation of the current state of the printer DoorOpen. Value-Jammed A numeric representation of the current state of the printer Jammed. Value-LowPaper A numeric representation of the current state of the printer LowPaper. Value-LowToner A numeric representation of the current state of the printer LowToner. Value-NoPaper A numeric representation of the current state of the printer NoPaper. Value-NoToner Numeric (cont) A numeric representation of the current state of the printer NoToner. Value-Offline A numeric representation of the current state of the printer Offline. Value- ServiceRequest Table 144. Printer Alert Properties (Continued) Property Data Type Description A numeric representation of the current state of the printer ServiceRequest BUA000118R4101

349 Section 6 IT Asset and IT Device Library Status Device - Printer Status Status Device - Printer Status Description: Returns the status of key attributes of a given network printer. Table 145 lists the Printer Status properties. Table 145. Printer Status Properties Property Data Type Description SysName String The name of the given printer. SysLocation The configured location of the given printer. SysDescription The description of the given printer. DeviceStatus A string describing the current device status (e.g. running). PrinterStatus A string describing the current device status (e.g. running). DetectedErrorState Numeric A number indicating the current error condition on the printer, if any (e.g. 00 indicates no error). szdetectederrorstate String The decoded error code of the existing error condition on the printer, if any. This string will contain one or more of the following strings, separated by plus (+) signs: Bad quality, Service Request, Offline, Jammed, Door Open, No Toner, No Paper, Low Paper. 3BUA000118R

350 Alarm Device - Cisco 12-Port Switch Alarm Section 6 IT Asset and IT Device Library Alarm Device - Cisco 12-Port Switch Alarm Description: Generates alarms for port failures and optionally for disconnected ports. Table 146 lists the Cisco 12-Port Switch Alarm Conditions/Subconditions. Table 146. Cisco 12-Port Switch Alarm Conditions/Subconditions Conditions Subconditions Generated Description SwitchHealth Normal The port is functioning normally, or the port is not connected but alarming on this condition is disabled. Bad Bad quality on ports: The status of one or several switch ports cannot be accessed. DeviceDown Device is down: All ports are bad quality and status cannot be accessed on any ports. PortError Errors are detected. One or several ports have input or output errors above the specified error limit. PortDisconnected Port(s) are disconnected: One or more ports are not connected. This only alarms if the switch is configured to alarm on open ports. Status Device - Cisco 12-Port Switch Alert Description: Returns the status of key attributes of a given Cisco 12-Port Switch. Table 147 lists the Cisco 12-Port Switch Alert properties. Table 147. Cisco 12-Port Switch Alert Properties Property Data Type Description Port-01 to Port-12 String A string describing the current state of each port. The string is either Normal or Bad quality. Value-Port-01 to Value-Port-12 Numeric A numeric representation of a port failure or disconnection BUA000118R4101

351 Section 6 IT Asset and IT Device Library Status Device - Cisco 12-Port Switch Status Status Device - Cisco 12-Port Switch Status Description: Returns the status of key attributes of a given Cisco 12-Port Switch. Even though this is a 12-Port Switch, it actually has 15 ports exposed. Ports 0, 13, and 14 are not used for communication and are internal. They are exposed for completeness. Table 148 lists the Cisco 12-Port Switch Status properties. Table 148. Cisco 12-Port Switch Status Properties Property Data Type Description SysName String The name of the given switch. SysDescr SysUpTime IfDescr00 to IfDescr14 IfOperStatus00 to IfOperStatus14 IfInOctets00 to IfInOctets14 IfOutOctets00 to IfOutOctets14 IfSpeed00 to IfSpeed14 IfOutErrors00 to IfOutErrors14 IfInErrors00 to IfInErrors14 The configured description of the switch. The amount of time the switch has been running since the last reset, in hundredths of seconds. A textual string containing information about the interface. This string should include the name of the manufacturer, the product name and the version of the hardware interface. Numeric A string describing the current port status of ports 0 to 14 (e.g. up). The number of bytes received by the switch per port. The number of bytes sent by the switch per port. The speed of each port in bytes per second. The number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. The number of outbound packets that could not be transmitted because of errors. 3BUA000118R

352 Light Alarm Device - Light Cisco 12-Port Switch Alarm Section 6 IT Asset and IT Device Library Light Alarm Device - Light Cisco 12-Port Switch Alarm Description: Generates alarms for port failures and optionally for disconnected ports. Table 149 lists the Light Cisco 12-Port Switch Alarm Conditions/Subconditions. Table 149. Cisco 12-Port Switch Alarm Conditions/Subconditions Conditions Subconditions Generated Description SwitchHealth Normal The port is functioning normally, or the port is not connected but alarming on this condition is disabled. Bad Bad quality on ports: The status of one or several switch ports can not be accessed. DeviceDown Device is down: All ports are bad quality and status can not be accessed on any ports. PortError Errors are detected. One or several ports have input or output errors above the specified error limit. PortDisconnected Port(s) are disconnected: One or more ports are not connected. This only alarms if the switch is configured to alarm on open ports. Light Status Device - Light Cisco 12-Port Switch Alert Description: Returns the status of key attributes of a given Cisco 12-Port Switch. Table 150 lists the Light Cisco 12-Port Switch Alert properties. Table 150. Light Cisco 12-Port Switch Alert Properties Property Data Type Description Port-01 to Port-12 String A string describing the current state of each port. The string is either Normal or Bad quality. Value-Port-01 to Value-Port-12 Numeric A numeric representation of a port failure or disconnection BUA000118R4101

353 Section 6 IT Asset and IT Device Library Alarm Device - Cisco 24-Port Switch Alarm Alarm Device - Cisco 24-Port Switch Alarm Description: Generates alarms for port failures and optionally for disconnected ports. Table 151 lists the Cisco 24-Port Switch Conditions/Subconditions. Table 151. Cisco 24-Port Switch Alarm Conditions/Subconditions Conditions Subconditions Generated Description SwitchHealth Normal The port is functioning normally, or the port is not connected but alarming on this condition is disabled. Bad Bad quality on ports: The status of one or several switch ports can not be accessed. DeviceDown Device is down: All ports are bad quality and status can not be accessed on any ports. PortError Errors are detected. One or several ports have input or output errors above the specified error limit. PortDisconnected Port(s) are disconnected: One or more ports are not connected. This only alarms if the switch is configured to alarm on open ports. Status Device - Cisco 24-Port Switch Alert Description: Returns the status of key attributes of a given Cisco 24-Port Switch. Table 152 lists the Cisco 24-Port Switch Alert properties. Table 152. Cisco 24-Port Switch Alert Properties Property Data Type Description Port-01 to Port-24 String A string describing the current state of each port. The string is either Normal or Bad quality. Value-Port-01 to Value-Port-24 Numeric A numeric representation of a port failure or disconnection. 3BUA000118R

354 Status Device - Cisco 24-Port Switch Status Section 6 IT Asset and IT Device Library Status Device - Cisco 24-Port Switch Status Description: Returns the status of key attributes of a given Cisco 24-Port Switch. Even though this is a 24-Port Switch, it actually has 27 ports exposed. Ports 0, 25 and 26 are not used for communication and are internal. They are exposed for completeness. Table 153 lists the Cisco 24-Port Switch Status properties. Table 153. Cisco 24-Port Switch Status Properties Property Data Type Description SysName String The name of the given switch. SysDescr SysUpTime IfDescr00 to IfDescr26 IfOperStatus00 to IfOperStatus26 IfInOctets00 to IfInOctets26 IfOutOctets00 to IfOutOctets26 IfSpeed00 to IfSpeed26 IfOutErrors00 to IfOutErrors26 IfInErrors00 to IfInErrors26 The configured description of the switch. The amount of time the switch has been running since the last reset, in hundredths of seconds. A textual string containing information about the interface. This string should include the name of the manufacturer, the product name and the version of the hardware interface. Numeric A string describing the current port status of ports 0 to 26 (e.g. up). The number of bytes received by the switch per port. The number of bytes sent by the switch per port. The speed of each port in bytes per second. The number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. The number of outbound packets that could not be transmitted because of errors BUA000118R4101

355 Section 6 IT Asset and IT Device Library Light Alarm Device - Light Cisco 24-Port Switch Alarm Light Alarm Device - Light Cisco 24-Port Switch Alarm Description: Generates alarms for port failures and optionally for disconnected ports. Table 154 lists the Light Cisco 24-Port Switch Alarm Conditions/Subconditions. Table 154. Light Cisco 24-Port Switch Alarm Conditions/Subconditions Conditions Subconditions Generated Description SwitchHealth Normal The port is functioning normally, or the port is not connected but alarming on this condition is disabled. Bad Bad quality on port(s): The status of one or several switch ports can not be accessed. DeviceDown Device is down: All ports are bad quality and status cannot be accessed on any ports. PortError Errors are detected. One or several ports have input or output errors above the specified error limit. PortDisconnected Port(s) are disconnected: One or more ports are not connected. This only alarms if the switch is configured to alarm on open ports. Light Status Device - Light Cisco 24-Port Switch Alert Description: Returns the status of key attributes of a given Cisco 24-Port Switch. Table 155 lists the Light Cisco 24-Port Alert properties. Table 155. Light Cisco 24-Port Alert Properties Property Data Type Description Port-01 to Port-24 String A string describing the current state of each port. The string is either Normal or Bad quality. Value-Port-01 to Value-Port-24 Numeric A numeric representation of a port failure or disconnection. 3BUA000118R

356 Alarm Device - Cisco 48-Port Switch Alarm Section 6 IT Asset and IT Device Library Alarm Device - Cisco 48-Port Switch Alarm Description: Generates alarms for port failures and optionally for disconnected ports. Table 156 lists the Cisco 48-Port Switch Alarm Conditions/Subconditions. Table 156. Cisco 48-Port Switch Alarm Conditions/Subconditions Conditions Subconditions Generated Description SwitchHealth Normal The port is functioning normally, or the port is not connected but alarming on this condition is disabled. Bad Bad quality on port(s): The status of one or several switch ports can not be accessed. DeviceDown Device is down: All ports are bad quality and status can not be accessed on any ports. PortError Errors are detected. One or several ports have input or output errors above the specified error limit. PortDisconnected Port(s) are disconnected: One or more ports are not connected. This only alarms if the switch is configured to alarm on open ports. Status Device - Cisco 48-Port Switch Alert Description: Returns the status of key attributes of a given Cisco 48-Port Switch Table 157 lists the Cisco 48-Port Switch Alert properties. Table 157. Cisco 48-Port Switch Alert Properties Property Data Type Description Port-01 to Port-48 String A string describing the current state of each port. The string is either Normal or Bad quality. Value-Port-01 to Value-Port-48 Numeric A numeric representation of a port failure or disconnection BUA000118R4101

357 Section 6 IT Asset and IT Device Library Status Device - Cisco 48-Port Switch Status Status Device - Cisco 48-Port Switch Status Description: Returns the status of key attributes of a given Cisco 48-Port Switch. Even though this is a 48-Port Switch, it actually has 53 ports exposed. Ports 0, 51 and 52 are not used for communication and are internal. They are exposed for completeness. Ports 49 and 50 are high-speed (GHz) ports. Table 158 lists the Cisco 48-Port Switch Status properties. Table 158. Cisco 48-Port Switch Status Properties Property Data Type Description SysName String The name of the given switch. SysDescr SysUpTime IfDescr00 to IfDescr52 IfOperStatus00 to IfOperStatus52 IfInOctets00 to IfInOctets52 IfOutOctets00 to IfOutOctets52 IfSpeed00 to IfSpeed52 IfOutErrors00 to IfOutErrors52 IfInErrors00 to IfInErrors52 The configured description of the switch. The amount of time the switch has been running since the last reset, in hundredths of seconds. A textual string containing information about the interface. This string should include the name of the manufacturer, the product name and the version of the hardware interface. Numeric A string describing the current port status of ports 0 to 52 (e.g. up). The number of bytes received by the switch per port. The number of bytes sent by the switch per port. The speed of each port in bytes per second. The number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. The number of outbound packets that could not be transmitted because of errors. 3BUA000118R

358 Light Alarm Device - Light Cisco 48-Port Switch Alarm Section 6 IT Asset and IT Device Library Light Alarm Device - Light Cisco 48-Port Switch Alarm Description: Generates alarms for port failures and optionally for disconnected ports. Table 159 lists the Light Cisco 48-Port Switch Alert Conditions/Subconditions. Table 159. Light Cisco 48-Port Switch Alert Conditions/Subconditions Conditions Subconditions Generated Description SwitchHealth Normal The port is functioning normally, or the port is not connected but alarming on this condition is disabled. Bad Bad quality on port(s): The status of one or several switch ports can not be accessed. DeviceDown Device is down: All ports are bad quality and status can not be accessed on any ports. PortError Errors are detected. One or several ports have input or output errors above the specified error limit. PortDisconnected Port(s) are disconnected: One or more ports are not connected. This only alarms if the switch is configured to alarm on open ports. Light Status Device - Light Cisco 48-Port Switch Alert Description: Returns the status of key attributes of a given Cisco 48-Port Switch. Table 160 lists the Light Cisco 48-Port Switch Alert properties. Table 160. Light Cisco 48-Port Switch Alert Properties Property Data Type Description Port-01 to Port-48 String A string describing the current state of each port. The string is either Normal or Bad quality. Value-Port-01 to Value-Port-48 Numeric A numeric representation of a port failure or disconnection BUA000118R4101

359 Section 6 IT Asset and IT Device Library Alarm Device - Hirschmann 8-Port Alarm Alarm Device - Hirschmann 8-Port Alarm Description: Generates alarms on the port modules of the Hirschmann Mach 3000 switches. Table 161 lists the Hirschmann 8-Port Alarm Conditions/Subconditions. Table 161. Hirschmann 8-Port Alarm Conditions/Subconditions Conditions Subconditions Generated Description PortHealth Normal The port is functioning normally. Bad The port cannot be accessed. ModuleDown The port module is down or not responding. PortError The switch has detected an error on this port module. PortDisconnect A port or ports on the module have been disconnected from the network. Status Device - Hirschmann 8-Port Alert Description: Generates alerts on Hirschmann Mach 3000 switches. Table 162 lists the Hirschmann 8-Port Alert properties. Table 162. Hirschmann 8-Port Alert Properties Property Data Type Description Port-1 to Port-8 String A string describing the current state of the port. Value-Port-1 to Value-Port-8 Numeric A numeric representation of the current state of the port. A value of zero (0) in normal and one (1) is Bad Input, greater than one (1) is an abnormal state. 3BUA000118R

360 Status Device - Hirschmann 8-Port Status Section 6 IT Asset and IT Device Library Status Device - Hirschmann 8-Port Status Description: Returns the status of key attributes of a configurable set of ports on a given Hirschmann Mach 3000 switch. There are four different Port Status devices corresponding to the 1, 2, 4, and 8 port modules. Depending on the Device used, the range of properties will vary. Table 163 lists the Hirschmann 8-Port Status properties. Table 163. Hirschmann 8-Port Status Properties Property Data Type Description IfOperStatus1 to Numeric A string describing the current status of the ports (e.g. up). IfOperStatus8 IfInOctets1 to The number of bytes received by the switch per port. IfInOctets8 IfOutOctets1 to The number of bytes sent by the switch per port. IfOutOctets8 IfSpeed1 to The speed of each port in bytes per second. IfSpeed8 MediaAvailable1 to MediaAvailable8 String A string describing the current availability of the port. Possible states include: OTHER, UNKNOWN, AVAILABLE, NOTAVAILABLE, REMOTEFAULT, INVALIDSIGNAL, REMOTEJABBER, REMOTELINKLOSS, REMOTETEST, OFFLINE, AUTONEGERROR BUA000118R4101

361 Section 6 IT Asset and IT Device Library Light Alarm Device - Light Hirschmann 8-Port Alarm Light Alarm Device - Light Hirschmann 8-Port Alarm Description: Generates alarms on the port modules of the Hirschmann Mach 3000 switches. Table 164 lists the Light Hirschmann 8-Port Alarm Conditions/Subconditions. Table 164. Light Hirschmann 8-Port Alarm Conditions/Subconditions Conditions Subconditions Generated Description PortHealth Normal The port is functioning normally. Bad The port cannot be accessed. ModuleDown The port module is down or not responding. PortError The switch has detected an error on this port module. PortDisconnect A port or ports on the module have been disconnected from the network. Light Status Device - Light Hirschmann 8-Port Alert Description: Generates alerts on Hirschmann Mach 3000 switches. Table 165 lists the Light Hirschmann 8-Port Alert properties. Table 165. Light Hirschmann 8-Port Alert Properties Property Data Type Description Port-1 to Port-8 String A string describing the current state of the port. Value-Port-1 to Value-Port-8 Numeric A numeric representation of the current state of the port. A value of zero (0) in normal and one (1) is Bad Input, greater than one (1) is an abnormal state. 3BUA000118R

362 Alarm Device - Hirschmann n-port Alarm Section 6 IT Asset and IT Device Library Alarm Device - Hirschmann n-port Alarm Description: Generates alarms on the port modules of the Hirschmann Mach 3000 switches. Table 166 lists the Hirschmann n-port Alarm Conditions/Subconditions. Table 166. Hirschmann n-port Alarm Conditions/Subconditions Conditions Subconditions Generated Description PortHealth Normal The port is functioning normally. Bad The port cannot be accessed. ModuleDown The port module is down or not responding. PortError The switch has detected an error on this port module. PortDisconnect A port or ports on the module have been disconnected from the network. Light Alarm Device - Light Hirschmann n-port Alarm Description: Generates alarms on the port modules of the Hirschmann Mach 3000 switches. Table 167 lists the Light Hirschmann n-port Alarm Conditions/Subconditions. Table 167. Light Hirschmann n-port Alarm Conditions/Subconditions Conditions Subconditions Generated Description PortHealth Normal The port is functioning normally. Bad The port cannot be accessed. ModuleDown The port module is down or not responding. PortError The switch has detected an error on this port module. PortDisconnect A port or ports on the module have been disconnected from the network BUA000118R4101

363 Section 6 IT Asset and IT Device Library Alarm Device - Hirschmann Power Supply Alarm Alarm Device - Hirschmann Power Supply Alarm Description: Generates alarms on power supply problems on Hirschmann Mach 3000 switches. Table 168 lists the Hirschmann Power Supply Alarm Conditions/Subconditions. Table 168. Hirschmann Power Supply Alarm Conditions/Subconditions Conditions Subconditions Generated Description Alarm Normal The power supply is functioning normally. Bad The power supply status cannot be accessed. Active The switch has reported a problem with the power supply. Status Device - Hirschmann Power Supply Alert Description: Generates alerts on power supply problems on Hirschmann Mach 3000 switches. Table 169 lists the Hirschmann Power Supply Alert properties. Table 169. Hirschmann Power Supply Alert Properties Property Data Type Description Status String A string describing the state of the power supply (e.g. failed). Value-Status Numeric A numerical representation of the state of the power supply. A value of 0 is normal, 1 is Bad Input, greater than 1 is abnormal state. 3BUA000118R

364 Status Device - Hirschmann Power Supply Status Section 6 IT Asset and IT Device Library Status Device - Hirschmann Power Supply Status Description: Returns the status of the Power supplies on given Hirschmann Mach 3000 switches. Table 170 lists the Hirschmann Power Supply Alert properties. Table 170. Hirschmann Power Supply Alert Properties Property Data Type Description PowerSupplyStatus String A string describing the state of the power supply (e.g. failed). Light Alarm Device - Light Hirschmann Power Supply Alarm Description: Generates alarms on power supply problems on Hirschmann Mach 3000 switches. Table 171 lists the Light Hirschmann Power Supply Alarm Conditions/Subconditions. Table 171. Light Hirschmann Power Supply Alarm Conditions/Subconditions Conditions Subconditions Generated Description Alarm Normal The power supply is functioning normally. Bad The power supply status cannot be accessed. Active The switch has reported a problem with the power supply BUA000118R4101

365 Section 6 IT Asset and IT Device LibraryLight Status Device - Light Hirschmann Power Supply Alert Light Status Device - Light Hirschmann Power Supply Alert Description: Returns the status of the Power supplies of Hirschmann Mach 3000 switches. Table 172 lists the Light Hirschmann Power Supply Alert properties. Table 172. Light Hirschmann Power Supply Alert Properties Property Data Type Description Status String A string describing the state of the power supply (e.g. failed). Value-Status Numeric A numerical representation of the state of the power supply. A value of 0 is normal, 1 is Bad Input, greater than 1 is abnormal state. 3BUA000118R

366 Status Device - Hirschmann Mach 3000 Base Status Section 6 IT Asset and IT Device Library Status Device - Hirschmann Mach 3000 Base Status Description: Returns the basic status attributes of given Hirschmann Mach 3000 switches. Table 173 lists the Hirschmann Mach 3000 Base Status properties. Table 173. Hirschmann Mach 3000 Base Status Properties Property Data Type Description SysName String The name of the given switch. SysDescr The configured description of the switch. SysUpTime Numeric The amount of time the switch has been running since the last reset, in hundredths of seconds BUA000118R4101

367 Section 6 IT Asset and IT Device Library Alarm Device - Hirschmann RS2 Alarm Alarm Device - Hirschmann RS2 Alarm Description: Generates alarms on port and power supply problems on Hirschmann RS2 switches. Table 174 lists the Hirschmann RS2 Alarm Conditions/Subconditions. Table 174. Hirschmann RS2 Alarm Conditions/Subconditions Conditions PowerSupply1 PowerSupply2 Subconditions Generated Normal Bad Active Description The power supply is functioning normally. The power supply status cannot be accessed. The switch has reported a problem with the power supply. 3BUA000118R

368 Alarm Device - Hirschmann RS2 Alarm Section 6 IT Asset and IT Device Library Table 174. Hirschmann RS2 Alarm Conditions/Subconditions (Continued) Conditions Port-1 Port-2 Port-3 Port-4 Port-5 Port-6 Port-7 Subconditions Generated Normal Bad Unknown NotAvailable RemoteFault InvalidSignal RemoteJabber RemoteLinkLoss Remote Test Offline AutoNegError Unconnected Description The port is functioning normally, or the port is not connected but alarming on this condition is disabled. The switch port status cannot be accessed. The switch has indicated that a problem of type Unknown has occurred. The switch has indicated that a problem of type Not Available has occurred. The switch has indicated that a problem of type Remote Fault has occurred. The switch has indicated that a problem of type Invalid Signal has occurred. The switch has indicated that a problem of type Remote Jabber has occurred. The switch has indicated that a problem of type Remote Link Loss has occurred. The switch has indicated that a problem of type Remote Test has occurred. The switch has indicated that a problem of type Offline has occurred. The switch has indicated that a problem of type Auto Neg Error has occurred. The switch has indicated that no network connection is currently present on this port BUA000118R4101

369 Section 6 IT Asset and IT Device Library Status Device - Hirschmann RS2 Alert Status Device - Hirschmann RS2 Alert Description: Generates alerts on port and power supply problems on Hirschmann RS2 switches. Table 175 lists the Hirschmann RS2 Alert properties. Table 175. Hirschmann RS2 Alert Properties Property Data Type Description PowerSupply-1 PowerSupply-2 String A string describing the current state of the power supply. Port-1 to Port-# A string describing the current state of the port. Value-PowerSupply-1 Value-PowerSupply-2 Numeric A numeric representation of the current state of the power supply. A value of zero (0) is normal, one (1) is Bad Input, greater than one (1) is an abnormal state. Value-Port-1 to Value-Port-# A numeric representation of the current state of the port. A value of zero (0) is normal, one (1) is Bad Input, greater than one (1) is an abnormal state. Status Device - Hirschmann RS2 Status Description: Returns the status of key attributes of Hirschmann RS2 switches. Table 176 lists the Hirschmann RS2 Status properties. Table 176. Hirschmann RS2 Status Properties Property Data Type Description SysName String The name of the given switch. SysDescr The configured description of the switch. 3BUA000118R

370 Status Device - Hirschmann RS2 Status Section 6 IT Asset and IT Device Library SysUpTime Numeric The amount of time the switch has been running since the last reset, in hundredths of seconds. IfOperStatus1 to IfOperStatus7 IfInOctets1 to IfInOctets7 IfOutOctets1 to IfOutOctets7 IfSpeed1 to IfSpeed7 MediaAvailable1 to MediaAvailable7 PowerState1 to PowerState7 Table 176. Hirschmann RS2 Status Properties (Continued) Property Data Type Description String A string describing the current port status of ports 0 to 7 (e.g. up). The number of bytes received by the switch per port. The number of bytes sent by the switch per port. The speed of each port in bytes per second. A string describing the current availability of the port. Possible states include: OTHER, UNKNOWN, AVAILABLE, NOTAVAILABLE, REMOTEFAULT, INVALIDSIGNAL, REMOTEJABBER, REMOTELINKLOSS, REMOTETEST, OFFLINE, AUTONEGERROR. A string describing the state of the power supply (e.g. failed) BUA000118R4101

371 Section 6 IT Asset and IT Device Library Light Alarm Device - Light Hirschmann RS2 Alarm Light Alarm Device - Light Hirschmann RS2 Alarm Description: Generates alarms on port and power supply problems on Hirschmann RS2 switches. Table 177 lists the Light Hirschmann RS2 Alarm Conditions/Subconditions. Table 177. Light Hirschmann RS2 Alarm Conditions/Subconditions Conditions PowerSupply1 PowerSupply2 Subconditions Generated Normal Bad Active Description The power supply is functioning normally. The power supply status cannot be accessed. The switch has reported a problem with the power supply. 3BUA000118R

372 Light Alarm Device - Light Hirschmann RS2 Alarm Section 6 IT Asset and IT Device Library Table 177. Light Hirschmann RS2 Alarm Conditions/Subconditions (Continued) Conditions Port-1 Port-2 Port-3 Port-4 Port-5 Port-6 Port-7 Subconditions Generated Normal Bad Unknown NotAvailable RemoteFault InvalidSignal RemoteJabber RemoteLinkLoss Remote Test Offline AutoNegError Unconnected Description The port is functioning normally, or the port is not connected but alarming on this condition is disabled. The switch port status cannot be accessed. The switch has indicated that a problem of type Unknown has occurred. The switch has indicated that a problem of type Not Available has occurred. The switch has indicated that a problem of type Remote Fault has occurred. The switch has indicated that a problem of type Invalid Signal has occurred. The switch has indicated that a problem of type Remote Jabber has occurred. The switch has indicated that a problem of type Remote Link Loss has occurred. The switch has indicated that a problem of type Remote Test has occurred. The switch has indicated that a problem of type Offline has occurred. The switch has indicated that a problem of type Auto Neg Error has occurred. The switch has indicated that no network connection is currently present on this port BUA000118R4101

373 Section 6 IT Asset and IT Device Library Light Status Device - Light Hirschmann RS2 Alert Light Status Device - Light Hirschmann RS2 Alert Description: Generates alerts on port and power supply problems on Hirschmann RS2 switches. Table 178 lists the Light Hirschmann RS2 Alert properties. Table 178. Light Hirschmann RS2 Alert Properties Property Data Type Description PowerSupply-1 PowerSupply-2 String A string describing the current state of the power supply. Port-1 to Port-# A string describing the current state of the port. Value-PowerSupply-1 Value-PowerSupply-2 Numeric A numeric representation of the current state of the power supply. A value of zero (0) is normal, one (1) is Bad Input, greater than one (1) is an abnormal state. Value-Port-1 to Value-Port-# A numeric representation of the current state of the port. A value of zero (0) is normal, one (1) is Bad Input, greater than one (1) is an abnormal state. 3BUA000118R

374 Light Status Device - Light Hirschmann RS2 Alert Section 6 IT Asset and IT Device Library 374 3BUA000118R4101

375 Section 7 Network and Device Scanning Tool Introduction The Network and Device Scanning Tool consists of two components: Net Scan: The Net Scan component is an Internet Protocol/Simple Network Management Protocol (IP/SNMP) discovery tool. It scans the network for available IT Assets, determines if they are SNMP enabled, and reads the SNMP data. Compilation Wizard: The Compilation Wizard component is used to load, compile, and translate Management Information Base (MIB) files. Figure 108 provides an overview of the Network and Device Scanning Tool structure. Figure 108. Network and Device Scanning Tool Structure tc07756a 3BUA000118R

376 Using the Network and Device Scanning Tool Section 7 Network and Device Scanning Tool Using the Network and Device Scanning Tool To start the Network and Device Scanning Tool, select: Start > All Programs > ABB Industrial IT 800xA > Asset Optimization > PC, Network and Software Monitoring > Network and Device Scanning Tool File Menu To start a project open the File Menu. Editing Project Properties The Project Properties dialog is used to configure the application parameters. The Project Properties dialog has two tabs: Application Data tab. The Application Data tab has several selections: Transaction Timeout. The transaction timeout is the total timeout for one transaction. This value must be greater than the Ping Timeout multiplied by Ping Attempts. Ping Timeout. Ping timeout is the timeout for one specific ping to a device. This number may need to be increased if the network is busy and is receiving timeout errors. Increasing this number can slow down the time to complete a range of IPs when the device does not exist. Ping Attempts. Ping attempts is the number of times to ping for each device before a ping timeout error is displayed. Increasing this number can slow down the time to complete a range of IPs when the device does not exist BUA000118R4101

377 Section 7 Network and Device Scanning Tool File Menu Memory Logging. Memory logging can be enabled. A pattern of: %d [%t] %-5p %c %x - %m%n is set as default in the text box on the right of the log4net Pattern label. The format of the output to the online memory log can be changed. Refer to the log4net user manual at: The online log file can be viewed by selecting: View > Online Log on the menu. Project Data tab. The Project Data tab provides information about the current project file, the last user, current user, last time the project was saved, and the formatter used. Creating a New Project 1. To create a new project select: File > New Project 2. When the New Project dialog appears, enter a name of a directory in which to create the new project in the Filename field and click Save. 3. A new directory is created with standard MIB files and an XML file for the project information. 3BUA000118R

378 Net Scan Window Section 7 Network and Device Scanning Tool Opening an Existing Project 1. To open an existing project select: File > Open Project 2. The Open Project dialog is displayed. If a project is already open a prompt appears asking if you want to save the existing project first. 3. Browse to the directory where the Project.xml file is located. Double-click on the Project.xml file to open the project. Net Scan Window When in the Net Scan Window the following features are available through the Scan drop-down menu as shown in Figure 109 or by right-clicking and using the context menu as shown in Figure 110. Figure 109. Scan Menu Selection Dialog TC07757A 378 3BUA000118R4101

379 Section 7 Network and Device Scanning Tool Net Scan Window TC07758A Figure 110. Context Menu Tree Edit IP Ranges Care should be taken when entering IP addresses on computers running the Windows 2000 Server operating systems. IP addresses on these computers may be misinterpreted. On Windows 2000 Server computers, IP addresses with a leading zero will be interpreted as being octal numbers. For example will represent the decimal IP address When specifying individual decimal numbers that make up an IP address, the numbers should always be entered without leading zeros e.g This restriction does not apply to Window XP or Windows Server 2003 where numbers with leading zeros are treated as decimal numbers. 1. Select: Scan > Edit IP Ranges from the menu. 3BUA000118R

380 Net Scan Window Section 7 Network and Device Scanning Tool 2. The IP Range and/or Hostname can be edited in the Edit IP Range Dialog as shown in Figure 111. Figure 111. Edit IP Range Dialog TC07759A 3. A project can contain multiple IP Ranges and Hostnames. After typing in the IP range and hostname, click Add Range or Add Hostname to add them to the current project. 4. To remove unused IP ranges and/or hostnames, click Remove. The number of devices per range is restricted to IP addresses are validated that they are correct. The IP syntax validation is not done for hostnames. Edit Community Names 1. Select: Scan > Edit Community Names from the menu BUA000118R4101

381 Section 7 Network and Device Scanning Tool Net Scan Window 2. The Edit Community Names dialog appears as shown in Figure 112. TC07760A Figure 112. Edit Community Names Dialog 3. Community names are used by SNMP to provide a simple form of security. The default community name for SNMP communication is public for read access. The community name can be changed in the devices themselves; therefore, multiple community names are needed if trying to get SNMP information from a range of devices. The default community name can also be deleted or changed, but if all community names are removed, including the default name (public), SNMP will not respond. Each time an SNMP Get Info (Selected) or (ALL) or SNMP Walk (Selected) or (ALL) is executed the device tries to communicate with each of the community names. Set Object ID (OID) Root 1. To Edit the OID Root for an IP Address, select Scan > Set OID Root from the menu. 3BUA000118R

382 Net Scan Window Section 7 Network and Device Scanning Tool 2. The Edit OID Root dialog is displayed as shown in Figure 113. Figure 113. Edit OID Root Dialog TC07761A This list is empty until IP Ranges or Hostnames have been created in the Edit IP Ranges dialog. 3. The list consists of one line per IP Range or Hostname and the corresponding OID. The OID is the starting point into the structure of an SNMP device at which the SNMP Walk will read data from. The OID for a specific IP Address can be edited. Generally, an SNMP Walk would have been done and data read from the device. One of the OIDs would then be chosen from the Results and used in here to do another SNMP Walk to get a subset of the data. Click on the OID to edit it. 4. Type in the New OID and click OK. 5. The next time an SNMP Walk is performed, the data will be read starting from this new OID. Scan IP Address/Range After adding the IP ranges, the devices on the network can be scanned BUA000118R4101

383 Section 7 Network and Device Scanning Tool Net Scan Window 1. Right-click on the IP range and select Ping (Selected) from the context menu that appears to ping a specific device (refer to Figure 114). -or- Select Ping (ALL) to ping all the devices in the IP Range List. Figure 114. Ping a Selected Device TC07762A 3BUA000118R

384 Net Scan Window Section 7 Network and Device Scanning Tool The devices become green if the ping is successful and red if not, as shown in Figure 115 (the same coloring behavior applies to SNMP transactions). Figure 115. Ping Results TC07763A SNMP Get Info To run an SNMP Get Info (Selected), the cursor must be on the IP Range. The SNMP Get Info (Selected) informs the user whether or not the device is SNMP enabled, by producing a specific table row with a description of the device as shown in Figure 116. An SNMP Get Info (ALL) performs the read on all the devices in the IP Range List. Figure 116. SNMP Info Results TC07764A 384 3BUA000118R4101

385 Section 7 Network and Device Scanning Tool Net Scan Window SNMP Walk To run an SNMP Walk, the cursor must be on the IP address. The SNMP Walk provides a detailed table representing information on the device using OIDs. An SNMP Walk (ALL) performs the read on all the devices in the IP Range List. Once the table is loaded the next step is to see which of the described OIDs are supported in the MIB through the Check Loaded MIB Support option. Check Loaded MIB Support 1. To check which OIDs are supported in the MIB for an individual device, rightclick on one of the SNMP Walks that it is desired to check the support for. 2. Select Check loaded MIB Support (Selected) from the context menu that appears. The NetScan finds the corresponding device in the tree of the Compilation Wizard according to the OID, followed by getting MIB information of the device, and then displays the description in the result fields, as shown in Figure 117. The value of the MIB Support column will become True for OIDs that are in the loaded MIBs. Figure 117. Getting MIB Support Results TC07765A 3BUA000118R

386 Net Scan Window Section 7 Network and Device Scanning Tool Verify SMIR Support During an SNMP Walk the values for the walked OIDs are queried from an SNMP agent using SNMP commands. However, after the corresponding MIB files have been loaded into the SMIR and a Namespace has been created for the targeted SNMP agent, the values for the same OIDs can also be retrieved via the SMIR using Windows Management Instrumentation (WMI). This way it is possible to verify that the MIB loading and Namespace creation have been successful. 1. After selecting Verify SMIR Support, either from the scan menu or from the context menu, the verification dialog is displayed as shown in Figure 118. TC07766A Figure 118. Verifying Dialog for Walked OIDs Against a SMIR 2. The dialog offers the selection between using the SNMP agent specific Namespace in the SMIR or using the default namespace of the SMIR on the SNMP agent BUA000118R4101

387 Section 7 Network and Device Scanning Tool Net Scan Window If the SMIR is selected, the namespace for the target agent can be specified. The namespace is automatically suggested based on the IP of the SNMP agent and is the same as the default value of the namespace creation tool. Either use the currently logged in user or specify another username/password combination. The selected user must have administrative privileges on the agent computer. 3. Clicking OK starts the verification. If the SMIR is selected and the specified namespace does not exist in the SMIR, the Create Namespace dialog is displayed to create the missing namespace. 4. When the verification is completed, the results display the full CIM path (including device, namespace, class, and object names) in the Verification Path column (Figure 119). Figure 119. Verification Results TC07767A The Value column displays the unformatted value read directly from the SNMP device and the Verification Value column contains the formatted value read by WMI. Hide/Remove Selected 1. To access Hide/Remove Selected, choose it from the context menu. 3BUA000118R

388 Net Scan Window Section 7 Network and Device Scanning Tool 2. The selected IP Address or transaction result is hidden or removed depending on where the cursor is placed. One transaction result is removed at a time or an IP Address is hidden and all transactions are removed under it. Hide/Remove Unreachable Remove unreachable IP Addresses and unsuccessful transactions by clicking Hide/Remove Unreachable from the context menu. The IP addresses that have been removed can not be accessed again until the Reset Tree feature is selected. Show All Selecting Show All from the context menu causes all the hidden IP Addresses to be shown in the tree. Reset Tree Selecting Reset Tree from the context menu causes all IP Ranges and Hostnames to be shown again, but all transaction results are removed. Create Namespace An SNMP agent provides access to management data about a particular network device or application and responds to SNMP management station requests for data. To access the values of such a remote SNMP agent using WMI, a namespace, containing the IP address of the agent, has to be created in the SMIR BUA000118R4101

389 Section 7 Network and Device Scanning Tool Net Scan Window 1. The Create New Namespace dialog (Figure 120) is provided by either selecting Create Namespace from the Tools menu or from the context menu. Figure 120. Create New Namespace Dialog The namespace creation tool uses an internal MOF file, which is compiled into the SMIR to create the selected namespace. The MOF file itself is created based on a template and parameters for the address of the SNMP agent and the name of the new namespace. 2. By clicking Browse, a MOF template can be selected. A MOF template is a normal MOF file, with the exception that it contains the two TC07768A instead of the IP address of the agent respectively and the name of the new namespace to create. All MOF file templates have the.mot suffix. 3BUA000118R

390 View Menu Section 7 Network and Device Scanning Tool 3. The Generic_SNMP_Proxy.mot template is selected by default. This template is created in the application folder during installation. It should not be necessary to change it. However, if to customize it, directly edit it within the dialog and save the changes by clicking Save Template. 4. After the IP address of the SNMP agent to access has been entered in the Agent Address field, a name for the namespace to be created is automatically suggested in the New Namespace field. This name can be customized, as long as the naming constraints for SMIR namespaces are respected. The Namespace name cannot contain periods and must start with a letter. 5. Clicking Generate MOF displays the results of the replacement of the in the MOF template with the specified parameter values. 6. The resulting MOF file is loaded into the SMIR by clicking Create. The result of the loading is displayed in the lower text box. 7. After creating any number of namespaces, leave the dialog by clicking Close. View Menu The View menu contains: NetScan. Used to view/use the Net Scan tool. Compilation Wizard. Used to view/use the Compilation Wizard tool. Online Log. The Online Log provides a text based file of all Network and Device Scanning Tool transactions. Compilation Wizard Window When a new project is created, two default MIB files that are included in the configuration file are loaded into the Compilation Wizard BUA000118R4101

391 Section 7 Network and Device Scanning Tool View Menu In order to support new MIB files, they have to be loaded and compiled into the local SNMP Management Information Repository - SMIR. MIB MIB has several functions. Open MIB Files. To Open MIB files: 1. Select: View > Compilation Wizard on the tool bar to display the Compilation Wizard Tool. 2. Select: MIB > OPEN MIB on the menu or use the context menu. 3. Browsing to the MIB file and click Open to load the MIB file into the current project. 4. The result window displays the current MIB loading information. Loading of MIBs may depend on other MIBs being loaded first. 3BUA000118R

392 View Menu Section 7 Network and Device Scanning Tool Show Selected MIB as Text. To view the MIB files in text form: 1. Select: Show Selected MIB as Text from the menu system or from the context menu. This provides a detailed description of the MIBs OIDs and corresponding Object Names in the results window as shown in Figure 121. Figure 121. View MIB File as Text TC07769A Remove MIB. To remove the MIB from the current project: 1. Select: MIB > Remove MIB or use the context menu. 2. Select the desired MIB from the dialog and click OK. 3. Unsuccessful removal of MIBs is due to the dependency of other MIBs. Check the result window for these names, they must be removed first BUA000118R4101

393 Section 7 Network and Device Scanning Tool Process Menu Process Menu The Process menu has several options. Compile into SMIR 1. To compile a MIB file into the SMIR, select: Process > Compile into SMIR or use the context menu and select the MIB file from the dialog. The MIB file must be opened into the project before it can be compiled into the SMIR. 2. If the compilation is successful, a message: Storing data in the repository Done! appears in the result window. There may be other minor syntax errors which do not effect the compilation. 3. If the message does not appear, then the MIB did not compile successfully. An unsuccessful compilation may be due to the following reasons: Syntax error in the MIB file - Check the result window for the syntax errors to correct. The MIB file may depend on other MIB files to be loaded first - Check the result window for the dependent MIB files to load first. Delete from SMIR To delete a MIB file from the SMIR, click Delete from SMIR or use the context menu and select the MIB file from the dialog. List SMIR To list the MIBs that are currently in the SMIR, click List SMIR or use the context menu. They are listed in the results window. 3BUA000118R

394 Process Menu Section 7 Network and Device Scanning Tool 394 3BUA000118R4101

395 Section 8 Creating Custom IT Devices and IT Assets Introduction Key Concepts The PC, Network and Software Monitoring feature provides tools that allow a user to create new IT Devices and IT Assets. This is necessary when existing IT Devices need to be enhanced to monitor additional data, or if new devices need to be monitored that do not have predefined IT Devices. Creating new Devices is a complex task, involving a number of different technologies and skills. Read this entire section before proceeding and ensure that the person designing the IT Devices is adequately trained and qualified to do so. These examples are being provided by ABB for those who have the training and expertise required to devise scripts for additional devices. ABB will not provide technical support for IT Asset and IT Device scripts that are not predefined scripts provided with the product. There are a number of key concepts that need to be understood before developing IT Devices. They are: Windows Management Instrumentation (WMI). Simple Network Management Protocol (SNMP). PC, Network and Software Monitoring Scripting. PC, Network and Software Monitoring OPC Item Syntax. 3BUA000118R

396 Windows Management Instrumentation (WMI)Section 8 Creating Custom IT Devices and IT Assets Windows Management Instrumentation (WMI) Figure 122 outlines the major WMI components. Figure 122. WMI Components TC05136A The WMI infrastructure uses an Object Manager to service requests from client applications. WMI devices are represented as objects in the Object Repository, with data for those objects provided by the WMI providers BUA000118R4101

397 Section 8 Creating Custom IT Devices and IT AssetsWindows Management Instrumentation (WMI) Use the WMI Object Browser shown in Figure 123 to browse the contents of the Object Repository. For details on how to use the WMI Object Browser, launch the help files from the WMI Object Browser window. Figure 123. WMI Object Browser TC05117A A free download of WMI tools, including the WMI Object Browser, mofcomp.exe, smi2smir.exe, and other useful tools, is available at: 3BUA000118R

398 Simple Network Management Protocol (SNMP) Section 8 Creating Custom IT Devices and IT Additional information about WMI can be found at: Simple Network Management Protocol (SNMP) SNMP is a communication protocol that allows network devices to exchange management information. An SNMP-managed network consists of three primary components: Managed device: A network node that contains an SNMP agent and resides on an SNMP-managed network. Managed devices collect and store information and use SNMP to make this information available to management systems that use SNMP. Managed devices include: Routers. Access servers. Switches. Bridges. Hubs. Computer hosts. Network elements. Agent: A software module that resides in a managed device. An agent has local knowledge of management information and translates that information into a form compatible with SNMP. The SNMP agent gathers data from the Management Information Base (MIB), which is the repository for device parameter and network data. Management system (also called management console): Sends information and update requests to an SNMP agent. Any computer running SNMP management software is an SNMP management system. The management software application does not need to run on the same host as the SNMP agent. The SNMP management system requests information from a managed computer (the agent), such as the amount of hard disk space available or the number of active sessions. The management system can also initiate a change to an agent configuration. However, this is rare because most clients have readonly access. In order to access data from an SNMP managed device, there must be a Management Information Base (MIB) file corresponding to that device. A MIB file 398 3BUA000118R4101

399 Section 8 Creating Custom IT Devices and IT Assets PC, Network and Software Monitoring defines the data that can be provided by an SNMP managed device. Within the MIB file, an object identifier (OID) is used to uniquely identify each object variable of a MIB. Ideally MIB files can be downloaded from the vendor of the network device; however, it is sometimes necessary to visit a web site that maintains a database of MIB files, such as: PC, Network and Software Monitoring Scripting Creating scripts is a computer programming activity, and should only be performed by those familiar with the concepts of software development. Do not test new scripts while a system is on line. Incorrect scripts can have serious detrimental effects on the operation of the PC, Network and Software Monitoring system. The PC, Network and Software Monitoring Server contains built-in support for executing small computer programs called scripts. A set of scripts is installed as part of the PC, Network and Software Monitoring software package, and users have the ability to add their own scripts. Scripts are useful for: Preprocessing or filtering raw data received from WMI. Alarm limit detection. Combining data from multiple sources or generating calculated values. Scripts can be written in any.net managed-code language (Visual BASIC.Net, JScript, C#, etc.). A simple scripting model is provided that allows script developers to focus on the additional functionality their scripts provide. A sample script is provided to assist in script creation. It is located in: Drive:\Program Files\ABB Industrial IT\Optimize IT\PC, Network and Software Monitoring\bin\Configuration\Scripts\Default Place new scripts in: Drive:\Program Files\ABB Industrial IT\Optimize IT\PC, Network and Software Monitoring\bin\Configuration\Scripts\User Directory 3BUA000118R

400 PC, Network and Software Monitoring Scripting Section 8 Creating Custom IT Devices and IT where they will be automatically detected and compiled by the PC, Network and Software Monitoring Server. Compiled scripts are placed in: Drive:\Program Files\ABB Industrial IT\Optimize IT\PC, Network and Software Monitoring\bin\Configuration\Cache Scripts support NLS (National Language Support) for displaying their text values. There is a corresponding resource file for each of the default scripts. Each resource file contains the modifiable text. The following procedure does not instruct how to change the language on Window computers. Refer to the appropriate Microsoft documentation for changing the language on the computer. The language on the computer must be set for the following procedure to work. To edit these files for use in different languages: 1. Using Windows Explorer, copy the resource file for which the language is to be changed, from: Drive:\Program Files\ABB Industrial IT\Asset Optimizer\PC, Network and Software Monitoring\bin\Configuration\Resources\Default Directory 2. Paste the file into: Drive:\Program Files\ABB Industrial IT\Asset Optimizer\PC, Network and Software Monitoring\bin\Configuration\Resources\User Directory 3. Remove the Read-only Attribute on the destination file. 4. Modify the name of the file to match standard language encoding practices which use lower case letters to represent the language and upper case letters to represent the country/region. Refer to: BUA000118R4101

401 Section 8 Creating Custom IT Devices and IT Assets PC, Network and Software Monitoring for the full list of languages. Some examples of the culture tags are listed in Table 179. Table 179. Culture Tags Culture Tag de de-at de-ch en en-us en-au en-ca fr sp Language German Austrian German Swiss German English - any region United States English Australian English Canadian English French Spanish An example of renaming a file for use with a Windows computer running in the German language, would be DiskDriveAlarm.txt to DiskDriveAlarm.de.txt. 5. Edit the file with Notepad and make the appropriate changes. The text to the left of the equal sign is the default value and should not be changed. The text to the right of the equal sign is the value that will be displayed. This is the text that would be changed to be language specific. Figure 124 shows the file changed to German. TC05316A Figure 124. NLS Example 3BUA000118R

402 PC, Network and Software Monitoring Assemblies Section 8 Creating Custom IT Devices and IT 6. Save the file. Be sure, when saving the file, that Encoding is set to Unicode or special characters will not be displayed correctly in the IT Control Connection. PC, Network and Software Monitoring Assemblies The PC, Network and Software Monitoring Server contains built-in support for executing preassembled programs. Default preassembled programs are installed with the PC, Network and Software Monitoring software. They are located in: Drive:\Program Files\ABB Industrial IT\Optimize IT\PC, Network and Software Monitoring\bin\Configuration\Assemblies\Default Users can add their own preassembled programs and they are placed in: Drive:\Program Files\ABB Industrial IT\Optimize IT\PC, Network and Software Monitoring\bin\Configuration\Assemblies\User Directory Script and Assembly Load Hierarchy If there is a combination of Scripts and Assemblies and the names of any of them are the same, then a certain hierarchy must be used to determine which one takes precedence over which. It will stop on the first instance found. If the OPC item in the IT Control Connection has a <name>.dll extension on it, it will go directly to the Assemblies Directory and search, in the following order, for: Assemblies/User/<name.dll> Assemblies/Default/<name.dll> If the OPC item does not have a.dll extension on it, then it will search, in the following order, for: Script/User/<name> Script/Default/<name> Cache/<name.dll> Assemblies/User/<name.dll> Assemblies/Default/<name.dll> BUA000118R4101

403 Section 8 Creating Custom IT Devices and IT Assets PC, Network and Software Monitoring OPC PC, Network and Software Monitoring OPC Item Syntax The PC, Network and Software Monitoring Server supports two different syntaxes, depending on whether the data to access is raw WMI data or generated by a script. The WMI syntax for non-snmp devices is: wmi: \\<wmi path>.<wmi property> The WMI syntax for SNMP devices is: wmi:@<hostname>:<community name>\\<wmi path>.<wmi property> Table 180 lists the definitions of the WMI syntax fields. Field hostname Table 180. WMI Syntax Definition IP address or DNS name of the SNMP managed device (switch, router, printer, etc.). community name SNMP community name, used by SNMP devices for security purposes. wmi path wmi property WMI path to the object of interest. This is usually taken from the PATH string shown in the WMI Object Browser. WMI property on the WMI object. The script syntax is: script:<scriptname>?<param1>=<value1>&<param2>=<value2>&... Table 181 lists the definitions of the script syntax fields. Table 181. Script Syntax Field scriptname param<n> value<n> Definition Name of the script to run (e.g. samplescript.js). A named parameter, used by the script. Value of the named parameter passed to the script. 3BUA000118R

404 Creating IT Devices and IT Assets Section 8 Creating Custom IT Devices and IT Assets When specifying the syntax for a WMI or script reference, it is possible to use Tokens as placeholders for user-configurable values. These values are configured through the IT General Property aspect, or the individual IT Device aspect configurations. For example, in the WMI syntax example, %host% could be substituted for hostname and %community% can be substituted for community name: wmi:@%host%:%community%\\localhost\root\cimv2... This means that when the item definition is passed to the PC, Network and Software Monitoring Server, %host% and %community% is replace by the host and community general or device-specific property: wmi:@ :public\\localhost\root\cimv2... Creating IT Devices and IT Assets The items previously discussed can be put together to create new IT Devices and IT Assets. Creating a New IT Device Creating a new IT Device means adding a new IT Device Configuration object to the Object Type Structure. Once this new IT Device is created, it can be selected for use in an IT Device aspect configuration page in an individual IT Asset object. Three types of IT Devices can be created: Status Devices: Devices that return status information, but no alarms. Properties defined in Status Devices typically return Boolean or numeric values. Status devices may be driven by either WMI data directly, or via scripts. Alert Devices: Devices that generate alerts when failure conditions exist. Properties defined in Alert Devices return Alert Strings of Alert Numeric Values. The numeric value indicates the state of the alert. Alert Devices are always driven by scripts. Alarm Devices: Devices that generate alarms when failure conditions exist. Properties defined in Alarm Devices return alarm definition strings, for use by Asset Optimization to generate alarms. Alarm Devices are always driven by scripts BUA000118R4101

405 Section 8 Creating Custom IT Devices and IT Assets Creating a New IT Device To create a new IT Device Configuration Type: The following procedure presents a suggested method for creating a new IT Device Configuration Type. The locations of Objects and Object Type Groups may differ depending on the installation. 1. Decide the location of the new Object Type in the Object Type Structure. To group several new Object Types together under IT Device Configurations, Object Type Group, create a new Object Type Group. a. Use the Structure Selector to open the Object Type Structure. b. Use the Object Browser to navigate to, and right-click on IT Device Configurations, Object Type Group. c. Select New Object... from the context menu that appears to open the New Object dialog. d. Select Object Type Group under the Common tab in the New Object dialog. e. Type a name in the Name field (IT Status Devices in this example). f. If desired, type a description in the Object description field. g. Click Create. 3BUA000118R

406 Creating a New IT Device Section 8 Creating Custom IT Devices and IT Assets 2. Create a new Object Type in the Object Type Group (Figure 125). Figure 125. Creating an Object Type TC05122B a. Right-click on the new Object Type Group (IT Status Devices, Object Type Group in this example). b. Select New Object... from the context menu that appears to open the New Object dialog. c. Select Object Type under the Common tab in the New Object dialog. d. Type a name in the Name field (NewStatusDevice in this example). e. If desired, type a description in the Object description field. f. Click Create BUA000118R4101

407 Section 8 Creating Custom IT Devices and IT Assets Configuring an IT Device Configuration 3. Add the IT Device Configuration aspect to the new object. a. Right-click on the new Object Type (NewStatusDevice, Object Type in this example). b. Select New Aspect... from the context menu that appears to open the New Aspect dialog. c. Check the Show all check box and deselect the List presentation check box. d. Navigate to and select IT Device Configuration from the list that appears. e. Change the name from IT Device Configuration to something that relates to this device. f. Click Create. Configuring an IT Device Configuration Aspect The IT Device Configuration allows definition of the contents of the new device. This includes: Defining the properties supported by the device. Defining the types of alarms or alerts (if any) the device will generate. In may be necessary to add a script to the system in order to generate alarms or alerts. Additional data about the alarm conditions, for use by Asset Optimization. Defining the required parameters when using this device, and whether or not they are shared with other devices. Default values for those parameters. The OPC item strings that map data from WMI or scripts to the properties. 3BUA000118R

408 Configuring an IT Device Configuration AspectSection 8 Creating Custom IT Devices and IT Assets Table 182 outlines the uses of the buttons that appear on the IT Device Configuration Config view shown in Figure 126. Table 182. IT Device Configuration Config View Buttons Button Function Description Delete Deletes the highlighted Item/Token and moves back to previous Item/Token in that branch. New Token Creates a new Token for the Item highlighted in the branch in the Tree view. New Item Creates a new Item at the root of the Tree view. Save Configuration Cancel Apply Help Saves the changes temporarily and enables Cancel and Apply. NOTE: After clicking Save Configuration, click Apply for changes to take effect or click Cancel to abort the changes. Cancels changes. Not enabled until Save Configuration is clicked. Applies changes. Not enabled until Save Configuration is clicked. Opens help file BUA000118R4101

409 Section 8 Creating Custom IT Devices and IT Assets Configuring an IT Device Configuration TC05123C Figure 126. IT Device Configuration Config View The Config view of the IT Device Configuration has three different views: Main view: Displays a list of all IT Devices that reference this IT Device Configuration (Figure 127). It is useful to know this if it becomes necessary to change or delete this IT Device Configuration. Changes made to the IT Device Configuration automatically propagate to the assets that use the device. TC05124B Figure 127. IT Device Configuration (Main View) 3BUA000118R

410 Configuring an IT Device Configuration AspectSection 8 Creating Custom IT Devices and IT Assets Config view - Token view: Allows configuration of the properties to return from the device, and the definitions of the Items that drive these properties. Config view Asset Optimization view: Allows configuration of the additional alarm data for use by Asset Optimization. To configure the newly created IT Device Configuration Type: 1. Use the Structure Selector to open the Object Type Structure. 2. Navigate to: IT Device Configurations, Object Type Group > IT Status Device, Object Type Group > NewStatusDevice, Object Type 3. Click IT Device Configuration in the Aspect List Area. 4. Click on the View Selector and select Config to open the Config view in the Preview Area as shown in Figure 126. Tokens Tokens are defined to configure the parameters necessary for the end user to fill in when using the new IT Device. There are two types of Tokens: Common: Used throughout the device, or across devices within the asset. Item-specific: Valid only within the scope of the individual Item. Token names can be reused between different properties. For example, the WarningLimit Token can be used on several different limit checking Items BUA000118R4101

411 Section 8 Creating Custom IT Devices and IT Assets Configuring an IT Device Configuration Figure 128 shows an example of a completed Token configuration. Figure 128. Token Configuration TC05125B The fields in the Token frame are: Name: The Token name. Description: The description of the Token. Source Type: Defines the source of the Token value. Table 183 lists and describes the valid Source Types. Default Value: The Token default value. Table 183 describes the behavior of the Default Value for each Source Type. Blank token does not prevent CC Population: If this check box is checked, then this token will be populated into the IT Control Connection even if Default Value: is blank. The check box is unchecked by default. 3BUA000118R

412 Configuring an IT Device Configuration AspectSection 8 Creating Custom IT Devices and IT Assets Table 183. Source Types Source Type Description Valid Token Type USERSETABLE_COMMON USERSETABLE_WMIDEVICE USERSETABLE_WMIITEM ASPECTVALUE_COMMON ASPECTVALUE _WMIDEVICE ASPECTVALUE _WMIITEM An entry is inserted in the IT General Properties aspect (if it does not already exist). The value of the General Property will be the value used to replace the Token. The name of the entry in the General Property will be the same as the name of the Token. The naming allows Items in multiple IT Devices to reference the same value. The Default Value of the creating Token will be put into the General Property but can be changed. Changing the Default Value changes it for all referencing Tokens. An entry is inserted in the IT General Properties aspect (if it does not already exist). The value of the General Property will be the value used to replace the Token. The name of the entry in the General Property will be the combination of the IT Device name and the name of the Token. The naming allows multiple IT Items within the same IT Device to reference the same value. The Default Value of the creating Token will be put into the General Property but can be changed. Changing the Default Value changes it for all referencing Tokens. The value is stored in the IT Item. The Default Value is initially displayed but can be changed by the user. The value of the Item will be the value used to replace the Token. Not supported. Common Item-specific 412 3BUA000118R4101

413 Section 8 Creating Custom IT Devices and IT Assets Configuring an IT Device Configuration Items Items define the properties, alerts, and alarms generated by an IT Device. In a status-type IT Device, an Item represents a particular value generated from the IT Device. In and alert-type IT Device, an Item represents a specific alert condition, that can in turn exist in one of the several definable subconditions. In an alarm-type IT Device, an Item represents a specific alarm condition, which can in turn exist in one of several definable subconditions. The data supplied with the Item configuration is used to configure the IT Control Connection aspect. For each Item defined, a property is added to the IT Control Connection with the Name, Description, Data Type, and Update Rate specified. Figure 129 shows an example of a completed Item configuration. Figure 129. Item Configuration TC05126B 3BUA000118R

414 Configuring an IT Device Configuration AspectSection 8 Creating Custom IT Devices and IT Assets WMI Property Type The fields and the check box in the Device Item frame are: Name: A unique name within the IT Device. When the property is created in the IT Control Connection on the IT Asset object, it is prefixed with the name given to this IT Device aspect on the object. Description: A short description of the Item. Data Type: The type of data that this Item returns (refer to Table 184). Table 184. WMI CIM Data Type to IT Item Type Conversion IT Device Item Data Type Description BOOLEAN VT_BOOL A 16 bit Boolean (True/False) value. A value of 0xFFFF (all bits 1) indicates True; a value of 0 (all bits 0) indicates False. No other values are valid. STRING, REF VT_BSTR A text string. DATETIME VT_DATE A value denoting a date and time. Dates are represented as double-precision numbers, where midnight, January 1, 1900 is 2.0, January 2, 1900 is 3.0, and so on. The value is passed in date. This is the same numbering system used by most spreadsheet programs, although some specify incorrectly that February 29, 1900 existed, and thus set January 1, 1900 to 1.0. Use Native Type VT_EMPTY No conversion will be done. The data type will be that defined in WMI. SInt8 VT_I1 A 1-byte character value. Char16, SInt16 VT_I2 A 2-byte integer value. SInt32 VT_I4 A 4-byte integer value. REAL32 VT_R4 An IEEE 4-byte real value. REAL64, SInt64, Uint64 VT_R8 An 8-byte IEEE real value. UInt16 VT_UI2 An unsigned 2-byte integer value BUA000118R4101

415 Section 8 Creating Custom IT Devices and IT Assets Configuring an IT Device Configuration WMI Property Type Uint32 VT_UI4 An unsigned 4-byte integer value. Object Table 184. WMI CIM Data Type to IT Item Type Conversion (Continued) IT Device Item Data Type Not supported. Description Update Rate: The default update rate for the Item. Items report values only when they change. The Update Rate defines the fastest rate that values can be returned from the PC, Network and Software Monitoring Server. The default Update Rate is 10,000 milliseconds (10 seconds). If the Item requires a more frequent update, set it to a smaller value, but keep in mind that it will have a performance effect on the system. In general, set the Update Rate to as high a number as acceptable, to minimize system load. The actual update rate may be longer than the specified update rate on heavily loaded systems. Item ID: The OPC Item ID for this Item. The Item ID can either use the wmi: namespace or the script: namespace. Refer to PC, Network and Software Monitoring OPC Item Syntax on page 403 for more information. KeepAlive: Checking this check box ensures that the subscription to the item is always active for this item, even when there is no IT Faceplate or IT Control Connection active. If the check box is unchecked, the item is unsubscribed when the IT Faceplate or IT Control Connection is removed. 3BUA000118R

416 Configuring an IT Device Configuration AspectSection 8 Creating Custom IT Devices and IT Assets Figure 130 shows the resulting set of properties corresponding to the Disk Drive Status IT Device shown in Figure 129. The figure shows how the property name is prefixed by the aspect name. Figure 130. Property View TC05127B Asset Optimization Settings The Asset Optimization Asset Monitoring settings can be configured without the Asset Optimization Asset Monitoring software being installed. However, they will have no effect on the system until the Asset Optimization Asset Monitoring software is installed BUA000118R4101

417 Section 8 Creating Custom IT Devices and IT Assets Configuring an IT Device Configuration If the IT Device will generate alarms, it is necessary to configure the default Asset Optimization settings. Checking the Display Asset Optimization View check box produces the view shown in Figure 131. Figure 131. Asset Optimization View Configuration TC05128B The buttons on this screen allow for the addition and removal of subconditions to any of the alarm properties defined on the Token View. The fields in this screen are used to define these subconditions. 3BUA000118R