sp_add_category (T-SQL)

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

Syntax

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

Arguments

[@class =] 'class'

Is 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'

Is 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'

Is 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 executed in the msdb database.

Permissions

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

Examples

This example creates a local job category name AdminJobs.

USE msdb

EXEC sp_add_category 'JOB', 'LOCAL', 'AdminJobs'

See Also