- 3 minutes to read

Settings Tab

The Settings tab of the Remote Configuration fine-tunes the general options of the Nodinite Microsoft BizTalk Server Monitoring Agent. The fields below follow the screen order.

Animation: the Settings tab with Environment, Debug, Culture Information, CSV Delimiter, the Agent Database sub-tab, and the additional options
The Settings tab from top to bottom. On this agent the Agent Database is already enabled; Save and close sends the settings to the agent.

General settings

BizTalk Monitoring Agent Settings tab with Environment DEMO, Debug, Culture Information, CSV Delimiter, and the Agent Database sub-tab
The general options come first; the Agent Database sub-tab follows.

Field Description Default
Environment Name of the environment the agent monitors, for example Test, Prod, or QA. –
Debug Writes detailed debug information to the local log file. Enable only for troubleshooting. ❌ Disabled
Culture Information Defines the culturally appropriate format for displaying dates and times, for example svenska (Sverige) (sv-SE). –
CSV Delimiter The character the agent uses when it exports data to CSV files, for example ;. –

Note

Culture Information applies to the date and time values this agent formats. Apart from those, the Web Client shows dates and times in your browser's local format, and the Web API returns them in UTC.

Agent Database

To use the Auditing feature and get statistics about suspended instances, enable the Monitoring Agent Database on the Agent Database sub-tab inside Settings. The connection string field's help text names the default database (Nodinite_MonitoringAgent_BizTalk on localhost).

The Agent Database sub-tab with Use Monitor Agent Database, the connection string, days to keep suspended history, Enable Auditing, and Audit retention
The Agent Database sub-tab enables statistics, history, and auditing.

Field Description Default
Use Monitor Agent Database Tracks statistics, including Suspended Instances history. Required for Auditing and clustering (stores configuration, audit log, comments). –
Monitoring agent database connection string Connection string to the database where the agent stores statistics. Data Source=localhost;Initial Catalog=Nodinite_MonitoringAgent_BizTalk;Integrated Security=True;Encrypt=True;Trust Server Certificate=True
Days to keep suspended history Number of days to keep history about suspended instances that have been terminated or resumed. – (example: 364)
Enable Auditing Audits user operations that change the state of a Resource. –
Audit retention Number of days to keep the audit history. – (example: 90)

Example connection string:

Data Source=%DBSERVERNAME%\[INSTANCENAME]%;Initial Catalog=%Nodinite_Prod_Agent_BizTalk%;Integrated Security=True;Encrypt=True;TrustServerCertificate=True

Note

This connection string uses the same format, driver (Microsoft.Data.SqlClient), and certificate guidance as the BizTalk Management Database connection string; for listeners, see Always On Availability Groups (AOAG).

Tip

See the shared user guide for installing and updating the Monitoring database.

Additional options

BizTalk Monitoring Agent Settings tab additional options for detailed descriptions and suspended message access
The end of the Settings tab, here with suspended-message access enabled.

Field Description Default
Include detailed description Adds a detailed description to Resources. When enabled, the amount of data sent between the BizTalk Monitoring Agent and Nodinite increases. ❌ Disabled
List suspended instances by service name Groups suspended messages by Service name instead of Application name. Use it on BizTalk Server Standard edition, which is limited to 5 BizTalk applications. ❌ Disabled
Allow downloading and viewing the Body of suspended messages Global setting for access to the message body of resumable Suspended Instances. –
Allow downloading and viewing the Context Properties of suspended messages Global setting for access to the message context of resumable suspended instances. –

Next Steps