Thank you for your feedback.
Form temporarily unavailable. Please try again or contact docfeedback@servicenow.com to submit your comments.
Versions
  • London
  • Kingston
  • Jakarta
  • Istanbul
  • Helsinki
  • Geneva
  • Store
Close

Create a JavaScript Probe activity

Create a JavaScript Probe activity

Create a JavaScript Probe activity to instruct a MID server to execute server-side javascript.

Before you begin

Role required: activity_creator or workflow_admin

About this task

The JavascriptProbe activity has the same functionality as making ‘Packages’ calls into standard Java libraries. It allows you to have more control over the Java libraries on the MID Server. You can load your own JAR files on the MID Server and have the JavascriptProbe make Package calls into those java files.

Procedure

  1. Create a custom activity.
    This action creates a custom activity using a template.
  2. After setting up general properties and creating input variables, configure the JavaScript probe activity Execution Command:
    OptionDescription
    Map the input variables Use the variables you created to configure the command that Orchestration executes on the MID server.
    Script type Select the type of script to include. Available options are:
    • Custom JavaScript
    • MID Server script include
    Script Custom JavaScript to run with this probe.
    Note: This field is available when the Script type selected is Custom JavaScript.
    MID Server script include Script for the MID Server to run with this probe.
    Note: This field is available when the Script type selected is MID Server script include.
    Select MID Server by host MID Server on which the probe runs.
    Required MID Server capabilities MID Server to use, by capabilities.
    Parameters Name-value pairs to pass to the host with this probe. You can create these parameters manually, or drag input variables into the Parameters fields and assign a value.
    Note: You can map parameter values in a test payload to variables in the Outputs tab automatically. See automap output variables.

What to do next

Finish creating your JavaScript probe activity by creating output variables, creating a parsing rule, or creating template conditions. Refer to the create custom activities topic to know your template options.

JavaScript probe template execution parameters

You use execution parameters to create the input process script in the Preprocessing form of the activity designer.

For descriptions of the JavaScript Probe command fields, see the table in Configure the JavaScript Probe execution command.
Note: You must use the executionParam. prefix with all variables in this table.
Table 1. JavaScript template execution parameters
Name Variable Type Usage
Script Type script_type Enumerated Type of script to run. The possible types are:
  • custom_javascript_typ
  • mid_script_include_type
Script script String Script that runs custom JavaScript when the script_type is custom_javascript_type.
Mid script include mid_script_include Reference The sys_id reference associated with the MID Server script include to call, when the script_type is mid_script_include_type.
Source source String Target host on which to run the script.
MidCapabilities midCapabilities String (comma separated) List of required MID Server capabilities.
Parameters parameters Array of JavaScript object Array of JavaScript objects, expressed with the executionParam. prefix. To add more name-value pairs to the parameters array, append them to the existing array. Create a JavaScript object with the following syntax, and add it to the executionParam.parameter array. This assigns additional parameters to the message:
var newParameter = {"name":"parameterName","value":"parameterValue"};
executionParam.parameters.push(newParameter);
ValueCapabilities valueCapabilities Array of hashmap Capability values used to select the MID Server. For more information, see MID Server capabilities. If there are additional capabilities that are assigned by value, use this example to customize the MID Server selection:
var valueCapability = {'NEW_MID_CAPABIILTY':'NEW_MID_CAPABILITY_VALUE'};
executionParam.valueCapabilities.push(valueCapability);

JavaScript probe template post-processing parameters

Use these parameters to create a post-processing script.

Table 2. JavaScript probe post-processing parameters
Name Variable Type Usage
Payload payload String Contains raw payload returned from the JavaScript Probe.
Output output String Contains output data returned from the JavaScript Probe.
EccSysId eccSysId String Contains the reference ID associated with the ECC Queue input message.
Error Messages errorMessages String Contains the error messages returned from the JavaScript probe. If no error messages are returned, this value is null.

Configure the JavaScript Probe execution command

Use the input variables you created to configure the command that Orchestration executes on the JavaScript Probe target host.

Before you begin

Create the input variables you need in the Inputs form before you can advance to the Execution Command stage.

Role required: activity_creator, admin

Note: You can test the JavaScript Probe connection between the MID Server and the target without having to run the acvitity in a workflow context. For details, see test template outputs.

Procedure

  1. Drag variables from the list of inputs and drop them into command fields.
    The system formats the variable in the proper syntax for the command.
    Figure 1. JavaScript Probe execution command
    JavaScript Probe execution command
  2. Complete the fields shown in the table.
    Table 3. JavaScript Probe execution command fields
    Field Description
    Input Input variable builder. Create input variables to map to available fields.
    Script type Select the type of script to include. Available options are:
    • Custom JavaScript
    • MID Server script include
    Script Custom JavaScript to run with this probe. This field is available when the Script type selected is Custom JavaScript.
    MID Server script include Script for the MID Server to run with this probe. This field is available when the Script type selected is MID Server script include.
    Select MID Server by host MID Server on which the probe runs.
    Required MID Server capabilities MID Server to use, by capabilities.
    Parameters Name-value pairs to pass to the host with this probe. You can create these parameters manually, or drag input variables into the Parameters fields and assign a value.
  3. Click Save.
  4. Click Continue to advance to the Outputs stage.