Web Application Management Console

Version 18
Copyright
Information in this document is subject to change without notice. The OnBase® software (the "Software")
described in this document is furnished only under a separate license agreement and may be used or copied
only according to the terms of such agreement. It is against the law to copy the Software except as
specifically allowed in the license agreement. This document or accompanying materials contains certain
information which is confidential information of Hyland Software, Inc. and which is subject to the
confidentiality provisions agreed to by you.
All data, names, and formats used in this document’s examples are fictitious unless noted otherwise.
Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under
copyright law, no part of this document may be reproduced, stored in or introduced into a retrieval system, or
transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or
for any purpose, without the express written permission of Hyland Software, Inc.
©
2018 Hyland Software, Inc. All rights reserved.
Depending on the modules licensed, the OnBase® software may include software developed and copyrighted
by third parties, including but not limited to the following:
A2iA CheckReader™ by A2iA Corp;
Adobe ® PDF Library™ by Adobe Systems Incorporated;
dtSearch® Text Retrieval Engine by dtSearch Corp.;
software or other content adapted from Smart Client – Composite UI Application Block by Microsoft
Corporation © 2005 Microsoft Corporation;
software or other content adapted from Microsoft patterns & practices ObjectBuilder © 2006 Microsoft
Corporation;
Nuance™ OCR © 1994-2012 Nuance Communications;
portions of imaging code owned and copyrighted by Pegasus Imaging Corporation, Tampa, FL;
Imaging Technology copyrighted by Snowbound Software Corporation, Snowbound.com;
CD-R technology by Sonic Solutions, Inc.;
full-text indexing technology by Autonomy;
IDSMail © 2005 by Intuitive Data Solutions;
jLex Copyright 1996-2003 by Elliot Joel Berk and C. Scott Ananian;
Rumba by NetManage;
AutoVue by Oracle America, Inc.
Streaming Powered by Wowza Streaming software
All rights reserved.
Further information regarding third-party software included in OnBase can be found in the About box within
the Software.
Hyland, Hyland Software ®, and OnBase® are registered and/or unregistered trademarks of Hyland Software,
Inc. in the United States and other countries. A2iA CheckReader™ is a trademark of A2iA Corporation.
Adobe ® PDF Library™ is a trademark of Adobe Systems Incorporated.
All other trademarks, service marks, trade names and products of other companies are the property of their
respective owners.
Document Name ........................................................................Web Application Management Console
Department/Group.......................................................................................................... Documentation
Revision Number ................................................................................................................................. 18

© 2018 Hyland Software, Inc. ii

© 2018 Hyland Software, Inc. iii
Using the Module Reference Guide (MRG)
If you are unfamiliar with module reference guides (MRGs), please review the content below so
that you can more quickly and efficiently locate the information you need.
The MRG is a PDF document containing all available instructions for a module. The content in this
MRG is considered module-specific. You may be referred to another MRG if a referenced function
is not specific to this module.
Each MRG typically includes the following chapters:
• Exposure - Provides introductory information and license requirements.
• Usage - Provides procedures for user-facing functionality.
• Configuration - Provides procedures for configuration and system administration.
• Installation - Provides system requirements and installation procedures.
You can open any chapter or section in the MRG by clicking its entry in the Table of Contents.
It is considered a best practice to read through an entire procedure before attempting to complete
any of its steps. Pay close attention to notes, tips, and cautions, which can help you better
understand the entire process and discover any prerequisites you may not have completed.
The MRGs use notes, tips, and cautions to draw your attention to additional information.

Note: A note provides supplemental information or highlights behavior you might not expect.

Tip: A tip describes extra, non-crucial information, such as a shortcut, reminder, or use for a
feature you might not think of.

Caution: Cautions are designed to help protect the system from data loss or severe issues that
may arise when an instruction is not followed properly.

Cross-references are links to related information or additional instructions you may need to
complete a task. Click a cross-reference to navigate to the referenced section. To return to the
page you were viewing before following a cross-reference, press Alt + Left Arrow until the desired
page is displayed.
Searching: The following search instructions pertain to viewing an MRG in Adobe Reader or Adobe
Acrobat. Some information may not apply to other PDF readers.
• Basic search: Press Ctrl + F . Enter the word or phrase you are looking for in the search
box and press Enter to locate each instance.
• Advanced search: Press Ctrl + Shift + F to find all instances of a phrase in an MRG or
folder. In the Search dialog box, enter the word or phrase you are looking for, and then
select one of the following options:
• In the current document - Searches the document you are viewing.
• All PDF Documents in - Searches a selected folder or directory. If you are unsure of
which MRG to search, try searching the folder where your MRGs are located to
display all results for the word or phrase.

© 2018 Hyland Software, Inc. iv

 Web Application Management Console
Table of Contents

Using the Module Reference Guide (MRG) ........................................................................................iv

EXPOSURE
Overview ....................................................................................................................................................1
Applications ...............................................................................................................................................1
Licensing .....................................................................................................................................................1

USAGE
Starting the Web Application Management Console .......................................................................3
Web Application Management Console Settings ..............................................................................4
Web Server Web.config........................................................................................................................................ 5
Web Client Tab .............................................................................................................................................. 5
Server Configuration Tab ............................................................................................................................. 6
Login Tab ...................................................................................................................................................... 6
ActiveX Tab ................................................................................................................................................... 7
Integrations Tab ........................................................................................................................................... 7
DocPop Tab ........................................................................................................................................... 8
PDFPop Tab ........................................................................................................................................... 9
FormPop Tab ....................................................................................................................................... 10
FolderPop Tab ..................................................................................................................................... 11
PacketPop Tab .................................................................................................................................... 12
E-Forms - Login Form Proc Tab .......................................................................................................... 12
Menus Tab .................................................................................................................................................. 13
Viewer Tab .................................................................................................................................................. 14
WorkView Tab ............................................................................................................................................. 14
Workflow Tab .............................................................................................................................................. 15
Retrieval Tab ............................................................................................................................................... 15
Document Import Tab ................................................................................................................................ 16
Foldering Tab .............................................................................................................................................. 16
Data Mining Tab ......................................................................................................................................... 17
Miscellaneous Tab ..................................................................................................................................... 17
ADFS Settings Tab ...................................................................................................................................... 18
Application Server Web.config .......................................................................................................................... 19
Application Server Tab ............................................................................................................................... 19
Integrations Tab ......................................................................................................................................... 19
DocPop Tab ......................................................................................................................................... 20
EIS Tab ................................................................................................................................................. 20
Commerce Tab .................................................................................................................................... 20
Viewer Tab .................................................................................................................................................. 21
Miscellaneous Tab ..................................................................................................................................... 21
ADFS Settings Tab ...................................................................................................................................... 22
Agenda Online Web.config ................................................................................................................................ 22

OnBase 18
©2018
v
Hyland Software, Inc.
 Web Application Management Console
Table of Contents

Agenda Public Access Tab ........................................................................................................................ 23

Settings Tab ................................................................................................................................................ 23
Mobile Applications Broker Server Web.config................................................................................................ 23
Mobile Broker Tab ...................................................................................................................................... 24
Server Configuration Tab ........................................................................................................................... 24
Gateway Caching Server Web.config................................................................................................................ 25
Public Access Server Web.config ..................................................................................................................... 25
Login Tab .................................................................................................................................................... 26
Server Configuration Tab ........................................................................................................................... 26
Retrieval Tab ............................................................................................................................................... 28
Public Access Required Keywords ............................................................................................................ 31
Public Access Theme Designer ................................................................................................................. 33
Creating a New Theme ............................................................................................................................... 33
Modifying an Existing Theme .................................................................................................................... 34
Duplicating an Existing Theme .................................................................................................................. 36
Modifying a Theme ..................................................................................................................................... 37
eCommerce Client Web.config.......................................................................................................................... 41
Server Configuration Tab .................................................................................................................... 42
Settings Tab ......................................................................................................................................... 42
Payment Processor Tab ...................................................................................................................... 43
Doc Preview Tab .................................................................................................................................. 43
Electronic Plan Review Web.config................................................................................................................... 44
Server Configuration Tab .................................................................................................................... 44
Plan Review Tab .................................................................................................................................. 44
Settings Tab ......................................................................................................................................... 44
Single Sign On Tab .............................................................................................................................. 45
Reporting Dashboards Web Viewer Web.config .............................................................................................. 46
Editing Settings ...................................................................................................................................... 48
Encrypting Settings ............................................................................................................................... 49
Exporting Settings ................................................................................................................................. 49
Importing Settings ................................................................................................................................. 50
Configuring ADO.NET Connection Strings ...................................................................................... 50
Creating Connection Strings.............................................................................................................................. 51
Modifying Connection Strings ........................................................................................................................... 55
Deleting Connection Strings .............................................................................................................................. 57
Changing Web Applications ................................................................................................................ 59
OnBase Web Client Contexts and Control Bars ............................................................................. 59
Default Context Info Tab.................................................................................................................................... 60
Document Tab .................................................................................................................................................... 61
Context ........................................................................................................................................................ 61
Control Bars ................................................................................................................................................ 61
Workflow Tab ..................................................................................................................................................... 61
WorkView Tab .................................................................................................................................................... 62

OnBase 18
©2018
vi
Hyland Software, Inc.
 Web Application Management Console
Table of Contents

KnowledgeTransfer Tab .................................................................................................................................... 62

Collaboration Tab............................................................................................................................................... 62
Context ........................................................................................................................................................ 62
Control Bars ................................................................................................................................................ 62
StatusView Tab .................................................................................................................................................. 63
Context ........................................................................................................................................................ 63
Control Bars ................................................................................................................................................ 63
Folders Tab......................................................................................................................................................... 63
User Tab.............................................................................................................................................................. 63
Context ........................................................................................................................................................ 63
Control Bars ................................................................................................................................................ 63
Admin Tab .......................................................................................................................................................... 64
Context ........................................................................................................................................................ 64
Control Bars ................................................................................................................................................ 64
Help Tab.............................................................................................................................................................. 64
Adding or Editing Contexts and Control Bars ................................................................................. 65
Editing OnBase Diagnostics Console Settings ................................................................................ 66
Copying the Application ...................................................................................................................... 67
Configuring Impersonation ................................................................................................................. 67
Installing Event Logs & Performance Counters .............................................................................. 69
Installing Event Logs .......................................................................................................................................... 69
Installing Performance Counters ...................................................................................................................... 70
Monitoring Performance ............................................................................................................................ 71
Uninstalling Event Logs & Performance Counters ........................................................................................... 72
Optimizing Applications for Windows Authentication ................................................................ 72
Viewing Version Information ............................................................................................................. 72

CONFIGURATION
WebApplicationManagementConsole.exe.config Settings ......................................................... 73
appSettings......................................................................................................................................................... 73
Web Application Management Console Settings ..................................................................................... 73
Web.config Settings ................................................................................................................................... 74

INSTALLATION
Requirements ......................................................................................................................................... 76
Microsoft .NET Framework Requirements ....................................................................................................... 76
Databases Supported ........................................................................................................................................ 76
Microsoft SQL Server ................................................................................................................................. 76
Oracle .......................................................................................................................................................... 77
SAP SQL Anywhere .................................................................................................................................... 77
Database/File Servers........................................................................................................................................ 78

OnBase 18
©2018
vii
Hyland Software, Inc.
 Web Application Management Console
Table of Contents

Third-Party Software Compatibility ................................................................................................................... 78

About Virtual Environments............................................................................................................................... 78
64-Bit Support Statement .................................................................................................................................. 79
Licensing............................................................................................................................................................. 79
Installation .............................................................................................................................................. 79
Command Line Switches ................................................................................................................................... 79
-CONFIGPATH ............................................................................................................................................. 79
-ROMANZO .................................................................................................................................................. 80
Contacting Support ............................................................................................................................... 80

WEB APPLICATION MANAGEMENT CONSOLE BEST PRACTICES

Usage ........................................................................................................................................................ 81
Editing Settings .................................................................................................................................................. 81
Exporting Settings .............................................................................................................................................. 81

OnBase 18
©2018
viii
Hyland Software, Inc.
 EXPOSURE

Overview
The Web Application Management Console helps administrators correctly configure settings
for the following OnBase applications:
• Web Server
• Application Server
• Mobile Applications Broker Server
• Gateway Caching Server
• Public Access Server
• Document eCommerce
• Electronic Plan Review
• Reporting Dashboards Web Viewer
With each version of OnBase that is released, new settings are added to each application’s
Web.config configuration file. These settings need to be configured appropriately for desired
functionality. As more settings are added, configuration overhead increases. The Web
Application Management Console ensures that valid settings are entered without accidentally
deleting or modifying existing settings.

Applications
The Web Application Management Console simplifies the process of modifying configuration
settings for the OnBase Web Server, Application Server, Mobile Applications Broker Server,
Gateway Caching Server, Public Access Server, eCommerce, Electronic Plan Review, and
Reporting Dashboards Web Viewer modules. Instead of modifying lengthy text-based
Web.config configuration files, the Web Application Management Console displays these files
in a Windows-based application. Settings are grouped together on tabs according to
functionality. For example, Web Client settings are contained on the Web Client tab. The Web
Application Management Console also assists OnBase administrators, installers, and technical
support with troubleshooting configuration issues.

Licensing
No licensing is required to use the Web Application Management Console. The Web Application
Management Console does not check for the presence of licenses when opening Web.config
configuration files. For this reason, you may have access to settings, contexts, and controls
bars that do not pertain to your OnBase solution. Ensure that you are familiar with your OnBase
solution’s licensing before using the Web Application Management Console.

OnBase 18 1
©2018
Hyland Software, Inc.
 Web Application Management Console
Exposure

Check your current licensing status by selecting Utils | Product Licenses from the
Configuration module.

OnBase 18 2
©2018
Hyland Software, Inc.
 U SAGE

Starting the Web Application Management Console

To start the Web Application Management Console:
1. From the Start menu, select All Programs | Hyland | Web Application Management
Console | Web Application Management Console .

Note: If the Web Application Management Console is not available from the Start menu,
navigate to the location where it was installed and double-click
WebApplicationManagementConsole.exe. In a 32-bit environment, this file is typically installed
at C:\Program Files\Hyland\Web Applications Management Console. In a 64-bit environment,
the file is installed at C:\Program Files (x86)\Hyland\Web Applications Management Console.

2. If Windows User Account Control (UAC) is enabled on your system, then a prompt is
displayed indicating that administrative access is required. Click OK to run the console
as an administrator.
For details on UAC, refer to your Microsoft support information or see http://
technet.microsoft.com/en-us/library/cc709691(WS.10).aspx.
3. Depending on how the Web Application Management Console is configured, you may be
prompted to select a web application:

The Web Application Management Console works with the following web applications:
• Web Server
• Application Server
• OnBase Agenda Online

OnBase 18 3
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

• Mobile Applications Broker Server

• Gateway Caching Server
• Public Access Server
• Document eCommerce
• Electronic Plan Review
• Reporting Dashboards Web Viewer
4. Select a web application and click OK .

Note: In a typical installation, the Web Server is named AppNet. The Application Server is
named AppServer. The names of the Gateway Caching Server, Public Access Server,
eCommerce, and Electronic Plan Review applications vary per installation.

5. The Web Application Management Console opens, displaying the Web.config settings
for the selected web application.
If an Error while loading message is displayed, then the Web.config file may have some
invalid values that need to be modified. These values will be highlighted in red in the
Web Application Management Console. Look for the tabs with asterisks ( * ) in their
labels to locate these settings.

Web Application Management Console Settings

The settings available in the Web Application Management Console vary depending on which
application’s Web.config file is displayed. Settings for both Web.config files are grouped on
tabs in the Web Application Management Console according to functionality. For example, Web
Client settings are contained on the Web Client tab. The fields in the Web Application
Management Console and their corresponding Web.config settings are described in the
following sections.

Note: When entering values into the fields for each of the settings, it is recommended that you
type the values in the field. If you use copy/paste, this could impact how the value is translated
into the .config files.

For information about each application’s settings, see the following topics:
• Web Server Web.config on page 5
• Application Server Web.config on page 19
• Mobile Applications Broker Server Web.config on page 23
• Gateway Caching Server Web.config on page 25
• Public Access Server Web.config on page 25
• eCommerce Client Web.config on page 41

OnBase 18 4
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

• Electronic Plan Review Web.config on page 44

• Reporting Dashboards Web Viewer Web.config on page 46

Note: Settings that are not listed in this reference guide may be custom settings, or they may
be settings that have recently had support added to the Web Application Management Console.

Web Server Web.config

When the Web Server’s Web.config file is opened in the Web Application Management Console,
the tabs and settings described in the following sections are displayed.

Note: For further information on what each Web Server setting in the Web Application
Management Console controls, see the Web Server documentation. Search the Web Server
documentation for the setting contained in the Web Server Web.Config Setting column.

Tip: Hover your pointer over a setting’s name in the Web Application Management Console to
display a tooltip briefly describing the setting.

Web Client Tab

The settings on this tab are the basic settings for the Web Client.

Web Application Management Console Field Web Server Web.Config Setting

Data Source dmsDataSource

Virtual Directory dmsVirtualRoot

Allow Insecure Connections AllowInsecureConnection

Server Designation ServerDesignation

Web Client Type WebClientType

Override UI Language OverrideUILanguage

Default UI Locale DefaultUILocale

Session Expiration EnableSessionExpiration

Prompt on Session Expire PromptOnSessionExpire

Session Timeout sessionState timeout

Close on Logout LogoutClose

Logout Redirect URL logoutRedirectURL

OnBase 18 5
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Web Application Management Console Field Web Server Web.Config Setting

Native Mail System NativeMailSystem

Internal Mail Time (in seconds) InternalMailTimerSeconds

Allowed Function Key List AllowedFunctionKeyList

Windows Server locale format WindowsServerLocaleFormat

Max Results MaxResults

Server Configuration Tab

The settings on this tab are used to configure the server.

Web Application Management Console Field Web Server Web.Config Setting

Service Client Type ServiceClientType

Application Server URL ApplicationServer Url

Allow NT Authentication On Forwarding AllowNTAuthenticationOnForwarding

Tracing Info Level hylandTracing

HttpRuntime Maximum Request Length (KB) maxRequestLength

HttpRuntime Execution Timeout (Seconds) executionTimeout

Max Allowed Content Length (Bytes) maxAllowedContentLength

Login Tab
The settings on this tab customize how login is handled.

Web Application Management Console Field Web Server Web.Config Setting

Default User Name default_username

Default Password default_password

Default Domain Name default_domainname

Default Institution default_institution

Enable Login Autocomplete EnableLoginAutocomplete

Auto Login EnableAutoLogin

Force OnBase Authentication forceSSOAutoLoginOverDomain

OnBase 18 6
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Web Application Management Console Field Web Server Web.Config Setting

Custom SSO Authentication Failure Page CustomSSOAuthenticationFailurePage

Silverlight Default User Name SLDefaultUsername

Silverlight Default Password SLDefaultPassword

ActiveX Tab
The settings on this tab are only used when the Web Client is in ActiveX mode.

Web Application Management Console Field Web Server Web.Config Setting

Spicer Code Version spicerCodeBase

Autozoom Thumbnail Configuration autoZoomThumbnail

Integrations Tab
Multiple integrations can be configured under the Integrations tab. Click one of the following
tabs to configure the corresponding integration:
• DocPop Tab on page 8
• PDFPop Tab on page 9
• FormPop Tab on page 10
• FolderPop Tab on page 11
• PacketPop Tab on page 12
• E-Forms - Login Form Proc Tab on page 12

OnBase 18 7
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

DocPop Tab
The settings on this tab are specific to DocPop. The only required setting is DocPop Data
Source , which can be configured in the Web Application Management Console or passed in a
query string.

Web Application Management Console Field Web Server Web.Config Setting (Located in
Hyland.Web.DocPop)

Default DocPop User Name username

Default DocPop Password password

DocPop Data Source datasource

Default DocPop Domain Name domain

Default DocPop Institution institution

Embedded DocPop embedded

Default Login enableDefaultLogin

HTTP Login enableHTTPLogin

Auto Login enableAutoLogin

HTTP Data Source enableHTTPDataSource

Validate Against Checksum enableChecksum

Checksum checksum

Core Query API License enableCoreQueryAPILicense

Encrypt DocPop (N/A)

Encrypts all DocPop Web.config settings within
an EncryptedData element.
See Encrypting Settings on page 49.

Auto Display One Document AutoDisplayOneDocument

Disable Context Menus in DocPop disableContextMenu

Note: The Web.config settings in this table are located in the Hyland.Web.DocPop element.
There are other Web.config settings with the same name (for example, datasource ); these
settings are located in different elements.

OnBase 18 8
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

PDFPop Tab
The settings on this tab are specific to PDFPop. The only required setting is PdfPop Data
Source , which can be configured in the Web Application Management Console or passed in a
query string.

Web Application Management Console Field Web Server Web.Config Setting (Located in
Hyland.Web.PdfPop)

Default PdfPop User Name username

Default PdfPop Password password

PdfPop Data Source datasource

Default PdfPop Domain Name domain

Default PdfPop Institution institution

Embedded PdfPop embedded

Default Login enableDefaultLogin

HTTP Login enableHTTPLogin

Auto Login enableAutoLogin

HTTP Data Source enableHTTPDataSource

Validate Against Checksum enableChecksum

Checksum checksum

Core Query API License enableCoreQueryAPILicense

Encrypt PdfPop (N/A)

Encrypts all PDFPop Web.config settings within
an EncryptedData element.
See Encrypting Settings on page 49.

Auto Display One Document AutoDisplayOneDocument

Note: The Web.config settings in this table are located in the Hyland.Web.PdfPop element.
There are other Web.config settings with the same name (for example, datasource ); these
settings are located in different elements.

OnBase 18 9
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

FormPop Tab
The settings on this tab are specific to FormPop. The only required setting is FormPop Data
Source , which can be configured in the Web Application Management Console or passed in a
query string.

Web Application Management Console Field Web Server Web.Config Setting (Located in
Hyland.Web.FormPop)

Default FormPop User Name username

Default FormPop Password password

FormPop Data Source datasource

Default FormPop Domain Name domain

Default FormPop Institution institution

Embedded FormPop embedded

Default Login enableDefaultLogin

HTTP Login enableHTTPLogin

Auto Login enableAutoLogin

HTTP Data Source enableHTTPDataSource

Validate Against Checksum enableChecksum

Checksum checksum

Core Query API License enableCoreQueryAPILicense

Encrypt FormPop (N/A)

Encrypts all FormPop Web.config settings within
an EncryptedData element.
See Encrypting Settings on page 49.

Auto Display One Document AutoDisplayOneDocument

Note: The Web.config settings in this table are located in the Hyland.Web.FormPop element.
There are other Web.config settings with the same name (for example, datasource ); these
settings are located in different elements.

OnBase 18 10
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

FolderPop Tab
The settings on this tab are specific to FolderPop. The only required setting is FolderPop Data
Source , which can be configured in the Web Application Management Console or passed in a
query string.

Web Application Management Console Field Web Server Web.Config Setting (Located in
Hyland.Web.FolderPop)

Default FolderPop User Name username

Default FolderPop Password password

FolderPop Data Source datasource

Default FolderPop Domain Name domain

Default FolderPop Institution institution

Embedded FolderPop embedded

Default Login enableDefaultLogin

HTTP Login enableHTTPLogin

Auto Login enableAutoLogin

HTTP Data Source enableHTTPDataSource

Validate Against Checksum enableChecksum

Checksum checksum

Core Query API License enableCoreQueryAPILicense

Encrypt FolderPop (N/A)

Encrypts all FolderPop Web.config settings
within an EncryptedData element.
See Encrypting Settings on page 49.

Note: The Web.config settings in this table are located in the Hyland.Web.FolderPop element.
There are other Web.config settings with the same name (for example, datasource ); these
settings are located in different elements.

OnBase 18 11
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

PacketPop Tab
The settings on this tab are specific to PacketPop.

Web Application Management Console Field Web Server Web.Config Setting (Located in
Hyland.Web.PacketPop)

PacketPop Data Source datasource

Validate Against Checksum enableChecksum

Checksum checksum

Note: The Web.config settings in this table are located in the Hyland.Web.PacketPop element.
There are other Web.config settings with the same name (for example, datasource ); these
settings are located in different elements.

E-Forms - Login Form Proc Tab

The settings on this tab are specific to submitting E-Forms using LoginFormProc.

Web Application Management Console Web Server Web.Config Setting (Located in

Field Hyland.Web.LoginFormProc)

LoginFormProc User Name username

LoginFormProc Password password

LoginFormProc Data Source datasource

Encrypt Login Form Proc (N/A)

Encrypts all LoginFormProc Web.config settings
within an EncryptedData element.
See Encrypting Settings on page 49.

Prompt for New Form prompt

Note: The Web.config settings in this table are located in the Hyland.Web.LoginFormProc
element. Other Web.config settings with the same name are located in different elements.

OnBase 18 12
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Menus Tab
The settings on this tab enable/disable right-click menu options in the document viewer.

Web Application Management Console Web Server Web.Config Setting

Field

Add Note Menu addNoteMenu

Create New Document Menu createDocumentMenu

Document Properties Menu documentPropertiesMenu

File Menu fileMenu

History Menu historyMenu

Keywords Menu keywordsMenu

Print Menu printMenu

Reindex Menu reindexMenu

Workflow Menu workflowMenu

Sent to Print Queue Menu sendToPrintQueueMenu

Viewer Control Menu viewerControlMenu

Text Search Menu textSearchMenu

Pages Menu pagesMenu

Clipboard Menu clipBoardMenu

Mail Recipient Menu mailRecipientMenu

First Page Menu firstPageMenu

Previous Page Menu previousPageMenu

Next Page Menu nextPageMenu

Last Page Menu lastPageMenu

Goto Page Menu gotoPageMenu

Zoom In Menu zoomInMenu

Zoom Out Menu zoomOutMenu

OnBase 18 13
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Viewer Tab
The settings on this tab control what the user sees in the Web Client.

Web Application Management Console Web Server Web.Config Setting

Field

Zoom Level zoomLevelOR

Overlay overlayOR

Goto Page gotoPageOR

Disable Context Menu DisableContextMenu

Left Border rectLeftOR

Right Border rectRightOR

Top Border rectTopOR

Bottom Border rectBottomOR

Viewer Control Toolbar enableViewerControlToolbar

Thumbnail Pages enableThumbnailPages

Annotation Toolbar enableAnnotationToolbar

Note Toolbar enableNoteToolbar

Auto Orient Printing autoOrientPrinting

Default Print Range defaultPrintRange

Documents Print As PDFs HTMLOnlyDocumentsPrintAsPDFs

Prevent Viewer Client Caching PreventViewerClientCaching

WorkView Tab
The settings on this tab customize WorkView.

Web Application Management Console Web Server Web.Config Setting

Field

WorkView Max Results WVMaxResults

WorkView Filter Count WVFilterCount

Display Created E-Forms displayCreatedEForms

OnBase 18 14
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Workflow Tab
The settings on this tab customize Workflow.

Web Application Management Console Web Server Web.Config Setting

Field

Workflow Height (px) WorkflowUserInteractionHeight

Default Workflow Layout WorkflowLayout

Display Related Documents DisplayRelatedDocuments

Show Combined Inbox ShowCombinedInbox

Show Queue Counts showQueueCounts

Reselect Delta reselectDelta

Workflow Max Results WorkflowMaxResults

Retrieval Tab
The settings on this tab customize document retrieval.

Web Application Management Console Web Server Web.Config Setting

Field

Row Coloring enableRowColoring

Number of Document Types to Display NumDisplayedDocumentTypes

Keyword Panel View Type KeywordPanelViewType

Enable Keyword Operators EnableKeywordOperators

Admin Security Keywords AllowSecurityKeywordsAdmin

Remember Hitlist Height RememberHitListHeight

Prompt User Queries promptUserQueries

Text Search Auto View textSearchAutoView

Display Single Document displaySingleDocument

EDM Briefcase EnableBriefcaseEDM

Open Rich Text Format Documents with OpenRTFasMSWord

Microsoft Word

OnBase 18 15
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Web Application Management Console Web Server Web.Config Setting

Field

Open Microsoft Office Documents in openOfficeDocumentsInSeparateWindow

Separate Window

Enable Retrieve Transactions RetrieveTransaction

Sort by Document ID RetrieveTransactionSortByDocId

Allow Caching ThumbnailHitListAllowCaching

Show Previews ThumbnailHitListShowPreviews

User Configurable ThumbnailHitListUserConfigurable

Number of Columns ThumbnailHitListColumns

Maximum Width ThumbnailHitListThumbnailMaxWidth

Maximum Height ThumbnailHitListThumbnailMaxHeight

Preview Maximum Width ThumbnailHitListPreviewMaxWidth

Preview Maximum Height ThumbnailHitListPreviewMaxHeight

Document Import Tab

The settings on this tab control the default behavior for the Import Document panel.

Web Application Management Console Web Server Web.Config Setting

Field

Clear Document Type After Import ClearDocumentTypeAfterImport

Clear Keywords After Import ClearKeywordsAfterImport

Always Generate Preview AlwaysGeneratePreviewAfterUpload

Maximum Import Queue Size MaxImportQueueSize

Foldering Tab
The settings on this tab control the default size of the folder tree, folder list, and document list.

Web Application Management Console Web Server Web.Config Setting

Field

Folder Tree Width (%) FolderTreeWidth

OnBase 18 16
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Web Application Management Console Web Server Web.Config Setting

Field

Folder Tree Height (%) FolderTreeHeight

Document List Height (%) DocumentListHeight

Folder List Height (%) FolderListHeight

Data Mining Tab

The settings on this tab are used for the Report Mining Integration for Datawatch Report Mining
Server.

Web Application Management Console Web Server Web.Config Setting

Field

Data Mining enableDataMine

Data Mining Temp Directory DataMiningTempDirectory

Data Mining Report Server Name DataMiningReportServerName

Data Mining URL DataMiningURL

Additional Models DataMiningAdditionalModels

Miscellaneous Tab
The settings on this tab are miscellaneous and do not fit into any of the above tabs.

Web Application Management Console Field Web Server Web.Config Setting

Use FolderPop Viewer UseFolderPopViewer

Max JSON Deserializer Members aspnet:MaxJsonDeserializerMembers

Application Enabler Integration sv_AppEnableIntegration

Launch Application Enabler sv_LaunchAppEnabler

SharePoint Online SharepointOnline

SharePoint Viewer Show Workflow SPViewerShowWorkflow

Allow View Source AllowViewSource

Enable Virtual Print Driver enableVirtualPrintDriver

Prompt with Unread DKT Docs PromptWithUnreadDKTDocs

OnBase 18 17
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Web Application Management Console Field Web Server Web.Config Setting

Enable Legacy Checksum Fallback EnableLegacyChecksumFallback

Keyword Typeahead Character Minimum KeywordDropdownTypeaheadCharacter

Minimum

OWIN Automatic App Startup owin:AutomaticAppStartup

IdPUrl IdPUrl

MaxResults MaxResults

ADFS Settings Tab

The settings on this tab are used to enable AD FS. In order to configure AD FS, you must run the
Configure For ADFS menu item from the Tools menu. See the Authentication module reference
guide for more information.

Web Application Management Console Field Web Server Web.Config Setting

Authentication Mode authentication mode

ADFS Enabled adfs enabled

Audience URI audienceUris

Trusted Issuer Thumbprint trustedIssuers thumbprint

Trusted Issuer Name trustedIssuers name

Cookie Handler Require SSL cookieHandler requireSsl

wsFederation Issuer wsFederation issuer

wsFederation Realm wsFederation realm

Certificate X509FindType certificateReference x509FindType

Certificate Find Value certificateReference findValue

Certificate Store Location certificateReference storeLocation

Certificate Store Name certificateReference storeName

OnBase 18 18
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Application Server Web.config

When the Application Server’s Web.config file is opened in the Web Application Management
Console, the tabs and settings described in the following sections are displayed.

Note: For further information on what each Application Server setting in the Web Application
Management Console controls, see the Application Server documentation. For module-specific
settings, see the module’s documentation. Search the documentation for the setting contained
in the Application Server Web.Config Setting column.

Tip: Rest your pointer over a setting’s name in the Web Application Management Console to
display a brief description of the setting.

Application Server Tab

The settings on this tab are the basic settings for the Application Server.

Web Application Management Console Application Server Web.Config Setting

Field

Data Source dmsdatasource

Use OS Authentication UseOSAuthentication

Allow Insecure Connections AllowInsecureConnection

Session Timeout sessionState timeout

HttpRuntime Maximum Request Length maxRequestLength

(KB)

HttpRuntime Execution Timeout executionTimeout

(Seconds)

Max Allowed Content Length (Bytes) maxAllowedContentLength

Item Cache Timeout ItemCacheTimeout

Server Designation ServerDesignation

Integrations Tab
Multiple integrations can be configured under the Integrations tab. Click one of the following
tabs to configure the corresponding integration:
• DocPop Tab on page 20
• EIS Tab on page 20
• Commerce Tab on page 20

OnBase 18 19
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

DocPop Tab
The settings on this tab are specific to DocPop.

Web Application Management Console Application Server Web.Config Setting

Field

Checksum DPChecksum

Enable Checksum EnableChecksum

EIS Tab
The settings on this tab are specific to the Enterprise Integration Server.

Web Application Management Console Application Server Web.Config Setting

Field

AppNet Directory AppNetDirectory

Use HTML Client Type UseHTMLClientType

Validate Message Schema ValidateMessageSchema

Continue on Validation Error ContinueOnValidationError

Data Set Cache Cleanup Interval (Minutes) DataSetCacheCleanUpIntervalInMins

Commerce Tab
The settings on this tab are specific to eCommerce.

Web Application Management Console Application Server Web.Config Setting

Field

Commerce User Name user

Commerce Password password

Commerce Minimum Pool Size minPoolSize

Commerce Maximum Pool Size maxPoolSize

Commerce UserLevel Minimum Pool Size userLevelMinPoolSize

Commerce UserLevel Maximum Pool Size userLevelMaxPoolSize

Commerce Maximum Query Count maxQueryResults

OnBase 18 20
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Web Application Management Console Application Server Web.Config Setting

Field

Separate Purchase Jobs by Purchase filterPurchasedDocsByAction

Action

Encrypt Commerce Select this option to encrypt the username and

password specified in the web.config file.

Viewer Tab
The following settings affect the display of JPEG-compressed TIFF images.

Web Application Management Console Application Server Web.Config Setting

Field

Raw Images RawImagesAllowed

Compression Quality CompressionQuality

Miscellaneous Tab
The Miscellaneous tab may contain additional settings have been added to the Application
Server’s Web.config file as part of a custom solution. This tab may also be available for
recently added settings that do not fall under other available tabs.
The following settings are available:

Web Application Management Console Application Server Web.Config Setting

Field

Document Query Warning Threshold DocumentQueryWarningThreshold

Document Query Limit DocumentQueryLimit

Watch Folder watchFolder

Site ID Keyword Type siteIDKeywordType

Cleanup Timer Interval cleanupTimerInterval

Max File Age maxFileAgeInHours

Default Storage Path DefaultStoragePath

Enable Legacy Checksum Creation EnableLegacyChecksumCreation

Data Capture WCF Endpoint Address DataCaptureServerWCFEndpointAddress

GCSUsername GCSUsername

OnBase 18 21
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Web Application Management Console Application Server Web.Config Setting

Field

GCSPassword GCSPassword

GCSPhoneHomeIntervalInMinutes GCSPhoneHomeIntervalInMinutes

ADFS Settings Tab

The settings on this tab are used to enable AD FS. In order to configure AD FS, you must run the
Configure For ADFS menu item from the Tools menu. See the Authentication module reference
guide for more information.

Web Application Management Console Field Web Server Web.Config Setting

ADFS Enabled adfs enabled

Audience URI audienceUris

Trusted Issuer Thumbprint trustedIssuers thumbprint

Trusted Issuer Name trustedIssuers name

Cookie Handler Require SSL cookieHandler requireSsl

wsFederation Issuer wsFederation issuer

wsFederation Realm wsFederation realm

Certificate X509FindType certificateReference x509FindType

Certificate Find Value certificateReference findValue

Certificate Store Location certificateReference storeLocation

Certificate Store Name certificateReference storeName

Agenda Online Web.config

When the Agenda Online’s Web.config file is opened in the Web Application Management
Console, the tabs and settings described in the following sections are displayed.

Note: For further information on what each Agenda Online setting in the Web Application
Management Console controls, see the Agenda Online documentation. For module-specific
settings, see the module’s documentation.

OnBase 18 22
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Agenda Public Access Tab

The settings on this tab are used to configure public access.

Web Application Management Console Field OnBase Agenda Online.Config Setting

Encrypt Agenda Public Access Select this option to encrypt the username and
password specified in the web.config file.

Session User SessionUser

Session Password SessionPassword

Data Source DataSource

Settings Tab
The settings on this tab are used to configure the OnBase Agenda Online Settings.

Web Application Management Console Field OnBase Agenda Online.Config Setting

Service Client Type ServiceClientType

Application Server URL ApplicationServerUrl

Player Source File Path PlayerSourceFilePath

Player Version PlayerVersion

Style Cache Duration StyleCacheDuration

Search Start Year SearchStartYear

MinPoolSize MinPoolSize

MaxPoolSize MaxPoolSize

Mobile Applications Broker Server Web.config

When the Mobile Applications Broker Server’s Web.config file is opened in the Web Application
Management Console, the tabs and settings described in the following sections are displayed.

Note: For further information on what each Mobile Application Server setting in the Web
Application Management Console controls, see the Mobile Applications Broker Server module
reference guide.

Tip: Rest your pointer over a setting’s name in the Web Application Management Console to
display a tooltip briefly describing the setting.

OnBase 18 23
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Mobile Broker Tab

The settings on this tab are the basic settings for the Mobile Applications Broker Server.

Web Application Management Console Mobile Applications Broker Server Web.Config

Field Setting

Data Source dataSource

Timeout timeout

Enable SSL Support enableSslSupport

Domain domain

Enable Offline Access enableOfflineAccess

Institutional Database institutionalDatabase

File Chunk Size (Bytes) fileChunkSizeBytes

Max Request Size (Bytes) maxRequestSizeBytes

Server Configuration Tab

The settings on this tab are used to configure the server.

Web Application Management Console Field Mobile Applications Broker Server

Web.Config Setting

Service Client Type ServiceClientType

Application Server URL ApplicationServer Url

OnBase 18 24
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Gateway Caching Server Web.config

When the Gateway Caching Server’s Web.config file is opened in the Web Application
Management Console, the settings described in the following table are displayed.

Note: For information about what each setting controls, search the Gateway Caching Server
documentation for the setting contained in the Gateway Caching Server Web.Config Setting
column.

Tip: Rest your pointer over a setting’s name in the Web Application Management Console to
display a tooltip briefly describing the setting.

Web Application Management Console Gateway Caching Server Web.Config Setting

Field

User Name username

Password password

Encrypt Login Settings (N/A)

Encrypts the username and password Web.config
settings within an EncryptedData element.
See Encrypting Settings on page 49.

Gateway Name gatewayName

Data Source dataSource

Cache Path cachePath

Allow Insecure Connections AllowInsecureConnection

Public Access Server Web.config

When the Public Access Server Web.config file is opened in the Web Application Management
Console, the tabs and settings described in the following sections are displayed.

Note: For information about each Public Access Server setting in the Web Application
Management Console, see the Public Sector Constituency Web Access documentation.

Tip: Rest your pointer over a setting’s name in the Web Application Management Console to
display a tooltip briefly describing the setting.

OnBase 18 25
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Login Tab
The Login tab contains settings which control how the API, and by proxy the front-end client,
connects and logs in to OnBase. These settings correspond to attributes in the
<Hyland.Web.PublicAccess> element of the Public Access web.config file.

WAMCon Setting/ Description

Web.config Attribute

User name Enter the OnBase user configured for public use.
user

Password Enter the password associated with the public user account.
password

Data Source Enter the name of the data source used to connect to OnBase.
datasource

Encrypt Public Access For additional security, select to encrypt login settings within an
(No web.config attribute) <EncryptedData> element of the web.config file.
See the Encrypting Settings section of the Web Application
Management Console documentation for more information on
encrypted data.

Server Configuration Tab

The Server Configuration tab contains settings which control how the API communicates with
the Application Server. These settings correspond to attributes in the <Hyland.Services.Client>
and <system.web> elements of the Public Access web.config file.

WAMCon Setting/ Description

Web.config Attribute

Service Client Type Specify the type of communication method used to connect to the
ServiceClientType Application Server:
• Set to Remoting for the API to use binary over HTTP to
communicate with the Application Server.
• Set to SOAP for the API to use XML SOAP over HTTP to
communicate with the Application Server.

Application Server URL Enter the base URL of the Application Server’s virtual directory.
Url The URL must end in Service.rem for Remoting connections or
Service.aspx for SOAP connections.

OnBase 18 26
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

WAMCon Setting/ Description

Web.config Attribute

Allow NT Authentication On If your system is configured for NT Authentication select this

Forwarding option, or set the attribute to true , to allow the API to forward NT
AllowNTAuthentication credentials to the Application Server.
OnForwarding See the Authentication module reference guide for more
information on NT Authentication.

SOAP Client Request If connecting to the Application Server with SOAP, set the
Timeout (Seconds) maximum duration, in seconds, for which a download request is
RequestTimeoutSeconds allowed to process before it times out. The default value is 100
seconds.

Note: This value must be less than or equal to the value of

HttpRuntime Execution Timeout (Seconds) (the
executionTimeout attribute in the web.config file).

HttpRuntime Execution Set the maximum duration, in seconds, for which a download
Timeout (Seconds) request is allowed to process before it times out. The default
executionTimeout value is 100 seconds.

Note: This attribute is in the Note: This value must be greater than or equal to the value of
<system.web> element of SOAP Client Request Timeout (Seconds) (the
the web.config file. RequestTimeoutSeconds attribute in the web.config file).

(No WAMCon Setting) Set the BufferSize to regulate the maximum size, in bytes, of
StreamingSettings buffered streaming data. The default value is 64000 bytes.

OnBase 18 27
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Retrieval Tab
The Retrieval tab contains settings which control how the API communicates with the
Application Server. These settings correspond to attributes in the <appSettings> element of
the Public Access web.config file.

WAMCon Setting/ Description

Web.config Attribute

Encrypt Doc ID Select this option, or set the attribute to true , to encrypt the
EncryptDocId document ID of documents retrieved using Public Access.
Encryption is enabled by default.
Deselect this option, or set the attribute to false , to disable the
encryption of document IDs.

Note: The encryption of document IDs is recommended. With

encryption disabled, document IDs are visible in the URL, and
users could enter other IDs to gain unauthorized access to other
documents.

Use Display Columns Select this option, or set the attribute to true , for the front-end
UseDisplayColumns client to use the display columns configured for the Custom
Query. Display columns are enabled by default.
Deselect this option, or set the attribute to false , for the front-
end client to display only Auto-Name strings in the results list.

Note: This option is not applicable to full-text searches.

Decorate Document Names Select this option, or set the attribute to true , to display
DecorateDocumentNames decoration formatting for document Auto-Name strings.
Decorated names are displayed by default.
Deselect this option, or set the attribute to false , to not display
decoration formatting for document Auto-Name strings.

Note: This option is not applicable to full-text searches.

Query Limit Set the maximum number of results returned by queries. The
QueryLimit default value is 0 , meaning no limit.

Note: The front-end client can also specify its own query limit
with the queryLimit key in obpa-config.json. The lower of the
two limits is applied when retrieving documents.

A high limit or no limit allows users to see more documents in

the results list, but can result in a performance loss if a very large
number of documents is returned.

OnBase 18 28
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

WAMCon Setting/ Description

Web.config Attribute

Chunk Size Set the size, in bytes, of the read/write buffer and the chunks of
ChunkSize data sent to the front-end client. The default value is 512000
bytes.

Note: Lowering the chunk size can limit the system memory
used by the API but will throttle downloads, especially for large
documents. Changing this value is therefore not recommended.

Viewer Mode Specify the default method used to deliver documents for display
ViewerMode and download, if none is specified by the front-end client:
• Set to PDF for documents to be converted to PDF before
being sent to the front-end for display. This is the default
viewer mode.

Note: Some large documents can take a long time to be

converted to PDF. If you encounter this problem, consider using
the Native viewer mode or re-importing problematic documents
as PDFs.

• Set to Native for documents to be sent to the front-end for

display or download in the format which they were uploaded
to OnBase as.

Note: If the user’s browser does not recognize the extension of a

document’s native format, the file may be downloaded instead of
displayed in the viewer.

• Set to NativeOptional for documents to be converted to PDF

for display, but still be available to download in their native
format.

Size to Prompt (MB) Set the maximum size, in MB, of documents which are allowed to
SizeToPrompt display in the viewer. Users are instead prompted to download
documents exceeding this size.
Setting the value to 0 forces all documents to be downloaded,
and setting it to -1 disables this feature, allowing all documents
to display in the viewer regardless of size. The default value is 20
MB.

OnBase 18 29
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

WAMCon Setting/ Description

Web.config Attribute

Default overlay mode Specify the method used to render documents with overlays, if
OverlayMode none is specified by the front-end client:
• Set to View to display overlays as normally configured.
• Set to Print to display overlays in a printer-friendly mode.
This is default overlay mode.
• Set to Off to not display overlays.

Note: This setting only applies to documents displayed in the

viewer as PDFs.

Size to Cache (MB) Set the minimum size, in MB, at which documents will be cached
SizeToCache to disk. Caching large documents allows for an improvement in
performance over time by reducing repeat traffic. The default
value is 1 MB.

Cache Path Enter the path to the directory used to store the document cache.
CachePath The default path is C:\DocCache .

Note: The specified cache directory does not need to already

exist, as long as the Windows user running the IIS service has
permission to create and modify it.

Expiration Time Set the duration, in days, for which a document is allowed to
ExpireTime remain cached before being re-fetched from the Application
Server. The default value is 1 day.

Max Cache Size Set the maximum size, in GB, to which the cache is allowed to
MaxCacheSize grow. When the cache reaches this limit, the oldest documents in
the cache are deleted to make room for each new one.
Setting the value to 0 disables document caching. The default
value is 10 GB.

Enable local browser Select this option, or set the attribute to true , to allow a user’s
caching browser to cache documents for a short time.
EnableBrowserCaching Deselect this option, or set the attribute to false , to not allow a
user’s browser to cache documents for a short time. Browser
caching is not enabled by default.

OnBase 18 30
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

WAMCon Setting/ Description

Web.config Attribute

Interval between throttle Set the frequency, in minutes, at which the throttle cache is reset.
cache resets Request throttling prevents users from making an excessive
ThrottleResetTimer number of requests and overburdening system resources. The
throttle cache tracks the number of requests made from each IP
address; if the number of requests exceeds the configured
threshold, traffic to that IP address is throttled and subsequent
requests are temporarily blocked. When the throttle cache is
reset, all blocks are lifted.
Setting the value to 0 disables request throttling. The default
interval is 5 minutes.

Amount of requests during Set the number of requests allowed from a single IP address
each throttle interval before traffic is throttled and users at the address are
ThrottleThreshold temporarily blocked from making further requests. Blocks are
lifted when the throttle cache is reset.
Setting the value to 0 disables request throttling. The default
threshold is 1000 requests per throttle cache reset interval.

Public Access Required Keywords

Caution: Adding or removing a required Keyword Type will cause the changes to be saved to
web.config. As a result, the application will restart, and any users connected to it will lose their
sessions.

Note: For the Pubic Access third generation toolkit, the configuration of required keywords can
only be done directly in the web.config file, not WAMCon.

OnBase 18 31
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

To add or remove a required Keyword Type for Public Access Server

1. Click the Required Keywords button from the toolbar. The Public Access Required
Keywords dialog box is displayed:

2. Click Add to add a new entry to the RequiredKeywords section of the Public Access
Server’s web.config file. The Add Required Keyword dialog box is displayed.

3. Enter the appropriate Custom Query ID and Keyword Type ID.

If the Query ID value is * , then the requirement is applied to all queries.
4. Click OK . The new required Keyword Type is added.
To remove a required Keyword Type, select it and click Remove .
5. Click Save .

OnBase 18 32
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Public Access Theme Designer

You are encouraged to add the Public Access Viewer controls to your own .aspx page and use
custom CSS style sheets to maintain a consistent look and feel across the website. If you
instead choose to use the provided template pages, style sheets can be generated using the
Theme Designer in the Web Application Management Console.

Note: The WAMCon Theme Designer is not compatible with the Pubic Access third generation
toolkit. For the third generation toolkit, theming can be configured directly using basic HTML
and CSS design.

Creating a New Theme

To create a new theme for use with your Public Access Viewer solution, follow these steps:
1. Launch the Web Application Management Console locally on the server where the
Public Access Viewer application is located.
In a typical 32-bit installation, the Web Application Management Console can be found
in C:\Program Files\Hyland\Web Applications Management Console .
In a typical 64-bit installation, the Web Application Management Console can be found
in C:\Program Files (x86)\Hyland\Web Applications Management Console .
2. Select the PublicAccess web application.

Note: If a web application is already open, you will need to click the Open Web Application
button to switch to the Public Access Viewer web application.

3. Click Theme Designer . The Theme Designer window is displayed.

4. Click New . A new theme is created, and is visible in the Preview section. The Theme
Part section is also populated with fields available to be modified.

OnBase 18 33
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

5. Modify the new theme as desired. See Modifying a Theme on page 37 for more
information on modifying your new theme.
6. Click Save when you are finished making changes. The Save As dialog is displayed.
7. Browse to the Resources directory for your Public Access Viewer web site.
8. Click Save . The Theme Saved Successfully prompt is displayed.

9. Click Copy Link . The link text is copied to your clipboard.

10. Click OK .
11. Open your custom .aspx file using a text editor (such as Notepad).
12. Paste the copied text over the existing <link> node.
13. Save and close the .aspx file.

Modifying an Existing Theme

To open an existing theme for editing, follow these steps:
1. Launch the Web Application Management Console locally on the server where the
Public Access Viewer application is located.
In a typical 32-bit installation, the Web Application Management Console can be found
in C:\Program Files\Hyland\Web Applications Management Console .
In a typical 64-bit installation, the Web Application Management Console can be found
in C:\Program Files (x86)\Hyland\Web Applications Management Console .
2. Select the PublicAccess web application.

OnBase 18 34
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

3. Click Theme Designer . The Theme Designer window is displayed.

4. Open the theme you want to modify by performing one of the following actions:
• Select the desired theme from the Theme drop-down select list
• Click Load and select the desired theme from the Resources folder of your Public
Access Viewer virtual directory.
• Click Load Default to load and modify the default theme page.
5. Modify the new theme as desired. See Modifying a Theme on page 37 for more
information on modifying your new theme.
6. Click Save when you are finished making changes. The Save As dialog is displayed.
7. Browse to the Resources directory for your Public Access Viewer web site.
8. Click Save . The Theme Saved Successfully prompt is displayed.

9. Click Copy Link . The link text is copied to your clipboard.

OnBase 18 35
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

10. Click OK .
11. Open your custom .aspx file using a text editor (such as Notepad).
12. Paste the copied text over the existing <link> node.
13. Save and close the .aspx file.

Duplicating an Existing Theme

To duplicate a theme for use with your Public Access Viewer solution, follow these steps:
1. Launch the Web Application Management Console locally on the server where the
Public Access Viewer application is located.
In a typical 32-bit installation, the Web Application Management Console can be found
in C:\Program Files\Hyland\Web Applications Management Console .
In a typical 64-bit installation, the Web Application Management Console can be found
in C:\Program Files (x86)\Hyland\Web Applications Management Console .
2. Select the PublicAccess web application.
3. Click Theme Designer . The Theme Designer window is displayed.

4. Open the theme you want to duplicate by performing one of the following actions:
• Select the desired theme from the Theme drop-down select list
• Click Load and select the desired theme from the Resources folder of your Public
Access Viewer virtual directory.
• Click Load Default to load the default theme page.
5. Click Duplicate . A copy of the selected theme is created and is displayed in the Theme
Designer .
6. Modify the new theme as desired. See Modifying a Theme on page 37 for more
information on modifying your new theme.
7. Click Save when you are finished making changes. The Save As dialog is displayed.
8. Browse to the Resources directory for your Public Access Viewer web site.

OnBase 18 36
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

9. Click Save . The Theme Saved Successfully prompt is displayed.

10. Click Copy Link . The link text is copied to your clipboard.
11. Click OK .
12. Open your custom .aspx file using a text editor (such as Notepad).
13. Paste the copied text over the existing <link> node.
14. Save and close the .aspx file.

Modifying a Theme
Follow these steps to modify the theme you have open in the Theme Designer :
1. Select a Mode :
• Basic : select this mode to modify basic features of a theme.
• Advanced : select this mode to modify additional features of a theme that are not
available in Basic mode (for example, Validation and Error theme parts).

Note: If you switch back to Basic mode after already having modified some values, you may
lose some of your selected style values.

2. Select a Template Type . The following themes are available:

• controltemplate.aspx
• datasourcetemplate.aspx
• fulltextcontroltemplate.aspx

OnBase 18 37
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

3. Modify the fields in the Theme Part section to customize the appearance of your web
page. As you modify each field, your changes will be reflected within the Preview
section. The following fields are available:

Page Description

Background Modify this field to change the background color of the page.

Border Modify this field to change the appearance of the border that separates the
page. You can modify the color, the width (in pixels), and the type of the
border. This field is not available in Advanced mode.

Text Modify this field to change the color of the text on the page. This field is not
available in Advanced mode.

Error Modify this field to change the color of the error text on the page. This field
is not available in Advanced mode.

Header Description

Background Modify this field to change the background color of the headers on the page.

Text Modify this field to change the color of the text of the headers on the page.

Font Modify this field to change the font used to display the headers on the page.
You can specify the size and type of font used. This field is only available in
Advanced mode.

Search Panel Description

Background Modify this field to change the background color of the search panel. This
field is only available in Advanced mode.

Border Modify this field to change the appearance of the border that surrounds the
search panel. You can modify the color and the type of the border. This field
is only available in Advanced mode.

Hit List Description

Background Modify this field to change the background color of the hit list. This field is
only available in Advanced mode.

Border Modify this field to change the appearance of the border that surrounds the
hit list. You can modify the color and the type of the border. This field is only
available in Advanced mode.

OnBase 18 38
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Hit List Description

Row Modify this field to change the color of half of the rows displayed in any
tables on your page. The appearance of the other half of the rows is
determined by the Alternate Row field.

Alternate Modify this field to change the color of half of the rows displayed in any
Row tables on your page. The appearance of the other half of the rows is
determined by the Row field.

Highlight Modify this field to change the color highlighted rows displayed in any tables
on your page.

Text Modify this field to change the color of the text displayed in the hit list. This
field is only available in Advanced mode.

Font Modify this field to change the font of the text displayed in the hit list. You
can specify the size and type of font used. This field is only available in
Advanced mode.

Field Description

Background Modify this field to change the background color of fields on your page.

Required Modify this field to change the background color of required fields on your
Field page.

Label Description

Text Modify this field to change the color of the text used as labels for fields and
required fields on your page. This field is only available in Advanced mode.

Font Modify this field to change the font of the text used as labels for fields and
required fields on your page. You can specify the size and type of font used.
This field is only available in Advanced mode.

OnBase 18 39
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Error Description

Text Modify this field to change the color of the text for errors that occur on your
page. This field is only available in Advanced mode.

Font Modify this field to change the font of the text for errors that occur on your
page. You can specify the size and type of font used. This field is only
available in Advanced mode.

Validation Description

Text Modify this field to change the color of the text of validation messages that
occur on your page (for example, "This is a required field" messages). This
field is only available in Advanced mode.

Font Modify this field to change the font of the text of validation messages that
occur on your page (for example, "This is a required field" messages). You
can specify the size and type of font used. This field is only available in
Advanced mode.

OnBase 18 40
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Instructions Description

Text Modify this field to change the color of the text of instruction messages that
occur on your page. This field is only available in Advanced mode.

Font Modify this field to change the font of the text of instruction messages that
occur on your page. You can specify the size and type of font used. This
field is only available in Advanced mode.

Maximum Description
Results

Text Modify this field to change the color of the text displayed when a user
reaches the maximum number of search results after running a query. This
field is only available in Advanced mode.

Font Modify this field to change the font of the text displayed when a user
reaches the maximum number of search results after running a query. You
can specify the size and type of font used. This field is only available in
Advanced mode.

Button Description

Text Modify this field to change the color of text displayed on any buttons on your
page (for example, Search or Clear ).

Font Modify this field to change the font of the text displayed on any buttons on
your page (for example, Search or Clear ). You can specify the size and type
of font used. This field is only available in Advanced mode.

eCommerce Client Web.config

When the eCommerce Client Web.config file is opened in the Web Application Management
Console, the tabs and settings described in the following sections are displayed.

Note: For further information on what each setting controls, see the Document eCommerce
documentation. Search the documentation for the setting contained in the Document
eCommerce Web.Config Setting column.

Tip: Rest your pointer over a setting’s name in the Web Application Management Console to
display a tooltip briefly describing the setting.

OnBase 18 41
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Server Configuration Tab

The settings on this tab are used to configure the server.

Web Application Management Console Field eCommerce Web.Config Setting

Service Client Type ServiceClientType

Application Server URL ApplicationServer URL

Settings Tab
The settings on this tab are used to configure the eCommerce web site.

Web Application Management Console Field eCommerce Web.Config Setting

Stylesheet Directory Location StyleSheetPath

Allow Anonymous Users AllowAnonymousUsers

Default User Time Zone DefaultTimeZone

Search Start Year SearchStartYear

Allow Empty Search AllowEmptyDocumentSearch

Allow Wildcard Character Searches AllowCharacterMatchingSearch

Abort Excessive Result Searches CancelSearchExceedsMaxCount

Document List Page Display Count SearchDisplayPageItemCount

Default Store ID DefaultStoreID

Page Count Keyword PageCountKeywordName

Password Strength Pattern PasswordStrengthPattern

Password Strength Message PasswordStrengthMessage

Reset Password Link Lifetime ResetPasswordLinkExpiration

Public CAPTCHA Key CAPTCHAPublicKey

Private CAPTCHA Key CAPTCHAPrivateKey

OnBase 18 42
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Payment Processor Tab

The settings on this tab are used to configure the payment processor used by eCommerce.

Web Application Management Console Field eCommerce Web.Config Setting

URL Scheme Type UrlSchemeType

Payment Test Mode PaymentTestMode

Payment Processor PaymentProcessor

Official Payments Product ID OfficialPaymentsProdID

Official Payments Unique Field Name OfficialPaymentsUniqueCdeName

Cybersource Merchant ID CSMerchantID

Cybersource Serial Number CSSerialNumber

Cybersource Shared Secret Key CSSharedSecret

HP PayBill Shared Key PBSharedKey

HP PayBill Source Account PBSource

HP PayBill URL PBUrl

Doc Preview Tab

The settings on this tab are used to configure the settings used for document preview.

Web Application Management Console Field eCommerce Web.Config Setting

Document Preview Width DocumentPreviewWidth

Document Preview Height DocumentPreviewHeight

Document Preview Content Width DocumentPreviewContentWidth

Document Preview Content Height DocumentPreviewContentHeight

Document Preview Position DocumentPreviewPosition

OnBase 18 43
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Electronic Plan Review Web.config

When the Plan Review Web.config file is opened in the Web Application Management Console,
the tabs and settings described in the following sections are displayed.

Note: For further information on what each setting controls, see the Electronic Plan Review
documentation. Search the documentation for the setting contained in the Plan Review
Web.Config Setting column.

Tip: Rest your pointer over a setting’s name in the Web Application Management Console to
display a tooltip briefly describing the setting.

Server Configuration Tab

The settings on this tab are used to configure the server.

Web Application Management Console Field Plan Review Web.Config Setting

Service Client Type ServiceClientType

Application Server URL ApplicationServer URL

Plan Review Tab

The settings on this tab are used to configure the OnBase user name, password, and database.

Web Application Management Console Field Plan Review Web.Config Setting

User Name SessionUser

Password SessionPassword

Data Source DataSource

Settings Tab
The settings on this tab are used to configure the Plan Review website.
‘

Web Application Management Console Field Plan Review Web.Config Setting

Stylesheet Directory Location StyleSheetPath

Allow Sign On AllowSignon

Allow Sign Off AllowSignoff

Default User Time Zone DefaultTimeZone

OnBase 18 44
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Web Application Management Console Field Plan Review Web.Config Setting

Search Start Year SearchStartYear

Items Per Page DisplayDocumentsPerPage

Reset Password Link Lifetime ResetPasswordLinkExpiration

File Upload Directory FileUploadDirectory

File Upload Validator FileUploadValidator

Public CAPTCHA Key CAPTCHAPublicKey

Private CAPTCHA Key CAPTCHAPrivateKey

Password Strength Pattern PasswordStrengthPattern

Password Strength Message PasswordStrengthMessage

Discipline Items Per Menu DisciplineItemsPerMenu

Single Sign On Tab

The settings on this tab are used to configure Single Sign-On.

Web Application Management Console Field Plan Review Web.Config Setting

Allow Single Sign On SingleSignOn

Source ID SingleSignOnSourceID

Resolution Mode SSOUserResolutionMode

OnBase 18 45
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Reporting Dashboards Web Viewer Web.config

When the Reporting Dashboards Web Viewer Web.config file is opened in the Web Application
Management Console, the settings described in the following table are displayed.

Web Application Web.Config Element Description and Settings

Management
Console Field

User Name username The user name of the account to use for
access to the linked dashboard. If a user
name is entered as the value, the
corresponding password must also be
entered for the Password value.

Caution: This user account is used to

access the dashboard by anyone
following the link. It is a best practice
to create a single-purpose user
account to fill this need, with the
minimum level of access and
privileges to Reporting Dashboards
and OnBase.

To require the user accessing the

dashboard to input a valid user name and
password, leave this value empty.

Password password The password that corresponds to the

user name entered as the User Name
value.
To require the user accessing the
dashboard to input a valid user name and
password, leave this value empty.

Auto Login enableAutoLogin Select this option, or set it to true in the

web.config file, if the Web Viewer is
configured to use a single sign-on
scheme, such as Active Directory or
LDAP.

Note: This does not automatically

grant permission to access the
dashboard. The user accessing the
dashboard from the link must still
have permission to access the
dashboard.

OnBase 18 46
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Web Application Web.Config Element Description and Settings

Management
Console Field

Dashboard Theme useTheme Set the color theme used to display

dashboards to either dark or light .

Export Dashboard enableExportDashboard Select this option, or set it to true in the

web.config file, to allow users accessing
dashboards to export dashboards as
either images or PDF files. Deselect this
option, or set it to false in the web.config
file, to disable exporting.

Export Dashboard enableExportDashboardItems Select this option, or set it to true in the

Items web.config file, to allow users accessing
dashboards to export specific dashboard
items within a dashboard as either
images or PDF files. Deselect this option,
or set it to false in the web.config file, to
disable exporting dashboard items.

Note: If Export Dashboard is

deselected (false) the ability to export
dashboard items is also disabled even
if Export Dashboard Items is
selected (true).

Allow HTTP acceptHttpDashboardParams Select this option, or set it to true in the

Parameters web.config file, to accept dashboard
parameters from the HTTP request.
Deselect this option, or set it to false in
the web.config file, to allow the user
accessing the dashboard to set the
parameters.

Note: This option must be set to true

if Web Viewer URLs are going to be
created manually, or by a scripted
process, without using the Unity Client
to create them.

OnBase 18 47
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Web Application Web.Config Element Description and Settings

Management
Console Field

Encrypt Dashboard n/a Select this option to encrypt the

Viewer configuration information of the Web
Viewer in the web.config file.

Note: If this option is selected, the

options can no longer be read or
configured directly in the web.config
file.

Dashboard Tracing sessionTraceLevel This value is for troubleshooting

Info Level purposes only. Valid values are whole
numbers 1-4.

Editing Settings
Before editing Web.config settings using the Web Application Management Console, ensure
you are familiar with the setting’s function and valid values. For further information about each
setting, see the related module’s documentation. Search the documentation for the setting
contained in the Web.Config Setting column in Web Application Management Console Settings
on page 4.

Tip: Rest your pointer over a setting’s name in the Web Application Management Console to
display a brief description of the setting.

To edit settings:
1. Open the Web Application Management Console.
2. Select one of the available Web applications and click OK .
3. Edit the appropriate settings by typing a new value, selecting a new value from a drop-
down list, or selecting or clearing a check box.

Tip: To undo your most recent change, click the Undo button in the toolbar. Continue clicking
Undo to undo more changes. This button becomes unavailable once you save your changes.

4. Select File | Save or click the Save toolbar button.

5. You are prompted to confirm that you want to save your changes.

Caution: Saving changes to the server application’s Web.config file causes the respective web
applications to restart. All users connected to the web application will lose their sessions.

6. Click Yes to save changes, or click No to return to the Web Application Management
Console without saving changes.

OnBase 18 48
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Encrypting Settings
You can use the Web Application Management Console to encrypt settings that apply to the
following applications:
• DocPop
• FolderPop
• PDFPop
• FormPop
• LoginFormProc
• Gateway Caching Server
• Public Access Viewer
When these settings are encrypted, information such as the username and password values
cannot be viewed within the Web.config file.
To enable encryption, select the Encrypt [Application Name] or Encrypt Login Settings setting
in the Web Application Management Console. For example, the setting for DocPop is named
Encrypt DocPop , and it is located on the same tab as other DocPop settings. When this setting
is applied and saved, information within the Hyland.Web.DocPop element is replaced with an
EncryptedData element, where the encrypted settings are stored as the CipherValue .
To reverse the encryption, clear the Encrypt [Application Name] setting, and click Save .

Caution: Saving changes to the server application’s Web.config file causes the respective web
applications to restart. All users connected to the applications will lose their sessions.

Exporting Settings
You can export configuration settings from an application’s Web.config file into an XML file
using the Web Application Management Console. For example, you may want to export
configuration settings before performing an upgrade. After the upgrade, you can import the
settings to apply them to the upgraded Web.config file.

Tip: Export settings from an application’s Web.config file before making large changes to
configuration. These exported settings will serve as a backup in case your OnBase solution
does not function as expected after making configuration changes.

To export settings:
1. Open the application’s Web.config file in the Web Application Management Console.
2. Select File | Export or click the Export toolbar button.
3. Specify the location where the XML file should be exported.
4. Type a name for the file.
5. Click Save .

OnBase 18 49
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Importing Settings
You can import values for one or multiple settings from an exported XML file or a backed up
Web.config file into the server application’s current Web.config file.
To import settings from an XML or configuration (.config) file:
1. Open the application’s Web.config file in the Web Application Management Console.
2. Select File | Import or click the Import toolbar button.
3. Navigate to the location of the XML or text-based configuration file containing the
settings to be imported.
4. Select the file and click Open .
5. If you are prompted with a Loading Error message, click OK . This message means
either:
• One or more expected settings were not found in the configuration file.
• Invalid values were provided for one or more settings.
The settings with missing or invalid values are highlighted in yellow and should be
reviewed before the configuration is saved.
6. You are prompted when the import process is complete. Click OK .
7. Using the Web Application Management Console, verify that the values were imported
properly. All values that were changed during the import process are highlighted in
yellow in the Web Application Management Console. Tabs containing values that were
changed include an asterisk after their name.

Note: Settings from the XML file are only imported if they have corresponding settings within
the Web Application Management Console interface. Once the import process is complete,
ensure that you verify the appropriate values were imported for the appropriate settings.

8. After verifying that the values were imported successfully, select File | Save or click the
Save toolbar button to save changes.

Configuring ADO.NET Connection Strings

The default database connection method for OnBase servers and applications requires
ADO.NET connection strings. An ODBC connection is still required for the OnBase Client and
the OnBase Configuration module.
A connection string contains the information required to connect to a database, and each
connection string has a unique identifying name for that data source connection. This unique
data source name is referenced by other applications to connect to the database configured in
the connection string.

OnBase 18 50
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Data source connection strings are configured in the configuration file of the application used
to connect directly to the database. For example, the connectionStrings element in the
Application Server web.config file contains a data source connection string for each database
that the Application Server accesses. Other applications using the Application Server, such as
the Unity Client or Web Server, access the database by referencing the unique data source
name from the relevant connection string.

You can use the Web Application Management Console to create, modify, and delete data
source connection strings to connect to the OnBase database. This utility also allows you to
encrypt all of the connection string information in the configuration file for security purposes.

Note: ADO.NET and connection strings are Microsoft .NET Framework concepts, but each
database provider (such as SQL Server or Oracle) has its own implementation of ADO.NET. For
more information on building a valid connection string or using additional options, see your
database provider’s documentation on connection strings.

It is important to note the following considerations for connection strings:

• It is strongly recommended to use integrated security instead of a database account
for authentication. To use integrated security, the Windows user connecting to the
database must be the same user that is running the connecting server or service
(such as the Application Server). This user must also be configured with the
configgp role in the database.
• It is strongly recommended to encrypt the connection strings. If they are not
encrypted, all data source connection information is visible in the configuration file,
including the database user names and passwords in the connection strings.

See the following sections to configure connection strings:

• Creating Connection Strings on page 51
• Modifying Connection Strings on page 55
• Deleting Connection Strings on page 57

Creating Connection Strings

You can use the Web Application Management Console to create and encrypt data source
connection strings.
To create a new connection string:
1. In the Web Application Management Console, open the Application Server web.config
file by clicking Open Web Application and selecting the Application Server from the list
of web applications.

Note: Opening the Application Server web.config file is required to access the connection
strings configuration utility, even if you are not configuring the Application Server.

OnBase 18 51
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

2. Select Connection Strings | View Contexts . The connection strings dialog box is
displayed.
If you are configuring an application or service other than the Application Server, follow
these additional steps to open the appropriate .config file:
a. Select File | Configuration Path .
b. Browse to open the .config file for the application or service.

Note: You can also apply the -CONFIGPATH command line switch to the Web Application
Management Console shortcut to directly open a .config file in the connection strings dialog
box. See the command line switches section of the Web Application Management Console
documentation for more information.

The connection strings dialog box allows you to configure connection strings.

3. To encrypt all connection strings configured in the application’s .config file, ensure the
Options | Encrypt Connection Strings menu option is selected. This option is
automatically selected by default every time you open the connection strings dialog
box, and the connection strings are encrypted when the .config file is saved.

Caution: It is strongly recommended to encrypt the connection strings. If they are not
encrypted, all data source connection information is visible in the .config file and could expose
sensitive data, including any entered database user names and passwords.

4. Click Add to start creating a new connection string. The fields on the right become
available for interaction.

OnBase 18 52
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

5. If you are configuring Reporting Dashboards with a secondary connection string with a
read-only database user account, select Options | Populate Read-Only User . This
optional feature populates the User ID and Password fields with the credentials for the
read-only user. See the Reporting Dashboards documentation for more information.
If you are creating a connection string for any other purpose, skip this step.
6. Enter the connection string information in the fields on the right. The following table
explains each field:

Option Description

Data Source Name A unique name that you create to identify the data source connection
string. This name must be different from the names of any other
ADO.NET or ODBC data source connections configured in your system.

Note: This identifying name may be different from the name of the
actual database, which is specified in the Data Source and Database
fields.

Data Provider The data provider type used for the database. Select one of the
following:
• System.Data.SqlClient : Select this for a SQL Server database.
• Oracle.ManagedDataAccess.Client : Select this for an Oracle
database.

Note: Only SQL Server and Oracle data providers can be used to connect
to the OnBase database.

Data Source The value of this element depends on the type of data provider used:
• SQL Server : Enter the server\instance name of the SQL Server
instance hosting the database.
• Oracle : Enter the TNS name or connect descriptor of the database.

Database The name of the database, if using SQL Server. This element is not used
for Oracle databases.

Integrated Security Select this option to use Windows Authentication to connect to the
database.

Caution: It is strongly recommended to use integrated security instead

of a database account for authentication. To use integrated security, the
Windows user connecting to the database must be the same user that is
running the connecting server or service (such as the Application
Server). This user must also be configured with the configgp role in the
database.

OnBase 18 53
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Option Description

User ID The user name of the database user account accessing the database.

Note: This user name is for a database user account, not a user account
for OnBase.

Password The password of the database user account accessing the database.

Note: This password is for a database user account, not a user account
for OnBase.

Additional Options Any additional options for the connection string. For more information
on available connection string options and syntax, see the
documentation for your database provider (SQL Server or Oracle).

7. Click Create to save the information in the fields and create the connection string. The
name of the data source is added to the Data Sources list on the left, and the
connection string is displayed in the Connection String section.

8. Select File | Save to save the .config file.

9. Select File | Close to exit the connection strings dialog box.

OnBase 18 54
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Modifying Connection Strings

If you have already created a connection string in the .config file, you can use the Web
Application Management Console to make changes to the data source connection information
in the connection string.
To modify a connection string:
1. In the Web Application Management Console, open the Application Server web.config
file by clicking Open Web Application and selecting the Application Server from the list
of web applications.

Note: Opening the Application Server web.config file is required to access the connection
strings configuration utility, even if you are not configuring the Application Server.

OnBase 18 55
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

2. Select Connection Strings | View Contexts . The connection strings dialog box is
displayed.
If you are configuring an application or service other than the Application Server, follow
these additional steps to open the appropriate .config file:
a. Select File | Configuration Path .
b. Browse to open the .config file for the application or service.

Note: You can also apply the -CONFIGPATH command line switch to the Web Application
Management Console shortcut to directly open a .config file in the connection strings dialog
box. See the command line switches section of the Web Application Management Console
documentation for more information.

The connection strings dialog box allows you to configure connection strings.

3. To encrypt all connection strings configured in the application’s .config file, ensure the
Options | Encrypt Connection Strings menu option is selected. This option is
automatically selected by default every time you open the connection string dialog box,
and the connection strings are encrypted when the .config file is saved.

Caution: It is strongly recommended to encrypt the connection strings. If they are not
encrypted, all data source connection information is visible in the .config file and could expose
sensitive data, including any entered database user names and passwords.

OnBase 18 56
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

4. Select the item you want to modify in the Data Sources list. The configured connection
string information for that data source is displayed in the fields on the right.

5. Modify the connection string fields and options as needed.

6. Click Update to save the changes to the connection string.
7. Select File | Save to save the .config file.
8. Select File | Close to exit the connection strings dialog box.

Deleting Connection Strings

You can use Web Application Management Console to delete a data source connection string
from the .config file.
To delete a connection string:
1. In the Web Application Management Console, open the Application Server web.config
file by clicking Open Web Application and selecting the Application Server from the list
of web applications.

Note: Opening the Application Server web.config file is required to access the connection
strings configuration utility, even if you are not configuring the Application Server.

OnBase 18 57
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

2. Select Connection Strings | View Contexts . The connection strings dialog box is
displayed.
If you are configuring an application or service other than the Application Server, follow
these additional steps to open the appropriate .config file:
a. Select File | Configuration Path .
b. Browse to open the .config file for the application or service.

Note: You can also apply the -CONFIGPATH command line switch to the Web Application
Management Console shortcut to directly open a .config file in the connection strings dialog
box. See the command line switches section of the Web Application Management Console
documentation for more information.

The connection strings dialog box allows you to remove connection strings.

3. Select the item you want to delete from the Data Sources list.
4. Click Remove . The data source is removed from the list.
5. Select File | Save to save the .config file.
6. Select File | Close to exit the connection strings dialog box.

OnBase 18 58
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Changing Web Applications

To modify settings for a different web application using the Web Application Management
Console:
1. Select File | Open Web Application or click the Open Web Application toolbar button.
2. You are prompted to select a web application:

3. Select a web application and click OK .

4. The application’s Web.config settings are displayed in the Web Application
Management Console.

OnBase Web Client Contexts and Control Bars

The contexts and control bars that are available in the OnBase Web Client can be modified in
the Web Application Management Console’s Navigation Panel dialog box. New contexts and
control bars can also be added.

Note: Before editing contexts and control bars using the Web Application Management
Console, ensure you are familiar with the context or control bar’s function. For further
information on contexts and control bars, see the Web Server documentation. Search the Web
Server documentation for the setting contained in the Web Server Web.Config Setting column
in the table below.

Tip: Rest your pointer over a context or control bar’s name to display a brief description of it.

OnBase 18 59
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

To open the Navigation Panel dialog box:

1. Verify that the Web Application Management Console is displaying the Web Server’s
configuration settings.
2. Select Navigation Panel | View Contexts or click the View Contexts toolbar button.
3. The Navigation Panel dialog box is displayed:

Similar to the Web Server Web.config settings contained in the Web Application
Management Console, settings for contexts and control bars are grouped on tabs in the
Web Application Management Console according to functionality. For example, the
Collaboration context and corresponding control bars are contained on the
Collaboration tab. The contexts and control bar settings in the Web Application
Management Console’s Navigation Panel dialog box and the Web Server’s
corresponding Web.config settings are described in the following sections.

Default Context Info Tab

The settings on this tab specify the context and control bar displayed by default when users log
on to the Web Client.

Web Application Management Console Web Server Web.Config Setting

Field

Default Context defaultContext

Default Control Bar defaultControlBar

Default Context ID defaultContextID

OnBase 18 60
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Document Tab
The settings on this tab are specific to the Document context and control bars.

Context

Check Box Web Server Web.Config Setting

Document Document

Control Bars

Check Box Web Server Web.Config Setting

Retrieve a Document RetrieveDocument

Retrieve by Document Handle RetrieveDocumentByHandle

Do a Custom Search CustomQuery

Create a New Form NewForm

Document Templates DocumentTemplates

Upload a Document Upload

Scan a Document Scan

Index a Scanned Batch IndexScannedBatch

Version Control VersionControl

Briefcase Briefcase

Workflow Tab
The settings on this tab are specific to the Workflow context.

Check Box Web Server Web.Config Setting

Workflow Workflow

OnBase 18 61
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

WorkView Tab
The settings on this tab are specific to the WorkView context.

Check Box Web Server Web.Config Setting

WorkView WorkView

KnowledgeTransfer Tab
The settings on this tab are specific to the KnowledgeTransfer context.

Check Box Web Server Web.Config Setting

KnowledgeTransfer KnowledgeTransfer

Collaboration Tab
The settings on this tab are specific to the Collaboration context and control bars.

Context

Check Box Web Server Web.Config Setting

Collaboration Collaboration

Control Bars

Check Box Web Server Web.Config Setting

My Workspaces AllWorkspaces

Workspace Retrieval FindWorkspace

OnBase 18 62
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

StatusView Tab
The settings on this tab are specific to the StatusView context and control bars.

Context

Check Box Web Server Web.Config Setting

StatusView StatusView

Control Bars

Check Box Web Server Web.Config Setting

Status View MyLayouts

Folders Tab
The settings on this tab are specific to the Folders context.

Check Box Web Server Web.Config Setting

Folders Folders

User Tab
The settings on this tab are specific to the User context and control bars.

Context

Check Box Web Server Web.Config Setting

User User

Control Bars

Check Box Web Server Web.Config Setting

Mailbox Mailbox

Envelopes Envelopes

OnBase 18 63
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Check Box Web Server Web.Config Setting

Password Password

Options Options

Client Settings ClientSettings

Briefcase Options BriefcaseOptions

Locked Objects LockedObjects

Admin Tab
The settings on this tab are specific to the Admin context and control bars.

Context

Check Box Web Server Web.Config Setting

Admin Admin

Control Bars

Check Box Web Server Web.Config Setting

Users Users

Diagnostics Diagnostics

Distribution Recipients DistributionRecipients

Help Tab
The settings on this tab are specific to the Help button.

Check Box Web Server Web.Config Setting

Help Help

OnBase 18 64
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Adding or Editing Contexts and Control Bars

Caution: Adding or editing a context or control bar will cause the changes to be saved to
Web.config. As a result, the application will restart, and any users connected to it will lose their
sessions.

In the Web Application Management Console’s Navigation Panel dialog box:

1. To add or edit a context, select Edit | Add Context or Edit | Edit Context , respectively.
2. If you are editing an existing context, select the context from the drop-down list in the
Context Menu dialog box. Specify the following:

Setting Description

Name Type a name for the context menu.

Display Name Type the name that should be displayed to users in the Web
Client for the context menu.

Display Order Specify the order in which the context menu should appear.

Note: A value of 0 means that the context menu will appear

first in the list of contexts.

Icon Specify the icon that should be used for the context menu.

Note: Help is not available in the context list and cannot be modified. The Web Application
Management Console controls only whether the Help button is displayed.

3. Click Save to save changes and close the Context Menu dialog box.
4. To add or edit a control bar, select Edit | Add Control Bar or Edit | Edit Control Bar ,
respectively.
5. If you are editing an existing control bar, select the control bar from the drop-down list
in the Control Bar dialog box. Specify the following:

Setting Description

Name Type a name for the control bar.

Display Name Type the name that should be displayed to users in the Web
Client for the control bar.

Path Specify the path to the control bar.

Icon Specify the icon that should be used for the control bar.

OnBase 18 65
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

6. Click Save to save changes and close the Control Bar dialog box.
7. Select File | Close Window to close the Navigation Panel dialog box.

Editing OnBase Diagnostics Console Settings

Message logging can also be controlled in the Web Application Management Console. Logged
messages are displayed in the Diagnostics Console.

Note: Some applications do not have Diagnostics Console settings.

To edit the types of messages displayed in the Diagnostics Console:

1. Open the Web Application Management Console.
2. Select one of the available web applications and click OK .
3. Select Diagnostics | View Diagnostics Settings or click the View Diagnostics Settings
toolbar button.
4. The Hyland.Diagnostics dialog box is displayed:

OnBase 18 66
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

5. Edit the appropriate settings by selecting or clearing the corresponding Enable Mail Slot
check box.

Note: The name of each Hyland.Diagnostics setting is identical to the name of the
application’s Web.config setting. For further information on what each diagnostics setting in
the Web Application Management Console controls, see the Web Server documentation.

6. Click File | Save to save changes and close the Hyland.Diagnostics dialog box.

Copying the Application

The Web Application Management Console can be used to duplicate a Web Server or
Application Server with another instance on the same Windows Server. The entire Application
is copied along with the creation of a new Application Pool.
1. Select Tools | Copy Application . The Copy Application dialog box is displayed.

Note that both the Application Name and Application Pool names are appended with
_Copy.
2. Type new names in the Application Name and Application Pool fields.
3. Click OK . Copies of the Application Name and Application Pool are created. The
web.config file is displayed, allowing you to edit any of the configurations for the new
copy.

Configuring Impersonation
The Web Application Management Console can be used to configure impersonation for
supported Web applications. For information about impersonation, see the Web Server or
Application Server module reference guide.
1. Copy the ASPNET_SETREG.exe utility to the directory where the Web Application
Management Console is installed or to another directory on your server.
ASPNET_SETREG.exe can be obtained through Microsoft or your OnBase solution
provider.
2. Open the Web Application Management Console.
3. Select one of the available web applications and click OK .

OnBase 18 67
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

4. Select Tools | Impersonation . The ASPNET_SETREG dialog box is displayed.

5. Enter the domain, user name, and password (twice) for the impersonation account.
6. Click OK .
7. If prompted, browse to the location of ASPNET_SETREG.exe, and click OK .

This dialog box is displayed if ASPNET_SETREG.exe does not reside in the same
directory as the Web Application Management Console.

OnBase 18 68
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

8. Read the confirmation message, and then click OK .

9. Grant the application pool’s identity account Read permissions to the appropriate
registry key. The key’s permissions are reset each time the ASPNET_SETREG.exe utility
is run.
• In 32-bit environments, grant the Read permission on
HKLM:SOFTWARE\Hyland\YourApp\Identity\ASPNET_SETREG .
• In 64-bit environments, grant the Read permission on
HKLM:SOFTWARE\Wow6432Node\Hyland\YourApp\Identity\ASPNET_SETREG .

Note: If the application pool is configured to use the built-in ApplicationPoolIdentity account,
then the IIS_IUSRS group must be granted Read access to the registry key.

Caution: Modify the registry at your own risk. Incorrectly editing the Windows registry can
cause serious problems that may require you to reinstall your operating system. Be sure to
back up the registry before making any changes to it. For more registry information, see the
following Microsoft articles: http://support.microsoft.com/kb/256986 and http://
technet.microsoft.com/en-us/library/cc725612.aspx

Installing Event Logs & Performance Counters

The Web Application Management Console can install event logs and performance counters to
help you monitor the OnBase Web Server and Application Server.
If you installed the Web Server or Application Server using an installer, these event logs and
performance counters may already be installed. Use the Web Application Management Console
to check whether all logs and counters have been installed.

Installing Event Logs

Event logs allow you to monitor events logged by the OnBase Web Server and Application
Server.
1. Open the Web Application Management Console on a server with the OnBase Web
Server or Application Server installed.
2. If prompted, select one of the available web applications and click OK .

OnBase 18 69
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

3. Select Tools | Installation | Event Logs . The Event Log Creator is displayed.

4. Click the Install button next to the event log you want to install.

Note: If only the Web Server is installed on this server, then only the OnBase Log is available. If
only the Application Server is installed, then only the Hyland Application Server log is
available.

A confirmation message is displayed.

5. Click OK to close the confirmation message.
6. The installed log is now available in the Windows Event Viewer on the server. To access
the Event Viewer, see the documentation provided for your server’s operating system.

Installing Performance Counters

If the Application Server is installed on the server, then you can install the Hyland performance
counters. These performance counters are available only on machines with the Application
Server installed.
1. Open the Web Application Management Console on a server with the OnBase
Application Server installed.
2. If prompted, select one of the available web applications and click OK .

OnBase 18 70
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

3. Select Tools | Installation | Performance Counters . The Performance Counter Creator

is displayed.

4. Click the Install button next to the performance counter you want to install. A
confirmation message is displayed.
5. Click OK to close the confirmation message.

Monitoring Performance
To add performance counters to a performance log, see the documentation provided for your
server’s operating system.
When you select counters to monitor, the OnBase counters are available within the following
groups:
• Hyland
• Hyland.Database
For a list of counters available in each group, see the Web Server module reference guide.

Note: To add performance counters, have a user first log on to the OnBase Web Client to open
a session. Due to a Windows requirement, counters cannot be added unless a session has been
opened.

OnBase 18 71
©2018
Hyland Software, Inc.
 Web Application Management Console
Usage

Uninstalling Event Logs & Performance Counters

To uninstall the event logs or performance counters, run the Web Application Management
Console with the -ROMANZO command line switch.

Caution: Before using features enabled by the -ROMANZO switch, ensure that you understand
the feature and implications of any changes to your system. Contact your service provider with
any questions regarding these features. Features enabled by the -ROMANZO switch should not
be made available to the casual user. Remove the -ROMANZO switch after completing
necessary actions.

For information about applying command line switches, see the Installation chapter.
1. Log on to the Web Application Management Console with the -ROMANZO switch
applied.
2. If prompted, select one of the available web applications and click OK .
3. Do one of the following:
• To remove event logs, select Tools | Installation | Event Logs . The Event Log Creator
is displayed.
• To remove performance counters, select Tools | Installation | Performance
Counters . The Performance Counter Creator is displayed.
4. Click the Uninstall button next to the item you want to uninstall. A confirmation
message is displayed.
5. Click OK to close the confirmation message.

Optimizing Applications for Windows Authentication

The Tools | Optimize for Windows Authentication option is not supported for all modules.
Please contact Hyland Technical Support for assistance before enabling this option.
If you encounter significant delays on a system configured for Windows authentication, contact
Hyland Technical Support. You may be instructed to select the Optimize for Windows
Authentication option from the Tools menu in the Web Application Management Console. This
option can optimize performance by updating authentication settings on specific files and
folders in the server application’s virtual directory.

Viewing Version Information

To view version information for the Web Application Management Console application:
1. Open the Web Application Management Console.
2. Select one of the available web applications and click OK .
3. Select Help | About .
The About Web Application Management Console dialog box is displayed. This dialog
box displays the current OnBase version of the Web Application Management Console.

OnBase 18 72
©2018
Hyland Software, Inc.
 C ONFIGURATION

WebApplicationManagementConsole.exe.config
Settings
WebApplicationManagementConsole.exe.config is a plain text XML file used to configure the
Web Application Management Console and control its layout, behavior, and feature set. To
change features, edit the appropriate value, save, and close the file.
In a 32-bit environment, WebApplicationManagementConsole.exe.config is typically installed at
C:\Program Files\Hyland\Web Applications Management Console. In a 64-bit environment, it is
installed at C:\Program Files (x86)\Hyland\Web Applications Management Console.

appSettings
The appSettings section of WebApplicationManagementConsole.exe.config controls the
features and functions that are available in the Web Application Management Console. The
first part of this section controls general functionality of the Web Application Management
Console, while the later part controls whether certain Web.config settings are shown or hidden
in the Web Application Management Console.

Web Application Management Console Settings

WAMConLocalPath - Contains the path to the virtual directory containing the Web.config file to
be opened by the Web Application Management Console. If no path is specified, users are
prompted to select an application when they start the Web Application Management Console.
The selected application is saved and used for subsequent Web Application Management
Console sessions. If you open a different web application during your Web Application
Management Console session, then the new application is saved in
WebApplicationManagementConsole.exe.config for use when starting future Web Application
Management Console sessions.

Note: In a typical installation, the Web Server’s virtual directory is

C:\Inetpub\wwwroot\AppNet. The Application Server’s virtual directory is
C:\Inetpub\wwwroot\AppServer.

VirtualDirectory - Contains the virtual directory name of the most recently configured
application.
DisplayConfirmDialog - If this is set to true , a confirmation dialog box is displayed when saving
changes to the Web.config file. If this is set to false , no confirmation dialog box is displayed.
OEMProductName - Contains the OEM product name to be displayed in the title bar of the Web
Application Management Console.

OnBase 18 73
©2018
Hyland Software, Inc.
 Web Application Management Console
Configuration

IconDirectory - Contains the path of the root directory for icons. The default path is
[WAMConLocalPath]\[IconDirectory]. For example, \Styles\XP.

Web.config Settings
Administrators can configure whether certain Web Server Web.config settings are shown or
hidden in the Web Application Management Console by editing
WebApplicationManagementConsole.exe.config. Settings that are shown can be edited in the
Web Application Management Console. Hidden settings are not displayed and cannot be edited
through the Web Application Management Console.
For the following settings, a value of hidden means that the field is not shown in the Web
Application Management Console. When no value is specified, the field is shown in the Web
Application Management Console.

Note: You cannot specify Web Server Web.config values for these settings in the
WebApplicationManagementConsole.exe.config file. You can only specify whether the field is
hidden or shown in the Web Application Management Console.

WebApplicationManageme Console Field Console Tab Web Server

ntConsole.exe.config Web.Config Setting
Setting

webtheme Web Theme Web Client webtheme

dmsOEMProductName OEM Product Name Web Client dmsOEMProductName

dmsOEMName OEM Name Web Client dmsOEMName

targetPage Target Page Login targetPage

loginPage Login Page Login loginPage

Charset Not used.

selectDebug Select Debug Retrieval selectDebug

PathFormProc PathFormProc E-Forms - Login PathFormProc

Form Proc

PathPrint PathPrint E-Forms - Login PathPrint

Form Proc

PathToolbarImageDirectory PathToolbarImageDi E-Forms - Login PathToolbarImageDirect

rectory Form Proc ory

pmCacheLocation Cache Location Platter pmCacheLocation

Management

pmCacheTimeout Timeout (minutes) Platter pmCacheTimeout

Management

OnBase 18 74
©2018
Hyland Software, Inc.
 Web Application Management Console
Configuration

WebApplicationManageme Console Field Console Tab Web Server

ntConsole.exe.config Web.Config Setting
Setting

pmCacheSize Cache Size (MB) Platter pmCacheSize

Management

OnBase 18 75
©2018
Hyland Software, Inc.
 I NSTALLATION

Requirements
The Web Application Management Console can run in Windows environments that support the
OnBase Web Server and Application Server. Refer to the Web Server module reference guide for
information about supported operating systems and software requirements.

Microsoft .NET Framework Requirements

OnBase requires Microsoft .NET Framework 4.6 or later. The .NET Framework can be obtained
from the Microsoft Download Center at http://www.microsoft.com/downloads.

Databases Supported
The following sections list the databases supported in OnBase 18.

Microsoft SQL Server

The following versions of Microsoft SQL Server™ are supported:
• Microsoft SQL Server 2008 (RTM, SP1, SP2, SP3, or SP4)
• Microsoft SQL Server 2008 R2 (RTM, SP1, SP2, or SP3)
• Microsoft SQL Server 2012 (RTM, SP1, SP2, SP3, or SP4)
• Microsoft SQL Server 2014 (RTM, SP1, or SP2)
• Microsoft SQL Server 2016 (RTM or SP1)
• Microsoft SQL Server 2017 (for Windows or Linux)

OnBase 18 76
©2018
Hyland Software, Inc.
 Web Application Management Console
Installation

When using Microsoft SQL Server databases, also note the following:
• Microsoft SQL Server 2008 and Microsoft SQL Server 2008 R2 are being deprecated
for eventual removal from the OnBase product suite. SQL Server 2008 and 2008 R2
are supported in OnBase 18; however, they will not be available in OnBase 19 and
subsequent versions of OnBase. If you are currently using either Microsoft SQL
Server 2008 or Microsoft SQL Server 2008 R2, Hyland Software recommends using
Microsoft SQL Server 2012 or later to fulfill your needs.
• In April 2016, Microsoft discontinued technical support for Microsoft SQL Server
2005. As of release 17, Hyland Software no longer supports SQL Server 2005.
• If you are using an ODBC data source to connect to the database, you must ensure
that your SQL Server database client software version matches or exceeds the
database server version. For example, if your database server is SQL Server 2012,
verify that the database client is SQL Server 2012 (or later). Running a previous client
version, such as SQL Server 2008, will result in system instability and memory issues.
For instructions on determining your server and client versions, see Database Client /
Server Version Compatibility.

Oracle
The following versions of Oracle ® are supported:
• Oracle 11g (R2)
• Oracle 12c (R1 or R2)

Note: All Oracle 11g and 12c drivers can be used.

Note: If you are using an Oracle database, it is strongly recommended that you have a certified
Oracle Database Administrator on staff.

SAP SQL Anywhere

Support for SAP SQL Anywhere™ databases is being deprecated for eventual removal from the
OnBase product suite. Beginning in OnBase 18, new customers are required to use a supported
version of a Microsoft SQL Server or Oracle database. However, the following versions of SAP
SQL Anywhere are still supported for existing customers:
• SAP SQL Anywhere 16
• SAP SQL Anywhere 17
Beginning in OnBase 19, SAP SQL Anywhere databases will no longer be supported.

Note: On December 31, 2016, SAP retired engineering support for SQL Anywhere versions 12.x
and lower. As of OnBase 17, Hyland Software no longer supports SQL Anywhere versions 12.x
and lower.

OnBase 18 77
©2018
Hyland Software, Inc.
 Web Application Management Console
Installation

Database/File Servers
Server requirements are site-specific. Database/file servers should be dedicated purpose
servers; that is, these servers should not be used as a domain controller, email server, print
server, or proxy server. Network and disk I/O hardware should be optimized for performance
and redundancy. Multiple network interface cards on servers are often required to minimize
network bottlenecks.

Third-Party Software Compatibility

OnBase is used in conjunction with a variety of third-party software products. The specific
versions of third-party software that are supported are documented in the requirements
sections of this manual, which reflect the versions that were required at the time this manual
was published.
For up-to-date information, visit the following site: https://www.onbase.com/community/
technical_communities/third_party_software_updates/default.aspx.

About Virtual Environments

Hyland Software develops, tests, and supports the OnBase suite of products on specific
Operating Systems, not specific hardware configurations. When OnBase is operated in a virtual
environment (such as Citrix, VMware, Hyper-V, or Windows Remote Desktop) there may be
limitations or subtle differences imposed by the environment. The customer and the virtual
environment vendor are responsible for any interactions or issues that arise at the Hardware or
Operating System layer as a result of their use of a virtual environment.
When it appears that a performance-related issue in OnBase is either caused by (or is unique
to) the virtual environment, organizations may be asked to validate that the issue occurs in a
non-virtual environment. Hyland Software will make this request if there is reason to believe
that the virtual environment is a contributing factor to the issue.
Each OnBase site is unique. Hyland Software depends on the customers who deploy OnBase in
virtual environments to do so only after careful design and adequate planning (that takes into
account the workloads of your organization), and in accordance with recommendations
provided by the virtual environment’s vendor. As with any implementation, Hyland Software
strongly recommends that any customer deploying the OnBase solution in a virtual
environment thoroughly test the solution before putting it into production.
For information about using OnBase in a Citrix and Microsoft Windows Remote Desktop
environment, please see the Citrix and Microsoft Windows Remote Desktop Environment
Deployment Guide , available on the Hyland Community (https://www.onbase.com/
community).

OnBase 18 78
©2018
Hyland Software, Inc.
 Web Application Management Console
Installation

64-Bit Support Statement

The OnBase suite of products is tested on 64-bit systems and is capable of being deployed on
64-bit systems using the Windows 32-bit on Windows 64-bit Emulator (WOW64) layer. However,
OnBase modules that integrate with third-party applications may not be able to be used with
the 64-bit versions of these applications. For these modules, only the 32-bit versions of these
third-party applications are currently supported by the OnBase integrations. Consult the
module-specific requirements section in each module reference guide for complete
requirements details.
Supported database versions that are deployed on a 64-bit database server are also supported.
For more information, contact your solution provider.

Licensing
See Licensing on page 1 for licensing requirements.

Installation
The Web Application Management Console is automatically installed when the Web Server
and/or Application Server are installed using the separate installers for each module. For
information on installing the Web Server, see the Web Server manual reference guide. For more
information on installing the Application Server, see the Application Server manual reference
guide.
In a 32-bit environment, WebApplicationManagementConsole.exe is typically installed at
C:\Program Files\Hyland\Web Applications Management Console. In a 64-bit environment, it is
installed at C:\Program Files (x86)\Hyland\Web Applications Management Console.
The Web Application Management Console can also be installed manually. To install the Web
Application Management Console manually, copy the \WebApplicationManagementConsole
folder from the \utilities folder of your OnBase Core Services build to the workstation that will
be running the Web Application Management Console.

Command Line Switches

The Web Application Management Console supports the following command line switches. To
apply a command line switch, create a shortcut to the Web Application Management Console,
access the shortcut’s Properties , and add the command line switch to the end of the Target
value on the Shortcut tab.

-CONFIGPATH
When applied to the Web Application Management Console, this switch directly opens the
connection strings dialog box with the specified .config file, bypassing the main Web
Application Management Console interface. This allows you to configure connection strings for
applications or services other than the Application Server.

OnBase 18 79
©2018
Hyland Software, Inc.
 Web Application Management Console
Installation

For example:

-CONFIGPATH="path\filename.config"

-ROMANZO
Caution: Before using features enabled by the -ROMANZO switch, ensure that you understand
the feature and implications of any changes to your system. Contact your service provider with
any questions regarding these features. Features enabled by the -ROMANZO switch should not
be made available to the casual user. Remove the -ROMANZO switch after completing
necessary actions.

This switch is used for advanced functionality. The features hidden by this switch are intended
for use by customers, but not by just any user. Therefore, they are hidden from the casual user.
An example of this would be the Directory Service Authentication dialog box in the
Configuration module, where an administrator can configure Active Directory or LDAP
authentication options for their OnBase system.

In the Web Application Management Console, this switch allows you to uninstall the event logs
and performance monitors provided for monitoring the OnBase Web Server and Application
Server.

Contacting Support
When contacting your solution provider, please provide the following information:
• The OnBase module where the issue was encountered.
• The OnBase version and build (Example: 18.0.0.10).
• The type and version of the connected database, such as Microsoft SQL Server 2014
or Oracle 12c, and any Service Packs that have been installed.
• The operating system that the workstation is running on, such as Windows 10 or
Windows Server 2012 R2, and any Service Packs that have been installed. Check the
supported operating systems for this module to ensure that the operating system is
supported.
• The name and version of any application related to the issue.
• The version of Internet Explorer, and any Service Packs that have been installed, if
applicable.
• A complete description of the problem, including actions leading up to the issue.
• Screenshots of any error messages.
Supplied with the above information, your solution provider can better assist you in correcting
the issue.

OnBase 18 80
©2018
Hyland Software, Inc.
 WEB APPLICATION M ANAGEMENT C ONSOLE B EST
P RACTICES

The following best practice recommendations were assembled by a team of OnBase subject
matter experts. They represent the accumulation of years of experience installing and
configuring OnBase solutions.
The following recommendations are general in nature, and are applicable to most OnBase
solutions and network environments. Depending on your solution design and your
organization’s needs, not all of the best practice recommendations listed below may apply to,
or be recommended for, your OnBase solution.
Carefully consider the impact of making any changes, including those listed below, to your
OnBase solution prior to implementing them in a production environment.

Usage
Editing Settings
Before editing an application’s Web.config settings using the Web Application Management
Console, it is considered a best practice to:
• Ensure you are familiar with the setting’s function and valid values. For further
information on what each setting in the Web Application Management Console
controls, see the respective web application’s documentation.
• Ensure that users are not using modules or applications that rely on the OnBase Web
Server or Application Server. Saving changes to an application’s Web.config file
causes web applications to restart. All users connected to the Web Server or
Application Server.

Exporting Settings
It is considered a best practice to export settings from an application’s Web.config file before
making large changes to configuration. These exported settings will serve as a backup in case
your OnBase solution does not function as expected after making configuration changes.

OnBase 18 81
©2018
Hyland Software, Inc.