PowerLogic Active Pager Module Version 6.1

Transcription

1 Version 6.1 Instruction Bulletin 3080IB0801 February 2009

2 Table of Contents 02/2009 Table of Contents Table of Contents... ii CHAPTER 1 INTRODUCTION... 1 PowerLogic Active Pager Module... 1 About this Instruction Bulletin... 1 Assumptions and Guidelines... 2 Who to Go to Answer Technical Questions... 2 CHAPTER 2 SAFETY PRECAUTION... 3 CHAPTER 3 INSTALLATION... 4 Prerequisites for Installing APM... 4 Table 1, Prerequisites for Installing APM... 4 Installing the Product... 4 CHAPTER 4 SETUP... 5 Overview of Setup... 5 Opening the APM Web Page... 5 Navigating to Setup... 6 OPC Server... 8 Remote Connection to OPC Using DCOM Filter Relay Templates Relay & Recipient Schedule Maintenance Subscription System Preference Maintenance Mode Setup on PowerLogic CHAPTER 5 DIAGNOSTICS...32 Overview of Diagnostics Navigating to Diagnostics Real Time Monitoring of Diagnostic Alarms and Events Historical Viewing of Diagnostic Information Diagnostic Options CHAPTER 6 MONITORING...37 Overview of Monitoring Navigating to Monitoring Real Time Monitoring of Alarms and Events Historical Viewing of Diagnostic Alarms and Events Monitoring Options CHAPTER 7 CONTROL...42 Overview of Control Navigating to Maintenance Mode Status Changing Status of Maintenance Mode Changing Status of Maintenance Mode Maintenance Mode Active X Control APPENDIX A ISSUES & TROUBLESHOOTING...46 APPENDIX B REMOTE CONNECTION TO OPC AE SERVER USING DCOM...49 Remote OPC AE Server Settings APM Machine Settings Troubleshooting APPENDIX C RELAY ATTRIBUTE DEFINITIONS...58 Table 2, Acronyms and Definitions ii 2008 Schneider Electric. All Rights Reserved.

3 Table 3, Relay Attributes for Dial-up TAP Table 4, Relay Attributes for Table 5, Relay Attributes for GsmOut Table 6, Relay Attributes for Smpp Table 7, Relay Attributes for Snpp APPENDIX D SMS OPC Server...63 Overview Prerequisites for Installing SMS OPC Alarm and Event Server Table 8, Prerequisites for Installing the SMS OPC Alarm and Event Server SMS Priority Conversion APPENDIX E PLSCADA OPC Server...64 Overview Prerequisites for Installing PowerLogic SCADA OPC Alarm and Event Server Table 9, Prerequisites for Installing the PowerLogic SCADA OPC Alarm and Event Server Installation Citect Configuration Event Tree Citect / PowerLogic SCADA Event Priorities APPENDIX F Database Maintenance Utility...66 Overview Maintenance Scripts Schedule APPENDIX G Migration of data from APM 6.0 to APM APPENDIX H Migration of data from APM to APM Purpose Prerequisites Installation Setup Prior To Running the Utility Running the Migration Utility Migration Rollback APPENDIX I CD CONTENTS...70

4

5 02/2009 CHAPTER 1 INTRODUCTION CHAPTER 1 INTRODUCTION PowerLogic Active Pager Module PowerLogic Active Pager Module (APM) sends s, text messages or paging messages to plant, facility, or campus personnel on alarms and events captured by PowerLogic monitoring system(s) or third party monitoring systems, notifying them of power or energy anomalies that may occur within their systems. For more information on PowerLogic monitoring system, including monitors, meters, specialized data network equipment, and system monitoring / reporting software, refer to the web site PowerLogic APM has an OPC alarm and event client that receives alarms and events from OPC alarm and event servers. Upon receipt, APM s and pages alarms and events to designated recipients, such as plant engineers and facility administrators. PowerLogic APM relies on OPC alarm and event servers to transmit alarms and events to the APM s OPC alarm and event client. OPC Alarm and Event servers, for the following PowerLogic products are included with this installation: SMS version 4.02 or greater PowerLogic SCADA PowerLogic SER 7.x is likewise equipped with an OPC Alarm and Event server and can provide alarms to PowerLogic APM. About this Instruction Bulletin This instruction bulletin focuses on the APM application software components. It covers... Installation o APM (OPC Alarm & Event Client) o OPC Alarm & Event Server Add-on to PowerLogic Monitoring System(s) Setup o OPC Alarm & Event Server Connections to Client o Definition of Alarm and Event Filters o Definition of Relay Templates o Recipients and Relays (or Notification Channels) o Schedules o System Preferences Diagnostics o Live Viewing of APM Application Alarms and Events o Historical Viewing of APM Application Alarms and Events o Diagnostic Options to Display or to Hide Data Columns for Either Live or Historical Viewing 2008 Schneider Electric. All Rights Reserved. 1

6 CHAPTER 1 INTRODUCTION 02/2009 Monitoring o Live Viewing of OPC Server Alarms and Events o Historical Viewing of OPC Server Alarms and Events o Monitoring Options to Display or to Hide Data Columns for Either Live or Historical Viewing Assumptions and Guidelines The following assumptions and guidelines are presumed... Readers of this document are familiar with Microsoft Windows and how to use Microsoft Windows controls, such as text edit boxes, buttons, pulldown menus, etc. Readers of this document have some degree of familiarity with telecommunications and telecommunication devices and how to setup such devices and systems. Readers of this document are familiar with PowerLogic system, including o PowerLogic monitors and meters identified in this document o PowerLogic Software Manager System (SMS) o PowerLogic data network equipment o Modicon Momentum Programmable Logic Controller (PLC) Readers of this document have working knowledge about their facilities electrical and operational systems, including severity levels of alarms and events There is no guarantee that the PowerLogic APM OPC Alarm and Event Client will communicate with every 3 rd party OPC Alarm and Event Server that is or has been available on the market. Who to Go to Answer Technical Questions To answer technical questions about APM, call PowerLogic technical support at Schneider Electric. All Rights Reserved.

7 02/2009 CHAPTER 2 SAFETY PRECAUTION CHAPTER 2 SAFETY PRECAUTION DANGER HAZARD OF ELECTRIC SHOCK, EXPLOSION, OR ARC FLASH NGER Apply appropriate personal protective equipment (PPE) and follow safe electrical work practices. See NFPA 70E. This equipment must only be installed and serviced by qualified electrical personnel. Turn off all power supplying this equipment before working on or inside equipment. Always use a properly rated voltage sensing device to confirm power is off. Replace all devices, doors and covers before turning on power to this equipment. Failure to follow these instructions will result in death or serious injury Schneider Electric. All Rights Reserved. 3

8 CHAPTER 3 INSTALLATION 02/2009 CHAPTER 3 INSTALLATION The APM compact disc (CD) allows for the installation of the APM application and the SMS OPC Alarm and Event Server. The OPC Alarm and Event Server for other PowerLogic software that are provided are automatically installed if that software is detected on the machine. Important! There is no guarantee that the PowerLogic APM OPC Alarm and Event Client will successfully communicate with every 3 rd party OPC Alarm and Event Server. Prerequisites for Installing APM The following table defines the prerequisites for installing APM. Table 1, Prerequisites for Installing APM Applications or Components to Install Versions Microsoft (MS) Windows Windows 2000 Server, Service Pack 4 Windows 2003 Server, Service Pack 1 Windows XP Professional, Service Pack 2 Windows Vista Windows Server 2008 Installing the Product Insert CD into PC drive, and follow instructions as they appear on your computer screen. Note! Administrator rights are mandatory to install APM Schneider Electric. All Rights Reserved.

9 02/2009 CHAPTER 4 SETUP CHAPTER 4 SETUP Overview of Setup This chapter describes how to set up PowerLogic APM (APM) to receive alarms and events and to transmit them to recipients via , pagers, etc. The setup of an APM application involves the following series of steps Add users to APM roles Setup OPC alarm and event server connections Setup filtering of the receipt of alarms and events from various OPC alarm and event servers Optionally, create templates to define message transmission characteristics for relays, such as servers or pagers Identify recipients and define relay attributes, optionally using relay templates Create the schedule for each recipient, defining when alarms may be sent Optionally, create maintenance mode groups Subscribe recipients to receive alarms and (optionally) maintenance mode notifications. Opening the APM Web Page Note! Skip this subsection if APM web page is already opened. If APM web page is not open, then click on the following to activate web page Start > All Programs > PowerLogic esolutions > APM > APM Web Upon opening APM web page, the main or home page appears, as illustrated by following example 2008 Schneider Electric. All Rights Reserved. 5

10 CHAPTER 4 SETUP 02/2009 Figure 1, Example of Main or Home Page Navigating to Setup From the home page, the user can click on the Setup button. Upon activation, the setup page appears, as illustrated by the following example Schneider Electric. All Rights Reserved.

11 02/2009 CHAPTER 4 SETUP Figure 2, Example of Setup Page On the left-hand side of the setup page, the following options are available... Clicking on the icon expands to allow access to link(s) The following sub-sections discuss each option and how it can be used to configure APM Schneider Electric. All Rights Reserved. 7

12 CHAPTER 4 SETUP 02/2009 OPC Server The OPC Server page sets up communication between the APM component and the various OPC Alarm and Event Servers accessible on the data network. Upon clicking the icon, adjacent to the OPC Server label, on the setup page, the Edit option appears, as illustrated below, and the icon, adjacent, to the OPC Server label changes to. Figure 3, Example of Setup Menu, OPC Server Selected and Expanded Click the Edit link to configure OPC servers. Clicking on the link opens the OPC Server Configuration page, similar to the following illustrated example. If there are OPC servers available on the local host, then they will be displayed in the Available Servers list Schneider Electric. All Rights Reserved.

13 02/2009 CHAPTER 4 SETUP Figure 4, Example of OPC Server Configuration Page Auto-detect OPC Alarm and Event Servers To auto-detect OPC alarm and event servers in a server machine and list them in the Available Servers list box, move the cursor to the Available OPC Servers group box and Key in the machine name in the Machine text edit box (See figure below) Figure 5, Example of Controls to Auto-detect OPC Servers for a Specified Server Machine 2008 Schneider Electric. All Rights Reserved. 9

14 CHAPTER 4 SETUP 02/2009 Click the Auto-detect OPC Servers button. If OPC alarm and event servers are registered on the specified machine, then the server names will appear in the Available OPC Servers list box (See figure below) Figure 6, Example of Available Servers / Selected Servers Click the > button to move a single server from Available Servers list to Selected Servers list or click the >> button to move all servers from Available Servers list to Selected Servers list (Figure below) Click the Apply Changes button to register the OPC alarm and event server(s) listed in the list of Selected Servers (See figure below) Figure 7, Example of Available Servers / Selected Servers Control Manual Entry and Assignment of OPC Alarm and Event Server Schneider Electric. All Rights Reserved.

15 02/2009 CHAPTER 4 SETUP To manually register an OPC alarm and event server, do the following Move the cursor to Manual Entry group box and enter the host name or IP address in the Machine text edit box (Figure below) Enter the OPC alarm and event server name in the OPC Server text edit box (Optional) Click on the Verify button to verify availability of OPC alarm and event server on the data network. If the OPC alarm and event server is available, then a dialog box will confirm connection. Figure 8, Example of Manual Entry Control Click the Add button to insert OPC alarm and event server into the list of Selected Servers (Figure on next page) Figure 9, Example of Available Servers / Selected Servers Controls Click the Apply Changes button to apply or register the OPC alarm and event server listed in the list of Selected Servers (See figure below) 2008 Schneider Electric. All Rights Reserved. 11

16 CHAPTER 4 SETUP 02/2009 Figure 10, Example of Available Servers / Selected Servers Control with a Selected Server Important! If the settings on a selected OPC server change, they will not be reflected in APM until the user re-imports the OPC server by clicking on the Apply Changes button. For example, if an alarm in SMS is disabled, and the SMS OPC Server is selected as one of the servers to page on, once the alarm is enabled, it will not be visible to APM until the user clicks the Apply Changes button. Remote Connection to OPC Using DCOM Filter See Appendix C. The Filter Configuration page allows for the creation of an alarm and event filter that defines groups of alarms for relay. To navigate to the configuration page, click the Edit link under the Filter menu. (See figure below) There is a default filter, ALL, assigned to each OPC alarm and event server that includes all alarms. (See figure below) Schneider Electric. All Rights Reserved.

17 02/2009 CHAPTER 4 SETUP Figure 11, Example of Setup Menu, Filter Selected and Expanded Figure 12, Example of Filter Configuration Page 2008 Schneider Electric. All Rights Reserved. 13

18 CHAPTER 4 SETUP 02/2009 Adding an Alarm and Event Filter To add a filter, click the Add New Filter button. In the Filter Configuration group box, do the following Select server in the Servers list box (Select first figure on next page) Enter the name of the filter in the Name text edit box (See figures on next page) Enter the severity range of alarms and events to be received Important! If the reader is unfamiliar with the alarm severity level, please contact the system administrator. (Optional) Enter an integer value in the Delay in Seconds text edit box. (See figures on next pages) This option prevents a flood of notifications in an avalanche alarm scenario. Upon receipt of alarms matching the filter with the specified delay, the following will happen o A notification is sent, indicating alarm compression has begun, and identifying which alarm triggered the compression. If text is entered into the Delay Start Message text edit box, it will be o included in the notification. At the end of the delay, another notification is sent, summarizing the alarms APM received Select the nodes from the area tree for inclusion in the filter (Checking alarms defines what gets paged on) (See figures on next pages) Click the Save Filter button to save filter, and respond to notification dialog (See figures on next pages) Important! When the user clicks the Add New Filter button, a new filter is created and saved with the name New Filter. Selecting/Deselecting nodes from the area tree automatically adds or removes nodes from the filter. However, changes to the other filter attributes such as filter name or severity are not made until the Save Filter button is clicked Schneider Electric. All Rights Reserved.

19 02/2009 CHAPTER 4 SETUP Figure 13, Example of Filter Configuration Page with Newly Added Filter with Web Controls Unmodified 2008 Schneider Electric. All Rights Reserved. 15

20 CHAPTER 4 SETUP 02/2009 Figure 14, Example of Filter Configuration Page with Newly Added Filter with Web Controls Modified Removing an Alarm and Event Filter To remove an alarm and event filter, Select server in the Servers selection box Select filter in the Filters selection box Click on Remove Filter button and respond to notification dialog Schneider Electric. All Rights Reserved.

21 02/2009 CHAPTER 4 SETUP Relay Templates The Relay Templates Configuration page permits creation of templates that define the data network parameters for messages sent from APM to a recipient. Upon clicking the icon, adjacent to the Relay Templates label, on the setup page, the Edit option appears, as illustrated below, and the icon, adjacent, to the Relay Templates label changes to. Figure 15, Example Setup Menu, Relay Templates Selected Click the Edit link to add, edit, or remove a relay template. Clicking on the link opens the Relay Templates Configuration page, similar to the diagram below Schneider Electric. All Rights Reserved. 17

22 CHAPTER 4 SETUP 02/2009 Figure 16, Example of Relay Templates Configuration Page Adding Relay Template and Creating the Template Name To add a relay template and create the template name, do the following Select one of the following relay types via the Relay selection box o ( ) o Dialup-TAP o GSM Out (Global Systems for Mobile Communications) o SMPP (Short Message Peer-to-Peer Protocol) o SNPP (Simple Network Paging Protocol) Click Add button. A dialog box prompts for entry of text. Enter text into text box and click the OK button (See figure on next page) Editing Relay Template Name To edit a relay template name, move cursor to Template group box and do the following Schneider Electric. All Rights Reserved.

23 02/2009 CHAPTER 4 SETUP Click Edit button. A dialog box prompts for entry of text. Enter text into text box and click the OK button (See Figure on next page) Deleting Relay Template To delete a relay template, move cursor to Template group box and do the following Click Delete button. Reply to notification dialog (See following illustration) Figure 17, Example of Relay Templates Configuration Page, Template Group Box Modifying Attributes in a Relay Template To modify attributes in a relay template, do the following Select one of the following relay types via the Relay selection box in the Template group box o ( ) o Dialup-TAP o GSM Out (Global Systems for Mobile Communications) o SMPP (Short Message Peer-to-Peer Protocol) o SNPP (Simple Network Paging Protocol) Select a template from the Template selection box (Refer to previous illustration) Click on the data field of the appropriate attribute, found in the list of attributes of the Configuration group box. Respond to dialog box, such as entering text in a text box or selecting an option in a selection box (See figure below) Figure 18, Example of Relay Templates Configuration Page, List of Attributes Attributes Attribute Data Fields 2008 Schneider Electric. All Rights Reserved. 19

24 CHAPTER 4 SETUP 02/2009 Relay Attributes See Appendix D. Relay & Recipient The Relay and Recipient Configuration page Enables identification of new recipients (communicational devices) Configures the communicational relay between the APM and the recipients, using relay templates to establish initial values in the various attribute data fields Upon clicking the icon, adjacent to the Relay Templates label, on the setup page, the Edit option appears, as illustrated below, and the icon, adjacent, to the Relay Templates label changes to. Figure 19, Example Setup Menu, Relay & Recipient Selected Click the Edit link to add, edit, or remove a relay template. Clicking on the link opens the Relay and Recipient Configuration page, similar to the following illustrated example Schneider Electric. All Rights Reserved.

25 02/2009 CHAPTER 4 SETUP Figure 20, Example of Relay and Recipient Configuration Page Adding a Recipient To add a recipient, move cursor to Recipient group box and do the following Click the Add button. Enter the Recipient's name, description and then click the Apply button to save the new recipient. (See figure on next page) Editing a Recipient (or Recipient s Name) To edit a recipient (or changing recipient s name), move cursor to Recipient group box and do the following Click Edit button. A dialog box prompts for entry of text. Enter text into text box and click the OK button (See figure on next page) Deleting a Recipient To delete a recipient, move cursor to Recipient group box and do the following Click Delete button. Reply to notification dialog (See figure on next page) 2008 Schneider Electric. All Rights Reserved. 21

26 CHAPTER 4 SETUP 02/2009 Figure 21, Example of Relay Templates Configuration Page, Template Group Box Modifying Communicational Attributes for a Recipient via Template To modify communicational attributes of a recipient, do the following Select a recipient from the Name selection box in the Recipient group box (Refer to previous illustration) Select one of the following relay types via the Relay Name selection box in the Configuration group box o ( ) o Dialup-TAP o GsmOut (Global Systems for Mobile Communications) o Smpp (Short Message Peer-to-Peer Protocol) o Snpp (Simple Network Paging Protocol) Select a template from the Relay Template selection box (Refer to following illustration) (Optional) Click on any of the attribute fields and custom modify any of the values (See figure below) Figure 22, Example of Relay and Recipient Configuration Page, List of Attributes Attributes Attribute Data Fields Relay Attributes See Appendix D Schneider Electric. All Rights Reserved.

27 02/2009 CHAPTER 4 SETUP Schedule The Schedule page defines the times during a seven-day week period when recipients can receive messages from APM. Upon clicking the icon, adjacent to the Schedule label, on the setup page, the Edit option appears, as illustrated below, and the icon, adjacent, to the Schedule label changes to. Figure 23, Example Setup Menu, Schedule Selected Upon clicking Edit under Schedule, the Schedules web page appears. The following figure illustrates the Schedules web page. Select the recipient in the Recipients list box and click the add button to add a schedule. Click the appropriate check boxes for the days of the week that applied to the start and end times that are to the right. Multiple schedule boxes may be added for the recipient to reflect different time schedules and when they apply on what days of the week. Combining different time schedules for a single recipient allows for greater flexibility in defining the overall paging schedule for the recipient Schneider Electric. All Rights Reserved. 23

28 CHAPTER 4 SETUP 02/2009 Figure 24, Example of a Schedules Page Maintenance The Maintenance page allows users to define maintenance mode groups for the configured OPC servers. Once a node or a group of nodes is placed in maintenance mode, no more alarms from these nodes are paged upon. Upon enabling a maintenance mode group, the pager sends a message notifying interested recipients about the status change. The message includes comments from the user who changed the status of the group. Figure 25, Example Setup Menu, Maintenance Selected Schneider Electric. All Rights Reserved.

29 02/2009 CHAPTER 4 SETUP Upon clicking the icon, adjacent to the Maintenance label, on the setup page, the Edit option appears, as illustrated below, and the icon, adjacent, to the Maintenance label changes to. Click the Edit link to add, edit, or remove a Maintenance group. Clicking on the link opens the Maintenance Group Configuration page, similar to Fig 26. Figure 26, Example of Maintenance Page Adding Maintenance mode group To add a filter, click the Add New Group button. In the Available Nodes group box, do the following Select server in the Servers list box (Select first figure on next page) Select the nodes from the area tree for inclusion in the group Click the Save Configuration button to save filter, and respond to notification dialog (See figures on next pages) Important! When the user clicks the Add New Group button, a new group is created and saved with the name New Group. Changes to the group are not saved until the Save Configuration button is clicked Schneider Electric. All Rights Reserved. 25

30 CHAPTER 4 SETUP 02/2009 Subscription The Subscription section assigns recipients to messaging services provided by the APM. Upon clicking the icon, adjacent to the Subscription label, on the setup page, the AE Subscription and MM Subscription options appears, as illustrated below, and the icon, adjacent, to the Subscriptions label changes to. Figure 27, Example Setup Menu, Subscription Selected Click the AE Subscription link to add, edit, or remove an Alarm & Event subscription. Figure 28, Example of Alarm and Event Subscription Page Schneider Electric. All Rights Reserved.

31 02/2009 CHAPTER 4 SETUP Subscribing a New Recipient To subscribe a recipient to a relay, do the following Click the Add button. (New row with blank data fields should appear in data grid.) Click button adjacent to newly added row. A dialog box should appear (See Fig x). Select options presented from the following controls and click OK button o Recipient Name o OPC Server o Relay Name o (Alarm and Event) Filter Name o Get Server Pings (Heartbeat Alarm) Note Get Server Pings is a heartbeat alarm, transmitted during a period of alarm inactivity of one hour or greater. Figure 29, Example of Subscription Dialog Editing a Subscription in Data Grid To edit a subscription (data row) in data grid, do the following Click button adjacent to desired row and edit data fields. A dialog box should appear. Select options presented from the following controls and click OK button o Recipient Name o OPC Server o Relay Name o (Alarm and Event) Filter Name Deleting Subscription in Data Grid To delete subscription of a recipient (data row) from data grid, do the following Click button adjacent to desired row Schneider Electric. All Rights Reserved. 27

32 CHAPTER 4 SETUP 02/2009 Click the MM Subscription link to add, edit, or remove a Maintenance Mode group notification subscription. Figure 30, Example of Maintenance Mode Subscription Page Subscribing a Recipient to Maintenance Mode Group. Click the Add button. (New row with blank data fields should appear in data grid.) Click button adjacent to newly added row. A dialog box should appear (See Fig x). Select options presented from the following controls and click OK button o Recipient Name o OPC Server o Relay Name o (Alarm and Event) Filter Name o Get Server Pings (Heartbeat Alarm) Schneider Electric. All Rights Reserved.

33 02/2009 CHAPTER 4 SETUP Figure 31, Example of Subscription Dialog System Preference Editing a Subscription in Data Grid To edit a subscription (data row) in data grid, do the following Click button adjacent to desired row and edit data fields. A dialog box should appear. Select options presented from the following controls and click OK button o Recipient Name o OPC Server o Maintenance Mode Group o Relay Name Deleting Subscription in Data Grid To delete subscription of a recipient (data row) from data grid, do the following Click button adjacent to desired row. The System page allows for administrative changes to APM. Upon clicking the icon, adjacent to the Schedule label, on the setup page, the Preference option appears, as illustrated below, and the icon, adjacent, to the System label changes to. Figure 32, Example Setup Menu, System Preference Selected 2008 Schneider Electric. All Rights Reserved. 29

34 CHAPTER 4 SETUP 02/2009 Upon clicking Preferences under System, the Preference page appears, as illustrated in the following. Figure 33, Example of a System Preference Page Service Object Controls The Preference Page provides service object controls to start, to stop, and to restart OPC Logger service of APM, and to start, to stop, and to restart APM Service Status. The following figure illustrates the control buttons. Figure 34, Example of Preference Page Control Buttons Start Service Object Controls Stop Service object controls Restart Service object controls Important! If you make any changes to the DANSrvAE.exe.config the change won t come into effect until you click the Reset All button Schneider Electric. All Rights Reserved.

35 02/2009 CHAPTER 4 SETUP Maintenance Mode Setup on PowerLogic See Appendix E Schneider Electric. All Rights Reserved. 31

36 CHAPTER 5 DIAGNOSTICS 02/2009 CHAPTER 5 DIAGNOSTICS Overview of Diagnostics The diagnostics page provides real time and historical viewing of activity relating to the Active Pager Module (APM). It does not provide information on events transmitted from OPC alarm and event servers. Navigating to Diagnostics Click on the Diagnostics button, located on the gray bar of control buttons, below the blue product banner. Afterwards, click on one of the following links Live viewing of current diagnostic information as it happens page refreshed every 5 seconds Historical viewing of historical diagnostic information with filtering and sorting Options display or hide information attributes Real Time Monitoring of Diagnostic Alarms and Events Upon clicking on the Live link, associated with the Diagnostics button, the live diagnostics page appears, as illustrated by the following example Figure 35, Example of Live Diagnostics Page Schneider Electric. All Rights Reserved.

37 02/2009 CHAPTER 5 DIAGNOSTICS Historical Viewing of Diagnostic Information Upon clicking the Historical link, associated with the Diagnostics button, the historical diagnostics page appears, as illustrated by the following example Figure 36, Example of Historical Diagnostics Page Date Time Filter Use the date / time filter control to define the time span of alarms and events to display. (Refer to the following illustration.) Figure 37, Date Time Filter 2008 Schneider Electric. All Rights Reserved. 33

38 CHAPTER 5 DIAGNOSTICS 02/2009 Auto Filter Click on the Auto Filter radio button to auto-filter data columns. Click on select topic(s) to be filtered. (Refer to the following illustration.) to Figure 38, Auto Filter Schneider Electric. All Rights Reserved.

39 02/2009 CHAPTER 5 DIAGNOSTICS Advanced Filter Click on the Advanced Filter radio button to perform advanced filtering of data columns. Click on ( filter mode symbol) to select type of filtering, and double click area adjacent to filter mode symbol to invoke display of text edit box, and enter target on which to filter on. (Refer to the following illustration.) Figure 39, Advanced Filter 2008 Schneider Electric. All Rights Reserved. 35

40 CHAPTER 5 DIAGNOSTICS 02/2009 Export of Historical Data to Microsoft Excel File Click on Excel link to export historical data Microsoft Excel File. (Refer to the following illustration.) Figure 40, Excel Export Diagnostic Options Upon clicking on the Options link, associated with the Diagnostics button, the diagnostic options page appears, as illustrated by the following example Figure 41, Example of Diagnostics Options Page The options page allows for the selection of data columns to be displayed on the live and historical pages. The page provides for a series of checkboxes to display or to hide data columns. The page also allows for the definition of rows per page Schneider Electric. All Rights Reserved.

41 02/2009 CHAPTER 6 MONITORING CHAPTER 6 MONITORING Overview of Monitoring The monitoring page provides live and historical viewing of alarms and events received from the OPC alarm and event servers. Navigating to Monitoring From the currently displayed APM page, the user can click on the Monitoring button, located on the gray bar of control buttons, below the blue product banner, and then click on one of the following links Live (Viewing of Alarms and Events) Historical (Viewing of Alarms and Events) Options (Display or Hide Alarm and Event Attributes) Real Time Monitoring of Alarms and Events Upon clicking on the Live link, associated with the Monitoring button, the live events page appears, as illustrated by the following example Figure 42, Example of Live Events Page Click on (located in the columnar headers) to auto-filter on target Schneider Electric. All Rights Reserved. 37

42 CHAPTER 6 MONITORING 02/2009 Historical Viewing of Diagnostic Alarms and Events Upon clicking on the Historical link, associated with the Monitoring button, the historical events page appears, as illustrated by the following example Figure 43, Example of Historical Events Page Date Time Filter Use the date / time filter control to define the time span of alarms and events to display. (Refer to the following illustration.) Figure 44, Date Time Filter Schneider Electric. All Rights Reserved.

43 02/2009 CHAPTER 6 MONITORING Auto Filter Click on the Auto Filter radio button to auto-filter data columns. Click on select topic(s) to be filtered. (Refer to the following illustration.) to Figure 45, Auto Filter 2008 Schneider Electric. All Rights Reserved. 39

44 CHAPTER 6 MONITORING 02/2009 Advanced Filter Click on the Advanced Filter radio button to perform advanced filtering of data columns. Click on ( filter mode symbol) to select type of filtering, and double click area adjacent to filter mode symbol to invoke display of text edit box, and enter target on which to filter on. (Refer to the following illustration.) Figure 46, Advanced Filter Schneider Electric. All Rights Reserved.

45 02/2009 CHAPTER 6 MONITORING Export of Historical Data to Microsoft Excel File Click on Excel link to export historical data Microsoft Excel File. (Refer to the following illustration.) Figure 47, Excel Export Monitoring Options Upon clicking on the Options link, associated with the Monitoring button, the diagnostic options page appears, as illustrated by the following example Figure 48, Example of Monitoring Options Page The options page allows for the selection of what data columns are displayed on the live and historical pages. The page provides for a series of checkboxes to display or to hide data columns. The page also allows for the definition of rows per page Schneider Electric. All Rights Reserved. 41

46 CHAPTER 7 CONTROL 02/2009 CHAPTER 7 CONTROL Overview of Control The control page provides a way to change the status of Maintenance Mode Groups. Upon enabling a maintenance mode group, all alarms originating from nodes in the group will not be paged upon. Navigating to Maintenance Mode Status From the currently displayed APM page, the user can click on the Control button, located on the gray bar of control buttons, below the product banner, and then click on Maintenance Mode Status link. Upon clicking on the Maintenance Mode Status link, associated with the Control button, the Maintenance Mode Control page appears, as illustrated by the following example Figure 49, Example of Maintenance Mode Control Schneider Electric. All Rights Reserved.

47 02/2009 CHAPTER 7 CONTROL Changing Status of Maintenance Mode To Change the status of a maintenance mode group, Click on the checkbox associated with the maintenance mode group. The user is prompted with a textbox in which the user must enter a reason for the status change. This text is transmitted to the recipients subscribed to the maintenance mode notifications. After entering the reason for status change, clicking Continue will change the status of the group. The user must be a member of either APMAdmin or APMUser to access the maintenance mode status change. Figure 50, Example of Maintenance Mode Control Maintenance Mode Active X Control The Active X control allows integration with graphical interfaces supporting the active x interface. These include such packages as GFX and Citect, as well as third party packages. In order to set up the properties of the control, the Active Pager Module service on the target server must be running Schneider Electric. All Rights Reserved. 43

48 CHAPTER 7 CONTROL 02/2009 The active x control name is PowerLogic.MaintenanceMode. Insert the control as you would any other in the package you are using. You may then configure the control using the properties page. Select the MaintGroup tab as show below in a sample from a PowerScada graphics page.. The control IP should be set to for the local server. Then select the target Maintenance group from the list and click Apply. Figure 51 Once a group is selected the control will reflect the current status of the maintenance group as show in the following two graphics. When maintenance mode is turned on for a group the control will turn red, when turned off the control will turn green. When the page is run you may control the status of the group by clicking the button on the control Schneider Electric. All Rights Reserved.

49 02/2009 CHAPTER 7 CONTROL Figure 52 Figure Schneider Electric. All Rights Reserved. 45

50 APPENDIX A ISSUES & TROUBLESHOOTING 02/2009 APPENDIX A ISSUES & TROUBLESHOOTING If symptoms exists and do not match with the ones listed below or if the attempt to implement prescribed solution does not resolve the issue, then please contact Tech Support at After installing Active Pager Module (APM), the APM service and the OPCAELogger Service will be started automatically only after a restart of the machine which will be prompted after the install. If a new Windows user profile is created after installing APM, then logging into the machine as the new user will cause the APM install to restart. To workaround this issue, create additional local Windows user profiles before installing APM. The user might see the statement, "The page cannot be displayed, when accessing the APM website. This is caused when another install overwrites the IIS setting of HTTP Keep-Alives Enabled and sets it to false. For APM to properly function, this must be set to true. This is required for integrated Windows authentication which the APM website uses. The illustration, below, shows the proper setting to resolve this issue. Figure 54, Default Web Site Properties Schneider Electric. All Rights Reserved.

51 02/2009 APPENDIX A ISSUES & TROUBLESHOOTING After navigating to the Subscriptions page, occasionally, the user will be taken to a blank screen. This is a known issue in a third party control. To workaround this problem, click on the AE Subscription link again, located under Subscription, in the Setup controls on the left side of the Setup web page. The figure, below, illustrates the link. Figure 55, Subscription Link SMS device events do not show up in filtering: This is a known issue with SMS. The work around to this is to o Open SMS Setup->Setup->Devices/Routing o Click on the device planned for use in APM o Click the configure button o Repeat the last two previous steps for each device planned for use in APM o When completed, restart the APM services. If installing with SER 7.1, prior to installing APM 6.0, the user must install the latest service update, minimum version SER Service Update If the user has a previously installed update for SER 7.1, the SER Service Update will not install until the previous update is uninstalled using the Control Panel, Add Remove programs. Once the previous update has been removed, the SER update should install normally. When installed with SER 7.1, the error Permission Denied may appear when moving events. Simply ignore this error as it does not cause any problems. Any value entered for an attribute in the Relay Templates and Relay Recipients grids must not exceed a 500 character limit this includes spaces. In order to show up in all of the drop-down boxes in the APM web site, the filter name must not exceed 40 characters this include spaces. During migration, 5 characters are appended to the name of the filter being migrated from APM 5.n. This means that if the filter name in APM 5.n is longer than 35 characters, then the whole filter name may not show up in the drop-down boxes in APM 6.0. The minimum recommended screen size for APM is 1024 by 768. If the user interface looks skewed, please try changing the screen size. Otherwise, try to maximize the browser window and refresh the page. If changes made in configuration are not reflected in the actual functionality, then make sure to restart the ActivePagerModule and PLOpcAELogger services either from the System -> Preferences page, or from the Windows Service Controller Schneider Electric. All Rights Reserved. 47

52

53 02/2009 APPENDIX B REMOTE CONNECTION TO OPC AE SERVER USING DCOM APPENDIX B REMOTE CONNECTION TO OPC AE SERVER USING DCOM The OPC AE server uses COM/DCOM to communicate with APM. When the OPC AE server and APM are installed on the same machine, no additional configuration is required. However, when the OPC AE server and APM are on separate machines, DCOM and IIS need to be configured. Remote OPC AE Server Settings Note This procedure is specific to Windows Server However, the general principle of this procedure can be applied to other Windows operating systems. To setup a remote machine with an OPC AE Server, using DCOM, do the following 1. Click on Start > Settings > Control Panel > Administrative Tools > Computer Management > Local Users and Groups a. In Users, create a user called DCOMUser b. In Groups, add DCOMUser to the Administrative group c. In Groups, create a group called OPCDCOM d. Add the following to OCPDCOM group i. DCOMUser ii. Administrator iii. ASPNET iv. INTERACTIVE v. NETWORK SERVICES vi. SYSTEM 2. Run DCOM configuration utility by clicking Start > Run > DComCnfg.exe. 3. In the Component Services window, expand the Component Services node, Computers node, and My Computer node in the tree, located to the left of the window. Refer to the following figure Schneider Electric. All Rights Reserved. 49

54 APPENDIX B REMOTE CONNECTION TO OPC AE SERVER USING DCOM 02/2009 Figure 56, Component Services Window 4. Right-click on My Computer and select Properties. 5. Select the Default Properties tab, as illustrated in the following figure. Figure 57, My Computer Properties Dialog Box, Default Properties Tab Schneider Electric. All Rights Reserved.

55 02/2009 APPENDIX B REMOTE CONNECTION TO OPC AE SERVER USING DCOM 6. As illustrated in the previous figure, set the options in the Default Properties Tab as follows a. Check box entitled Enable distributed COM on this computer b. Select Connect in the drop down list box, Default Authentication Level c. Select Identify in the drop down list box, Default Impersonation Level 7. Select the COM Security tab, as illustrated in the following figure. Figure 58, My Computer Properties Dialog Box, COM Security Tab 8. As illustrated in the preceding figure, set options in the COM Security tab as follows a. Click Edit Default button under Access Permissions group box and do the following i. Add the group OPCDCOM, created in Step 1, by clicking on the Add button in the Access Permissions dialog box ii. Check the boxes for all permissions for each group and user listed in the Access Permission dialog box iii. Click on the OK button to apply changes b. Click Edit Default button under Launch and Activation Permissions group box and do the following i. Add the group OPCDCOM, created in Step 1, by clicking on the Add button in the Launch Permissions dialog box ii. Check the boxes for all permissions for each group and user listed in the Launch Permissions dialog box iii. Click on the OK button to apply changes c. Click Edit Limits button under Access Permissions group box and do the following i. Check box for Remote Access for each user and group listed in the Access Permission dialog box ii. Click on the OK button to apply changes 2008 Schneider Electric. All Rights Reserved. 51

56 APPENDIX B REMOTE CONNECTION TO OPC AE SERVER USING DCOM 02/2009 d. Click Edit Limits button under Launch and Activation Permissions group box and do the following i. Check boxes for Remote Launch and Remote Activation for each user and group listed in the Launch Permissions dialog box ii. Click on the OK to apply changes 9. Expand My Computer, select and expand on DCOM Config, and do the following a. Select OPCEnum server, a child node of DCOM Config, and right-click. Note this action may induce the addition of several registry keys. Be sure to click OK on the dialog boxes requesting acknowledgement. i. In the Properties dialog box, select the General tab, and select Connect in the Authentication Level drop down list box. ii. In the Properties dialog box, select the Security tab and do the following 1. Click Edit Default button under Access Permissions group box and do the following a. Add the group OPCDCOM, created in Step 1, by clicking on the Add button in the Access Permissions dialog box b. Check the boxes for all permissions for each group and user listed in the Access Permissions dialog box c. Click on the OK button to apply changes 2. Click Edit Default button under Launch and Activation Permissions group box and do the following a. Add the group OPCDCOM, created in Step 1, by clicking on the Add button in the Launch Permissions dialog box b. Check the boxes for all permissions for each group and user listed in the Launch Permissions dialog box c. Click on the OK button to apply changes b. The following OPC servers may need to be configured for DCOM access on the remote machine PowerLogic SMS AE server PLSEROPC AE/DA server Other OPC AE servers Select the appropriate OPC AE server, a child node of DCOM Config, and right-click. Note this action may induce the addition of several registry keys. Be sure to click OK on the dialog boxes requesting acknowledgement. i. In the Properties dialog box, select the General tab, and select Connect in the Authentication Level drop down list box. ii. In the Properties dialog box, select the Security tab and do the following 1. Click Edit Default button under Access Permissions group box and do the following a. Add the group OPCDCOM, created in Step 1, by clicking on the Add button in the Access Permissions dialog box b. Check the boxes for all permissions for each group and user listed in the Access Permissions dialog box c. Click on the OK button to apply changes 2. Click Edit Default button under Launch and Activation Permissions group box and do the following Schneider Electric. All Rights Reserved.

57 02/2009 APPENDIX B REMOTE CONNECTION TO OPC AE SERVER USING DCOM a. Add the group OPCDCOM, created in Step 1, by clicking on the Add button in the Launch Permissions dialog box b. Check the boxes for all permissions for each group and user listed in the Launch Permissions dialog box c. Click on the OK button to apply changes iii. In the Properties dialog box, select the Identity tab, and do the following 3. Select This User and set the starting user to DCOMUser 4. Enter password for DCOMUser. 5. Click on the OK button to apply changes APM Machine Settings To configure the APM machine for DCOM, do the following 1. Click on Start > Settings > Control Panel > Administrative Tools > Computer Management > Local Users and Groups c. In Users, create a user called DCOMUser d. In Groups, add DCOMUser to the Administrative group e. In Groups, create a group called OPCDCOM f. Add the following to OCPDCOM group i. DCOMUser ii. Administrator iii. ASPNET iv. INTERACTIVE v. NETWORK SERVICES vi. SYSTEM 2. Run DCOM configuration utility by clicking Start > Run > DComCnfg.exe. 3. In the Component Services window, expand the Component Services node, Computers node, and My Computer node in the tree, located to the left of the window. Refer to the following figure Schneider Electric. All Rights Reserved. 53

58 APPENDIX B REMOTE CONNECTION TO OPC AE SERVER USING DCOM 02/2009 Figure 279, Component Services Window 4. Right-click on My Computer and select Properties. 5. Select the Default Properties tab, as illustrated in the following figure. Figure 60, My Computer Properties Dialog Box, Default Properties Tab Schneider Electric. All Rights Reserved.

59 02/2009 APPENDIX B REMOTE CONNECTION TO OPC AE SERVER USING DCOM 6. As illustrated in the previous figure, set the options in the Default Properties Tab as follows a. Check box entitled Enable distributed COM on this computer b. Select Connect in the drop down list box, Default Authentication Level c. Select Identify in the drop down list box, Default Impersonation Level 7. Select the COM Security tab, as illustrated in the following figure. Figure 61, My Computer Properties Dialog Box, COM Security Tab 8. As illustrated the in preceding figure, set options in the COM Security tab as follows. a. Click Edit Default button under Access Permissions group box and do the following i. Add the group OPCDCOM, created in Step 1, by clicking on the Add button in the Access Permissions dialog box ii. Check the boxes for all permissions for each group and user listed in the Access Permission dialog box iii. Click on the OK button to apply changes b. Click Edit Default button under Launch and Activation Permissions group box and do the following i. Add the group OPCDCOM, created in Step 1, by clicking on the Add button in the Launch Permissions dialog box ii. Check the boxes for all permissions for each group and user listed in the Launch Permissions dialog box iii. Click on the OK button to apply changes c. Click Edit Limits button under Access Permissions group box and do the following i. Check box for Remote Access for each user and group listed in the Access Permission dialog box ii. Click on the OK button to apply changes 2008 Schneider Electric. All Rights Reserved. 55

60 APPENDIX B REMOTE CONNECTION TO OPC AE SERVER USING DCOM 02/2009 d. Click Edit Limits button under Launch and Activation Permissions group box and do the following i. Check boxes for Remote Launch and Remote Activation for each user and group listed in the Launch Permissions dialog box ii. Click on the OK to apply changes 9. Click on Control Panel > Administrative Tools > Computer Management and do the following a. Expand the Services and Application node, a child node of Computer Management b. Select Services node, a child node of Services and Application c. Under Services list box, right-click on PLActivePagerModule and select Properties and do the following, referring to following figure i. Click on the Log On tab in the Properties dialog ii. Click the radio button, This Account iii. Enter.\DCOMUser in text box adjacent to This Account label iv. Enter password v. Click on Apply button vi. Click on OK button d. Under Services list box, right-click on PLOPCAELogger, select Properties and do the following, referring to following figure i. Click on the Log On tab in the Properties dialog ii. Click the radio button, This Account iii. Enter.\DCOMUser in text box adjacent to This Account label iv. Enter password v. Click on OK button vi. Reboot the machine Figure 62, PLActivePagerModule Properties Dialog Box, Log On Tab Schneider Electric. All Rights Reserved.

61 02/2009 APPENDIX B REMOTE CONNECTION TO OPC AE SERVER USING DCOM Troubleshooting Symptom An access denied error is reported in the event log when the client attempts to establish an IOPCShutdown or IOPCDataCallback connection point callback. Problem The.NET framework uses the default DCOM security settings for the machine, since the client application does not call CoInitializeSecurity(). Resolution It is not possible to call CoInitializeSecurity() in a.net client application. However, DCOM security can be configured in the registry for each client application, by creating the following registry values HKCR\AppID\APMService.exe\AppID = {426AF718-0B46-423B-8DC8-833E7A944F11} HKCR\AppID\{426AF718-0B46-423B-8DC8-833E7A944F11}\AuthenticationLevel = 1, where the GUID should be unique for each OPC client application, and the APMService.exe key should be replaced with the name of the client application. To automatically create these keys, browse to the CD content s Utility folder and import the APM_DCOM.reg file to the registry, by double-clicking it. This page is intentionally blank Schneider Electric. All Rights Reserved. 57

62 APPENDIX C RELAY ATTRIBUTE DEFINITIONS 02/2009 APPENDIX C RELAY ATTRIBUTE DEFINITIONS This section uses many acronyms that may seem ambiguous to the user. Below, is a table that provides definitions of the acronyms introduced in this section. Table 2, Acronyms and Definitions Acronym Descriptions GSM OTA PL SMS SIM card SMPP SMS SMSC SNPP TAP UCP VMS (Global System for Mobile communications). This is a communications standard used by many mobile phones. SMS is defined in the GSM standard, allowing messages of up to 160 characters. (Over-the-Air activation system). This is a category of the type of device that is connecting to the SMSC used in the SMPP standard. PowerLogic System Manager Software (SMS in all other sections) (Subscriber Identity Module). This is a chip that is placed into a mobile phone and securely stores the servicesubscriber key of a user, allowing the user to switch phones by replacing the SIM card. This card is mandatory in all devices that communicate using GSM. (Short Message Peer to Peer). This is an open standard that sends and SMS by connecting directly to an SMSC. Often used to submit messages in bulk. (Short Message Service). This is a communications protocol that allows the exchange of short text messages (160 7-bit characters, including spaces) between mobile phones. More information about SMS, including other protocols can be found here: (Short Message Service Centre). Routes an SMS sent by a user, to the specified destination. (Simple Network Paging Protocol). This is a standard protocol for sending messages to SMS and paging devices. (Telocator Alphanumeric Protocol). This protocol can be used to send SMS messages using a standard modem and telephone landline. (Universal Computer Protocol). This is a protocol that is used by mobile phones to connect to an SMSC. (Voice Mail System). This is a category of the type of device that is connecting to the SMSC used in the SMPP standard Schneider Electric. All Rights Reserved.

63 02/2009 APPENDIX C RELAY ATTRIBUTE DEFINITIONS The following tables identify the attributes of the available relay types, selectable from the Relay selection box, located in the Relay and Recipient Configuration Web Page of APM. Table 3, Relay Attributes for Dial-up TAP Relay Attributes Dialup Device Dialup Speed Data Format Protocol Password Sender Number Recipient Number Provider Dial String Prefix Text Postfix Text Retries Log File Path Descriptions Name of the device for sending APM messages. The baud rate of the communication session. A string indicating the data bits / parity / stop bits Contact your provider to get this. The following link may also be useful Type of provider. This is either the TAP or UCP. Provider password (if required) The number listed as the reply-to number in the SMS. SMS number of the recipient. Number to dial to access provider. Text to append before the message body of the SMS. Text to append after the message body of the SMS. This number determines how many unsuccessful send attempts are made before the SMS is aborted. This is the full path (including name) of the log file. All device commands and responses are written to this file Schneider Electric. All Rights Reserved. 59

64 APPENDIX C RELAY ATTRIBUTE DEFINITIONS 02/2009 Table 4, Relay Attributes for Relay Attributes From To SMTP Server Host Credential User Name Credential Password Retries Prefix Text Postfix Text Enable SSL Subject Pickup Directory Location Delivery Method SMTP Service Port SMTP Timeout Descriptions Appears in the From field of the sent . Addresses of recipients, comma separated. This can be a server name or an IP address of the provider. Usually obtained from the IT department. Login for SMTP Server, if required. Password for SMTP Server, if required. This number determines how many unsuccessful send attempts are made before the is aborted. Text to append before the subject of the . Text to append after the subject of the . True or False indicates whether the is sent using Secure Sockets. The text that will appear in the subject line of the sent . Left blank by default. Path to the folder where messages are to be placed in order to be processed by the SMTP server. Left blank by default. Indicates how messages are delivered: An SMTP server. Moving the into the pickup directory for IIS, which then delivers the message. Moving the to a directory specified by PickupDirectoryLocation for later delivery by another application. An integer that represents the port number on the SMTP host. The default value is 25. An integer that specifies the time-out value in seconds. The default value is 60 seconds Schneider Electric. All Rights Reserved.

65 02/2009 APPENDIX C RELAY ATTRIBUTE DEFINITIONS Table 5, Relay Attributes for GsmOut Relay Attributes Gsm Device Gsm Sim Pin Gsm Prefix Text Gsm Postfix Text Gsm Retries Gsm Recipient Log File Path Descriptions Name of the device to use for sending SMS messages. Required if SIM card is pin protected Text to append before the subject of the SMS. Text to append after the subject of the SMS. This number determines how many unsuccessful send attempts are made before the SMS is aborted. SMS number of the recipient. This is the full path (including name) of the log file. All device commands and responses are written to this file. Table 6, Relay Attributes for Smpp Relay Attributes Descriptions Smpp Server This can be a server name or an IP address of the provider. Smpp Server Port TCP port used for connection to SMPP provider. Smpp System ID Account used to login to the SMSC provider s system. Smpp Password Password used to login to the SMSC provider s system. Smpp System Type Type of SMSC provider (e.g. SMPP, VMS, OTA) Smpp Keep Alive (Seconds) Integer representing the number of seconds to keep a communication channel open. Smpp Timeout (Milliseconds) Integer representing the server timeout in milliseconds used for all network operations such as Connect or Send. Smpp Prefix Text Text to append before the subject of the SMS. Smpp Postfix Text Text to append after the subject of the SMS. Smpp Retries This number determines how many unsuccessful send attempts are made before the SMS is aborted. Smpp Recipient SMS number of the recipient. Log File This is the full path (including name) of the log file. All device commands and responses are written to this file Schneider Electric. All Rights Reserved. 61

66 APPENDIX C RELAY ATTRIBUTE DEFINITIONS 02/2009 Table 7, Relay Attributes for Snpp Relay Attributes Descriptions Snpp Server This can be a server name or an IP address of the provider. Snpp Server Port TCP port used for connection to SMPP provider. Snpp Password Password used to login to the SMSC provider s system. Snpp Timeout (Milliseconds) Integer representing the server timeout in milliseconds used for all network operations such as Connect or Send. Snpp Prefix Text Text to append before the subject of the SMS. Snpp Postfix Text Text to append after the subject of the SMS. Snpp Retries This number determines how many unsuccessful send attempts are made before the SMS is aborted. Snpp Recipient SMS number of the recipient. Log File This is the full path (including name) of the log file. All device commands and responses are written to this file Schneider Electric. All Rights Reserved.

67 02/2009 APPENDIX D SMS OPC Server APPENDIX D SMS OPC Server Overview The SMS OPC server retrieves events from the PowerLogic SMS system and presents these as OPC compliant events. OPC clients can connect to the SMS OPC event server and receive these events by selecting the PL OPC AE.1 server. Prerequisites for Installing SMS OPC Alarm and Event Server The following table defines the prerequisites for installing the SMS OPC Alarm and Event Server. Table 8, Prerequisites for Installing the SMS OPC Alarm and Event Server Applications or Components to Install Versions Microsoft (MS) Windows Windows 2000 Server, Service Pack 4 Windows 2003 Server, Service Pack 1 Windows XP Professional, Service Pack 2 Windows Vista Windows Server 2008 PowerLogic System Manger Software (SMS) System Manager Software (SMS), version 4.02 or greater SMS Priority Conversion SMS event priorities are converted to a normal OPC Priority between 1 and 1000 with 1000 having the highest priority. For Example, an SMS alarm with a priority of 1 would have an OPC priority of 900, while a priority 9 alarm would have an OPC severity of Schneider Electric. All Rights Reserved. 63

68 APPENDIX E PLSCADA OPC Server 02/2009 APPENDIX E PLSCADA OPC Server Overview The PowerLogic SCADA OPC server connects to the Citect PLSCADA server and acts as an OPC compliant Alarm and events server. Prerequisites for Installing PowerLogic SCADA OPC Alarm and Event Server The following table defines the prerequisites for installing the PowerLogic SCADA OPC Alarm and Event Server. Table 9, Prerequisites for Installing the PowerLogic SCADA OPC Alarm and Event Server Applications or Components to Install Versions Microsoft (MS) Windows Windows 2000 Server, Service Pack 4 Windows 2003 Server, Service Pack 1 Windows XP Professional, Service Pack 2 Windows Vista Windows Server 2008 PowerLogic SCADA PowerLogic SCADA 7.1 or greater Installation The APM compact disc (CD) allows for the installation of the PLSCADA OPC Server application. Installing Active Pager Module also installs the PLSCADA OPC server if the PowerLogic SCADA server is installed. Citect Configuration The OPC server connects to the installed PowerLogic SCADA server to retrieve events. The translation of Citect Alarms into OPC events is as follows. Event Tree Schneider Electric. All Rights Reserved.

69 02/2009 APPENDIX E PLSCADA OPC Server The OPC tree structure is built from the Alarm Tag using a UNC type structure. Each level of the tree is defined by a back slash \ character so that multilevel trees can be defined. For example Source\Event1 Source\Event2 Would produce a tree with Source as the root, the Event1 and Event2 below - Source o o Event1 Event2 Trees can have as many levels as needed to represent the event structure the customer desires. Citect / PowerLogic SCADA Event Priorities PowerLogic SCADA priorities are defined in the Alarm Category Screen. These are based on the Citect priority scheme where a priority is an integer value between 1 and is the considered the highest priority while 255 is the lowest. PLSCADA OPC server will translate the Citect priority value so that it is consistent with the OPC scale with 1 being lowest priority and 1000 being the highest. Therefore; a Citect priority of 1 will translate to an OPC severity of 1000, and a Citect priority of 255 will translate to an OPC severity of Schneider Electric. All Rights Reserved. 65

70 APPENDIX F Database Maintenance Utility 02/2009 APPENDIX F Database Maintenance Utility Overview The Database Maintenance Utility is a set of SQL scripts scheduled to run daily as a Windows scheduled task. These tasks are installed during the APM install to facilitate the maintenance of the various databases associated with esolutions products. Maintenance Scripts Schedule Tasks The scripts associated with the database maintenance tasks are located in the DBMaintenance directory. To change the directory for the backup or some other aspect of the maintenance tasks, edit the scripts in the subdirectory associated with the particular task. All tasks associated with the Database maintenance are scheduled to run once per day during the early morning hours. Database Backup Backup databases Log Backup Backup log files Rebuild Index Rebuild table indexes Reorg Index Reorganize Indexes ShrinkTranLog Shrink Transaction Log TrimDiagnosticLogTable Remove old diagnostic events. By default this task leaves 5000 records for diagnostic events. Usually, this number is sufficient for monitoring the health of the system. If you wish to leave more events in the table you may edit the TrimDiagnosticLogTable.sql file. It is recommended no more than 50,0000 records be left in this table as it risks filling the 4GB limit on the SQL express database. TrimEventsTable Remove old monitoring events. By default this leaves 1,000,000 records in the table. If you wish to leave more records or do not wish to trim the events table edit the TrimEventsTable.sql file or disable the scheduled task Schneider Electric. All Rights Reserved.

71 02/2009 APPENDIX G Migration of data from APM 6.0 to APM 6.1 APPENDIX G Migration of data from APM 6.0 to APM 6.1 To migrate data from APM 6.0 to APM 6.1, uninstall APM 6.0 and install APM Schneider Electric. All Rights Reserved. 67

72 APPENDIX H Migration of data from APM to APM /2009 APPENDIX H Migration of data from APM to APM 6.1 Purpose Import into APM 6.1 the paging configurations for all the users set up in APM This includes: - For every user that exists in APM and does not exist in APM 6.1, create a recipient in APM 6.1 (if the recipient exists, he does not get overwritten). - Populate the relay of the newly-created recipients with the corresponding settings from APM Create a Filter in APM 6.1 for every alarm group that exists in APM Create a schedule entry in APM 6.1 for every schedule entry that exists in APM Create a Subscription in APM 6.1 for every user that was set up to receive alarms in APM Prerequisites - SMS < - APM APM Migration Utility Tool (installed with APM 6.1) Installation The Migration Utility is installed as part of the APM 6.1 Install. Please see the APM 6.1 Install manual for details. Setup Prior To Running the Utility Important: An SMS OPC Server must be configured before migration will proceed. If no OPC Server has yet been configured, the user can do so on the OPC Server page of the APM Configuration website (see APM user guide). Running the Migration Utility To run the utility, select it from the Windows Start menu. If installed into the default location, it will be found in Start->All Programs->PowerLogic esolutions->apm-> Migration Utility. When it shows up, it should resemble the form in Figure 1 below. *Before being displayed, the Migration Utility will ask the user to confirm that the APM Configuration website is closed and the PowerLogic Network Server Service is running, and that an SMS OPC Server has been configured Schneider Electric. All Rights Reserved.

73 02/2009 APPENDIX H Migration of data from APM to APM 6.1 Migration Figure 28 - Before initiating the Migration, paths to the configuration files for APM and APM 6.1 must be set. The Migration Utility searches for the files in a default path, and if not found, the user must browse for the paths using the browse buttons. Until the correct paths are set, the Migrate button will not be enabled. - Once the paths to configuration files are set, the Migrate button becomes enabled. - Migration starts after the user clicks the Migrate button. The process may take several minutes to complete. - At the end of this process, the user will be presented with a confirmation message, stating that the ActivePagerModule and PLOpcAELogger services need to restarted. - If the user clicks Yes, the services are restarted. Otherwise, the user must remember to restart the services himself, or the migrated settings will show up in the configuration website, but will not take effect. - When migration is complete, the status bar will display a message indicating the completion and the date of completion. Rollback - After migration has been completed, the Rollback feature is enabled. The Rollback feature allows the user to restore the APM 6.1 configuration to the way it was before the Migration occurred. When the user presses the Rollback button, he will be presented with two confirmation messages. o The first will warn that all changes made to APM 6.1 since the migration occurred will be lost. (Keep in mind that all changes will be lost not just the ones made by the migration utility). o The second message will tell the user that the ActivePagerModule and PLOpcAELogger services will be stopped now and restarted after rollback is complete. - After the confirming both messages, the program waits until the required services are stopped, and then continues with the rollback operation. - When the rollback is complete, the status bar will display a message indicating the completion Schneider Electric. All Rights Reserved. 69