- 6 minutes to read

The Route Picker

New 7.12

An Integration Article documents the BizTalk routes you say belong together. The route picker is where you choose them, for a new Article (Define an Integration Article) or for one that already exists (Edit the routes of ‹Article›). It is part of Generate Articles from BizTalk, and like the rest of it, it reads the BizTalk management database and uses no AI.

Where It Opens

  • New Integration Article... on the wizard's Articles step
  • The edit button of an Integration Article row on the Articles step, and Edit its routes in the picker itself
  • Edit selection... on a generated Integration Article and in the Articles list
  • Edit BizTalk routes on an Integration, and Document the integration on an End Point; see Document from the Repository

Find and Tick the Routes

  • Scope: the picker searches the routes of the whole BizTalk group of the Log Agent, never only the applications picked for diagrams. The search term matches the subscriber name, receive port, filter property and value, message type, map name, and address.
  • Facets: each with counts; the Integration Key facet comes first. Its heading holds the pattern in an editable box. Changing it applies to this Article only (This Article uses its own pattern); reset restores the run's pattern. Every Integration Article records the pattern its key was found with, so an Article generated with an older pattern keeps it until you reset it.
  • Your applications: when the run has applications for diagrams, the picker names them above the filter bar, lists them first in the Application facet with a selected badge, and offers Only routes of my applications (off by default).
  • Selection: tick a route's checkbox, or the header checkbox to select every route on the page. Ticked routes stay selected across pages, searches, and facets. To take a whole match, narrow it with facets and tick the header on each page.

Two badges on a route tell you where else it is documented:

Badge Means Tooltip
documented An Article already saved in Nodinite documents the route Names that Article and points to Edit its routes in the panel
also in this run Another Integration Article of the same wizard run holds the route Names that Article, for example Also in INT001: Bad Filter on Send Port, defined in this run. Ticking it here documents the route in both Articles.

A route may be in more than one Article; ticking it documents it in each.

Route list with the also in this run badge on the INT001 routes and the tooltip of one badge open (7.12)
The tooltip names the other Article of the run that holds the route.

Define a New Integration Article

The panel on the right, The new Article, holds the Title, the Document Profile, the run size, and the Ticked routes. Only Integration Article profiles are offered, with the shipped BizTalk Integration profile first.

Route picker opened from New Integration Article with the Integration Key facet, the selected applications, three ticked routes, and the new Article panel (7.12)
The route picker. The Integration Key facet comes first; the panel on the right holds the new Article's title, profile, and ticked routes.

  • Title suggestion: when the ticked routes carry an Integration Key, an empty Title is filled with the key and the first ticked route's name, such as INT001: Send Order. A hint says it is a suggestion (Suggested from the Integration Key and the first ticked route; name the integration the way your team does.) and disappears when you change the title. Routes without a key leave the Title empty, because a port name is not the name of an integration; the placeholder suggests one, e.g. INT0042: Orders to ERP. A title you typed is never replaced.
  • New or existing: a new title is marked New. A new Article can't take the title of an existing one; when you type such a title, the Title box says so and offers Edit its routes instead.

The new Article panel with the suggested title INT001: Send Order and the hint that it is only a suggestion (7.12)
The suggestion is the Integration Key and the first ticked route's name.

  • Already documented: when ticked routes are already documented, a box under Ticked routes says how many existing Articles document them, for example 1 existing Article documents ticked routes. Each Article says how much it covers, such as documents 3 of the 4 ticked routes, and has three buttons:

    • Edit its routes switches the picker to Edit the routes of that Article.
    • Open opens the Article.
    • Refresh from BizTalk rewrites its generated sections, and reports Up to date: no change in BizTalk. or what it updated.

    Create Integration Article always makes a new, separate Article: to change what an existing Article documents, use Edit its routes.

The new Article panel with ticked routes and the box saying 1 existing Article documents ticked routes, documents 3 of the 4, with Edit its routes, Open, and Refresh from BizTalk (7.12)
Ticked routes that an existing Article already documents. Edit its routes changes that Article instead of creating a new one.

  • Why Create is disabled: next to the disabled Create Integration Article button, the picker says what is missing: Tick at least one route. when nothing is ticked, Give the Article a title. when the Title is empty, or that the run limit (BizTalkArticleGenerationMaxPerRun) is reached.

Define an Integration Article with only ResendPort ticked, an empty Title showing its placeholder, and Create Integration Article disabled with the reason Give the Article a title (7.12)
The ticked route has no Integration Key, so no title is suggested; the reason at the bottom left tells you what to fix.

Edit the Routes of an Existing Article

When BizTalk gets a new route for an integration, for example a second send port, add it to the existing Article. Open the picker on that Article with Edit BizTalk routes on its Integration, Edit selection... on the Article, the edit button of its row on the Articles step, or Edit its routes in the picker. The title reads Edit the routes of ‹Article›, and the panel on the right is The existing Article:

  • The title is locked and marked Updates existing: a document is known by the title it was generated with. Rename the Article itself on its edit page.
  • The routes the Article holds are ticked and marked in it; routes you tick are marked added, and routes you untick are listed as removed.
  • A line sums up what Update will do, for example Editing the routes of ‹Article› · Update adds 1 route. or Update keeps its 3 routes and regenerates it.
  • Update Integration Article saves the ticked routes as the routes the Article documents, and regenerates it.

Edit the routes of an Article: three routes marked in it, ResendPort marked added, Update adds 1 route, the Updates existing title, and Update Integration Article (7.12)
Adding a route to an existing Article: the new route is marked added.

If the new route is a separate integration, click New Article instead and give it its own title; Create Integration Article then writes a second Article.

Route picker opened from Document the integration on a send port, traced back from the send port, in Edit the routes of mode because an Article already documents the route (7.12)
Opened from an End Point whose route is already documented: the picker goes straight to Edit the routes of that Article.

Frequently Asked Questions

Why is no title suggested?

None of the ticked routes has an Integration Key. Type the integration's name, the way your team names integrations. To get suggestions, change the Integration Key pattern so it finds the number in your port names.

Why does an Article show a different Integration Key pattern than the run?

Every Integration Article keeps the pattern its key was found with. An Article generated with an older default shows that pattern in the facet, with This Article uses its own pattern. Click reset next to the pattern to use the run's pattern for this Article.

Next Steps