NSNotificationBatchList (Transact-SQL)

Lists the notification batches generated for a notification class.

Syntax

[ application_schema_name . ] NSNotificationBatchList 
    [ @NotificationClassName = ] notification_class_name

Arguments

  • [ @NotificationClassName = ] notification_class_name
    Is the name of a notification class. notification_class_name is nvarchar(255) and has no default value.

Return Code Values

0 (success) or 1 (failure)

Result Sets

Column Name Data Type Description

NotificationClassName

nvarchar(255)

Name of the notification class.

NotificationBatchId

bigint

Identifier of the notification batch.

NotificationCount

int

Number of notifications in the notification batch.

NotificationBatchesStatus

nvarchar(255)

Status of the notification batch, which can be any of the following values:

  • Undone
  • Generating
  • Generated
  • Creating distributor work items
  • Created distributor work items
  • Failed to generate

NotificationBatchExpirationTime

datetime

Date and time, in Coordinated Universal Time (UTC), at which the notification batch expires. After the expiration time, any remaining undelivered notifications are abandoned. Delivery of these notifications will not be attempted again, regardless of the retry schedule. If this value is NULL, the batch has no expiration time.

StartGenerationTime

datetime

Start date and time, in UTC, of the notification batch generation.

EndGenerationTime

datetime

End date and time, in UTC, of the notification batch generation.

DistributorWorkItemCreationTime

datetime

Date and time, in UTC, that work items were created from the notification batch. Work items consist of notifications within a single batch that will be delivered through the same delivery channel.

Remarks

To troubleshoot notification formatting and delivery, you sometimes need a notification batch ID to use as an input to another stored procedure, such as NSNotificationBatchDetails. This stored procedures lists the notification batch IDs for a specific notification class.

Notification Services creates the NSNotificationBatchDetails stored procedure in the application database when you create the instance. When you update the application, Notification Services recompiles the stored procedure.

This stored procedure is in the application's schema, which is specified by the application's SchemaName property. If no schema name is provided, the default schema is dbo.

Permissions

Execute permissions default to the NSAnalysis database role, the db_owner fixed database role, and the sysadmin fixed server role.

Examples

The following example shows how to run the NSNotificationBatchList stored procedure for the Notification Services tutorial sample.

EXEC dbo.NSNotificationBatchList N'WeatherAlerts';

See Also

Reference

NSNotificationBatchDetails (Transact-SQL)
Notification Services Stored Procedures (Transact-SQL)

Other Resources

Defining Condition Actions
SchemaName Element (ADF)

Help and Information

Getting SQL Server 2005 Assistance