Description:

The Ping Server workflow step performs a server ping operation using a specified server host name or IP address and timeout value.

The step supports:

• Specifying a server host name or IP address.
• Specifying a timeout value.
• Testing server reachability through ping.
• Continuing workflow processing through True or False return paths.

Usage:

The Ping Server step can be used when a workflow needs to perform a server ping operation before proceeding with subsequent processing.

A typical workflow pattern is:

Specify Server → Ping Server → Continue or Handle Failure

The workflow supplies the target server through a server host name or IP and a Timeout value. Both inputs are required.

For example:

Start → Ping Server → Continue Processing

Start
  |
  v
Ping Server
  |
  +---- True ----> Continue Processing
  |
  +---- False ---> Handle Unreachable Server

Typical Workflow Suggestions:

Check Server Availability Before Processing

Use the step before a workflow activity that depends on communication with a particular server.

Example:

Start → Ping Server → Execute Server Operation

Ping Server
  |
  +---- True ----> Execute Server Operation
  |
  +---- False ---> Handle Server Unavailable

Validate a Server Before Integration Processing

Use the step before an integration workflow that requires the target server to be reachable.

Example:

Prepare Integration → Ping Server → Start Integration

Configuration:

Server host name or IP: IntegrationServer01
Timeout value: 1000

Check a Server Before File Processing

Use the step before processing files on or through a server that must be reachable.

Example:

Prepare File Processing → Ping Server → Process Files

If the ping produces the alternative result, the workflow can branch to a server-unavailable handling activity.

Validate a Server Before Executing a Scheduled Operation

Use the step at the beginning of a scheduled workflow to check the target server before continuing with processing.

Example:

Scheduled Start → Ping Server → Execute Scheduled Job

Scheduled Start
      |
      v
  Ping Server
   /       \
 True       False
  |           |
  v           v
Execute      Handle
Job          Failure

Route Processing Based on Server Reachability

Use the step to separate normal processing from an alternative path after performing the server ping.

Example:

Prepare Request → Ping Server

                  +---- True ----> Process Request
                  |
Ping Server ------+
                  |
                  +---- False ---> Server Unavailable Handling

Example:

Let’s build and execute the “clsPingStepDef” example.             

• Create a new process definition named “clsPingStepDef” and open it in Designer mode. 
• Drag a "clsPing" step to the canvas.
• Connect the dots between the “Start” and the “clsPing” steps, as shown above. 
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
• Click the “clsPing” step to configure its “Required” properties. Provide a name for the step. Enter the expression to evaluate. Specify a variable or a global to store the expression result. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

• The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. Configure the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.

• Save the process definition, create a new instance, and execute it. As configured, the process step should ping the server. 

• The process step shall generate an error alert if the host is unknown, as shown in the graphic below.

• Navigate to the Status - Log - System Log to view the ping exception requests. 

Tips:

• Enter the correct Server host name or IP.
• Verify that the target server is the intended destination before executing the workflow.
• Provide a suitable Timeout value for the environment.
• The timeout property is a string input and has a default value of 1000. 
• Test the ping against representative servers before deploying the workflow.
• Connect the True path to the processing that should occur when the step produces a True result.
• Connect the False path to appropriate alternative or error-handling processing.
• Use a separate handling path when subsequent processing depends on server availability.
• When moving a workflow between environments, verify the server host name or IP value.
• Avoid assuming that a successful ping guarantees that a particular application, service, port, or API is available.
• Do not assume that the timeout value is measured in a particular unit because the XML does not define the unit.
• Do not assume that the False path represents a specific network error because the XML does not define the runtime conditions.
• Test the workflow under representative network conditions before relying on the result for downstream processing.
• Consider documenting the purpose of the server check when the ping is used as a prerequisite for a larger workflow operation.

Definition Sample:

You may download the sample definition(s) from the link provided and later import them (drag-and-drop) into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

After adding or importing this step into a process definition, verify and complete the environment-specific configuration, including:

• The intended server host name or IP.
• The timeout value.
• The True workflow path.
• The False workflow path.
• Any downstream activities that respond to the ping result.
• The target environment before executing the process.

Click here to download the sample file.