hmLoadTopic({
hmKeywords:"API Management,XML API Management",
hmTitle:"XML API Management",
hmDescription:"This dialog contains various management settings for MDaemon\'s XML API service. For more on MDaemon\'s API library and integrating your custom applications with MDaemon, see:...",
hmPrevLink:"message-indexing_diagnostics.html",
hmNextLink:"preferences_gui.html",
hmParentLink:"index.html",
hmBreadCrumbs:"Setup Menu",
hmTitlePath:"Setup Menu > XML API Service",
hmHeader:"<h1 class=\"p_Heading1\" style=\"page-break-after: avoid;\"><span class=\"f_Heading1\">XML API Management<\/span><\/h1>\n\r",
hmBody:"<p class=\"p_BodyText\"><span class=\"f_BodyText\">This dialog contains various management settings for MDaemon\'s XML API service. For more on MDaemon\'s API library and integrating your custom applications with MDaemon, see: <\/span><span class=\"f_BodyText\" style=\"font-weight: bold;\">MD-API.html<\/span><span class=\"f_BodyText\"> (located in the <\/span><span class=\"f_PlainText\">\\..\\MDaemon\\Docs\\API<\/span><span class=\"f_BodyText\"> folder).<\/span><\/p>\n\r<h2 class=\"p_Heading2\" style=\"page-break-after: avoid;\"><a id=\"system\" class=\"hmanchor\"><\/a><span class=\"f_Heading2\">System<\/span><\/h2>\n\r<p class=\"p_BodyText_Center\"><img style=\"margin:0 auto 0 auto;width:34.4375rem;height:32.1250rem;border:none\" src=\".\/images\/xml-api_system.png\"\/><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">Archive all XML Requests and Responses<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">Enable this option is you wish to save all XML requests and responses so that you can diagnose issues that may arise.<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">Enable Global Address List (Public Contact Folder) caching<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">Use this option if you wish to allow the API to keep the Global Address Lists (public contacts folders) for domains cached, in order to improve performance. This option is enabled by default.<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">[xx] second Logon session timeout<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">This option determines the number of seconds before an API Logon token expires if not used.<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">[xx] days of Settings Editor backup retention<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">This option determines the number of days to retain Editor\/INIfile and Editor\/HiWater backups, so that changes might be undone\/reverted via the \'recover\' action.<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">[xx] Seconds between maintenance thread interval<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">This is the number of seconds that the maintenance thread sleeps before checking for new maintenance tasks such as cleaning up old directories and files.<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">Disable all &quot;Are you sure?&quot; confirmation prompts<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">Check this box if you wish to disable all \'Are you sure?\' prompts to streamline UI actions.<\/span><\/p>\n\r<p class=\"p_BodyText\"><a id=\"address-restriction\" class=\"hmanchor\"><\/a><\/p>\n\r<h2 class=\"p_Heading2\" style=\"page-break-after: avoid;\"><span class=\"f_Heading2\">Address Restrictions<\/span><\/h2>\n\r<p class=\"p_BodyText_Center\"><img style=\"margin:0 auto 0 auto;width:34.2500rem;height:32.0000rem;border:none\" src=\".\/images\/xml-api_address.png\"\/><\/p>\n\r<p class=\"p_DialogSectionHeading\" style=\"page-break-after: avoid;\"><span class=\"f_DialogSectionHeading\">Allowed Addresses<\/span><\/p>\n\r<p class=\"p_BodyText\"><span class=\"f_BodyText\">Right-click to add a new IP address\/mask to the allowed addresses list. These addresses are allowed to connect to the API.<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">Allow all Trusted IP addresses<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">Check this box if you wish to allow all <a href=\"security--trusted_ips.html\" class=\"topiclink\">Trusted IP<\/a> addresses to connect to the API.<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">Allow all LAN IP Addresses<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">Check this box if you wish to allow all <a href=\"security--lan_ips.html\" class=\"topiclink\">LAN IP<\/a> addresses to connect to the API.<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">Allow all Dynamic Allow List addresses<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">Use this option if you wish to allow all <a href=\"dynamic-screening_dynamic-whitelist.html\" class=\"topiclink\">Dynamically Allowed<\/a> addresses to connect to the API.<\/span><\/p>\n\r<p class=\"p_DialogSectionHeading\" style=\"page-break-after: avoid;\"><span class=\"f_DialogSectionHeading\">Blocked Addresses<\/span><\/p>\n\r<p class=\"p_BodyText\"><span class=\"f_BodyText\">Right-click to add or modify IP addresses in this list. These IP addresses are restricted from connecting to the API. <\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">Deny all IP addresses not specifically allowed<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">When this box is checked, the only IP addresses allowed to connect to the API are those specifically allowed to connect via the Allowed Addresses settings.<\/span><\/p>\n\r<p class=\"p_BodyText\"><a id=\"diagnostics\" class=\"hmanchor\"><\/a><\/p>\n\r<h2 class=\"p_Heading2\" style=\"page-break-after: avoid;\"><span class=\"f_Heading2\">Diagnostics<\/span><\/h2>\n\r<p class=\"p_BodyText_Center\"><img style=\"margin:0 auto 0 auto;width:34.3125rem;height:32.0625rem;border:none\" src=\".\/images\/xml-api_diagnostics.png\"\/><\/p>\n\r<p class=\"p_DialogSectionHeading\" style=\"page-break-after: avoid;\"><span class=\"f_DialogSectionHeading\">Logging<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">Log level<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">Six levels of logging are supported, from the highest to lowest amount of data logged:<\/span><\/p>\n\r<div style=\"text-align: left; text-indent: 0; padding: 0 0 0 0; margin: 0 0.3125rem 0.8750rem 2.6250rem;\"><table style=\"width:40.6250rem; border:none; border-spacing:0.1250rem;\">\n\r<tr>\n\r<td style=\"vertical-align:top; width:7.5000rem; padding:0.0625rem; border:none\"><p class=\"p_BodyText\" style=\"text-align: right;\"><span class=\"f_BodyText\" style=\"font-weight: bold;\">Debug<\/span><\/p>\n\r<\/td>\n\r<td style=\"vertical-align:top; width:47.1875rem; padding:0.0625rem; border:none\"><p class=\"p_BodyText\"><span class=\"f_BodyText\">This is the most extensive log level. Logs all available entries, and is typically only used when diagnosing a problem, or when the administrator wants detailed information.<\/span><\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr>\n\r<td style=\"vertical-align:top; width:7.5000rem; padding:0.0625rem; border:none\"><p class=\"p_BodyText\" style=\"text-align: right;\"><span class=\"f_BodyText\" style=\"font-weight: bold;\">Info<\/span><\/p>\n\r<\/td>\n\r<td style=\"vertical-align:top; width:47.1875rem; padding:0.0625rem; border:none\"><p class=\"p_BodyText\"><span class=\"f_BodyText\">Moderate logging. Logs general operations without details. This is the default log level.<\/span><\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr>\n\r<td style=\"vertical-align:top; width:7.5000rem; padding:0.0625rem; border:none\"><p class=\"p_BodyText\" style=\"text-align: right;\"><span class=\"f_BodyText\" style=\"font-weight: bold;\">Warning<\/span><\/p>\n\r<\/td>\n\r<td style=\"vertical-align:top; width:47.1875rem; padding:0.0625rem; border:none\"><p class=\"p_BodyText\"><span class=\"f_BodyText\">Warnings, errors, critical errors, and startup\/shutdown events are logged.<\/span><\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr>\n\r<td style=\"vertical-align:top; width:7.5000rem; padding:0.0625rem; border:none\"><p class=\"p_BodyText\" style=\"text-align: right;\"><span class=\"f_BodyText\" style=\"font-weight: bold;\">Error<\/span><\/p>\n\r<\/td>\n\r<td style=\"vertical-align:top; width:47.1875rem; padding:0.0625rem; border:none\"><p class=\"p_BodyText\"><span class=\"f_BodyText\">Errors, critical errors, and startup\/shutdown events are logged.<\/span><\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr>\n\r<td style=\"vertical-align:top; width:7.5000rem; padding:0.0625rem; border:none\"><p class=\"p_BodyText\" style=\"text-align: right;\"><span class=\"f_BodyText\" style=\"font-weight: bold;\">Critical<\/span><\/p>\n\r<\/td>\n\r<td style=\"vertical-align:top; width:47.1875rem; padding:0.0625rem; border:none\"><p class=\"p_BodyText\"><span class=\"f_BodyText\">Critical errors and startup\/shutdown event are logged.<\/span><\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr>\n\r<td style=\"vertical-align:top; width:7.5000rem; padding:0.0625rem; border:none\"><p class=\"p_BodyText\" style=\"text-align: right;\"><span class=\"f_BodyText\" style=\"font-weight: bold;\">None<\/span><\/p>\n\r<\/td>\n\r<td style=\"vertical-align:top; width:47.1875rem; padding:0.0625rem; border:none\"><p class=\"p_BodyText\"><span class=\"f_BodyText\">Only startup and shutdown events are logged.<\/span><\/p>\n\r<\/td>\n\r<\/tr>\n\r<\/table>\n\r<\/div>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">View\/Analyze Log<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">Click this button to open the MDaemon Advanced System Log Viewer. By default the <\/span><span class=\"f_ControlIndent\">logs are stored in: &quot;<\/span><span class=\"f_PlainText\">..\\MDaemon\\Logs\\<\/span><span class=\"f_ControlIndent\">&quot;<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_DialogSectionHeading\">Advanced Options<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">Minimum debugger log level<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">This is the minimum level of logging to emit to the debugger. The available log levels are the same as those outlined above.<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">Log process memory counters<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">Check this box to log process-specific Memory, Handle, and Thread information to the log file. This is useful for finding potential leads and resource allocation issues. Log entries will only be emitted if the data has changed since the last time it was logged.<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">Log system wide performance information<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">Check this box if you with to log system-wide performance information to the log file. This is useful for finding potential leads and resource allocation issues. Log entries will only be emitted if the data has changed since the last time it was logged.<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">No more than every [xx] seconds<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">Use this option to set the limit on how often the process and performance information will be logged.<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_DialogSectionHeading\">Process Dumps<\/span><\/p>\n\r<p class=\"p_ControlHeading\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading\">Enable error based process dumps<\/span><\/p>\n\r<p class=\"p_ControlIndent\"><span class=\"f_ControlIndent\">Enable this option if you want to generate process dumps whenever a specific warning or error occurs that you have designated below.<\/span><\/p>\n\r<p class=\"p_ControlHeading2\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading2\">Include heap information in dumps<\/span><\/p>\n\r<p class=\"p_ControlIndent2\"><span class=\"f_ControlIndent2\">By default, heap information is included in the process dumps. Clear this checkbox if you do not wish to include it.<\/span><\/p>\n\r<p class=\"p_ControlHeading2\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading2\">Prefix dump files with<\/span><\/p>\n\r<p class=\"p_ControlIndent2\"><span class=\"f_ControlIndent2\">Process dump filenames will begin with this text.<\/span><\/p>\n\r<p class=\"p_ControlHeading2\" style=\"page-break-after: avoid;\"><span class=\"f_ControlHeading2\">Errors\/Warnings to generate dumps on<\/span><\/p>\n\r<p class=\"p_ControlIndent2\"><span class=\"f_ControlIndent2\">Right-click this area and use the <\/span><span class=\"f_ControlIndent2\" style=\"font-style: italic;\">Add\/Edit\/Delete Entry...<\/span><span class=\"f_ControlIndent2\"> options to manage the list of errors or warnings that will trigger process dumps. For each entry you can specify the number of process dumps allowed before it will be deactivated.<\/span><\/p>\n\r<p class=\"p_BodyText\"><span class=\"f_BodyText\">&nbsp;<\/span><\/p>\n\r"
})
