Create a probe activity · SN Doc Reader

Create an activity that runs a probe on the target host that is configured to return specific information..

Before you begin

Role required: activity_creator or workflow_admin

About this task

For instructions on using the activity template process flow, see create custom activities.

Procedure

Create a custom activity.

This action creates a custom activity using a template.
After setting up general properties and creating input variables, configure the Probe Execution Command.

Map the input variables	Use the variables you created to configure the command that Orchestration executes.
Probe	Probe to run with this activity, from the list of probes in the system
Target host	Host name or IP address of the target server for this activity.
Parameters	MID Server to use, by capabilities.
Required MID Server capabilities	Name-value pairs to pass to the host with this probe. You can create these parameters manually, or drag and drop input variables into the parameter 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/orchestration/automap-output-variable-inputs.md).

What to do next

Use auto-mapping to generate outputs and parsing rules
If you do not use auto-mapping, you can manually create output variables and create parsing rules

Parent Topic:Orchestration custom activity templates

Probe template execution parameters

You use execution parameters to create the input process script in the Pre Processing form.

For descriptions of the command fields, see Configure the Probe execution command.

Note: You must use the executionParam. prefix with all variables in this table.

Name	Variable	Type	Usage
Probe	probe	Reference	The sys_id of the MID Server probe.
Source	source	String	Intended target host
Parameters	parameters	Array of JS 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); Text </td></tr><tr><td> MidCapabilities </td><td> midCapabilities </td><td> String \(comma separated\) </td><td> List of required MID server capabilities. </td></tr><tr><td> ValueCapabilities </td><td> valueCapabilities </td><td> Array of hashmap </td><td> Capability values used to select the MID Server. For more information, see [MID Server capabilities](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown). 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);

Name

Variable

Type

Usage

Probe

probe

Reference

The sys_id of the MID Server probe.

Source

source

String

Intended target host

Parameters

parameters

Array of JS 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);

Text

</td></tr><tr><td>
MidCapabilities
</td><td>
midCapabilities
</td><td>
String \(comma separated\)
</td><td>
List of required MID server capabilities.
</td></tr><tr><td>
ValueCapabilities
</td><td>
valueCapabilities
</td><td>
Array of hashmap
</td><td>
Capability values used to select the MID Server. For more information, see [MID Server capabilities](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown). 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);

## Probe template post-processing parameters

Use these parameters to create a post-processing script.

Name	Variable	Type	Usage
Payload	payload	String	Contains raw payload returned from the probe.
Output	output	String	Contains output data returned from the probe.
EccSysId	eccSysId	String	Contains the reference ID associated with the ECC Queue input message.

Configure the Probe execution command

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

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 activity 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

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.

[Omitted image "ProbeExecutionCommand.png"] Alt text: Probe execution command

Complete the fields shown in the table.

Field	Description
Input	Input variable builder. Create input variables to map to available fields.
Probe	Probe to run with this activity, from the list of probes in the system.
Target host	Host name or IP address of the target server for this activity.
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 and drop input variables into the parameter fields and assign a value.

Click Save.
Click Continue to advance to the Outputs stage.

title	Create a probe activity
description	Create an activity that runs a probe on the target host that is configured to return specific information..You use execution parameters to create the input process script in the Pre Processing form.Use these parameters to create a post-processing script.Use the input variables you created to configure the command that Orchestration executes on the target.
locale	en-US
canonical_url	https://www.servicenow.com/docs/r/australia/servicenow-platform/orchestration/t\_CreateAProbeActivity.html
release	australia
product	Orchestration
classification	orchestration
topic_type	task
last_updated	2026-09-10
reading_time_minutes	4
breadcrumb	Orchestration custom activity templatesOrchestration activity designerClassic OrchestrationServiceNow AI Platform Additional CapabilitiesExtend ServiceNow AI Platform capabilities