AppServerGateway 24.1

Gateway Caching Server
Reference Guide
Includes:
Installation Guide
Administration Guide
Foundation 24.1
Documentation Notice
Information in this document is subject to change without notice. The software described in this
document is furnished only under a separate license agreement and may only be used or copied
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 may
contain certain information which is confidential information of Hyland Software, Inc. and its
affiliates, and which may be subject to the confidentiality provisions agreed to by you.
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. or one of its affiliates.
Hyland, Hyland Experience, OnBase, Alfresco, Nuxeo, and product names are registered and/or
unregistered trademarks of Hyland Software, Inc. and its affiliates in the United States and other
countries. All other trademarks, service marks, trade names and products of other companies are the
property of their respective owners.
© 2024 Hyland Software, Inc. and its affiliates.
The information in this document may contain technology as defined by the Export Administration
Regulations (EAR) and could be subject to the Export Control Laws of the U.S. Government including
for the EAR and trade and economic sanctions maintained by the Office of Foreign Assets Control as
well as the export controls laws of your entity’s local jurisdiction. Transfer of such technology by any
means to a foreign person, whether in the United States or abroad, could require export licensing or
other approval from the U.S. Government and the export authority of your entity’s jurisdiction. You are
responsible for ensuring that you have any required approvals prior to export.
DISCLAIMER: This documentation contains available instructions for a specific Hyland product
or module. This documentation is not specific to a particular customer or industry. Hyland
customers are responsible for making their own independent assessment of the information in
this documentation. This documentation: (a) is for informational purposes only, (b) is subject to
change without notice, and (c) does not create any commitments or assurances by Hyland or its
affiliates. This documentation is provided “as is” without representation or warranty of any kind.
Hyland expressly disclaims all implied, express, or statutory warranties. Hyland’s responsibilities and
liabilities to its customers are controlled by the applicable Hyland agreement. This documentation
does not modify any agreement between Hyland and its customers.
Document Name
Department/Group
Documentation
Revision Number
Foundation 24.1
© 2024 Hyland Software, Inc. and its affiliates i

Contents
Overview
Contents
Introduction..................................................................................................................................................1
Caching...........................................................................................................................................................2
Cache Management...........................................................................................................................2
Supported File Formats..................................................................................................................... 3
Encryption...........................................................................................................................................3
Disk Groups & Caching..............................................................................................................................3
Licensing........................................................................................................................................................ 4
Simplified Licensing...........................................................................................................................4
Legacy Licensing............................................................................................................................... 4
Installation Guide
Installation
Installation Overview................................................................................................................................6
Requirements...............................................................................................................................................6
General Requirements....................................................................................................................... 6
Server Hard Drive Configuration....................................................................................................... 6
Load Balancing...................................................................................................................................6
Gateway Installation..................................................................................................................................7
Configuring General Web.config Settings...................................................................................... 14
Using the Web Application Management Console...................................................................14
Web.config Settings................................................................................................................... 15
AllowInsecureConnection.................................................................................................... 16
Change, Repair, or Remove an Installation.....................................................................................16
Client Installation.....................................................................................................................................16
Enabling Caching for the Unity Client............................................................................................. 17
Enabling Caching for the Web Client.............................................................................................. 17
Controlling the Installer from the Command Line........................................................................ 17
Installer Properties.......................................................................................................................... 18
APPLICATION_SERVER_GATEWAY_FILES................................................................................18
APPLICATION_SERVER_URL..................................................................................................... 18
APPSERVER_GATEWAY_APPLICATION_NAME....................................................................... 18
APPSERVER_GATEWAY_CACHEPATH......................................................................................18
APPSERVER_GATEWAY_NAME.................................................................................................18
APPSERVER_IIS_WEBSITE_ID................................................................................................... 18
DATASOURCE............................................................................................................................. 18
DB_SERVICE_PASS.....................................................................................................................18
DB_SERVICE_USER.....................................................................................................................19
IIS_ASPNET_IMPERSONATION................................................................................................. 19
IIS_ASPNET_PASS......................................................................................................................19
IIS_ASPNET_USER......................................................................................................................19
IIS_NTAUTH................................................................................................................................ 19
IIS_SSL........................................................................................................................................ 19
© 2024 Hyland Software, Inc. and its affiliates ii

Contents
Troubleshooting........................................................................................................................................20
Request timed out............................................................................................................................20
Contacting Support................................................................................................................................. 21
Configuration
Overview.....................................................................................................................................................23
Service Account Configuration............................................................................................................23
Gateway Configuration.......................................................................................................................... 25
Creating a Gateway..........................................................................................................................26
Excluding Document Types from Being Cached............................................................................28
Gateway Exclusion Configuration............................................................................................. 28
Document Type Exclusion Configuration..................................................................................29
Configuring Autocaching.................................................................................................................29
Gateway Autocaching Configuration........................................................................................ 29
Document Type Autocaching Configuration............................................................................ 30
Configuring Keyword Rules............................................................................................................. 31
Gateway Keyword Rule Configuration.......................................................................................31
Creating a Gateway Keyword Rule....................................................................................... 31
Editing a Gateway Keyword Rule..........................................................................................33
Deleting a Gateway Keyword Rule....................................................................................... 33
Document Type Keyword Rule Configuration...........................................................................33
Creating a Document Type Keyword Rule........................................................................... 33
Editing a Document Type Keyword Rule..............................................................................35
Deleting a Document Type Keyword Rule........................................................................... 35
Workflow Configuration........................................................................................................................35
© 2024 Hyland Software, Inc. and its affiliates iii

Overview
Introduction
The Gateway Caching Server is a network component that allows organizations to manage file
caching geographically. The Gateway Caching Server provides geographically distant employees fast
access to Office documents, PDF documents, and single- and multi-page CAD drawings through the
OnBase Unity Client and Web Client.
The following diagram illustrates a configuration where the Gateway Caching Server is installed
at three remote locations, while the OnBase Application Server is installed at the company's
headquarters in Ohio:
In this example, the OnBase database and disk groups reside in Ohio in the United States. Each
remote location has a gateway installed, and each gateway communicates with the system in Ohio.
The remote locations can also have other OnBase components such as Web Servers, Web Clients,
Unity Clients and even custom Unity-based API applications. All these components communicate
with the gateway, which resolves large file requests using a local cache.
© 2024 Hyland Software, Inc. and its affiliates 1

Overview
Caching
The Gateway Caching Server facilitates file access by caching large files at remote locations. For
example, when the Gateway Caching Server requests a PDF document, it caches the document
locally so that subsequent requests can be fulfilled more quickly. When the Gateway Caching Server
retrieves a document from the cache, it eliminates the download time required to obtain the file from
the OnBase disk groups through the OnBase Application Server. See the following topics for more
information:
• Cache Management on page 2
• Supported File Formats on page 3
• Encryption on page 3
Cache Management
Once configured, the Gateway Caching Server allows documents with supported formats to be
automatically cached upon first access at gateway locations. Several additional mechanisms are
available to help you manage file caching.
Caching on Modification
When documents belonging to specified Document Types are uploaded, revised, or modified, the
documents can be automatically cached to specific gateways. This feature ensures users always
have access to the latest copy of a document.
Caching on Upload
In the Unity Client, when documents are uploaded at a location where they are configured to be
cached, the Gateway Caching Server both uploads the documents and immediately caches the
documents locally. The Gateway Caching Server does not need to download documents to the cache
after uploading them from the Unity Client.
Keyword Mapping
The gateway can cache documents to specific remote locations according to configured rules. Rules
are driven by Document Types, Keyword Values, and the Workflow and Unity API methods.
Document Type Exclusions
Specific Document Types can be configured as excluded from file caching.
Document Expiration
The gateway can automatically update the cache at remote locations when cached documents
become stale, or expire. This expiration can occur after a configured period or when the document
has been edited, revised, or deleted.
Cache Cleanup
The gateway automatically removes documents from the cache when the documents are deleted
from OnBase. The gateway also runs a cleanup process every hour in case the cache ever exceeds
its configured maximum size. For more information, see the description of 5.
Core-Based Workflow
Workflow actions can explicitly send a document to one or more remote locations, or it can use the
Keyword mapping to resolve the cache destinations.

Overview
Unity API
The Unity API can explicitly send a document to a remote location, or it can use the Keyword
mapping to resolve the cache destinations.
Supported File Formats

The Gateway Caching Server supports caching for documents of the following file formats (as they
appear in OnBase Configuration):
• AVI Movie
• Engineering Drawings (used for certain CAD documents)
• MS Excel Spreadsheet
• MS Outlook Message
• MS Power Point
• MS Word Document
• PDF
• Rich Text Format
• Spicer Document (used for certain CAD documents)
• WAV Audio File
Note: For information about CAD file formats, see the documentation for your OnBase CAD
integration.
Note: Caching is not supported for documents with custom file formats.
Encryption
Files stored in the cache are encrypted to protect the security of the documents. Cached documents
can be viewed only in OnBase by users with sufficient privileges.
Disk Groups & Caching

When setting up your OnBase system, be aware of the differences between the OnBase disk groups
and the Gateway Caching Server's caching mechanisms. Do not attempt to use the OnBase disk
groups for caching purposes, and do not attempt to use the Gateway Caching Server for backing up
files.

Overview
Disk Groups Caching
Backups: Disk groups are ideal for backup Not for backups: Caching should never be
purposes. As documents are committed, they are used for backup purposes. The consistency of
pushed to multiple backup locations and can be the cache is not guaranteed and items may be
burned to media at a later date. flushed from the cache. The caching mechanism
Predictable copying: The process by which data is internal and so the location of the cache is
makes its way to multiple copies within a disk not published and may change from release to
group is predictable. release.
Non-distributed: Disk groups are not intended Variable copying: Items may or may not make
for distributed document access. their way into the cache, depending on the
Consistency of content: Each copy of a disk various configured rules. At any moment, there is
group is a mirror of the other copies. The content no guarantee that an item that should be in the
is consistent from one copy to the next for a cache is in the cache.
given disk group. Distributed: Caching with the Gateway Caching
Server is the recommended approach for
facilitating document access at distributed
locations.
Application Server only: Caching works only
with Application Server-based products, such as
the Web Client and Unity Client.
Gateway required: Caching requires the
deployment of an Gateway Caching Server.
Licensing
Beginning in OnBase Foundation EP5, new customers must use simplified licensing to access
Gateway Caching Server functionality. Existing customers upgrading from a version of OnBase prior
to OnBase Foundation EP5 can continue to use legacy licensing to access this functionality.
If you are a new customer as of OnBase Foundation EP5 or greater, see Simplified Licensing on page
4.
If you are upgrading from a version of OnBase prior to OnBase Foundation EP5, see Legacy Licensing
on page 4.
Simplified Licensing
The Essential User, Standard User, or Premier User license is required.
Legacy Licensing
The Gateway Caching Server requires a Gateway Caching Server license for each gateway in your
system.
Check your current licensing status by selecting Utils | Product Licenses in OnBase Configuration.

Guide
Installation
Installation Guide
Foundation 24.1
Installation
Installation Overview
See the following topics for Gateway Caching Server installation information:
• Requirements on page 6
• Gateway Installation on page 7
• Client Installation on page 16
Requirements
The following sections outline requirement information specific to Gateway Caching Server in
OnBase Foundation 24.1.
General Requirements
For general requirement information that applies to Gateway Caching Server and other modules, see
the sections on the following topics in the Installation Requirements manual:
• Operating system requirements
• Microsoft .NET Framework requirements
• Microsoft Visual C++ requirements
• Web browser requirements
• Hardware requirements
See the Application Server module reference guide for additional system requirements.
Server Hard Drive Configuration

Because the Gateway Caching Server closely resembles a server hosting the Disk Groups, its hard
drive configuration must be appropriate for processing document requests. Use fast storage for the
cache location. Fast storage often can be achieved using drives in a RAID or spanned configuration.
Load Balancing
The Gateway Caching Server is supported in a load-balanced environment. If you configure load
balancing, ensure all load-balanced Gateway Caching Servers point to the same network cache
location. There should be only one cache per geographic gateway location.
Each Gateway Caching Server must be installed on a separate machine. Load balancing with multiple
gateways on the same machine is not supported.
For more information on load balancing, see the Application Server module reference guide.

Installation
Gateway Installation
Use the Gateway Caching Server installer to install a gateway at each remote location where
documents need to be cached.
1. Double-click setup.exe from your installation files. The Hyland Gateway Caching Server Setup
Wizard is displayed.

Installation
2. Click Next. The Destination Folder screen is displayed.
3. Enter the directory where the Gateway Caching Server should be installed. To browse to the
directory, click Change.
If you click Change, the Change destination folder screen is displayed. Enter a Folder name in
the field provided, or select it from the Look in drop-down. Then, click OK.

Installation
If the Destination Folder is not changed, the default location is used (e.g., C:\Inetpub\wwwroot
\GatewayCachingServer\).
4. Click Next. The Data Source page is displayed.
5. Enter the name of a valid connection string in the field.

6. Click Next. The IIS Settings screen is displayed.

Installation
7. Select the IIS settings you want to enable.
Setting Description
Use identity impersonation to Select to use identity impersonation to run your Gateway Caching
run the IIS worker process Server. If this option is not selected, then the Gateway Caching
Server runs under the Network Service account.
Enable TLS Select to run the Gateway Caching Server using an HTTPS
connection. If this option is selected, you must ensure the server is
correctly configured for HTTPS connections.
Note: An HTTPS connection is required, even though you have the
ability to disable this option. The Gateway Caching Server must be
configured to use HTTPS connections.
Use NT/LDAP Authentication Select to enable Active Directory or LDAP authentication.
If you select Use identity impersonation to run the IIS worker process:
• In the User Name field, enter the domain and user name to use to run the IIS worker process
for your server. This must be entered in the domain\username format.
• In the Password field, enter the password that corresponds to the user name provided.
• In the Confirm Password field, re-enter the password that corresponds to the user name
provided. This is used to ensure that the password is typed correctly.
The impersonation account is granted modify rights to the installation directory (e.g.,
GatewayCachingServer) and its sub-directories. The cache path inherits its permissions from
the folder where it is created.
Note: The installer does not add modify rights for any other groups. If impersonation is not
used, ensure the account the Gateway Caching Server is running under has modify rights to
the installation and cache directories. If modify rights are not granted, you may experience
permissions errors in modules attempting to modify files on the server.

Installation
8. Click Next. The OnBase Service Account screen is displayed.
9. Enter and confirm the credentials for the OnBase Service Account that the Gateway Caching
Server will use.
• In the User Name field, enter the Service Account's OnBase user name.
• In the Password field, enter the Service Account's password.
• In the Confirm Password field, re-enter the Service Account's password. This is used to
ensure that the password is typed correctly.

Installation
10. Click Next. The Gateway Caching Server Settings screen is displayed.
11. Enter the Gateway Name as it is displayed in OnBase Configuration. For information about
configuring gateways, see Creating a Gateway on page 26.
12. Enter the Cache Path(the location where this Gateway Caching Server will cache documents).
• For example: C:\ClevelandGateway\Cache\ or \\server-1\ClevelandGateway\Cache
• For load-balanced deployments, this location should be a UNC path shared by each load-
balanced Gateway Caching Server.
• To browse to the directory, click Change. Enter a Folder name in the field provided, or select
it from the Look in drop-down. Then, click OK.

Installation
13. Click Next. Additional settings are displayed.
14. Select the Web site where the Gateway Caching Server should be installed. The Web Site list is
populated with the Web sites configured in IIS and available to the target machine.
15. Enter a name for the Gateway Caching Server application.
16. Click Next. The Application Server URL screen is displayed.

Installation
17. Enter the URL to the Application Server's Service.asmx page.

18. Click Next. The installer is now ready to install the Gateway Caching Server.
19. Click Install.

20. When the installation is complete, click Finish.
Note: A common practice after installation of server applications may be to test navigation
to the application's Service page to verify a correct installation (e.g., http://localhost/
GatewayCachingServer/Service.asmx). Navigating to this page for the Gateway Caching Server
will display an error: Root element is missing. However, this is intended behavior based on the
functionality of the Gateway Caching Server.
Configuring General Web.config Settings

When the installer runs, it automatically configures the Gateway Caching Server Web.config file. Use
the information provided in this section to change Web.config settings after installation.
Tip: It is considered a best practice to use the Web Application Management Console to edit your
Web.config file. The console also allows you to set up or change your impersonation settings. See
Using the Web Application Management Console on page 14.
Using the Web Application Management Console

To edit the Web.config file on the server hosting the Gateway Caching Server:
1. Make a backup copy of the Web.config file before you modify it.
2. Launch the Web Application Management Console locally on the Gateway Caching Server server.

Installation
In a typical installation, the Web Application Management Console can be found here:
• 32-Bit Systems: C:\Program Files\Hyland\Web Applications Management Console.
• 64-Bit Systems: C:\Program Files (x86)\Hyland\Web Applications Management Console
3. Select your Gateway Caching Server virtual directory and click OK.
4. Modify the settings as needed. If necessary, you can also change your impersonation account
using the console's Tools menu.
5. Click Save when finished.
Note: For more information about available tools, see the Web Application Management Console
documentation.
Web.config Settings
See the following table for descriptions of Gateway Caching Server Web.config settings:
Web.config Setting Description
ApplicationServer Url The path to the Service.asmx page on the OnBase Application
Server.
Note: Ensure the extension of the service page is .asmx and the
ServiceClientType is SOAP. Remoting is not supported with the
cachePath The path to the cache where documents of specific Document

Types or file types are stored for quick retrieval.
CipherValue (under The encrypted Username and Password values for the OnBase
EncryptedData) service account that the Gateway Caching Server will use.
These credentials are automatically encrypted by the Gateway
Caching Server installer. To change the credentials, use the Web
Application Management Console. See the Web Application
Management Console module reference guide for more
information.
dataSource The name of the ODBC connection configured on the OnBase

Application Server.
gatewayName The name of the gateway as specified in OnBase Configuration. To

create a gateway in OnBase Configuration, see Creating a Gateway
on page 26.
identity impersonate; The identity element allows you to enable or disable identity
username; password impersonation. For more information, see the Application Server
module reference guide.

Installation
AllowInsecureConnection
AllowInsecureConnection- This setting controls whether or not the server will only accept https://
connections, or if it will accept both http:// and https:// connections. By default, this setting is set to
false.
To only allow https:// connections to the server, this setting should be set to false.
To allow both http:// and https:// connections to the server, this setting should be set to true.
Note: If AllowInsecureConnection is set to false, then the server must be correctly configured for
HTTPS connections.
Change, Repair, or Remove an Installation

After initial installation, the setup program can be used to change, repair, or remove components
from a previous installation. After launching setup.exe or the *.msi installation package, and clicking
Next at the welcome dialog, the Change, repair, or remove installation dialog box is displayed.
Select the option for the actions you wish to perform:
Option Description
Change Add or remove components using the Custom Setup dialog.

Note: This option is not available if the installer has no independently selectable
features.
The steps for adding selected components are the same as those under the
Component Selection section of the installation instructions, if applicable to the
installer.
Note: Change does not allow you to alter configuration options originally set
during a previous installation of components contained in the installer.
Repair Repair errors in the most recent installation of the component, such as missing
and corrupt files, shortcuts, and registry entries.
Note: This option is not available from all installers. Repair does not include
errors made in the configuration options set by the user during installation. For
specific troubleshooting information regarding an installed component, see the
module reference guide for that component.
Remove Removes all previously installed components.
Client Installation
To take advantage of caching through the Gateway Caching Server, client applications must be
configured to send requests to the Gateway Caching Server rather than the Application Server.
The following procedures describe how to manually configure Application Server-based modules to
use the Gateway Caching Server:
• Enabling Caching for the Unity Client on page 17

Installation
• Enabling Caching for the Web Client on page 17
Enabling Caching for the Unity Client

1. Open obunity.exe.config.
2. Locate the ServiceLocations element.
3. For each applicable service location, set the ServicePath to point to the local gateway's
service.asmx page. For example:
<add ServicePath="http://gatewayServer/ClevelandGateway/service.asmx"
Datasource="DMS" FriendlyName="DocMgmt" UseNTAuthentication="false" />
Enabling Caching for the Web Client

The following steps describe how to configure the Web Client to use the Gateway Caching Server.
1. Open the Web Server's Web.config file.
2. Locate the ApplicationServer element.
3. Set the ApplicationServer Url to the local gateway's service.asmx page. For example:
<ApplicationServer Url="http://gatewayServer/ClevelandGateway/service.asmx"
ServiceClientType="SOAP"/>
4. In the ApplicationServer element, ensure the extension of the service page is .asmx and the
ServiceClientType is SOAP. Remoting is not supported with the Gateway Caching Server
5. Save and close the Web.config file.
Controlling the Installer from the Command Line

The Hyland Gateway Caching Server installer can be run from an installation CD or a local drive. For
upgrades, be sure to uninstall the old application before running the installer.
When run from the command line, the installer must be launched using this command, where [PATH]
represents the location of the MSI:
msiexec /i "[PATH]\Hyland Gateway Caching Server.msi"
To control the installer from the command line, you must configure the installation options by
applying the properties listed in the following sections. Properties are appended to the command in
the format PROPERTY NAME="VALUE".
To make a property empty, set its value to an empty string. For example, to disable impersonation,
you would set the property like this on the command line:
msiexec /i "[PATH]\Hyland Gateway Caching Server.msi"

IIS_ASPNET_IMPERSONATION=""

Installation
Installer Properties
Available properties are described in the following topics.
APPLICATION_SERVER_GATEWAY_FILES
The location where Gateway Caching Server files are installed.
The default location is C:\Inetpub\wwwroot\GatewayCachingServer\
APPLICATION_SERVER_URL
The URL to the Service.asmx page on the OnBase Application Server.
For example: APPLICATION_SERVER_URL="http://serverOBApp/AppServer/Service.asmx"
This setting is required.
APPSERVER_GATEWAY_APPLICATION_NAME
The name of the Gateway Caching Server's application in IIS.
APPSERVER_GATEWAY_CACHEPATH
The location of the file cache. The default location is C:\Documents and Settings\All Users
\Application Data\Hyland Software\AppServerGateway\Cache\
APPSERVER_GATEWAY_NAME
The name of the gateway specified in OnBase Configuration.
APPSERVER_IIS_WEBSITE_ID
The identification number of the IIS Web site where the Gateway Caching Server will be installed.
Web site identifiers are found in the Internet Information Services (IIS) Manager.
If you have only one Web site under IIS (e.g., Default Web Site), its number is typically 1.
DATASOURCE
The ODBC name of the OnBase data source on the OnBase Application Server.
For example: DATASOURCE="ODBC Name"
DB_SERVICE_PASS
The password for the DB_SERVICE_USER user name entered (the service account).

Installation
For example: DB_SERVICE_PASS = "password"

DB_SERVICE_USER
The OnBase service account to use for the gateway service.
For example: DB_SERVICE_USER = "SERVICEACCT"
IIS_ASPNET_IMPERSONATION
Enter 1 to enable IIS identity impersonation. Leave empty to disable identity impersonation. If
identity impersonation is disabled, then the Gateway Caching Server runs under the Network Service
account. If this property is not included, the default value of 1 is used and IIS identity impersonation
is enabled.
For example: IIS_ASPNET_IMPERSONATION=""
Note: Ensure the account the Gateway Caching Server is running under has modify rights to the
installation and cache directories. If modify rights are not granted, you may encounter permissions
errors in modules attempting to modify files on the server.
IIS_ASPNET_PASS
The password for the IIS_ASPNET_USER user name entered.
For example: IIS_ASPNET_PASS = "password"
This setting is required when IIS_ASPNET_IMPERSONATION is set to 1.
IIS_ASPNET_USER
The domain user account to use for identity impersonation. This must be entered in the domain
\username format. If this property is not included, the default value of domain\username is used.
For example: IIS_ASPNET_USER = "domain\username"
This setting is required when IIS_ASPNET_IMPERSONATION is set to 1.
IIS_NTAUTH
Enter 1 to enable Active Directory or LDAP Authentication.
For example: IIS_NTAUTH="1"
This setting is optional.
IIS_SSL
Enter 1 to run the Gateway Caching Server using an SSL connection. If SSL is enabled you must
ensure the server is correctly configured for SSL connections.

Installation
For example: IIS_SSL="1"

This setting is optional.
Note: The installer only supports installation to a virtual directory. You cannot use the installer to
install to a Web site root. If you set IIS_SSL="1" the URL must begin with https:
Troubleshooting
Information about Gateway Caching Server events is logged to the OnBase Log in the Windows Event
Viewer. Gateway Caching Server will be the Source name for these events.
Tip: Run the Diagnostics Service or Diagnostics Console on the Application Server to log events from
Gateway Caching Servers that are reporting to that Application Server.
Request timed out

After users attempt to view or upload very large documents, the attempt fails and the following
message is logged to the Diagnostics Console:
• Request timed out
This message is displayed when the requested action (such as uploading or downloading a
document) takes longer than the configured execution timeout.
The execution timeout specifies the number of seconds the application has to execute a request
before the request times out. Depending on your network architecture, you may need to increase the
execution timeout at one of the following levels:
• Application Server
• Web Server
• Gateway Caching Server
If users' requests are passing through more than one of these applications, start with the application
that has the lowest execution timeout. To increase the execution timeout:
1. Open the application's Web.config file.
2. Locate the executionTimeout setting.
Note: The Gateway Caching Server's Web.config file does not contain an executionTimeout
setting. As a result, it uses the default ASP.NET execution timeout of 110 seconds. Add
<httpRuntime executionTimeout="110"/> on a new line directly above the </configuration> tag
in the Gateway Caching Server's Web.config file, and modify the value accordingly.
3. Specify (in seconds) how long the server should allow a request to be executed.
Keep in mind this value controls how long the server is allowed process a user's request. If the
server cannot execute the user's request within the period allowed, the user will have to wait the
entire duration of the executionTimeout before an error is logged.
Note: If you intend to export PCL documents to PDF, the executionTimeout value must be set to
86000. This allows an export to succeed without timing out.
4. Save the Web.config file.

Installation
5. Test whether the issue is resolved. If it is not, then repeat these steps as needed until the
executionTimeout is large enough for the request to be executed. You may need to perform
these steps for more than one server application.
Tip: For assistance troubleshooting timeout issues, contact your first line of support.
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.
• The type and version of the connected database, such as Microsoft SQL Server 2022 or Oracle
19c, and any Service Pack that has been installed.
• The operating system that the workstation is running on, such as Windows 11 or Windows Server
2022, and any Service Pack that has 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 Pack that has 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.

Guide
Administration
Foundation 24.1
Configuration
Overview
To configure the Gateway Caching Server, complete the following steps:
1. Create the Service Account under which the Gateway Caching Server will run. See Service
Account Configuration on page 23.
2. Configure gateways, exclusions, and mapping rules in OnBase Configuration. See Gateway
Configuration on page 25.
3. (Optional) Configure a Workflow life cycle to push documents out to specific gateways. See
Workflow Configuration on page 35.
Service Account Configuration

The Gateway Caching Server must be configured to use a Service Account. After configuring a
Service Account in OnBase Configuration, you must enter its credentials in the Gateway Caching
Server's Web.config file.
To configure a Service Account:
1. From the Configuration module, select Users | User Names / Passwords.
The User Names & Passwords dialog box is displayed.
2. Enter a new user name in the field beneath the User Name list and click Create. The User
Settings dialog box is displayed.

Configuration
You can also select an existing user account to designate as a service account, then click
Settings. The User Settings dialog box is displayed.
3. Select the Service Account check box under Administrator Options.
All options not applicable to a Service Account are disabled. Deselecting the Service Account
check box for the existing user allows them to retain all rights and privileges that were previously
assigned to them. Options in the User Settings dialog box are cleared when the Service
Account check box is selected and must be reapplied when the check box is deselected.
CAUTION: The Service Account check box should never be selected with an account that is
being used to run the OnBase Client (obclnt32.exe) as a Windows service.
CAUTION: Designating an existing user account as a Service Account removes the existing user
from all User Groups and prevents the user from being added into a User Group. Users that are
configured as service accounts will not be able to log into OnBase through standard interfaces. A
Service Account also grants the user name full rights and privileges in OnBase.

Configuration
4. Enter a User Password and repeat this password in the Verify Password field. If this is an
existing user account and you need to change its password, select Update Password to enable
these fields.
Note: The Require Password Change on Next Login setting cannot be selected for Service
Accounts.
5. Click Save.
Gateway Configuration
Once an Gateway Caching Server is installed, you must configure its settings in OnBase
Configuration.
• For each gateway, you can configure settings that govern how often the cache is updated and
how often documents expire from the cache.
• You can configure custom caching rules that allow documents to be automatically cached when
they are uploaded or modified.
• You can use either Workflow or the Unity API to cache documents at remote locations.
Note: Gateway configuration requires the System Configuration configuration right.

Configuration
Creating a Gateway
Using OnBase Configuration, you must configure each Gateway Caching Server installed on your
network.
Note: Each gateway consumes an Gateway Caching Server license. You cannot create more
gateways than your system is licensed for.
1. In OnBase Configuration, select Utils | Gateway Caching Server. The Gateway Caching Server
Configuration dialog box is displayed.
2. Type a name for the new gateway in the field provided.

3. Click Create. The new gateway is added to the list.

Configuration
4. Click Settings to display the Gateway Caching Server Settings dialog box.
5. Update each setting's value, as described in the following table:
Setting Description
Poll Interval In Minutes Enter the number of minutes between each time the Gateway Caching
Server polls to cache or re-cache documents.
Valid values range from 1–9999.
Days Until Document Enter the number of days before a document expires and is eligible to
Expiration be removed from the cache. A document's age is based on the day it
was cached. Valid values range from 1–9999.
Expired documents are removed only when the Max Cache Size has
been exceeded. See the description of the Max Cache Size setting for
more information.
Documents are automatically removed from the cache if they have
been deleted in OnBase.
Max Cache Size (GB) Enter the maximum size allowed for the cache (in GB). Valid values
range from 1–9999.
The Gateway Caching Server runs a cleanup process once per hour.
If the cache grows too large, then the cleanup process removes all
expired documents.
If the cache is still too large, then the cleanup process removes all
documents older than half the Days Until Document Expiration
setting. For example, suppose document expiration is set to 30 days. If
the cache is still too large after expired documents are removed, then
documents older than 15 days are removed.
If the cache size is too large after the cleanup process runs, then you
may need to increase the Max Cache Size or add more disk space.
6. Click Save.

Configuration
Excluding Document Types from Being Cached

By default, any document with a supported file format is cached unless its Document Type is
explicitly excluded. If necessary, you can exclude documents from specific Document Types from
being cached at specific gateways.
Note: Configured exclusions are applied on a day-forward basis. If a document from an excluded
Document Type has already been cached at a gateway, the document will continue to be
synchronized as part of that gateway's cache.
Gateway Exclusion Configuration

Complete the following steps to exclude one or more Document Types from being cached at a
specific gateway:
2. Select the gateway you want to configure.
3. Click Exclude. The Exclude dialog box is displayed.
4. If necessary, select a Document Type Group to filter the list of Document Types.
5. From the Available list, select the Document Types that should not be cached at this gateway.
• To individually select multiple Document Types, press CTRL as you click each one.

Configuration
• To select multiple consecutive Document Types, either click and drag your pointer over them,
or select the first Document Type, and then press SHIFT as you select the last Document
Type.
6. Click Add to move the selected Document Types to the Excluded list.
7. Click Close when finished.
Document Type Exclusion Configuration

Complete the following steps to prevent a specific Document Type from being cached at one or more
gateways:
1. In OnBase Configuration, select Document | Document Types.
2. Select the Document Type you want to configure.
3. Click Gateway. The Gateway Caching Server dialog box is displayed.
4. Click Exclude.
5. Select the gateways where the Document Type should not be cached.
• To individually select multiple gateways, press CTRL as you click each one.
• To select multiple consecutive gateways, either click and drag your pointer over them, or
select the first gateway, and then press SHIFT as you select the last gateway.
6. Click Add.
7. Click Close.
Configuring Autocaching
Autocaching allows documents to be automatically cached to a gateway when they are created,
modified, or revised in one of the OnBase clients. This way, documents in specific Document Types
are pushed out to specific gateways before the documents are requested by a user.
Gateway Autocaching Configuration

Perform the following steps to configure autocaching for a specific gateway.

Configuration
3. Click Auto Cache. The Auto Cache dialog box is displayed.
4. If necessary, select a Document Type Group to filter the list of Document Types.
5. From the Available list, select the Document Types that should be cached automatically.
• To select multiple Document Types, press CTRL as you click each one.
• To select multiple consecutive Document Types, either click and drag your pointer over them,
or select the first Document Type, and then press SHIFT as you select the last Document
Type.
6. Click Add to move the selected Document Types to the Selected list.
7. Click Close when finished.
Document Type Autocaching Configuration

Perform the following steps to configure autocaching for a specific Document Type:

Configuration
4. Click Auto Cache.

5. Select the gateways where the Document Type should be automatically cached.
• To individually select multiple gateways, press CTRL as you click each one.
• To select multiple consecutive gateways, either click and drag your pointer over them, or
select the first gateway, and then press SHIFT as you select the last gateway.
6. Click Add.
7. Click Close.
Configuring Keyword Rules

Keyword rules allow you to cache uploaded documents to a gateway based on Document Type and
Keyword Values. When a document that satisfies a configured rule is created, modified, or revised,
the document is automatically pushed to the specified gateway for fast retrieval.
Gateway Keyword Rule Configuration

To configure Keyword rules for a specific gateway, see the following topics:
• Creating a Gateway Keyword Rule on page 31
• Editing a Gateway Keyword Rule on page 33
• Deleting a Gateway Keyword Rule on page 33
Creating a Gateway Keyword Rule

To create a rule for a gateway:

Configuration
3. Click Keyword. The Keyword Value dialog box is displayed.
4. Click Create to create a new rule. The Keyword Configuration dialog box is displayed.
Note: The Create button is unavailable if a value is currently selected. Click Clear to clear the
selection and enable the Create button.
5. Select the Document Type to be cached.
6. Select the Keyword Type on which the rule should be based.
7. Type the Keyword Value that must be present on documents you want to cache.
Note: For a document to be cached, the Keyword Value on the document must exactly match the
Keyword Value specified here, including case. If you select a mixed-case Keyword Type, you are
permitted to enter the value in mixed case.

Configuration
Editing a Gateway Keyword Rule

To modify a rule:
1. From the Keyword Value dialog box, select the Keyword rule you want to modify.
2. Click Edit to open the Keyword Configuration dialog box.
3. Modify the values as needed.
4. Click Save.
Deleting a Gateway Keyword Rule

To delete a rule:
1. From the Keyword Value dialog box, select the Keyword rule you want to delete.
2. Click Delete. A confirmation prompt is displayed.
3. Click Yes to confirm the deletion.
Document Type Keyword Rule Configuration

To configure Keyword rules for a specific Document Type, see the following topics:
• Creating a Document Type Keyword Rule on page 33
• Editing a Document Type Keyword Rule on page 35
• Deleting a Document Type Keyword Rule on page 35
Creating a Document Type Keyword Rule

To create a rule for a Document Type:

Configuration
4. Click Keyword. The Keyword Value dialog box is displayed.
5. Click Create to create a new rule. The Keyword Configuration dialog box is displayed.
Note: The Create button is unavailable if a value is currently selected. Click Clear to clear the
current selection and enable the Create button.
6. Select the gateway where the Document Type should be cached.

7. Select the Keyword Type on which the rule should be based.
8. Type the Keyword Value that must be present on documents you want to cache.
Note: For a document to be cached, the Keyword Value on the document must exactly match the
Keyword Value specified here, including case. If you select a mixed-case Keyword Type, you are
able to configure a mixed-case value here.

Configuration
Editing a Document Type Keyword Rule

To modify a rule:
1. From the Keyword Value dialog box, select the Keyword rule you want to modify.
2. Click Edit to open the Keyword Configuration dialog box.
3. Modify the values as needed.
4. Click Save.
Deleting a Document Type Keyword Rule

To delete a rule:
1. From the Keyword Value dialog box, select the Keyword rule you want to delete.
2. Click Delete. A confirmation prompt is displayed.
3. Click Yes to confirm the deletion.
Workflow Configuration
OnBase Studio Workflow configuration provides an action named Add Document to Gateway
Caching Server, which can cache Workflow documents at specific gateways.
Note: The Add Document to Gateway Caching Server action can be configured only using OnBase
Studio; it is not available in OnBase Configuration. For information about configuring life cycles and
actions, see the Workflow module reference guide.
When this action is executed, the document is cached at one or more remote Gateway Caching
Servers, allowing remote users to quickly retrieve the document on demand.
Note: This action is not supported in the Classic OnBase Client interface.
To configure this action, do the following:

1. Select one of the following options to specify a gateway:
• Specify Gateways —Select to cache the document at one or more specific gateways. From
the drop-down provided, select the gateway where the document should be cached. Then,
click Add. Repeat for each gateway as needed.
• Use Mapping Rules Configured for Document Type —Select to cache the document at a
gateway based on the Keyword mapping rules configured for the Document Type.
Rules are configured at the gateway level under Utils | Gateway Caching Server in OnBase
Configuration. To configure rules at the Document Type level, select the Document Type
under Document | Document Types, then click Gateway, and then click Keyword.
• Get Gateways from Property Value —Type the document property value that will specify the
gateway where the document should be cached. The property bag type can be specified on
the Advanced tab.
2. Select one of the following rendition options:
• Default Rendition —Select to cache the default rendition of the document.

Configuration
• Specific Rendition —Select to cache a specific rendition of the document. Select the
appropriate rendition from the corresponding drop-down. Only formats that are able to be
cached are available.
3. Select one of the following revision options:
• Latest Revision —Select to cache only the latest revision of the document.
• All Revisions —Select to cache all revisions of the document.

AppServerGateway 24.1

Uploaded by

Copyright:

Available Formats

AppServerGateway 24.1

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

AppServerGateway 24.1

Uploaded by

Copyright:

Available Formats

Gateway Caching Server

© 2024 Hyland Software, Inc. and its affiliates i

© 2024 Hyland Software, Inc. and its affiliates ii

© 2024 Hyland Software, Inc. and its affiliates iii

© 2024 Hyland Software, Inc. and its affiliates 1

© 2024 Hyland Software, Inc. and its affiliates 2

Supported File Formats

Disk Groups & Caching

© 2024 Hyland Software, Inc. and its affiliates 3

Disk Groups Caching

© 2024 Hyland Software, Inc. and its affiliates 4

Server Hard Drive Configuration

© 2024 Hyland Software, Inc. and its affiliates 6

© 2024 Hyland Software, Inc. and its affiliates 7

2. Click Next. The Destination Folder screen is displayed.

© 2024 Hyland Software, Inc. and its affiliates 8

5. Enter the name of a valid connection string in the field.

© 2024 Hyland Software, Inc. and its affiliates 9

7. Select the IIS settings you want to enable.

Use NT/LDAP Authentication Select to enable Active Directory or LDAP authentication.

© 2024 Hyland Software, Inc. and its affiliates 10

8. Click Next. The OnBase Service Account screen is displayed.

© 2024 Hyland Software, Inc. and its affiliates 11

© 2024 Hyland Software, Inc. and its affiliates 12

13. Click Next. Additional settings are displayed.

© 2024 Hyland Software, Inc. and its affiliates 13

17. Enter the URL to the Application Server's Service.asmx page.

19. Click Install.

Configuring General Web.config Settings

Using the Web Application Management Console

© 2024 Hyland Software, Inc. and its affiliates 14

Web.config Setting Description

cachePath The path to the cache where documents of specific Document

dataSource The name of the ODBC connection configured on the OnBase

gatewayName The name of the gateway as specified in OnBase Configuration. To

© 2024 Hyland Software, Inc. and its affiliates 15

Change, Repair, or Remove an Installation

Change Add or remove components using the Custom Setup dialog.

Remove Removes all previously installed components.

© 2024 Hyland Software, Inc. and its affiliates 16

• Enabling Caching for the Web Client on page 17

Enabling Caching for the Unity Client

Enabling Caching for the Web Client

Controlling the Installer from the Command Line

msiexec /i "[PATH]\Hyland Gateway Caching Server.msi"

msiexec /i "[PATH]\Hyland Gateway Caching Server.msi"

© 2024 Hyland Software, Inc. and its affiliates 17

© 2024 Hyland Software, Inc. and its affiliates 18

For example: DB_SERVICE_PASS = "password"

© 2024 Hyland Software, Inc. and its affiliates 19

For example: IIS_SSL="1"

Request timed out

© 2024 Hyland Software, Inc. and its affiliates 20

© 2024 Hyland Software, Inc. and its affiliates 21

Service Account Configuration

© 2024 Hyland Software, Inc. and its affiliates 23

© 2024 Hyland Software, Inc. and its affiliates 24

Note: Gateway configuration requires the System Configuration configuration right.

© 2024 Hyland Software, Inc. and its affiliates 25