BAM Related Activities and Related Documents integration in BizTalk360

BAM Related Activities and Related Documents integration in BizTalk360

BAM Related Activities and Related Documents integration in BizTalk360

Earlier versions of BizTalk360 already had the Business Activity Monitoring (BAM) feature inbuilt, which provides the option for querying the BAM views, perform activity search, check user permissions and to view activities time window. However, the user couldn’t view the detail information on query results in BizTalk360 similar to BAM portal.

bam relationships

Some of our customers requested this functionality to view the related activities and documents of the query result from BizTalk360 application itself. From this release v8.6, we bring the Related activities and documents of each query result to the existing BAM feature. This helps the user to find the solution in a single application rather than switching to multiple applications.

What is a BAM Relationship?

A BAM activity can span to multiple heterogeneous applications (for example, a pipeline, two orchestrations, a line-of-business application, and then another pipeline). The BAM infrastructure can correlate the events from the multiple sources. BAM Relationship is used whenever two activities need to be connected to shared data. The Activity relationship exists when an activity relates to one or more activities in a BAM view.

For Example, for an Order Request, there may be multiple Responses, which may arrive from the end system; the relationship between the request and multiple responses is established using a Common ID which is common between the Inbound and Outbound Order. In our case, it will be the OrderID.

bam view

The user can query the result, by selecting the required activity to sort the data and milestones from the available columns for the query. Next, the user can view the result in the grid view.

bam query results

View the Detailed Information for Request

The user can view the detailed information on each request arrived for the inbound Activity by clicking on the respective row. This action will open a blade where the user can view detailed information such as requested data and the set milestone information.

bam activity status

View the Related Activities for Request

By clicking the Related Activities tab, the user can view all the Responses generated for that request and the user can view the detailed information such as data and milestones for the Responses, by clicking the Eye Icon in each response, as displayed below.

bam activity status inbound order

In the BAM Portal, the user can view above response details, by clicking the Related activities and it will navigate to the response in the Outbound Activity.

Download the Related Documents for the Request

In BizTalk360, the user can also download the Request document by clicking the Related Documents tab. In this screen, the user can view the documents for that request in a grid and the user can also download the file by selecting and clicking the Document link.

related documents

The user can download the related document only when the archive folder is in a shared location.

bam activity status

Functionality for the Response Activity

The Response activity is the Outbound activity; same as in Inbound Activity the user can view the detailed information about the response and view the request for that response in the related Activity tab.  Finally, the detailed information for that request can also be viewed by clicking the Eye icon on the grid.

response activity

Note: From the Above sample, the Common Id should be same.

BAM Operation Using Command Prompt

BAM Operation Using Command Prompt

This blog helps to perform various operations with BAM views using the command prompt such as:

  • deploy BAM Views
  • remove BAM definitions
  • authorize user accounts for BAM View

First, I have created a BAM view named as “BAMOperation” with the Activities Order and Status with items as shown below.

Business Activity Monitoring BAM Operation Using Command Prompt

Business Activity Monitoring BAM Operation Using Command Prompt

The BAM management utility deployment command line tool, bm.exe., allows to apply, modify, and remove BAM definitions. You can use, amongst others, below commands:

  • deploy-all – Deploys a BAM definition
  • remove-all – Removes a BAM definition
  • update-all – Updates a BAM definition
  • add-account – add accounts on BAM definition

Deploy a BAM View and Activities

The BAM Definition file (BAMOperation.xml) becomes deployed using the BAM Command line utility.

Deploying of BAM definition file will create corresponding database tables, views, etc., which will organize the data in a relational view. Follow the below steps to deploy a BAM View:

  1. Open Command Prompt as administrator
  2. Navigate to BizTalk Server Installation path/ Tracking folder and use the below command:

bm.exe deploy-all –DefinitionFile:” <<FileLocation>> BAMOperation.xml”

Business Activity Monitoring BAM Operation Using Command Prompt

which will deploy a “BAMOperation” view in BAM Portal as shown below.

Business Activity Monitoring BAM Operation Using Command Prompt

Remove a BAM Definition

Administrators can use the remove-view / remove-activity command to remove a view and Activity from the BAM Primary Import database. Follow the below steps to remove an existing activity/view:

  1. Open Command Prompt as administrator.
  2. Navigate to BizTalk Server Installation path/ Tracking folder and use the below command.

To Remove a BAM Definition File:

bm.exe deploy-all –DefinitionFile:” <<FileLocation>> BAMOperation.xml”

Business Activity Monitoring BAM Operation Using Command Prompt

Removing a BAM definition file will remove the related tables, views, etc. which were deployed in the database and server.

Remove a BAM Activity

To remove a BAM Activity, the user needs to remove the BAM View first and then the BAM Activity they wanted to remove. Execute the below-shown command to remove the BAM View first and then the BAM Activity.

To remove a BAM View:

bm.exe remove-view -name: {view name}

Business Activity Monitoring BAM Operation Using Command Prompt

To remove a BAM Activity

bm.exe remove-activity -name: {activity name}

Business Activity Monitoring BAM Operation Using Command Prompt

The above command which will remove the specified activity alone form the database.

Update a BAM Activity

The User is also able to update an existing View/Activity. To update an Activity/ View, the user should remove the activity/view first by using the above-mentioned commands and then follow the below steps to update any changes in the existing View /Activity.

For example, I have removed the above “Status” activity and I have updated the activity as shown below.

Business Activity Monitoring BAM Operation Using Command Prompt

We then use the below command to update the changes to the existing view:

bm.exe update-all –DefinitionFile:” <<FileLocation>> BAMOperation.xml”

The above command will add a table, view in the database and it will update the previous activity in the BAM Portal as shown below.

Business Activity Monitoring BAM Operation Using Command Prompt

Add an Account to BAM Definition

Administrators use the add-account command to associate users with BAM views and protect the BAM Excel Spreadsheet views from unauthorized access. When users save BAM views, the views reference a SQL connection string that is hidden within the workbook. The workbook is protected, but you must also ensure that the document is protected.

When you associate users with BAM views, you restrict access to the views to only the users or groups to whom you grant access by using the below command.

bm.exe add-account -AccountName: DomainName UserName -View:(viewname)

Business Activity Monitoring BAM Operation Using Command Prompt