Execution Results

The Execution Results section provides a quick overview of the statistics associated with the consumer executions and portal executions along with the SDK logs.

Let’s understand the option available under Execution Results.

Dashboard

The Dashboard option offers you a consolidated view of all consumer workflow and portal workflow execution status for the selected time period along with a graphical representation for the same.

You can fetch the execution data for a specific duration by selecting the relevant time frame option given on the top-right corner of the screen.

  • 12h: Fetch execution data for last 12 hours from the current time
  • 1 Day: Fetch execution data for the entire previous day as well as the current time of the present day
  • 1 Week: Fetch execution data for the previous week as well as the current time of the present day
  • 2 Weeks: Fetch execution data for the last two weeks as well as the current time of the present day
  • 3 Weeks: Fetch execution data for the last three weeks as well as the current time of the present day
  • 4 Weeks: Fetch execution data for the last four weeks as well as the current time of the present day

You can also view the detailed execution logs for each successful/failed consumer or portal workflow by clicking on the relevant figure.

Based on your selection, you are redirected to Consumer Executions or Portal Executions tab.

From here, you can view the names of the workflows, their status, and detailed execution logs.

Consumer Executions

The Consumer Execution option lets you view and monitor consumer workflow execution-related data in a detailed graphical format.

A workflow can have one of the following status:

  • Successful: Workflow execution is completed successfully.
  • Stopped: Workflow execution is stopped.
  • Running: Workflow is currently being executed.
  • Timeout: Workflow execution has failed to complete in the allotted time.
  • Pending: Workflow execution has not been initiated yet. The workflows with Pending status are executed automatically after a specific time period.
  • Failed: Workflow execution has failed to complete.

Time frame

You can fetch the execution data for a specific duration by selecting the relevant time frame option given at the top-right corner of the screen.

  • 12h: Fetch execution data for last 12 hours from the current time
  • 1 Day: Fetch execution data for the entire previous day as well as the current time of the present day
  • 1 Week: Fetch execution data for the previous week as well as the current time of the present day
  • 2 Weeks: Fetch execution data for the last two weeks as well as the current time of the present day
  • 3 Weeks: Fetch execution data for the last three weeks as well as the current time of the present day
  • 4 Weeks: Fetch execution data for the last four weeks as well as the current time of the present day

You can alternatively specify a custom time frame using the date picker option.

Note: The maximum custom date range that you can specify is last 30 days.

Filters

You can fetch specific consumer workflow execution data based on execution status, solution or template, consumers, instances, BYOW projects, and BYOW workflows.

Filter Types

Execution Status Select one or more execution status from the drop down field to fetch execution details of the associated consumer workflows.

Solution/Template Select one or more solution or template from the drop down field to fetch execution details of the associated consumer workflows.

Consumers Select one or more consumers from the drop down field to fetch execution details of the associated consumer workflows.

Instances Select one or more instances from the drop down field to fetch execution details of the associated consumer workflows.

BYOW Projects Select one or more BYOW projects from the drop down field to fetch execution details of the associated consumer workflows.

BYOW Workflows Select one or more BYOW workflows from the drop down field to fetch their associated execution details.

After selecting the relevant filters, click Apply. This returns the execution details for the consumer workflows that satisfy the specified filter type criterias. To reset the filter back to default, click on Reset.

Example

The filter types work as an AND operation. So, if you select more than one filter type, the result contains only those records that satisfy all the filter type criterias.

Example 1:

Given below is the sample consumer workflow data:

Workflow Name Execution Status Consumer Name
Create Notifications running xyz@example.com
Generate Reports stopped abc@example.com
Approve Leave running abc@example.com

For this data, if you set the following filters:

Execution Status filter: running and success Consumers filter: abc@example.com

The result returns details for following consumer workflow: Approve Leave

View Consumer Workflow Logs

The Executions section lets you view and monitor the execution log for each consumer workflow.

You can select the columns you want to view in the Executions table based on your requirements by clicking on the Settings button located beside the Download Logs option. The Settings button, when clicked, displays a list of column names and allows you to select the columns you want to view in the Executions table. Column names that are not selected stay hidden in the Executions table.

Note: Selecting or deselecting the column - Name and Actions is not supported.

To get detailed information on the performance details of a particular consumer workflow, click on the workflow name.

Here you can view the detailed workflow execution log.

You can optionally export the execution log of a particular workflow to your local machine by clicking on the Export Logs button located at the top right of the screen.

To view detailed information about the configured trigger or actions for the selected workflow, click on the name of the trigger or action.

Download Execution Logs

You can download the workflow execution logs (all or filtered records) either in JSON or CSV format to your local machine. To do this, click Download Logs located on the right side of the screen and select the format of the workflow execution log that you want to download.

The selected execution logs are automatically downloaded as a .zip file to the default download location in your machine.

Important:
  • A maximum of 100,000 execution records are added in a single file inside a compressed zipped folder by default. If the workflow execution logs that you want to download exceed the specified limit, IBM® webMethods Embed automatically generates another file inside the zipped folder, which holds a maximum of 100,000 records. For example, if you have a total of 200,000 execution logs, a zipped folder with two files, each containing 100,000 records is generated and downloaded in your machine.
  • IBM webMethods Embed uses the tenantname_starttimestamp_endtimestamp format to name a zipped folder/file. If you have multiple files created in a zipped folder, the files are named by appending an incrementing number suffix to the zipped folder name.

Portal Executions

The Portal Execution option lets you view and monitor portal execution-related data in a detailed graphical format.

A workflow can have one of the following status:

  • Successful: Workflow execution is completed successfully.
  • Stopped: Workflow execution is stopped.
  • Running: Workflow is currently being executed.
  • Timeout: Workflow execution has failed to complete in the allotted time.
  • Pending: Workflow execution has not been initiated yet. The workflows with Pending status are executed automatically after a specific time period.
  • Failed: Workflow execution has failed to complete.

Time frame

You can fetch the execution data for a specific duration by selecting the relevant time frame option given at the top-right corner of the screen.

  • 12h: Fetch execution data for last 12 hours from the current time
  • 1 Day: Fetch execution data for the entire previous day as well as the current time of the present day
  • 1 Week: Fetch execution data for the previous week as well as the current time of the present day
  • 2 Weeks: Fetch execution data for the last two weeks as well as the current time of the present day
  • 3 Weeks: Fetch execution data for the last three weeks as well as the current time of the present day
  • 4 Weeks: Fetch execution data for the last four weeks as well as the current time of the present day

You can alternatively specify a custom time frame using the date picker option.

Note: The maximum custom date range that you can specify is last 30 days.

Filters

You can fetch specific portal workflow execution data based on execution status, projects, and workflows.

Filter Types

Execution Status Select one or more execution status from the drop down field to fetch execution details of the associated portal workflows.

Projects Select one or more projects from the drop down field to fetch execution details of the associated portal workflows.

Workflows Select one or more workflows from the drop down field to fetch their associated execution details.

After selecting the relevant filters, click Apply. This returns the execution details for the consumer workflows that satisfy the specified filter type criterias. To reset the filter back to default, click on Reset.

Example

The filter types work as an AND operation. So, if you select more than one filter type, the result contains only those records that satisfy all the filter type criterias.

Example 1:

Given below is the sample portal workflow data:

Workflow Name Execution Status Project Name
Create Notifications running Acme Org
Generate Reports stopped Acme Org
Approve Leave running Leave Automation

For this data, if you set the following filters:

Execution Status filter: running and stopped Projects filter: Acme Org

The result returns details for following portal workflow: Create Notifications and Generate Reports

View Portal Workflow Logs

The Executions section lets you view and monitor the execution log for each portal workflow.

You can select the columns you want to view in the Executions table based on your requirements by clicking on the Settings button located beside the Download Logs option. The Settings button, when clicked, displays a list of column names and allows you to select the columns you want to view in the Executions table. Column names that are not selected stay hidden in the Executions table.

Note: Selecting or deselecting the column - Name and Actions is not supported.

To get detailed information on the performance details of a particular portal workflow, click on the workflow name.

Here you can view the detailed workflow execution log.

You can optionally export the execution log of a particular workflow to your local machine by clicking on the Export Logs button located at the top right of the screen.

To view detailed information about the configured trigger or actions for the selected workflow, click on the name of the trigger or action.

Download Execution Logs

You can download the workflow execution logs (all or filtered records) either in JSON or CSV format to your local machine. To do this, click Download Logs located on the right side of the screen and select the format of the workflow execution log that you want to download.

The selected execution logs are automatically downloaded as a .zip file to the default download location in your machine.

Important:
  • A maximum of 100,000 execution records are added in a single file inside a compressed zipped folder by default. If the workflow execution logs that you want to download exceed the specified limit, IBM webMethods Embed automatically generates another file inside the zipped folder, which holds a maximum of 100,000 records. For example, if you have a total of 200,000 execution logs, a zipped folder with two files, each containing 100,000 records is generated and downloaded in your machine.
  • IBM webMethods Embed uses the tenantname_starttimestamp_endtimestamp format to name a zipped folder/file. If you have multiple files created in a zipped folder, the files are named by appending an incrementing number suffix to the zipped folder name.

Restart Portal Workflows

The Restart feature allows you to restart the execution of your failed, timed out, and stopped workflows.

Note: The Restart option is only available for workflows that were executed through a Webhook or Trigger.

Since this feature works at workflow-level, you must enable it for each workflow that you may want to restart in the future. To enable this feature for a workflow, navigate to the Workflow -> Workflow Settings and then select the Save status of each successfully executed action checkbox under the Execution Settings tab.

You can restart one or multiple workflows as per your requirements.

Restarting a single workflow

You can Restart the Workflow executions from the main execution listing page of the Monitor tab. This option is provided under the Actions column.

If you have enabled the Restart feature for your workflow and the workflow fails, times out, or is stopped, the Restart button appears in the execution log of that particular workflow.

When you click on the Restart button, a dialog box appears on screen where you are prompted to specify whether you would like to modify the webhook payload data before restarting the workflow or restart the workflow directly.

If you don't want to modify webhook payload data, click Restart. This restarts the workflow execution using the existing webhook payload immediately.

If you want to modify the webhook payload data before restarting the workflow, click Edit Payload.

Once you have modified the webhook payload as per requirement, click Restart. This restarts the workflow execution using the modified webhook payload.

When you are redirected to the Execution Logs page, you can refresh the page by clicking the Refresh icon located on the left side of the screen. When you click this icon, the latest status of the workflow execution is automatically fetched in the Execution Logs.

Restarting multiple workflows

You can select multiple failed Workflow executions to restart in just one click. To achieve this, in the Executions table, select the checkbox beside the name of failed workflows and click the Restart button.

Important:
  • While restarting multiple workflow executions, if one of the selected workflows fails, times out, or stops, make necessary changes to the corresponding workflow from the canvas only. Modifying the webhook payload data is not supported when you restart multiple workflows.
  • You can select a maximum of 150 workflow executions to restart at a time.

Resume Workflows

The Resume feature allows you to resume the execution of your failed and timed out workflows. Since this feature works at workflow-level, you need to enable it for each workflow that you may want to resume in the future. To enable this feature for a workflow, navigate to the Workflow -> Workflow Settings and then select the Save status of each successfully executed action checkbox under the Execution Settings tab.

Note: You can Resume the Workflow executions from the main execution listing page of the Monitor tab. This option is provided under the Actions column.

If you have enabled the Resume feature for your workflow and it fails, you see the Resume button in the execution log of that workflow.

When you click the Resume button, a dialog box appears where you are prompted to specify whether you would like to edit the input JSON data of failed action(s) before resuming the workflow execution or resume the workflow execution directly.

Click Resume to immediately resume the workflow execution from the point it failed in the previous run.

Click Edit Input to modify the input JSON of failed action(s).

Click Resume. This resumes the workflow execution from the point it failed in the previous run, using the modified JSON input data for failed actions. After this, you are redirected to the Execution Logs page. Next, refresh the page by clicking the Refresh icon located on the left side of the screen. Clicking on this icon fetches the latest status of the workflow execution in Execution Logs.

If the workflow is executed successfully, the execution status of the workflow is changed from Failed to Success. Moreover, when you click the workflow execution log, you can see the complete execution log details (previously failed action logs and current successfully executed action logs).

SDK Logs

The SDK Logs menu lets you view the logs associated with the IBM webMethods Embed SDK requests. The log records include details such as the timestamp, consumer identifier, module, operation, as well as action control items.

Click on View option to view the detailed SDK log.