Processors

Processors provide a customizable URL endpoint that can execute arbitrary server-side JavaScript code and produce output such as TEXT or JSON. Creating custom processors is deprecated.

Note:

This feature is deprecated. While legacy, existing custom processors continue to be supported, creating new custom processors has been deprecated. Instead, use the Scripted REST APIs.

Warning:

When creating a processor, ensure that you use parameter names that are specific to your processor. For example, if your processor exports a list of legal records, and a necessary parameter is the recipient's email address, don't use “email” as the parameter name. Create a more processor specific parameter name, such as legal_export_recipient_email. Failure to do so, and using instance parameter names, such as id, table, sys_id, service, catalog_id, or view (and others), can cause unexpected results.

When to create processors

Do not create custom processors. This feature is deprecated. Please use the REST APIs instead of creating custom processors. The remaining information is left for existing processors only.

Processor form

Field	Description
Name	Unique name of the processor.
Type	Programming language of the processor script. Options include: java: do not select this option script
Application	Application containing this record.
Active	Flag to enable or disable the record.
CSRF protect	Option to protect the processor from running unless the instance uses a CSRF token.
Description	Description of the processor's function or purpose.
Parameters	List of available input parameters. Specify parameter values in the URL as <parameter name>=<parameter value>. Note: Parameter names must be processor-specific. Do not choose common parameter names that another processor might use. If you use a common parameter name, such as id, sys_id or table in a processor, it can break other functionality, since the processor wins when that parameter exists in a URL. For example, a processor with an id parameter, regardless of the Path value in the same record, breaks the Service Portal, which depends on that parameter for page identification.
Path	URI path used to call this processor. Call a processor from the URL as: https://<instance name>.service-now.com/<Path>.do
Script	Immediately Invoked Function Expression to run when the system calls this processor. The function automatically provides input parameters for the following API objects. g_request g_response g_processor
Protection policy	Policy to use to protect this record's script. Options include: None Read-only Protected

• Processor API components
  Processors have access to dedicated API classes, objects, and methods.
• Secure and protect a processor
  You can protect your processor against unauthorized use by using role restrictions, and protect it by requiring a CSRF token.
• Create a simple processor
  Create a simple processor to execute a script from a URL query. This feature is deprecated.
• Create a multi-table processor
  Create a multi-table processor that reports the number of rows in any table on your instance. This feature is deprecated.
• Create a custom processor
  Create a custom processor to execute a script from a URL query. This feature is deprecated.