appSettings - Unity Client - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential

Unity Client

Platform
OnBase
Product
Unity Client
Release
Foundation 24.1
License
Premier
Standard
Essential

The following settings are available in the appSettings element of the Unity Client configuration file.

Note:

If a setting is not present in the Unity Client configuration file, add the setting in the format of <add key=" [attribute] " value=" [value] " /> .

Attribute

Description

mailclient

The value that specifies the email client that will be used to email documents from the Unity Client.

The following values are available:

  • outlook- Microsoft Outlook

  • lotus- IBM Lotus Notes

  • gmail- Google Gmail

  • groupwise- Novell GroupWise

When using the value groupwise, consider the following:

  • When sending messages with Novell GroupWise, plain text is the only format available.

  • When Microsoft Outlook and Novell GroupWise are installed on the same machine, using GroupWise as the default mail client for the Unity Client is not supported.

emailLinkAs

The value that determines whether Send To | Mail Recipient (as Link) is enabled and how links to documents will be sent.

The following values are available:

  • disabled- The Send To | Mail Recipient (as Link) option is unavailable.

  • docpop- DocPop links are sent via Send To | Mail Recipient (as Link).

    When using the value docpop, consider the following:

  • To send DocPop links, the user must have the Create Integration Hyperlink privilege.

  • A value must be set for the docpopurl attribute.

  • upop-file- Unity Pop files are sent via Send To | Mail Recipient (as Link).

    Note:

    To view Unity Pop files, the Unity Client must be running in Service mode. Within the ServiceMode element of the Unity Client configuration file, the enabled attribute and the Unity Pop attribute must be set to true.

  • upop- Unity Pop URI links are sent via Send To | Mail Recipient (as Link).

    When using the value upop, consider the following:

  • To view Unity Pop URI links, the Unity Client must be running in Service mode. Within the ServiceMode element of the Unity Client configuration file, the enabled attribute and the Unity Pop attribute must be set to true.

  • To send Unity Pop links, the user must have the Create Integration Hyperlink privilege.

docpopurl

The value that determines the DocPop link used when emailing DocPop links from the Unity Client.

The default value is http://[server]/[virtual directory]/docpop/docpop.aspx?docid={0}&amp;clienttype=html. Replace [server] with the name of your Web Server and [virtual directory] with the name of your virtual directory.

Note:

This setting is only supported when emailLinkAs is set to docpop.

MaxConcurrentAutoVueControls

The value that specifies the maximum number of concurrent instances allowed for AutoVue controls. The default value is 3. This attribute only applies to modules that use AutoVue controls.

Note:

Increasing this value may decrease the performance of your system.

PlanReviewEngineeringViewer

The value that specifies which viewer is used by the Electronic Plan Review module.

CAUTION:

This setting should not be modified unless you have been directed to do so by your solution provider.

An Electronic Plan Review license is required to use Electronic Plan Review in the Unity Client. For more information, see the Electronic Plan Review documentation.

scanlog

The value that enables scan logging when set to true. The default value is false.

Note:

The scanlog attribute is only respected when the enableModernScanning attribute is set to true. For more information, see the Document Imaging module reference guide.

The log file can be opened from the %LOCALAPPDATA%\Hyland Software, Inc\Hyland.Canvas.Controls\scanlog directory for up to three days after closing the Unity Client after scanning. Log files older than three days are deleted automatically.

suppressScriptErrors

The value that disables script errors from being displayed to users when set to true. The default value is false.

webBrowserRenderMode

The value that specifies the rendering browser used by default. Valid values are edge (for WebView2-enabled web browsers) and ie (for Internet Explorer). The default value is edge.

Note: HTML Custom Queries do not respect the webBrowserRenderMode attribute. HTML Custom Queries always render using WebView2.

virtualImageBuffer

The value that specifies the image size buffer. If an invalid value or no value is specified, the default value 1.5 is used.

Note:

This attribute should only be modified for troubleshooting purposes.

useImprovedImageViewerInterpolation

The value that enables improved image rendering when set to true. This attribute is not included in the Unity Client configuration file by default.

Note:

This attribute should only be added if text on image documents is difficult to read when set to different zoom levels, as it may impact performance.

useSystemBrowserForIdpLogin

This value determines whether the Unity Client uses the default System Browser or the embedded CEFSharp Browser to authenticate.

If set to true, the System Browser (such as Google Chrome or Firefox) will be used to authenticate. If set to true, the IdP Client configuration must also be updated to include http://127.0.0.1 as a redirect URL. For information on configuring redirect URLs, see the Integrating With Hyland IAM Services documentation.

If set to false, the embedded CEFSharp Browser will be used to authenticate.