sp_add_category (Transact-SQL)

Adds the specified category of jobs, alerts, or operators to the server.

Topic link iconTransact-SQL Syntax Conventions

Syntax

sp_add_category 
     [ [ @class = ] 'class', ] 
     [ [ @type = ] 'type', ] 
     { [ @name = ] 'name' }

Arguments

  • [ @class = ] 'class'
    The class of the category to be added. class is varchar(8) with a default value of JOB, and can be one of these values.

    Value

    Description

    JOB

    Adds a job category.

    ALERT

    Adds an alert category.

    OPERATOR

    Adds an operator category.

  • [ @type = ] 'type'
    The type of category to be added. type is varchar(12), with a default value of LOCAL, and can be one of these values.

    Value

    Description

    LOCAL

    A local job category.

    MULTI-SERVER

    A multiserver job category.

    NONE

    A category for a class other than JOB.

  • [ @name = ] 'name'
    The name of the category to be added. The name must be unique within the specified class. name is sysname, with no default.

Return Code Values

0 (success) or 1 (failure)

Result Sets

None

Remarks

sp_add_category must be run from the msdb database.

Permissions

Only members of the sysadmin fixed server role can execute sp_add_category.

Examples

The following example creates a local job category named AdminJobs.

USE msdb ;
GO

EXEC dbo.sp_add_category
    @class=N'JOB',
    @type=N'LOCAL',
    @name=N'AdminJobs' ;
GO