Document from the Repository
New 7.12
Generate Articles from BizTalk usually runs as a wizard. To document one port, integration, or application, start from its page in the Repository instead: no wizard, no environment step, and the document is written or refreshed straight away. Like the wizard, it uses no AI and reads only the BizTalk management database.
- ✅ Document a port, or the whole integration through it, from its End Point
- ✅ Change or refresh the routes an Integration's Article documents
- ✅ Write the Application Overview of a BizTalk application from its System
The BizTalk Actions
You don't need the wizard to document one port, one integration, or one application. The Repository pages of a BizTalk Log Agent's End Points, Integrations, and Systems have BizTalk actions that write or refresh the document straight away. There is no environment step: the entity already knows its Log Agent. The actions are shown only to members of the Administrator Role, when the installation has a Mapify product key.
| Start from | Action | What it writes |
|---|---|---|
| End Point page, a row's Action menu on the End Points list | Document this port | The port's Building Block, with no dialog |
| Same | Document the integration | An Integration Article, through the route picker with the port's routes ticked |
| End Points list, With Selected | Document these ports (n) | A Building Block for every selected BizTalk port, one run per Log Agent |
| Integration page and edit page, a row's Action menu on the Integrations list | Edit BizTalk routes | Opens the route picker on the Integration's Article, to change what it documents |
| Same | Refresh from BizTalk | Rewrites the generated sections of the Integration's Article |
| Integrations list, With Selected | Regenerate from BizTalk (n) | The same, for every selected Integration |
| System page, a row's Action menu on the Systems list | Document this application | The Application Overview of the BizTalk application the System stands for |
To refresh a generated Article from the Article itself or from the Articles list, see Keeping Generated Articles Up to Date.
End Point: Document This Port or the Integration
Open a BizTalk End Point, for example a send port. The toolbar has Document this port and Document the integration; the row's Action menu on the End Points list has the same two.
The Articles card lists the Articles that already document this End Point, each Linked by a generator.
The same two actions from the list, without opening the End Point.
Document this port writes or refreshes the port's Building Block straight away. The page then reports the outcome, for example Already existed and is up to date: nothing changed in BizTalk.
Document the integration opens the route picker with the routes through the port already ticked, and a line that says which way it traced. You never choose the direction; it follows from the port:
End Point Traces Ticked routes Send port Back to its sources The routes that end at this send port Receive location Forward to its subscribers Every route that starts here Orchestration port To the routes that start the orchestration Those routes If one Article already documents those routes, the picker opens in Edit the routes of ‹Article› mode, so you update that Article instead of starting a second one; see Edit the Routes of an Existing Article. Otherwise, untick the routes that belong to other integrations (a receive location on a shared hub can have dozens of subscribers, and all of them come up ticked), check the title and Document Profile, and click Create Integration Article.
Running an action again never creates a duplicate; it reports that the document is up to date.
Integration: Edit BizTalk Routes or Refresh
An Integration that a BizTalk Integration Article documents has Edit BizTalk routes and Refresh from BizTalk on its page, its edit page, and the row's Action menu on the Integrations list.
The BizTalk actions in an Integration's Action menu.
- Edit BizTalk routes opens the route picker on the Integration's Article, in Edit the routes of mode.
- Refresh from BizTalk rewrites the Article's generated sections from BizTalk, and reports the outcome, for example Up to date: nothing changed in BizTalk.
- With Selected › Regenerate from BizTalk (n) does the same for every selected Integration.
From the Integration straight to the routes its Article documents.
A refresh with no BizTalk change writes nothing.
System: Document This Application
A System that stands for a BizTalk application has Document this application on its page and in the row's Action menu on the Systems list. It writes or refreshes the application's Application Overview. When the application exists in more than one BizTalk group, each group gets its own overview, and the result says so.
The action on the System page.
The same action from the Systems list.
One overview per BizTalk group the application is in.
Frequently Asked Questions
Why don't I see the BizTalk actions?
They are shown only to members of the Administrator Role when the installation has a Mapify product key, and only on End Points, Integrations, and Systems that belong to a BizTalk Log Agent.
Does running an action twice create a duplicate?
No. A document is known by the title it was generated with. Running an action again refreshes the existing document, or reports that it is already up to date.
Next Steps
- Route Picker – pick the routes of an Integration Article
- Keeping Generated Articles Up to Date
- Where Generated Articles Appear