JavascriptProbe - Global

  • Release version: Australia
  • Updated March 12, 2026
  • 1 minute to read
  • 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.

    JavascriptProbe - JavascriptProbe(String midServer)

    Creates an instance of the JavascriptProbe.

    Table 1. Parameters
    Name Type Description
    midServer String The 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.

    Table 2. Parameters
    Name Type Description
    name String The parameter name
    value String The parameter's value
    Table 3. Returns
    Type Description
    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".

    Table 4. Parameters
    Name Type Description
    None
    Table 5. Returns
    Type Description
    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.

    Table 6. Parameters
    Name Type Description
    script String The script to add to the probe
    Table 7. Returns
    Type Description
    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

    Table 8. Parameters
    Name Type Description
    name String The name to give the JavascriptProbe.
    Table 9. Returns
    Type Description
    void
    var jspr = new JavascriptProbe('msserv');
    jspr.setName('jsprobe100');

    JavascriptProbe - setSource(String ip)

    Sets the source of the probe.

    Table 10. Parameters
    Name Type Description
    ip String The IP address of the target probe.
    Table 11. Returns
    Type Description
    void
    var jspr = new JavascriptProbe('msserv');
    jspr.setName('jsprobe100');
    jspr.setSource('100.100.100.1');