- 4 minutes to read

Details action for Orchestrations

The Details modal provides comprehensive information about the selected BizTalk Orchestration, empowering you to manage and optimize your integration processes.

The Remote Action Details button menu item is available in Monitor Views that include the Category BizTalk Orchestrations.

The Roles for the Monitor View must be set to allow Remote Actions.

From the Details modal, you have quick access to key information about the selected Orchestration using the following tabs:

Details modal of the Orchestration Lab.Orders.i0100_OrderFlow with the Start, Stop, Enlist, and Unenlist buttons and the Details tab open (7.12)
This image shows the Details modal for a BizTalk Orchestration.

To view the details for a BizTalk Orchestration, press the Action button menu item on an Orchestration in the Monitor View:
Action menu of an Orchestration with the Details menu item (7.12)
Action button menu with details option.

Details

In the Details tab, you can find information about the Orchestration: a Description you can edit and keep with Save, and the Miscellaneous and Bindings cards.

You can also manage the State of the Orchestration by clicking any of the enabled buttons (state aware):

Start
Stop
Enlist
Unenlist

Start, Stop, Enlist, and Unenlist buttons of the Orchestration Details modal (7.12)
State-aware Actions for Orchestrations.

Miscellaneous

Miscellaneous card of the Orchestration Lab.Orders.i0100_OrderFlow with FullName, HostName, Application.Name, the Auto settings, Tracking, and Is primary (7.12)
Miscellaneous details for the selected Orchestration: names, host, assembly, the AutoResume, AutoSuspend, and AutoTerminate settings, and tracking. The list continues with the properties of the bound ports.

Bindings

Orchestrations subscribe through their logical ports. The Bindings card lists the inbound logical ports with their Receive Ports and Receive Locations, and the outbound logical ports with their Send Ports or Send Port Groups, each with its state icon:
Bindings card of the Orchestration Lab.Orders.i0100_OrderFlow with inbound and outbound logical ports (7.12)
Bindings for the selected Orchestration.

Tracking

Depending on the type of Orchestration, different information elements and options are available:

  • One-Way Orchestrations
  • Solicit Response Orchestrations

You can change the tracking settings by checking or unchecking the checkboxes.

Info

Don't forget to click the Save button to persist changes.

You can manage Static and Dynamic Orchestrations.

Tracking tab of the Orchestration Details modal with Track Events, Track Message Bodies, and Track Message Properties (7.12)
The options for an Orchestration; the Tracking action page explains them, and Tracking what BizTalk tracks.

Host/Host Instances

This tab presents information about the Host/Host instances on the current Orchestration Handler. This is the same information presented for Host Instances, read more in the Host Instance Details user guide.

If the host has no host instances, the tab still shows the host, with a warning that artifacts bound to it can't run. Create a host instance for the host in the BizTalk Server Administration Console to run the Orchestration.

Host / Host instances tab for a host with no host instances, with the warning that artifacts bound to it cannot run (7.12)
Details for the Orchestration handler associated with the current adapter used on the selected Orchestration.

Orchestration View

The implementation of the Orchestration is displayed as an image in the Orchestration View tab.

New 7.12 Two buttons above the image let you keep a copy of the design:

  • Download PNG saves the image shown in the tab as a PNG file.
  • Download ODX saves the orchestration's design file (.odx), read from the deployed assembly; you open it in the Visual Studio orchestration designer. Orchestrations that ship with BizTalk Server, such as the EDI orchestrations, have no ODX, and the agent tells you so.

Both files come from the BizTalk Monitoring Agent; the buttons are on this tab only, not on the Action button menu.

Orchestration View tab of Lab.Orders.i0100_OrderFlow with the Download PNG and Download ODX buttons above the top of the orchestration diagram (7.12)
The Orchestration View tab, with the Download PNG and Download ODX buttons above the orchestration diagram.

  • This function is only available if you install the Nodinite BizTalk Monitoring Agent on any of the processing BizTalk nodes (needs to load the orchestration assembly from the GAC). If you add BizTalk Assemblies as resources of the BizTalk Application, as appropriate; Make sure to check:
    > - Add to global assembly cache on add resource (gacutil) and/or
    > - Add to the global assembly cache on MSI file install (gacutil)
    > * You may need to restart the Nodinite BizTalk Monitoring Agent if the DLL was previously loaded. Always assume that this is the case. Restart the agent as part of your BizTalk deployment.

GAC Option
This image shows the GAC resource option for orchestration assemblies.

New 7.12 The same design can also go into the Repository: Generate Articles from BizTalk writes it into the orchestration's Building Block as a flowchart, optionally with this image.


Frequently asked questions

Find additional solutions to common problems and the FAQ for the Nodinite BizTalk Monitoring Agent in the Troubleshooting user guide.

Why is the Orchestration Image not displayed?

The Nodinite BizTalk Monitoring Agent loads this information from the .NET Assembly.

There might also be deployment-related problems with your Orchestrations. Please make sure there are no problems and errors reported using the Health Check - Assembly verifier feature.

Next Steps

Enlist
Start
Stop
Tracking
Unenlist

BizTalk Server Monitoring Agent
Generate Articles from BizTalk
Monitor Views
Orchestrations
Remote Actions