Search Artifacts

The BizTalk Administration Console offers the functionality to search for run-time service instances such as orchestration instances, and 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 organizations might have hundreds of such artifacts in their BizTalk server environment. To help such organizations or businesses, BizTalk360 provides the "Search Artifacts" feature. This enables users to easily locate artifacts with robust query filtering options. Users can also perform operations like Start/Stop/Enable/Disable (depending on the artifact) and view artifact properties directly via BizTalk360. 

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 actions on the application. Users can use wildcard search in the "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 shown, users can click on the respective application name to perform any operations.

Search for Applications as follows:

1. Select the artifact type as Application from the drop-down. 
2. 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.
3. Click Run Query to generate the list of applications. The filters used for searching the artifacts can be saved for future reference.
4. The user can organize and categorize the data by grouping the column.
5. Click on the application name which will navigate to the Application section from there you can perform operations such as Start/Stop the application, view the associated artifacts, and start/stop or enable/disable the artifacts.
6. Click the eye icon (References) to view the application references information.
7. Users have the option to save the query by applying filters according to their specific requirements.

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 the 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 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:

1. Select the artifact type as Orchestrations from the drop-down.
2. Enter the wildcard search text in the space provided (optional).
3. To generate fine-grained results, add more filter criteria such as Orchestration status, Application name, and Host Instance name to which orchestration belongs.
4. Click Run Query to generate the list of orchestrations. The filters used for searching the artifacts can be saved for future references. 
5. The user can organize and categorize the data by grouping the columns.
6. Select the check box against the orchestration to perform operations such as Start/Stop/Enlist/Unenlist.
7. Click the eye icon (Properties) to view the orchestration properties information.
8. Users have the option to save the query by applying filters according to their specific requirements.

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:

1. Select the artifact type as Receive Ports from the drop-down.
2. Enter the wildcard search text in the space provided (optional)
3. Add Filter criteria such as Application name, and Is two-way port, to generate fine-grained results as per the requirement. 
4. Click Run Query to generate the list of received ports. The filters used for searching the artifacts can be saved for future references 
5. The user can organize and categorize the data by grouping the column
6. Select the checkbox against the receive port to perform operations such as Enable/Disable 
7. Click the eye icon (Properties) to view the receive port properties information in detail along with the associated receive location, maps, and tracking details
8. Users have the option to save the query by applying filters according to their specific requirements.

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 the URI address of the receive location, and wild card on the 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 a 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:

1. Select the artifact type as Receive Location from the drop-down.
2. Enter the wildcard search text in the space provided (optional).
3. Add Filter criteria such as Application name, status, hostname, transport type to generate fine-grained results. 
4. Click Run Query to generate the list of received locations. The filters used for searching the artifacts can be saved for future references. 
5. The user can organize and categorize the data by grouping the column.
6. Select the check box against the receive location to perform operations such as Enable/Disable.
7. Click the eye icon (Properties) to view the received location properties in detail.
8. Users have the option to save the query by applying filters according to their specific requirements.

Searching Send Ports

Similar to receive 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.

 Search for Send Port as follows:

1. Select the artifact as Send Port from the drop-down.
2. Enter the wildcard search text in the space provided for schema name, root name, target namespace (optional).
3. Add Filter criteria such as Status, Host name and Transport type to generate a fine-grained result. 
4. Click Run Query to generate the list of schemas. The filters used for searching the artifacts can be saved for future references. 
5. The user can organize and categorize the data by grouping the column.
6. Click the eye icon (Properties) to view the schema properties information. In the send ports properties blade, send handler mapping details and subscription details for the dynamic send ports are shown that gives a quick overview of all the properties of send ports in a single place. And for the subscriptions, the general properties and its expressions can be viewed on clicking the subscription details icon.
7. Users have the option to save the query by applying filters according to their specific requirements.
   

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 for Send Port Groups as follows:

1. Select the artifact as Send Port Groups from the drop-down.
2. Enter the wildcard search text in the space provided for schema name, root name, target namespace (optional).
3. Add Filter criteria such as Application name and Status to generate a fine-grained result.
4. Click Run Query to generate the list of schemas. The filters used for searching the artifacts can be saved for future references. 
5. The user can organize and categorize the data by grouping the column.
6. Click the eye icon (Properties) to view the schema properties information.
7. Users have the option to save the query by applying filters according to their specific requirements.

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:

1. Select the artifact as Schemas from the drop-down.
2. Enter the wildcard search text in the space provided for schema name, root name, target namespace (optional).
3. Add Filter criteria such as Application name, Schema Type, and Assembly name to generate a fine-grained result. 
4. Click Run Query to generate the list of schemas. The filters used for searching the artifacts can be saved for future references. 
5. The user can organize and categorize the data by grouping the column.
6. Click the eye icon (Properties) to view the schema properties information.
7. Users have the option to save the query by applying filters according to their specific requirements.

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 for Pipelines as follows:

1. Select the artifact as Pipelines from the drop-down.
2. Enter the wildcard search text in the space provided for schema name, root name, target namespace (optional).
3. Add Filter criteria such as Application name, Pipeline Type, and Assembly name to generate a fine-grained result. 
4. Click Run Query to generate the list of schemas. The filters used for searching the artifacts can be saved for future references. 
5. The user can organize and categorize the data by grouping the column.
6. Click the eye icon (Properties) to view the schema properties information.
7. Users have the option to save the query by applying filters according to their specific requirements.

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 for Transform as follows:

1. Select the artifact as Transform from the drop-down.
2. Enter the wildcard search text in the space provided for schema name, root name, target namespace (optional).
3. Add Filter criteria such as Application name, Source Schema, Target Schema and Assembly name to generate a fine-grained result. 
4. Click Run Query to generate the list of schemas. The filters used for searching the artifacts can be saved for future references. 
5. The user can organize and categorize the data by grouping the column.
6. Click the eye icon (Properties) to view the schema properties information.
7. Users have the option to save the query by applying filters according to their specific requirements.

Saved Queries 

BizTalk360 offers robust querying capabilities. For instance, if you need to query disabled receive ports within a specific application, you can do so effortlessly using the multiple filters available in the search artifacts feature. Once created, this filter can be saved for future reference, allowing quick access to the filtered artifacts. Additionally, you have the option to pin this saved query to either the Administration or Analytics dashboard for convenient access. From there, you can view the query results in a widget directly on the pinned dashboard. 

Saved queries can be exported from an environment and then they can be imported in another environment. There might be a scenario where similar types of queries must be created in one or more environments. In such case you can create the required queries in one environment and export them. The exported file can be imported in various environments based on the requirement. This reduces manual effort in creating similar queries multiple times.

User Access Policy

The applications and artifacts are listed based on the user access policy set to users. For super users, all the applications and artifacts in the environment will be listed. Whereas, for normal users / NT users the applications and artifacts are listed based on the access provide to them.

For instance, assume that a normal user has access only to FTP-Server and SFTP-Configurations applications. In that case the artifacts related to the FTP-Server and SFTP-Configurations applications are alone listed for those users.