Quick Reference Guides

Unity Client

Platform: OnBase
Product: Unity Client
Release: Foundation 23.1
License: Premier; Standard; Essential

Documentation Notice
Overview
Introduction
Exclusive Features
Applications
Licensing
Simplified Licensing
Legacy Licensing
Definitions
Annotations
AutoFill Keyword Set
AutoFill Keyword Set Instance
Cascading Data Sets
Cross-Reference
HTML-Based Documents
Custom Queries
Document
Document Handle
Document Type
Document Type Group
Envelope
External Text Search
File Cabinet
Dynamic Folder
Static Folder
Image Documents
Internal Text Search
Keyword Data Sets
Keyword Types and Keyword Values
Keyword Types
Keyword Values
Keyword Type Groups
Multi-Instance Keyword Type Groups
Keyword Type Masking
Note
OLE Documents
Overlay
Staples
Text Documents
User
User Group
Installation
Requirements
General Requirements
HTTPS Automation Requirements
Hyland Software - Microsoft Windows Updates
Windows 10 Updates
Digital Input Device Compatibility
Third-Party Software Requirements
Licensing
Upgrade Considerations
General User Interface Redesign
Server Machine Considerations
End-User Workstation Considerations
ClickOnce Deployment Considerations
General Deployment Considerations
Installation Overview
Installer Prerequisites
Installer User Permissions
Installation Using the MSI Installer
Running the Installer
Change, Repair, or Remove an Installation
Running the Installer from the Command Line
Feature Names
Properties
Post-Installation
AD FS Configuration
HTTPS Automation
Installation Using ClickOnce
ClickOnce Deployment
Web Server Installation Steps
From a Shared Folder Installation Steps
Manually Created Share Steps
Unity Features
Service Location and Deployment Configuration
Before Signing the Deployment
AD FS Configuration
HTTPS Automation
Deployment Signing
Updating or Adding a Deployment Instance
Web Server Add or Update Steps
From a Shared Folder Add or Update Steps
Service Location and Deployment Configuration
Automatically Launching a Deployed Application at System Startup
Removing a Deployed Application
Removing a Deployed Application Instance from Client Workstations
Removing a Deployed Application Instance from the Deployment Server
Completely Removing a Deployed Application
Manual Installation
Running Multiple Instances of the Unity Client
Backup/Recovery
Window Settings
Frequently Asked Questions
Troubleshooting
Cannot Start Application
Common Display Issues
Unexpected Visual Behavior When Using Custom Scaling
Common External Email Issues
The Body of a Notification is Blank
Exception Has Been Thrown by the Target of an Invocation
One or More of the Selected Documents Could Not Be Sent
Unity Pop File Is Not Valid for the System
You Do Not Have Privileges to View This Document
Open or Save an EML Document
Page Could Not Be Displayed
Common Issues When Logging In
Microsoft SQL Server Compact Edition (CE)
Initialization Error
Windows Security Prompt
Common Scanning Issues
Common Issues When Working with Documents
There Was an Error Opening This File
Attempt to Access Invalid Address
Exception Has Been Thrown by the Target of an Invocation
Unity Client Becomes Unresponsive When Scrolling
Microsoft Word Documents Open Outside the Unity Client
E-Forms Do Not Work Inside the Unity Client
Unable to Print Documents
Microsoft Office Documents Not Displaying Correctly in the Document Viewer
WebView2 Runtime is Not Installed
Slowness After Using the Notes Gallery
Slow Performance or High CPU Usage on the Application Server
Notes, Redactions, Burned Markups, and Deficiencies on Documents with Overlays
Contacting Support
Configuration
Custom Query Configuration
Grouping Columns
Filtering Columns
Document Retrieval
Document Retrieval Threshold
DocumentQueryWarningThreshold
DocumentQueryLimit
Configuring Google Services
Creating a Google API Project in the Google Developers Console
Enabling Google Services
Configuring Gmail
The Integrated Office Viewer Integration
The Unity Client Configuration File
AD FS Configuration
Embedded WebView2-Compatible Browser Configuration
Enabling Dev Tools
Hyland.Canvas.Client
Trusted Certificates
ServiceLocations
appSettings
Hyland.Canvas
DisplayLanguage
Culture
Application
DefaultHomeLayout
UserGroupTimeoutMode
Hyland.Canvas.Automation.Services
Application Enabler
HTTPS Automation
Workflow
Configuring Unity Pop
Configuring Unity Pop Links
Configuring Unity Pop Files
Client Administration
Introduction
Managing Locks
Document Locks
Keyword Locking
Disk Group Locks
Process Locks
User Administration
Required Administrative Rights
User Administration Overview
Users Tab
Creating Users
Editing Users
Resetting User Passwords
Locking and Unlocking Users
Deleting Users
Changing User Group Assignments
Assigning Security Keywords to Users
User Option Policy Administration
Adding a User Option Policy
Viewing the Resultant Set of User Options
Changing a User Option Policy
Changing the Name and Description of a User Option Policy
Changing the Configured User Options of a User Option Policy
Changing the Assigned User Group of a User Option Policy
Changing the Priority of a User Option Policy
Deleting a User Option Policy
Personal Page Tile Group Administration
Creating a Tile Group
Renaming a Tile Group
Deleting a Tile Group
Assigning a Tile Group to a User Group
Adding Tiles to Tile Groups
Adding Documents, Folders, and Individual Items to Tile Groups
Adding a Layout to Tile Groups
Adding Custom Query Results to Tile Groups
Adding Import Tiles with Specified Document Types to Tile Groups
Managing and Configuring Tiles in Tile Groups
Custom Query Results Tiles
Removing Tiles from a Tile Group
Troubleshooting Layout
Troubleshooting Messages
Creating Bug Reports
Using the Request Profile Diagram
Best Practices
Best Practices Overview
DocPop and Unity Pop
Network Connectivity
Document Retrieval
Dates
Drop-Down Lists
Wildcards
Importing
Text Documents
Indexing
Multi-Instance Keyword Type Groups
Usage
General Functionality
Opening the Unity Client
Logging In
Session Interruption
Session Timeout
Authentication Required
Change Password
The Unity Client Window
Home Tab
Home Layout
Web Sites
RSS Ticker
File Menu
Accessing Keyboard Shortcuts
Favorites
Using Your Home Page
Setting Your Home Page
Resetting Your Home Page
Using Your Favorites
Adding a Favorite
Opening a Favorite
Managing Your Favorites
Renaming Favorites
Deleting Favorites
Personal Page
Using Your Personal Page
Administrative Tiles
Editing Administrator Suggested Tiles
Adding Items to Your Personal Page
Adding Layouts to Your Personal Page
Adding Custom Queries to Your Personal Page
Adding Documents to Your Personal Page
Adding Import Tiles with Specified Document Types to Your Personal Page
Adding WorkView Filters and Objects to Your Personal Page
Opening a Layout or an Item from the Personal Page
Managing and Configuring Personal Page Tiles
Removing Personal Page Tiles
Panes
Data Lists
Selecting Multiple Items
Reordering and Stacking Columns
Grouping
Sorting
Filtering
Operators
Drop-Down Lists
Custom Filter Selection
User Options
Overview
General
Document
Document Import
Local Data
Printing
Retrieval Date Options
Service Mode
Document Retrieval
Retrieving Documents by Document Type Group
Retrieving Documents by Document Type
Retrieval Using Custom Queries
Conducting a Custom Query
Conducting Multiple Custom Queries
Viewing Folder Custom Query Results
Filtering Custom Query Results
Document Retrieval by Keyword Value
Document Search Results List
Viewing Documents
Thumbnail Viewer
Document Retrieval by Document Date
Date Range Parameters and Corresponding Results
Document Retrieval Using Note Search
Document Retrieval Using External Text Search
Viewing Recent Query History
Document Retrieval by Document Handle
Document Retrieval by Trash Can
Working with Deleted Documents
Keyword Types Relationship Examples in Document Retrieval
Cascading Data Set
Multi-Instance Keyword Type Group
Working with Documents
Document Viewer
Document Tab
The Notes Gallery
Notes
Annotations
Redacting Documents Using Redaction Annotations
Creating a Redaction
Viewing Redactions
Redacting Documents Using Bitmap Redactions
Navigating in the Bitmap Redaction Tab
Applying a Redaction Bitmap
Deleting a Redaction Bitmap
Working with Notes in the Document Viewer
Viewing Notes
Showing and Hiding Notes
Moving Notes
Deleting Notes
Setting Note Privacy Options
Working with Notes in the Task Pane
Viewing and Editing Notes
Deleting a Note
Setting Note Privacy Options
Viewer Options
Google Services Integration Viewer
Integrated Office Viewer
Opening Documents in an Alternate Viewer
View in Native Format
Staples
Stapling Open Documents from the Information Bar
Stapling Documents from a Document Search Results List
Viewing Stapled Documents
Moving Staples
Editing Staple Notes
Deleting Staples
Image Tab
Document Thumbnails
Text Tab
Internal Text Search
Generating Text Search Reports
Limiting Searches Using Internal Text Search Settings
Overlays
Apply an Overlay to a Document
Remove an Overlay from a Document
Media Tab
Retrieving Cross-Referenced Documents
From a Document Search Results List
From Image or Text-Based Documents
From E-Forms, HTML Documents, or OLE Documents
Access Document History
Document History
Access Document Properties
Document Properties
Generating a CSV File
Saving Documents to Files
Deleting Documents
Creating a Document
Creating a New Document from an Existing Document
Executing a Unity Script
Working with Keywords
Access the Keyword Values of a Document
Add / Modify Keywords
Read-Only Keywords
Mixed Case Keywords
Searching on Mixed Case Keyword Values
With Case Sensitive Searching Applied
Without Case Sensitive Searching Applied
Indexing Mixed Case Keyword Values
Masked Keywords
AutoFill Keyword Set Instance
Using AutoFill Keyword Sets When Indexing or Re-Indexing
Indexing with AutoFill Keyword Sets
Re-Indexing with AutoFill Keyword Sets
Using a Reverse AutoFill Keyword Set Lookup
Use Keywords for Document Retrieval
Keyword Types that Contain Relationships
Cascading Data Sets
Multi-Instance Keyword Type Groups
Common Keyword Types for Document Type Groups and Multiple Document Types
Add Another Value to a Keyword
Multi-Instance Keyword Type Groups
Keywords with Drop-Down Lists
Keyword Operators and Extended Search Features
Relational (Comparative) Operators
Logical Boolean Operators
Wildcard Characters
Adding Multiple Values to a Keyword Type
Re-Indexing
Re-Indexing Documents
Keywords with Drop-Down Lists
Re-Indexing Document Revisions
Considerations for Re-Indexing Documents and Adding or Modifying Keyword Values
Separating Image and PDF Documents
The Separation Workspace
Document Display Mode
Page Display Mode
Tree Display Mode
Adjusting Thumbnails in the Separation Workspace
Selecting Documents in the Separation Workspace
Selecting Documents in Document Display Mode
Selecting Documents in Page Display Mode
Reordering Documents in the Separation Workspace
Using the Page Holder
Working with Locked and Read-Only Documents in the Separation Workspace
Saving Documents
Viewing and Editing Page Details in Document Separation
Creating and Editing Documents in the Separation Workspace
Adding New Pages to the Separation Workspace
Adding Pages by Browsing
Adding Pages by Acquiring
Clicking and Dragging Pages in the Separation Workspace
Clicking and Dragging Pages in Document Display Mode
Clicking and Dragging Pages in Page Display Mode
Joining Documents in the Separation Workspace
Merge Documents
Join Pages
Append After Page
Splitting Documents in the Separation Workspace
Split
Using the Break into Documents Option
Copying Pages and Documents in the Separation Workspace
Copy Document
Copy Pages to New Document
Copy Pages in Place
Deleting Documents or Pages in the Separation Workspace
Undoing and Redoing Actions in the Separation Workspace
Importing a New Document in the Separation Workspace
Adding or Modifying Keywords on a Source Document in the Separation Workspace
Working with Comments on Revisable Documents in the Separation Workspace
Working with Comments in Document Display Mode
Working with Comments in Page Display Mode
Keyboard Shortcuts for the Separation Workspace
Folders
Folder Definition
Folder Hierarchy
Folder Contents
Static Folder
Dynamic Folder
Auto-Foldering
Opening File Cabinets and Folders
Moving Up a Level from a Folder Tab
Scrolling Through Folder Tabs
Accessing Folder Search by Clicking a Folder
Working with Folder Pop-up Lists
Retrieving Related Folders
Searching for Folders
Show Folder Locations
Keyword Considerations for Show Folder Locations
Applying Folder Filters
Applying a Folder Template
Adding, Uploading, and Removing Documents
Adding Documents to Dynamic Folders
Adding Documents to Static Folders
Clicking and Dragging Documents into a Folder
Sending Documents to a Folder
Moving Documents Between Folders
Copying Documents to Another Folder
If You Cannot Add a Document to a Folder
Uploading and Indexing Documents Using Folders
Removing Documents from Folders
Adding and Deleting Folders
Adding a Folder
Deleting a Folder
Changing Folder Keyword Values
Modifying Keyword Values on a Folder, Child Folders, and Documents
Modifying Multi-Instance Keyword Type Groups
Example 1: Content uses the same Multi-Instance Keyword Type Group as its folder
Example 2: Content uses a Multi-Instance Keyword Type Group that contains a Keyword Type used by its folder
Example 3: Content uses a Keyword Type that is contained in a Multi-Instance Keyword Type Group used by its folder
Working with Folder Notes
Folder Notes Requirements
Viewing and Sorting Folder Notes and Bookmarks
Adding a Folder Note or Bookmark
Viewing a Bookmarked Document
Editing an Existing Note or Bookmark
Deleting a Note or Bookmark
Folder Properties
Viewing the History of a Folder
Sending and Receiving Mail
Send To | Internal User
Sending OnBase Documents to Other OnBase Users
Checking Internal Mail
Viewing Internal Mail
Emailing Documents and Links to Documents
Attachment Display Considerations
Sending Folders as Unity Pop Links and Unity Pop Files
Using the Mail Message Dialog Box
Checking Names and Addresses
Viewing Unity Pop Files and Links
Using Envelopes
Envelope
Creating and Deleting Envelopes
Creating a New Envelope
Deleting an Envelope
Sharing an Envelope
Adding or Removing Documents from Envelopes
Adding Documents to Envelopes
Removing Documents from Envelopes
Opening Existing Envelopes
Importing Documents
Importing Documents by Browsing
Importing Documents by Acquiring
Importing Documents from Google Drive
Importing Documents from Third-Party Google Applications
Importing Documents by Dragging and Dropping
Completing the Import Process
Multi-Page TIFF Images
Appending Pages to an Existing Document
Printing
Printing Documents
File Format not Supported for Printing
Reports
Creating List Reports
Document Search Results Lists and Batch Queues
Quick Reference Guides
Quick Reference Guides Overview
Keyboard Shortcuts
Global
Main Window
Data Lists
Keywords
Re-Indexing
Import Layout
Document Viewer
Document Separation
General Usage
Access the End-User Help Files
Set Your Home Page
Add Favorites
Use the Personal Page
Document Retrieval
Import Documents
Document Separation
Envelopes
User Options
Generate CSV Files
Send Mail
Document List Organization

Back to home page