Predefined Templates

Predefined Templates

Users are provided with predefined templates to streamline the process of creating automated tasks efficiently. These templates serve as a quick-start guide, offering pre-configured settings and structures tailored for common use cases.

Below are the available templates, each designed to address specific operational requirements  with Instant Workflow steps :

1. Shutdown Artifacts for Maintenance - Automates the process of stopping selected application artifacts during maintenance windows.

2. Resume Artifacts After Maintenance - Simplifies the reactivation of artifacts after maintenance.

3. Restart Artifacts to Handle Unprocessed Files - Facilitates restarting artifacts to manage and process unhandled or pending files.

4. Free Up Disk & Database Space -Automates the cleanup of disk and database resources by removing temporary or redundant files.

5. Reverse Workflow Action - Enables the rollback or reversal of specific custom workflows to a previous state.

To create Automated Task Using Predefined Template Navigate to Environment Settings→ Administration →Automated Tasks → Predefined Templates.

1.Shutdown Artifacts For Maintenance

Users can utilize this template to efficiently manage maintenance activities, ensuring dependent artifacts are stopped to prevent any false transactions.

This template enables users to quickly perform the actions such as to Stop artifacts ,Stop host instances ,Turn off tracking ,Disable conflicting alarms ,Disable event log collections and Back up the BizTalk database

Quick Action Steps

The Quick Action Configuration feature allows users to create instant workflow steps for a selected application. To configure, simply select the application for which you want to perform the actions.

This template empowers users to quickly perform the following predefined actions:

• Stop Artifacts - Adds steps to stop all Send Ports and disable all Receive Locations associated with the selected application.

• Stop Host Instances -Adds steps to stop all host instances mapped to the selected application.

• Turn Off Tracking- Includes steps to disable tracking (Ports, Schemas, Pipelines) for the selected application.

• Disable Conflicting Alarms -If the selected application is mapped for monitoring, this step ensures that related alarms are disabled to prevent false notifications during maintenance.

• Disable Event Log Collection-Prevents BizTalk360 from collecting data when the server is down during maintenance.

• Backup BizTalk Database - Includes a predefined script to back up the BizTalk database, which is recommended before deployment.

These predefined steps are designed to streamline maintenance and operational tasks. However, users have the flexibility to modify these steps at any time to suit their specific requirements.

By enabling the option "Sync new artifacts created in the selected application to the template-related steps," any newly added artifacts within the selected application will automatically be included in the workflow actions. For instance, if new artifacts are added to the selected application, they will be automatically updated in the action steps.

2.Resume Artifacts after Maintenance

This template is for restarting artifacts after the maintenance activities are complete. The tasks in this template include below instant workflow steps :

• Start Artifacts: Starts the Send Ports and enables Receive Locations.

• Start Host Instances: Restarts all host instances related to the selected application.

• Turn On Tracking: Resumes tracking for Ports, Schemas, and Pipelines.

• Enable Conflicting Alarms: Reactivates alarms that were disabled during maintenance.

• Enable Event Log Collection: Resumes event log collection for monitoring.

• Back Up the BizTalk Database: Executes a script to back up the BizTalk database (often recommended after the maintenance process).

3.Restart Artifacts to Handle Unprocessed Files

This automatic action streamlines file processing by resolving scenarios where files become stuck due to network issues or other disruptions. By monitoring the age of files in designated receive locations, the system can automatically restart the relevant send ports or receive locations if a file remains unprocessed for too long, even when the port itself is enabled.

For example, a purchase order file for Supplier A has been stuck in the receive location for 45 minutes due to a network issue. Once the system detects that the file has exceeded the configured threshold, it automatically restarts the receive location or send ports associated with Supplier A's orders. This restart re-establishes the connection, allowing BizTalk to promptly process the file and ensuring the order is managed efficiently without requiring manual intervention.

Quick Action Steps

• Restart Receive Location-Steps have been added to configure the automatic restart for receive locations. All receive ports mapped for location monitoring will be displayed. Users can select the relevant file-monitored ports and set a file age threshold. For example, configure the system to restart the respective ports if the file age exceeds 1 hour.

• Restart Send Ports -Steps have been added to configure the automatic restart for send ports. All send ports mapped for location monitoring will be displayed. Users can select the relevant file-monitored ports and set a file age threshold. For instance, configure the system to restart the respective ports if the file age exceeds 1 hour.

The video below demonstrates how to configure ports for automatic restarts effectively.

4.Clean Disks & Database Space

In a BizTalk environment, maintaining optimal performance and avoiding bottlenecks often requires regular cleanup tasks, such as Message Box Spool Cleanup, Tracking DTA Purge & Archive, and Disk Cleanup. These tasks prevent database bloat, free up system resources, and ensure smooth operations.

This task helps to clean up your Disk and Database space with predefined clean up scripts for Message Box Spool Clean up , Tracking DTA purge , Disk cleanup in BizTalk environment

Quick Action Steps

• MessageBox Spool Cleanup :A predefined script has been introduced to monitor the MessageBox spool size. When the spool size reaches its maximum record limit, the cleanup jobs—MessageBox_Message_Cleanup_BizTalkMsgBoxDb and MessageBox_Parts_Cleanup_BizTalkMsgBoxDb—will automatically execute.

  To ensure successful execution, users must specify the correct server name. The script includes the variables: $SqlInstanceName $DatabaseName $MessageCleanupJobName $PartsCleanupJobName $MaxRecords. Users can modify these variable values to suit their business requirements.

• Tracking DTA Purge & Archive: Predefined scripts are available to monitor the tracking database size. If the database size exceeds the defined maximum limit, the script will purge the tracking DTA table.

  The script includes the variables: $SqlInstanceName $DatabaseName $JobName $MaxAllowedSizeMB .Users can adjust these values to set the desired maximum database size.

• Disk Cleanup :A script has been added to clean up the Recycle Bin and specified folders. Users can define the folder paths and the retention period (number of days to retain records) through the script variables.

5.Reverse Workflow Action

This template is designed to reverse any custom workflow actions. For example, if you create a step to start an application, its artifacts, host instances, alarms, and tracking, this task will stop all those components. It allows you to create a task to reverse a custom workflow by defining alternate actions for applications, application artifacts, host instances, alarms, and tracking. This task is ideal for undoing previously executed actions, effectively turning off components that were turned on, and vice versa.

For an instance ,During a disaster recovery (DR) drill, a secondary BizTalk environment is activated. A workflow is used to start all applications, artifacts, host instances, alarms, and tracking in the DR environment. Once the drill is complete, a reverse workflow can we used to deactivate the DR environment.

Common Configuration for All Templates

1. Enable/Disable Task: By default, task execution is enabled. You can choose to disable it if needed, which will stop the task from running.

2. Skip During Maintenance: Activate this option to ensure the task does not run during scheduled maintenance periods.

3. Run Immediately: Enable this option to execute the task immediately after saving the configuration. Note that the task will still run at its scheduled time.

4. Execute the Next Workflow Step Even if the Previous Step Fails: Turn on this option to allow all workflow steps to proceed, even if one or more steps fail during execution.