MOM NOTIFICATION WORKFLOW SOLUTION ACCELERATOR VER 2.1

Transcription

1 5/30/2006 QUICKSTART GUIDE MOM NOTIFICATION WORKFLOW SOLUTION ACCELERATOR VER Pete Zerger, MCSE(Messaging)

2 Table of Contents INTRODUCTION... 3 IMPORTANT NOTICE /DISCLAIMER:... 3 PREREQUISITES... 3 INSTALLATION TASKS... 4 Install SQLXML SP Install SQL Notification Services SP Install Notification Workflow Solution Accelerator... 6 Verifying installation is successful... 7 Configure ASP.NET Impersonation... 9 Configure Default Page... 9 POST INSTALLATION TASKS... 9 To Configure the Remote SMTP server:...10 APPLYING THE V2.1 HOTFIX...11 Replace appadf.xml, NoOp.xslt and Edit Accordingly...11 Run the CGTruncationBugFix.sql Script...11 REGISTERING APPCONFIG.XML AND APPADF.XML CHANGES...11 SUBSCRIBING TO ALERTS...12 ADDITIONAL RESOURCES...13 REVISIONS...13 P e t e Z e r g e r, M C S E ( M e s s a g i n g ) h t t p : / / w w w. m o m r e s o u r c e s. o r g Page 2

3 Introduction This document was created out of a need to simply the NWSA installation process, which is not fully documented in any single document, and is lacking on a couple of the dependencies and installation steps in my humble option. To be fair, the information exists in the NWSA user and installation of guides plus a KB article, but I wanted to gather up all the details and boil it down to the essential elements so folks could get N W S A up and running quickly and easily.without the need for knowledge of SQL Notification Services. If you find this document helpful...or lacking in some way, I welcome your feedback. I can be reached at pete.zerger@gmail.com. IMPORTANT NOTICE /DISCLAIMER: Install components in the order shown. These instructions assumes all NWSA components are being installed on the MOM database server (hosting Onepoint), as that is where the Notification Workflow installer will direct the actual SQL database creation. Be sure to install the hotfix, as it addresses known issues, one which can result in alerts not being received and another related to a time zone issue. A distributed installation is possible (database and SQL notification services components on different servers), but since the web component overhead is low, these instructions assume installation of all components on the MOM database server. If you have high performance requirements, consider a distributed installation and size hardware components appropriately. Prerequisites Verify the following on your MOM database server prior to beginning the installation process Verify.NET Framework 1.1 is installed and ASP.NET is enabled prior to installation of remaining components. IIS 6.0 should be installed and the default website running on the server where you intend to install the NWSA. SQL Server and SQL Agent components should be running at the time of installation. Your MOM 2005 installation should be installed and fully functional. A valid SMTP server (Windows SMTP Server, Exchange Server must be available on your network for delivery of notification s. Default script engine is set to CScript (cscript //H:cscript from a cmd prompt). If not, your install will fail. Verify time is synchronized on MOM management and database servers. Visit Windows Update and make sure any critical updates have been applied, such as critical.net framework updates. OPTIONAL: Add the nscontrol.exe directory to the system path, as it makes running the nscontrol commands easier near the end of the installation process. The nscontrol.exe file is located in the %programfiles%\microsoft SQL Server Notification Services\v \Bin directory by default. P e t e Z e r g e r, M C S E ( M e s s a g i n g ) h t t p : / / w w w. m o m r e s o u r c e s. o r g Page 3

4 Installation Tasks Install SQLXML SP3 Download the software from 1. Double-click the sqlxmlsp3.msi executable 2. On the Welcome screen, click Next. 3. On the End User License Agreement screen, accept the license agreement and click Next. 4. On the Customer Information screen, enter the appropriate user and organization information 5. On the Choose Setup Type screen, select the Install Now button. 6. When complete, click Finish. No reboot is necessary. Install SQL Notification Services SP1 Download the software from 1. Double-click the MSSQLNS20SP1.Std.en.exe executable 2. On the Welcome screen, click Next. 3. On the End User License Agreement screen, accept the license agreement and click Next. 4. On the Customer Information screen, enter the appropriate user and organization information. In the install this application for section, select Everyone. 5. On the Custom Setup screen, deselect Sample Applications and click Next. P e t e Z e r g e r, M C S E ( M e s s a g i n g ) h t t p : / / w w w. m o m r e s o u r c e s. o r g Page 4

5 6. On the Database Components Setup screen, select the name of the SQL instance you wish to use. This will generally be the same instance as your MOM database server. 7. On the SQL Server Login Information screen, select Windows authentication. This meets with MS best practices and should match your original selection when installing SQL 2000 on the MOM database server. Click Next. 8. Ready to Install the Program screen, click Install. Installation will take only a minute or two. 9. When complete, click Finish. You are now ready to install the MOM 2005 Notification Workflow Solution Accelerator. P e t e Z e r g e r, M C S E ( M e s s a g i n g ) h t t p : / / w w w. m o m r e s o u r c e s. o r g Page 5

6 Install Notification Workflow Solution Accelerator Download the software from 7AE7B4775B0F&displaylang=en 1. Double-click the Notification Workflow.msi executable. On the Welcome screen, set the 'Install Notification Workflow' button to Everyone, and then click Next. 2. On the Confirm Installation screen, click Next. 3. On the Enter Installation Details screen you'll need to provide a number of parameters. A valid logon ID, which consists of the domain and user name. This should be written in the format Domain\User Name. This account will be used to run the P e t e Z e r g e r, M C S E ( M e s s a g i n g ) h t t p : / / w w w. m o m r e s o u r c e s. o r g Page 6

7 Notification Workflow service (NS$NotificationWorkflow). I recommend using the MOM DAS Account simply because it should have privileges to the SQL instance where the Onepoint database is installed. The user password corresponding to the logon ID. The text that will be used in the From field in any notification s. The polling interval (in seconds). This is the time period that will be used to poll for new alerts from the MOM 2005 database. The value that you choose for this property directly affects how fast you can receive notifications once an alert is generated. Make sure that you consider your service level agreement (SLA), if you have one in place, to determine the optimized value for this property. The name of the MOM Management Server. This is the name of the MOM Management Server in your environment. 4. After completing these details, click Install. When installation is complete, click Close. Verifying installation is successful Assuming installation is successful, type the following address in Internet Explorer to access the Notification Workflow console: where <servername> is the name of the server where you installed the NWSA. If the page fails to render, you'll likely see the following error: HTTP Error Unauthorized: Access is denied due to invalid credentials. Internet Information Services (IIS) This is because the Notification Workflow virtual directory in IIS 6.0 is set to Anonymous access only be default. To resolve this issue, perform the following steps. 1. Launch the IIS Manager MMC snap-in in Start, Administrative Tools menu. 2. Expand the default website, and right click the Notification Workflow virtual directory (NotificationWorkflow.web) and select Properties. P e t e Z e r g e r, M C S E ( M e s s a g i n g ) h t t p : / / w w w. m o m r e s o u r c e s. o r g Page 7

8 3. Select the Directory Security tab. Under Authentication and access control, click edit. 4. On the Authentication Methods screen, disable anonymous access and enable Integrated Windows authentication. Click OK to accept the change. P e t e Z e r g e r, M C S E ( M e s s a g i n g ) h t t p : / / w w w. m o m r e s o u r c e s. o r g Page 8

9 Configure ASP.NET Impersonation Also, ASP.NET impersonation is not configured by default. Impersonation is required to ensure only users granted explicit permissions can access the site. Perform the actions in the following steps: 1. Locate the Web.config file in \<Notification Workflow installation folder>\presentation\msmnw.web\. 2. Locate the following text: <authentication mode="windows" />. 3. Add the following text: <id en tity im p erso n ate= tru e /> immediately below the preceding section. 4. Save the file. 5. Run IIS Manager. 6. Expand the Web Sites node. 7. Expand the Default Web Site node. 8. Right click the NotificationWorkflow.Web node. 9. Click the Directory Security tab. 10. Click Edit in the Authentication and access control section. 11. Clear the Enable anonymous access check box. 12. Verify that the Integrated Windows authentication check box is selected. 13. Restart the World Wide Web Publishing Service. Configure Default Page 1. In IIS Manager, right click the default website and select Properties. 2. On the Documents tab, add homepage.aspx to the default documents list. 3. Attempt access to the site again - Shazaam, the site appears! Post Installation Tasks We need to configure values for the SMTP server that will be used to relay messages. While we could use the local server, I prefer to use my existing SMTP server to handle notification delivery. The remote SMTP server can be an Exchange Server, a Windows server running SMTP, or even a non-windows SMTP server. Browse to the following directory in the Notification Workflow installation path: C:\program files\microsoft\notification workflow\notification Workflow\AppDefinition. You should see 2 XML files here; AppADF.xml and AppConfig.xml. To configure the AppADF.xml and AppConfig.xml files, follow these steps: 1. First, Stop the Notification Workflow service (NS$NotificationWorkflow) in Services Manager. P e t e Z e r g e r, M C S E ( M e s s a g i n g ) h t t p : / / w w w. m o m r e s o u r c e s. o r g Page 9

10 To Configure the Remote SMTP server: While the Notification Workflow database components live on the MOM database server, it makes more sense to forward alerts to an appropriate SMTP server for final delivery. By default, no SMTP server is specified in the AppConfig.xml file, nor are instructions on configuring this given in the N W S A Installation G uide. In this section, w e ll u pdate the xml configuration file and then save changes to the NWSA application using NSCONTROL, a command line utility in SQL Notification Services. 1. Stop the NS$NotificationWorkflow service through Service Manager or by typing net stop NS$NotificationWorkflow at a command prompt. Open the AppConfig.xml file by using a text editor. AppConfig.xml should be located in the %programfiles%\notification workflow\notification workflow\appdefinition directory. 2. Locate the "<ProtocolName>SMTP</ProtocolName>" entry. 3. Add the following "Arguments" section after the entry. <Arguments> <Argument> <Name>SmtpServer</Name> <Value>EXCHSERVER</Value> (If using local SMTP, put LOCALHOST here!) </Argument> <Argument> <Name>BodyEncoding</Name> <Value>utf-8</Value> </Argument> </Arguments> P e t e Z e r g e r, M C S E ( M e s s a g i n g ) h t t p : / / w w w. m o m r e s o u r c e s. o r g Page 10

11 Applying the v2.1 Hotfix Replace appadf.xml, NoOp.xslt and Edit Accordingly 1. Unzip the hotfix to a local drive. 2. Make a backup of the appadf.xml and NoOp.xslt files in the %programfiles%\notification workflow\notification workflow\appdefinition directory 3. Replace the original files with a copy of the version of these two files from the directory where you unzipped the hotfix. 4. Edit the appadf.xml file w ith N otepad changing the sender nam e A dm in to the FROM: address you entered during the initial Notification Workflow installation. <Field> </Field> <FieldName>From</FieldName> <SqlExpression>'admin'</SqlExpression> 5. Also in the appadf.xml file, edit the polling provider. Replace the 01M00S value with the interval you wish the application to process events. I use 00M15S in my environment. <Schedule> </Schedule> <Interval>P0DT00H01M00S</Interval> Run the CGTruncationBugFix.sql Script 6. Open Query Analyzer and connect to the SQL instance where Onepoint is hosted. 7. From the file menu, select Open and browse to the CGTruncationBugFix.sql file. 8. IMPORTANT: Make sure the database selected in the dropdown above the query window is set to NotificationWorkflowNotificationWorkflowApp. 9. Click the green checkmark or hit F5 to execute the script. A ll application changes are com plete at this point. N ext, you ll register these changes in SQL Notification Services. Registering AppConfig.xml and Appadf.xml Changes Changes to the AppConfig.xml and Appadf.xml files must be registered with SQL Notification Services using a SQL Notification Services command line tool called NSCONTROL. For more info on NSCONTROL, see SQL Notification Services Books Online 1. The application must be disabled prior to being updated. Disable Notification Workflow by entering the following at the command line: NSCONTROL DISABLE -name "NotificationWorkflow" P e t e Z e r g e r, M C S E ( M e s s a g i n g ) h t t p : / / w w w. m o m r e s o u r c e s. o r g Page 11

12 2. Now, we can register the changes made to the AppConfig.xml file. Copy the following to a command prompt (single line) and press enter. Be sure to replace <server> with the name of the appropriate server in this case, the name of the MOM database server. NOTE: Due to a bug in SQL Notification Services 2.0, it is necessary to run the following command 2 times! NSCONTROL UPDATE -in "C:\Program Files\Microsoft\Notification Workflow\Notification Workflow\AppDefinition\appconfig.xml" SQLServer=<server> BaseDirectoryPath="C:\Program Files\Microsoft\Notification Workflow\Notification Workflow" NSSystem=<server> 3. When complete, re-enable the application with the following command. NSCONTROL ENABLE -name "NotificationWorkflow" 4. When complete, start the NS$NotificationWorkflow service through Service Manager or by typing net start NS$NotificationWorkflow at a command prompt. Installation is complete! You may now start using the Notification Workflow Solution Accelerator. Subscribing to Alerts Subscribing to MOM alerts requires configuration of 4 components on the Notification Workflow Website. Begin at the NWSA homepage: 1. Create and activate a subscriber 2. Set the subscribers schedule 3. Defining subscriber devices. Devices are essentially are addresses of the subscriber 4. Select alert subscriptions for the subscriber. Alerts subscriptions include computer group(s), alert severity, and optionally, search criteria on the alert description. These items are very well documented in the Notification Workflow Users Guide, so I w on t recount them in detail here. P e t e Z e r g e r, M C S E ( M e s s a g i n g ) h t t p : / / w w w. m o m r e s o u r c e s. o r g Page 12

13 Additional Resources Prerequisites and configuration settings that are required to make the Notification Workflow Solution Accelerator fully functional with Microsoft Operations Manager (MOM) Errata: If you wish to use a remote SMTP server, (which is a good idea) the following section of the KB suggests pasting the following value into appconfig.xml. The utf-16 value for body encoding sometimes results in Chinese characters in the notification s in my experience. Change this value to utf-8 and you should be good to go. <Arguments> <Argument> <Name>SmtpServer</Name> <Value>EXCHSERVER</Value> </Argument> <Argument> <Name>BodyEncoding</Name> <Value>utf-16</Value> </Argument> </Arguments> Also see the following guides in the directory where you extracted the NWSA files. Notification Workflow Installation Guide Notification Workflow User Guide More info on the NSCONTROL utility and SQL Notification Services is available in SQL Notification Services Books Online. Revisions 12/7/05 Updated <bodyencoding> datatype in the AppConfig.xml section. 12/9/05 Clarified SMTPServer options in AppConfig.xml section. 05/30/06 Cleaned up various errata. 50/30/06 - Updated 5/30/06 for version 2.1 P e t e Z e r g e r, M C S E ( M e s s a g i n g ) h t t p : / / w w w. m o m r e s o u r c e s. o r g Page 13