Troubleshooting Workflows

Problems can sometimes arise within a workflow. Quickly troubleshoot workflows to pinpoint the issue, assess the necessary changes, and get the workflow up and running again.

Accessing the Workflow executions page

To begin troubleshooting, access the Workflows Executions details page:

  • Go to Workflows > Manage workflows.

  • Click on the relevant workflow to open the Edit Workflow page.

  • Click the Workflow overview button in the top-right corner of the page to view the Executions page.

After you’ve accessed the Executions details page, select a specific workflow execution. The workflow timeline widget appears.

Using the Workflow timeline

The workflow timeline is a graphical representation of the sequence of events and actions that occurred when the system executed the workflow.

The timeline is organized by:

  • Execution ID: The unique identifier of the workflow execution used in NQL investigations.

  • Current status: The overall status of the workflow at the current point in time.

  • Duration: The total time taken between the start of an execution and when it reaches an end state.

  • Trigger: The method used to trigger the workflow. Methods include:

    • Manual

    • Schedule

    • API

  • Status: A timeline that lists each event in a separate row. Each row displays the following information:

    • The date and time that the system began processing the action.

    • An icon depicting the type of action.

    • The name of the action.

    • The current status of the action.

      • In the case of a condition, this would be the conditional gate that was resolved during the execution.

The status of each action is from the perspective of the workflow itself and pertains to whether it was able to execute the action. This does not directly reflect the status of the Nexthink or 3rd Party modules that are being interacted with.

For example, a Service\API Thinklet has made a call and receives a 200 (OK) response from the 3rd party system, but there is an internal error from the 3rd party system in the response. This is not seen as a failure from the perspective of the workflow.

Action details

To further investigate the status and view more information about a particular action, click on the specific action in the timeline. A pop-up appears with more details displayed for further inspection.

For troubleshooting purposes, the following Thinklets are clickable and provide detailed information for further inspection.

  • Service\API

  • Remote action

  • Campaign

Remote action

When reviewing the details for a remote action Thinklet, the following information is available.

  • Start time: The date and time when the system began processing the Thinklet.

  • End time: The date and time when the system finished processing the Thinklet.

  • Status details: Displayed only when an error has occurred and contains the message describing the fault that has occurred with the remote action.

  • Parameters: Displayed when parameters have been used with this remote action. The contents of the parameters are shown here.

  • Outputs: Displayed when there are outputs that have been captured by the remote action. The contents of the outputs are shown here.

Campaign

When reviewing the details for a campaign Thinklet, the following information is available.

  • Start time: The date and time when the system began processing the Thinklet.

  • End time: The date and time when the system finished processing the Thinklet.

  • State details: Displayed only when an error has occurred and contains the message back from the campaign that may describe the fault.

  • Parameters: Displayed when parameters have been used with this campaign. The contents of the parameters are shown here.

  • Outputs: Displayed where there are collected responses for the campaign. The contents of the outputs are shown here.

Service\API Thinklet

When reviewing the details for a Service\API Thinklet action, the following information is available.

  • Start time: The date and time when the system began processing the Thinklet.

  • End time: The date and time when the system finished processing the Thinklet.

  • Response HTTP code: The response received from the 3rd party API.

  • HTTP method: The HTTP method used by the 3rd party API.

  • Resource path: The resource path endpoint on the 3rd party API that the call is sent to.

  • Payload: The body of the call that the system made to the 3rd party API.

    • In the case of large payloads, hover over the payload to display a tooltip with the full dataset.

  • Outputs: If you have configured the outputs for this Thinklet, the collected data in these outputs is displayed here.

Last updated