In this section, we will take a deep dive into the message box data monitoring screen to understand the functionality of every option and controls present in the screen. The first and foremost step in Message Box Data Monitoring is to Create an Alarm and map the alarm for data monitor alerts. Click here to understand the process of creating a data monitor alarm. Without creating an alarm, when you try to create a data monitoring, you will see an error message as:
- Choose Alarm - As mentioned above, the first step to set up message box data monitoring is to create an alarm. Once you have created the alarm, the alarm name will be displayed in the drop down. Select the alarm that should be used for message box data monitoring purposes.
- Monitor Name - A meaningful name for the Message Box Data Monitor. Say, as per your requirement you want to terminate the suspended instances after every 15 minutes when the count goes above 20. The monitor name can be set as "Terminate suspended instances every 15 minutes when count > 20".
- Query Type - This section is very similar to the Message Box (Queries) section in BizTalk360. Select the type of query for which you want to run the data monitor. As per the above requirement, since we are looking for suspended instances, select 'Suspended Service Instances' from the drop down.
- Add a filter - To filter the query results based on different parameters (application name, host name, instance status, service class, service instance id, service name, service type id)
- Warning Threshold - Select the value from the drop down on when you want to be notified when there is a warning. The first drop down is to select the Operator (> or =) and the second operator is to select the warning value. For e.g., When number of service instances are > 10, throw a warning
- Error Threshold - Select the value from the drop down on when you want to be notified when there is an error. The first drop down is to select the Operator (> or =) and the second operator is to select the warning value. For e.g., When number of service instances are > 20, throw an error
- Send Instance Detail In Notification - Selecting this check box will send the instance details and exception description in the notification email when the number of instances exceed the warning and/or error threshold level
How often you want to monitor - Select the duration how often you want to monitor for suspended service instances. The options are - Daily, Weekly, and Monthly. Depending on the selection, you can add further filter criteria on how often you want to monitor.
- Daily - will set up the data monitor to execute everyday
- Weekly - The data monitor will execute on the selected days of the week (Every Day, Monday-Friday, or the selected day of choice). To add a single day of the week, click the control and select the day of your choice.
Monthly - The data monitor will execute on the selected day of the month. To add a specific day of the month, enter the date in the space provided or select the date from the drop down. If a particular day is not present in the month (say, 29th Feb), then system will skip that month and generate the results on the specified day in the next month.
When during the day - Select the time when the data monitor must execute on a particular day during the business hours. You can customize your business hours by selecting the values from the Business Day Start and Business Day End options. By default, the business day start time is 9 AM and business day end time is 5 PM.Depending on the business hour selection, the following options are available when you want the data monitor to execute on a particular day.
At the end of the business day - If this option is chosen, the data monitor will execute depending on the value chosen in the Business Day End field. For e.g, if the business end time specified is 5 PM (default value), the data monitor will execute exactly at 5 PM.
Monitor every X minutes/hours - You can define specific intervals during the business hours when the data monitor should execute. The options available are Minutes and Hours.
The minimum time interval supported is 15 minutes, which means the data monitor will execute 4 times (15 minutes x 4 = 60 minutes) in an hour.The minimum time interval supported is 1 hour.
- Minutes - Select the number of minutes after which the data monitor should execute. E.g., 30 minutes means the data monitor will execute once in every 30 minutes.
- Hours - Select the number of hours after which the data monitor should execute during the business hours. E.g., 2 hours means the data monitor will execute once in 2 hours between 9 AM and 5 PM.
Advanced - This section can be used to define advanced settings for data monitoring. You can define a date range (from date and to date) when you want the data monitor to execute. You can set up a data monitor to start, say, on a Monday and end on the next Tuesday. In addition to this, you can set up the other settings mentioned above in the previous steps. This means the data monitor will only start to run next Monday and will not execute after Tuesday.
By default, the Advanced section will be in Collapsed state. Click the '>' button to expand the Advanced section and make the settings.
- Based on only Query result count (no date/time filter) - Selecting this option will execute the query based on the setting for trigger time (Defined under 'At what time' as explained above in step 10). Say, the monitor at set frequency is set to every 15 minutes, the query execution will happen once in every 15 minutes till the specified end time.
- Based on Query result with date/time range - Selecting this option will activate the "Choose date/time column" drop down from where the appropriate option can be selected (Creation Time). When selected, the query will be constructed with the from/to date time filter based on the selected date/time column, and execute the query with the time range.
- Is Action Required - Selecting this check box will automate the tasks such as regularly terminating instances, resuming instances and so on. You can define an action such as "Whenever there are Suspended (Non-Resumable) service instances during the monitoring time range, the system should automatically terminate them. Similarly, whenever there are Suspended (Resumable) instances, the system can automatically Resume these messages.The following options are available for the Is Action Required setting:
- When to Action - Defines when you need to take an action - Always (or) when there is an error condition (or) a warning condition. You need to be cautious about enabling it, since some of the actions performed by the system cannot be undone.
What Action - Defines what action needs to be taken - Resume (or) Suspend (or) Terminate. You need to be cautious about enabling it, since some of the actions performed by the system cannot be undone.From version 7.10 (7.9.9998.3106), we have added an additional functionality to be able to archive the service instances before terminating them. When you select the action as "Terminate", you will notice a check box as "Archive message(s) content & context associated before Terminate". Selecting the check box will automatically back up the service instance details to a folder and then terminate the instance. Click here to read about the functionality in detail.
- Summary - The summary information will automatically be populated based on the information selected in the previous columns
Save & Close - Once all the values are selected in the previous steps, click Save & Close to save the settings
- Save & Add Another - The entered values will be saved and a new screen will be displayed to create another data monitor
- Close - Click Close to discard the changes. When the close button is clicked, system will display a confirmation message as "There are unsaved changes, do you still want to close?". Click Yes to close the Data Monitoring creation window. Click No to remain on the same page.
- General guideline - Provides information about the operations that can be performed in the current screen
Archive And Terminate Suspended Service Instances
In version 7.9.9998.3106, we have added the functionality to be able to archive the suspended service instances (to a specific location) before the message box data monitor automatically terminates the suspended service instances. For more information about this functionality, please refer this article.
Operational Automation Capabilities
In version 7.9.9998.3106, we have added the functionality for administrators to be able to automatically receive the message payload information (message context + message content) in the email notification from BizTalk360 system. In addition, users can choose to receive the context properties that are associated with the message in the notification email. The context property information will be made available in a Summary CSV file. For more information about this functionality, please refer this article.
Ability To Retry Suspended Service Instances
In version 7.9.9998.3106, we have added the capability for BizTalk360 monitoring service to automatically perform retries on suspended service instances depending on the value set in the Message Box Data Monitor. For more information about this feature, please refer this article.