Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

JavascriptProbe- Global

The JavascriptProbe script include provides methods for using the JavascriptProbe on the MID Server.

Use these methods in server scripts to send a probe to the MID Server For more information, see Create a JavaScript Probe activity.

Parent Topic:Server API reference

JavascriptProbe - JavascriptProbe(String midServer)

Creates an instance of the JavascriptProbe.

NameTypeDescription
midServerStringThe MID server name

The following example shows how to use an instance of JavascriptProbe.

var jspr = new JavascriptProbe('midserver_name');

var func = function () {
    // Java FileWriter class of java.io package. FileWriter is write data in character.
    var FileWriter = Packages.java.io.FileWriter;

    // Constructs a FileWriter object given a file name.
    var file = new FileWriter("TestMessage.txt");

    // Gets the parameter from the ECC queue payload.
    var message = probe.getParameter("message");

    // Write the message to a file.
    file.write(message);

    // Close the FileWriter.
    file.close();
    file = null;
}

// Add parameter to pass to MIDServer.
jspr.addParameter('message', 'ServiceNow Message');

// Set the script to be executed by the MIDServer as a string
jspr.setJavascript('(' + func.toString() + ')();');

// Send to MIDServer. The MIDServer will execute the Script immediately.
jspr.create();

JavascriptProbe - addParameter(String name, String value)

Adds a parameter with the specified value to the probe.

NameTypeDescription
nameStringThe parameter name
valueStringThe parameter's value
TypeDescription
void 
var jspr = new JavascriptProbe('msserv');
jspr.setName('jsprobe100');
jspr.setSource('jspr_source');
jspr.addParameter('support_feat', 'yes');

JavascriptProbe - create()

Creates the probe for the current MID server, puts it on the output queue, and sets its state to "ready".

NameTypeDescription
None  
TypeDescription
void 
var jspr = new JavascriptProbe('msserv');
jspr.setName('jsprobe100');
jspr.setSource('jspr_source');
jspr.setJavascript('jspr_script');
jspr.create();

JavascriptProbe - setJavascript(String script)

Adds a script to the probe.

NameTypeDescription
scriptStringThe script to add to the probe
TypeDescription
void 
var jspr = new JavascriptProbe('msserv');
jspr.setName('jsprobe100');
jspr.setSource('jspr_source');
jspr.setJavascript('jspr_script');

JavascriptProbe - setName(String name)

Sets the name of the JavascriptProbe

NameTypeDescription
nameStringThe name to give the JavascriptProbe.
TypeDescription
void 
var jspr = new JavascriptProbe('msserv');
jspr.setName('jsprobe100');

JavascriptProbe - setSource(String ip)

Sets the source of the probe.

NameTypeDescription
ipStringThe IP address of the target probe.
TypeDescription
void 
var jspr = new JavascriptProbe('msserv');
jspr.setName('jsprobe100');
jspr.setSource('100.100.100.1');