Monitor

Track and monitor execution status, set up automated alert rules, and view user activities.


The Monitor tab has three sections, namely Execution Results, Alert Rules, and General, located on the left of the screen which allow you to carry out different operations.

Notes

  • Any time stamp displayed in webMethods.io Integration is based on the user’s registered time zone specified in Software AG Cloud. Note that not all the time zones in Software AG Cloud are supported in webMethods.io Integration. If a time zone in Software AG Cloud is not supported, then the time stamp in webMethods.io Integration defaults to the Pacific Standard Time (PST) time zone. To change the time zone for a user profile, using the App Switcher, go to My Cloud and in Software AG Cloud, click My Cloud > Administration. On the Administration page, edit the user profile. Under Locale Information, select the required time zone. Save the changes, log out, and then again log in to see the changes.
  • You can see FlowService-related options only if you have enabled FlowServices for your tenant. Know more about how to enable FlowService.

Let’s understand each of these sections in detail.

Execution Results

The Execution Results section provides a quick overview of the statistics associated with the workflow executions and FlowService executions (if enabled) along with their respective execution logs.

In the Monitor page, click on Execution Results as shown below:

Let’s now glance through the options provided by the Execution Results:

Dashboard

Note: This option will only be visible for users who have enabled FlowService for their tenant.

The Dashboard option offers you a consolidated view of all Workflow and FlowService 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.

You can also view the detailed execution logs for each successful/failed Workflow and FlowService by clicking on the relevant figure as shown below:

This will take you to a new screen where you can click the relevant workflow/FlowService name to view the detailed execution log associated with it.

If you want to view a detailed execution log for successful FlowServices, click on the relevant figure. This will take you to the following screen:

Workflow Execution

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

A workflow can have one of the following status:

Note: The transaction consumption calculation is done based on the duration in which the workflow completes execution. This duration includes the time taken for the pre-processing activities such as fetching metadata, the post-processing activities, and the actual workflow execution.


Due to this, the duration shown in the workflow execution log can sometimes be greater than the elapsed time which indicates the total time taken for workflow trigger/action execution.


Using filters to fetch specific workflow execution data

You can fetch specific workflow execution data for a certain time frame and/or a certain project, workflow, and execution status.

Fetching workflow execution data for specific 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.

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

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

Fetching workflow execution data associated with specific projects, workflows, and execution status

You can fetch the execution data associated with one or more projects, one or more workflows, and one or more execution status. This can be achieved by applying the filter criteria.

To apply a filter, click on the Filters option.

You will see the following three filter criteria:

Once you select the required filter options, click on Apply. Doing this will display the execution details (in a graphical format) and execution logs for the selected projects and workflows.

To reset the filter back to default, click on Reset.

Viewing Workflow Execution Logs

The Workflow Execution option lets you view and monitor the execution log for each workflow that you execute.

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

Clicking on the workflow’s name will take you to a screen having complete execution log information about that particular workflow. You can optionally export the execution log of a particular workflow to your local machine by clicking on the Export Log button located at the top right of the screen.

Resuming Workflows

The Resume feature enables you to resume execution of a workflow right from the point it fails. Since this feature works at workflow-level, you need to enable it for each workflow that you may want to resume in the future.

Note: To enable this feature for a workflow, navigate to the Workflow -> Workflow Settings and then check the Save status of each successfully executed action checkbox under the Execution Settings tab.

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

When you click on the Resume button, a dialog box will appear where you will be prompted specify whether you’d like to edit the input JSON data of failed action(s) before resuming the workflow execution or resume the workflow execution directly.

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

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

Once this is done, click Resume. This will resume the workflow execution from the point it failed in the previous run, using the modified JSON input data for failed actions.

Note: After clicking on the Resume button, you will be redirected to the Execution Logs page. Next, you will need to refresh the page by clicking on the Refresh icon located on the left side of the screen. Clicking on this icon will fetch latest status of the workflow execution in Execution Logs.

If the workflow is executed successfully, you will see that 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).

Restarting Workflows

The Restart feature enables you to restart execution of your failed webhook-run workflows. Since this feature works at workflow-level, you need to enable it for each workflow that you may want to restart in the future.

Note: To enable this feature for a workflow, navigate to the Workflow -> Workflow Settings and then check the Save status of each successfully executed action checkbox under the Execution Settings tab.

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

When you click on the Restart button, a dialog box will appear on screen where you will be prompted to specify whether you’d 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 on Restart. This will restart the workflow execution using the existing webhook payload immediately.

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

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

Note: After clicking on the Restart button, you will be redirected to the Execution Logs page. Next, you will need to refresh the page by clicking on the Refresh icon located on the left side of the screen. Clicking on this icon will fetch latest status of the workflow execution in Execution Logs.

FlowService Execution

Note: This option will only be visible for users who have enabled FlowService for their tenants.

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

A FlowService can have one of the following status:

You can optionally terminate the ongoing FlowService executions from the FlowService Execution details page. To do so, navigate to the Running Executions section and hover over the relevant FlowService name. You will see the Terminate button placed against the FlowService name. Click the Terminate button to terminate the ongoing FlowService execution.

Note: The Terminate button is available for ongoing FlowService executions only.

Using filters to fetch specific FlowService execution data

You can fetch specific FlowService execution data for a certain time frame and/or a certain project, FlowService, and execution status.

Fetching FlowService execution data for specific 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.

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

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

Fetching FlowService execution data based on execution source, project, FlowService, execution status, and context ID

You can fetch the execution data associated with an execution source, a project, a FlowService, an execution status, and the context ID. This can be achieved by applying the filter criteria.

To apply a filter, click on the Filters option.

You will see the following filter criteria:

Notes:

  • Currently, you can select only one Execution Source from the drop-down list.
  • Selecting values in other filters first and then in the Execution Source will automatically clear all the applied values in other filters.
  • By default, selecting REST APIs or SOAP APIs as the Execution Source will replace the filter - FlowServices with the filter - REST API or SOAP API respectively. You can then choose one or more APIs (REST API or SOAP API) from the drop-down list to fetch the FlowService execution data. On the other hand, selecting Scheduler, User Interface, HTTP Interface, Workflow Interface, Streaming, or JMSTrigger as the Execution Source will not affect other filters.

  1. In a FlowService, select the SetCustomContextID service available in the Flow category. It is recommended to add the setCustomContextID service as the first step in a FlowService.

  2. In the mapping editor, set a value for the id field and then save and run the FlowService.

    Note: The maximum number of characters supported for the id field is 36. If you specify more than 36 characters, the remaining characters will be truncated.

  3. Search for the custom context ID in the Monitor > Execution Results > FlowService execution page by clicking Filters and by specifying the custom context ID in the Context ID field.

  4. Once you select the required filter options, click Apply.
    The execution details will be displayed in a graphical format and the execution logs will appear for the selected filter criteria. To reset the filter back to default, click Reset.

Viewing FlowService Execution Logs

The FlowService Execution option lets you view and monitor the execution log for each FlowService that you run.

You can optionally download the execution logs of FlowServices to your local machine by clicking Download Logs as shown:

To view the detailed execution logs, click on the name of the relevant flow.

This will take you to a screen having complete information about that particular FlowService.

The execution page displays the total number of documents processed by the FlowService, the number of documents processed successfully, the number of documents that did not process successfully, and the success score.

Next, to view detailed information about operations for the selected FlowService, click on the name of the operation as shown below:

You can view additional information about operation execution including Details, Results, and Business Data. Click on the relevant options to view the required information.

By default, all FlowService execution logs are retained for 30 days. You can optionally specify the number of days (up to 30) for which you would like to retain the FlowService execution logs by clicking the Modify Retention Period link. Once the retention period is over, the FlowService execution logs are deleted automatically.

Alert Rules

webMethods.io Integration allows you to set automated alert rules for your projects to send notifications to specific users when a workflow or FlowService fails, timeouts, or completes execution.

In the Monitor page, click on Alert Rules as shown below:

Workflow Alerts

The Alert Rules option lets you send alert notifications to specific recipients when a certain event(s) occur during workflow execution. This will help you keep relevant users updated about the status of workflow executions.

Adding Workflow Alert Rules

To add a new alert rule, navigate to tenant homescreen-> Monitor-> Workflow Alerts.

Click on the Add Alert button located at the right of the screen to create a new alert rule.

You will be redirected to a New Workflow Alert configuration screen.

In the New Workflow Alert configuration screen that appears, enter the details as given below:

Once you have entered these details, click Save. This will add the specified alert rule for your tenant. By default, the status of the added alert rule will always be inactive. You will have to manually activate the alert rule by using the Active toggle button.

After this, whenever the selected workflow fails, timeouts, completes execution, an alert notification will be sent to the specified email address.

Managing Workflow Alert Rules

When you click on the Workflow Alerts, you will view all the list of existing alert rules for your tenant. Here, you can see the name of the alert rule, along with its description and status (active/inactive).

Note: webMethods.io Integration provides the following options when you set an alert rule for workflows:

  • Use custom sender address for alert email notifications: Previously, all alert email notifications were sent from the default sender address set by webMethods.io Integration. You can now use your own SMTP configurations to send alert email notifications from a custom sender address. To do so, you will need to share the relevant details of your SMTP configuration with our Customer Service team, which in turn will set up a custom SMTP config in our internal portal.
  • Display tenant name in the subject of the alert email notification: All alert email notifications will now contain the name of the tenant for which the notification is created. This will help you to clearly distinguish between alert notifications of different tenants. Subject format: webMethods.io Integration alert -<workflow_name> from Tenant: <tenantname>
  • Display tenant timezone in alert email notifications: Previously, all alert email notifications had the UTC timezone. Now, each alert email notification will display the relevant time zone of the tenant for which the notification is created.

FlowService Alerts

Note: This option will be visible only to users who have enabled the FlowServices capability.

The Alert Rules option lets you send custom notifications to specific recipients when a certain event(s) occur during FlowService execution. This will help you keep relevant users updated about the status of FlowService executions.

Adding Alert Rules

To add a new alert rule, navigate to tenant homescreen-> Monitor-> FlowService Alerts.

Click on the Add Alert button located at the right of the screen to create a new alert rule. Along with a new alert rule, you can also add an alert frequency period (5 mins, 10 mins, or 15 mins) to specify how often the alert rule should be run.

You will be redirected to the New FlowService Alert configuration screen.

In the New FlowService Alert configuration screen that appears, enter the details as given below:

Once you have entered these details, click Add. This will add the specified alert rule for your tenant. After this, whenever the selected flow fails, timeouts, completes execution, an alert notification will be sent to the specified email address.

Note: If you delete a FlowService from your tenant, the alert rule (if added) associated with that FlowService will be automatically removed from the list of existing alert rules.

Managing FlowService Alert Rules

Note: You can select the alert frequency period (5 mins, 10 mins, or 15 mins) to send email messages as per your requirements by clicking on the drop-down arrow beside Alert Frequency.

When you click on the FlowService Alerts, you will view all the list of existing alert rules for your tenant. Here, you can see the name of the alert rule, along with its description and status (active/inactive).

General

The General section allows you to view, track, and monitor your tenant activities through the Audit Logs and view the current month’s transaction usage statistics for your transaction-based tenants.

In the Monitor page, click on General as shown below:

Audit Logs

The Audit Logs section maintains a record of all the activities performed by the user. It maintains a history of all the actions that are performed within a tenant, including details such as the type of action performed, the user performing the action, and date/time.

To access the tenant audit logs, navigate to tenant homescreen and then click Monitor > Audit Logs.

Using Filters in Audit Logs

You can apply filters on the audit logs to retrieve specific logs.

Filter Logs by Time-range Selector

You can view audit logs for a certain time frame using the date picker located at the top-right corner of the Audit Logs screen.

By default, you will see the logs from the last 12 hours. You can either choose the time-range menu to select the required time range or specify the start and end date to fetch the audit logs created between them.

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

Filter Logs by Search Query

webMethods.io Integration allows you to perform two types of searches, namely, Simple Search and Advanced Search to search and view log events as per your requirements. You can search and filter a set of particular log entries by specifying a search term or a query expression in the search query box. Let’s now understand each of these search capabilities in detail.

You can quickly search through your audit logs by entering a search term in the search query box to fetch specific log details.

A search term can consist of a word (such as John or Doe) or a phrase (like untitled workflow). When you enter a search term, webMethods.io Integration searches across all columns to retrieve log entries containing the specified word or the phrase.

Note: By default, search queries are not case-sensitive.

For instance, to fetch all log details associated with a Default project, you can simply enter Default or default.

Notes:

  • webMethods.io Integration allows you to perform searches on columns - Module, Title, and Action. In addition, the platform allows you to perform searches on other attributes - Module ID and Metadata.
  • You can perform a partial text search for the column - Title, which means all records containing the specified search term will be retrieved. However, for other columns - Module and Action, and for other attributes - Module ID and Metadata, you will need to enter a search term that exactly matches your target keyword.

Similarly, if you want to fetch details of all untitled workflows, you can type the phrase Untitled Workflow or untitled workflow in the search query box.

You can perform an advanced search on your logs to narrow down your searches and form complex queries and fetch specific log details

This functionality allows you to search for a particular set of log entries that satisfy the condition specified in a query expression. A query expression consists of multiple search terms in conjunction with operators.

Notes:

  • webMethods.io Integration allows you to perform searches on columns - Module, Title, and Action. In addition, the platform allows you to perform searches on other attributes - Module ID and Metadata.
  • You can perform a partial text search for the column - Title, which means all records containing the specified search term will be retrieved. However, for other columns - Module and Action, and for other attributes - Module ID and Metadata, you will need to enter a search term that exactly matches your target keyword.
  • By default, search queries are not case-sensitive.
  • Operators are case-sensitive and hence, always should be capitalized. Operators written in lowercase are considered as search terms.

Supported Query Expressions

Using an advanced search capability, you can combine multiple search terms with different operators to perform a more specific search. A query expression can either consist of multiple search terms separated by commas or multiple search terms grouped together with parentheses.

Following are the different query expressions that you can perform:

A query that has search terms separated by a comma returns log entries containing the specified values in the same row. For example, the query - Project, Delete - will search for log entries containing Project and Delete in the same row.

A multiple query that has search terms joined by an OR operator with each query grouped tog ether with parentheses returns log entries containing either or both of the search terms in the same row.

For example, the query - (Project, Delete) OR (Untitled Workflow) - will search for log lines containing either Project and Delete or Untitled Workflow or both in the same row.

A query with field-based searches returns the log entries where the attribute equals the specified value in the same row.

For example, the query - (module: project, action: create) will search for log lines where the module - project equals action - create in the same row.

Supported Operators

A query expression allows the following operators:

Operator Example Description
OR (Project, Delete) OR (Default) Searches for log entries containing either or both of the specified search terms in the same row
, (comma) Project, Delete Searches for log entries containing all the specified search terms in the same row
: (colon) (module:project, action:delete) Searches for log entries where the field equals the specified value

Example Query Expressions

Following are examples of a few query expressions for searching a specific set of log entries:

Query Expression Description
workflow, delete Retrieve log entries containing workflow and delete in the same row
created, johndoe@example.com Retrieve log entries for which the ‘Created’ action is performed by ‘johndoe@example.com’
(created, johndoe@example.com) OR (updated, johndoe@example.com) Retrieve log entries for which the ‘Created’ or ‘Updated’ action is performed by ‘johndoe@example.com’
(published, janesmith@example.com ) OR (published, johndoe@example.com ) OR (published, veronicasmith@example.com ) Retrieve log entries for projects that are published by ‘janesmith@example.com’ , ‘johndoe@example.com’ , or ‘veronicasmith@example.com’
(module: project, action: delete) Retrieve log entries where the column fields - ‘module’ and ‘action’ equal values - ‘project’ and ‘delete’ respectively

Downloading Audit Logs

You can download the audit logs (all or filtered records) either in JSON or CSV format to your local machine.

To do this, click the Download Logs button located at the upper-right corner of the Audit Logs screen.

Next, select the desired format type of audit log report that you want to download.

With this, the required audit logs will be downloaded to the default download location in your machine.

Usage

For all transaction-based tenants, a certain number of transactions are allocated to their account depending on the selected plan on a monthly basis. You can view the current month’s transaction usage statistics of your transaction-based tenants through the Usage tab.

Note: You can see this option only if transactions are enabled for your tenant.

To view the transaction usage of your tenant, navigate to the homescreen and then click Monitor > Usage.

Here, you can check the number of transactions already consumed by your tenant workflows and FlowServices out of the total allocated transactions, for the current month.
If you’d like to upgrade your plan to get more transactions, get in touch with our support team by clicking the Contact Support link.