• Print
  • Share

Search Artifacts

  • Updated on 09 May 2018
  • 9 minutes to read
  • Contributors

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, there is no functionality to search for design time artifacts such as orchestrations, receive locations, send ports and so on. In a real-world scenario, most of the organizations have hundreds of design time artifacts in their BizTalk server environment. Therefore, it is not possible for the users to search for these design-time artifacts. To address this problem, BizTalk360 offers the "Search Artifacts" functionality where users can easily search for the design-time artifacts with rich query filter capabilities, in addition to the run-time service instances.

What artifacts can be searched?

The Search Artifacts functionality can be used to search the following artifacts:

  • Applications
  • Orchestrations
  • Receive Ports
  • Receive Locations
  • Send Ports
  • Send Port Groups
  • Schemas
  • Pipelines
  • Transforms

BizTalk360 allows users to search for a particular artifact based on specific filter criteria, perform operations such as Start/Stop/Enable/Disable (depending on the artifact), and view the properties of the artifacts. All the above operations can be performed from a single place in BizTalk360. The user can perform the required operation in 3 different ways:

  • Selecting the artifact (checkbox) and clicking on the Operation buttons (Start/Stop/Enable/Disable/Enlist/Unenlist) at the top of the grid.
  • Selecting the artifact (checkbox). When you do this, you will notice an inline operation showing up right next to the checkbox with the possible operations that you can perform on the artifact.
  • Hovering over the record in the Status column - When you hover the mouse over the status column, you will notice the possible operations that can be performed on the selected artifact.

Searching Applications

When there are many BizTalk applications in an environment and users need 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 operations on the artifacts. In addition, BizTalk360 also allows users to search for an application based on a "Search Name" parameter. For instance, if there is an application with the name "BizTalk EDI Application", users can enter the wildcard search name as "EDI" and find the application from the search artifacts page. Once the search results are generated, users can click on the application name to perform any operations on the associated artifacts.

-Search-Application.png

  1. Select the artifact from the drop down (Applications in this case)
  2. Enter the wildcard search text in the space provided (optional)
  3. Click Search to generate the list of applications
  4. Click on the application name to perform the operations on the associated artifacts
  5. 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. For instance, the administrator might have named the Orchestrations based on some naming conventions (say Batch). Say, the administrator wants to start all the Orchestrations in one go rather than doing one by one. BizTalk360 solves this challenge by allowing administrators to perform a wildcard search for Orchestrations starting with a name convention (eg. Batch). In addition, administrators can set up additional filters such as Orchestration belonging to a particular application, status of the Orchestration, host name. Users will be able to perform the operations such as Start/Stop/Enlist/Unenlist on the Orchestrations depending on their User Access Policy permissions. Once a filter item is chosen from the drop down and while adding a new filter, the previously selected item will not be visible in the drop down.

-Search-Orchestration.png

  1. Select the artifact from the drop down (Orchestrations in this case)
  2. Enter the wildcard search text in the space provided (optional)
  3. Add Filter criteria to generate fine-grained result as per the requirement
  4. Click Search to generate the list of orchestrations
  5. Select the check box against the orchestration to perform operations such as Start/Stop/Enlist/Unenlist
  6. Click the eye icon (Properties) to view the orchestration properties information

Searching Receive Ports

As with the case of searching Orchestrations, users can perform a wildcard search for the list of receive ports in the BizTalk environment. In addition to searching based on wildcard search, 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 ports.

Search-receive-ports.png

  1. Select the artifact from the drop down (Receive Ports in this case)
  2. Enter the wildcard search text in the space provided (optional)
  3. Add Filter criteria to generate fine-grained result as per the requirement
  4. Click Search to generate the list of receive ports
  5. Select the checkbox against the receive port to perform operations such as Enable/Disable
  6. Click the** eye** icon (Properties) to view the receive port properties information

Searching Receive Locations

As with the case of searching receive ports, users can perform a wildcard search on the receive location name, URI address of the receive location, and on the receive port name. In addition to the wildcard search, users can add filter criteria such as host name, application name, receive location status, and type of transport.

Search-receive-location.png

  1. Select the artifact from the drop down (Receive Locations in this case)
  2. Enter the wildcard search text in the space provided (optional)
  3. Add **Filter **criteria to generate fine-grained result as per the requirement
  4. Click** Search** to generate the list of receive locations
  5. Select the check box against the receive location to perform operations such as Enable/Disable
  6. Click the eye icon (Properties) to view the receive location properties information

Searching Send Ports

The users can perform a wildcard search for the list of send ports in the BizTalk environment. In addition to searching based on wildcard search, users can set up additional filters based on the application name, status, host name, and the 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).

-Search-send-ports.png

  1. Select the artifact from the drop down (Send Ports in this case)
  2. Enter the wildcard search text in the space provided (optional)
  3. Add Filter criteria to generate fine-grained result as per the requirement
  4. Click Search to generate the list of send ports
  5. Select the checkbox against the send port to perform operations such as Start/Stop/Enlist/Unenlist
  6. Click the eye icon (Properties) to view the send ports properties information

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).

-Search-send-port-groups.png

  1. Select the artifact from the drop down (Send Port Groups in this case)
  2. Enter the wildcard search text in the space provided (optional)
  3. Add Filter criteria to generate fine-grained result as per the requirement
  4. Click Search to generate the list of send port groups
  5. Click the eye icon (Properties) to view the send port groups properties information

Searching Schemas

The users can perform a wildcard search for the list of schemas in the BizTalk environment. In addition to searching based on wildcard search, users can set up additional filters based on the application name, schema 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 schemas by clicking the Properties icon (represented with the eye icon).

-Search-schemas.png

  1. Select the artifact from the drop down (Schemas in this case)
  2. Enter the wildcard search text in the space provided (optional)
  3. Add Filter criteria to generate fine-grained result as per the requirement
  4. Click Search to generate the list of schemas
  5. 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).

-Search-Pipelines.png

  1. Select the artifact from the drop down (Pipelines in this case)
  2. Enter the wildcard search text in the space provided (optional)
  3. Add Filter criteria to generate fine-grained result as per the requirement
  4. Click Search to generate the list of pipelines
  5. Click the eye icon (Properties) to view the pipelines properties information

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).

-Search-Transforms.png

  1. Select the artifact from the drop down (Transforms in this case)
  2. Enter the wildcard search text in the space provided (optional)
  3. Add Filter criteria to generate fine-grained result as per the requirement
  4. Click Search to generate the list of transforms
  5. Click the eye icon (Properties) to view the transforms properties information

Filter Implementation for Grids

A Filter capability is implemented for the grid columns to do better search from 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 Search Artifacts section grid columns:

  • Status Filter
  • Boolean Filter
  • Text Filter

Status Filter

The status filter is used to filter Status columns. The drop down of the filter shows values according the statuses which are displayed in the column. The user can select the status from the drop down and filter accordingly.

Boolean Filter

The Boolean filter helps to filter for True or False values in the grid. For example in Search Artifacts, the Send Ports grid view section, has a column “Is Two way”. To search for two way Send Ports, this filter can be used by selecting either True or False.

Text Filter

This is the most commonly used filter. Using this filter, a user canperform text based search. The text filter has the following options:

  • Is equal to
  • Is not equal to
  • Starts with
  • Ends with
  • Contains
  • Does not Contains
  • Is Null
  • Is not null
  • Is Empty
  • Is not Empty