Video

Reference Guide

Includes:

Administration Guide
User Guide

Foundation EP3
Copyright
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 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 its affiliates, 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. or one of its affiliates.
Hyland ® and Hyland Software ®, as well as Hyland 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.
© 2020 Hyland Software, Inc. and its affiliates. All rights reserved.
Document Name ............................................................................................................................. Video
Department/Group.......................................................................................................... Documentation
Revision Number ............................................................................................................Foundation EP3

© 2020 Hyland Software, Inc. and its affiliates ii

 Video
Table of Contents

OVERVIEW
Licensing .....................................................................................................................................................1
Before You Begin ......................................................................................................................................1

ADMINISTRATION GUIDE

CONFIGURATION
Media Provider Configuration ..............................................................................................................3
Creating a Document Type to Integrate with the Hyland Cloud ................................................................ 4
Configuring a Media Library for the Document Type .......................................................................... 6
License Settings ........................................................................................................................................... 7
Unity Management Console Configurations .................................................................................................... 10
Configuration File Modifications....................................................................................................................... 17
Proxy Server Considerations ............................................................................................................................. 17
Unity Client Considerations ............................................................................................................................... 17

USER GUIDE

USAGE
Importing Media Files........................................................................................................................... 19
Importing Media Files From Unity Client .......................................................................................................... 19
Importing Media Files from the Web Client...................................................................................................... 21
Using the Customer Data Export Self Service .................................................................................................. 22
Viewing Media Files .............................................................................................................................. 22
Viewing Media Files from the Unity Client........................................................................................................ 23
Viewing Media Files from the Web Client......................................................................................................... 25

© 2020 Hyland Software, Inc. and its affiliates iii

 O VERVIEW

OnBase Video provides an elevated experience for managing and delivering multimedia
content, creating additional opportunities to incorporate video and audio into critical business
processes, and provide additional visibility to support better decision-making. OnBase Video
provides optimized upload, management and playback of multimedia content, and files are
stored in the Hyland Cloud, eliminating the associated hardware and maintenance
requirements. Automatic transcoding of video assets into a streamable format with multiple
resolutions ensures support for a variety of devices and bandwidths. Utilizing standard OnBase
search and retrieval methods, videos are accessed and directly streamed via the document
viewer in both the Web and Unity Clients, and video quality automatically adjusts to provide the
best viewing experience.

Licensing
The OnBase Video license is required.

Before You Begin

Prior to integrating media files with the Hyland Cloud, you must have the following OnBase
modules installed:
• Application Server . Provides the integration between the user clients and the Hyland
Cloud.
• OnBase Configuration . Provides the ability to configure the media provider and
document type necessary for the integration.
• Unity Scheduler . Windows NT service that performs background upload of media
from the Application Server to the Hyland Cloud.
• Unity Management Console . Provides the ability to configure the background upload
of media performed by the Unity Scheduler.
• Unity Client . Provides the ability to import and view media files.
• Web Server . Provides the ability to import and view media files.

© 2020 Hyland Software, Inc. and its affiliates 1

 Video

Administration Guide

Foundation EP3
 C ONFIGURATION

In the OnBase Configuration tool, you must configure a media provider and a document type to
fully integrate with the Hyland Cloud. To access the configuration dialogs described below, you
must log into the Configuration tool with a user that has "System Configuration" group rights.

Media Provider Configuration

In order for OnBase to work with the Hyland Cloud, you must configure a media provider to the
correct service address.

Note: Before configuring the media provider, you must obtain the service address and
authentication password for the provider. See your system administrator for more information.

To configure the media provider:

1. Open the OnBase Configuration tool.
2. From the Utils menu, select Media Services | Media Provider . The Media Provider
Configuration dialog box is displayed.

3. In the field on the bottom of the box, type a name for your server.

© 2020 Hyland Software, Inc. and its affiliates 3

 Video
Configuration

4. Click Create . The Media Provider Settings dialog box is displayed.

The information provided in this dialog box is used to authenticate the calls that the
application server makes to the Hyland Cloud.
5. In the Authentication Name field, enter the Hyland Cloud authentication name.

Note: If the Save button is not activated, you may need to enter a value in the Authentication
Name field.

6. In the Authentication Password field, enter the Hyland Cloud authentication password.
7. In the Service Address field, type the address for the Hyland Cloud.
8. Click Save .

Creating a Document Type to Integrate with the Hyland Cloud

You must create a document type in OnBase Configuration that is configured to use the media
stream file format, and that points to the Hyland Cloud media provider.

© 2020 Hyland Software, Inc. and its affiliates 4

 Video
Configuration

To set a document type for media in the OnBase Configuration tool:

1. Open the OnBase Configuration tool.
2. From the Document menu, select Document Types. The Document Types dialog box is
displayed.

3. In the field at the bottom of the box, type a name for your new document type.

© 2020 Hyland Software, Inc. and its affiliates 5

 Video
Configuration

4. Click Create . The configuration dialog box for your new document type is displayed.

5. From the Document Type Group drop-down list, select a group used to categorize the
document type.
6. From the Default File Format drop-down list, select Media Stream . This value is
important in order to ensure that the Viewer in either Unity Client or Web Client knows to
request a stream to play from the Hyland Cloud.
7. From the Default Disk Group , select a disk group to which to associate the document
type.
8. When all the options are set, click Save .

Configuring a Media Library for the Document Type

To complete the configuration for the document type, you must associate it with the Hyland
Cloud library where the media will be stored.

Note: The library name is case-sensitive and must match the original library name created in
the Hyland Cloud.

© 2020 Hyland Software, Inc. and its affiliates 6

 Video
Configuration

To configure a media library:

1. From the Document Types dialog box, select the document type you created from the
Document Type list.
2. Click the Media Library button. The Media Library Configuration for <Document Type
Name> dialog box is displayed.

3. From the Media Provider drop-down list, select the media provider you created in the
Media Provider Configuration on page 3 section.
4. From the Media Library drop-down list, select or type the name of the Hyland Cloud
library that will be associated with this document type.
5. Click Save .

License Settings
Before you can integrate with the Hyland Cloud, you must ensure that the Video database/
institution license is enabled. When you enable this option, you are able to use the features
offered by the Hyland Cloud.

© 2020 Hyland Software, Inc. and its affiliates 7

 Video
Configuration

To enable the Video database/institution license:

1. Open the OnBase Configuration tool.
2. From the Utils menu, select Licensing | Product Licenses . The Product Licenses dialog
box is displayed.

3. Select the Database/Institution Licenses tab.

© 2020 Hyland Software, Inc. and its affiliates 8

 Video
Configuration

4. Scroll down to the OnBase Video license.

5. Click License Product . A dialog box is displayed asking for a call back code.

Note: The call back code must be obtained from technical support.

6. Enter the code in the Call Back Code field.

© 2020 Hyland Software, Inc. and its affiliates 9

 Video
Configuration

7. Select one of the following options in the Mode section:

•Licensed Software . Select this option if you have a license for the software.
•Pilot Use (Number of Days) . Select this option only if you do not have a license for
the software. You can select the number of days to use the pilot version. When you
select this option, the Generate Pilot License Code button is activated. Select this
button to create a code that will automatically populate the Update Code field. You
will still need to acquire the call back code from technical support to complete the
process.
8. Click Save . The OnBase Video database/institution license has been enabled.

Unity Management Console Configurations

The Unity Management Console provides the ability to setup scheduled tasks for an upload.

© 2020 Hyland Software, Inc. and its affiliates 10

 Video
Configuration

To configure the Unity Management Console:

1. Login to the Unity Management Console.
2. Click Create Task .

3. The Task Wizard is displayed.

© 2020 Hyland Software, Inc. and its affiliates 11

 Video
Configuration

4. In the Name field, enter a name for the task.

5. Click Next . The Task Wizard is displayed allowing you to choose the type of task to
create.

6. From the drop-down list, select Media Upload .

© 2020 Hyland Software, Inc. and its affiliates 12

 Video
Configuration

7. Click Next . The Task Wizard screen is displayed allowing you to select the user group
that should have access to the task.

8. From the User Groups drop-down list. select the user to which you want to allow access
to the task and click Add . The user is added to the Name box.

Add as many users as needed.

© 2020 Hyland Software, Inc. and its affiliates 13

 Video
Configuration

9. Click Next . The Task Wizard screen is displayed allowing you to schedule when the task
should be executed.

10. Click Add to select a time frame when this task should be executed.

© 2020 Hyland Software, Inc. and its affiliates 14

 Video
Configuration

11. Select an option from the list. A dialog box is displayed allowing you to determine how
often the task should be executed. For our purposes, the Interval option has been
selected.

12. Configure the option you selected and click OK . The option you configured is displayed
in the Task Wizard.

© 2020 Hyland Software, Inc. and its affiliates 15

 Video
Configuration

13. Click Next . One of the following is displayed:

• If you selected the Interval option, a dialog box is displayed allowing you to select the
times the interval should be active.

Select the options to indicate how often the interval schedules should be active.
• If you selected any other option, a dialog box is displayed allowing you to indicate
when the task should start and expire.

Select the options to indicate when to start and stop the task.

© 2020 Hyland Software, Inc. and its affiliates 16

 Video
Configuration

14. Click Next . A summary of the action you created is displayed.

15. Click Finish to compete the configuration.

Configuration File Modifications

In order to allow large files to be uploaded, modifications must be made to the Web.config files
for both the Web Client and Application Server. These modifications must be made if files
being uploaded are expected to exceed 30MB.
The following changes in the Web.config file must be made to allow large files to be uploaded:
• maxRequestLength . Increase this value to at least 4096000.
• executionTimeout . Increase this value to at least 7200.

Proxy Server Considerations

If a proxy server is used at the site, both api.twistage.com and api2.twistage.com may need to
be listed as trusted sites.

Unity Client Considerations

When multiple media items are selected for Send To File , deselect the Apply Settings to
Subsequent Documents check box. Select the Next Document button to move from one
document to the next.

© 2020 Hyland Software, Inc. and its affiliates 17

 Video

User Guide

Foundation EP3
 U SAGE

Importing Media Files

Media files can be imported using either the OnBase Unity Client or the OnBase Web Client.
When a media upload task is enabled, videos are uploaded as scheduled, not in real-time.

Importing Media Files From Unity Client

To import media files using Unity Client:
1. Open the Unity Client.
2. Select the Import option.
3. Click Browse to browse to the media file you want to import.
4. Select the media file you want to import from the Open screen.
5. Click Open . A preview of the media file is displayed in the Unity Client.

© 2020 Hyland Software, Inc. and its affiliates 19

 Video
Usage

6. From the Import pane, select the document type from the Document Type drop-down
list that has been configured to work with the Hyland Cloud.
7. If the file type does not default to the type of file for the media, select the correct type
from the File Type drop-down list.
8. Click Import . The video is imported and can be viewed from the Unity Client using the
Viewer from the Hyland Cloud.

Note: If the upload has not yet completed, a message is displayed in the Viewer indicating that
the media upload is in progress.

© 2020 Hyland Software, Inc. and its affiliates 20

 Video
Usage

Importing Media Files from the Web Client

To import files using the Web Client:
1. From your web browser, login to the Web Client.
2. From the Document Retrieval menu, select Import Document .

The Import Document pane is displayed.

© 2020 Hyland Software, Inc. and its affiliates 21

 Video
Usage

3. Select the following options from the Import Document pane:

• From the Select File field, click Browse to select the media file to import.
• From the Document Type Groups drop-down list, select the document group to which
your document type belongs.
• From the Document Types drop-down list. select the document type that has been
configured for use with the Hyland Cloud. The File Type field automatically defaults
to Media Stream.
4. Click Import . The document is imported into Web Client.

Using the Customer Data Export Self Service

If you want to export one or multiple video files:
1. From the Unity Client or Web Client, right-click the video file from the Documents Search
Results pane.
2. Select Send To > File .

To export several files, you must contact Technical Support for assistance.

Viewing Media Files

Once the files have been imported into either the Unity Client or the Web Client, they can be
viewed within the Hyland Cloud.

© 2020 Hyland Software, Inc. and its affiliates 22

 Video
Usage

Viewing Media Files from the Unity Client

To view media files in Unity Client:
1. Open the Unity Client.
2. Select the Retrieval option.
3. Do one of the following to search for documents:
• From the Document Types and Groups section, select a document group to narrow
your search, and then choose the document type you want.
• Scroll through the list of document types and select the document type you want.
4. Click Find . The documents that match the search are displayed.

5. Do one of the following to select a media file to view:

• Double-click the document from the Documents list.

Note: If the upload has not yet completed, a message is displayed in the Viewer indicating that
the media upload is in progress. Press F5 to update the message with the percentage
completed from the media server.

• View thumbnails of the documents and choose the document you want to view.
Right-click the document you want to view (select multiple documents by holding
down the CTRL key and selecting the documents you want to view), and select Open
in Thumbnail Viewer .

© 2020 Hyland Software, Inc. and its affiliates 23

 Video
Usage

When viewing the media file in the Viewer, a control bar is available allowing you to play, pause
and stop the video.

The control bar is visible for approximately two seconds, and then it is hidden. To view the
control bar after it has been hidden, move your mouse over the video to display it for another
two seconds. If you pause a video, the control bar remains on the screen until the video is
played.

Note: If you click or drag the control bar while the video is playing, the video is paused and
remains paused until the Play button is selected.

You can use the following keys on your keyboard to manage the control bar:
• Spacebar or Enter : Pressing this key pauses the video. Once paused, press this key
again to play continue playing the video.
• Up/Down Arrows : Advances (Up arrow) or reverses (Down arrow) the video by five
seconds.
• Left/Right Arrows : Increases (Right arrow) or decreases (Left arrow) the volume.
• M key : Mutes or unmutes the video.
• Number keys . Pressing the number keys (0 - 9) advances or reverses the video
depending on what percentage of the video has played. For example, 0 moves the
video to the beginning, 1 moves the video to 10%, 5 moves the video to 50%, 9 moves
the video to 90%, etc.

© 2020 Hyland Software, Inc. and its affiliates 24

 Video
Usage

Viewing Media Files from the Web Client

To view media files in Web Client:
1. From your web browser, login to the Web Client.
2. From the Document Retrieval menu, select Document Retrieval .

The Document Retrieval pane is displayed.

© 2020 Hyland Software, Inc. and its affiliates 25

 Video
Usage

3. From the Document Types section, select the Document Type Group to which the
Hyland Cloud document type belongs, and then select the document type.

4. Click Search . A list of documents is displayed in the Document Search Results list.

5. Double-click the document from the Document Search Results list to view the media file
in the Viewer:

© 2020 Hyland Software, Inc. and its affiliates 26

 Video
Usage

When viewing the media file in the Viewer, a control bar is available allowing you to play, pause
and stop the video.

The control bar is visible for approximately two seconds, and then it is hidden. To view the
control bar after it has been hidden, move your mouse over the video to display it for another
two seconds. If you pause a video, the control bar remains on the screen until the video is
played.

Note: If you click or drag the control bar while the video is playing, the video is paused and
remains paused until the Play button is selected.

You can use the following keys on your keyboard to manage the control bar:
• Spacebar or Enter : Pressing this key pauses the video. Once paused, press this key
again to play continue playing the video.
• Up/Down Arrows : Advances (Up arrow) or reverses (Down arrow) the video by five
seconds.
• Left/Right Arrows : Increases (Right arrow) or decreases (Left arrow) the volume.
• M key : Mutes or unmutes the video.
• Number keys . Pressing the number keys (0 - 9) advances or reverses the video
depending on what percentage of the video has played. For example, 0 moves the
video to the beginning, 1 moves the video to 10%, 5 moves the video to 50%, 9 moves
the video to 90%, etc.

© 2020 Hyland Software, Inc. and its affiliates 27