Viewing Interface Maps
The Interface Maps utility lists all the routes that a message can take within a production, allowing you to view related production components in a tabular format. The search criteria allow you to focus on a specific component such as finding where a routing rule or data transformation is used within the production. Each interface map represents a unique route that a message can take through the production. For example, if a business process connects to multiple business operations, multiple interface maps are shown because a message could flow to any of the business operations. Displaying interface maps is useful when:
Finding all components named for a particular feed in a complex production that has multiple feeds. For example, you could find all the message routes that include a business service whose name contains the word EMR1.
Visualizing message flow though a complex production.
Documenting a complex production to make it easier to maintain.
Ensuring that you have tested all possible paths when modifying a production.
The utility displays the interface maps for the production that was most recently running. You can export the results of the interface map search into a .csv, .txt, .xml, or .html file.
Each interface map includes the following production components:
Name of the business service where the message begins.
Name of the business host called between the input and output. This is usually a business process, but can also be a business operation if it makes a call to another production component, for example, when the business operation makes a call to Ens.Alert.
Name of the routing rule called while processing the message.
Name of the data transformation called while processing the message.
Name of the business host where the message stops. This is usually a business operation, but can also be a business process if it never calls a business operation, for example, when the message stops at a business process that simply stores data directly in the database.
You can double-click a column header to sort the list of interface maps by that production component.
Once you find the production route you are interested in, you can click the row in the list to view a visual representation of the route.
Use the left-hand pane to enter search criteria that controls which interface maps appear in the list. There are three sections of the search pane:
Displays the name of the production. You can click the production name to open the production in the Production Configuration window. To change the production, start a new production in the Production Configuration window. A green graphic indicates that the production is currently running while a yellow graphic indicates that the production is currently stopped.
Enter text that is part of the name of the production component you are looking for. You can indicate whether the search is case sensitive.
The Interface Maps utility only searches the types of components (service, operation, process, routing rule, or data transformation) that are selected. The Process
options refer to the position of the component in the interface map, not a business process or business operation. A production’s business process shows up as an operation in the interface map if it does not make a call to another component. Similarly, a production’s business operation shows up as a process in the interface map if it makes a call to another component. If you want to find a business process or business operation regardless of where it shows up in the interface map, select both Process
in the search criteria.
You can use the Category Filter
drop-down list to focus your search on components that have been labeled with a specific category. A production route appears when any component in the route belongs to the category. Categories are defined in the Informational Settings
section of the Settings
tab for each business service, business process, or business operation of a production.
When you select Highlight search text
, the text string that you entered in the Search Criteria is highlighted in the names of the production components in the list of interface maps.
You can use the Export
button to save the interface map routes found by a search as a .csv, .txt, .xml, or .html file. This is a useful way to document a production. The extension of the filename that you specify determines the format of the exported file. An exported .csv file is tab-delimited, not comma-delimited. The export file is saved to your local machine via your browser’s downloading capability.
When the setting to auto refresh the Management Portal is disabled, you receive a message telling you to click the Refresh icon
to complete the export process. This Refresh icon is located next to the Export
Content Date/Time: 2019-04-23 13:43:24