Diagnostic Console

Docentric Diagnostic console is not released yet. However, some of the future elements are and System administrators can use them already.

Upgrade log

Upgrade log is a form introduced in version 3.4.5 and enables System administrators to: (1) view the upgrade log and (2) re-run Docentric Upgrade manager, which is important in cases when the upgrade manager failed during the upgrade procedure.

 

Docentric Upgrade manager serves to handle some changes of setup data which might be needed for upgrading to a particular product version. It runs only once after the upgrade procedure, when the first application session is created. If an error occurs during the upgrade procedure, it is shown as a notification to System administrators but now they can also see the error using the Upgrade log form.

The form can be invoked via the DocUpgradeLog menu item.

Clearing encrypted database fields

Usually, the upgrade procedure completes without issues, however we noticed one situation when it might fail. This happens when the database is migrated, e.g. from Production to UAT, because these environments, although belong to the same tenant, might have different certificate used for encrypting password fields.

Therefore at system startup (before the upgrade procedure) Docentric detects the environment change (from version 3.4.4) and clears all encrypted database table fields such as passwords and connections strings used in Docentric setup if reading their values fails. These are:

  • Additional email account passwords.
  • Electronic signature certificates stored in the database.
  • PDF encryption passwords.
  • Integration user passwords participating in SharePoint extended security.
  • Azure storage accounts connection strings.

You can also run the clearing manually if needed by invoking the DocEncryptedFieldsCleanup class manually. This class validates encrypted fields in Docentric tables and clears the fields that cannot be decrypted.

Another function of environment change detection is that the Suppress outgoing emails feature, that's configurable in Docentric AX parameters -> Emailing -> General settings, is set to Suppress with download.

This is done to prevent sending out unintended emails, because the data copied to DEV/UAT environments is usually from PROD environments, which means that the emails are actual real emails and sending them could be problematic.
This is applicable to:

  • Reports printed to Docentric Email print destination.
  • Emails sent via the Docentric Email distributor batch.

In addition to the above, when an environment change is detected, the Send email option for all lines in Docentric AX parameters -> Licensing -> License notification settings to No.

This is done to avoid duplicate or errant sending of email alerts for the Docentric license running out.

When debugging UAT/Sandbox database from development environment the system will detect it as environment change and will also clear encrypted fields for UAT users.

To prevent it disable environment change detection by adding the following key in the configuration > appSettings section in the web.config file, that is usually located in the AOSService\webroot directory:

<add key="Docentric.DetectEnvironmentChanged" value="false" />

 

See also

Tracing >>
Improved Table Browser >>

IN THIS ARTICLE