- 11 Apr 2022
- 7 Minutes to read
- Print
- DarkLight
- PDF
Search Artifacts
- Updated on 11 Apr 2022
- 7 Minutes to read
- Print
- DarkLight
- PDF
The BizTalk Administration Console offers the functionality to search for run-time service instances such as orchestration instances, service instances with specific states such as suspended, suspended (resumable), and so on. However, in most BizTalk Server versions, there is no functionality to search for artifacts such as orchestrations, receive locations, send ports, etc. In a real-world scenario, most of the organizations might have hundreds of such artifacts in their BizTalk server environment.
To quickly access any required artifact, BizTalk360 offers the "Search Artifacts" functionality where users can easily search for the artifacts with rich query filter capabilities and perform operations such as Start/Stop/Enable/Disable (depending on the artifact), and view the properties of the artifacts.
What artifacts can be searched?
The Search Artifacts functionality allows you to search for the below BizTalk artifacts in one single screen with the advanced filter capability
- Applications
- Orchestrations
- Receive Ports
- Receive Locations
- Send Ports
- Send Port Groups
- Schemas
- Pipelines
- Transforms
Application Search
When there are many BizTalk applications in an environment and if the user needs to work on a single application, it is not so easy to perform this task with the traditional tree view navigation of the admin console. To address this issue, BizTalk360 offers the ability for users to search the list of applications in the BizTalk environment and perform action on the application. User can use wildcard search in the "Search Name" parameter. For instance, if there is an application with the name "BizTalk EDI Application" and "BizTalk EDI ", users can enter the wildcard search name as "EDI" and find the application from the search artifacts page. Once the search results are shown, users can click on the respective application name to perform any operations.
Search for Applications as follows:
- Select the artifact type as Application from the drop-down
- Enter the wildcard search text in the space provided (optional). If this is not provided then all the applications will get lists based on max match selection
- Click Run Query to generate the list of applications. The filters used for searching the artifacts can be saved for future references
- Click on the application name which will navigate to the Application section from there you can perform operations such as Start/Stop application, view the associated artifacts, and start/stop or enable/disable the artifacts
- Click the eye icon (References) to view the application references information
Searching Orchestrations
When there are many Orchestrations in the environment, it becomes a challenging task for administrators to manage every Orchestration. Say, the administrator wants to start all the Orchestrations in one go, rather than doing them one by one. BizTalk360 solves this challenge by allowing administrators to perform a wildcard search for Orchestrations starting with a name convention.In addition to orchestration name, other filters can also be applied say orchestration belonging to a particular application, status of the Orchestration, hostname, etc . This filter can be saved for further execution and easy access.
Users will also be able to perform the operations such as Start/Stop/Enlist/Unenlist on the Orchestrations depending on their User Access Policy permissions by selecting single or multiple orchestrations.
You can search for Orchestrations as follows:
- Select the artifact type from the drop-down (Orchestrations in this case)
- Enter the wildcard search text in the space provided (optional)
- To generate fine-grained results add more filter criteria such as Orchestration status, Application name, and Host Instance name to which orchestration belongs.
- Click Run Query to generate the list of orchestrations.The filters used for searching the artifacts can be saved for future references
- Select the check box against the orchestration to perform operations such as Start/Stop/Enlist/Unenlist
- Click the eye icon (Properties) to view the orchestration properties information
Searching Receive Ports
Searching on Receive ports is straightforward, users can perform a wildcard search for the list of Receive Ports in the BizTalk environment. In addition to searching based on a wildcard, users can set up additional filters based on the receive port properties. Depending on the results, users can perform operations such as enabling or disabling the receive locations that belong to the found receive ports.
Search for Receive Ports as follows:
- Select the artifact type from the drop-down (Receive Ports in this case)
- Enter the wildcard search text in the space provided (optional)
- Add Filter criteria such as Application name, Is two-way port, to generate fine-grained results as per the requirement .
- Click Run Query to generate the list of received ports.The filters used for searching the artifacts can be saved for future references
- Select the checkbox against the receive port to perform operations such as Enable/Disable
- Click the eye icon (Properties) to view the receive port properties information in detail along with associated receive location, maps, and tracking details
Searching Receive Locations
Search on receive location is more powerful with few more search options. Users can perform a wild card search on the name of the receive location, wild card on URI address of the receive location, wild card on receive port name. Let's see this scenario where the user wants to load all the receive locations pointing to a particular folder location which is using FILE adapter running on a particular BizTalk host, this can be easily achieved by adding additional filters like Search URI and HostName .
Search for Receive Locations as follows:
- Select the artifact type from the drop-down (Receive Locations in this case)
- Enter the wildcard search text in the space provided (optional)
- Add Filter criteria such as Application name,status , host name,transport type to generate fine-grained results
- Click Run Query to generate the list of received locations.The filters used for searching the artifacts can be saved for future references
- Select the check box against the receive location to perform operations such as Enable/Disable
- Click the eye icon (Properties) to view the received location properties in detail
Searching Send Ports
Similar to receiving locations, user can construct complex search queries to retrieve particular send ports. User can perform a wild card search on send port name, wildcard on URI address where the send port is pointing . In addition to searching based on wildcard search, users can set up additional filters based on the application name, status, hostname, and transport type. Once the results are generated, users can view the properties of the send ports by clicking the Properties icon (represented with the eye icon). From the list user can easily start/stop/enlist/unenlist the single or multiple sendports.
Searching Send Port Groups
The users can perform a wildcard search for the list of Send Port Groups in the BizTalk environment. In addition to searching based on wildcard search, users can set up additional filters based on the application name and status. Once the results are generated, users can view the properties of the send port groups by clicking the Properties icon (represented with the eye icon).
Searching Schemas
Search on schemas is very rich and could be very productive if you have hundreds of schemas deployed in your environment. Search schemas by simply performing a wild card search on schema root name and target namespace . In addition you can also add additional filters like schema type, assembly name, and application name. Once the results are generated, users can view the properties of the schemas by clicking the Properties icon (represented with the eye icon).
Search for Schemas as follows:
- Select the artifact from the drop-down (Schemas in this case)
- Enter the wildcard search text in the space provided for schema name,root name ,target namespace (optional)
- Add Filter criteria such as Application name , Schema Type , Assembly name to generate a fine-grained result
- Click Run Query to generate the list of schemas.The filters used for searching the artifacts can be saved for future references
- Click the eye icon (Properties) to view the schemas properties information
Searching Pipelines
The users can perform a wildcard search for the list of Pipelines in the BizTalk environment. In addition to searching based on wildcard search, users can set up additional filters based on the application name, pipeline type, and assembly name. Depending on the filter item that is selected, the values corresponding to the filter criteria will be automatically populated in the drop-down. Once the results are generated, users can view the properties of the pipelines by clicking the Properties icon (represented with the eye icon).
Searching Transforms
The users can perform a wildcard search for the list of Transforms in the BizTalk environment. In addition to searching based on wildcard search, users can set up additional filters based on the application name, source schema, target schema, and assembly name. Depending on the filter item that is selected, the values corresponding to the filter criteria will be automatically populated in the drop-down. Once the results are generated, users can view the properties of the transforms by clicking the Properties icon (represented with the eye icon).
The Filters queries used to search the artifacts can be saved for further reference/Quick access.
Saved Queries
BizTalk360 supports rich querying capability. Say for instance if you want to query the disabled receive port which is running in any specific application. you can easily query this by using multiple filters available in search artifacts. This filter can be saved for further reference. With this saved query you can quickly access the filtered artifacts .
This saved query can be pinned to Administration or Analytics dashboard for quick access. You can view the query result in a widget in the pinned dashboard.