---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# JavascriptProbe - Global

# JavascriptProbe - Global {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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](https://www.servicenow.com/docs/access?context=t_CreateAJavaScriptProbeActivity&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).

## JavascriptProbe - JavascriptProbe(String midServer) {#ariaid-title2}

Creates an instance of the JavascriptProbe.
{#r_JSP-JavascriptProbe_S__table_wk5_jqf_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| midServer | String | The MID server name |
[Table 1. Parameters]

{#r_JSP-JavascriptProbe_S__table_wk5_jqf_zt}  
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) {#ariaid-title3}

Adds a parameter with the specified value to the probe.
{#r_JSP-addParameter_S_S__table_ohx_nrf_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| name | String | The parameter name |
| value | String | The parameter's value |
[Table 2. Parameters]

{#r_JSP-addParameter_S_S__table_ohx_nrf_zt} {#r_JSP-addParameter_S_S__table_phx_nrf_zt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 3. Returns]

{#r_JSP-addParameter_S_S__table_phx_nrf_zt}  

    var jspr = new JavascriptProbe('msserv');
    jspr.setName('jsprobe100');
    jspr.setSource('jspr_source');
    jspr.addParameter('support_feat', 'yes');

## JavascriptProbe - create() {#ariaid-title4}

Creates the probe for the current MID server, puts it on the output queue, and sets its
state to "ready".
{#r_JSP-create__table_fkn_gsf_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 4. Parameters]

{#r_JSP-create__table_fkn_gsf_zt} {#r_JSP-create__table_gkn_gsf_zt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 5. Returns]

{#r_JSP-create__table_gkn_gsf_zt}  

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

## JavascriptProbe - setJavascript(String script) {#ariaid-title5}

Adds a script to the probe.
{#r_JSP-setJavascript_S__table_rt2_yrf_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| script | String | The script to add to the probe |
[Table 6. Parameters]

{#r_JSP-setJavascript_S__table_rt2_yrf_zt} {#r_JSP-setJavascript_S__table_st2_yrf_zt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 7. Returns]

{#r_JSP-setJavascript_S__table_st2_yrf_zt}  

    var jspr = new JavascriptProbe('msserv');
    jspr.setName('jsprobe100');
    jspr.setSource('jspr_source');
    jspr.setJavascript('jspr_script');

## JavascriptProbe - setName(String name) {#ariaid-title6}

Sets the name of the JavascriptProbe
{#r_JSP-setName_S__table_lrs_tqf_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| name | String | The name to give the JavascriptProbe. |
[Table 8. Parameters]

{#r_JSP-setName_S__table_lrs_tqf_zt} {#r_JSP-setName_S__table_mrs_tqf_zt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 9. Returns]

{#r_JSP-setName_S__table_mrs_tqf_zt}  

    var jspr = new JavascriptProbe('msserv');
    jspr.setName('jsprobe100');

## JavascriptProbe - setSource(String ip) {#ariaid-title7}

Sets the source of the probe.
{#r_JSP-setSource_S__table_yps_2rf_zt__entry__3}

| Name | Type | Description |
|-|-|-|
| ip | String | The IP address of the target probe. |
[Table 10. Parameters]

{#r_JSP-setSource_S__table_yps_2rf_zt} {#r_JSP-setSource_S__table_zps_2rf_zt__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 11. Returns]

{#r_JSP-setSource_S__table_zps_2rf_zt}  

    var jspr = new JavascriptProbe('msserv');
    jspr.setName('jsprobe100');
    jspr.setSource('100.100.100.1');