- 28 Mar 2023
- 6 Minutes to read
- Updated on 28 Mar 2023
- 6 Minutes to read
In BizTalk terms, a BizTalk Application is a feature that simplifies the process of deploying, managing, and troubleshooting business integration solutions. A BizTalk application is a logical grouping of items referred to as "Artifacts". There are different types of artifacts in a BizTalk solution such as:
- Receive Locations/Receive Ports
- Send Ports/Send Port Groups
To access these artifacts in BizTalk360, follow the below steps:
- Log in to BizTalk360
- Click Administration in the environmental panel
- Click the expand button against BizTalk services and then hit Applications
- Click on the application name to view the status of the artifacts associated with the application
The applications list view contains the following information:
- Application Name - The name of the application. Click the application name to view the status of different associated artifacts
- Status - Current running status of the application (Started/Stopped/Partially Stopped/Not Applicable/Orphaned)
- Configured - Whether the application is configured or not. If the application is configured, a visual cue (tick mark) will be visible in the column
- Suspended Instances - The number of suspended instances within the application
- Description - A detailed description of the application. If the application is a System application, the description field will contain the text as "System Application"
- References - Provides information on the application references. For instance, consider an application 'Contoso'. The References section provides information on the list of applications that Contoso depends on, and the list of applications that are dependent on Contoso
- Refresh - Refreshes the application information in the list view
- Export Data - Allows users to export the list of available applications for the user along with their current operational and configuration status. Click the Export Data link and select either Export as PDF or Export as Excel download the report to your computer
The Application dashboard page helps to easily understand the health of a BizTalk application from a single view. Once in a BizTalk environment, to view the Application dashboard, select Administration, expand BizTalk Services, and select the Applications link in the menu panel.
Let's understand the Application Dashboard page in detail:
- Home - Displays the counts and statuses of Receive Ports, Receive Locations, Send Ports, Send Port Groups, Orchestrations, and Host Instances. The grid for the respective artifacts only shows up when it contains any data for that artifact. If the application does not contain any artifacts for the respective category, then the home page will not show that category. Instead, it will display the message that “There are no artifacts configured for this application”.
- Artifacts - Displays the summary of different artifacts that are associated with the application such as Receive Locations, Send Ports, Orchestrations, Send Ports Groups, and so on. Also, Policies & Rules associated with the applications can be viewed. For this, the user doesn't need Business Rules Composer access. Click the artifact name to navigate to the screen where you can see the list of artifacts, their status, and other details.
- Artifact Details - Clicking the artifact details icon displays the artifacts section where the user can perform activities on the selected artifact (such as Enable/Disable and so on)
- Refresh - Forces a refresh of the status of the artifacts. When the status of the artifact is changed in the corresponding section, the status will get reflected on the Home screen. If the status is not reflected, click Refresh to force refresh the status of the artifacts
- Start - To start an already stopped application. When the Start button is clicked, a pop-up window appears where the user can choose the artifacts that are to be started (orchestrations, send ports, send port groups, receive locations). A tick mark will appear next to the items if the artifacts have started successfully. Once the artifacts have started successfully, click the X button at the top right corner of the page to close the pop-up window
- Stop - To stop a running application. When the Stop button is clicked, a pop-up window appears where the user can choose the artifacts that are to be stopped (receive locations, orchestrations, send ports, send port groups). Select the appropriate option from the list. Click the Stop button at the bottom right corner of the page to close the pop-up window
When an application has suspended instances, the number of suspended instances for that application will be shown. When the application name is clicked, the Home tab of the application displays the number of suspended messages for the application, including a link to Query Instances. When the Query Instances link is clicked, the system automatically navigates the user to the Message Box Queries section. In the Message Box Queries section, the query expression is automatically filled up and the query result can be generated by clicking the 'Execute Query' button.
Performing Operations under the artifacts section
Based on the user permissions, the users will have the ability to perform operations such as Start/Stop/Enable/Disable/Enlist/Unenlist the artifacts. The user can perform the required operation by selecting the artifact (checkbox) and clicking on the Operation buttons (Start/Stop/Enable/Disable/Enlist/Unenlist) at the top of the grid.
This example shows various operations that can be performed in a Receive Port in the application. Similarly, you can perform operations under other artifacts like Orchestration, Receive Location, Send Port, Send Port Groups, etc. Once the operation is performed in any of the artifacts, the user activities will get recorded. The recorded data can be shown under the Governance and Auditing (under Application activities) section.
Filter Implementation for Grids
To do a better search from the grid columns, a Filter capability is implemented for the grid columns. A user can filter the data from the respective rows according to their needs.
The following types of filters have been implemented in the Applications section grid columns:
- Status Filter
- Text Filter
The status filter can be used to filter Status columns. The drop-down of the filter shows the values according to the statuses that are displayed in the column. The user can select the status from the drop-down and filter accordingly.
This is the most commonly used filter. Using this filter, a user can perform a text-based search. The text filter has the following options:
- Is equal to
- Is not equal to
- Starts with
- Ends with
- Does not Contains
- Is Null
- Is not null
- Is Empty
- Is not Empty
Users are allowed to schedule the Service Window Configuration for Receive Locations and Send Ports
Configure Service Window
One of the core capabilities of Microsoft BizTalk server is to configure services windows for your receive locations and send ports. If you configure a schedule/service window for your receive locations, messages will be accepted only during that time window, all other times BizTalk either won’t pick up messages . The same applies to send ports, message won’t be transmitted outside the service window.
You can configure service window if you wanted to poll data from your SQL/Oracle database only during a certain period. Follow the below steps to configure Service Window from BizTalk360
1)Navigate to the Application and select the Receive Location/Send Port you wish to schedule the service window.
2)Click on the property(eye) icon, which opens the property blade. There you configure the Service window as below
- For Receive Location the service window can be configured under the schedule tab by enabling the service window toggle
- Send Port the service window can be configured under the Primary Send tab by enabling the service window toggle
The below gif image will illustrate the service window configuration from BizTalk360.
NOTE - The Service Window time is aligned to BizTalk Server Time Zone.
All the operations such as Starting/Stopping the application, changing the artifact state as enable/disable/enlist, and scheduling the service window from BizTalk360 and from BizTalk Server 2020 will be audited. To view the audited details navigate to Environment settings->Governance Audit->Administrative Activities->Application .
Role Based Access
Super users can view and manage all the applications. However to view /manage the BizTalk application from BizTalk360 the custom user need below access
View Application - The Applications must be added while defining the role of custom user . The user can access only that particular application through BizTalk360
Manage Applications - To Start/Stop the application , to Start/Stop/Disable/Enable/Enlist/UnEnlist application artifacts, and to configure the schedule window user must have access to Manage Application .