Sending SQL notifications with CDOSYS Desiree Harris July 27, 2004 While SQL Server has a very mature

set of tools, one thing that is lacking is the ability to send a simple email alert based on a pre-defined set of rules. At first glace, it appears that email notifications exist but what becomes a problem to many people is the requirement for a MAPI subsystem to be present on the server. This means that Outlook or an equivalent program has to be installed on the server. Not only that, to properly configure it, the administrator will need to log into the server as the user that the SQL Server service is running under. I have always found this inconvenient so I set out to create a stable, free, easy to configure means of accomplishing the same thing without installing anything special on the server. I've included steps below to complete this task successfully. Before we start, a SMTP server needs to be available. This can be setup on the server itself, on another server within the local network, or outside the network. To install an SMTP service on the SQL Server, ensure that IIS SMTP Services are installed. You can do so from Add/Remove programs in the Control panel. Once it is installed, '' will need to be added to 'relay' on the 'access' tab in the SMTP Properties. Alternately a SMTP server of another mail server can be used instead. This information will need to be added to the 'sp_send_cdosys' stored procedure we'll create later. First we need to create the stored procedure to send the e-mail. This can be done with Enterprise Manager and Query Analyzer. For our example, we'll implement the job with Enterprise manager using the Northwind database. In Enterprise Manager, expand the Northwind database, select and right-click on 'stored procedures', and then select 'New Stored Procedure… '. Note: This can also be added to the Master database so that it is available for all databases.

Delete the contents in the box, and copy and paste the contents below in the stored procedure box (everything between ' -- '). Note: The sp_send_cdosysmail stored procedure uses ‘sp_OACreate' and ‘sp_OASetProperty' stored procedures; this will require the user account running it to have SA permissions.

------------------------------------CREATE PROCEDURE [dbo].[sp_send_cdosysmail] @From varchar(100) , @To varchar(100) , @Subject varchar(100)=" ", @Body varchar(4000) =" " /******************************************

'TextBody'.asp?url=/ library/enus/cdosys/html/_cdosys_messaging. 'MailServerName' -. 'Send'. @Subject -.Save the configurations to the message object. @From EXEC @hr = sp_OASetProperty @iMsg. -. 'Configuration.If you are using HTML e-mail. @Body EXEC @hr = sp_OAMethod @iMsg.Update'. 'Configuration.Message Object ***** EXEC @hr = sp_OACreate 'CDO.fields("http://schemas.This is to configure a remote SMTP NULL -.'2' -. EXEC @hr = sp_OAMethod").microsoft. 'Configuration.Replace MailServerName by the name or IP of your SMTP Server. 'To'. -.Sample error handling.asp EXEC @hr = sp_OASetProperty @iMsg.fields ("http://schemas. EXEC @hr = sp_OASetProperty All the mail configurations are hard-coded in the stored procedure. use 'HTMLBody' instead of 'TextBody'.Value'. Comments are added to the stored procedure where necessary. @iMsg OUT --*****Configuring the Message Object ***** -. @source OUT.Message'.Set the e-mail parameters. EXEC @hr = sp_OASetProperty @iMsg.Fields. 'Subject'. @description OUT IF @hr = 0 BEGIN SELECT @output = ' PRINT @output Description: ' + @description SELECT @output = ' Source: ' + @source .asp *******************************************/ AS Declare @iMsg int Declare @hr int Declare @source varchar(255) Declare @description varchar(500) Declare @output varchar(1000) --***** Create the CDO. IF @hr <>0 select @hr BEGIN EXEC @hr = sp_OAGetErrorInfo NULL. @To EXEC @hr = sp_OASetProperty"). EXEC @hr = sp_OASetProperty @iMsg. microsoft.Value'.microsoft.This is to configure the Server Name or IP address.asp?url=/library/enus/cdosys/html/_cdosys_schema_configuration_sendusing. 'From'. References to the CDOSYS objects are at the following MSDN Web site: null -.http://msdn.This stored procedure takes the parameters and sends an e-mail.

' -. enter the information below. When pasting from my example you may find that some lines wrap. On the 'Steps'"). then send a notification via e-mail when it completes successfully. as an example we will create a job that will backup the Northwind database. Be careful of word wrapping.Do some error handling after each step if you have to. 'Configuration. In Enterprise Manager. On the 'General' tab name the job 'Backup Northwind'. 'MailServerName' Replace 'MailServerName' with either 'localhost' or your 'SMTPMailServer'.fields("http://schemas. -. EXEC @hr = sp_OADestroy @iMsg GO ----------------------Once you have copied the stored procedure into the box. and select 'New Job… '.Clean up the objects created.PRINT END ELSE BEGIN PRINT ' RETURN END END @output sp_OAGetErrorInfo failed. (The path should be a path that exists on the SQL Server.Value'.microsoft. EXEC @hr = sp_OASetProperty @iMsg.) . open 'Management' > 'SQL Server Agent'. click on 'New'. and then select and right-click on 'Jobs'. and then click OK. Next. find the line below within the code. You may need to double check the lines to make sure nothing wrapped that shouldn't have.

because we are about to create another step) and the 'On Failure' column says 'Quit with failure' (this is ok. Notice that the 'On Success' column says 'Goto next step' (this is ok. 'subject*'. . we don't want it to go to the next step). ---------------------------------------Name: Database: Command: SendNotification Northwind EXEC sp_send_cdosysmail '*'. The Northwind database has been backed up successfully. 'to@emailaddress. Click 'New…' and add the information below (everything between ' --.'). 'I've added an example message for you* Team. because if the job fails.This is what you should see after you click 'OK'.com*'. Now we'll add the job step that will notify us that the job has completed.

. ORCS Web ' ---------------------------------------*fill in the fields with the desired information. This is what the job should look like now. Click on the 'Advanced' tab and change the 'On Success' box to 'Quit the job reporting success' and then click 'OK'.Thank you.

For our purposes. right-click on the job we just created and click 'Start Job'. the 'Schedules' and 'Notifications' tabs default settings are fine. Click 'OK' and your job should appear in the job window. . we will not need to make any changes. Now.

open 'Management' > 'SQL Server Agent'. even though email notifications can be setup as a 'job step' you can also setup an alert based on a SQL Server event that will send an email and include details of the event. and select 'New Job… '. and then select and right-click on 'Jobs'. you will be sent an email notification that looks like this. In Enterprise Manager.Make sure that the Job step named 'Backup' is selected then click start. . When the job complete. Now. Next we will setup an alert that will send an email notification with details.

click on 'New'. "") --' EXEC sp_send_cdosysmail 'from@emailaddress. On the 'Steps' tab. --------DECLARE @msg nvarchar(4000) Set @msg = REPLACE("Error: [A-ERR] Severity: [A-SEV] Date: [STRTDT] Time: [STRTTM] Database: [A-DBN] Message: [A-MSG] ".com*'. @msg ---------*fill in fields with desired information . 'subject*'.On the 'General' tab name the job 'SQL Server Severity Alert Notification'. "'". name it 'SendEmail' and enter the script below (everything between '--').com*'.On the 'Advanced' tab. change the 'on success action' to 'Quit the job reporting success' and click 'OK'. 'to@emailaddress.

bak*' *ensure the path exists on the SQL Server This task will execute the alert. put a check in the box for 'Execute job'. open 'Management' > 'SQL Server Agent'.I guess you're wondering what the script does. I've included an example below. The script takes advantage of the power of agent tokens. . select the job we just created. which will be automatically filled in at runtime.sqldev. 'SQL Server Severity Notification'. an email should appear in the inbox of the email address you specified in the script. Next we'll create the alert that will run the job we just created when an event occurs. In Enterprise Manager. and then select and right-click on 'Alerts'.net/sqlagent/SQLAgentStepTokens. On the 'General' tab name the job 'SQL Server Severity Alert'. let's click 'OK' again to complete the job. We'll leave the severity level at 010 as it will return information and isn't specific to an error and we'll let this alert fire for all databases. and then click 'OK'. On the 'Response' tab.htm The 'Schedules' and 'Notifications' tab don't need any changes at this time. Let's backup the Northwind database in Query Analyzer with the script below: Use master BACKUP DATABASE Northwind TO DISK = 'c:\temp\northwind. You can get more information about agent tokens here:http://www. we are ready to test. and select 'New Alert… '. At this point. Now.


Sign up to vote on this title
UsefulNot useful