Sunteți pe pagina 1din 306

OpenText™ Media Management

Administration Guide

Administering OpenText Media Management (OTMM)


involves starting and stopping the OTMM software, configuring
local and global software settings, administering OTMM users,
configuring security privileges, and administering and
maintaining the OTMM databases. These topics are covered in
depth in this document.

MEDMGT160300-AGD-EN-02
OpenText™ Media Management
Administration Guide
MEDMGT160300-AGD-EN-02
Rev.: 2017-Oct-30
This documentation has been created for software version 16.3.
It is also valid for subsequent software versions as long as no new document version is shipped with the product or is
published at https://knowledge.opentext.com.

Open Text Corporation

275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1

Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com

Copyright © 2017 Open Text. All Rights Reserved.


Trademarks owned by Open Text.

Disclaimer

No Warranties and Limitation of Liability

Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
Part 1 Administering OpenText™ Media Management 13

1 Introduction .............................................................................. 15
1.1 Conventions in this guide ................................................................. 15
1.1.1 Legacy product names .................................................................... 15
1.1.2 Nomenclature ................................................................................. 15
1.2 Directory structure and contents ....................................................... 16
1.2.1 Media Management directories ........................................................ 16
1.2.2 Data directories ............................................................................... 18
1.2.3 Repository directories ...................................................................... 22
1.2.3.1 Media Management Repository Directories ....................................... 22

2 Web Administration tool ......................................................... 25


2.1 Signing in and out ........................................................................... 25
2.1.1 Signing in to the Web Administration tool .......................................... 25
2.1.2 Signing out of the Web Administration tool ........................................ 25
2.2 The Web Administration tool interface .............................................. 25
2.2.1 Configuring Internet Explorer to refresh pages correctly ..................... 27
2.2.2 Role-based access to Web Administration tool functionality ............... 28
2.3 Metadata ........................................................................................ 28
2.3.1 Metadata properties ........................................................................ 28
2.3.1.1 Metadata for participants ................................................................. 30
2.3.1.2 Microsoft SQL Server syntax ............................................................ 30
2.3.1.3 External Metadata ........................................................................... 30
2.3.1.3.1 Limitations ...................................................................................... 31
2.3.2 Metadata Editor .............................................................................. 31
2.3.2.1 Models ........................................................................................... 33
2.3.2.1.1 Field groups for layout files .............................................................. 34
2.3.2.2 Creating and editing field groups ...................................................... 35
2.3.2.3 Creating and editing metadata fields ................................................. 36
2.3.2.3.1 Field_Restrictions table ................................................................... 39
2.3.2.3.2 Metadata field limitations ................................................................. 41
2.3.2.4 Tabular field groups ........................................................................ 41
2.3.2.5 Lookup Domains ............................................................................. 43
2.3.2.6 Cascading Groups .......................................................................... 44
2.3.3 Importing metadata configurations .................................................... 46
2.3.4 Exporting metadata configurations ................................................... 46
2.3.5 Custom Table Editor ........................................................................ 46
2.3.5.1 Metadata tables .............................................................................. 46
2.3.5.2 Tabular Metadata tables .................................................................. 47

OpenText Media Management – Administration Guide iii


MEDMGT160300-AGD-EN-02
Table of Contents

2.3.5.3 Lookup Domain Tables .................................................................... 48


2.3.5.4 Cascading Mapping Tables .............................................................. 49
2.3.6 Metadata language ......................................................................... 50
2.3.7 Using the Metadata Editor in an HA environment .............................. 51
2.4 Security .......................................................................................... 51
2.4.1 Creating a security policy ................................................................. 51
2.4.2 Managing security policies ............................................................... 52
2.4.3 Managing roles ............................................................................... 53
2.4.4 Function Enablement Tokens ........................................................... 55
2.5 Users ............................................................................................. 55
2.5.1 User Groups ................................................................................... 55
2.5.1.1 Creating a User Group .................................................................... 55
2.5.1.2 Navigating existing User Groups ...................................................... 56
2.5.1.3 Adding and removing users within User Groups ................................ 57
2.5.1.4 Adding and removing administrators within User Groups ................... 58
2.5.1.5 Applying restricted field access within User Groups ........................... 59
2.5.1.6 Deleting a User Group ..................................................................... 59
2.5.1.7 Synchronizing user group memberships from OTDS using Push
Connector ....................................................................................... 60
2.5.1.8 Applying branding ........................................................................... 61
2.5.2 Users ............................................................................................. 61
2.5.2.1 Creating users ................................................................................ 62
2.5.2.2 Viewing user account information ..................................................... 62
2.5.2.2.1 Viewing the summary of user accounts ............................................. 62
2.5.2.2.2 Viewing account information by user ................................................ 63
2.5.2.3 Editing users ................................................................................... 65
2.5.2.4 Deleting users ................................................................................. 66
2.5.2.5 Case sensitivity for sign-in names .................................................... 66
2.5.3 Current Users Report ...................................................................... 67
2.5.3.1 Refreshing current users ................................................................. 68
2.6 Templates ...................................................................................... 68
2.6.1 Folder Types .................................................................................. 68
2.6.1.1 Adding folder types ......................................................................... 69
2.6.1.2 Managing folder types ..................................................................... 71
2.6.2 Property Templates (Metadata Profiles) ............................................ 73
2.6.2.1 Creating Property Templates ........................................................... 73
2.6.2.1.1 Cascading list limitations for new Property Templates ........................ 74
2.6.2.2 Editing a Property Template ............................................................. 74
2.6.2.3 Duplicating a Property Template ...................................................... 75
2.6.3 Preference Templates ..................................................................... 75
2.6.3.1 Creating a Preferences Template ..................................................... 76
2.6.3.2 Managing Preference Templates ...................................................... 76

iv OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
Table of Contents

2.6.4 Advanced Search configurations ...................................................... 77


2.6.4.1 Creating a new search configuration ................................................. 77
2.6.4.2 Managing search configurations ....................................................... 80
2.7 Utilities ........................................................................................... 82
2.7.1 Recycle Bin .................................................................................... 82
2.7.1.1 Purging individual deleted assets ..................................................... 84
2.7.1.2 Bulk Purge utility ............................................................................. 84
2.7.1.3 Undeleting assets ........................................................................... 84
2.7.2 Releasing locks ............................................................................... 85
2.7.2.1 Releasing locked assets .................................................................. 86
2.7.2.2 Refreshing locked assets ................................................................. 86
2.7.3 Clearing caches .............................................................................. 87
2.7.4 Regenerating Tasset file .................................................................. 87
2.7.5 Resubmitting a failed audio or video import job ................................. 87
2.8 Required field behavior .................................................................... 88
2.9 YouTube ........................................................................................ 88
2.9.1 Setting up authorization for the YouTube Data API ............................ 89
2.9.2 Mapping a YouTube channel to a delivery template ........................... 90
2.9.3 Deleting a YouTube mapping ........................................................... 91
2.10 Configurations ................................................................................ 91
2.10.1 Transformers .................................................................................. 91
2.10.1.1 Managing transformers .................................................................... 91
2.10.1.2 Adding custom transformers ............................................................ 92
2.10.1.3 Deleting a custom transformer ......................................................... 95
2.10.2 Content Types ................................................................................ 96
2.10.2.1 Managing content types ................................................................... 96
2.10.2.2 Adding content types ....................................................................... 97
2.10.2.3 Editing content types ....................................................................... 97
2.10.2.4 Deleting content types ..................................................................... 98
2.10.3 Mime Types .................................................................................... 98
2.10.3.1 Managing mime types ..................................................................... 98
2.10.3.2 Adding mime types .......................................................................... 99
2.10.3.3 Editing mime types .......................................................................... 99
2.10.3.4 Deleting mime types ...................................................................... 100
2.10.4 Interval profiles ............................................................................. 100
2.10.4.1 Creating interval profiles ................................................................ 100
2.10.4.2 Managing interval profile configurations .......................................... 103
2.10.5 Facet ............................................................................................ 106
2.10.5.1 Creating a facet configuration ........................................................ 107
2.10.5.2 Managing facet configurations ....................................................... 111
2.10.6 Brand ........................................................................................... 115
2.11 Media Analysis .............................................................................. 115

OpenText Media Management – Administration Guide v


MEDMGT160300-AGD-EN-02
Table of Contents

2.11.1 Adding a schedule ......................................................................... 116


2.11.2 Editing a schedule ......................................................................... 117
2.11.3 Deleting a schedule ....................................................................... 118
2.12 Analytics ....................................................................................... 118
2.12.1 Configuring the iHub user sign-in credentials .................................. 119
2.12.2 Configuring Analytics ..................................................................... 119
2.12.3 Modifying the Analytics events list .................................................. 121
2.12.4 Adding metadata fields .................................................................. 122
2.12.5 Changing the tenant ID .................................................................. 122
2.12.6 Running the Seed Agent utility ....................................................... 123
2.13 Storage Management .................................................................... 124
2.13.1 Administering storage management ............................................... 124
2.13.2 Adding a content manager ............................................................. 125
2.13.3 Duplicating a content manager ....................................................... 127
2.13.4 Editing a content manager ............................................................. 127
2.13.5 Deleting a content manager ........................................................... 128
2.13.6 Defining business rules ................................................................. 128
2.13.6.1 Adding a business rule .................................................................. 129
2.13.6.2 Editing a business rule .................................................................. 130
2.13.6.3 Deleting a business rule ................................................................ 130
2.14 Settings ........................................................................................ 130
2.14.1 Administering configuration groups ................................................. 131
2.14.1.1 Adding a configuration group ......................................................... 134
2.14.1.2 Viewing a configuration group ........................................................ 134
2.14.1.3 Editing a configuration group .......................................................... 134
2.14.1.4 Deleting a custom configuration group ............................................ 135
2.14.2 Configuring components ................................................................ 135
2.14.2.1 Adding a component and properties ............................................... 135
2.14.2.2 Viewing a component and properties .............................................. 136
2.14.2.3 Editing a component and properties ............................................... 136
2.14.2.4 Deleting a custom component and its properties ............................. 137

3 Performing operations tasks ................................................ 139


3.1 Starting OTMM ............................................................................. 140
3.1.1 Starting Media Management as a Windows service ......................... 140
3.1.2 Starting Media Management on Linux ............................................. 140
3.1.3 Starting the OpenText Indexer as a service ..................................... 141
3.1.4 Starting OTDS as a Windows service ............................................. 141
3.1.5 Signing in to the Media Management user interface ......................... 142
3.2 Localizing notifications ................................................................... 142
3.2.1 To localize notifications ................................................................. 142
3.3 Changing the database connection information ............................... 144

vi OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
Table of Contents

3.4 Changing the Indexer sign-in information ........................................ 145


3.5 Changing the OTDS sign-in information .......................................... 145
3.6 Moving the repository after importing assets ................................... 146
3.7 Configuring content managers ....................................................... 147
3.7.1 Configuring content manager attributes .......................................... 147
3.7.2 Configuring Microsoft Azure blob storage ........................................ 148
3.7.3 Configuring Amazon S3 storage ..................................................... 150
3.7.4 Configuring Google Cloud Storage ................................................. 153
3.7.5 Changing the default content manager ........................................... 156
3.7.6 Configuring cloud storage for Review Jobs ..................................... 157
3.7.7 Configuring cloud storage for streaming .......................................... 157
3.7.8 Configuring cloud storage for Adaptive Media Delivery .................... 158
3.8 Configuring Rich Media Analysis Service ........................................ 158
3.8.1 Preparing and configuring for the analysis of assets ........................ 158
3.8.2 Tuning considerations for Rich Media Analysis Service .................... 159
3.9 Configuring SSL ............................................................................ 160
3.9.1 Configuring OTMM for SSL ............................................................ 160
3.9.2 Generating Certificates .................................................................. 160
3.9.3 Configuring the application server .................................................. 161
3.9.4 Configuring the application ............................................................ 163
3.9.5 Securing the session cookie .......................................................... 164
3.9.6 Redirecting HTTP requests to HTTPS ............................................ 165
3.10 Updating or recovering or the JBoss password ................................ 166
3.11 Changing the default JBoss server ports ......................................... 166
3.11.1 Changing the JBoss web server port .............................................. 167
3.11.2 Changing the JBoss JNDI naming port ........................................... 167
3.11.3 Changing the shutdown port .......................................................... 167
3.12 Enabling search term logging ......................................................... 168
3.12.1 Enabling internal search logging ..................................................... 168
3.13 Preparing to export asset URLs ..................................................... 169
3.14 Administering the Search Index ...................................................... 169
3.14.1 Re-indexing the Search Index database ......................................... 170
3.14.2 Configuring the Search Indexer engine ........................................... 170
3.14.2.1 Modifying the synonyms.txt configuration file ................................... 172
3.14.3 The Media Management Indexer .................................................... 173
3.14.3.1 Troubleshooting the Media Management Indexer ............................ 173
3.14.3.1.1 Not sure if the Indexer is running .................................................... 173
3.14.3.1.2 I cannot find any newly added assets (new assets are not being
indexed) ....................................................................................... 173
3.15 Configuring Solr to use the ICU Unicode tokenizer .......................... 175
3.16 Configuring enum Facet method .................................................... 177
3.17 Setting the debug level .................................................................. 179

OpenText Media Management – Administration Guide vii


MEDMGT160300-AGD-EN-02
Table of Contents

3.18 Clearing the Java cache ................................................................ 179


3.19 Importing Japanese Ruby character in PDFs .................................. 179
3.20 Configuring SMTP server authentication ......................................... 180
3.21 Customizing the text in the password reset email ............................ 181
3.22 Configuring the Search Suggestion feature ..................................... 181
3.22.1 Considerations for using the Suggester method .............................. 181
3.22.2 Converting the Solr search plugin to use the Suggester
implementation ............................................................................. 183
3.22.3 Disabling the Search Suggestion feature ........................................ 183
3.23 Configuring model-level required fields ........................................... 185
3.24 Overwriting HTTP response headers .............................................. 185
3.25 Viewing recently access assets and folder ...................................... 186

4 Administering links ............................................................... 189


4.1 Standard link types ........................................................................ 189
4.2 Creating links ................................................................................ 190

5 Logging and messaging ....................................................... 193


5.1 Server logs ................................................................................... 193
5.1.1 Changing the logging configuration ................................................ 194
5.1.1.1 Changing the logging configuration for JBoss .................................. 194
5.1.1.2 Changing the logging configuration for TomEE ................................ 195
5.1.2 Changing application server logs .................................................... 195
5.1.3 Viewing, debugging or tracing hibernate activities ........................... 195
5.2 OpenText™ Secure MFT (Secure MFT) logs .................................. 195
5.2.1 Viewing the Secure MFT Enterprise server log ................................ 196
5.2.2 OTMM Secure MFT logs ............................................................... 196

6 Maintenance recommendations ........................................... 197


6.1 Application administration maintenance .......................................... 197
6.2 Database maintenance .................................................................. 198
6.3 Data backup guidelines ................................................................. 198
6.3.1 Reverting to a backup copy of the Solr index files ............................ 201
6.4 Log file maintenance ..................................................................... 202
6.5 Cleaning up working areas ............................................................ 203
6.6 Miscellaneous items ...................................................................... 203
6.6.1 Custom application clean up .......................................................... 203
6.6.2 JSP pages .................................................................................... 204

7 Tuning considerations .......................................................... 205


7.1 Application server tuning ............................................................... 205
7.1.1 JBoss server tuning parameters ..................................................... 205
7.1.2 Advanced OTMM architecture options ............................................ 206
7.1.3 Managing OTMM application log files ............................................. 206

viii OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
Table of Contents

7.1.4 Configuring datasource parameters ................................................ 206


7.2 System setting tuning configuration ................................................ 207
7.3 Database tuning ............................................................................ 209
7.3.1 Rebuilding indexes ........................................................................ 209
7.3.2 Oracle database tuning ................................................................. 209
7.3.2.1 Oracle optimizer ............................................................................ 210
7.3.3 Managing OTMM tables ................................................................ 210
7.3.3.1 Workflow log tables ....................................................................... 210
7.3.3.2 Auditing tables .............................................................................. 210
7.3.3.3 Session tables .............................................................................. 211
7.4 Search Index tuning ...................................................................... 211
7.4.1 Solr server log files ........................................................................ 211
7.5 Performing maintenance ................................................................ 211

8 Field Locking ......................................................................... 213


8.1 LockUnlockUtility ........................................................................... 213
8.1.1 Database design ........................................................................... 214
8.1.2 LockUnlockUtility.dtd ..................................................................... 215
8.1.3 LockUnlockUtility.bat ..................................................................... 215
8.1.4 LockUnlockUtility.xml .................................................................... 216

9 Populating folder types ......................................................... 219


9.1 Admin Utility for folder types .......................................................... 219
9.1.1 AdminUtility.dtd ............................................................................. 219
9.1.2 AdminUtility.bat ............................................................................. 219
9.1.3 Folder type XML file ...................................................................... 220

10 Partial deletion of assets ...................................................... 225


10.1 Configuring purge system settings .................................................. 225
10.2 Implications of partially deleted assets ............................................ 226
10.3 Recycle Bin .................................................................................. 227

11 Multilingual metadata ............................................................ 229


11.1 Configuring metadata locales ......................................................... 229
11.2 Configuring multilingual metadata .................................................. 230
11.2.1 Creating custom multilingual metadata tables ................................. 230
11.2.2 Creating multilingual metadata fields .............................................. 230
11.3 Updating an existing metadata field to be multilingual ...................... 231
11.3.1 Upgrading existing custom metadata tables to be multilingual .......... 231
11.3.2 Upgrade existing metadata field to be multilingual ........................... 231
11.4 Importing and exporting multilingual metadata values ...................... 232
11.4.1 Importing assets containing multilingual metadata ........................... 233
11.4.2 Exporting assets containing multilingual metadata ........................... 234

OpenText Media Management – Administration Guide ix


MEDMGT160300-AGD-EN-02
Table of Contents

11.5 Retrieving assets containing multilingual metadata at the API level .. 234

12 Appendix A – Preference file ................................................ 235


12.1 Tresource file ................................................................................ 235
12.2 Tresource settings cache ............................................................... 236
12.3 Changing server preferences ......................................................... 236
12.4 Preferences blocks ........................................................................ 237
12.4.1 Preference value formats ............................................................... 237
12.5 Volatile and nonvolatile preferences ............................................... 238

13 Appendix B – System settings ............................................. 239


13.1 System configurations ................................................................... 239
13.1.1 ADAPTIVE_MEDIA\CONFIG ......................................................... 239
13.1.2 ADOBE\CCAPPS .......................................................................... 239
13.1.3 APPLICATION\CONTENT_SHARE ................................................ 239
13.1.4 ASSET\CONFIG ........................................................................... 240
13.1.5 ASSET\METADATA_TRANSFORMERS ........................................ 240
13.1.6 COLLABORATION\CONFIG .......................................................... 240
13.1.7 COMMON\CLIENT ........................................................................ 241
13.1.8 COMMON\JDBC ........................................................................... 242
13.1.9 COMMON\SERVER ...................................................................... 242
13.1.10 COMMON\SOLR .......................................................................... 245
13.1.11 CONTENT\CONFIG ...................................................................... 246
13.1.12 CONTENT_TRANSFER\CONFIG .................................................. 247
13.1.13 CREATIVEREVIEW\VIKI ............................................................... 247
13.1.14 CREATIVEREVIEW
\VIKI_CONTENTMANAGER_DATASTORE_MAP ........................... 250
13.1.15 EVENT_LOGGING\SERVER ......................................................... 251
13.1.16 EXPORT\SERVER ........................................................................ 251
13.1.17 HELP\CONFIG ............................................................................. 252
13.1.18 IMAGE\CONFIG ........................................................................... 252
13.1.19 IMPORT\SERVER ........................................................................ 253
13.1.20 INDEXING\COMMON ................................................................... 256
13.1.21 INDEXING\SOLR .......................................................................... 258
13.1.22 JNDI\CONFIG ............................................................................... 258
13.1.23 JOB\CONFIG ................................................................................ 259
13.1.24 LIGHTBOX\SERVER .................................................................... 261
13.1.25 MEDIAANALYSIS\GENERAL ........................................................ 261
13.1.26 METADATA\CONFIG .................................................................... 262
13.1.27 METADATA\LEGACY-CONFIG ..................................................... 262
13.1.28 METADATA\VALIDATOR .............................................................. 263
13.1.29 OTAG\GENERAL .......................................................................... 263
13.1.30 OTDS\GENERAL .......................................................................... 264

x OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
Table of Contents

13.1.31 OTDS\SYNCHRONIZATION .......................................................... 265


13.1.32 REPORT\CONFIG ........................................................................ 266
13.1.33 RESTAPI\CONFIG ........................................................................ 267
13.1.34 RULEENGINE\CONFIG ................................................................ 268
13.1.35 SCHEDULER\CONFIG ................................................................. 268
13.1.36 SEARCH\SERVER ....................................................................... 268
13.1.37 SEARCH\SOLR ............................................................................ 270
13.1.38 SECURITY\SERVER .................................................................... 270
13.1.39 SERVER\EVENTS ........................................................................ 272
13.1.40 TRANSCODE\SERVER ................................................................ 273
13.1.41 TRANSFER_SCHEME\ALT_SCHEME ........................................... 274
13.1.42 TRANSFER_SCHEME\DEFAULT_SCHEME .................................. 275
13.1.43 TRANSFER_SCHEME\SWITCH .................................................... 275
13.1.44 TRANSFORMER\CONFIG ............................................................ 275
13.1.45 YOUTUBE\CONFIG ...................................................................... 276
13.1.46 UX\CACHE ................................................................................... 277
13.1.47 UX\CUSTOM ................................................................................ 278
13.1.48 UX\GENERAL .............................................................................. 278
13.1.49 UX\IMPORT ................................................................................. 280
13.1.50 UX\OBJECTBUILDER ................................................................... 280
13.1.51 VIDEO\TRANSCODE .................................................................... 280
13.1.51.1 RHOZET\PROFILE ....................................................................... 285
13.1.51.2 TRANSCODE\FFMPEG ................................................................ 286
13.1.52 WEB\ADMIN ................................................................................. 287
13.1.53 WEB\CONFIG .............................................................................. 287
13.1.54 WEB\GENERAL ........................................................................... 287
13.1.55 WEB_APPLICATIONS\CONFIG .................................................... 289

14 Appendix C – JBoss EAP and WildFly ports ...................... 291

Part 2 Administering OpenText™ Media Management Adaptive


Media Delivery 295

15 Using Adaptive Media Delivery ............................................ 297


15.1 Accessing the Adaptive Media Delivery Administration page ............ 297
15.2 Registering client applications ........................................................ 298
15.3 Managing users ............................................................................ 298
15.4 Configuring and managing a multi-tenant environment .................... 299
15.4.1 Creating a tenant .......................................................................... 300
15.5 Supported Content Types .............................................................. 302
15.6 Generating dynamic renditions ....................................................... 302
15.7 Accessing log files ......................................................................... 305
15.8 Database tables ............................................................................ 305

OpenText Media Management – Administration Guide xi


MEDMGT160300-AGD-EN-02
Part 1
Administering OpenText™ Media
Management
Part 1 Administering OpenText™ Media Management

The following sections provide information about how to administer OpenText™


Media Management (OTMM) using the Web Administration tool.

14 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
Chapter 1

Introduction

Administrators need a basic understanding of the (OTMM architecture and


directory structure. In addition to describing the conventions in this guide, this
section describes OTMM and the elements of OTMM administration in general
terms.

Important
This content describes the administrative requirements for a generic
application. Not all of the administrative functions documented may apply
to your particular installation.

1.1 Conventions in this guide


The section discusses the legacy product names and nomenclature.

1.1.1 Legacy product names


Media Management was previously known as Artesia DAM and before that,
TEAMS. Therefore, this document references these legacy names in code examples
and some executables and variables still incorporate “artesia” or “TEAMS” within
their names, for example:

%TEAMS_HOME%\bin\ArtesiaProcessManagerConsole.bat
artesia-server-utilities.jar

Consider references such as %TEAMS_HOME% or <TEAMS_HOME> as references to the


Media Management root install.

Note: References to the Media Management Web Client or OTMM Web Client
mean the HTML5 UI, which was introduced in version 10.5.

1.1.2 Nomenclature
Certain components of the back end, or server, part of the OTMM software can be
installed on either a Windows® or a RedHat Enterprise Linux® operating system. By
convention, each system uses terms that are slightly different to describe the same
thing. For example, a software component can be called either a “server” or a
“service”. In this document, OTMM components are called “servers”.

Linux path definitions use the UNIX syntax (forward slashes), while Windows paths
use back slashes. For path definitions not specifically attributed to one system, this
document shows paths in the UNIX syntax using forward slashes (/). When
applying the examples to Windows, change all forward slashes to back slashes (\).

OpenText Media Management – Administration Guide 15


MEDMGT160300-AGD-EN-02
Chapter 1 Introduction

This document uses the term Asset when referring to an OTMM object containing
both editorial content and a description of the content properties. Internally, an asset
is sometimes called a Unit of Information (UOI), and this term appears in some
directory names and preference sections.

1.2 Directory structure and contents


The OTMM directory structure exists under the Media Management root directory,
a directory defined in the environment variable TEAMS_HOME. This variable is used in
various path settings in OTMM to define the absolute path to the Media
Management subdirectories.

In the path examples in this manual, the variable is shown simply as <TEAMS_HOME>.

1.2.1 Media Management directories


<TEAMS_HOME>
The root directory for all OTMM-related data and software.
<TEAMS_HOME>/ant
The bundled installation of Apache Ant™ used to configure the server at install
time.
<TEAMS_HOME>/archive
The location where archived versions of your system metadata configuration are
stored. When a new metadata configuration is applied, the old configuration is
stored here.
<TEAMS_HOME>/bin
Contains all OTMM-related executables, such as servers and utilities.
<TEAMS_HOME>/data
The root directory for OTMM data, such as the physical data repository. For
more information, see “Data directories” on page 18.
<TEAMS_HOME>/ddl
Contains the database scripts used to create the OTMM schema. Not used at
runtime.
<TEAMS_HOME>/ddl_install
Contains the scripts used to install OTMM. Not used at runtime. This folder is
creating during the install process. The scripts are configured to run on the
server. This folder also contains logs that are the result of executing the database
scripts.
<TEAMS_HOME>/deploy
This folder contains the library files that the OTMM server depends on. This
folder is part of OTMM runtime.
<TEAMS_HOME>/ear
Where the main parts of OTMM are installed. This folder is part of OTMM
runtime.

16 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
1.2. Directory structure and contents

<TEAMS_HOME>/exiftool
Contains the ExifTool executable file.

<TEAMS_HOME>/Indexer
This folder contains files necessary to configure Solr for OTMM. It also contains
the log4j configuration file.

<TEAMS_HOME>/Install
This folder contains the executable and scripts used during installation. It also
contains scripts to configure OTMM post installation.

<TEAMS_HOME>/jars
This folder contains JAR files that are used when running server utilities. This
folder is not part of OTMM runtime.

<TEAMS_HOME>/lib
Contains all OTMM shared libraries.

<TEAMS_HOME>/logs
Contains all OTMM log files related to debugging and tracking system behavior.
Indexer log files are also written to this folder.

<TEAMS_HOME>/MediaInfo
This folder contains the MediaInfo software. It is used to extract metadata from
video assets.

<TEAMS_HOME>/otds
This folder contains the OTMM Push Connector files for OpenText™ Directory
Services (OTDS).

<TEAMS_HOME>/oracleinstantclient
This folder contains the Oracle database connectivity clients required for the
OTMM installation.

<TEAMS_HOME>/plugins
The location for custom code when using some OTMM frameworks.

<TEAMS_HOME>/repository
The default repository directory. This can be changed during the install.

<TEAMS_HOME>/servers
Contains configuration information used by OTMM servers during startup.

<TEAMS_HOME>/solr_otmm
The default location for the Apache Solr™ (Solr) search index.

<TEAMS_HOME>/spicer
Utilities to process and convert Office documents.

<TEAMS_HOME>/UninstallMediaManagement
The files used during the uninstallation.

<TEAMS_HOME>/xpdf
Utilities to process and convert PDF format documents.

OpenText Media Management – Administration Guide 17


MEDMGT160300-AGD-EN-02
Chapter 1 Introduction

1.2.2 Data directories


<TEAMS_HOME>/data/config
Contains configuration information used by OTMM servers at runtime.
<TEAMS_HOME>/data/cs
System configuration and working areas.
<TEAMS_HOME>/data/cs/global
Contains the Media Management global preference file (Tresource).This file
contains node-specific settings.
<TEAMS_HOME>/data/jobs
Contains Spring Batch job configuration files.
<TEAMS_HOME>/data/jobs/form
Contains user form definition files.
<TEAMS_HOME>/data/cs/working_area
Root directory used as a temporary working area. For Windows, this data
directory is:
<TEAMS_HOME>/data/cs/working_area

<TEAMS_HOME>/data/cs/working_area/<vertical>
A set of multiple directories for managing the working areas for vertical
components, such as import, edit, and search. Each directory is named for a
particular vertical component. For example:
<TEAMS_HOME>/data/cs/working_area/import
For Windows, this directory is:
<TEAMS_HOME>/data/cs/work/import

<TEAMS_HOME>/data/delivery
Contains delivery profiles.
<TEAMS_HOME>/data/images
This is for internal use.
<TEAMS_HOME>/data/notification
Contains configuration files, in subdirectories, for various email and push
notifications.
Normally, each subdirectory contains the following configuration files for email
notifications:
• subject.txt
• body.txt
• from.txt

For Collaborative Jobs, in some, cases different email notifications are sent for
the same event to Job managers and Task assignees. In these cases, the
subdirectory will contain the following configuration files:

18 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
1.2. Directory structure and contents

• body_jobmanager.txt
• body_assignee.txt
• subject_jobmanager.txt
• subject_assignee.txt
• from.txt

Some of the Collaborative Job related subdirectories also contain configuration


files for push notifications delivered to OpenText Media Management Mobile
App. These subdirectories will also contain the files:

• push_title.txt
• push_summary.txt

Note: You need to overwrite the from.txt with a valid email account that
is specified in the EMAIL_SERVER setting. This setting is located in the
COMMON\SERVER component, which belongs to the General
configuration group. You can access this group from the Settings page. For
more information, see “Editing a component and properties” on page 136.

The subdirectories containing the configuration files are as follows:

asset-checkin
Used for email notification regarding a subscribed asset being checked in.

asset-comment-add
Reserved for future use.

asset-deleted
Used for email notification regarding a subscribed asset being marked for
deletion.

asset-metadata-updated
Used for email notification regarding a subscribed asset’s metadata being
updated.

asset-undeleted
Used for email notification regarding a subscribed asset being undeleted.

folder-assets-added
Used for email notification regarding assets added to a subscribed folder.

folder-assets-removed
Used for email notification regarding removal of assets from a subscribed
folder.

folder-deleted
Used for email notification regarding a subscribed folder being marked for
deletion.

OpenText Media Management – Administration Guide 19


MEDMGT160300-AGD-EN-02
Chapter 1 Introduction

folder-metadata-updated
Used for email notification regarding a subscribed folders’s metadata being
updated.

folder-parents-changed
Used for email notification regarding a subscribed folder’s parent being
updated.

folder-purged
Used for email notification regarding a subscribed folder being purged.

folder-undeleted
Used for email notification regarding a subscribed folder being undeleted.

password-reset
Used to configure the text of the password reset email.

review-assets-added
Used for email notification regarding new assets being added to a
participating review.

review-notification-sent
Used for email notification to let participants know about due date.

review-started
Used for email notification to let participants to know that the review has
been initiated.

review-updated
Used for email notification to let participants know that due date has been
updated.

review-user-added
Used to invite participants to a new review.

review-user-updated
Used to invite new participants to an existing review.

reviewjob-job-add-asset
Used for notifying Job Managers that new assets were added to a Review
Job.

reviewjob-job-add-participant
Used to notify a participant that they were added to a Review Job as a Job
Manager.

reviewjob-job-all-tasks-completed
Used to notify Job Managers that all the Tasks from their Review Job were
completed by a Task Assignee.

reviewjob-job-complete-reviewjob
Used to notify a Job Manager that a Task was completed by a Task Assignee.

20 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
1.2. Directory structure and contents

reviewjob-job-reopen-reviewjob
Used to notify Task Assignees of Tasks where the status is not started or in
progress when a closed or completed Review Job has been reopened.
reviewjob-job-start-reviewjob
Used to notify a Job Manager and Task Assignees where the status is not
started when a draft Review Job is started.
reviewjob-jobtask-asset-new-version-added
Used to notify a Job Manager and Task Assignees where the status is in
progress when a newer version of an asset that belongs to their Review Job
or assigned Task was checked in.
reviewjob-job-update-participant
Used to notify an existing participant that they were assigned as the Job
Manager for the Review Job.
reviewjob-job-update-reviewjob
Used to notify a Job Manager that the due date for the Review Job changed.
reviewjob-task-activate-reviewjobtask
Used to notify a Task Assignee that a Task was activated and assigned to
them.
reviewjob-task-add-asset
Used to notify a Task Assignee that the Job Manager added a new asset to
the Task to which they are assigned.
reviewjob-task-complete-task
Used to notify a Job Manager that a Task was completed.
reviewjob-task-createtask
Used to notify a Review Job participant that a Task was created and
assigned to them.
reviewjob-task-decline-task
Used to notify a Job Manager that a Task was declined.
reviewjob-task-reopen-reviewjobtask
Used to notify a Task Assignee that their Review Job task has been
reopened.
reviewjob-task-send-notification
Used to notify a Task Assignee that they have has an unfinished Task.
reviewjob-task-update-reviewjobtask
Used to notify a Job Manager and Task Assignee that the due date of the
Review Job Task changed.
user-task-completed
Used for notifying participants that the Task was completed.
user-task-created
Used for inviting new participants to a new Task.

OpenText Media Management – Administration Guide 21


MEDMGT160300-AGD-EN-02
Chapter 1 Introduction

user-task-updated
Used to notify participants that the task has been updated.

Note: For more information about how to localize notifications, see


“Localizing notifications” on page 142.

<TEAMS_HOME>/data/rules
This directory contains examples of Drools files.

<TEAMS_HOME>/data/search
This directory contains the definition of filters to be applied on search results

<TEAMS_HOME>/data/template
This is obsolete.

<TEAMS_HOME>/data/trigger
This directory contains data files for Integrators to set up triggers that initiate
business processes based on changes in metadata.

<TEAMS_HOME>/data/ux
This directory contains data files to be used during Web services invocations
that use the UX WebServices (UX-WS) module.

1.2.3 Repository directories


All data content is stored and retrieved from the repository directories. The default
location is <TEAMS_HOME>/repository/data/repository. You can optionally
change this in one of two ways. One way is by using the TEAMS_REPOSITORY_HOME
environment variable. For example, if you set TEAMS_REPOSITORY_HOME to /opt1/
content, the application will store and retrieve content from /opt1/content/data/
repository. A second way in which you can change the location where data
content is stored and retrieved is through the Content Manager. For more
information about configuring the Content Manager, see “Configuring content
managers” on page 147.

1.2.3.1 Media Management Repository Directories


<TEAMS_REPOSITORY_HOME>/data/repository
The root directory containing the physical data repository.

<TEAMS_REPOSITORY_HOME>/data/repository/keyframes
The keyframe directory.

<TEAMS_REPOSITORY_HOME>/data/repository/original
The root directory for content imported into OTMM.

<TEAMS_REPOSITORY_HOME>/data/repository/original/<directory>
A set of multiple directories containing original content. The default directory is
named in the IMPORT/SERVER component, which belongs to the Import
configuration group. You can access this group from the Settings page. For
more information, see “Settings” on page 130.

22 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
1.2. Directory structure and contents

<TEAMS_REPOSITORY_HOME>/data/repository/original/<directory>/
<subdirectory>
A set of multiple subdirectories containing content files imported into OTMM.
The application creates subdirectories during the import process.

<TEAMS_REPOSITORY_HOME>/data/repository/screen
Root directory for any screen resolution files created for content imported into
OTMM.

<TEAMS_REPOSITORY_HOME>/data/repository/screen/<directory>
A set of multiple directories containing screen resolution content. The default
directory is named in the PARTITION property, located under the IMPORT/
SERVER component, which belongs to the Import configuration group. You can
access this group from the Settings page. For more information, see “Settings”
on page 130.

<TEAMS_REPOSITORY_HOME>/data/repository/screen/<directory>/<subdirectory>
A set of multiple subdirectories containing screen resolution files created for
content imported into OTMM. The application creates subdirectories during the
import process.

<TEAMS_REPOSITORY_HOME>/data/repository/thumb
Root directory for any thumbnail files created for content imported into OTMM.

<TEAMS_REPOSITORY_HOME>/data/repository/thumb/<directory>
A set of multiple directories containing thumbnail content. The default directory
is named in the IMPORT/SERVER component, which belongs to the Import
configuration group. You can access this configuration group from the Settings
page. For more information, see “Settings” on page 130.

<TEAMS_REPOSITORY_HOME>/data/repository/thumb/<directory>/<subdirectory>
A set of multiple subdirectories containing thumbnail files created for content
imported into OTMM. The application creates subdirectories during the import
process.

OpenText Media Management – Administration Guide 23


MEDMGT160300-AGD-EN-02
Chapter 2
Web Administration tool

This chapter provides information on how to sign in, sign out, and navigate through
the Media Management Web Administration tool. The Web Administration tool is
used by system administrators, librarians and others with appropriate access.

2.1 Signing in and out


The Web Administration tool sign-in page is accessed through a different URL than
the Media Management Web application. The URL will have the following form:

http://<webserver>:11090/teams/admin-index.html

Before signing in to the Web Administration tool, you must enter your user name
and password. For security purposes, your password does not display. Instead, dots
appear as the password is entered.

2.1.1 Signing in to the Web Administration tool


To sign in to the Web Administration tool:

1. Type in your User Name.


2. Type in your Password.
3. Click the Sign in button.

2.1.2 Signing out of the Web Administration tool


To sign out of the Web Administration tool:

• Click Logout located at the top of the screen, on the far right.

2.2 The Web Administration tool interface


After you sign in to the Web Administration tool, you see the Welcome page. The
Web Administration tool has a set of buttons (described in the following table) on a
navigation bar at the top of every page. This is also referred to as the top-level menu.

Use the top-level menu to navigate to each Web Administration tool function. From
this point forward you can access everything in the Web Administration tool that
your user role has permission to access. For more information about roles, see
“Managing roles” on page 53.

Note: The Web Administration tool supports role-based access. Each user login
belongs to a role which is assigned by the administrator when the user account

OpenText Media Management – Administration Guide 25


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

is created. When a user is denied access to a function, the associated menu


option, button, or link will not be displayed. Therefore, the accessible controls
on the Web Administration tool user interface may look different for users of
different roles. If you feel that you need functionality that currently is not
accessible to you, contact your administrator.

Table 2-1: Navigation Functionality

Button Description
Metadata Edit, import, and export metadata
configurations, and create or edit custom
metadata tables, lookup domain tables, and
cascading mapping tables.
Security Manage Security Policies, Roles, and
Function Enablement Tokens (FETs).
Users Manage User Groups, edit users, maintain
security access of users, and display a list of
users currently logged into the system.
Templates Manage Property Templates, copy existing
user’s preferences and save them as a
template that can be applied to other users
when users are created. Also, users can
create folder types and configure Advanced
Search.
Utilities • View assets marked for deletion and
undelete or purge them from the system
using the Recycle Bin.
• View locked assets and release the locks.
• Clear the server caches, client caches, and
API-based program cache.
• Regenerate the Tasset.dtd file.
• Regenerate video proxies.
YouTube Allows you to map a YouTube channel to a
delivery template to upload videos to
YouTube.
Configurations Allows you to configure transformers,
content types, mime types, interval profiles,
facets and brands.
Media Analysis Allows you to create, edit, and delete a
schedule to run an OpenText™ Media
Management Rich Media Analysis Service
(Rich Media Analysis Service ) job. This
service analyzes image assets. Based on its
analysis, it generates metadata.

26 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.2. The Web Administration tool interface

Button Description
Analytics Allows you to configure the integration with
OpenText™ Experience Analytics Data
Collector (Data Collector) and OpenText
Analytics products for reporting.
Storage Management Allows you to configure content managers
and business rules.
Settings Allows you to administer OTMM system
settings.

2.2.1 Configuring Internet Explorer to refresh pages correctly


If the browser you are using to view the Web Administration tool is not set correctly,
your browser will not refresh with every page and you will see out-of-date data
when you navigate through Web Administration tool.

To get the most out of the Web Administration tool, change the refresh settings of
the browser you are using to view the Web Administration tool.

To configure Internet Explorer to refresh pages:

1. Click Tools in the menu bar of the browser window.

2. Click Internet Options.

3. Click the General tab.

4. Under Browsing History, click Settings.

5. Click Every visit to the page under Check for newer versions of stored pages.

Notes
• If you attempt to prematurely terminate the loading of a browser page by
clicking a navigation link or button while the page is loading, OpenText
cannot guarantee that the buttons will work properly. To recover from such
instances, click your browser's refresh button and let the page load
completely before continuing with your desired action.
• Use of your browser's back and forward buttons is strongly discouraged. If
you use these buttons, OpenText cannot guarantee that the Web
Administration tool will work properly. To recover from such instances,
click your browser's refresh button, let the page load completely, and then
use the appropriate Web Administration tool button to navigate through the
application.

OpenText Media Management – Administration Guide 27


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.2.2 Role-based access to Web Administration tool


functionality
The Web Administration tool supports role-based access. Each user login belongs to
a role which is assigned by the administrator when the user account is created.
When a user is denied access to a function, the associated menu option, button, or
link will not be displayed. Therefore, the accessible controls on the Web
Administration tool user interface may look different for users of different roles.

If you feel that you need functionality that currently is not accessible to you, contact
your administrator.

2.3 Metadata
This section provides a guideline for administrators who are responsible for
designing and implementing custom metadata within the OTMM architecture. It
provides the information necessary for you to extend the OTMM metadata, as well
as how to integrate it with external data sources.

2.3.1 Metadata properties


Metadata within the OTMM system represents various structured properties that
describe and define the asset stored in the repository. This data may include system-
defined or generated metadata along with business metadata.

The OTMM database stores the following properties associated with assets:

Content-specific Attributes
These attributes describe most of the asset types, such as text documents, XML
documents, images, layouts, videos, and generic multimedia objects.

Generic Attributes
The properties fields in this category include generic columns of Character,
Date, and Numeric datatypes associated with each asset.

Predefined Associations
These include assignments of Vocabulary Control terms, rights and permissions,
and links.

The OTMM metadata framework is used for managing metadata associated with
your assets. This metadata, both system-defined and custom, is highly structured
and can be projected into rows and columns.

The following table defines terms with respect to OTMM metadata.

28 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.3. Metadata

Table 2-2: OTMM metadata terminology

Term Definition
Field Group A grouping of metadata fields on the
Property View/Edit window.
Model A collection of metadata fields organized by
field groups that describe assets.
Field A metadata field.
Tabular Field Group Tabular Data is used when there is a one-to-
many relationship between an asset and the
metadata field values and consists of
multiple Metadata Table fields which map to
columns in the field group.
Cascading Groups Related domains that are linked together.
Lookup A metadata field whose value is set by
selecting from a predefined list of values.
This is also known as a “Domain List”.
UOI Synonymous with asset.
Field Attribute An attribute about each metadata field that is
used by the metadata interface to determine
how to display or treat the metadata field.
Lookup Domain A set of lookup values for a field. A “Lookup
Domain” may be shared among fields. For
example, common lookups like “Yes/No”
may now be defined once and be shared by
many fields. A lookup domain may also
come from an external source or can be
programmatically determined by defining a
custom plug-in.
External Metadata A plug-in can be used to retrieve read-only
metadata from an external datasource. This
datasource may be another database or a
web service for example.
Cache versus Non-cache Lookup Domains may be cached for
improved performance on a domain by
domain basis.

OTMM provides a set of metadata fields that comes with the pre-configured
product.

The OTMM schema may be configured to handle custom metadata. The storage of
the core metadata part of an asset and of the custom metadata attributes for an asset
is called the Metadata interface.

Note: Domain item entries cannot have leading or trailing spaces.

OpenText Media Management – Administration Guide 29


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

To restrict domains from being able to be edited by the Web Administration


domain editor, add them to the EXCLUDED_DOMAINS table in the database.

2.3.1.1 Metadata for participants


Participant is a special out-of-the-box model that is used internally as a metadata
placeholder for information about users defined in the system. Participant metadata
can be extended to include business specific metadata. The configuration required to
extend the metadata is the same as extending the metadata of any other metadata
model in OTMM.

Pre-configured metadata fields, which are included in these models, are required for
the proper operation of the application. The existing field attributes cannot be
modified, but new metadata fields can be added freely.

Note: Using the Media Management client, it is possible to edit the metadata
values pertaining to a particular user. It is similar to editing metadata on an
asset.

2.3.1.2 Microsoft SQL Server syntax


When configuring metadata field domains with Microsoft® SQL Server® queries, the
query should be structured with the join column preceding the display column. For
example:

Correct syntax:

SELECT ID, VALUE from DOMAIN_LOOKUP

This specifies the ID column as CODE and VALUE as the display VALUE.

Incorrect syntax:

SELECT VALUE, ID from DOMAIN_LOOKUP

This specifies the VALUE column as CODE, and ID as the display VALUE.

2.3.1.3 External Metadata


External metadata enables OTMM to access information from external systems
beyond what is conventionally stored as part of asset metadata in the database.
External metadata is implemented using a Java class that provides hooks for
retrieving values using Web Services, JDBC, or other APIs, to retrieve information
regarding an asset and to provide search capability.

An example of external metadata includes data which resides in SAP or other PIM
systems which is tied to the current asset through some common attribute such as
ItemID or BarCode information. For information about the implementation details,
see the Service Plugins section, which contains the External Datasource Plugins section,
in OpenText Media Management Programmer Guide (https://knowledge.opentext.com/
knowledge/llisapi.dll/Properties/69371555), which is a ZIP file located on OpenText
My Support (https://support.opentext.com/).

30 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.3. Metadata

The external metadata:

• Can be displayed in the UX views as part of asset metadata.


• Can be added to metadata models and field groups.
• Can be accessed through the API.
• Can be classified as tabular data. For example, an asset that has region-specific
tabular information may include data from other systems.
• Can be configured by users in Preferences.
• Is included in the Search Index.

2.3.1.3.1 Limitations

The following are the limitations when using external metadata:

• External metadata cannot be marked as editable, facetable, or sortable.


• External metadata is included in the Search Index. However, if an external
metadata value changes, the index will not be updated (so search results won’t
include the changes) until the asset is re-indexed for some other reason such as a
non-external metadata field is updated or you re-index the search index
database. For more information on re-indexing the search index database, see
“Re-indexing the Search Index database” on page 170.
• External metadata cannot not be classified as a cascading drop-down field.
• Because external metadata is a read-only field, it will not be shown in Property
Templates. However, when external metadata is added to a model, it can allow
templates created with that model to function correctly.
• External metadata will not be included in an export (it will not be included in
assetProperties.xml).
• External metadata cannot be inherited.
• Do not use external metadata values to trigger workflows on state changes since
external metadata is not automatically updated.

2.3.2 Metadata Editor


The Metadata Editor allows system administrators to create, modify, and import
metadata configurations for use within OTMM. The Metadata Editor uses a
“sandbox” approach—that is, you can create and modify metadata configurations in
a staged working area without impacting the current system's configuration.
Administrators can make changes to the new metadata configuration, save it, and
come back to it at a later time still without affecting the configuration currently
active in the database. When the Metadata Editor is running, it will display
informational text denoting whether the configuration that is currently being edited
was loaded from the database (“LIVE IN DATABASE”) or from the staged working
area (“WORK IN PROGRESS”).

OpenText Media Management – Administration Guide 31


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

Changes made to the configuration are not saved to the working area until you click
the Save button. Administrators can also run a verification command to identify all
errors in the new configuration. Then, during an appropriately planned off-hours
period, the administrator can initiate the process of updating the active system with
the metadata configuration by clicking the Apply button. This process will log all
users off the system, prevent new logins, and complete all tasks associated with
activating a metadata configuration. If you try to apply a new configuration with
errors in it, the system will automatically revert to the previous active configuration,
allowing the administrator to correct any errors in the new configuration. If there are
any unintended or unexpected results (not errors), administrators can revert to the
previous active configuration and then make changes to the new configuration
before applying it again. Once you have successfully applied the configuration, it is
archived and the copy in the staged working area is removed. The next time the
Metadata Editor is loaded, it will load the database version of the configuration.

The following diagram shows the process flow of the metadata editor concepts.

Figure 2-1: Metadata Editor Flow

To access the Metadata Editor, on the top-level menu, click Metadata > Metadata
editor. The Metadata Editor screen is divided in two sections. On the left side is an

32 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.3. Metadata

accordion control which lists the various configurations for each category as you
choose the category. The right side of the screen will show the configuration of any
item selected on the left side. Once the right pane appears, you can re-size it by
dragging the invisible dividing bar between the two panes.

2.3.2.1 Models
A model is a collection of metadata that describe assets. The MODELS table contains
a list of all metadata models contained within OTMM.

A web client metadata search can be performed only on a single model. The default
OTMM metadata fields, such as asset name and asset ID are not automatically
included in new models. Therefore, if you want to perform searches on these fields,
you need to include them in your new model. This is done by adding a field group
that contains these fields to your model. The fields need not be displayed on the
Media Management Property View/Edit window, but they must be included in the
new model in order to be used.

Note: Do not configure NOT_NULL columns from the same table to two
different models as this can lead to undesirable results.

To add a new model or modify an existing model:

1. On the top-level menu, click Metadata > Metadata editor.


2. Do one of the following to configure the new or existing model:

• To add a new model, click the Plus Sign icon at the bottom of the left side.
• To edit an existing model, click it.
3. In the ID box, enter the domain ID.
4. In the Name box, enter or edit the name.

Note: Valid characters for model names are letters, numbers, the
underscore (_), and period (.).
5. In the Object Type list, choose one of the following default types:

• ASSET to import and create Property Templates.


• CLIP to create video clips.
• FOLDER to create folder types.
• USER to create user types.

Note: If the model type is not set or is empty, then it can be used as any
model type. The model type USER is used for the Participant model
(internal use).
6. For any field groups that you want to include, drag any of the groups from the
Available Field Groups to the Associated Field Groups.

OpenText Media Management – Administration Guide 33


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

Note: You can reorder the list by dragging items to a new position in that
list.

7. After choosing all the fields that you want to include in the model, perform any
of the following actions:

• Click Save to save the current configuration to the staged working area.
• Click Validate to validate the current configuration and identify any errors.
• Click Apply to apply the current configuration.

Important
The Apply option logs all users off the system, prevents new logins,
and completes all tasks associated with activating a metadata
configuration. Therefore, you may want to perform this during off
hours.

• Click Revert to revert to the previous configuration settings.

Important
This removes the working area file and reverts to the last applied
configuration from the database.

• Click Cancel to cancel the current editing session. This undoes any changes
that have not been saved or applied, but it does not remove the working
area file if one exists.

8. To delete any models, choose the model that you want to delete and click the
Minus Sign icon on the lower left side.

2.3.2.1.1 Field groups for layout files

Special metadata field groups must be added to any models used to ingest Adobe
InDesign® or Adobe Illustrator® layouts.

InDesign Models
Add the following metadata field groups to any metadata model where
InDesign layouts will be ingested:

ARTESIA.CATEGORY.LAYOUT ATTRIBUTES
ARTESIA.CATEGORY.LAYOUT FONTS

Illustrator Models
Add the following metadata field group to any metadata model where
Illustrator layouts will be ingested:

ARTESIA.CATEGORY.ILLUSTRATOR CATEGORY

Note: For information on adding field groups to a model, see “Creating and
editing metadata fields” on page 36.

34 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.3. Metadata

2.3.2.2 Creating and editing field groups


A field group is a group of like metadata fields. Using the Metadata Editor, you can
create new field groups and edit existing ones.

To create and edit field groups:

1. On the top-level menu, click Metadata > Metadata editor.

2. Click the Field Groups category. The existing field groups appear on the left
side of the Metadata Editor page.

3. Do one of the following:

• To add a new field group, click the Plus Sign icon on the lower left.
• To edit an existing field group, click it.

4. In the ID box, enter the domain ID.

5. In the Name box, enter or edit the name.

6. Drag any of the fields or groups that you want to include from the Available
Fields and Available Tabular Field Groups lists to the Associated Fields and
Groups list.

Note: You can reorder the list by dragging items to a new position in that
list.

7. After choosing all the fields and groups that you want to include, perform any
of the following actions:

• Click Save to save the current configuration to the staged working area.
• Click Validate to validate the current configuration and identify any errors.
• Click Apply to apply the current configuration.

Important
The Apply option logs all users off the system, prevent new logins,
and completes all tasks associated with activating a metadata
configuration. Therefore, you may want to perform this during off
hours.

• Click Revert to revert to the previous configuration settings.

Important
This removes the working area file and revert to the last applied
configuration from the database.
• Click Cancel to cancel the current editing session. This undoes any changes
that have not been saved or applied, but it does not remove the working
area file if one exists.

OpenText Media Management – Administration Guide 35


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

8. To delete any field groups, choose the group you want to delete and click the
Minus Sign icon at lower left side.

2.3.2.3 Creating and editing metadata fields

Note: The following out-of-the-box metadata fields are assumed to represent


file sizes and are rendered as such. The file size will be rendered in the
appropriate unit (such as B, MB, KB, and so on) automatically.
• ARTESIA.FIELD.FILE SIZE
• ARTESIA.FIELD.MAC.RESOURCE CONTENT SIZE
• ARTESIA.FIELD.RENDITION SIZE
• ARTESIA.FIELD.FONT OUTLINE FILE SIZE
• ARTESIA.FIELD.LAYOUT FILE SIZE

To create or edit a metadata field:

On the top-level menu, click Metadata > Metadata editor.

1. Click the Fields category. The existing fields appear on the left hand side of the
Metadata Editor.

2. Do one of the following:

• To add a new field, click the Plus Sign icon at the bottom of the left hand
side.
• To edit an existing field, click it.

3. In the ID box, edit or enter the new name.

4. In the Name box, edit or enter the name.

5. Choose the table to use this field with at the Table prompt.

6. Choose the column that stores this field's value at the Column prompt. This is
optional if the field has an external data source.

Note: The selectable columns are automatically populated with a list of


available columns for the table chosen.

7. The Datatype is automatically populated with a value that represents the


datatype of the chosen database column. The datatype can be one of the
following:
The following table lists and describes the datatypes for Microsoft SQL.
Table 2-3: Microsoft SQL Datatypes

Metadata Data Type Database file names


BLOB BINARY, IMAGE, VARBINARY

36 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.3. Metadata

Metadata Data Type Database file names


CHAR CHAR, TEXT, VARCHAR
DATE DATETIME, SMALLDATETIME
FLOAT FLOAT, REAL
INTEGER DECIMAL, MONEY, NUMERIC,
SMALLMONEY
NUMBER DECIMAL, MONEY, NUMERIC,
SMALLMONEY

The following table lists and describes the datatypes for Oracle®.
Table 2-4: Oracle Datatypes

Metadata file names Database Data Type


BLOB LONG RAW, RAW, BLOB
CHAR CHAR, VARCHAR2, VARCHAR
DATE TIMESTAMP, DATE
FLOAT BINARY, DOUBLE, REAL,
BINARY_FLOAT
NUMBER NUMBER
NUMBER DECIMAL, MONEY, NUMERIC,
SMALLMONEY

8. Set the Data Length. This is the maximum length of the data for this field. A
value of 0 indicates no limit. This setting does not override the database storage
length for the field.

9. Choose the Edit Type. This is used by GUI builders to determine how to render
controls for editing the field. Edit types can be one of the following:

• CASCADING - A multiple list box control used with Cascading Domain


fields.
• CASCADING_TYPE_AHEAD - Supports selection from a cascading
domain list by typing the first characters of the cascading domain list item.
• COMBO - A list box that allows a NULL entry.
• COMBO_ NOTNULL - A list box that does not allow a NULL entry.
• DATE - Same as SIMPLE except that when NULL, the default date format is
pre-filled to assist the user.
• SIMPLE - A single line edit control.
• TEXTAREA - A multi-line edit control that displays approximately five lines
of text.

OpenText Media Management – Administration Guide 37


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

• TYPE_AHEAD - Supports selection from a domain list by typing the first


characters of the domain list item.

10. Choose a Lookup Domain.

11. Choose an External Datasource. Optionally, specify the ID of the associated


external metadata datasource from EXT_META_DATASOURCES.

12. At the Restriction prompt, optionally select a restricting class to apply to this
field.

Note: Restricting classes are defined in the Field_Restrictions table. For


more information, see “Field_Restrictions table” on page 39.

Restricted fields are fields that have been restricted to being viewed by
specified User Groups. For example, you may have a Salary field that you may
want to restrict all user groups from viewing except for the HR User Group.
The process of applying Restricted Fields to a User Group is a two-step process:

• First, you must restrict a field with a restriction class, which is done in the
Restriction box of this dialog box. For example, if you have a Salary field,
you can restrict it to the HR only class. However, at this point, no one can
view the Salary field because no User Group has the HR only class applied
to it.
• Second, you must apply the Restriction Class to a User Group. In the
previous example, you would apply the HR only class to the HR User
Group. Now, the only users who can view the Salary field are those who
belong to the HR User Group. For more information, see “Applying
restricted field access within User Groups” on page 59.

13. At the Cascading Group box, optionally choose a cascading group, which
consists of related domains that are linked together, to assign this field to.

14. Select or clear any of the following check boxes:

• Enabled – Indicates the field is enabled.

Note: Metadata fields which are mapped to database columns which


are non-nullable should not be disabled. If they are disabled, an error
will occur on importing an asset into the model which contains the
metadata field.
• Editable – Indicates this field can be edited.
• Facetable – Indicates whether the field can be used in a facet configuration.
• Sortable – Indicates whether the field can be used as a sort criteria.

38 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.3. Metadata

• Displayable – Indicates whether the field should be displayed as metadata.


For example, you may want to have a field that is searchable but not
displayable.

• Required – Indicates whether this field requires that a value be specified


when saving new metadata for this field.

• Searchable – Indicates whether this field can be specified in an OTMM


search.

• Keyword Searchable – Indicates whether this field is used in a keyword


search.

15. After making all the configuration changes, perform any of the following
actions:

• Click Save to save the current configuration to the staged working area.

• Click Validate to validate the current configuration and identify any errors.

• Click Apply to apply the current configuration.

Important
The Apply option will log all users off the system, prevent new
logins, and complete all tasks associated with activating a metadata
configuration. Therefore, you may want to perform this during off
hours.

• Click Revert to revert to the previous configuration settings.

Important
This will remove the working area file and revert to the last applied
configuration from the database.

• Click Cancel to cancel the current editing session. This will undo any
changes that have not been saved or applied, but it will not remove the
working area file if one exists.

16. To delete a field, select the field you want to delete and click the Minus Sign
icon at the lower left.

2.3.2.3.1 Field_Restrictions table

The Field_Restrictions table defines the restricted classes used by OTMM to restrict
fields and User Groups. This table, by default, contains three example restricted
classes of Restricted Class 1, Restricted Class 2, and Restricted Class 3. You may
want to edit, add, or delete these classes to suit your needs. The Field_Restrictions
table contains the following columns. Only the first two are mandatory.

OpenText Media Management – Administration Guide 39


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

Table 2-5: Columns in Field_Restrictions Table

Column Description
FIELD_RESTRICTION_ID numeric (PK) Field restriction ID (mandatory).
NAME varchar(100)(Unique Key) Name of the restriction. No two restrictions
can have the same name. This is this label or
restriction class (mandatory).
DESCR varchar(249) Description of the restriction.
CREATE_DT date Date created.
CREATE_ID varchar(80) ID of the user who created this restriction.
UPDATE_DT date Date updated.
UPDATE_ID varchar(80) ID of the user who updated this restriction.

Use SQL commands to add new field restriction classes. The following is an
example:

Example 2-1: Adding new field restriction classes


insert into FIELD_RESTRICTIONS
(FIELD_RESTRICTION_ID, NAME, DESCR, CREATE_DT, CREATE_ID,
UPDATE_DT, UPDATE_ID) values
(1, 'Restricted Class 1', 'Restricted Class 1', CURRENT_DATE,
1, CURRENT_DATE, 1);

Use SQL commands to update field restriction classes. The following is an example:

Example 2-2: Updating field restriction classes


update FIELD_RESTRICTIONS
set name = 'new name',
update_dt = CURRENT_DATE,
UPDATE_ID = 1
Where FIELD_RESTRICTION_ID = 1

For more information on applying restricted classes to fields and User Groups, see
the following sections:
• “Creating and editing metadata fields” on page 36.
• “Applying restricted field access within User Groups” on page 59.

40 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.3. Metadata

2.3.2.3.2 Metadata field limitations

Certain field configurations can only be used programmatically through the APIs.
For example, the datatypes BLOB, CLOB, and LONG can only be used for fields that
are not mapped to models. In addition, fields that use an external metadata data
source also cannot be mapped to models.

Note: Fields that are not mapped to models will not be visible to the Media
Management Web Client. They will only be usable programmatically through
the APIs.

2.3.2.4 Tabular field groups


A tabular field group is data that is displayed within a table on the Media
Management Property View/Edit window. Tabular data is used when there is a one-
to-many relationship between an asset and the metadata field values.

For scalar metadata, each asset is associated with just one row in the physical
database table. But for tabular metadata, there is more than one database record
associated with an asset. This allows a list of similar data items to be stored, as
opposed to just one. This might be a list of actors, contracts, or asset usage data.

An example of this might be the staff associated with a production. Recording each
staff member would mean capturing several attributes per member, such as first
name, last name, role in the production, and contact email address. The tabular
metadata then would be presented as a single row of data per staff member. If there
were 10 staff members, there would be 10 rows of data.

This tabular structure enables extensible metadata storage, where the number of
entries for each asset vary from one asset to another.

To create or edit a tabular field group:

1. On the top-level menu, click Metadata > Metadata editor.


2. Click the Tabular Field Groups category. The existing groups appear on the left
side of the Metadata Editor.

a. To add a new tabular field group, click the Plus Sign icon on the lower left.
b. To edit an existing tabular field group, click it. The configuration for the
new or existing tabular field group appears.
3. Enter the domain ID in the ID box.
4. Edit or enter the new name in the Name box.
5. Select the table to use this field group with in the Database Table box.

Notes
• The UOI_ID column values are not unique in a tabular metadata table.
When you create a Tabular Metadata table in the Custom Table Editor

OpenText Media Management – Administration Guide 41


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

and you want to use the UOI_ID as the primary key, you must select
another column as the primary key to create a composite primary key
for the table.
• Do not use the same database table to store tabular and scalar fields.
• Do not use the same table in multiple tabular groups.

6. To add new tabular fields, click the Plus Sign next to Tabular Fields. A new
untitled field appears in the current list of fields.

7. To edit a field, click any of the field characteristics and make the desired
changes.

8. To reorder the fields, drag any field to the desired position.

9. After making all the configuration changes, perform any of the following
actions:

• Click Save to save the current configuration to the staged working area.
• Click Validate to validate the current configuration and identify any errors.
• Click Apply to apply the current configuration.

Important
The Apply option will log all users off the system, prevent new
logins, and complete all tasks associated with activating a metadata
configuration. Therefore, you may want to perform this during off
hours.
• Click Revert to revert to the previous configuration settings.

Important
This will remove the working area file and revert to the last applied
configuration from the database.
• Click Cancel to cancel the current editing session. This will undo any
changes that have not been saved or applied, but it will not remove the
working area file if one exists.

10. To delete a tabular field group, select the group you want to delete and click the
Minus Sign icon on the lower left.

Note: Cascading Groups can be a member of a Tabular Field Group.

42 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.3. Metadata

2.3.2.5 Lookup Domains


A Lookup Domain is a set of lookup values for a field that may be shared among
fields. For example, common lookups like “Yes/No” can be defined once and be
shared by many fields. A Lookup Domain may also come from an external source
or can be programmatically determined by defining a custom plug-in.

Lookup fields are best described as lists which are restricted to a limited set of
values. Metadata fields are created as lookup fields by selecting a Lookup Domain
on the field edit panel. A domain data source can be a SQL query that returns data
from a lookup table or can be a custom plug-in.

To create or edit a Lookup Domain:

1. On the top-level menu, click Metadata > Metadata editor.


2. Click the Lookup Domains category. The existing domains will appear on the
left side of the Metadata Editor.
To add a new lookup domain, click the Plus Sign icon on the lower left. To edit
an existing lookup domain, click it. The configuration for the new or existing
lookup domain will appear.
3. Enter the domain ID in the ID box.
4. Select the Cache Domain Values check box if you want to be able to cache this
domain value.
5. Select the Lookup Value Source, either the Database or Java™ Interface.
6. At the Database Table prompt, select the table that you want to use with this
lookup domain.
7. Select the ID (Join) Column. If a query is supplied, this field is mandatory. The
value for this column is the join column for the lookup table if a join were to
occur between the metadata table and the lookup table.
8. Select the Value (Display) Column. If a query is supplied, this field is
mandatory. The value for this column is the column of the lookup table that
provides the display value.
9. Select the Order By Column.
10. Optional Edit or reset the Query to use for this lookup domain. This is an SQL
query that retrieves the values of the domain. The query must return exactly
two values per row. The first is the value that will be saved for the field. The
second is the value displayed to the user.
11. Optional Click the Edit Value Activation Dates button to set the validation period
for the domain values.

Notes
• Value Activation dates define a period of time when domains can be
active. For example, you might have certain domains that you only want

OpenText Media Management – Administration Guide 43


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

active during the calendar year 20017. You could set the activation
period from 1/1/20017 to 12/31/20017.
• Setting Value Activation dates will not affect any assets already in the
system. They will only affect new assets going forward.
12. Select the Active From date and Active To date for the validation dates for each
of the domains.

Note: Click the calendar icons to select dates.

13. Click Save.


14. After making all the configuration changes, perform any of the following
actions:

• Click Save to save the current configuration to the staged working area.
• Click Validate to validate the current configuration and identify any errors.
• Click Apply to apply the current configuration.

Important
The Apply option will sign off all users off the system, prevent new
sign ins, and complete all tasks associated with activating a metadata
configuration. Therefore, you may want to perform this during off
hours.
• Click Revert to revert to the previous configuration settings.

Important
This removes the working area file and reverts to the last applied
configuration from the database.
• Click Cancel to cancel the current editing session. This will undo any
changes that have not been saved or applied, but it will not remove the
working area file if one exists.
15. To delete a lookup domain, select the domain you want to delete and click the
Minus Sign icon on the lower left.

2.3.2.6 Cascading Groups


Cascading Groups are domains which are related and linked together—that is,
selections from one group determines the selections in the next. For example, you
might have these three groups: Car Manufacturer, Model, and Year. When you
select a particular Car Manufacturer, that determines what populates the Model
group, and the selection in the Model group determines the selections in the Year
group.

Before creating Cascading Groups, you will need to create a mapping table to map
valid values for each successive domain group. For more information, see
“Cascading Mapping Tables” on page 49.

44 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.3. Metadata

To create or edit a Cascading Group:

1. On the top-level menu, click Metadata > Metadata editor.

2. Click the Cascading Group category. The existing groups will appear on the left
side of the Metadata Editor.

3. To add a new group, click the Plus Sign icon on the lower left. To edit an
existing Cascading Group, click it. The configuration for the new or existing
Cascading Group will appear.

4. Enter the domain ID in the ID box.

5. Enter the name in the Name box.

6. Enter a description in the Description box.

7. Choose the Cascading Map Value Source, Database or Java Interface.

• If you chose a Database, in the Cascading Mapping Table list, chose a


value.

• If you chose Java Interface, in the Cascading Mapping Class box, enter a
class.

8. Perform any of the following actions:

• Click Save to save the current configuration to the staged working area.

• Click Validate to validate the current configuration and identify any errors.

• Click Apply to apply the current configuration.

Important
The Apply option logs all users off the system, prevents new logins,
and complete all tasks associated with activating a metadata
configuration. Therefore, you may want to perform this during off
hours.

• Click Revert to revert to the previous configuration settings.

Important
This removes the working area file and reverts to the last applied
configuration from the database.

• Click Cancel to cancel the current editing session. This undoes any changes
that were not saved or applied, but it does not remove the working area file,
if one exists.

9. To delete a Cascading Group, select the group you want to delete and click the
Minus Sign icon on the lower left.

OpenText Media Management – Administration Guide 45


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.3.3 Importing metadata configurations


To import a metadata configuration from another server instance:

1. Create any database or custom tables that the imported metatdata configuration
will be using.
2. On the top-level menu, click Metadata > Import metadata.
3. Click Choose File, and choose the configuration file that you want to import.
4. Click Import.

2.3.4 Exporting metadata configurations


Exporting a metadata configuration will export the current configuration into an
XML file. The export function carries forward the metadata only into the export file.
Database and custom tables and other schema objects are not exported.

Note: The exported XML file cannot be edited.

To export a metadata configuration:

1. On the top-level menu, click Metadata > Export metadata.

Note: To export a metadata configuration from one server instance and


import it into a second instance, you must create the database or custom
tables on the second instance before importing the configuration.
2. Select Save to save the file.

2.3.5 Custom Table Editor


The Custom Table Editor allows you to create or edit custom metadata tables,
lookup domain tables, and cascading mapping tables. It allows for basic
functionality only and does not support tasks like assigning tablespace or storage
options.

2.3.5.1 Metadata tables


The Custom Table Editor only displays metadata tables created or edited in the
Custom Table Editor—that is, tables in the database that have a UOI_ID column and
are listed in the METADATA_TABLE_INCLUSIONS table.

Note: Tables that have been created outside of the Custom Table Editor (for
example, through database scripts) must be added to the
METADATA_TABLE_INCLUSIONS table.

To create or edit a metadata table:

1. On the top-level menu, click Metadata > Custom table editor.

46 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.3. Metadata

2. To add a new metadata table, click the Plus Sign icon on the lower left. To edit
an existing metadata table, click it. The configuration for the new or existing
table will appear.

3. Enter or edit the Name of the table.

4. To add new columns to the table, click the Plus Sign next to Columns. A new
untitled column will appear in the current list of columns.

5. To edit a column attribute, click any of the attributes and make the desired
changes.

Notes
• Fields not defined as nullable will create the required metadata fields in
the system.
• Use the Multilingual check box to indicate a multilingual column. Only
columns which are of the data type CHARACTER can be set to
multilingual. When you are creating a field that is associated with the
table's multilingual column, the Multilingual parameter is on by default,
which you can optionally deselect.

6. After making all the desired changes, perform any of the following actions:

• Click Create Table to save the current table.


• Click Cancel to cancel the current editing session.

2.3.5.2 Tabular Metadata tables


To create or edit a Tabular Metadata table:

1. On the top-level menu, click Metadata > Custom table editor.

2. Click the Tabular Metadata Tables category. The existing tabular metadata
tables will appear on the left side of the Metadata Editor.

3. To add a new tabular metadata table, click the Plus Sign icon on the lower left.
To edit an existing metadata table, click it. The configuration for the new or
existing table will appear.

4. Enter or edit the Name of the table.

5. To add new columns to the table, click the Plus Sign next to Columns. A new
untitled column will appear in the current list of columns.

6. To edit a column attribute, click any of the attributes and make the desired
changes.

Notes
• UOI_ID column values are not unique in a tabular metadata table. When
you create a Tabular Metadata table in the Custom Table Editor, you

OpenText Media Management – Administration Guide 47


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

cannot only use the UOI_ID as the primary key, you must select another
column or columns according to your business rule to define a
composite primary key.
• Do not use one table that has NOT_NULL columns for two different
tabular groups; this may lead to undesirable results.
• Fields not defined as nullable will create the required metadata fields in
the system.
• Tabular Metadata tables do not support the Multilingual check box
option.

7. After making all the desired changes, perform any of the following actions:

• Click Create Table to save the current table.


• Click Cancel to cancel the current editing session.

2.3.5.3 Lookup Domain Tables


The Custom Table Editor allows administrators to edit lookup values. The columns
cannot be edited. The lookup tables listed in the Custom Table Editor are the lookup
tables listed in the LOOKUP_TABLE_INCLUSIONS table, as well as all other tables
referenced by lookup domains in the META_FIELD_DOMAINS table.

To create or edit a Lookup Domain Table:

1. On the top-level menu, click Metadata > Custom table editor.

2. Click the Lookup Domain Tables category. The existing lookup tables will
appear on the left side of the Metadata Editor.

3. To add a new lookup domain table, click the Plus Sign icon on the lower left. To
edit an existing table, click it. The configuration for the new or existing table
will appear.

4. Enter the Name of the table.

5. To edit a column attribute, click any of the attributes and make the desired
changes.

6. To add new domain value to the table, click the Plus Sign next to “Domain
Values”. A new untitled value will appear in the current list of columns.

7. To edit a value, click any of the attributes and make the desired changes.

8. After making all the desired changes, perform any of the following actions:

• Click Create Table to save the current table.


• Click Cancel to cancel the current editing session.

9. To delete a lookup domain table, select the table you want to delete and click
the Minus Sign icon on the lower left.

48 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.3. Metadata

The Custom Table Editor will enforce database integrity rules. For example, tables
that contain data may not be deleted if it violates database foreign key rules.
Columns may not be added to tables that contain data unless they are specified as
nullable columns.

2.3.5.4 Cascading Mapping Tables


Cascading Groups are domains which are related and linked together—that is,
selections from one group determines the selections in the next. For example, you
might have State, County, and City groups. When you select a particular State, that
determines what populates the County group and the selection in the County group
determines the selections in the City group. For more information about creating
Cascading Groups, see “Cascading Groups” on page 44.

Cascading Mapping Tables are used to define the relationship between the different
values of the Cascading Groups. In the previous example, for each state, you would
map all the valid counties for each state. For each county, you would map all the
valid cities for that county.

Lookup Domains need to be created before a Cascading Mapping Table is created


because the mapping relationship between Cascading Groups is based on the
lookup values in Lookup Domains. For example, if you have Cascading Groups
consisting of State, County, and City, then the values for each of these come from
Lookup Domains. For more information about creating Lookup Domains, see
“Lookup Domains” on page 43.

To create or edit a cascading mapping table:

1. On the top-level menu, click Metadata > Custom table editor.

2. Click the Cascading Mapping Tables category.

Tip: Existing Cascading Mapping Tables appear on the left side of the
Metadata Editor.

3. Do one of the following:

• To add a new table, click the Plus Sign icon on the lower left.
• To edit an existing table, click the name of the table.

4. On the Cascading Mapping Table page, enter the Name of the table.

5. Drag the lookup domains you want from the Available Lookup domains list to
the Selected Lookup Domains list.

Note: The sequence of the selected Lookup domains is important. The


sequence that you specify determines the sequence in the database table
and the user interface. To reorder the lookup domains, drag a domain to
the location you want in the Selected Lookup Domains list.

OpenText Media Management – Administration Guide 49


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

Tip: You can also choose the domains in the Available Lookup domains
list, and the click the blue arrow to move them to the Selected Lookup
Domains list.

6. Click Done.

Tip: The domains you chose populate the Lookup Domains column in the
below the domain lists.

7. Enter a name for each of the domains in the Table Column Name column.

Tip: These used as the column names in the database.

8. Enter a label for each of the domains in the Drop-Down Label column.

Tip: These are how the labels will appear in the user interface.

9. Click Create Table, and then confirm that you want to add the table to the
database. In the bottom section of the screen, a table will display with your
column headings.
10. In the Cascading Values Map section, choose values from the lists for each
column to set the mapping values for each successive domain.

11. Click the Plus sign (+) icon to add a new row to the Cascading Values Map
table.

12. Repeat Step 10 and Step 11 until the table is complete.

13. Click Update Table and click Yes in the confirmation dialog box to save the
table.

14. To delete a table, select the table you want to delete on the left side and click the
Minus Sign icon on the lower left side.

2.3.6 Metadata language


Multilingual metadata extends the existing OTMM metadata by allowing locale-
specific translations to metadata values. For more information, see “Multilingual
metadata“ on page 229.

50 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.4. Security

2.3.7 Using the Metadata Editor in an HA environment


To use the Metadata Editor within an HA environment:

Note: The Metadata Editor should be used directly on a node, without the help
of a load balancer.

1. Sign in to the Web Administrator and on one node, start the Metadata Editor
and click Apply.

2. Regenerate the Tasset file on all the remaining nodes by signing in to the Web
Administrator, selecting Utilities > Regenerate Tasset File, and then clicking
Regenerate Tasset File.

2.4 Security
You can use the Security feature to create, delete, and edit Security Policies, manage
user Roles, and manage Function Enablement Tokens (FETs).

2.4.1 Creating a security policy


To create a new security policy:

1. On the top-level menu, click Security > Security policy. The Security policies
page displays.

2. Click New Security Policy.

3. On the Info tab, enter the name and description for the new policy.

4. Click Save.

Note: You will be unable to edit permissions on the Permissions tab, or


add or remove administrators on the Administrators tab until you click
Save and the Security Policy is created in the system.

5. Click Edit Info and modify the Security Policy information.

6. Do one of the following:

• Click Delete This Policy to delete the selected Security Policy.


• Click Back to Manage Security Policies to return to the list of the Security
Policies.

Note: The process of deleting a Security Policy does not happen


synchronously, because it involves removing the association of all assets to that
Security Policy. Since the number of associated assets can be quite large, the
process can take quite a while. OTMM marks the Security Policy so that it
cannot be used anymore by OTMM users, starts an asynchronous task to finish
deleting the policy, and returns control to the user.

OpenText Media Management – Administration Guide 51


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.4.2 Managing security policies


To manage security policies:

1. On the top-level menu, click Security > Security policy. The Security policies
page displays.

2. In the list of security policies, click the Manage link of a security policy.

3. Click the Info tab.

Tip: To modify the name and description of the policy, click Edit info, and
make the modifications, and then click Save

4. Click the Permissions tab, and do the following:

a. Select a user group in the left tree, and click Edit Permissions to edit the
security policy permissions associated with that group.

b. Assign permissions within the security policy, based on the following:

Permission Name Description


View Controls the most basic level of access
to any asset on the system, for example
including the asset in a user's search
results. The user must have this
permission to have any knowledge that
an asset or folder exists on the system.
View Summary Controls access to thumbnail image.
Preview Controls access to ScreenRes image,
Proxy, or Video.
Export Control access to One-click Download,
Export, including any or all
transformations and transport such as
HTTP, FTP, or email functions.
Subscribe Controls ability to subscribe or
unsubscribe to assets.
Edit Comments Controls ability to add comments to
assets and workflow projects.
Edit Metadata Controls access to Edit Metadata page,
selection of assets in Bulk Metadata
Edit and Sequential Edit pages, and
editing other user subscriptions.
Edit Content Controls access to Check Out, Check In,
and Attach Content functions.

52 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.4. Security

Permission Name Description


Apply/Remove Security Policies Controls access to adding assets to or
removing them from a Security Policy.
Also controls permission to change
policy membership of assets under a
Security policy.
Delete Controls access to Delete Asset
functions.
Edit container parents Controls access to parent container
Custom 01 For use by integrators to control access
to a custom function.
Custom 02 For use by integrators to control access
to a custom function.
Custom 03 For use by integrators to control access
to a custom function.
Custom 04 For use by integrators to control access
to a custom function.
c. Click Save.
5. Click the Administrators tab, and do the following:

a. Click the Add Administrators link and search for administrators.

Note: You can only search for users who are not already
administrators and candidates for “Security Policy Administrator”.
b. In the search results, select the check box of each administrator you want
for the security policy, and then click Apply Selections.
The Administrators tab will refresh and list the administrators you
selected.
c. To delete any administrators, navigate to the Actions column of the
administrators you want to remove, and then click Delete. Click OK in the
confirmation dialog box.

2.4.3 Managing roles


Notes
• Use the Web Administration tool to modify User Roles and preference
templates for users. All other changes, such as creating, updating, deleting,
enabling, and disabling, should be done in OTDS.
• When modifying User Roles, clear the cache to see your changes reflected.
For information on clearing the cache, see “Clearing caches” on page 87.

Administrators use the Roles functionality to control User Roles in Media


Management client applications. User Roles determine which users have access to
which menu items. These associations are made possible with the implementation of

OpenText Media Management – Administration Guide 53


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

Function Enablement Tokens (FETs). For more information, see “Function


Enablement Tokens” on page 55. Each aspect of OTMM functionality, such as
deleting an asset or personalizing a search, has an FET associated with it. The FETs
are then mapped to OTMM User Roles. Through these mappings, you can control
which users have access to which menu items in OTMM.

OTMM provides a set of pre-configured standard roles. These roles can be used
directly or can serve as examples for custom roles. The following table lists the
standard roles and a summary of the features they allow access to.

Table 2-6: Role Definitions

Role Name Description


No Access No access to any menu items or role-based
functionality.
Administrator Administrative user who have access to all
menu items and functionality.
Consumer User of repository assets.
Producer Creator and manager of repository assets.
Librarian Establishes the repository environment for
use by the consumer and producer.

To manage roles:

1. On the top-level menu, click Security > Roles. The Roles page displays the
current list of roles.

2. To view the FETs associated with a role, click the View link under the Actions
column.

3. To edit the FETs associated with a role, click the Edit link under the Actions
column, make the desired changes, and click Save.

4. To remove a role, navigate to the Actions column of the role you want to delete
and click Delete. Click OK in the confirmation dialog box.

5. To create a new role by duplicating and editing an existing role, click the
Duplicate and Edit link under the Actions column, make the desired changes,
and click Save.

6. To create a completely new role, click Create Role, make the desired changes,
and click Save.

Tip: When creating or editing a role, you can view the description of any FET
by clicking the FET name.

54 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.5. Users

2.4.4 Function Enablement Tokens


Function Enablement Tokens (FETs) determine whether a user can access a given
function in the UI. These are established when defining a Role, and each user is
assigned to a single Role. By assigning a user to a Role, the user is given access to
those functions in the UI that are established in the Role's FETs. A user's Role is set
at the time that the user's account is created, but can be changed at any time. Roles
are established prior to creating a user who is assigned to the Role, and the FETs
associated with the Role can be altered at any time. For example, a Role titled
“Media Creator” could be established and in the Role definition, users with this Role
would be granted access to the import function, enabling those users to import
media content that they create.

FETs apply only to the Media Management client and Media Management
Administration client and are not enforced in the APIs. It is possible to define
custom FETs to be associated with custom features in the client interfaces.

To manage FETs:

1. On the top-level menu, click Security > Function Enablement Tokens. The
Function Enablement Tokens page displays the current list of roles.

2. To view a FET, click the View link under the Actions column.

3. To create a FET, click Create Function Enablement Token, make the desired
changes, and click Save.

2.5 Users
This section provides information about Users Groups and Users.

2.5.1 User Groups


User Groups are groups of users who are grouped together based on their restricted
field access.

2.5.1.1 Creating a User Group


To create a User Group:

1. On the top-level menu, click Users > User Groups. The User groups page
displays.

2. In the left pane, navigate to and select the user group that you want to designate
as the parent of the new user group by clicking the Plus Sign or Minus Sign
icon to expand or collapse the tree view and then clicking a user group.

3. Click Insert new user subgroup. The Info tab of the new user group displays.

4. On the Info tab, enter a name and description of the new user group.

OpenText Media Management – Administration Guide 55


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

5. Use the Map button to select a user group in OTDS to map the current user
group to.

Notes
• All the membership changes for this group then must be managed in the
OTDS Web Client, which will be synchronized to OTMM through the
Push Connector deployed in OTDS.
• If the OTDS group already has users, a consolidate operation on the
corresponding group in the OTDS Web Client will push all the user
memberships to OTMM using Push Connector.

6. Click Save.

Note: The Users and Administrators tabs are disabled until you click Save and
the new user group is created.

2.5.1.2 Navigating existing User Groups


User groups are hierarchical by nature. For example, a user group can have child
user groups, whereas a user group can only have one parent user group. Pencil icons
indicate user groups for which you have edit or insert access.

To navigate existing User Groups:

1. On the top-level menu, click Users > User Groups.

2. On the left panel is a tree view of all of the user groups in the system. Navigate
to and select the user group that you want to designate as the parent of the new
user group by clicking the Plus Sign or Minus Sign icon to expand or collapse
the tree view, and then clicking a user group.

3. To display and manage the corresponding information of the selected user


group, do one of the following:

• Click the Info tab.


• Click the Users tab.
• Click the Restricted Field Access tab.
• Click the Branding tab.

4. Located above the tabs is a navigation bar where parent user groups are linked.
Click a linked user group to navigate to and then select that user group. Both
the left and right panels are refreshed to indicate the selected user group.

5. Do one of the following:

• Click Edit info to edit the selected user group's information.


• Click Insert New User Subgroup to insert a new user group as a child of the
selected user group.

56 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.5. Users

6. Click Insert New User Subgroup to insert a new user group as a child of the
selected user group.

Note: Which buttons display on this panel depends on your permissions


or on whether the selected user group is a read-only group. The Pencil
icon that displays with a user group in the tree view indicates that you
have edit access to that group.

2.5.1.3 Adding and removing users within User Groups


To add or remove users within User Groups:

1. On the top-level menu, click Users > User Groups.

2. In the left pane, navigate to and select the user group that you want to add or
remove users from.

3. Click the Users tab.

4. Click the Add Users link to display the User Search page. The Add Users link
will not be available for those groups which have OTDS groups mapped.

Notes
• If a group is mapped to an OTDS group from a non-synchronized user
partition, then users must be added to the mapped group in the OTDS
Web Client for membership to be reflected in OTMM through Push
Connector.
• If a group is mapped to an OTDS group from a synchronized user
partition, users have to be added to the original group in LDAP/AD, the
original source of the synchronized user partition, to reflect the changes
in OTMM through Push Connector.

5. Fill in the search criteria to search for users and then click Search. The search
results that match your criteria display.

6. Select the check box for each user you want to add to the selected user group
and then click Apply Selections. The users you selected will now display on the
Users tab.

7. To remove any user, click the icon next to the user you want to delete and
select OK in the confirmation dialog box.

Important
If a user group is mapped to an OTDS group, the icon should only be
used as a fall back mechanism to delete the users from the group when
Push Connector fails to delete the members due to some network
failures or the unavailability of the OTMM server at the time of the Push
Connector event. Even though clicking the icon temporarily deletes
the users from the user group in OTMM, a consolidate operation on the
OTDS group in the OTDS Web Client will restore the membership

OpenText Media Management – Administration Guide 57


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

which was deleted for an OTMM group with an OTDS Group mapped
to it.

Notes
• If a group is mapped to an OTDS group from a non-synchronized user
partition, then users must be deleted from the mapped group in the
OTDS Web Client for membership to be reflected in OTMM through
Push Connector.
• If a group is mapped to an OTDS group from a synchronized user
partition, users have to be deleted from the original group in LDAP/AD,
the original source of the synchronized user partition, to reflect the
changes in OTMM through Push Connector.

2.5.1.4 Adding and removing administrators within User Groups


To add or remove administrators within User Groups:

1. On the top-level menu, click Users > User Groups.

2. In the left pane, navigate to and select the user group that you want to add or
remove administrators for.

3. Click the Administrators tab.


The right side displays the list of administrators in the selected user group.

4. Click the Add Administrators link to add a new administrator, or click a linked
name to display more details about the user.

5. Fill in the search criteria to search for administrators, and then click Search.
The search results that match your criteria appear.

6. Select the check box for each administrator you want to add to the selected user
group, and then click Apply Selections.
The administrators you selected will now display on the Administrators tab.

7. To remove any administrator, click the icon next to the user you want to
delete and click OK in the confirmation dialog box.

58 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.5. Users

2.5.1.5 Applying restricted field access within User Groups


Restricted fields are fields that have been restricted to being viewed by specified
User Groups. For example, you may have a Salary field which you may want to
restrict all user groups from viewing except for the HR User Group.

The process of applying Restricted Fields to a User Group is a two-step process:


• First, you must restrict a field with a restriction class. For example, if you have a
Salary field, you can restrict it to the HR only class. However, at this point, no
one can view the Salary field because no User Group has the HR only class
applied to it. To restrict a field with a restriction class, “Creating and editing
metadata fields” on page 36.
• Second, you must apply the Restriction Class to a User Group. In the previous
example, you would apply the HR only class to the HR User Group. Now, the
only users who can view the Salary field are those who belong to the HR User
Group.

To apply restricted field access within a User Group:

1. On the top-level menu, click Users > User Groups.


2. In the left pane, navigate to and select the user group that you want to restrict
field access for.
3. Click the Restricted Field Access tab. The Restricted Field Access page
appears.
4. Select the check box next to the field restriction you want to use for this User
Group and click Save Restriction Settings.

Note: All subgroups will inherit the same restrictions.

2.5.1.6 Deleting a User Group


To delete a User Group:

1. On the top-level menu, click Users > User Groups.


2. In the left pane, navigate to and select the user group that you want to delete.
3. In the right pane, click Delete This Group.

Important
If an OTMM group is mapped to an OTDS group, then OpenText
recommends maintaining the same user memberships in both OTMM and
OTDS in order to avoid data inconsistency issues.

Notes
• If a user group is mapped to an OTDS group, then deleting the user group in
OTMM will not delete the group in OTDS, and vice versa.

OpenText Media Management – Administration Guide 59


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

• If any of the mapped OTDS groups are deleted in OTDS, an OTMM


administrator must manually clear and save the OTDS group mapping for
the corresponding group in OTMM.
• Push Connector will only handle “Add Users to Group” and “Remove Users
from Group” events.

2.5.1.7 Synchronizing user group memberships from OTDS using Push


Connector
OTMM supports user membership synchronization of user groups from OTDS from
both Synchronized and Non-Synchronized user partitions. For user group
memberships to get synchronized to OTMM, a user group in Media Management
must be mapped to the corresponding user group in OTDS.

Push Connector synchronizes user group memberships once they are available on
the OTDS server. For a synchronized user partition whose source of information is
either LDAP or AD, data will first be synchronized to the OTDS server automatically
and then the Push Connector will synchronize the data to the OTMM server. For a
synchronized user partition, users have to either be added or removed in the actual
LDAP or AD.

Push Connector can be used to synchronize user memberships in the following


cases:

User group exists only in OTDS


Create an equivalent group in OTMM that should be mapped to the existing
OTDS group for which memberships have to be synchronized to OTMM. If the
mapped OTDS group already has users associated with it, then perform a
consolidate operation on the OTDS group using the OTDS Web Client in order
for the memberships to be pushed to OTMM. If new users are added to the
OTDS group, the users will be pushed automatically to OTMM.

User group exists only in OTMM


If the user group exists only in OTMM and the administrator wants the users to
be managed through OTDS, then map the corresponding OTMM group to the
corresponding group in OTDS in order to enable the user memberships to be
pushed from OTDS. If the user group in OTMM already has users, they won’t be
added to the OTDS group automatically because the Push Connector pushes
memberships from OTDS to OTMM only, not from OTMM to OTDS. Only new
users added using OTDS will be pushed to OTMM.

User group exists in both OTDS and OTMM


If an existing user group in OTMM is mapped to an existing user group in
OTDS, then to get all the users from OTDS to OTMM, perform a consolidate on
the OTDS group. The existing users in OTMM will be retained as is and new
members will be added when the group is mapped to the OTDS group.

A new user group is created


If the user group does not exist in both OTMM and OTDS, then create a new
user group in OTDS and a new user group in OTMM and map the newOTMM

60 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.5. Users

user group to the OTDS user group. Then add users to the OTDS group using
the OTDS Web Client and the users will be pushed automatically to OTMM by
the Push Connector.

Notes

• Push Connector will only synchronize user memberships from OTDS to


OTMM. Therefore, user changes performed in OTMM will not automatically
be reflected in OTDS.
• Push Connector will only handle the events “Add Users to Group” and
“Remove Users from Group” and not any other events like “Create, Update
and Delete User Groups”.

2.5.1.8 Applying branding


A brand configuration defines the brand presentation in the UI. The UI will reflect
the branding configuration associated with the signed in user. If a user belongs to
more than one group, they can set their default branding through preferences. Or if
no preference is set, OTMM will use the branding associated with the first user
group it finds. In the absence of any configured branding for user groups, the
system will load the default branding configuration.

To apply a branding configuration:

1. On the top-level menu, click Users > User Groups.

2. Click the Branding tab.

3. Select a branding configuration.

4. Click Save Branding.

2.5.2 Users
In OTMM, user management is performed through OpenText Directory Services
(OTDS) by leveraging its push connector framework. User management refers to all
the users who are local to OTMM as well as to external users belonging to
Lightweight Directory Access Protocol (LDAP) or to Active Directory (AD). For
more information on LDAP, see section 9.1.2 “Lightweight Directory Access Protocol
(LDAP) utilities” in OpenText Media Management - Integration Guide
(MEDMGT160300-AIN).

System and User Group administrators can change the roles and preference for
users. User Group administrators will only be able to change the roles and
preferences for those User Groups for which they have been designated as an
administrator.

Note: User administration changes will not affect users currently signed in.
The changes will be applied the next time the user signs in.

OpenText Media Management – Administration Guide 61


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.5.2.1 Creating users


After integration with OTDS, create users locally in OTMM or create a synchronized
user partition through the OTDS Web Client to synchronize users to OTMM.

To create a local OTMM user:


Create OTMM users using the OTDS Web Client, which pushes users to OTMM
using the Push Connector configured for the OTMM resource in OTDS. User
creation supports synchronizing several user properties from OTDS to Media
Management. For more information, see section 9.1.2.1 “Configuring Media
Management user attributes in OTDS” in OpenText Media Management -
Integration Guide (MEDMGT160300-AIN).

To create a user in LDAP or AD:


Create a synchronized user partition in OTDS and the users created in LDAP or
AD will become available in OTMM. For information on creating a
synchronized user partition in OTDS, see section 3 “User partitions” in OpenText
Directory Services - Installation and Administration Guide (OTDS160202-IWC).

Note: The sign-in names for the users in OTMM are unique across all the
partitions of OTDS, regardless of case. For example, a user with sign-in
name “tsuper” cannot exist in more than one partition in OTDS even if the
sign-in name differs in case (i.e. “Tsuper”).

2.5.2.2 Viewing user account information


The Users page includes the Account Summary table which provides sum of the
number of standard (read-write) and consumer (read-only) user accounts, enabled
and disabled user accounts, and the number of standard OTMM licenses that are
available.

In addition, this page lists each user account by name, login name, and includes the
preference, account status, and license type. You can also edit each user account.
Any changes you make are reflected in the Account Summary table.

2.5.2.2.1 Viewing the summary of user accounts

The Users page displays a table that provides a summary of the user accounts.

The License Type is either Standard or Consumer (Read Only). Standard users can
perform write tasks in OTMM, such as uploading, editing, reviewing and checking
in assets. Consumer users can only perform read-only tasks, such as viewing assets.

Tip: A standard user might be limited in the tasks that they can perform due to
their role. Roles are defined by a collection of FETs that you specify as
administrator. Any of the following or all of the following FETs enable the role
definition of a standard user:
• IMPORT
• JOB_INITIATOR

62 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.5. Users

• ASSET.EDIT_PROPERTIES.SINGLE

For more information, see the following:


• “Managing roles” on page 53
• “Function Enablement Tokens” on page 55

Your OTMM license key determines the maximum number of standard, enabled
users that you can have. This limit is available in the Entitlement column of the
Standard row.

You can have an unlimited number of consumer (read-only) licenses. In addition,


standard disabled users are not counted towards your entitled limit.

If you reach the maximum number of enabled standard users, you will not be able to
update any user or role that will increase the count of standard users.

To view the summary of user accounts:

1. On the top-level menu, click Users > Users.

2. Navigate to the Account Summary table.

2.5.2.2.2 Viewing account information by user

The Users page lists the each user account that is in the system. This page displays
information by user.

To view account information by user:

1. On the top-level menu, click Users > Users.

2. To browse through multiple pages of users, use the navigation controls to


advance to the first, previous, next, or last pages. You can configure the number
of users displayed per page using the
NUMBER_OF_USERS_TO_DISPLAY_PER_PAGE setting.

Note: The NUMBER_OF_USERS_TO_DISPLAY_PER_PAGE setting is located


under the WEB\ADMIN component, which belongs to the General
configuration group. For more information, see “Editing a component and
properties” on page 136.

3. Use the Search list to Search By Last Name, Search By First Name, or Search
By Login Name. Enter a name in the search prompt, and click Search. To clear
the search results, click Clear Search.

Tip: Use the asterisk (*) as a wildcard.

4. To sort on any column, click the column name. Any column can be sorted in
ascending or descending order. Clicking a column multiple times switches
between ascending and descending order. An ascending sort is indicated by red

OpenText Media Management – Administration Guide 63


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

up arrows next to the column name and a descending sort is indicated by red
down arrows next to the column name.

Note: Sorting search results will sort the search results only. If the search
results have been cleared, all users will be sorted.

The following table lists the fields, buttons, and columns that appear on this page.

Table 2-7: Users Page Fields and Buttons

User Interface Element Description


Search By Searches for the user or users by last, first, or
sign-in name that you enter in the blank box.
Show All Filters the user list according to the following
setting that you choose: Enabled, Disabled,
Standard or Read Only.
Clear Search button Clears the search results.
Search button Runs the search according to the criteria that
you specified.
Name Full name of the OTMM user. Click Edit to
change the user's information. For more
information, see “Users” on page 61.
Login Name The sign-in ID that is assigned to the user.
Preference The Preference Template associated with the
user.
Role The access control group. Defines what
software features are available to a user
based on the user's area of responsibility
within an organization.
Account Status Displays whether the user is Enabled or
Disabled.
License Type Displays whether the license is Read Only or
Standard.
Actions Click Edit to displays a data entry screen to
edit user details.

64 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.5. Users

2.5.2.3 Editing users


Only a limited amount of user attributes can be edited in OTMM directly. Most user
attributes have to be edited using the OTDS Web Client.

To edit users in OTMM:

1. On the top-level menu, click Users > Users.

2. On the Users page, click the Edit link under the Actions column of the Users
page for the user you want to edit.

3. To edit the user account, do any of the following:

a. In the Apply Preference list, choose the template that you want to apply to
this user. For more information, see “Preference Templates” on page 75.
b. Click Enabled or Disabled.
c. In the Type area, do one of the following:

• Click Standard and then choose a role from the list.


• Click System Administrator and then choose a role from the list. The
role must have administrative FETs associated with it to be able to
perform administrative tasks.
d. Optional Select one or both of the following check boxes:

• User Group Administrator to make this user a User Group


administrator. The role must have the appropriate FETs associated with
it to be able to perform these administrative tasks.
• Security Policy Administrator to make this user a security policy. The
role must have the appropriate FETs associated with it to be able to
perform these administrative tasks.

4. Do one of the following:

• Click Save to save the user record.


• Click Cancel to return to the Users window without editing the user
information.

5. In the User Group Membership area, assign user groups to a user.

Notes
• For information about editing users in OTDS, see section 3.6.6 “Editing users
in a non-synchronized user partition” in OpenText Directory Services -
Installation and Administration Guide (OTDS160202-IWC). User properties
edited in OTDS will be synchronized to OTMM through Push Connector.
• Users belonging to LDAP or AD can only be edited in the corresponding
LDAP or AD server. After a user is edited in LDAP or AD, the changes will
be synchronized to OTMM through Push Connector.

OpenText Media Management – Administration Guide 65


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.5.2.4 Deleting users


You must delete OTMM users from the OTDS Web Client. For more information, see
section 3.6.12 “Deleting users in a non-synchronized user partition” in OpenText
Directory Services - Installation and Administration Guide (OTDS160202-IWC).

When a user is deleted in OTDS, the user will automatically be deleted in OTMM
unless the user has any of the following associated records:

• Assets that are created, locked, or modified by the user.


• Saved searches.
• They are a Security Policy administrator.
• They created or updated categories.
• They created or updated transformers.

Deleting a user (for both synchronized and non-synchronized) from the user
partition does not clean up the references in EPS. Therefore, the user will potentially
have some process or work item references. If a new user in the same partition with
the same user name is created again, this will reactivate the original user account in
EPS. To avoid confusing process references, clean up the old process instances
referring to the original user before the new user account is created.

Note: LDAP and AD users can only be deleted from the LDAP and AD servers
and will be synchronized to OTMM through Push Connector.

2.5.2.5 Case sensitivity for sign-in names


You can configure case sensitivity for sign-in names by setting the value of the
ALLOW_CASE_SENSITIVE_LOGIN_NAMES setting to Y.

This setting is located in under the SECURITY\SERVER component, which belongs


to the General configuration group. You can access this group from the Settings
page. For more information, see “Editing a component and properties” on page 136.

By default, sign-in names are case-sensitive. You can make sign-in names case
insensitive, that is, “tsuper” is the same as “Tsuper”. To do this, set the value of
ALLOW_CASE_SENSITIVE_LOGIN_NAMES to N.

Notes

• This setting is only applicable if the OTMM application is using an Oracle


database and is respected during sign-in time only. Anything to do with data
is still case-sensitive.
• This entry does not affect the case sensitivity for passwords, which are
always case-sensitive.

66 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.5. Users

2.5.3 Current Users Report


Using the Current Users Report feature, you can view the list of users currently
signed in to OTMM.

To access the Current users page:

• On the top-level menu, click Users > Current Users Report.

Tip: You can sort columns by clicking the title of the column.

The following table lists the fields and buttons that appear on this page.

Table 2-8: Current Users Page Fields and Buttons

Field/Button Description
Search By Search by name, sign-in name, sign-in time
of the day or week.
Search button Searches by the criteria that you specified.
Clear Search button Clears the search results.
Hide internal sessions check box Hides or shows internal sessions.
Hide internal sessions check box Hides or shows internal sessions.
Name The full name of the user.
Login name The sign-in ID of the user.
Role The user's role.
Server name The host name of the machine from where
the user signed in to OTMM.
Login time The date and time the user logged in.
Last ping time The last recorded time when a user
performed any operation in OTMM.
Login type Type of OTMM application that a user is
logged into such as Web or Standalone.
Logout button Terminates sessions of the users that you
selected.

Note: You cannot terminate the


current session where you are viewing
this page from.
Refresh button Refreshes the list of current users.

OpenText Media Management – Administration Guide 67


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.5.3.1 Refreshing current users


To refresh current users:

• On the Current users page, click Refresh.

Note: If users close the OTMM application by clicking the X to close the
browser rather than clicking Logout, the list of current users might be
artificially high. Running the cleanup_web_sessions.sh utility on the
OTMM server will ensure that the list of current users is accurate.

2.6 Templates
Using the Templates menu, you can manage folder types, property and preferences
templates, and Advanced Search configurations.

2.6.1 Folder Types


Folders are used to group assets. When a user creates a new folder, they must select
a folder type. Administrators create the default folder types to populate the system
with.

This folder type utility is controlled by an FET. However, only system


administrators are allowed to perform some of the folder type operations, such as
delete or update.

Note: This feature is used to create one folder type at a time. The Admin
Utility is used to create folder types in bulk. For more information, see
“Populating folder types“ on page 219.

The following table lists the fields and buttons that appear on this page.

Table 2-9: Folder Types Page Fields and Buttons

Field/Button Description
New folder type Create a folder type.
View View the folder type.
Edit Edit the folder type.
Delete icon Delete the folder type.

68 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.6. Templates

2.6.1.1 Adding folder types


To add a new folder type:

1. On the top-level menu, click Templates > Folder types.

2. Click New folder type.

3. To specify the properties of the folder type, navigate to the Properties section,
and provide the following information:

Note: Mandatory properties are indicated by a red asterisk (*).

ID ID of the folder type. Leading and trailing spaces will be trimmed


before processing the ID. The maximum length of the ID is 40
characters.
Name Name of the folder type.
Description Description of the folder type. If nothing is specified, then the
database will be populated with a null value or empty string.
Model Select any model name existing in the database.
Identifier As soon as a model is selected, the All Level Inheritance and One
Level Inheritance lists will be populated with all the fields associated
with this model.

Notes
• Only scalar fields will be displayed by default. To display
tabular fields, set the system setting
ALLOW_TABULAR_FIELDS_INTO_FOLDER_TYPES in the
WEB\ADMIN component to Y.
• Multilingual metadata fields will be displayed. Translations
are not inherited to child folders or assets. For multilingual
fields, only the default language values is inherited.
All Level If a field is specified as All Level, that means the field will be
Inheritance accessible to all folders, assets and sub folders.

Note: Use the CTRL or SHIFT keys to select more than one
field. The same field name should not be used for both One
and All Level Inheritance.
One Level If a field is specified as One Level, that means the field will be
Inheritance accessible to only to its immediate folder and assets.

Note: Use the CTRL or SHIFT keys to select more than one
field. The same field name should not be used for both One
and All Level Inheritance.

OpenText Media Management – Administration Guide 69


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

Default Fully qualified path for thumbnail image to be used. When creating a
Thumbnail File folder type, if a thumbnail is specified, the user would have an
Path opportunity to view the image by clicking View Thumbnail.

Note: Only image Mime types are applicable for default


thumbnail paths.
Default Fully qualified path for preview image to be used. When creating a
Preview File folder type, if a preview image is specified, the user would have an
Path opportunity to view the image by clicking View Preview.

Note: Only image Mime types are applicable for default


preview file paths.
Is Root Determines whether the folder type is a root node or not.
Is Active Determines whether the folder type is in an active or inactive state. In
the user interface, since all the operations are based on this field,
some of the operations may not be possible if the folder type is
marked as inactive.
Can Contain Determines whether the folder type can hold any assets or not. If set
Assets to TRUE, then folders of this folder type can hold assets. If set to
FALSE, then folders of this folder type can hold folders but not
assets.
Restricted to Determines whether the folder type is of single parent type or not. If
Have Single set to FALSE, then the folder type can have more than one parent. If
Parent set to TRUE, then the folder type cannot have more than one parent.
Are Container Determines whether the folder type is restricted or not. If set to TRUE,
Children then this folder type can only be a parent of the folders specified in
Restricted the List Of Allowed Child Types. If set to FALSE, then this folder
type can be a parent of any folder in the system (including itself).
List Of Select the allowable child folder types.
Allowed Child
Types Note: Use the CTRL or SHIFT keys to select multiple fields.

4. To specify the User Groups that will be allowed to create folders of this folder
type, navigate to the Users Permitted to Create Folders section. In the All User
Groups box, click a User Group.

Note: Select the Select this option to include sub groups check box to
include subgroups. Clear the check box if you do not want to include
subgroups.

Tip: The User Group is added to the User Groups Permitted to Create
Folders of this Folder Type box. To remove a User Group from this box,
click that is adjacent to the User Group name.

5. Click Save.
The new folder type will be available in the list of folder types when users
create a folder in the system.

70 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.6. Templates

2.6.1.2 Managing folder types

To manage folder types:

1. On the top-level menu, click Templates > Folder types.

2. To view a folder type, click the View link.

Tip: When viewing a folder type, click Back to list to return to the Folder
types page or click Edit to edit the contents.

3. To edit a folder type, click the Edit link, and then do the following:

a. To edit the properties of a folder type, navigate to the Properties section,


and then edit any of the following:

Note: Mandatory properties are indicated by a red asterisk (*).

ID ID of the folder type.


Name Name of the folder type.
Description Description of the folder type. If nothing is specified, then the
database will be populated with a null value or empty string.
Model Select any model name existing in the database.
Identifier As soon as a model is selected, the All Level Inheritance and
One Level Inheritance lists will be populated with all the fields
associated with this model.

Notes
• Only scalar fields will be displayed; all the tabular fields
will be filtered out. Also, the asset ID field will not be
displayed.
• Multilingual metadata fields will be displayed.
Translations are not inherited to child folders or assets.
For multilingual fields, only the default language value
is inherited.
All Level If a field is specified as All Level, that means the field will be
Inheritance accessible to all folders, assets and sub folders.

Note: Use the CTRL or SHIFT keys to select more than


one field. The same field name should not be used for
both One and All Level Inheritance.
One Level If a field is specified as One Level, that means the field will be
Inheritance accessible to only to its immediate folder and assets.

Tip: Use the CTRL or SHIFT keys to select multiple


fields. The same field name should not be used for both
One and All Level Inheritance.

OpenText Media Management – Administration Guide 71


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

Default Fully qualified path for thumbnail image to be used. When


Thumbnail File creating a folder type, if a thumbnail is specified, the user will
Path have an opportunity to view the image by clicking View
Thumbnail.
Default Fully qualified path for preview image to be used. When
Preview File creating a folder type, if a preview image is specified, the user
Path will have an opportunity to view the image by clicking View
Preview.
Is Root Determines whether the folder type is a root node or not.
Is Active Determines whether the folder type is in an active or inactive
state. In the user interface, since all the operations are based on
this field, some of the operations may not be possible if the
folder type is marked as inactive.
Can Contain Determines whether the folder type can hold any assets or not.
Assets If set to TRUE, then folders of this folder type can hold assets. If
set to FALSE, then folders of this folder type can hold folders
but not assets.
Restricted to Determines whether the folder type is of single parent type or
Have Single not. If set to FALSE, then the folder type can have more than one
Parent Parent. If set to TRUE, then the folder type cannot have more
than one Parent.
Are Container Determines whether the folder type is restricted or not. If set the
Children TRUE, then this folder type can only be a parent of the folders
Restricted specified in the List Of Allowed Child Types. If set to FALSE,
then this folder type can be a parent of any folder in the system
(including itself).
List Of Select the allowable child folder types.
Allowed Child
Types Note: Use the CTRL or SHIFT keys to select more than
one field.
b. To specify the User Groups that will be allowed to create folders of this
folder type, navigate to the Users Permitted to Create Folders section. In
the All User Groups box, click a User Group.

Note: Select the Select this option to include sub groups check box to
include subgroups. Clear the check box if you do not want to include
subgroups.

Tip: The User Group is added to the User Groups Permitted to


Create Folders of this Folder Type box. To remove a User Group
from this box, click that is adjacent to the User Group name.
c. Click Save.
4. To delete a folder type, click the icon next to the folder type you want to
remove, and click OK in the confirmation dialog box.

Note: You can only delete a folder type when no folders of this type have
been created.

72 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.6. Templates

2.6.2 Property Templates (Metadata Profiles)


Property Templates, also known as Metadata Profiles, contain information
comprised of asset properties, Security Profiles, and User Groups. This data is
recorded onto a template and displayed on the Property Templates page. From this
page, you can create, edit, duplicate, and delete content from an asset's profile.

After importing assets through the Bulk Import Utility or Adobe® Drive, Property
Templates are used to apply information to the imported assets.

2.6.2.1 Creating Property Templates

To create a Property Template:

1. On the top-level menu, click Templates > Property templates. The Property
template page appears.

2. Click New property template.

3. On the Info tab, enter the Name of the Property Template.

4. On the Properties tab, choose a property model to assign to the Property


Template.

5. Enter property values for the Property Template.

6. On the Security tab, select the check boxes of the security policies that you want
to assign to the Property Template.

7. On the User Groups tab, in the Select User Groups box, choose the User
Groups that you want to assign to the Property Template.

Notes

• Select the Select this option to include sub groups check box to include
subgroups. Clear the check box if you do not want to include
subgroups.
• The User Group is added to the Allowed User Groups box. To remove a
User Group from this box, click that is adjacent to the User Group
name.
• Only users who belong to the User Group listed in the Allowed User
Groups box will be able to use the Property Template

8. Click Save.

A refreshed listing of Property Templates appears with a message verifying that the
Property Template was created.

OpenText Media Management – Administration Guide 73


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.6.2.1.1 Cascading list limitations for new Property Templates

The following are limitations for cascading lists when creating Property Templates:

• You cannot set the values for cascading lists in a tabular metadata field for a
Property Template.
• You cannot create a Property Template where the model contains “required”
fields in a tabular field with a cascading list.

2.6.2.2 Editing a Property Template


To edit a Property Template:

1. On the top-level menu, click Templates > Property templates.


The Property templates page displays all the existing Property Templates.

2. Under the Actions column, click the Edit link next to the Property Template
you want to edit.
The Edit Property Template page displays the Info, Properties, Security, and
User Groups tabs.

3. On the Info tab, edit the Name of the Property Template if desired.
The Info tab also displays the following display-only fields.
Table 2-10: Info Tab Display-Only Fields

Field Description
ID The identification number automatically
assigned to the Property Template.
Model The property model applied to the
Property Template.
Created By The user who created the Property
Template.
Date Created The date that the Property Template was
created.
Date Last Modified The date when the Property Template was
last modified.

4. On the Properties tab, change the property model assigned to the Property
Template, and edit the model's associated properties.

5. On the Security tab, select the new security policies you want to assign to the
Property Template.

6. On the User Groups tab, select the new user group that you want to assign to
the Property Template.

74 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.6. Templates

Note: Select the Select this option to include sub groups check box to
include subgroups. Clear the check box if you do not want to include
subgroups.

7. Click Save.

A refreshed listing of Property Templates displays with a message verifying that


your changes were saved.

2.6.2.3 Duplicating a Property Template

To duplicate a Property Template:

1. On the top-level menu, click Templates > Property templates.


The Property templates page displays all the existing Property Templates.

2. Under the Actions column, click the Duplicate link next to the Property
Template you want to copy.

3. On the Info tab, and edit the Name of the Property Template as required.

4. On the Properties tab, change the property model assigned to the Property
Template, and edit the model's associated properties.

5. On the Security tab, select the new security policies you want to assign to the
Property Template.

6. On the User Groups tab, select the new user group that you want to assign to
the Property Template.

Note: Select the Select this option to include sub groups check box to
include subgroups. Clear the check box if you do not want to include
subgroups.

7. Click Save.

2.6.3 Preference Templates


The Preference Templates feature allows administrators to create a template of
preferences to be used when creating new user accounts. Preferences for users
include individual preferences for searching, importing, and viewing. Using this
feature enables administrators to create a template based on the preferences of a
particular user and they can use that template to create the preferences for new
users. The Preference Templates created here will be available in the Apply
Preference list when creating a new user. For more information, see “Users”
on page 55. The following table lists the fields and buttons that appear on this page.

OpenText Media Management – Administration Guide 75


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

Table 2-11: Preference Template fields and buttons

Field/Button Description
Name The name applied to the template. This name
appears on the Create New User/Edit User
page in the Apply Preference selection list.
Description Description that is assigned to the template
being created.
Login name The OTMM sign-in ID that the preferences
are copied from to create the template.
New preference template Creates the Preference template.
Edit link Edit the Preference template.
Delete icon Delete the Preference template.

2.6.3.1 Creating a Preferences Template


To create a Preference Template:

1. On the top-level menu, click Templates > Preference templates.

2. On the Preference templates page, click New preference template.

3. On the Info tab, specify the following:

• Preference Template Name


• Preference Template Description
• Login Name to Copy

4. Click Save.

2.6.3.2 Managing Preference Templates


To manage Preference templates:

1. On the top-level menu, click Templates > Preference templates.

2. To edit the description of a Preference template, in the Actions column, click its
Edit link, and do the following:

a. Click the Info tab.


b. Edit the description.
c. Click Save.

3. To edit the user groups of a Preference template, in the Actions column, click its
Edit link, and do the following:

a. Click the UserGroup tab, select the check box to include subgroups.

76 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.6. Templates

b. In the Select User Groups box, click the user group that you want to assign
to the Preference template.
c. In the Available User Groups box, verify that the user groups that you
want to assign to the template are listed.
d. Click Save.

4. To delete a Preference template, click the icon next to the template you want
to remove, and click OK in the confirmation dialog box.

2.6.4 Advanced Search configurations


In the Media Management Web Client, users can perform an Advanced Search,
which is a more flexible and powerful search. All the search parameters and
available search fields are defined by an administrator in an Advanced Search
Configuration. Administrators can define different Advanced Search configurations
for different groups of users.

Note: The Advanced Search Configuration utility is accessible only to system


administrators and is not controlled or managed by FETs. All default
Advanced Search configurations can be edited and deleted. For more
information about how to make an Advanced Search Configuration “read-
only”, see section 3.4 “Modifying Advanced Search configurations to be read-
only” in OpenText Media Management - Integration Guide (MEDMGT160300-
AIN).

2.6.4.1 Creating a new search configuration


To create a new search configuration:

1. On the top-level menu, clickTemplates > Advanced search.

2. On the Advanced search configurations page, click New search configuration.

3. In the Search Properties area, do the following:

a. In the Name box, enter a name.


b. In the Description box, enter a description.
c. In the Is Keyword Search Allowed list, choose whether Keyword Searches
are allowed or not. If you choose TRUE, in the Media Management Web
Client, users performing an Advanced Search will have a keyword input
box available for their search.
d. In the Allowable "Search Within" Contexts list, choose whether the
Advanced Search Configuration can be used when restricting search results
within a folder. Advanced Search configurations can allow no restrictions
or can allow restrictions to folders only.
e. In the Facet configuration list, choose the facet configuration that will be
used to generate facet information when searches are performed using this
Advanced Search configuration. If you do not choose a facet configuration,
the facet configuration specified in the

OpenText Media Management – Administration Guide 77


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

DEFAULT_FACET_CONFIGURATON_NAME setting will be used. This setting is


located under the UX\GENERAL component, which belongs to the API
Configuration configuration group. For more information, see “Editing a
component and properties” on page 136.
f. In the Select User Groups, choose the User Groups that the Advanced
Search Configuration will be available to by choosing any User Group
within the Select User Groups box to add it to the list in the Allowed User
Groups box.

Notes
• Select the Select this option to include sub groups check box to
include subgroups. Clear the check box if you do not want to
include subgroups.
• To remove a User Group, navigate to the Allowed User Groups
box, and click that is adjacent to the User Group name that you
want to remove.
4. The Candidate Fields List section displays the search fields which users will
have available to them when configuring an Advanced Search. They will be able
to select search fields from this list and add them to their Advanced Search,
creating more robust search criteria. An Advanced Search Configuration form is
required to have at least one searchable field selected.

a. Click the Add Another Field link to add a searchable field to the list.
b. Select a field from the list and specify if it should be Selected for First Time
Use. Fields selected for first time use will appear in the Advanced Search
facility the first time a user selects to use this Advanced Search
Configuration. The result is that the user will not see a blank Advanced
Search facility upon the first usage. The user can then override these pre-
selections.

Notes
• The fields listed in the Candidate Fields List and the Fixed Search
Conditions are mutually exclusive; you cannot have the same fields in
both. The same is also true for fields within the same Tabular Field
Group. Different fields from within the same Tabular Field Group
cannot be used in both the Candidate Fields List and Fixed Search
Conditions.
• The list of fields populated in the Candidate Fields List area are
searchable fields available in the system. Non-searchable fields are
filtered out and therefore cannot be used in Advanced Search
configurations. Similarly, CLOB and BLOB fields of type are also be
filtered out as the data stored in those fields is not indexed and cannot
be searched.
5. In the Fixed Search Conditions section, specify the search conditions that are
included when using this search template. These are search conditions which
are part of the search but not visible to the end user.

78 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.6. Templates

a. Click the Add A New Row link to add a new row to the search conditions.
b. Select the desired field or tabular field group from the list to use for the
search condition. Tabular field group names in the list are surrounded by
square brackets. Depending upon the data type of the field selected, the
comparison operators and values will change to reflect valid choices for the
selected field.

• Use left and right parenthesis to override or define your own evaluation
of operator precedence. For example:
( (SEX=MALE) OR (SEX=FEMALE) ) AND (AGE .GT. 18)
In this expression, the OR condition is evaluated first and then the AND
Condition is evaluated.

Note: When using the “contains” or “does not contain” search


operator in a fixed search condition, if multiple search terms are
entered, explicitly enter a connecting Boolean operator between the
terms (AND/OR). Do this instead of allowing the system to
automatically provide a default operator because the default operator
used may change in the future if the DEFAULT_OPERATOR setting is
modified. This setting is located under in the SEARCH\SERVER
component, which belongs to the Search configuration group. For
more information, see “Settings” on page 130.
c. If a tabular field group is selected for the search condition, for example the
Participant All Tasks Assignments, enter one or more sub conditions
against fields from that tabular field group. The PROPERTY selection is
automatically populated with the fields specific to this tabular field group.

Notes
• The fields listed in the Candidate Fields List and the Fixed Search
Conditions are mutually exclusive; you cannot have the same fields in
both. The same is also true for fields within the same Tabular Field
Group. Different fields from within the same Tabular Field Group
cannot be used in both the Candidate Fields List and Fixed Search
Conditions.
• The list of fields populated under the Fixed Search Conditions area are
searchable fields available in the system. Non-searchable fields are
filtered out and therefore cannot be used in Advanced Search
configurations. Similarly, CLOB and BLOB fields of type are also be
filtered out as the data stored in those fields is not indexed and cannot
be searched.
6. Click Save to return to the Advanced search configurations main page.

OpenText Media Management – Administration Guide 79


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.6.4.2 Managing search configurations


To manage search configurations:

1. On the top-level menu, click Templates > Advanced search.

Note: Assets, Folders, and Users are default Advanced Search


configurations for OTMM.

2. To view a search configuration, click the View link.

3. To delete a search configuration, click the icon.

4. To edit a search configuration, click the Edit link.

5. On the Advanced search configurations page, in the Search Properties area, do


any of the following:

• In the Name box, enter a name of the Advanced Search.


• In the Description, enter a description of the Advanced Search.
• In the Is Keyword Search Allowed list, choose whether Keyword Searches
are allowed or not. If you choose to TRUE, then in the Media Management
Web Client, users performing an Advanced Search will have a keyword
input box available for their search.
• In the Allowable "Search Within" Contexts list, choose whether the
Advanced Search Configuration can be used when restricting search results
within a folder. Advanced Search configurations can allow no restrictions or
can allow restrictions to folders only.
• In the Facet configuration list, choose the facet configuration that will be
used to generate facet information when searches are performed using this
Advanced Search configuration. If you do not choose a facet configuration,
the facet configuration specified in the DEFAULT_FACET_CONFIGURATON_NAME
setting will be used. This setting is located under the UX\GENERAL
component, which belongs to the API Configuration configuration group.
For more information, see “Editing a component and properties”
on page 136.
• In the Select User Groups, choose the User Groups that the Advanced
Search Configuration will be available to by choosing any User Group
within the Select User Groups box to add it to the list in the Allowed User
Groups box.

Note: Select the Select this option to include sub groups check box to
include subgroups. Clear the check box if you do not want to include
subgroups.
To remove a User Group, navigate to the Allowed User Groups box,
and click that is adjacent to the User Group name that you want to
remove.

80 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.6. Templates

6. The Candidate Fields List area displays the search fields which users will have
available to them when configuring an Advanced Search. They will be able to
choose search fields from this list and add them to their Advanced Search,
creating more robust search criteria. An Advanced Search Configuration form is
required to have at least one searchable field selected.

a. Click the Add Another Field link to add a searchable field to the list.
b. Select a field from the list and specify whether it should be Selected for
First Time Use. Fields selected for first time use will appear in the
Advanced Search facility the first time a user uses this Advanced Search
Configuration. The result is that the user will not see a blank Advanced
Search facility upon the first usage. The user can then override these pre-
selections.

7. In the Fixed Search Conditions area, specify the search conditions that are
included when using this search template. These are search conditions which
are part of the search but not visible to the end user.

a. Click the Add A New Row link to add a new row to the search conditions.
b. Select the desired field or tabular field group from the list to use for the
search condition. Tabular field group names in the list are surrounded by
square brackets. Depending upon the data type of the field selected, the
comparison operators and values will change to reflect valid choices for the
selected field.

• Use left and right parenthesis to override or define your own evaluation
of operator precedence. For example:
( (SEX=MALE) OR (SEX=FEMALE) ) AND (AGE .GT. 18)
In this expression, the OR condition is evaluated first and then the AND
condition is evaluated.

Note: When using the “contains” or “does not contain” search


operator in a fixed search condition, if multiple search terms are
entered, you should explicitly enter a connecting Boolean operator
between the terms (AND/OR) instead of allowing the system to
automatically provide a default operator because the default operator
used may change in the future if the DEFAULT_OPERATOR setting is
modified. This setting is located under the SEARCH\SERVER
component, which belongs to the Search configuration group. For
more information, see “Editing a component and properties”
on page 136.
c. If a tabular field group is selected for the search condition (for example the
Participant All Tasks Assignments), enter one or more sub conditions
against fields from that tabular field group. The PROPERTY selection is
automatically populated with the fields specific to this tabular field group.

Note: The fields listed in the Candidate Fields List and the Fixed Search
Conditions are mutually exclusive, which means you cannot have the

OpenText Media Management – Administration Guide 81


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

same fields in both. The same is also true for fields within the same
Tabular Field Group. Different fields from within the same Tabular Field
Group cannot be used in both the Candidate Fields List and Fixed Search
Conditions.

8. Click Save to return to the Advanced Search Configurations main page.

2.7 Utilities
The Utilities options allow you to manage the Recycle Bin, release locks, clear
caches, regenerate the Tasset.dtd file and resubmit failed video import jobs.

2.7.1 Recycle Bin


The Recycle Bin holds assets that users have marked for deletion. Administrators
can undelete assets in the Recycle Bin or permanently purge them from the system.
Other users who have access to the recycle bin will only be able to work with assets
to which they are granted delete permission by a security policy.

Click Utilities > Recycle bin from the top-level menu. The Recycle bin page shows
the status of recent Purge All events and provides options to perform Purge All,
Undelete All or Search Criteria for Pagination of deleted assets. The following table
lists the fields and buttons that appear on this page.

Notes

• When purging video assets, all the associated clip assets are also purged.
• You can sort the Name, ID, Content Type, Date Deleted, Deleted By, and
What’s Deleted columns by ascending or descending order. To do this, click
the title of the column, then click the arrow to sort by ascending or
descending order.

Table 2-12: Recycle Bin Page Fields and Buttons

Field/Button Description
Purge All link Provides a quick way to purge all of the
deleted assets from the system.

This includes assets deleted by all users.


For administra-
tors
For non-admin- If the
istrative users
UTILITIES.RECYCLE_BIN.PURGE_RECOV
ER_ALL FET is enabled in combination with
UTILITIES.RECYCLE_BIN.PURGE or
UTILITIES.RECYCLE_BIN.RECOVER FET
for a role, users who belong to this role can
purge or undelete the assets that have been
deleted by other users.

82 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.7. Utilities

Field/Button Description
Undelete All link Provides a quick way to undelete the deleted
assets in the system. For administrators, this
includes assets deleted by other all users. For
non-administrators, it only includes assets
deleted by that user.
Refresh Purge All Status link Refreshes the current Recycle bin page. This
is useful after click Purge All. This also clears
the Search Context and its result.
Search by/Search/Clear Search buttons Search for specific assets by ID or by name.

Notes
• Multiple asset IDs can be specified at
the Search prompt separated by
commas. The search type should be
"Asset Ids".
• The asterisk (*) can be used to
retrieve all the deleted assets where
the search type is “Asset Name”.
• The results includes assets which are
in the deleted state.
Select box Check this box to select the asset.
Name The name of the deleted asset.
ID The ID of the deleted asset.
Content Type The content type of the deleted asset. For
folders, the Content Type will be displayed
as FOLDER and the What's Deleted will be
displayed as FULL.
Date Deleted The date the asset was deleted.
Deleted By The user who deleted this asset.
What's Deleted Assets marked for complete deletion will
display as FULL. Assets marked for content
deletion, partial deletion, or selective
deletion will display as PARTIAL.
Purge Button Permanently removes the selected asset or
assets from the repository.
Undelete Button Removes the deleted designation and returns
the asset back to its normal state.

OpenText Media Management – Administration Guide 83


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.7.1.1 Purging individual deleted assets


Assets that you purge are removed from the OTMM repository.

To purge individual deleted assets:

1. Select assets that you want to purge from the list.

2. Click Purge.

2.7.1.2 Bulk Purge utility


The Bulk Purge command line utility allows administrators to purge assets in bulk
from the Recycle Bin. This utility, which can be executed as a scheduled job, removes
assets on a first-in-first-out (FIFO) basis. Configure the total number of assets to be
purged during each execution using the optional “count” parameter (or all assets
can be purged by skipping this parameter).

The Bulk Purge utility, bulkpurge.bat for Windows or bulkpurge.sh for Linux,
are located in the <TEAMS_HOME>/bin folder. The usage is as follows:

WINDOWS
bulkpurge.bat —user <user> —password <password> —count <count>

LINUX
bulkpurge.sh —user <user> —password <password> —count <count>

where:

<user>
Is the OTMM user.

<password>
Is the OTMM user password.

<count>
Is the number of assets to be purged in the current run. This is an optional
parameter. Skip this parameter to purge all assets in the Recycle Bin.

2.7.1.3 Undeleting assets


Assets are removed from the Recycle Bin after they have been purged or restored.

To undelete assets:

1. Select the assets that you want to undelete from the list.

2. Click Undelete.

The selected assets are returned to their normal, unlocked, state.

84 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.7. Utilities

2.7.2 Releasing locks


When a user checks out or edits an asset, OTMM locks the asset so that no other user
can edit its content or properties. The Release Locks feature allows an administrator
to override this lock and free the asset for check-out or editing by others.

To access this feature, click Utilities > Release locks from the top-level menu. The
ReleaselLocks page opens with a list of assets that are currently locked.

Tip: You can sort any column in ascending or descending order. If you ran a
search, sorting applies to the search results only. Clear your search to apply the
sort order to all locked assets.

The following table lists the fields and buttons that appear on this page.

Table 2-13: Release Locks Page fields and buttons

Field/Button Description
Release All link Provides a quick way to unlock all of the
locked assets from the system, irrespective of
the Release Locks page.

ItFor
releases all the locked assets in the system,
administra-
tors including assets locked by
other users.

ItFor
releases assets that were locked by that
non-admin-
istrative users user and other users. If the
UTILITIES.RELEASE_LOCKS.VIEW and
UTILITIES.RELEASE_LOCKS.ALL FETs are
enabled for a role, users who belong to this
role can see the assets locked by all users. If
these FETs are disabled, then only assets
locked by that user are shown.
Refresh link Refreshes the list of locked assets.
Search by list/Search/Clear Search buttons Search for specific assets by ID, name, or lock
owner. Enter the search criteria in the box,
and click Search. Click Clear search to clear
the search results.
Select Check this box to select an asset to unlock.
Name The name of the locked asset.
Content Lock Owner The name of the user responsible for locking
the asset content.
Content Lock Date The date and time the asset content was
locked.
Metadata Lock Owner The name of the user responsible for locking
the asset metadata.

OpenText Media Management – Administration Guide 85


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

Field/Button Description
Metadata Lock Date The date and time the asset metadata was
locked.
ID The asset ID of the locked asset.
Release button Unlocks the selected asset or assets.

Note: If the content and metadata of an asset are both locked, when you
release either of these locks, both locks are automatically released.

2.7.2.1 Releasing locked assets


To release locked assets:

1. Select one or more assets to unlock from the List of Locked Assets on the
Release locks page.

2. Click Release.
The selected assets are unlocked.

3. Optional Select Release All to unlock all locked assets which the user has
permissions for in the system.

Note: If the content and metadata of an asset are both locked, as system
administrator, you can release both the locks irrespective of who the content or
metadata lock owner is. A non-administrator user can release asset content and
metadata locked by other users only if the UTILITIES.RELEASE_LOCK.ALL
FET is enabled for that user's role. If the non-administrator user do not have
this FET, they can only release locks that they own.

2.7.2.2 Refreshing locked assets


To refresh locked assets:

• On the Release locks page, click the Refresh link.

The table listing of all currently locked assets is refreshed.

86 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.7. Utilities

2.7.3 Clearing caches


The Clear Caches process provides the ability to clear the cache while users are
active in the OTMM application.

To clear the cache:

1. On the top-level menu, click Utilities > Clear caches.

2. On the Clear caches page, click Clear caches.

You will receive a confirmation message stating that you Successfully signaled
Media Management servers and clients to clear their caches.

2.7.4 Regenerating Tasset file


The Tasset.dtd file contains complete list of metadata attributes in the system. You
can regenerate the Tasset.dtd file to update it with newly added metadata
attributes.

To regenerate the Tasset.dtd file:

1. On the top-level menu, click Utilities > Regenerate tasset file.

2. Click Regenerate Tasset File.

2.7.5 Resubmitting a failed audio or video import job


If an audio or video transcode job failed while importing an asset, you can resubmit
the transcode job. Users will see Completed with errors as the status, on their My
Jobs page. From the Web Administration tool, you can find the asset on the
Resubmit Failed Videos page and resubmit the transcode job for the assets that you
select.

To resubmit a failed import job:

1. On the top-level menu, click Utilities > Regenerate video proxies.

2. On the Resubmit Failed Videos page, do the following:

a. Choose to search by Asset Name or Import User.

b. Enter the name of the asset or user in the box, and then click Search.

3. Select the check box of the asset that you want to resubmit, and then click
Submit Video.

Note: If you click Ignore, the assets you selected will be deleted from the
Resubmit Failed Videos page.

OpenText Media Management – Administration Guide 87


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.8 Required field behavior


When creating required fields, you should be aware of the following behavior in
Media Management.

Data Type Required = No Required = Yes


Simple text fields Can be blank. Enter at least one
character.
Date Can be blank. Date should be
selected.
Dropdown Can be blank (unless the combo is not One value should
null). be selected.
Tabular Row can be empty. At least one row
and the required
fields must be
populated.
Cascading Levels can be empty. All levels must be
populated.

2.9 YouTube
Using YouTube configuration, you can map a YouTube channel to a delivery
template to upload videos to YouTube.

To do this, you need the following prerequisites:


• Google account
• YouTube channel associated with the Google account

For more information about the YouTube transformer delivery template, see section
5.6.4.2 “YouTube transformer delivery template” in OpenText Media Management -
Integration Guide (MEDMGT160300-AIN).

Note: This option is enabled for administrative users and users who have the
YOUTUBE_CONFIGURATION FET enabled.

88 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.9. YouTube

2.9.1 Setting up authorization for the YouTube Data API


The application must have authorization credentials to use the YouTube Data API.
As administrator, you can create authorization credentials from the Google
Developers Console.

To set up authorization:

1. On the top-level menu, click YouTube > Authorization setup.

2. Sign in to the Google Developers Console.

3. On the Projects page, do the following:

a. Click Create Project.


b. Enter a name for your project and click Create.

4. On the API Manager Overview page, do the following:

a. Navigate to the YouTube APIs list and click YouTube Data API.
b. Click Enable.
c. Click Go to Credentials.

5. To add credentials to your project, on the API Manager Credentials page, do


the following:

a. In the Which API are you using? list, choose YouTube Data API v3.
b. In the Where will you be calling the API from? list, choose Web browser
(Javascript).
c. In the What data will you be accessing? area, click User data.
d. Click What credentials do I need?

6. To set up OAuth 2.0 credentials, on the API Manager Credentials page, do the
following:

a. In the Name box, enter the name of the web application that your
organization requires.
b. In the Authorized JavaScript origins box, enter the fully qualified host
name of your system. For example:
http://<hostname.domainName>:<port-number>
c. In the Authorized redirect URIs box, enter a URL using the following
format:
http://<hostname.domainName>:<port-number>/teams/do/
SaveYouTubeConfiguration
d. Click Create client ID.

7. To set up the OAuth 2.0 consent screen, on the API Manager Creditials page,
enter the relevant information, and then click Continue.

OpenText Media Management – Administration Guide 89


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

8. On the API Manager Creditials page, click Download to download the


credentials that are displayed on the Download Credentials page.

9. To complete the process and return to the Credentials page, click Done.

2.9.2 Mapping a YouTube channel to a delivery template


The Map YouTube account to Delivery template page lists Delivery Templates that
are mapped to YouTube Accounts.

To map a YouTube channel to a delivery template:

1. Clear the browser cache.

2. Set the URL of the browser as the URL that you specified in Step 6.b on page 89.

Note: If you are using a local host as your server, use the fully qualified
name of the server where the OTMM Administration tool is hosted.

3. In the OTMM Web Administration tool, on the top-level menu, click YouTube >
Map to delivery template.

4. On the Map YouTube account to Delivery template page, do the following:

a. Click New YouTube Configuration to map a delivery template to a


YouTube Channel.

b. In the Delivery Template Name list, choose a delivery template.

c. In the YouTube Channel Email ID box, enter the authorized Google email
ID.

d. In the Client secrets file list, choose the secret JSON file that you
downloaded from the Google Developers Console in Step 8 on page 90.

e. Click Save.

5. Sign in to the Google Sign-in page using the credentials for which you
authorized setup for the YouTube Data API.

6. Click Allow to map the YouTube channel to the delivery template.

Tip: The User granted access to your application message displays if the
mapping is successful.

7. Return to the OTMM Web Administration console and refresh the Map
YouTube account to Delivery template page to verify that the template is
mapped to the YouTube channel.

90 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.10. Configurations

2.9.3 Deleting a YouTube mapping


The Map YouTube account to Delivery template page lists Delivery Templates that
are mapped to YouTube Accounts.

To delete a YouTube mapping:

1. On the top-level menu, click YouTube > Map to delivery template.

2. On the Map YouTube account to Delivery template page, navigate to the


mapping that you want to delete and click .

2.10 Configurations
Using the Configurations menu, you can manage configurations for transformers,
content types, mime types, brands, and facets.

2.10.1 Transformers
The Transformers page provides a list of all the transformers, including your
custom transformers. You can search for a transformer and view a transformer. You
can also create, edit, and delete custom transformers.

Note: You can perform the tasks in the following sections if you are an
administrative user or if you have been granted the MANAGE_TRANSFORMERS
FET.

2.10.1.1 Managing transformers


To manage transformers:

1. On the top-level menu, click Configurations > Transformers.

2. On the Transformer page, do any of the following:

To Do this
To find a transformer Enter the name of the transformer in the
search box, and click .
To view the details, attributes, and Navigate to the row of that transformer
configuration attributes of a transformer and click View.
To add a custom transformer Click New Transformer. For more
information, see “Adding custom
transformers” on page 92
To edit a custom transformer Navigate to the row of that transformer,
click Edit, edit the transformer as required,
and click Save.
To delete a custom transformer Navigate to the row of that transformer,
and click Delete.

OpenText Media Management – Administration Guide 91


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

Note: When you create or edit a custom transformer, do not use the ARTESIA
prefix for the ID, such as the Transformer ID. The system transformers are
always prefixed with ARTESIA. By using a different prefix, you avoid the
possibility of duplicating and overwriting system transformers and customer
transformers, in future upgrades. Also, you can distinguish between custom
and pre-configured transformers.

2.10.1.2 Adding custom transformers


To add a custom transformer:

1. On the top-level menu, click Configurations > Transformers.

2. On the Transformer page, click New Transformer.

3. On the New transformers page, do the following:

a. In the Transformer ID box, enter the ID for the transformer.


b. In the Name box, enter the name of the transformer.

Note: This name will be displayed in the user interface.

c. In the Description box, describe the transformer.


d. In the Implementation class box, register a class that is implemented using
the Transformer plugin framework.

Note: The implementation class is a fully qualified class name of a


Java class that implements the appropriate transformer interface. For
more information, see section 5.7.2.1 “Java-based transformer
interface” in OpenText Media Management - Integration Guide
(MEDMGT160300-AIN).
e. In the Transformer executable box, enter the transformer executable name
without the path. Generally this file is placed in a folder relative to the
<TEAMS_HOME> directory.

Notes
• If this executable is hardcoded in a transformer, you do not need to
mention the executable.
• If the transformer externalizes the executable, enter the executable
in the Transformer executable box. If, at a later time, the executable
changes, you can change the executable name in this box. You do
not need to change the transformer class. For example, if this is an
image transformer and the executable is magick. Later the
executable is changed to magicX, change the configuration
Transformer executable box. You do not need to change the source
code in the Transformer class because the variable is referenced as
one of the settings.

92 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.10. Configurations

f. In the Working directory box, enter the location where the intermediary
files are stored and handed to the Transformer.

Note: This directory is relative to <TEAMS_HOME>. It is a type of


staging directory where intermediary files are stored and handed to
the Transformer class. For more information, contact your services
team.
4. In the Type area, select one or more of the following Transformer types that are
applicable to the current Transformer:

• Import to add an asset-level import transformer that is used at the time of


import.
• Export Job to add a job-level Transformer that acts on a set of exported
assets after the export job is processed.

Tip: This transformer handles post-export transformations, such as a


ZIP compression transformer.
• Export to add an asset-level export Transformer which is used at the time of
export.
• Named Location to add a Delivery Template-type Transformer which is
triggered after the export job is processed.

Tip: Delivery Template-type Transformer are triggered post-export to


deliver assets, such as emailing assets or delivering assets to a YouTube
channel.
5. Select the Enabled check box to activate the transformer and make it visible in
the Share assets dialog box in Media Management.

Note: If you clear the Enabled check box, the Transformer will not be
operational even after you register it.
6. Click Save.
7. On the Transformer details page, click the Details tab > Edit to change details,
as required, and then click Save.

Note: You can only edit the details of a custom transformers that you
implemented.
8. On the Transformer details page, click the Attributes tab > Add Attribute to
add attributes to the custom transformer, as required:

Notes
• When you create a transformer, you can create attributes and add them
to your respective custom transformer. Initially, you need to provide
required information, such as name. Then, you can add more
information as required, depending on the transformer.

OpenText Media Management – Administration Guide 93


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

• For delivery-type templates, these attributes are displayed in the Share


assets dialog box Media Management.

a. In the Name box, enter the name of the attribute.


b. In the Description box, enter a description for the attribute.
c. In the Default value box, enter the default value of the attribute.

Notes
• You can override this default value by adding an attribute through
the Instances tab. The Instances tab lets the transformer receive a
specific value.
For example, if there is an export transformer that can export assets,
where the width and height are configured as 20 and 30 pixels,
respectively, when they are configured through the Attributes tab.
However, while creating an instance, the width and height can be
changed to 50 and 80 pixels respectively. Other instances of the
same transformer can also vary the width and height.
d. In the Attribute option box, enter an option for the attribute.
e. In the Data Type list, choose Numeric, Read only, or Editable.
f. In the Display Mode list, choose Text String, Select List, Text area, Email
Address, Email Address List, or Password.
g. Select the Required check box if the value of the attribute is mandatory.
h. Click Save.

9. On the Transformer details page, click the Config Attributes tab > Add
Configuration Attribute to add custom configuration settings to transformers,
as required, and then click Save.

Notes
• The transformer class can use these configuration attributes as
initialization parameters. They are not used as transformer arguments,
but can be used to provide additional information or settings that might
be invoked when the transformations are applied.
• Configuration attributes are constants.

10. On the Transformer details page, click the Instance tab > New Instance to
create an instance of a registered transformer.

a. In the Id box, enter the ID of the transformer.


b. In the Name box, enter a name of the transformer.
c. In the Description box, provide a description for the transformer
d. Select the Content Downloadable check box to show the exported assets in
My Downloads and in the Download panel in Media Management.
e. In theFile Template box, enter the file template. For more information
about creating a file template, see section 5.6.3 “File Handling Template

94 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.10. Configurations

configuration” in OpenText Media Management - Integration Guide


(MEDMGT160300-AIN).

Note: Enter the File Template information only when you are
creating delivery templates.
f. To override the required transformer attributes value, click the Attributes
tab > New value, and then add the attribute name and value as required.
g. To control access to this delivery type transformer, also called a delivery
template, and do the following:

i. Click the User Groups tab.


ii. To permit all of the groups access. click All. This is chosen by default.
iii. To restrict access to a few user groups, click All, and then in the
Available User Groups box, click the name of the group to move it to
the choose Exempted User Groups box.
iv. To permit a few user groups, click None, and then in the Available
User Groups box, click the name of the group to move it to the choose
Exempted User Groups box.

Notes

• Only available for delivery type transformers


• Users belonging to the selected group can see the transformer
instance in the Share assets dialog box in Media Management
only.
h. Click Save.

Notes

• Each transformer must have a minimum of one transformer instance.


• Use the Instances tab when you need to create an instance of a
transformer.

2.10.1.3 Deleting a custom transformer


To delete a custom transformer:

1. On the top-level menu, click Configurations > Transformers.

2. On the Transformer page, navigate to the custom transformer that you want to
delete.

3. Click Delete.

4. Confirm that you want to delete the transformer.

OpenText Media Management – Administration Guide 95


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.10.2 Content Types


Content Type configuration allows you to register a new content type in OTMM.
You can map this content type to multiple export transformers.

In OTMM, each asset belongs to a specific content type. An asset is assigned to a


specific content type at the time of its ingestion based on its file extension. This is
driven by mime type mapping.

The process of exporting an assert requires export transformers to be mapped to a


content type. Based on the content type of the selected asset, the mapped
transformers are displayed as delivery formats in the Share assets dialog box. A
user can add the required delivery formats, allowing the assets to be delivered in
various formats.

This section contains information about managing, adding, deleting and editing
content types.

Note: You can perform the tasks in the following sections if you are an
administrative user or if you have been granted the MANAGE_TRANSFORMERS
FET.

2.10.2.1 Managing content types


To manage content types:

1. On the top-level menu, click Configurations > Content Types.

2. On the Content types page, do one of the following:

To Do this
To find a content type Enter the name of the content type in the
search box, and click .
To view the details of a content type or to Navigate to the row of that content type
view the registered transformers for and click View.
export
To create a content type Click New Content Type. For more
information, see “Adding content types”
on page 97.
To edit a content type, or add and register Navigate to the row of that content type,
its transformer for export click Edit, make the changes as required,
and click Save. For more information, see
“Editing content types” on page 97.

Tip: Registering transformers for


export for a content type means that
those transformers will operate on
assets of this content type during the
export process.

96 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.10. Configurations

To Do this
To delete a content type Navigate to the row of that content type,
and click Delete.

2.10.2.2 Adding content types


To add a content type:

1. On the top-level menu, click Configurations > Content Types.

2. To create a content type, click New Content Type.

3. In the Content Type box, enter the name of the content type.

4. In the Name box, enter a meaningful name for the content type.

5. In the Description box, provide a description for the content type.

6. In the Register Transformer for Export area, do the following to associate this
content type to a transformer:

a. Click Add Transformer.


b. In the list, choose the name of a transformer.

7. Click Save.

2.10.2.3 Editing content types


To edit a content type:

1. On the top-level menu, click Configurations > Content Types.

2. Do one of the following:

• Enter the name of the content type in the search box, and click . Navigate
to the name of the content type, and click Edit.
• Navigate to the row of that content type, click Edit.

3. In the Description box, edit the description of the content type.

4. In the Register Transformer for Export area, do the following to edit the
transformer that is associated with this content type:

a. To add a transformer, click Add Transformer. In the list, choose the name
of a transformer.
b. To remove the registration of the transformer, navigate to that transformer
and click Delete.

5. Click Save.

OpenText Media Management – Administration Guide 97


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.10.2.4 Deleting content types

To delete a content type:

1. On the top-level menu, click Configurations > Content Types.

2. On the Content Types page, navigate to the row of the content type that you
want to delete, and click Delete.

Note: The content type will be deleted from the system if no related assets
are present. Otherwise, you will see an error message.

3. Confirm the deletion.

2.10.3 Mime Types


Mime Type configuration allows you to add a new Mime type to OTMM. You can
register a content type and different file extensions for a mime type. OTMM qualifies
an ingested asset to be of a certain content type and mime type based on the
ingested file extension and the mime type configuration. Also, this configuration
allows you to add multiple import transformers that are executed at the time of
import.

Note: You can perform the tasks in the following sections if you are an
administrative user or if you have been granted the MANAGE_TRANSFORMERS
FET.

2.10.3.1 Managing mime types

To manage mime types:

1. On the top-level menu, click Configurations > Mime Types.

2. On the Mime types page, enter the name of the mime type in the search box,
and click .

3. To view the mime type details, and import transformer registered for that mime
type, navigate to the row of that mime type, and then click View.

4. To create a mime type, click New Mime Type. For more information, see
“Adding mime types” on page 99.

5. To edit a mime type, navigate to the row of that mime type, click Edit, edit the
mime type as required, and click Save. For more information, see “Editing
mime types” on page 99.

6. To delete a mime type, navigate to the row of that mime type, and click Delete.
For more information, see “Deleting mime types” on page 100.

98 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.10. Configurations

2.10.3.2 Adding mime types


To add a mime type:

1. On the top-level menu, click Configurations > Mime Types.

2. On the Mime types page, click New Mime Type.

3. On the Add new mime type page, in the Name box, enter the name of the mime
type.

4. In the Description box, describe the mime type.

5. In the Content Type list, choose a content type.

6. In the File Extensions area, do the following:

a. Click New extension.


b. Add the extension that you want to associate with this mime type

Note: Use lower case letters, and do not add a period (.) before the file
extension.
c. Repeat Step 6 for each file extension that you want to associate with the
mime type.

7. Click Save.

8. On the Mime type details page, click the Import Transformers tab, and then
click Add Transformer.

9. In the Transformer Id column, choose a transformer ID from the list.

10. In the Pre Execution Class column, enter the business class that needs to be run
before executing the transformer.

11. Click Save.

12. Arrange the transformers by dragging them to their required position.

2.10.3.3 Editing mime types


To edit a mime type

1. On the top-level menu, click Configurations > Mime Types.

2. Navigate to the row of the mime type that you want to edit and click Edit.

3. On the Edit mime type page, in the Content Type list, choose the content type
you want.

4. In the File Extensions area, do any of the following:

a. Click New extension and add the extension that you want to associate with
this mime type

OpenText Media Management – Administration Guide 99


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

Note: Use lower case letters, and do not add a period (.) before the file
extension.
b. To delete a file extension, navigate to its row, and click Delete.
5. Click Save.

2.10.3.4 Deleting mime types


To edit a mime type

1. On the top-level menu, click Configurations > Mime Types.


2. Navigate to the row of the mime type that you want to delete and click Delete.
3. Confirm that you want to delete the mime type.

2.10.4 Interval profiles


Interval profiles are configured to be used with interval facets. You can create two
types of interval profiles, numeric and date, which can be used with numeric and
date facets respectively. Both types of profiles contain a user-defined list of intervals.
These intervals are then used to generate facets.

2.10.4.1 Creating interval profiles


To create an interval profile:

1. On the top-level menu, click Configurations > Interval profiles.


2. Click New interval profile configuration.
3. In the Interval Profile Properties area, do the following:

a. In the Type list, choose NUMERIC or DATE.


b. In the ID box, enter a unique interval profile ID.

Note: After you save the interval profile configuration, you cannot
change the Type or ID of the profile.
c. In the Name box, enter a unique interval profile name.
d. In the Description box, enter a description for the interval profile.

Note: Interval Type, ID and Name are required fields.

4. In the Interval List area, define the intervals for the facets that you want to
generate.
The following properties apply to all interval types.

• Sequence
Specifies the order in which intervals will appear on the Facets Panel.
Sequence numbers are assigned automatically as new intervals are

100 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.10. Configurations

configured. However, you can manually update the sequence numbers to re-
configure the order in which intervals should appear. If you do this, you
must assign each interval a unique sequence number.
• Display Label
Specifies the label that will be used to represent that interval on the Facets
Panel.

Note: You must provide a Display Label for each interval.

• Numeric interval profile


The following properties are specific to the numeric-type of interval profile.
They control the start value of the interval, the end value, and whether both
values are inclusive or exclusive.

Note: You must provide a Start Value and End Value, otherwise, the
interval will be invalid.

• Start Value
A numeric value for the start of the interval. If you leave this empty, the
interval will be considered an open-ended interval. A numeric interval
with an open start value will include all values less than (or less than or
equal to) the End Value.
• Inclusive (Start)
A filled circle indicates that the Start Value is inclusive. Conversely, an
empty circle indicates that the Start Value is exclusive.
• Inclusive (End)
A filled circle indicates that the End Value is inclusive. Conversely, an
empty circle indicates that the End Value is exclusive.
• End Value
A numeric value for the end of the interval. If you leave this empty, the
interval will be considered an open-ended interval. A numeric interval
with an open end value will include all values greater than (or greater
than or equal to) the Start Value.

• Date Interval Profiles


The following properties are specific to the date-type of interval profile.
They control the start and end values of the date interval.

Notes
• If you leave the Start Value and End Value empty, the interval will
be invalid.
• The start date of the date interval is inclusive and the end date is
exclusive.

OpenText Media Management – Administration Guide 101


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

• Start Value
The start date of the date interval. If you leave this empty, the interval
will be considered an open-ended interval. A date interval with an open
start value will occur on or before the End Value.
• End Value
The end date of the date interval. If you leave this empty, the interval
will be considered an open-ended interval. A date interval with an open-
ended value will occur on or after the Start Value.
• Evaluate
This button displays the interval as a fixed date format. You can use it to
help you with relative date values.

Notes
• For a date interval, you can specify a Start Value and an End Value
using relative dates or fixed dates. The following properties are
specific to relative dates, which specify a base time unit and an
optional adjustment offset. An adjustment offset consists of the
direction of the adjustment, the adjustment offset value, and the
adjustment units.All three components of an adjustment offset are
necessary: direction, value and units. If you leave one of these
components empty, the adjustment offset will be ignored.
• Start and end values
The base time unit for a relative date, which you can choose for the
Start Value and the End Value of a date interval. A base time unit
can be a relative date in and of itself, without an adjustment offset.
The possible base time unit values are as follows:
• Start of Today
• Start of Current Month
• Start of Current Year
• Now
• Start of Tomorrow
• Start of Yesterday
• Adjustment offset direction
The direction in which the adjustment offset is applied to the base
time unit. The possible values are as follows:
• plus
• minus
• Adjustment offset value
A numeric value of an adjustment offset.

102 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.10. Configurations

• Adjustment offset units


The units in which an adjustment offset is expressed. The possible
value are as follow:
• Days
• Months
• Years
• The following properties are specific to fixed dates, which specify a
specific date. For fixed dates, the beginning of a specified start date
will be 00:00:00 and the end of the specified end date will be
23:59:59

• Start Value and End Value


To specify a fixed date for a Start Value or End Value, choose
Fixed Date.
• Fixed date
Specify a fixed date using the format MM/DD/YYYY.
5. To add an interval, click the Add Another Interval link.
6. Click Save.

2.10.4.2 Managing interval profile configurations


To manage interval profile configurations:

1. On the top-level menu, click Configurations >Interval profiles.


2. To view an interval profile configuration, click the View link.
3. To delete an interval profile configuration, click the icon.
4. To edit an interval profile configuration, click the Edit link.
5. In the Interval Profile Properties area, edit any of the following:

• Name
• Description

Note: You cannot change the Type and ID fields of an interval profile
after creation.
6. In the Interval List area, define the intervals for the facets that you want to
generate.
The following properties apply to all interval types.

• Sequence
Specifies the order in which intervals will appear on the Facets Panel.
Sequence numbers are assigned automatically as new intervals are

OpenText Media Management – Administration Guide 103


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

configured. However, you can manually update the sequence numbers to re-
configure the order in which intervals should appear. If you do this, you
must assign each interval a unique sequence number.
• Display Label
Specifies the label that will be used to represent that interval on the Facets
Panel.

Note: You must provide a Display Label for each interval.

• Numeric interval profile


The following properties are specific to the numeric-type of interval profile.
They control the start value of the interval, the end value, and whether both
values are inclusive or exclusive.

Note: You must provide a Start Value and End Value, otherwise, the
interval will be invalid.

• Start Value
A numeric value for the start of the interval. If you leave this empty, the
interval will be considered an open-ended interval. A numeric interval
with an open start value will include all values less than (or less than or
equal to) the End Value.
• Inclusive (Start)
A filled circle indicates that the Start Value is inclusive. Conversely, an
empty circle indicates that the Start Value is exclusive.
• Inclusive (End)
A filled circle indicates that the End Value is inclusive. Conversely, an
empty circle indicates that the End Value is exclusive.
• End Value
A numeric value for the end of the interval. If you leave this empty, the
interval will be considered an open-ended interval. A numeric interval
with an open end value will include all values greater than (or greater
than or equal to) the Start Value.

• Date Interval Profiles


The following properties are specific to the date-type of interval profile.
They control the start and end values of the date interval.

Notes
• If you leave the Start Value and End Value empty, the interval will
be invalid.
• The start date of the date interval is inclusive and the end date is
exclusive.

104 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.10. Configurations

• Start Value
The start date of the date interval. If you leave this empty, the interval
will be considered an open-ended interval. A date interval with an open
start value will occur on or before the End Value.
• End Value
The end date of the date interval. If you leave this empty, the interval
will be considered an open-ended interval. A date interval with an open-
ended value will occur on or after the Start Value.
• Evaluate
This button displays the interval as a fixed date format. You can use it to
help you with relative date values.

Notes
• For a date interval, you can specify a Start Value and an End Value
using relative dates or fixed dates. The following properties are
specific to relative dates, which specify a base time unit and an
optional adjustment offset. An adjustment offset consists of the
direction of the adjustment, the adjustment offset value, and the
adjustment units.All three components of an adjustment offset are
necessary: direction, value and units. If you leave one of these
components empty, the adjustment offset will be ignored.
• Start and end values
The base time unit for a relative date, which you can choose for the
Start Value and the End Value of a date interval. A base time unit
can be a relative date in and of itself, without an adjustment offset.
The possible base time unit values are as follows:
• Start of Today
• Start of Current Month
• Start of Current Year
• Now
• Start of Tomorrow
• Start of Yesterday
• Adjustment offset direction
The direction in which the adjustment offset is applied to the base
time unit. The possible values are as follows:
• plus
• minus
• Adjustment offset value
A numeric value of an adjustment offset.

OpenText Media Management – Administration Guide 105


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

• Adjustment offset units


The units in which an adjustment offset is expressed. The possible
value are as follow:
• Days
• Months
• Years
• The following properties are specific to fixed dates, which specify a
specific date. For fixed dates, the beginning of a specified start date
will be 00:00:00 and the end of the specified end date will be
23:59:59

• Start Value and End Value


To specify a fixed date for a Start Value or End Value, choose
Fixed Date.
• Fixed date
Specify a fixed date using the format MM/DD/YYYY.

7. To add a new interval to the list, click the Add Another Interval link.

8. Click Save.

2.10.5 Facet
Search results, from both Advanced and Key Word search, can be further narrowed
down by the faceted navigation feature. A facet is a set of clearly defined, mutually
exclusive properties. For example, a collection of books might be classified using an
author facet and subject facet. Faceted search is a technique for accessing
information that is organized according to a faceted classification system, allowing
users to apply multiple filters to a search. The Facet Configurations section allows
administrators to generate facets based on metadata fields for faceted navigation in
the search results and to configure properties that affect how these facets are
generated.

Note: You can edit, but not delete, the default facet configurations.

106 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.10. Configurations

2.10.5.1 Creating a facet configuration


To create a facet configuration:

1. On the top-level menu, click Configurations > Facets.

2. Click New facet configuration.

3. In the Facet Properties area, specify the following:

• Name – Enter the facet name.


• Description – Enter a description for the facet.
• Default facets to display – Specify the default number of facets to display in
the Media Management Web Client. If more facets are generated than the
default number entered, then a “more” link will appear on the Facets Panel
in the Web client allowing the complete list of facets to be viewed. A value of
0 indicates that all facets generated should be displayed by default.
• Default facet values to display – Specify the default number of facet values
to display in the Media Management Web Client. If more facets values are
generated than the default number entered, a “more” link will appear on the
Facets Panel in the Web client allowing the complete list of facets to be
viewed (up to the limit specified in the Max facet values to showoption). A
value of 0 indicates that all facets values generated should be displayed by
default.
• Facet value order – Specify whether the facet values should be ordered
based on the count for that facet value or the index of the facet value. This
entry does not apply to facets on numeric or date fields, which will always
be displayed by ascending ranges.
• Max facet values to show – Specify the maximum number of facet values
that will be generated for a given field. This entry does not apply to facets on
numeric or date fields. A value of 0 indicates no limit.

Note: If there are assets returned in the search results in which the
given field is empty, then an “unknown” facet value is generated. In
these cases, the number of facet values returned can exceed the
configured Max facet values to show limit by one, as the “unknown”
facet value is returned in addition to the configured limit.
• Min facet values to show facets – Configure the minimum number of facet
values that must exist for the facet to be returned. The common use case is to
set this to 2 to prevent facet information from being returned for fields
which just generate one facet value.

Note: This option does not apply to facets generated from cascading
domain fields.
• Min asset count to show facet values – Configure the minimum asset count
required for a facet value to be returned. This allows you to filter out facet

OpenText Media Management – Administration Guide 107


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

values where the asset count doesn’t reach the specified threshold. Set to 1 to
display facet values regardless of their asset count.
4. Use the Facet Fields List area to select the fields for which facets you want to
generate and to configure properties for the facet.
The following properties apply to all facets:

• Facet Sequence
Specifies the order in which facets will appear in the Facets Panel. Each field
must be assigned a unique sequence number. Sequence numbers are
assigned automatically as new fields are configured. However, you can
manually update the sequence numbers to re-configure the order in which
facets should appear.
• Facet Field
Specifies the field used to generate facets. You can only choose fields defined
as facetable from the Facet Field list.

The following properties are specific to facets associated with specific field
types:

• Cascading Domain Field Properties


Facet values for cascading domain fields are displayed as a list of text
strings. No field type specific properties are available for cascading domain
fields.
• Domain and Text Field Properties
Facet values for domain and text fields are displayed as a list of text strings.
The following property controls the behavior when selecting these values:

• Multi Select
Specifies whether uses can select multi-facet values or only a single value
in the Facets Panel.
• Numeric Field Properties
Facet values for numeric fields are displayed as either a series of pre-defined
numeric intervals or a series of numeric value ranges. The following
properties control the behavior when selecting these values:

• Multi Select
Specifies whether users can select multi-facet values or only a single
value in the Facets Panel.
• Facet Type
Specifies whether the facet is Interval based or Range based.

The following properties apply to interval facets and control what pre-
defined facet interval profile will be used to generate facets, as well as the
order in which the facets will be displayed.

108 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.10. Configurations

• Interval Profile
Specifies a pre-defined numeric interval profile that will be used to
generate facets.
• Order By
Specifies the order in which the facets will be displayed. Available
options are: Sequence, where facets will be displayed in the same order
as they were defined in the interval profile, or Count, where facets will
be displayed with the highest count first.

The following properties apply to range facets and control the size of each
range and what values it starts and stops generating ranges at.

• Starting
The number to start generating numeric range facet values at. Field
values less than this value will be placed into a Before facet value.
• Ending
The number to stop generating numeric range facet values at. Field
values greater than or equal to this value will be placed into an After
facet value.
• Range Size
The size of each numeric range. If (End - Start) is not evenly divisible by
the size that you specified, the last range generated will be smaller than
this size.

Note: The number of possible ranges that you configure will have
an impact on search performance. As the (End - Start)/Size value
increases, the time required to generate facets for the field will
increase as well. For example, a configuration that generates a
million possible ranges will perform significantly worse than a
configuration that generates a thousand possible ranges.
• Date Field Properties
Facet values for date fields are displayed as either a series of pre-defined
date intervals or a series of date value ranges. The following property
controls the behavior when selecting these values:

• Multi Select
Specifies whether user can select multi-facet values or only a single value
in the Facets Panel.
• Facet Type
Specifies whether the facet is interval based or range based.

The following properties apply to interval facets and control what pre-
defined facet interval profile will be used to generate facets, as well as the
order in which the facets will be displayed.

OpenText Media Management – Administration Guide 109


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

• Interval Profile
Specifies a pre-defined date interval profile that will be used to generate
facets.
• Order By
Specifies the order in which the facets will be displayed. Available
options are Sequence, where facets will be displayed in the same order
as they were defined in the interval profile, or Count, where facets will
be displayed with the highest count first.

The following properties apply to range facets and control the size of each
range and what values it starts and stops generating ranges at.

• Starting
The date to start generating the date range facet values at. Field values
less than this value will be placed into a Before facet value.
• Ending
The date to stop generating date range facet values at. Field values
greater than or equal to this value will be placed into an After facet
value.
• Range Size
The size of each date range specified in the format #<units> where
<units> consists of one of the following:

• DAY (or DAYS)


• MONTH (or MONTHS)
• YEAR (or YEARS)

Examples of valid date range sizes are as follows:

• 10 DAYS
• 3 MONTHS
• 1 YEAR

If (End - Start) is not evenly divisible by the size specified, the last range
generated will be smaller than this size.

Note: The number of possible ranges you configure will have an


impact on search performance. As the (End - Start)/Size value
increases, the time required to generate facets for the field will
increase as well. For example, a configuration that generates a
million possible ranges will perform significantly worse than a
configuration that generates a thousand possible ranges.

5. Click the Add Another Field link to add a searchable field to the list.

110 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.10. Configurations

6. Select a field from the list and specify the properties that are appropriate for the
field type.

7. Click Save.

2.10.5.2 Managing facet configurations


To manage facet configurations:

1. On the top-level menu, click Configurations > Facets.

Note: ARTESIA.FACET.DEFAULT CONFIG is a default facet configuration.

2. To view a facet configuration, click the View link.

3. To delete a facet configuration, click the icon.

4. To edit a facet configuration, click the Edit link.

5. In the Facet Properties area, edit any of the following:

• Name – Enter the facet name.


• Description – Enter a description for the facet.
• Default facets to display – Specify the default number of facets to display in
the Media Management Web Client. If more facets are generated than the
default number entered, then a “more” link will appear on the Facets Panel
in the Web client allowing the complete list of facets to be viewed. A value of
0 indicates that all facets generated should be displayed by default.
• Default facet values to display – Specify the default number of facet values
to display in the Media Management Web Client. If more facets values are
generated than the default number entered, a “more” link will appear on the
Facets Panel in the Web Client allowing the complete list of facets to be
viewed (up to the limit specified in the Max facet values to showoption). A
value of 0 indicates that all facets values generated should be displayed by
default.
• Facet value order – Specify whether the facet values should be ordered
based on the count for that facet value or the index of the facet value. This
entry does not apply to facets on numeric or date fields, which will always
be displayed by ascending ranges.
• Max facet values to show – Specify the maximum number of facet values
that will be generated for a given field. This entry does not apply to facets on
numeric or date fields. A value of 0 indicates no limit.

Note: If there are assets returned in the search results in which the
given field is empty, then an “unknown” facet value is generated. In
these cases, the number of facet values returned can exceed the
configured Max facet values to show limit by one, as the “unknown”
facet value is returned in addition to the configured limit.

OpenText Media Management – Administration Guide 111


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

• Min facet values to show facets – Configure the minimum number of facet
values that must exist for the facet to be returned. The common use case
would be to set this to 2 to prevent facet information from being returned for
fields which just generate one facet value.

Note: This option does not apply to facets generated from cascading
domain fields.
• Min asset count to show facet values – Configure the minimum asset count
required for a facet value to be returned. This allows you to filter facet
values where the asset count does not reach the specified threshold. Set it to
1 to display facet values regardless of their asset count.

6. Use the Facet Fields List area to select the fields for which facets you want to
generate and to configure properties for the facet.
The following properties apply to all facets:

• Facet Sequence
Specifies the order in which facets will appear in the Facets Panel. Each field
must be assigned a unique sequence number. Sequence numbers are
assigned automatically as new fields are configured. However, you can
manually update the sequence numbers to re-configure the order in which
facets should appear.
• Facet Field
Specifies the field used to generate facets. You can only choose fields defined
as facetable from the Facet Field list.

The following properties are specific to facets associated with specific field
types:

• Cascading Domain Field Properties


Facet values for cascading domain fields are displayed as a list of text
strings. No field type specific properties are available for cascading domain
fields.
• Domain and Text Field Properties
Facet values for domain and text fields are displayed as a list of text strings.
The following property controls the behavior when selecting these values:

• Multi Select
Specifies whether uses can select multi-facet values or only a single value
in the Facets Panel.
• Numeric Field Properties
Facet values for numeric fields are displayed as either a series of pre-defined
numeric intervals or a series of numeric value ranges. The following
properties control the behavior when selecting these values:

• Multi Select

112 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.10. Configurations

Specifies whether users can select multi-facet values or only a single


value in the Facets Panel.
• Facet Type
Specifies whether the facet is Interval based or Range based.

The following properties apply to interval facets and control what pre-
defined facet interval profile will be used to generate facets, as well as the
order in which the facets will be displayed.

• Interval Profile
Specifies a pre-defined numeric interval profile that will be used to
generate facets.
• Order By
Specifies the order in which the facets will be displayed. Available
options are: Sequence, where facets will be displayed in the same order
as they were defined in the interval profile, or Count, where facets will
be displayed with the highest count first.

The following properties apply to range facets and control the size of each
range and what values it starts and stops generating ranges at.

• Starting
The number to start generating numeric range facet values at. Field
values less than this value will be placed into a Before facet value.
• Ending
The number to stop generating numeric range facet values at. Field
values greater than or equal to this value will be placed into an After
facet value.
• Range Size
The size of each numeric range. If (End - Start) is not evenly divisible by
the size that you specified, the last range generated will be smaller than
this size.

Note: The number of possible ranges that you configure will have
an impact on search performance. As the (End - Start)/Size value
increases, the time required to generate facets for the field will
increase as well. For example, a configuration that generates a
million possible ranges will perform significantly worse than a
configuration that generates a thousand possible ranges.
• Date Field Properties
Facet values for date fields are displayed as either a series of pre-defined
date intervals or a series of date value ranges. The following property
controls the behavior when selecting these values:

• Multi Select

OpenText Media Management – Administration Guide 113


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

Specifies whether user can select multi-facet values or only a single value
in the Facets Panel.
• Facet Type
Specifies whether the facet is interval based or range based.

The following properties apply to interval facets and control what pre-
defined facet interval profile will be used to generate facets, as well as the
order in which the facets will be displayed.

• Interval Profile
Specifies a pre-defined date interval profile that will be used to generate
facets.
• Order By
Specifies the order in which the facets will be displayed. Available
options are Sequence, where facets will be displayed in the same order
as they were defined in the interval profile, or Count, where facets will
be displayed with the highest count first.

The following properties apply to range facets and control the size of each
range and what values it starts and stops generating ranges at.

• Starting
The date to start generating the date range facet values at. Field values
less than this value will be placed into a Before facet value.
• Ending
The date to stop generating date range facet values at. Field values
greater than or equal to this value will be placed into an After facet
value.
• Range Size
The size of each date range specified in the format #<units> where
<units> consists of one of the following:

• DAY (or DAYS)


• MONTH (or MONTHS)
• YEAR (or YEARS)

Examples of valid date range sizes are as follows:

• 10 DAYS
• 3 MONTHS
• 1 YEAR

If (End - Start) is not evenly divisible by the size specified, the last range
generated will be smaller than this size.

114 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.11. Media Analysis

Note: The number of possible ranges you configure will have an


impact on search performance. As the (End - Start)/Size value
increases, the time required to generate facets for the field will
increase as well. For example, a configuration that generates a
million possible ranges will perform significantly worse than a
configuration that generates a thousand possible ranges.

7. Click the Add Another Field link to add a searchable field to the list.

8. Select a field from the list and specify the properties that are appropriate for the
field type.

9. Click Save.

2.10.6 Brand
A brand configuration is an XML file containing a collection of items, including CSS
elements, JS elements, image elements, brand names, and user groups (list of users
associated with the branding configuration), that define the items required for a
proper brand presentation in the UI and when using the APIs. The UI will reflect the
branding configuration associated with the signed in user. If a user belongs to more
than one group, they can set their default branding through preferences. Or if no
preference is set, OTMM will use the branding associated with the first user group it
finds. In the absence of any configured branding for user groups, the system will
load the default branding configuration.

To create a brand configuration:

1. On the top-level menu, click Configurations > Brands.

2. Click New brand configuration.

3. Enter a name and description, and specify the folder containing the branding
configuration.

4. Click Save.

2.11 Media Analysis


The Rich Media Analysis Service analyzes assets. Assets are populated with
metadata based on the results of the analysis.

This service can analyze assets during asset ingest or at later time through jobs that
you schedule on the Media Analysis Management page. For more information
about having assets analyzed during ingest, see “Configuring Rich Media Analysis
Service” on page 158.

Prior to scheduling a job through the Media Analysis Management page, you must
do the following to ensure that certain criteria are met and perform configuration
tasks.

OpenText Media Management – Administration Guide 115


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

1. Make assets eligible for media analysis. To do this, the following criteria must be
met:
a. Ensure that the asset metadata model contains the ARTESIA.CATEGORY.MEDIA
ANALYSIS metadata field group.
b. Only image assets, such as bitmap content type assets, are eligible for media
analysis.
2. Configure the value of the MEDIAANALYSIS_ENABLED setting to true. By default,
it is set to false. For more information, see “MEDIAANALYSIS\GENERAL”
on page 261.

Notes
• This setting is available under the MEDIAANALYSIS\GENERAL
component, which belongs to the configuration group. For more
information, see “Editing a component and properties” on page 136.
• After modifying MEDIAANALYSIS_ENABLED, you must clear the caches.
3. To analyze existing assets, configure the SCHEDULE_EXECUTE_USER system
setting to specify the name of the default user who will be used to execute asset
analysis jobs. For more information, see “MEDIAANALYSIS\GENERAL”
on page 261.

Note: This setting is available under the SCHEDULER\CONFIG


component, which belongs to the General configuration group. For more
information, see “Editing a component and properties” on page 136.
4. Create a public saved search that identifies the assets which contain the content
that you want to analyze. For more information, see section 7.4.1 “To save a
search” in OpenText Media Management - Web Desktop Client User Guide
(MEDMGTMOD160300-UCW).

2.11.1 Adding a schedule


To add a schedule:

1. On the top-level menu, click Media Analysis > Media Analysis Scheduler.

2. Click New Media Analysis Schedule.

3. On the New Media Analysis Schedule page, do the following:

a. In the Name box, enter a name for the schedule.


b. In the Definition (Save Search) list, choose the public saved search that
identifies the assets that you want to have analyzed.
c. In the Status list, choose one of the following to define the status of the
media analysis schedule:

• Active - to make the media analysis schedule active and have it execute
an asset analysis job according the schedule that you specify on this
page.

116 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.11. Media Analysis

• Inactive - to suspend the media Analysis schedule. The asset analysis


job will not be executed according to the specified schedule until you
change the state to Active.
d. In the Start Date box, choose the date that you want the asset analysis to
start.
e. In the Scheduled Time box, enter the time that you want the asset analysis
job to take place.
You must enter the time using 24-hour notation. To do this, use the
HH:MM:SS format . For example, for “3:20 p.m.”, enter 15:20:00.
f. In the Recurrence area, specify how frequently you want to run the job.

Notes
• OTMM executes asset analysis jobs according to the settings that
you specify in the Recurrence area, even if you specified an early
start date. That is, if the start date is before the recurrence date, the
job will not take place until the recurrence date.
• If you set the recurrence of a job to Run once and the execution of
this job is missed, the OTMM server will handle this misfire the first
time it polls for any active jobs after the event of the misfire. OTMM
only handles scheduled misfires when the job recurrence is set to
Run once; all other misfires are ignored.

4. In the End Date box, choose the date that you want the asset analysis job to end.

5. Click Save.

2.11.2 Editing a schedule


To edit a schedule:

1. On the top-level menu, click Media Analysis > Media Analysis Scheduler.

2. On the Media Analysis Management page, navigate to the name of the


schedule and click Edit.

3. On the Edit Media Analysis Schedule page, edit the settings as required.

4. Click Save.

OpenText Media Management – Administration Guide 117


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.11.3 Deleting a schedule


To delete a schedule:

1. On the top-level menu, click Media Analysis > Media Analysis Scheduler.

2. On the Media Analysis Management page, navigate to the name of the


schedule and click Delete.

3. Confirm the deletion.

2.12 Analytics
Using the Analytics page, you can enable or disable the new Data Agent
component, and configure the location of the following:

• Data Collector
• Information Hub (iHub) URL
• Usage reports and dashboards

The Data Agent forwards configured usage events and metadata to Data Collector.
Data Collector transforms the events as a formatted CSV file. OpenText™ Big Data
Analytics (Big Data Analytics) loads event data to a database, making it available for
reporting. iHub presents this information in reports and dashboards that are
available in the Media Management Web Desktop Client.

In addition, you can use the Seed Agent utility to forward historical events to
Analytics to bootstrap the database.

Important

• Prior to configuring Analytics, you must install Data Collector and the
OpenText Analytics products, and then perform the integration. For more
information about integrating with Data Collector, see section 10
“Integrating Media Management and Data Collector” in OpenText Media
Management - Installation Guide (MEDMGT160300-IGD).
• For previous versions of Media Management, it was necessary to
integrate iHub with OTDS using the OTDS Report Security Server
Extension (RSSE) service. The current version of iHub no longer requires
the RSSE service. If you are upgrading to the current version of OTMM,
you must remove the RSSE service and follow separate instructions to
upgrade iHub and integrate it with OTDS before configuring Analytics.
For more information, see section 14.4 “Upgrading OpenText Information
Hub” in OpenText Media Management - Installation Guide
(MEDMGT160300-IGD).

118 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.12. Analytics

Notes
• You can determine which end-user groups can access Analytics reports and
dashboards by adding the DASHBOARD_REPORTS.VIEW FET to the
appropriate role. For more information, see “Managing roles” on page 53.

2.12.1 Configuring the iHub user sign-in credentials


Prior to configuring Analytics, you must configure the iHub user sign-in credentials
by creating the iHub_SEC.cfg encrypted credentials file. This file contains the iHub
fully-qualified user name and password. You must grant this account read-execute
permission to the iHub reports and dashboards through the iHub Information
Console.

To configure the iHub user sign-in credentials:

1. Verify that a dedicated iHub user account, such as mmihubuser, has been
created in an OTDS user partition. For more information, see OpenText Directory
Services - Installation and Administration Guide (OTDS160202-IWC).

2. Using the iHub Information Console, verify that the dedicated user has access to
the Information Hub/Applications/OTMM16 folder.

3. In the <TEAMS_HOME>/servers folder, create a text file and name it iHub_SEC.


cfg.

4. In a text editor, open the iHub_SEC.cfg file, and then add the following:

• The iHub user fully qualified user name, for example,


mmihubuser@MediaMgmt.

• The iHub user password.

5. Save the iHub_SEC.cfg file.

6. At the command prompt, change to the <TEAMS_HOME>/install/ant directory,


and then run the following Ant task to encrypt the new credentials:
ant encrypt-ihub-login

2.12.2 Configuring Analytics


By default, the Analytics feature is not enabled after installing or upgrading OTMM.

To start collecting Analytics event data and make Analytics reporting and
dashboards available, you need to enable it using the Analytics page. Once enabled,
users with the DASHBOARD_REPORTS.VIEW FET will be able to view Analytics
features in the Media Management Web Desktop Client.

Notes
• When you enable Analytics reporting, you must specify the Data Collector
host name and port number.

OpenText Media Management – Administration Guide 119


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

• This is the best time to modify the tenant ID if you choose not to use the
default GUID.
• If you do not configure Analytics, all Analytics user interface elements are
not visible in the Media Management Web Desktop Client. This includes
Analytics reports and dashboards.
• Users must have the DASHBOARD_REPORTS.VIEW FET enabled to be able
to see the Analytics tabs. For more information, see “Managing roles”
on page 53.
• The Analytics tabs are only available in the Web Desktop Client.

To configure Analytics:

1. On the top-level menu, click Analytics.

2. On the Analytics page, click the General tab.

3. Select the Enable check box to make the settings on this page available.

4. To configure the location of the Data Collector server, do the following:

Notes
• By changing the location of the Data Collector server, OTMM sends
events to the new server. OTMM events that were collected on the
previously configured Data Collector server will remain on that server.
• Changing the location of the Data Collector server might result in the
loss of previously recorded events.

a. In the Data Collector Server box, enter the host name.


b. In the Data Collector port box, enter the port number.

5. Change the Tenant ID only if necessary. For more information, see “Changing
the tenant ID” on page 122.

6. In the iHub Information Console URL box, enter the URL to configure the
location of the iHub portal.

Note: In addition to entering the URL, you must configure the iHub user
sign-in credentials by creating the iHub_SEC.cfg encrypted credentials
file. This file contains the iHub fully-qualified user name and password.
You must grant this account read-execute permission to the iHub reports
and dashboards through the iHub Information Console. For more
information, see “Configuring the iHub user sign-in credentials”
on page 119.

7. To replace the default Analytics reports and dashboards with custom reports
and dashboards, do the following:

a. In the Asset Details Report Location box, enter the path to configure
OTMM to use your custom Data Collector report.

120 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.12. Analytics

b. In the Asset Dashboard Location box, enter the path to configure OTMM
to use to your custom Data Collector dashboard.

Note: OpenText recommends that you use the default reports and
dashboards in your initial Analytics configuration.

8. Click Save.

2.12.3 Modifying the Analytics events list


By default, OTMM provides the following:

Asset Detail Report


This report provides details on how often an asset is viewed, downloaded,
exported, and used by OpenText™ Media Management Adaptive Media
Delivery (Adaptive Media Delivery). This report is available from the Asset
Details page in the Media Management Web Desktop Client.

Analytics Dashboard
This dashboard provides one tab for usage analytics and a second for system
analytics. These dashboards are available from the main menu tab in the Media
Management Web Desktop Client. The usage tab provides various reports on
how assets are used in the system. The System tab illustrates the distribution of
assets within the system.

By default, OTMM reports all activity events necessary for these default Analytics
reports and dashboards. You can collect additional information for custom Analytics
reports and dashboards.

To collect additional information for custom analytics reports and dashboards:

1. On the top-level menu, click Analytics.

2. On the Analytics page, click the Events tab.


3. In the Configured analytics events table, select the Enabled check box of each
event that you want to include.

Tip: To return to the default list of events, click the Restore default events
link.

4. Click Save.

Important
Disabling default events might cause the default Analytics reports and
dashboards to break.

OpenText Media Management – Administration Guide 121


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.12.4 Adding metadata fields


You can configure metadata field values that OTMM will collect and use for
Analytics reports.

To add metadata fields:

1. On the top-level menu, click Analytics.

2. On the Analytics page, click the Metadata tab.

3. To add metadata fields, do the following:

a. In the first drop-down list, choose a field group.

b. In the Available fields list, choose the field that you want to add, click
to move the metadata field to the Selected fields list.

Tip: To remove a metadata field, choose a field in the Selected fields


list, and click .

4. Click Save.

2.12.5 Changing the tenant ID


A single Data Collector server can accept events from multiple OpenText products
and instances. OTMM uses a combination of a product name and a tenant ID to
identify itself to Data Collector.

By default, OTMM generates a default GUID as the tenant ID.

Important
The purpose of the tenant ID is to uniquely identify an OTMM installation.
Change the tenant ID only if absolutely necessary. Changing the tenant ID
might cause loss of data in Data Collector. If events have been transmitted to
Data Collector, they will be stored under the previous OTMM tenant ID.

To change the tenant ID:

1. On the top-level menu, click Analytics.

2. On the Analytics page, click the General tab.

3. In the Tenant ID, edit the value of the tenant ID of OTMM.

4. Click Save.

5. Optional To forward the OTMM history to the new tenant ID.

122 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.12. Analytics

2.12.6 Running the Seed Agent utility


Analytics uses Media Management events to track usage history. Reports and
dashboards provide a visual history of your Media Management instance.

You can forward past, historical, events to Analytics to bootstrap the database. By
running the Seed Data Agent utility, you can start using the Analytics feature to use
reports and dashboards for existing OTMM assets.

You can run the Media Management Seed Data Agent utility to send the following
event information to Data Collector:
• Generates an Analytics object for each existing asset and folder.
• Generates an Analytics object for each existing Creative Review.
• Generates an Analytics object for each existing User and User Group.
• Forwards past events that are logged in the WORKFLOW_LOGS table to
Analytics.

To run the Seed Data Agent utility:

• At the command prompt, change to the <TEAMS_HOME>/install/ant folder,


and the do any of the following:

Note: The progress is logged in the <TEAMS_HOME>/logs/seed-agent.


log file.

To import your old events into Analytics Run the following Ant task:
ant run-seed-agent
Note: To perform this task, you
must have upgraded to the current
version of OTMM.
To collect newly configured metadata Run the following Ant task:
values ant -Dargs="-mode assets" run-
seed-agent

Notes
• To collect the metadata for
existing assets and folders, you
must run the Seed Agent in
assets mode.
• Running this Ant task updates the
Analytics database with the newly
configured asset metadata fields.

OpenText Media Management – Administration Guide 123


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

To collect recently configured events Run the following Ant task:


ant -Dargs="-mode logs" run-
seed-agent

Notes
• To collect historical events that
match the new configuration, run
the Seed Agent in logs mode.
This pulls events that match the
new event criteria from the
WORKFLOW_LOGS table.
To stop the seed data agent prior to its Run the following Ant task:
completion ant stop-seed-agent

Note: If you run the Seed Agent multiple times, you could create duplicate
event files in the Analytics database. In this case, OpenText recommends that
you clear out the Media Management analytics events previously imported
into Big Data Analytics before you rerun the Seed Agent.

2.13 Storage Management


Using the Storage Managers tab, you can configure content managers and business
rules. Using business rules you can automate the process of having have assets move
to a specific content manager based on a schedule that you define.

2.13.1 Administering storage management


To administer storage management:

1. On the top-level menu, click Storage Management.

2. On the Intelligent Storage Management page, do any of the following:

To Do
To add a content manager Click New content manager. For more
information, see “Adding a content
manager” on page 125.
To edit a content manager Click Edit. For more information, see
“Editing a content manager” on page 127.
To duplicate a content manager Click Duplicate. For more information, see
“Duplicating a content manager”
on page 127.
To view a list of content managers Click the Content managers tab.
To define business rules Click the Business Rules tab. For more
information, see “Defining business rules”
on page 128.

124 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.13. Storage Management

To Do
To delete a content manager Navigate to its row, and click Delete.

Note: For more information about the pre-configured content managers, see
“Configuring content managers” on page 147.

2.13.2 Adding a content manager


Note: Creative Review supports files system only.

To add a content manager:

1. On the top-level menu, click Storage Management.

2. On the Intelligent Storage Management page, click New content manager.

3. In the Id box, enter the ID of the content manager using the following format:
CUSTOM.<OBJECT TYPE>.<OBJECT ID>

Notes
• OpenText recommends that you use the following format to avoid
having the ID overwritten in future releases of OTMM.
• Valid characters for ID are letters, numbers, underscore (_), hyphen (-),
and period (.).

4. In the Name box, enter the name of the content manager.

5. In the Class box, enter a class name that implements the


ArtesiaContentManager interface.

Notes
• Make sure that you provide a valid class name that already exists. The
class name will be validated after it is entered.
• Each implementation provides methods for reading, writing, and
deleting content within its particular storage medium. For more
information, see ArtesiaContentManager class in OpenText Media
Management Programmer Guide (https://knowledge.opentext.com/
knowledge/llisapi.dll/Properties/69371555).
• For more information about classes for the pre-configured content
managers, Microsoft® Azure® blob storage, Amazon S3™ storage, and
Google Cloud Storage™ service , see one of the following:
• “Configuring Microsoft Azure blob storage” on page 148
• “Configuring Amazon S3 storage” on page 150
• “Configuring Google Cloud Storage” on page 153

OpenText Media Management – Administration Guide 125


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

6. In the Storage root box, enter the location of the root folder where the assets
will be saved.

7. In the Storage provider list, choose one of the following storage providers:

• SAN/NAS
• Cloud

8. In the Storage Details area, do the following:

a. Click Add Attribute.


b. In the Name and Value boxes, enter the name and value each attribute.

Note: To enable streaming from multiple storage roots, add two attributes
called AUDIO_BASE_URL and VIDEO_BASE_URL. For more information about
configuring content manager attributes, see “Configuring content manager
attributes” on page 147.

9. Click Test Connection to verify that assets will be saved to the content
manager.

Note: You will not be able to save the content manager if the class name
that you provided is invalid.

10. Click Save.

11. To use the new content manager to store content, do the following:

a. To configure the settings using the IMPORT\SERVER component which


belongs to the IMPORT configuration group, update
DEFAULT_CONTENT_MANAGER_ID. For example:
"DEFAULT_CONTENT_MANAGER_ID"="ARTESIA.CONTENT.AMAZON.S3"
b. To store KeyFrames, renditions, and video proxies to a different location
update the following settings:
"KEYFRAME_CONTENT_MANAGER_ID" = "ARTESIA.CONTENT.FILESYSTEM"
"RENDITION_CONTENT_MANAGER_ID" = "ARTESIA.CONTENT.FILESYSTEM"
"VIDEO_PROXY_CONTENT_MANAGER_ID" = "ARTESIA.
CONTENT.FILESYSTEM"

Note: OpenText recommends that you store KeyFrames, renditions,


and video proxies in their own file system.

126 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.13. Storage Management

2.13.3 Duplicating a content manager


If you want to add a content manager that is similar to one that you created, you can
duplicate the content, and then modify it accordingly.

When you duplicate a content manager, the class, storage root, storage provider and
storage details of the source content manager pre-populate the fields of the
duplicate.

To duplicate a content manager:

1. On the top-level menu, click Storage Management.

2. On the Intelligent Storage Management page, navigate to the content manager


that you want to duplicate, and then click Duplicate.

3. On the New Content Manager page, in the Id box, enter the ID of the content
manager using the following format:
CUSTOM.<OBJECT TYPE>.<OBJECT ID>

Notes
• OpenText recommends that you use the following format to avoid
having the ID overwritten in future releases of OTMM.
• Valid characters for ID are letters, numbers, underscore (_), hyphen (-),
and period (.).

4. In the Name box, enter the name of the content manager.

5. Edit the boxes, lists, and fields as required. For more information, see “Adding a
content manager” on page 125.

6. Click Save.

2.13.4 Editing a content manager


To edit a content manager:

1. On the top-level menu, click Storage Management.

2. On the Intelligent Storage Management page, navigate to the row of the


content manager that you want to edit, and click Edit.

3. On the Edit Content Manager page, do any of the following:

a. Edit the Name of the content manager.


b. Edit the Class Name that will implement the ArtesiaContentManager
interface.
c. Edit Storage root location of the root folder where the assets will be saved.
d. In the Storage provider list, choose a different storage provider.

OpenText Media Management – Administration Guide 127


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

4. In the Storage Details area, do any of the following:

• To add an attribute, click Add Attributes, and then enter the Name and
Value of the attribute.
• To delete an attribute, navigate to the row of the attribute and click Delete.

5. Click Test Connection to verify that assets will be saved to the content
manager.

6. Click Save.

2.13.5 Deleting a content manager


Notes
• You cannot delete pre-configured content managers that are included with
OTMM.
• You cannot delete a content manager that was created from the user
interface that has an ID that was configured as
DEFAULT_CONTENT_MANAGER_ID in the system settings.

To delete a content manager:

1. On the top-level menu, click Storage Management.

2. On the Intelligent Storage Management page, navigate to the row of the


content manager that you want to delete, and click Delete.

3. Confirm the deletion.

2.13.6 Defining business rules


Using the Business Rules tab, as administrator or a user with equivalent privileges,
you can schedule a job to move assets from one content manager to another content
manager. To do this, you must create a business rule, which requires the following:

• A saved search that identifies the assets which contain the content that you want
to move.
• A destination content manager where you want to move the assets to.

Notes
• As part of the move job, only the master content is moved to the content
manager that you specify.
• The business rules that you define are cluster aware. This means that the rule
will only be executed on one of the cluster members.

You also need to configure the time which defines the execute move in the
SCHEDULE_EXECUTE_USER system setting, which is available under the SCHEDULER

128 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.13. Storage Management

\CONFIG component, which belongs to the General configuration group. For more
information, see “Editing a component and properties” on page 136.

2.13.6.1 Adding a business rule


To add a business rule:

1. On the top-level menu, click Storage Management.

2. On the Intelligent Storage Management page, click the Business Rules tab.

3. Click New Business Rule.

4. On the New Business Rule page, do the following:

a. In the Name box, enter a name for the rule.


b. In the Move content to list, choose the content manager where you want to
move assets to.
c. In the Definition (Save Search) list, choose the saved search that identifies
the assets that you want to move.
d. In the Status list, choose one of the following to define the status of the
business rule:

• Active – to make the business rule active and have it execute a move job
according the schedule that you specify on this page.
• Inactive – to suspend the business rule. The move job will not be
executed according to the specified schedule until you change the state
to Active.
e. In the Start Date box, choose the date that you want the content move to
start.
f. In the Scheduled Time box, enter the time that you want the content move
job to take place.

Note: You must enter the time 24–hour notation. To do this use the
format HH:MM:SS. For example, to enter 3:20 p.m., enter 15:20:00.
g. In the Recurrence area, do one of the following to specify how frequently
you want to move assets:

• Click Run once (Don’t repeat) to move the assets only once.
• Click Daily, and in the list, choose Every day or Weekdays.
• Click Weekly on and select the days of the week.
• Click Monthly on day, and in the list, choose the date.

Notes
• OTMM executes move jobs according to the settings that you
specify in the Recurrence area, even if you specified an early start

OpenText Media Management – Administration Guide 129


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

date. That is, if the start date is prior to the recurrence date, the
move job does not take place until the recurrence date.
• If you set the recurrence of a move job to Run once and the
execution of this job is missed, the OTMM server will handle this
misfire the first time it polls for any active jobs after the event of the
misfire. OTMM only handles scheduled misfires when the job
recurrence is Run once; all other misfires are ignored.
h. In the End Date box, choose the date that you want the content move job to
end.

5. Click Save.

2.13.6.2 Editing a business rule

To edit a business rule:

1. On the top-level menu, click Storage Management.

2. On the Intelligent Storage Management page, click the Business Rules tab.

3. On the Intelligent Storage Management page, navigate to the row of the


business rule that you want to delete and click Edit.

4. On the Edit Business Rule page, edit the settings as required.

5. Click Save.

2.13.6.3 Deleting a business rule

To delete a business rule:

1. On the top-level menu, click Storage Management.

2. On the Intelligent Storage Management page, click the Business Rules tab.

3. On the Intelligent Storage Management page, navigate to the row of the


business rule that you want to delete , and click Delete.

4. Confirm the deletion.

2.14 Settings
This section provides a guideline for administrators who are responsible for adding,
updating or viewing the following:

• system setting configuration groups


• components
• system setting data

130 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.14. Settings

Notes

• Using the search box on the Settings page, you can search for properties,
settings, and descriptions across all configuration groups.
• Node-specific settings are stored in an ASCII resource file called Tresource.
For more information about naming conventions and format of this file, see
“Appendix A – Preference file“ on page 235.
• The Settings page is visible to administrative users and users who have the
SYSTEM_SETTINGS.ALL FET granted in their role.

2.14.1 Administering configuration groups


A configuration group holds the components.

Using the search box on the Settings page, you can search for settings, properties,
and descriptions across the configuration groups.

The following table lists the configuration groups, which are available on Settings
page, and the components that each group contains. For more information about the
settings of components, see “Appendix B – System settings“ on page 239.

Note: Node-specific settings, such as those under the [JNDI\CONFIG] and


[COMMON\JDBC] sections, are stored in an ASCII resource file called Tresource,
also referred to as the preference file. For more information and a detailed list
of settings store in Tresource, see “Tresource file” on page 235.

Table 2-14: Configuration group and components mappings

Configuration Group on the Settings page Component


Adaptive Media • “ADAPTIVE_MEDIA\CONFIG”
on page 239

For more information about these


components, see
Adobe Connector • “ADOBE\CCAPPS” on page 239

For more information about these


components, see the following:
• OpenText Media Management Connector for
Adobe Creative Cloud - Installation Guide
and Release Notes (MEDMGTPO160300-
ICC)
• OpenText Media Management Connector for
Adobe Creative Cloud - User Guide
(MEDMGTPO160300-UCC)

OpenText Media Management – Administration Guide 131


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

Configuration Group on the Settings page Component


API Configuration • “RESTAPI\CONFIG” on page 267
• “UX\CACHE” on page 277
• “UX\CUSTOM” on page 278
• “UX\GENERAL” on page 278
• “UX\IMPORT” on page 280
• “UX\OBJECTBUILDER” on page 280
Jobs • “JOB\CONFIG” on page 259
Collaborative Jobs • Section 13.1.6 “COLLABORATION
\CONFIG” in OpenText Media
Management - Administration Guide
(MEDMGT160300-AGD)
Events • “EVENT_LOGGING\SERVER”
on page 251
• “SERVER\EVENTS” on page 272
Export • “EXPORT\SERVER” on page 251
• “YOUTUBE\CONFIG” on page 276
General • “APPLICATION\CONTENT_SHARE”
on page 239
• “ASSET\CONFIG” on page 240
• “COMMON\CLIENT” on page 241
• “COMMON\SERVER” on page 242
• “CONTENT\CONFIG” on page 246
• “CONTENT_TRANSFER\CONFIG”
on page 247
• “HELP\CONFIG” on page 252
• “MEDIAANALYSIS\GENERAL”
on page 261
• “REPORT\CONFIG” on page 266
• “REPORT\CONFIG” on page 266
• “REPORT\CONFIG” on page 266
• “SECURITY\SERVER” on page 270
• “TRANSFORMER\CONFIG”
on page 275
• “WEB\ADMIN” on page 287
• “WEB\CONFIG” on page 287
• “WEB\GENERAL” on page 287
• “WEB_APPLICATIONS\CONFIG”
on page 289
Image • “IMAGE\CONFIG” on page 252
Import • “IMPORT\SERVER” on page 253
Lightbox • “LIGHTBOX\SERVER” on page 261

132 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.14. Settings

Configuration Group on the Settings page Component


Metadata • “ASSET
\METADATA_TRANSFORMERS”
on page 240
• “METADATA\CONFIG” on page 262
• “METADATA\LEGACY-CONFIG”
on page 262
• “METADATA\VALIDATOR”
on page 263
OTDS • “OTAG\GENERAL” on page 263
• “OTDS\GENERAL” on page 264
• “OTDS\SYNCHRONIZATION”
on page 265
Reviews • “CREATIVEREVIEW\VIKI” on page 247
• “CREATIVEREVIEW
\VIKI_CONTENTMANAGER_DATAST
ORE_MAP” on page 250
For more information about these
components, see OpenText Media Management
Creative Review - Installation Guide and Release
Notes (MEDMGTPO160300-ACR).
OTHER Can contain custom components and
settings.
Search • “COMMON\SOLR” on page 245
• “INDEXING\COMMON” on page 256
• “INDEXING\SOLR” on page 258
• “SEARCH\SERVER” on page 268
• “SEARCH\SOLR” on page 270
Transfer Schemes • “TRANSFER_SCHEME\ALT_SCHEME”
on page 274
• “TRANSFER_SCHEME
\DEFAULT_SCHEME” on page 275
• “TRANSFER_SCHEME\SWITCH”
on page 275
Video • “TRANSCODE\SERVER” on page 273
• “VIDEO\TRANSCODE” on page 280

OpenText Media Management – Administration Guide 133


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

2.14.1.1 Adding a configuration group


To add a configuration group:

1. On the top-level menu, click Settings.

2. On the Settings page, click New configuration group.

3. On the Configuration group page, do the following:

a. In the Name box, enter the name of the configuration group.


b. In the Description box, enter a description for the configuration group.
c. Select or clear the Active check box to make the component active or
inactive.

4. Click Save.

2.14.1.2 Viewing a configuration group


To view a configuration group:

1. On the top-level menu, click Settings.

2. On the Settings page, in the Configuration group name column, navigate to


General, click the View link.

3. On the Configuration Group page, navigate to the component you want to


view its properties.

2.14.1.3 Editing a configuration group


To edit a configuration group:

1. On the top-level menu, click Settings.

2. On the Settings page, in the Configuration group name column, navigate to the
configuration group that you want to edit, and click the Edit link.

3. On the Configuration group page, do the following:

a. In the Name box, edit the name of the configuration group.


b. In the Description box, edit the description.
c. Select or clear the Active check box to make the component active or
inactive.

Note: If a configuration group is inactive, all the components and


system settings under the component will be have an inactive state

4. Click Save.

134 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.14. Settings

2.14.1.4 Deleting a custom configuration group


To delete a custom configuration group:

1. On the top-level menu, click Settings.

2. On the Settings page, in the Configuration group name column, navigate to the
configuration group that you want to delete, and click .

3. Confirm that you want to delete the configuration group.

Note: By deleting a configuration group, you also delete its associated


components and settings.

2.14.2 Configuring components


A component holds the component details and lists of all system setting property
details.

2.14.2.1 Adding a component and properties


To add a component and properties:

1. On the top-level menu, click Settings.

2. On the Settings page, in the Configuration group name column, navigate to the
configuration group that you want to edit, and click the Edit components link.

3. On the Configuration Group page, click New component.

4. On the Component page, do the following:

• In the Component box, enter a name for the component


• In the Key box, enter a key
• In the Description box, provide a description.
• Select or clear the Active check box to make the component active or
inactive.

Note: Clearing the check box will also make its properties settings
inactive.

5. To add a property, navigate to the Properties area, and do the following:

a. Click New property.


b. Enter the property name
c. Choose the data type.
d. Enter the value.
e. Select the appropriate Active check box to make the setting active.
f. Select the appropriate Public check box to make the setting public.

OpenText Media Management – Administration Guide 135


MEDMGT160300-AGD-EN-02
Chapter 2 Web Administration tool

Note: If you clear this check box, when a user retrieves system
settings using REST API, all non-public settings will be excluded.

6. Click Save.

Note: For more information about adding a property to an existing


component, see “Editing a component and properties” on page 136.

2.14.2.2 Viewing a component and properties


To view a component and properties:

1. On the top-level menu, click Settings.

2. On the Settings page, in the Configuration group name column, navigate to the
configuration group that you want to view, and click the View link.

3. On the Configuration group page, navigate to the component you want to see
its details and view its properties.

2.14.2.3 Editing a component and properties


To edit a component:

1. On the top-level menu, click Settings.

2. On the Settings page, in the Configuration group name column, navigate to the
configuration group that contains the component that you want to edit, and
click the Edit components link.

3. On the Configuration group page, navigate to the component that you want to
edit.

4. Click Edit.

5. On the Component page, do the following to edit the settings of the


configuration group, as required:

a. In the Component box, edit the name of the component.


b. In the Key box, edit the key.
c. In the Description box, edit the description.
d. Select or clear the Active check box to make the component active or
inactive.

6. On the Component page, in the Properties area, do the following as required:

a. In the Properties area, edit the property name, data type, value or
description.
b. Select the appropriate Active check box to make the setting active.
c. Select the appropriate Public check box to make the setting public.

136 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
2.14. Settings

Note: If you clear this check box, when a user retrieves system
settings using REST API, all non-public settings will be excluded.
d. To add a property, click New property, and then add the appropriate
attributes.
e. To delete a property, navigate to the property that you want to delete and
click .

7. Click Save.

2.14.2.4 Deleting a custom component and its properties


To delete a component and its properties:

1. On the top-level menu, click Settings.

2. On the Settings page, in the Configuration group name column, navigate to the
configuration group that you want to delete, and click the Edit components
link.

3. On the Configuration Group page, navigate to the component, and then click
Delete.

4. Confirm that you want to delete the component.

Note: By deleting a configuration group, you also delete its associated


components and settings.

OpenText Media Management – Administration Guide 137


MEDMGT160300-AGD-EN-02
Chapter 3
Performing operations tasks

Operations tasks include the following:


• “Starting OTMM” on page 140
• “Changing the database connection information” on page 144
• “Changing the Indexer sign-in information” on page 145
• “Changing the OTDS sign-in information” on page 145
• “Moving the repository after importing assets” on page 146
• “Configuring content managers” on page 147
• “Configuring SSL” on page 160
• “Changing the default JBoss server ports” on page 166
• “Enabling search term logging” on page 168
• “Preparing to export asset URLs” on page 169
• “Administering the Search Index” on page 169
• “Configuring Solr to use the ICU Unicode tokenizer” on page 175
• “Configuring enum Facet method” on page 177
• “Setting the debug level” on page 179
• “Clearing the Java cache” on page 179
• “Importing Japanese Ruby character in PDFs” on page 179
• “Customizing the text in the password reset email” on page 181
• “Configuring the Search Suggestion feature” on page 181
• “Configuring model-level required fields” on page 185
• “Overwriting HTTP response headers” on page 185

OpenText Media Management – Administration Guide 139


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

3.1 Starting OTMM


You can start OTMM as a service or manually.

Note: In the current release of OTMM, the OpenText Indexer service is not
automatically started, stopped, or restarted with the Media Management
service. You must manage the Indexer service independently. Start, stop or
restart the OpenText Indexer service only after the corresponding operation is
successful for the Media Management service. This is applicable to all the
modes of managing the Media Management application.

3.1.1 Starting Media Management as a Windows service


To start Media Management as a Windows service:

1. Click Windows Start Menu > All Programs > Administrative Tools > Services.

2. Select the OpenText Media Manager Service.

Note: The OpenText Media Manager service must be running successfully


before you can start any of the other Media Management services, such as
the OpenText Indexer service.

3. Click Start. If Media Management and the database are on different servers, you
can configure Media Management to start automatically.

3.1.2 Starting Media Management on Linux


To start Media Management on Linux:

1. Sign out of Media Management to allow your environment to set up properly.

2. Sign in to Media Management.

3. To start the Media Management server, run the following command:


mediamanagement-process-manager start

Note: The OpenText Media Manager service must be running successfully


before you start any of the other Media Management services, such as the
OpenText Indexer service.

Tips

• To stop the Media Management server, run the following command:


mediamanagement-process-manager stop
• To restart the Media Management server, run the following command:
mediamanagement-process-manager restart

140 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.1. Starting OTMM

• These commands stop and restart the Media Management server only.
You must stop and restart the other Media Management services, such
as the OpenText Indexer service, separately.

3.1.3 Starting the OpenText Indexer as a service


The OpenText Media Manager service must be running successfully before you start
the OpenText Indexer service.

To start the OpenText Indexer service as a service on Windows:

1. Select Windows Start Menu > Programs > Administrative Tools > Services.

2. Select the OpenText Indexer service entry.

3. Start or stop the service by clicking Start or Stop.

To start the OpenText Indexer service on Linux:

• On a terminal, run the following command:


indexer-process-manager start

Tips
• To stop the service, run the following command:
indexer-process-manager stop
• To restart the OpenText Indexer service, run the following command:
indexer-process-manager restart

3.1.4 Starting OTDS as a Windows service


To start OTDS as a Windows service:

1. Select Windows Start Menu > Programs > Administrative Tools > Services.

2. Select the Apache Tomcat service entry.

3. Start or stop the service by clicking Start or Stop.

OpenText Media Management – Administration Guide 141


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

3.1.5 Signing in to the Media Management user interface


To sign in to the Media Management user interface:

1. Access Media Management through a URL of the following form, substituting


in "http" or "https" for the protocol and the host and port of your OTMM server:
<protocol>://<host:port>/otmm

2. Type in your user name.

3. Type in your password.

4. Click Sign In.

Note: To enable Help in your browser or tablet, either disable the Pop-up
Blocker or add the Media Management web site to the allowed web sites.

3.2 Localizing notifications


You can create locale-specific versions of email and push notifications.

OTMM sends notifications according to an individual user's locale setting in OTMM.


Before sending the notification, OTMM checks the user's locale setting, then it sends
locale specific notifications to the user. If no locale-specific configuration files are
configured, OTMM uses the default locale, which is English.

3.2.1 To localize notifications


Note: When creating localized versions of notifications, do not localize
message replacement tokens within the notification files. OTMM replaces these
tokens with dynamic values before the notifications are sent. Replacement
tokens start with the dollar sign character ($). For example $DUE_DATE.

To localize notifications:

1. Create a subdirectory using the following format within the data/


notification root folder:
<language_Territory>
For example, de_DE.

2. Add the localization email notification folder that you want under the
<language_Territory> folder.

3. Add the localized copies of the following notification configuration files to the
email notification folder. Depending on the data or notification subdirectory
being copied, the notification configuration files will be a subset of the following
files:

• Subject.txt

142 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.2. Localizing notifications

• Body.txt
• From.txt

• body_jobmanager.txt

• body_assignee.txt

• subject_jobmanager.txt

• subject_assignee.txt

• push_title.txt

• push_summary.txt

The following is an example of the directory structure of English (default), Italian,


and French localization files for notifications that OTMM sends when a user
completes a task:

Example 3-1: Directory structure of English, Italian, and French


localization files
<TEAMS_HOME>/data/notification
|- user-task-completed
|- from.txt (default English version)
|- subject.txt (default English version)
|- body.txt (default English version)

|- it_IT (directory
for Italian localization)
|-user-task-completed
|- from.txt (localized
Italian version)
|- subject.txt (localized
Italian version)
|- body.txt (localized
Italian version)

|- fr_FR (directory
for French localization)
|-user-task-completed
|- from.txt (localized
French version)
|- subject.txt (localized
French version)
|- body.txt (localized
French version)

OpenText Media Management – Administration Guide 143


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

3.3 Changing the database connection information


For security reasons, the database connection information for the OTMM database
user account is encrypted. If you need to make any updates, such as updating the
password, you will need to re-encrypt the information.

To change the database connection information:

1. Delete the existing file <TEAMS_HOME>/servers/TEAMS_SEC_Srv.cfg

2. Create a new file named TEAMS_SEC_Srv.cfg in the <TEAMS_HOME>/servers


directory. Enter the database connection information, in the following order
with each on a separate line:

• OTMM Database user password.


• OTMM Database user ID.

The file that needs to be encrypted should look as follows, with every parameter
starting on a new line:

dev364new
dev364new

3. Encrypt the file, by running the script in <TEAMS_HOME>/bin:

WINDOWS
crypt.bat ef <TEAMS_HOME>\servers\TEAMS_SEC_Srv.cfg

LINUX
crypt.sh ef <TEAMS_HOME>/servers/TEAMS_SEC_Srv.cfg

To view the current Database Connection information:

1. Change directory to the <TEAMS_HOME>/install/ant folder.

2. Run the following Ant task to decrypt the security file:


ant decrypt-security-file

3. The text contents of the Database Connection sign-in will be placed in the
<TEAMS_HOME>/servers/TEAMS_SEC_Srv.txt file.

144 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.4. Changing the Indexer sign-in information

3.4 Changing the Indexer sign-in information


The Media Management Indexer must sign in to use the OTMM SDK. To do its job
and to provide the most complete search results, the Indexer must be an
administrative user with the ability to view all assets in the OTMM installation. The
sign-in information for the Indexer is stored in the file <TEAMS_HOME>/servers/
index_SEC.cfg. The TEAMS_ADMIN_USER and TEAMS_ADMIN_PASSWORD parameters
should be replaced with valid administrator sign-in details and must be encrypted.

To change the Indexer administrator account credentials:

1. Stop the Indexer.

2. Change directory to the <TEAMS_HOME>/servers folder.

3. Rename the index_SEC.cfg file to index_SEC.cfj.bak.

4. Create a sign-in file named index_SEC.cfg.

5. Edit the file with the new user name and password information. Enter the user
name on the first line and the password on the second line.

6. Change directory to the <TEAMS_HOME>/install/ant folder.

7. Encrypt the new password file using the following Ant task:
ant encrypt-indexer-login

8. Restart the Indexer and verify that the sign-in works.

To view the current Indexer sign-in information:

1. Change directory to the <TEAMS_HOME>/install/ant folder.

2. Decrypt the sign-in configuration file using the following Ant task:
ant decrypt-indexer-login

3. View the <TEAMS_HOME>/servers/index_SEC.txt file.

3.5 Changing the OTDS sign-in information


The OTDS sign-in information is stored in the <TEAMS_HOME>/servers/
OTDS_SEC_Srv.cfg encrypted file.

To change the OTDS sign-in information:

1. Backup the original OTDS_SEC_Srv.cfg file.

2. Create a new text file called OTDS_SEC_Srv.cfg, and do the following in the file:

a. On the first line, type the user name.


b. On the second line, type the password.

OpenText Media Management – Administration Guide 145


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

3. Once the OTDS_SEC_Srv.cfg text file is created, it can be encrypted using the
following Ant task:
ant encrypt-otds-login

To view the current contents of the encrypted sign-in file:

1. To view the current contents of the OTDS_SEC_Srv.cfg file, use the following
Ant task to decrypt the file:
ant decrypt-otds-login

2. The following decrypt Ant task will generate a text version of the file for
viewing:
<TEAMS_HOME>/servers/OTDS_SEC_Srv.txt

3.6 Moving the repository after importing assets


OTMM has the ability to separate the storage of its content from the OTMM
application using an optional environment variable called TEAMS_REPOSITORY_HOME.
When this variable is not set, content is stored in the default location of
<TEAMS_HOME>/data/repository. When the variable is set, the application will
store and retrieve all content in this location. For example, if you set
TEAMS_REPOSITORY_HOME to /opt1/content, the application will store and retrieve
content from the /opt1/content/data/repository.

If you have not been using TEAMS_REPOSITORY_HOME and already have assets stored
in <TEAMS_HOME>/data/repository, you can copy or move your repository if
desired.

To move the repository after importing assets:

1. Stop the OTMM application.

2. Ensure your content and OTMM application are safely backed up.

3. Create your <TEAMS_REPOSITORY_HOME> directory (for example mkdir /opt1/


content).

4. Create a subdirectory called data under <TEAMS_REPOSITORY_HOME> and a


subdirectory called repository under data (for example /opt1/content/data/
repository).

5. Copy the entire <TEAMS_HOME>/data/repository directory to


<TEAMS_REPOSITORY_HOME>/data.

6. Set the TEAMS_REPOSITORY_HOME environment variable.

7. Restart your OTMM application.

8. Rename the <TEAMS_HOME>/data/repository directory so you can verify that


the application will not find content from this old location. For example, move
<TEAMS_HOME>/data/repository to <TEAMS_HOME>/data/repo.old.

146 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.7. Configuring content managers

9. Verify imports, exports, checkout, and check-in work with the new repository
location.

10. Remove your old repository (for example rm–rf <TEAMS_HOME>/data/


repository).

Note: Depending on the size of your content repository, you may decide
to instead move a copy of your repository. Or, if you are running on
Linux, you may decide to use soft links.

3.7 Configuring content managers


A content manager implementation is intended to provide an interface to any
storage medium. Each implementation provides methods for reading, writing, and
deleting content within its particular storage medium. For more information, see
ArtesiaContentManager class in OpenText Media Management Programmer Guide
(https://knowledge.opentext.com/knowledge/llisapi.dll/Properties/69371555).

Note: The following sections include the classes for Microsoft Azure blob
storage, Amazon S3 storage, and Google Cloud storage. For more information,
see one of the following:

• “Configuring Microsoft Azure blob storage” on page 148


• “Configuring Amazon S3 storage” on page 150
• “Configuring Google Cloud Storage” on page 153

Each content manager has a list of attributes that the implementation requires or
uses to store content in the storage medium. OTMM includes support a specific list
of content managers. This section discusses the configuration prerequisites of those
supported content managers and their attributes.

3.7.1 Configuring content manager attributes


Content manager attributes provide additional information for the content manager
implementation to interact with the storage medium. Some attributes are optional.
The default values for these optional attributes are either picked up from system
settings or defaulted to a fixed value in the implementation. Other attributes are
mandatory, without which the content manager implementation will not work.

The following attributes are applicable to all the content managers irrespective of
their implementation:

AUDIO_BASE_URL
This attribute is used to generate the streaming URL for the audio asset that
needs to be played through the OTMM user interface.

Note: Each content manager has specific attributes for this setting. For
more information, see the following:

OpenText Media Management – Administration Guide 147


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

• “Configuring Microsoft Azure blob storage” on page 148


• “Configuring Amazon S3 storage” on page 150
• “Configuring Google Cloud Storage” on page 153

VIDEO_BASE_URL
This attribute is used to generate the streaming URL for the video asset that
needs to be played through the OTMM user interface.

Note: Each content manager has specific attributes for this setting. For
more information, see the following:
• “Configuring Microsoft Azure blob storage” on page 148
• “Configuring Amazon S3 storage” on page 150
• “Configuring Google Cloud Storage” on page 153

AUDIO_PROGRESSIVE_DOWNLOAD_URL
If the AUDIO_BASE_URL is set to a streaming server for clients that do not support
configured streaming server to play proxies, set this to the base URL of the
progressive download server to play audio proxies.
VIDEO_PROGRESSIVE_DOWNLOAD_URL
If the VIDEO_BASE_URL is set to a streaming server for clients that do not support
configured streaming server to play proxies, then set this to the base URL of the
progressive download server to play video proxies.
The default is <Base URL of the progressive download server>.

You can configure these attributes for each of the content managers in the system.
These attributes are used to generate the streaming URLs for the video and audio
assets that are to be played through the OTMM user interface. If you do not
configure these attributes for a content manager, the default values are picked up
from the system settings configuration. These attributes provide a way for the video
and audio assets to be stored in multiple content managers and allow them to be
played in the user interface as each content manager has its own base URLs
configured for streaming.

3.7.2 Configuring Microsoft Azure blob storage


You can configure a new content manager for Azure blob storage by specifying the
content_manager_class as com.artesia.server.
content.AzureBlobStorageContentManager. You can configure the
storage_root to a blob container name in the Azure blob storage account. If you do
not specify the value for storage_root, this value defaults to otmm.

The content manager creates a container, or uses an existing container, in the blob
storage account with the name specified in the storage_root.

In addition to the common attributes listed in “Configuring content manager


attributes” on page 147, the following is the list of supported attributes for Azure
blob content manager.

148 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.7. Configuring content managers

AUDIO_BASE_ This attribute is used to generate the streaming URL for the audio asset
URL that needs to be played through the OTMM user interface.

https://<account_name>.blob.core.windows.net/
<azure_folder_name>

where

<azure_folder_name> is the same as what you configure for


<storage_root>
VIDEO_BASE_ This attribute is used to generate the streaming URL for the video asset
URL that needs to be played through the OTMM user interface.

https://<account_name>.blob.core.windows.net/
<azure_folder_name>

where

<azure_folder_name> is the same as what you configure for


storage_root
AUDIO_PROG If the AUDIO_BASE_URL is set to a streaming server for clients that do not
RESSIVE_DO support configured streaming server to play proxies, set this to the base
WNLOAD_UR URL of the progressive download server to play audio proxies.
L
VIDEO_PROG If the VIDEO_BASE_URL is set to a streaming server for clients that do not
RESSIVE_DO support configured streaming server to play proxies, then set this to the
WNLOAD_UR base URL of the progressive download server to play video proxies.
L
The default is <Base URL of the progressive download server>.
account_name The name of the Azure blob account to be used for this content manager.
account_key The account key to be used for communicating with this Azure blob
account configured in account_name.

Note: The attribute is mandatory.

communication The protocol to be used to communicate with the Azure account. It


_protocol supports HTTP and HTTPS protocols.

Note: The default value is HTTPS.

access_policy The access policy that you need to set for the storage_root folder if you
created it through the content manager implementation. The following
values are supported:
• PRIVATE
• CONTAINER
• BLOB

Note: The default value is BLOB.

OpenText Media Management – Administration Guide 149


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

sas The shared access signature to will used to access any private blobs in the
Azure storage account.
• This attribute is required only if the access_policy for the
storage_root is PRIVATE.
• The value for this attribute must be generated in the Azure portal only.
• OTMM must have read permissions for blob objects.

Note: For more information about blob storage, Azure blob and how to
configure it, see https://azure.microsoft.com/en-in/documentation/services/
storage/.

3.7.3 Configuring Amazon S3 storage


You can configure a content manager for Amazon S3 by specifying the
content_manager_class as com.artesia.server.
content.AmazonS3ContentManager. You must configure the storage_root to a
bucket name in Amazon S3.

In addition to the common attributes listed in “Configuring content manager


attributes” on page 147, the following is the list of supported attributes for Amazon
S3 storage:

AUDIO_BASE_ This attribute is used to generate the streaming URL for the audio asset
URL that needs to be played through the OTMM user interface.

https://s3-<region>.amazonaws.com/bucketname

where

<bucket-name> is the same as what you configure for storage_root.


VIDEO_BASE_ This attribute is used to generate the streaming URL for the video asset
URL that needs to be played through the OTMM user interface.

https://s3-<region>.amazonaws.com/bucketname

where

<bucket-name> is the same as what you configure for storage_root.


AUDIO_PROG If the AUDIO_BASE_URL is set to a streaming server for clients that do not
RESSIVE_DO support configured streaming server to play proxies, set this to the base
WNLOAD_UR URL of the progressive download server to play audio proxies.
L
VIDEO_PROG If the VIDEO_BASE_URL is set to a streaming server for clients that do not
RESSIVE_DO support configured streaming server to play proxies, then set this to the
WNLOAD_UR base URL of the progressive download server to play video proxies.
L
The default is <Base URL of the progressive download server>.

150 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.7. Configuring content managers

access_key_id An alphanumeric text string that uniquely identifies the user who owns
the AWS account.

Note: This attribute is mandatory.

secret_access_k A secret 40-character string that is used to communicate the AWS account.
ey
Note: This attribute is mandatory.

region The geographical region of the Amazon S3 bucket. Specify the value of the
region where the Amazon S3 bucket is created. For more information
about the values for regions, see http://docs.aws.amazon.com/AWSEC2/
latest/UserGuide/using-regions-availability-zones.html.

Note: This attribute is mandatory.

storage_class The storage class for the objects (files) that you store in Amazon S3.
Specify the value of the storage class based on your use case scenario and
performance access requirements.

Note: This attribute is mandatory.

The default value is STANDARD.

OpenText Media Management – Administration Guide 151


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

access_control_ Using the Amazon S3 Access Control Lists (ACLs), you can manage access
list_xml to objects (files). Each object has an ACL attached to it as a subresource.
The ACL object defines which AWS accounts or groups are granted access
and the type of access. When a request is received against a resource,
Amazon S3 checks the corresponding ACL to verify that the requester has
the required access permissions. You must specify the XML string that
contains the access permissions that will be on the object.

Note: This attribute is mandatory.

The following is an example of an XML string:

<?xml version="1.0" encoding="UTF-8"?>

<AccessControlPolicy xmlns="http://s3.amazonaws.com/
doc/2006-03-01/">

<AccessControlList>

<Grant>

<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance"

xsi:type="CanonicalUser">

<ID>e820c9e3203a45321593dfab8aca90ffec522a1adc96c748be
f925a1562777ee</ID>

</Grantee>

<Permission>FullControl</Permission>

</Grant>

<Grant>

<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance"

xsi:type="Group">

<URI>http://acs.amazonaws.com/groups/global/
Authenticatedusers</URI>

</Grantee>

<Permission>FullControl</Permission>

</Grant>

<Grant>

<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-

152 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.7. Configuring content managers

instance"

xsi:type="Group">

<URI>http://acs.amazonaws.com/groups/global/AllUsers</
URI>

</Grantee>

<Permission>Read</Permission>

</Grant>

<Grant>

<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance"

xsi:type="Group">

<URI>http://acs.amazonaws.com/groups/s3/LogDelivery</
URI>

</Grantee>

<Permission>Write</Permission>

</Grant>

</AccessControlList>

</AccessControlPolicy>

Note: For more information about Amazon S3 storage and its configuration,
see https://aws.amazon.com/documentation/s3/.

3.7.4 Configuring Google Cloud Storage


You can configure a content manager for Google Cloud Storage by specifying the
content_manager_class as com.artesia.server.
content.GoogleCloudStorageContentManager. You must configure the
storage_root to a bucket name in Google Cloud Storage.

The following describes the list of supported attributes for Google Cloud storage in
addition to the common attributes listed in “Configuring content manager
attributes” on page 147:

OpenText Media Management – Administration Guide 153


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

AUDIO_BASE_ This attribute is used to generate the streaming URL for the audio asset
URL that needs to be played through the OTMM user interface.

http://storage.googleapis.com/<bucket-name>

where

<bucket-name> is the same as what you configure for storage_root.


VIDEO_BASE_ This attribute is used to generate the streaming URL for the video asset
URL that needs to be played through the OTMM user interface.

http://storage.googleapis.com/<bucket-name>

where

<bucket-name> is the same as what you configure for storage_root.


AUDIO_PROG If the AUDIO_BASE_URL is set to a streaming server for clients that do not
RESSIVE_DO support configured streaming server to play proxies, set this to the base
WNLOAD_UR URL of the progressive download server to play audio proxies.
L
VIDEO_PROG If the VIDEO_BASE_URL is set to a streaming server for clients that do not
RESSIVE_DO support configured streaming server to play proxies, then set this to the
WNLOAD_UR base URL of the progressive download server to play video proxies.
L
The default is <Base URL of the progressive download server>.
service_account ID of the service account.
_id
Note: This attribute is mandatory.

service_account ID of the private key to use with the service account flow
_private_key_i
d Note: This attribute is mandatory.

service_account Private key to use with the service account flow.


_private_key
storage_class Storage class for the objects (files) that you store in Google Cloud storage.
Specify the value of the storage class depending on your use case scenario
and performance access requirements.

Notes
• This attribute is mandatory.
• The default value is multi_regional.

154 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.7. Configuring content managers

access_control_ Using Google Cloud Storage Access Control Lists (ACLs), you can
list_json manage access to objects (files). You can control who has access to your
objects and what level of access they have. You need to specify the JSON
string that contains the access permissions that need to be set on the
object.

Note: This attribute is mandatory.

The following is an example of a JSON string:

"acl": [{

"entity": "project-owners-<project-id>",

"role": "OWNER"

},

"entity": "user-<user-email-id>",

"role": "OWNER"

},

"entity": "AllUsers",

"role": "READER"

}]

Note: For more information about Google Cloud storage and its configuration,
see https://cloud.google.com/storage/docs/.

OpenText Media Management – Administration Guide 155


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

3.7.5 Changing the default content manager


The default content manager is filesystem. You can change it to a cloud storage that
OTMM supports.

To change the default content manager:

1. Configure the attributes of the content manager. For more information, see
“Configuring content manager attributes” on page 147.

2. Configure the content manager that you want to set as the default content
manager. For more information, see one of the following:

• “Configuring Microsoft Azure blob storage” on page 148


• “Configuring Amazon S3 storage” on page 150
• “Configuring Google Cloud Storage” on page 153

3. On the top-level menu, click Settings, in the Configuration group name


column, navigate to the Import row, and click the Edit components link.

4. On the Configuration group page, navigate to the IMPORT\SERVER group,


and navigate to the following properties and edit them accordingly:

DEFAULT_CO • In the Value column, enter the ID for the content manager that
NTENT_MAN you provided when you configured it.
AGER_ID • In the Active column, select the check box.
KEYFRAME_C • In the Value column, enter the key frame ID of the content
ONTENT_MA manager.
NAGER_ID • In the Active column, select the check box.
RENDITION_ • In the Value column, enter the manager ID for the thumbnails ID.
CONTENT_M
ANAGER_ID • In the Active column, select the check box.

VIDEO_PROX • In the Value column, enter the manager for the video proxy ID.
Y_CONTENT_
MANAGER_ID • In the Active column, select the check box.

Note: By default, KEYFRAME_CONTENT_MANAGER_ID,


RENDITION_CONTENT_MANAGER_ID, and
VIDEO_PROXY_CONTENT_MANAGER_ID are not active. To use any other
content manager other than file system as the repository for these types of
contents, you must make them active.

156 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.7. Configuring content managers

3.7.6 Configuring cloud storage for Review Jobs


To configure cloud storage for Review Jobs:

1. On the top-level menu, click Settings, in the Configuration group name


column, navigate to the Reviews row, and click the Edit components link.

2. On the Configuration group page, navigate to the CREATIVEREVIEW\VIKI


component, and then update the
USE_PREVIEW_PROXY_FOR_CONTENT_TYPE property by appending
BITMAP to the default value.

3. On the Settings page, in the Configuration group name column, navigate to the
Import row, and click the Edit components link.

4. Navigate to the IMPORT\SERVER component, and then update the


RENDITION_CONTENT_MANAGER_ID property with the following value:
ARTESIA.CONTENT.FILESYSTEM.

5. Navigate to the Active row of RENDITION_CONTENT_MANAGER_ID and


select its check box.

3.7.7 Configuring cloud storage for streaming


To configure cloud storage for streaming:

1. On the top-level menu, click Settings.

2. To use the streaming servers that OTMM supports, do the following:

a. On the Settings page, in the Configuration group name column, navigate


to the Import row, and click the Edit components link.
b. Navigate to the IMPORT\SERVER component.
c. Update the VIDEO_PROXY_CONTENT_MANAGER_ID property with
following value:
ARTESIA.CONTENT.FILESYSTEM
For more information, see “Editing a component and properties”
on page 136.
d. Navigate to the Active column and select the check box.

Note: For more information about supported streaming servers, see


OpenText Media Management Technical Specifications (https://
knowledge.opentext.com/knowledge/llisapi.dll/Properties/69371555).

3. To use cloud-based streaming servers, do the following:

a. On the Settings page, in the Configuration group name column, navigate


to the Video row, and click the Edit components link.
b. Navigate to the VIDEO\TRANSCODE component.

OpenText Media Management – Administration Guide 157


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

c. Update the VIDEO_BASE_URL and AUDIO_BASE_URL properties. For more


information, see “Editing a component and properties” on page 136.

3.7.8 Configuring cloud storage for Adaptive Media Delivery


Adaptive Media Delivery works when the OTMM storage repository is not shared.

3.8 Configuring Rich Media Analysis Service


Rich Media Analysis Service analyzes assets. Assets are populated with metadata
based on the results of the analysis.

This service can analyze assets during ingest or at later time through jobs that you
schedule on the Media Analysis Management page.

Ingest includes processes where assets are added to OTMM, such as import, check-
in, and attach content processes.

During ingest, assets are submitted to the service for analysis. The results of the
analysis are returned to OTMM asynchronously during the post-import process and
OTMM populates the assets with the metadata.

Notes
• For more information about scheduling jobs for Rich Media Analysis Service
for existing assets, see “Adding a schedule” on page 116.
• You can also modify the system configuration changes. For more
information, see “Tuning considerations for Rich Media Analysis Service”
on page 159.

Important
Prior to having the service analyze assets during ingest or at a later time, you
must perform preparation and configuration tasks.

3.8.1 Preparing and configuring for the analysis of assets


To prepare and configure for the analysis of assets:

1. Make assets eligible for media analysis. To do this, the following criteria must
be met:

a. Ensure that the asset metadata model contains the ARTESIA.


CATEGORY.MEDIA ANALYSIS metadata field group.
b. Only image assets, such as bitmap content type assets, are eligible for
media analysis.

2. Configure the value of the MEDIAANALYSIS_ENABLED and


ENABLE_MEDIAANALYSIS_DURING_INGEST settings to true. For more
information, see “MEDIAANALYSIS\GENERAL” on page 261.

158 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.8. Configuring Rich Media Analysis Service

Notes

• This setting is available under the MEDIAANALYSIS\GENERAL


component, which belongs to the configuration group. For more
information, see “Editing a component and properties” on page 136.
• After modifying MEDIAANALYSIS_ENABLED annd
ENABLE_MEDIAANALYSIS_DURING_INGEST, you must clear the caches.

3.8.2 Tuning considerations for Rich Media Analysis Service


You can tune Rich Media Analysis Service properties to achieve better performance.
While these recommendations may help you achieve the maximum performance
from your installation, OpenText cannot guarantee that these recommendations will
provide a noticeable or measurable performance impact on your system. In an effort
to measure the impact of these tuning activities, OpenText recommends that you
take a “timed benchmark” of common user actions before and after any of these
tuning activities. In addition, a complete system backup should be taken before any
of these steps are implemented.

To tune Rich Media Analysis Service:

1. In a text editor, open the <Rich_Media_Analysis_HOME>/conf/


application.properties configuration file.

2. Edit any of the following settings accordingly:

mediaanalysis.j Provides confirmation that a job was submitted. Confirmation is sent


obs.confirm once the job request is persisted, such as to disk. Enabling this setting
may slow down the job submission. By default, this is set to true.
mediaanalysis.j The number of concurrent Rich Media Analysis jobs. This setting
obs.analytics.co limits the number of concurrent requests to Azure. By default, this is
ncurrent-count set to 1.
mediaanalysis.j The number of concurrent processed jobs. This setting limits the
obs.processed.c number of concurrent callback requests to OTMM. By default, this is
oncurrent- set to 1.
count
mediaanalysis.j The number of times, in days, that failed delivery jobs are preserved.
obs.delivered.tt By default, this is set to 7.
l-days
mediaanalysis.j The number of times, in days, that successful delivery jobs are
obs.failed- preserved. By default, this is set to 30.
delivery.ttl-
days

3. Restart OpenText Media Manager Rich Media Analysis Service.

4. Verify that the service started properly.

OpenText Media Management – Administration Guide 159


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

3.9 Configuring SSL


This section discusses configuring SSL.

3.9.1 Configuring OTMM for SSL


The primary task to implement SSL on your OTMM installation is configuring the
application server that OTMM is installed on. However, you also need to make
changes within the OTMM configuration. As a prerequisite, a set of SSL encryption
keys and an SSL encryption certificate are required. You can purchase these from a
certificate-signing authority, or you can generate them yourself using command-line
utilities.

You need to do the following configurations:


• Generate certificates.
• Configure the application server.
• Configure the application.

3.9.2 Generating Certificates


To generate certificates:

1. Shut down the OpenText Media Manager service.


2. For SSL setup, create a public/private key pair. Use the Java default, "JKS"
Keystore, as the key/certificate repository. For other supported types of
keystores, see the JBoss documentation. Oracle JDK includes a Keystore
Management Tool, called keytool, to manage "JKS" keystores, which is located
at:
%JAVA_HOME%\bin\keytool

Notes
• If the APR/Tomcat Native Library is used, you need OpenSSL to
generate keys/certificates. For more information, see the JBoss AS 6.4
documentation.
• For more information about the keytool utility, see http://
docs.oracle.com/javase/8/docs/technotes/tools/windows/keytool.html
(http://docs.oracle.com/javase/7/docs/technotes/tools/windows/
keytool.html).

a. To generate a public/private key pair, run the following command:


keytool -genkey -alias otmm -keyalg RSA -keystore
<path_to_new_keystore>-storepass <keystore password>
Where the alias otmm is a reference handle to the newly created key pair in
the specified keystore. If the keystore does not exist, it is automatically
created.

160 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.9. Configuring SSL

Follow the prompts and provide all the necessary information. The CN field
must be the same as the domain name that is used to access the Media
Management Web Client. For example, if OTMM is accessed through the
URL http://www.companyA.com/otmm, then the CN contained in your
certificate must be www.companyA.com.
b. Do the following to create a CA signed certificate:

Notes
• If you are running a development environment, a self-signed
certificate associated with the public key is sufficient. You can
proceed to Step 3.
• In a production deployment, a CA signed certificate is typically
used.

i. Run the following command to create a certificate signing request for


the generated public key:
keytool -certreq -alias otmm -file otmm.csr -keystore
<path_to_keystore> -storepass <keystore password>

Note: The certificate signing request otmm.csr is submitted to


the CA. This could be a formal process at the end of which CA
gives a Certificate reply.
ii. Run the following command to import the certificate reply to the
keystore:
keytool -import -alias otmm -file certificate_reply
-keystore path_to_keystore -storepass <keystore password>
where:
certificate_reply is the file received from the CA.

3. Copy or move the new keystore to the following location:


<JBOSS_HOME>\standalone\configuration

3.9.3 Configuring the application server


To configure JBoss EAP:

1. Back up the <JBOSS_HOME>\standalone\otmm.xml file.

2. In a text editor, open the otmm.xml file, and locate <JBOSS_HOME>\standalone\


otmm.xml.

3. Navigate to the web subsystem tag, and comment out the HTTP/1.1 Connector.

4. Create a secure connector, named HTTPS, which uses the HTTPS scheme, the
HTTPS socket binding, which defaults to 11443, and is set to be secure. Add the
connector and configure a new keystore as a server identity for SSL. For
example:

OpenText Media Management – Administration Guide 161


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

<subsystem xmlns="urn:jboss:domain:web:2.2" default-virtual-


server="default-host" native="false">
<!-- ... -->
<connector name="HTTPS" protocol="HTTP/1.1" scheme="https"
socket-binding="https" secure="true">
<ssl name="https" key-alias="<keyAlias>"
password="<keystorePassword>" certificate-key-
file="<keystoreFile>" protocol="TLSv1"/>
</connector>

where:

• <keyAlias> is the alias name of the keystore

• <keystoreFile> is ${jboss.server.config.dir}\<your keystore file>

• <keystorePassword> is the keystore password

Note: If the keystore has multiple public/private key pairs, the reference
handle to the key pair to be used for SSL has to be specified using a
keyAlias attribute in the Connector element. In the above example,
keyAlias would be otmm.

To configure Wildfly:

1. Back up the <JBOSS_HOME>\standalone\otmm.xml file.

2. In a text editor, open the otmm.xml file.

3. Add a new security realm for SSL configuration. Configure an additional


security realm for SSL and a new keystore as a server identity for SSL in the
WildFly security-realms section of the otmm.xml file. For example:

<management>
<security-realms>
<!-- ... -->
<security-realm name="<SSLRealm>">
<server-identities>
<ssl>
<keystore path="<keystoreFile>" relative-
to="jboss.server.config.dir" keystore-
password="<keystorePassword>" alias="<keyAlias>"/>
</ssl>
</server-identities>
</security-realm>
<!-- ... -->

where:

• <SSLRealm> is the name of SSL realm

• <keyAlias> is the alias name of the keystore

• <keystoreFile> is the keystore file

• <keystorePassword> is the keystore password

162 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.9. Configuring SSL

Note: If the keystore has multiple public/private key pairs, the reference
handle to the key pair to be used for SSL has to be specified using the
keyAlias attribute in the Connector element. In the above example,
keyAlias would be otmm.

4. Navigate to the undertow subsystem element, and then comment out the HTTP/
1.1 Connector.

Note: Instead of disabling the HTTP connector, check “Redirecting HTTP


requests to HTTPS” on page 165.

5. To add a new HTTPS-listener for HTTPS, do the following:

a. Configure the undertow subsystem for SSL using default-server.


b. Add the https-listener to the undertow subsystem. For example:

<subsystem xmlns="urn:jboss:domain:undertow:2.0">
<!-- ... -->
<server name="default-server">
<!-- ... -->
<https-listener name="https" socket-
binding="https" security-realm="<SSLRealm>" max-post-
size="0"/>
<! -- ... -->

where:
SSLRealm is the name of the realm that created in Step 3.

3.9.4 Configuring the application


To configure the application:

1. To configure the OTMM setting, edit the URL in the WEB_APPS_BASE_URL


property. This is available under the WEB_APPLICATIONS\CONFIG
component, which belongs to the General configuration group. For more
information, see “Editing a component and properties” on page 136.

Note: When entering the URL, be sure to specify the correct protocol and
port, such as HTTPS.

2. To re-configure the Push Connector for Media Management to use SSL, do the
following:

a. Verify that the Media Management server is running.


b. Sign in to OTDS Web Client.
c. Do the following:

• Edit the Media Management resource.


• Edit the Media Management URL.

OpenText Media Management – Administration Guide 163


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

Notes
• When you enter the URL, you must specify the correct protocol
and port, such as HTTPS.
• For HA configurations, the host and port of the URL must be the
same as the Media Management load-balancer.
• Provide the password of the Media Management administrator.

3.9.5 Securing the session cookie


To secure the session cookie:

• Uncomment <secure>true</secure> under the <cookie-config> element in


the web.xml files in the following locations:

JBoss EAP and Wildfly

• <TEAMS_HOME>/ear/artesia.ear/artesia-ws.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia.ear/content.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia.ear/restapi.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia.ear/otmmux.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia.ear/artesia-ux-ws.war/WEB-INF/
web.xml

• <TEAMS_HOME>/ear/artesia.ear/teams.war/WEB-INF/web.xml

TomEE

• <TEAMS_HOME>/ear/artesia/artesia-ws.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia/content.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia/restapi.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia/otmmux.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia/teams.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia.ear/teams.war/WEB-INF/web.xml

164 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.9. Configuring SSL

3.9.6 Redirecting HTTP requests to HTTPS


If you implemented Secure Sockets Layer (SSL) on your OTMM installation, you can
set up JBoss Web to redirect all HTTP requests to HTTPS requests.

To set up JBoss Web to redirect all HTTP requests to HTTPS requests:

1. Edit the following files:

JBoss EAP and Wildfly

• <TEAMS_HOME>/ear/artesia.ear/artesia-ws.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia.ear/content.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia.ear/restapi.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia.ear/otmmux.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia.ear/artesia-ux-ws.war/WEB-INF/
web.xml

• <TEAMS_HOME>/ear/artesia.ear/teams.war/WEB-INF/web.xml

TomEE

• <TEAMS_HOME>/ear/artesia/artesia-ws.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia/content.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia/restapi.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia/otmmux.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia/teams.war/WEB-INF/web.xml
• <TEAMS_HOME>/ear/artesia.ear/teams.war/WEB-INF/web.xml

2. Add the following lines to each of the above files:

<security-constraint>
<web-resource-collection>
<web-resource-name>WEB_APPLICATION_NAME</web-resource-
name>
<url-pattern>/*</url-pattern>
</web-resource-collection>
<user-data-constraint>
<transport-guarantee>CONFIDENTIAL</transport-guarantee>
</user-data-constraint>
</security-constraint>

where
WEB_APPLICATION_NAME is the name of application.
For example:
WEB_APPLICATION_NAME is teams

OpenText Media Management – Administration Guide 165


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

3.10 Updating or recovering or the JBoss password


You can access the JBoss Management Console using the following URL:

http://localhost:19990/console

In the configuration that is included with Media Management, you can only access
the JBoss Management Console from the server where Media Management is
deployed. As part of the Media Management setup, the admin console is configured
with the default user ID, admin, and password, artesia, unless an OTMM user was
setup prior to the Media Management installation.

To recover or update the default JBoss password:

1. To recover the password, run the following script:

WINDOWS
<JBOSS_HOME>/bin/add-user.bat

LINUX
<JBOSS_HOME>/bin/add-user.sh

2. To update the password, run the script Step 1, use same user name, but specify
different password.

Note: For more information about configuring access to the management


console and using it to configure the application server, see the JBoss
documentation.

3.11 Changing the default JBoss server ports


By default, OTMM uses ports 11090 (HTTP), 11091 (AJP) and 11099 (JNDI Port). To
customize these ports, modify the following file:

JBOSS_HOME/standalone/configuration/otmm.xml

All default port bindings are placed in the socket-binding-group XML element.
The port-offset attribute is common across all socket-binding default ports.

For more information about how to change the JBoss web server port and the JBoss
JNDI naming port, which are two of the most commonly changed ports, see the
following:

• “Changing the JBoss JNDI naming port” on page 167


• “Changing the shutdown port” on page 167

166 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.11. Changing the default JBoss server ports

3.11.1 Changing the JBoss web server port


By default, the Media Management Web Client port is 11090. If you change this
port, you will need to update the URL value for WEB_APPS_BASE_URL.

Notes
• For more information about how to edit the settings of a component, see
“Editing a component and properties” on page 136.
• The WEB_APPS_BASE_URL setting is located under the
WEB_APPLICATIONS\CONFIG component, which belongs to the General
configuration group.

3.11.2 Changing the JBoss JNDI naming port


By default, the JNDI naming port is set to 11099. If you change this port, you will
need to update the value for PROVIDER_HOST in [JNDI\CONFIG] section of all
Tresource files. You will also need to update the port number in the JBoss
shutdown script, which is stored in the following location:

WINDOWS

"$JBOSS_HOME/server/teams/bin/shutdown.bat"

LINUX

"$JBOSS_HOME/server/teams/bin/shutdown.sh"

3.11.3 Changing the shutdown port


By default, the controller port is 19990 for WildFly and 19999 for JBoss EAP. If you
change this port, you also need to update the port number in the JBoss shutdown
script, which is stored in the following location:

WINDOWS
${TEAMS_HOME}/bin/artesia-process-manager-wrapper-windows-conf.
bat

LINUX
${TEAMS_HOME}/bin/artesia-process-manager-wrapper-unix.conf

OpenText Media Management – Administration Guide 167


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

3.12 Enabling search term logging


Search Term Logging provides a detailed record of all successful searches
performed through the OTMM Search API. It will log all interactive searches as well
as saved searches.

To enable the Search Term Logging feature, set the


SEARCH_HISTORY_LOGGING_ENABLED setting to Y. This setting is located under the
SEARCH\SERVER component, which belongs to the Search configuration group.
You can access this group from the Settings page. For more information, see
“Editing a component and properties” on page 136.

Note: If the setting is not present in the SEARCH\SERVER component, the


default is N.

3.12.1 Enabling internal search logging


In some cases, the Search API is used internally by the OTMM application as part of
other processing. For example, the Content Monitor Services performs searches
through the Search API as part of its processing. These searches are marked as
internal searches in the Search Term Log. It is assumed that customers generally
will not be interested in these internal searches, therefore logging is disabled by
default. To enable logging of internal searches, set the
SEARCH_HISTORY_LOG_INTERNAL_SEARCHES setting to Y. This setting is located
under the SEARCH\SERVER component, which belongs to the Search
configuration group. For more information, see “Editing a component and
properties” on page 136.

Note: If the setting is not present in the SEARCH\SERVER component, the


default value is N.

For debugging purposes, there may be cases where you only want to capture
internal searches in the Search Term Log. If you want to disable logging of non-
internal searches in these cases, set the SEARCH_HISTORY_LOG_EXTERNAL_SEARCHES
setting to N. This setting is located under the SEARCH\SERVER component, which
belongs to the Search configuration group. For more information, see “Editing a
component and properties” on page 136.

Note: If the entry is not present in the SEARCH\SERVER component, the


default value is Y.

For more information about what information is logged and which tables are used,
see Section 3.3 “Search Term Logging” in OpenText Media Management - Integration
Guide (MEDMGT160300-AIN).

168 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.13. Preparing to export asset URLs

3.13 Preparing to export asset URLs


You will need to perform the following task before using the Export Asset URL
feature.

To prepare your database for the Export Asset URL feature:

• Do one of the following:

• SQL Server

DELETE from EXPORT_URL_ASSETS WHERE EXPORT_URL_ID in


(select ID from EXPORT_URL where URL_EXPIRY_TIME < GETDATE());
DELETE from EXPORT_URL WHERE URL_EXPIRY_TIME < GETDATE();
• Oracle

DELETE from EXPORT_URL_ASSETS WHERE EXPORT_URL_ID in


(select ID from EXPORT_URL where URL_EXPIRY_TIME < sysdate);
DELETE from EXPORT_URL WHERE URL_EXPIRY_TIME < sysdate;
• PostgreSQL

DELETE from EXPORT_URL_ASSETS WHERE EXPORT_URL_ID in


(select ID from EXPORT_URL where URL_EXPIRY_TIME <
current_timestamp);
DELETE from EXPORT_URL WHERE URL_EXPIRY_TIME <
current_timestamp;
• SAP HANA

DELETE from EXPORT_URL_ASSETS WHERE EXPORT_URL_ID in


(select ID from EXPORT_URL where URL_EXPIRY_TIME <
current_timestamp);
DELETE from EXPORT_URL WHERE URL_EXPIRY_TIME <
current_timestamp

3.14 Administering the Search Index


Administering the Search Index includes the following topics:
• “Re-indexing the Search Index database” on page 170
• “The Media Management Indexer” on page 173

OpenText Media Management – Administration Guide 169


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

3.14.1 Re-indexing the Search Index database


You must re-index the Search Index database should one of the following situations
occur:

• If you changed the Search Index configuration.


• If your Search Index database has become corrupt.

If your Search Index database has become corrupt, perform the following procedure.

Important

• A re-index of the Search Index database can be time consuming if you are
re-indexing a large amount of data. If that is the case, you should consider
performing the following procedure during off hours.
• Performing a complete reindex of Solr invalidates any backup files that
you created prior to reindexing.

To re-index the Search Index database:

1. Stop the Media Management Indexer.

Note: In an HA environment, stop the Indexer on all hosts.

2. Run the following command from the <TEAMS_HOME>/install/ant directory:

Note: In an HA environment, run the following command on one of the


nodes only:
ant reset-search-indexes

3. Start the Media Management Indexer.

Note: In an HA environment, start the Indexer on all hosts.

When the Indexer starts, it will re-index all assets.

3.14.2 Configuring the Search Indexer engine


Word variations (synonyms)

By default, the Media Management Solr search index is configured to use the Solr
SynonymFilterFactory. This is defined in the Solr schema.xml in the query
analyzers for the otft_text_stemmed and otft_text_unstemmed fieldTypes. The
SynonymFilterFactory is configured with the following parameters:

<filter class="solr.SynonymFilterFactory" synonyms="synonyms.txt"


ignoreCase="true" expand="true"/>

170 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.14. Administering the Search Index

What this means is that any synonym definitions added to the synonyms.txt
configuration file will be used to perform term expansion when keyword searching
or searching textual metadata fields. For example:

Example:

# blank lines and lines starting with pound are comments.

# Explicit mappings match any token sequence on the LHS of "=>"


# and replace with all alternatives on the RHS. These types of
mappings
# ignore the expand parameter in the schema.
# Examples:
colour, hue => color, tone
i-pod => ipod

# Equivalent synonyms may be separated with commas and give


# no explicit mapping. In this case the mapping behavior will
# be taken from the expand parameter in the schema. This allows
# the same synonym file to be used in different synonym handling
# strategies.
# Examples:
foozball, foosball
MB, mbyte, megabyte

# If expand==true, "MB, mbyte, megabyte" is equivalent to the


explicit mapping:
MB, mbyte, megabyte => MB, mbyte, megabyte
# If expand==false, "MB, mbyte, megabyte" is equivalent to the
explicit mapping:
MB, mbyte, megabyte => MB

#multiple synonym mapping entries are merged.


foo => bar
foo => baz
#is equivalent to
foo => bar, baz

The expand value is set to true. As a result, when querying, terms searched that are
listed in an equivalent synonyms entry will be expanded to include the full list of
synonyms for that entry.

The ignoreCase value is set to true, so the case of matching synonym entries will
be ignored.

As an administrator, you can edit the synonyms.txt configuration file with


synonym lists that are relevant for their environment.

OpenText Media Management – Administration Guide 171


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

3.14.2.1 Modifying the synonyms.txt configuration file


As an administrator, you can edit the synonyms.txt configuration file with
synonym lists that are relevant for their environment.

Note: There is an open issue with Solr for multi-term synonyms (that is, "IRS,
Internal Revenue Service") logged under SOLR-5379 (https://issues.apache.org/
jira/browse/SOLR-5379). Only single term synonyms should be entered in the
synonyms.txt file.

To modify the synonyms.txt configuration file:

Note: If Solr is installed in an HA configuration, stop the Solr service on all


nodes prior to performing this task, and then proceed to Step 1.

1. Back up the current Solr synonyms file by copying the <TEAMS_HOME>/


solr5_otmm/otmmcore/conf/synonyms.txt configuration file.

2. In a text editor, open the synonyms.txt file, and edit the synonym lists
accordingly.

3. If Solr is installed on a remote server, replace the synonyms.txt file on the


remote server's index by copying it from <TEAMS_HOME>/solr5_otmm/
otmmcore/conf.

Note: Linux - After copying the synonyms.txt file to the remote server,
change the permissions of the file to be owned by the Solr user by running
the following command from the solr5_otmm/otmmcore/conf directory:
chown -R <solr username> synonyms.txt

4. Restart the Solr server by doing one of the following:

WINDOWS
Restart the Solr Windows Service in the Windows Services Console.

LINUX
Run the command following command:
sudo service solr restart

Note: If Solr is installed in an HA configuration, you must perform Step 1


to Step 4 on all OTMM servers.

172 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.14. Administering the Search Index

3.14.3 The Media Management Indexer


The Indexer enables an administrator to keep Solr synchronized with OTMM by
crawling the OTMM data and updating the Solr database.

When you configure the Indexer as Automatic, the Indexer service detects when the
OpenText Media Manager service and the Solr server start and stop. The Indexer
checks for updates to the OTMM database. Updates will most likely be for minor
modifications to the database, therefore the entire database does not need to be re-
indexed.

Notes
• Windows - The Indexer is configured as a Windows service called OpenText
Indexer.
• Linux - There are scripts to start and stop the service.
• For more information, see out starting and stopping the Indexer service, see
“Performing operations tasks“ on page 139.

3.14.3.1 Troubleshooting the Media Management Indexer


This section provides some guidance for diagnosing and resolving the following
problems that may arise with the Indexer.

3.14.3.1.1 Not sure if the Indexer is running

If you are unsure if the Indexer is indexing your assets, you can check the
<TEAMS_HOME>/logs/indexer.log file for current log messages.

Windows Check the status of the OpenText Indexer service in the Windows Services UI.

3.14.3.1.2 I cannot find any newly added assets (new assets are not being indexed)

If you have added new assets to your database or modified assets but you cannot
retrieve them using search, then first make sure you have allowed enough time for
the Indexer to process the new assets. If you have waited a few minutes and still
cannot find the new or modified assets, then there are a few reasons why this may
be happening. An error can occur during any of the following steps:
• Populating the INDEX_WORKQUEUE table in Oracle, SAP HANA,, SQLServer,
or PostgresSQL.
• Fetching the assets using the SDK.
• Indexing the assets using the SOLRJ API.

The following is a list of items to verify:

1. Make sure the SQL Server Agent is running (SQL Server only). This controls the
job that copies data from the INDEX_STAGING_QUEUE table to
INDEX_WORKQUEUE.

OpenText Media Management – Administration Guide 173


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

2. Verify that the Solr server is running. Use the Solr administration URL to access
the Solr search index independent of OTMM. The URL is typically http://
<hostname>:8983/solr, which is configured through the SOLR_URL entry under
the [COMMON\SOLR] section in the Tresource file.
3. If the Solr server is not running, start the Solr service.

WINDOWS
Start the Solr Windows service in the Windows Services Console.

LINUX
Run the following command:
sudo service solr start
4. Verify the Indexer is running by checking the <TEAMS_HOME>/logs/
indexer.log file for current log messages.If there are no current messages in the
Indexer log, check the latest Indexer process ID. In the log, look for the last line
with the following format:
**************** STARTING solrIndexer (<pid>@<Media Manager Host
Name>)**************
The number before the at sign (@) is the process ID. Check the Task Manager or
process listing to verify that this Java process is still running. If the process is not
running, check the Indexer log file for errors before starting the Indexer.
5. Check the Indexer log file, which is located in the <TEAMS_HOME>/logs folder,
for error messages or exceptions. If there are no errors, search for the missing
asset’s ID, for example, “abc123”. If you find the asset’s ID and no errors, then it
is safe to start the Indexer if it is not already running. To determine if the Indexer
is already running, check the <TEAMS_HOME>/logs/indexer.log file for current
log messages. If you need to start the Indexer, use the <TEAMS_HOME>/bin/
startIndexer script.
6. Using the Solr Administrator, verify that the asset is not indexed in the Solr
search database by querying for one of the missing assets. For example, to query
for the asset with UOI_ID (abc123), issue the following query into the search
form:
uoi_id:abc123
If one or more documents are returned, then verify if the content displayed is
current. If zero documents are returned, then the asset is not indexed in the Solr
search index. If the content is outdated, then the problem is an indexing issue.
7. Check the Solr server log for error messages. The Solr server log will indicate if
there are any schema errors that are preventing the indexing from working
correctly.

Notes
• Windows - The log files are located in the \solr-5.3.1\server\logs
folder below the folder where you expanded the solr-5.3.1.zip when
you installed Solr.

174 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.15. Configuring Solr to use the ICU Unicode tokenizer

• Linux - The log files are located in the /logs directory below the
Writable Files Directory, that you chose when you installed Solr. By
default, this is /var/solr/logs.

8. Verify that the RDBMS triggers are working correctly. If the Solr server and
Indexer logs do not show any errors, then check the INDEX_WORKQUEUE
table. OTMM keeps a list of assets to be indexed in the INDEX_WORKQUEUE
table. This table is populated by a trigger, index_workq, on the UOIS table.
Verify the following:

• Verify that the index_workq trigger is enabled and active.


• Verify that there are rows in the INDEX_WORKQUEUE table by running the
following query:
SELECT COUNT(ASSET_ID) FROM INDEX_WORKQUEUE

If there are no rows in INDEX_WORKQUEUE, verify that the trigger is active


and enabled by doing the following:

a. Stop the Media Management Indexer. For more information, see


“Performing operations tasks“ on page 139.

b. Using the HTML5 UI , modify an asset.

c. To make sure the modified asset is registered in the INDEX_WORKQUEUE


table, run the query:
SELECT COUNT(ASSET_ID) FROM INDEX_WORKQUEUE

If there are still no rows in the INDEX_WORKQUEUE table, then contact


your database administrator to determine why the trigger is not working
correctly.

3.15 Configuring Solr to use the ICU Unicode


tokenizer
The Solr search module is installed with two Solr schemas, each using a different
Tokenizer. The schemas are as follows:

Whitespace Tokenizer (default)


This is the default Tokenizer configuration which identifies words based upon
whitespace. It is appropriate for languages such as English, French, and Spanish.

ICU Tokenizer
This Tokenizer is provided for support of languages which are not whitespace
delimited. Examples of languages where this Tokenizer configuration is
beneficial are Japanese, Chinese, Arabic, and Greek.

Note: Both schemas support Unicode characters.

OpenText Media Management – Administration Guide 175


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

To change your Solr schema from the default Whitespace Tokenizer to the ICU
Tokenizer:

Note: If Solr is installed in an HA configuration, stop the Solr service on all


nodes prior to performing this task, and then proceed to Step 1.

1. Back up of the current Solr schema by copying the <TEAMS_HOME>/solr5_otmm/


otmmcore/conf/schema.xml configuration file.

2. Delete the existing schema by removing the <TEAMS_HOME>/solr5_otmm/


otmmcore/conf/schema.xml file.

3. Configure the new Solr schema by copying either the <TEAMS_HOME>/


solr5_otmm/otmmcore/conf/unicode-schema.xml or <TEAMS_HOME>/
solr5_otmm/otmmcore/conf/unicode-schema-no-suggestions.xml file to
the <TEAMS_HOME>/solr5_otmm/otmmcore/conf/schema.xml file.

Note: If you modified the Solr configuration to disable the Search


Suggestion feature, then replace the existing the schema.xml file with the
supplied unicode-schema-no-suggestions.xml file. If you made any
custom modifications to the schema.xml file, you must reapply them
manually.
For more information about disabling Search Suggestion feature, see
“Disabling the Search Suggestion feature” on page 183.

4. If Solr is installed on a remote server, replace the schema.xml in the remote


server's index by copying it from the <TEAMS_HOME>/solr5_otmm/otmmcore/
conf folder.

Note: Linux - After copying the schema.xml file to the remote server,
change the permissions of the file to be owned by the Solr user by running
following command from the solr5_otmm/otmmcore/conf directory:
chown -R <solr username> schema.xml

5. Restart the Solr server by doing one of the following:

WINDOWS
Restart the Solr Windows Service in the Windows Services Console.

LINUX
Run the command following command:
sudo service solr restart

Note: If Solr is installed in an HA configuration, you must perform Step 1


to Step 5 on all OTMM servers.

6. Re-index the search index database. For more information, see “Re-indexing the
Search Index database” on page 170.

176 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.16. Configuring enum Facet method

Note: If Solr is installed in an HA configuration, re-index the search index


database once.

3.16 Configuring enum Facet method


The enum faceting method can provide better Faceting performance than the default
fc method for selected fields. However, it increases Solr memory usage.

Note: The enum faceting method is not used for range, interval, or cascading
domain facet fields.

After Solr instantiates a new Searcher, the first time you generate Facets for field
with facet.method=enum, the Searcher builds an in-memory structure that makes
Faceting on that field faster for subsequent searches. The size of this in-memory
structure is dependent on the number of assets indexed and the number of unique
values present in the field. This size is approximately (#assets-indexed / 8) * #unique-
values) bytes. Therefore, OpenText recommends that you use the enum facet method
only for fields with a relatively small number of unique values.

A new Solr Searcher is instantiated when Solr first starts up, and each time updates
to the Solr indexes that are committed.

To avoid having the first user-submitted search affected by the creation of these in-
memory structures, you can optionally add queries to the firstSearcher and
newSearcher sections of the solrconfig.xml that generate Facets on the fields
listed in the ENUM_FACET_FIELD_IDS setting. This will create the in-memory
structures before the new Searcher is brought online.

Example 3-2: enum Faceting method


{code}
<listener event="newSearcher"
class="solr.QuerySenderListener">
<arr name="queries">
<!-- seed common facets and filter queries -->
<lst> <str name="q">*:*</str>
<str
name="facet.field">ARTESIA_2EFIELD_2EMODEL_domain_value</str>
<str
name="facet.field">ARTESIA_2EFIELD_2EMIME_20TYPE_domain_value<
/str>
<str name="facet.method">enum</str>
<str name="facet">true</str>
<str name="facet.missing">true</str>
<str
name="fq">(ARTESIA_2EFIELD_2EIS_20LATEST_20VERSION_string:
("Y"))</str>
<str
name="fq">((ARTESIA_2EFIELD_2ECONTENT_20STATUS_empty:(*) NOT
ARTESIA_2EFIELD_2ECONTENT_20STATUS_string:("DELETED")))</str>
<str
name="fq">((ARTESIA_2EFIELD_2ECONTENT_20TYPE_empty:(*) NOT

OpenText Media Management – Administration Guide 177


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

ARTESIA_2EFIELD_2ECONTENT_20TYPE_string:("SHORTCUT")))</str>
</lst>
</arr>
</listener>
<listener event="firstSearcher"
class="solr.QuerySenderListener">
<arr name="queries">
<!-- seed common facets and filter queries -->
<lst> <str name="q">*:*</str>
<str
name="facet.field">ARTESIA_2EFIELD_2EMODEL_domain_value</str>
<str
name="facet.field">ARTESIA_2EFIELD_2EMIME_20TYPE_domain_value<
/str>
<str name="facet.method">enum</str>
<str name="facet">true</str>
<str name="facet.missing">true</str>
<str
name="fq">(ARTESIA_2EFIELD_2EIS_20LATEST_20VERSION_string:
("Y"))</str>
<str
name="fq">((ARTESIA_2EFIELD_2ECONTENT_20STATUS_empty:(*) NOT
ARTESIA_2EFIELD_2ECONTENT_20STATUS_string:("DELETED")))</str>
<str
name="fq">((ARTESIA_2EFIELD_2ECONTENT_20TYPE_empty:(*) NOT
ARTESIA_2EFIELD_2ECONTENT_20TYPE_string:("SHORTCUT")))</str>
</lst>
</arr>
</listener>
{code}

Add the facet.field entry for each field listed in the ENUM_FACET_FIELD_IDS
Tresource entry. The field name listed must be the internal Solr field name The Solr
field name is a ‘mangled’ version of the OTMM field ID, underscores in the OTMM
field ID are converted to _5F, spaces are converted to _20, and periods converted to
_2E) with an extension added that indicates to Solr how the field should be indexed.
The internal Solr field names can be determined by performing searches in the
OTMM user interface, and then extracting the internal Solr field names from the
mediamanager-appserver.log. The parameters that are sent to Solr for each search
are captured in this log. (Search for SolrV1SearchPlugin). This will include
multiple facet.field parameters for each of the fields listed in the Facet
Configuration used by the search. It is also possible to specify filter query (fq)
parameters as part of the newSearcher and firstSearcher queries. This will pre-
populate results for these filter queries in the Solr caches. In Example 3-2, “enum
Faceting method” on page 177, the filter queries generated by the search filter
user preferences in OTMM are listed.

178 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.17. Setting the debug level

3.17 Setting the debug level


The environment variable TEAMS_SERVER_DEBUG_LEVEL is used to set the debug
level for OTMM utilities such as Bulk Import and Bulk Purge. The possible values of
TEAMS_SERVER_DEBUG_LEVEL and their meaning are as follows:

Table 3-1: Debug Levels

TEAMS_SERVER_DEBUG_LEVEL Information Logged


5 or 9 Debug, Warn, Info, and Error messages
3 Warn, Info, and Error messages
1 Info and Error messages

3.18 Clearing the Java cache


When clearing the Java cache on the Windows client machines where Media
Management is used, the location of the Java cache is:

C:\Users\<user_name>\AppData\LocalLow\Sun\Java\Deployment\cache

3.19 Importing Japanese Ruby character in PDFs


By default, OTMM uses the Xpdf based PDF TO TEXT transformer to extract text
from PDFs. However, the Xpdf transformer does not handle Japanese Ruby
characters correctly when extracting text content. If you are importing PDFs that
contain Japanese Ruby characters, you might consider switching the transformer
used to extract content from PDFs to the Apache Tika™ based CONVERTTOTXT
transformer, which handles Japanese Ruby characters correctly.

To switch the transformer used to extract content from PDFs to the Tika based
CONVERTTOTXT transformer:

• Execute the following SQL statements:

update IMPORT_TRANS_MIME_TYPE_MAP set TRANSFORMER_ID =


'ARTESIA.TRANSFORMER.CONVERTTOTXT' where

MIME_TYPE = 'application/pdf' and TRANSFORMER_ID =


'ARTESIA.TRANSFORMER.PDF TO TEXT';

update EXPORT_TRANS_CONTENT_TYPE_MAP set TRANSFORMER_ID =


'ARTESIA.TRANSFORMER.CONVERTTOTXT' where

CONTENT_TYPE = 'ACROBAT' and TRANSFORMER_ID =


'ARTESIA.TRANSFORMER.PDF TO TEXT';

OpenText Media Management – Administration Guide 179


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

Note: If your OTMM instance is running when performing the above SQL
commands, in the Web Administration tool, clear the cache, by clicking
Utililties> Clear caches, and then click Clear caches.

3.20 Configuring SMTP server authentication


By default, OTMM assumes that the SMTP server allows anonymous access to send
an email. In the event that your SMTP server requires a authentication, OTMM
allows you to configure the user name and password to connect to the SMTP server.
OTMM uses sign-in credentials only when the
EMAIL_SERVER_AUTHENTICATION_ENABLED setting is enabled.

To configure sign-in credentials:

1. Navigate to the <TEAMS_HOME>/servers folder

2. In a text editor, open the SMTP_SEC_Srv.cfg file.

3. Enter a valid user name and password.

4. At the command prompt, do the following:

a. Change to the <TEAMS_HOME>/bin folder.


b. To encrypt the sign-in credentials, enter one of the following commands at
a command prompt or terminal:

WINDOWS
crypt.bat ef ..\servers\SMTP_SEC_Srv.cfg

LINUX
crypt.sh ef ../servers/SMTP_SEC_Srv.cfg

5. To enable SMTP server authentication, change the


EMAIL_SERVER_AUTHENTICATION_ENABLED setting to TRUE.

Note: This setting is located under the COMMON\SERVER component,


which belongs to the General configuration group. This group is accessible
from the Settings page in the Web Administration tool. For more
information, see “Editing a component and properties” on page 136.

180 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.21. Customizing the text in the password reset email

3.21 Customizing the text in the password reset email


The text of the Password Reset email is configurable. To customize the content of the
Password Reset email, navigate to the <TEAMS_HOME>/data/notification/
password-reset folder and update the subject.txt and body.txt configuration
files as desired. Do not remove the $LOGIN_NAME and $PASSWORD tokens from the
configuration files. The OTMM server will replace these tokens with the user sign-in
name and updated password at runtime.

3.22 Configuring the Search Suggestion feature


The Search Suggestion feature, which is enabled by default, suggests query terms for
Keyword Search based on incomplete user input. When users type a term at the
Keyword Search prompt, the Search Suggestion feature is called and generates a list
of words from the index that match the word stem that has been entered. The
suggestions are ordered based on the total number of assets in the system in which
the original typed word appears.

Solr supports two mechanisms for implementing the Search Suggestion feature:
• TermsComponent method
• Suggester method

By default, the TermsComponent method is used. However, if desired, you can


reconfigure Solr and the Solr search plugin to use the Suggester method. Both
methods use the index for an underlying Solr field to generate suggestions. The
TermsComponent method works directly against the underlying Solr index. The
Suggester method loads the terms from the index into memory and then generates
suggestions from the in-memory representation of the index.

3.22.1 Considerations for using the Suggester method


While the Suggester method is faster than the TermsComponent method and is less
affected by the size of the underlying index, it increases the amount of memory used
by Solr. To limit the memory requirements, the Suggester can be configured with a
threshold value.

Another consideration to take into account for the Suggester method is it does not
support updates. When assets are added, modified, or deleted, the in-memory
representation needs to be reloaded to reflect the changes to the index. There are two
ways to reload the in-memory representation:
• Configure the in-memory representation to be automatically reloaded each time
updates to the Solr indexes are committed.
• Manually reloaded the in-memory representation.

Automatic reloading is configured by setting the buildOnCommit option to true.


However, on a system with a high volume of updates, the overhead of continually
reloading the in-memory representation may degrade Solr performance. In such

OpenText Media Management – Administration Guide 181


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

cases, buildOnCommit should be set to false and the in-memory representation


should be manually reloaded.

To manually reload the Suggester in-memory representation:

1. Navigate to the TEAMS_HOME/install/ant directory.


2. Execute the following Ant task:
ant reload-suggester-dictionary

Typically, a scheduled job is used to automatically run this Ant task periodically.

To convert Solr to use the Suggester implementation:

Note: If Solr is installed in an HA configuration, stop the Solr service on all


nodes prior to performing this task, and then proceed to Step 1.

1. Back up the current Solr solrconfig file by making a copy of the


<TEAMS_HOME>/solr5_otmm/otmmcore/conf/solrconfig.xml configuration
file.
2. In a text editor, open the solrconfig.xml file, and then do the following:

a. Delete the two lines that contain the following text:


REMOVE TO ENABLE SUGGESTER
b. Optional Edit the suggest searchComponent entry and modify the
threshold and buildOnCommit values.

• threshold
This value represents the minimum fraction of the assets a term must
occur in for that term to be included in the in-memory representation of
the index. For example, a threshold value of .001 would require a
term to occur in 0.1% of the assets. Therefore, in a million asset
collection, this would mean a term would have to occur in at least 1,000
assets to be included in the in-memory representation of the index.
OpenText recommends that you set a threshold value if you are using
the Suggester method. The threshold value used will depend on the
size of your collection and your system requirements.
• buildOnCommit
Automatic reloading is configured by setting the buildOnCommit option
to true. However, on a system with a high volume of updates, the
overhead of continually reloading the in-memory representation may
degrade Solr performance. In such cases, set buildOnCommit to false,
then and manually reload the in-memory representation.
c. Save the solrconfig.xml file.
3. If Solr is installed on a remote server, replace the solrconfig.xml in the remote
server's index by copying it from the <TEAMS_HOME>/solr5_otmm/otmmcore/
conf folder.

182 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.22. Configuring the Search Suggestion feature

Note: Linux - After copying the solrconfig.xml file to the remote server,
change the permissions of the file to be owned by the Solr user by running
following command from the solr5_otmm/otmmcore/conf directory:
chown -R <solr username> solrconfig.xml

4. Restart the Solr server by doing one of the following:

WINDOWS
Restart the Solr Windows Service in the Windows Services Console.

LINUX
Run the command following command:
sudo service solr restart

Note: If Solr is installed in an HA configuration, you must perform Step 1


to Step 4 on all OTMM servers.

3.22.2 Converting the Solr search plugin to use the Suggester


implementation
In the OTMM Oracle, SAP HANA, or SQL Server, or PostgreSQL instance, execute
the following SQL INSERT statement:

INSERT INTO ASSET_INDEX_PLUGIN_ATTRS (ASSET_INDEX_PLUGIN_ATTR_ID,


ASSET_INDEX_PLUGIN_ID, ATTR_NAME, ATTR_VALUE) VALUES ((SELECT
coalesce(MAX(ASSET_INDEX_PLUGIN_ATTR_ID), 0) + 1 FROM
ASSET_INDEX_PLUGIN_ATTRS), 'ARTESIA.PLUGIN.SEARCH.SOLR.V1',
'SUGGESTION_METHOD', 'SUGGESTER');

3.22.3 Disabling the Search Suggestion feature


Disabling the Search Suggestion feature is a twofold process. You must do the
following:

• Disable the Search Suggestion feature.


• Modify the Solr configuration to no longer generate the Solr index used to
generate search suggestions.

Note: Modifying the Solr configuration is not necessary, but doing so will
avoid the overhead of additional disk space and index processing time.

To disable the Search Suggestion feature, change the value of the


DISABLE_SEARCH_SUGGESTIONS setting to TRUE. This setting is located under the
SEARCH\SERVER component, which belongs to the Search configuration group.
For more information, see “Editing a component and properties” on page 136.

OpenText Media Management – Administration Guide 183


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

To modify your Solr schema to disable the generation of the suggestion index:

Note: If Solr is installed in an HA configuration, stop the Solr service on all


nodes prior to performing this task, and then proceed to Step 1.

1. Back up the current Solr schema by making a copy of the <TEAMS_HOME>/


solr5_otmm/otmmcore/conf/schema.xml configuration file.

2. Delete the existing schema by removing the <TEAMS_HOME>/solr5_otmm/


otmmcore/conf/schema.xml file.

3. Configure the new Solr schema by copying either <TEAMS_HOME>/solr5_otmm/


otmmcore/conf/schema-no-suggestions.xml or <TEAMS_HOME>/
solr5_otmm/otmmcore/conf/unicode-schema-no-suggestions.xml to
<TEAMS_HOME>/solr5_otmm/otmmcore/conf/schema.xml.

Note: If you modified the Solr configuration to use the ICU tokenizer to
support the searching of non-white space delimited languages, then
replace the existing schema.xml with the supplied unicode-schema-no-
suggestions.xml file. If you made any custom modifications to the
schema.xml file, you must reapply them manually.
For more information about modifying the Solr configuration to use the
ICU tokenizer, see “Configuring Solr to use the ICU Unicode tokenizer”
on page 175.

4. If Solr is installed on a remote server, replace the schema.xml in the remote


server's index by copying it from the <TEAMS_HOME>/solr5_otmm/otmmcore/
conf folder.

Note: Linux - After copying the schema.xml file to the remote server,
change the permissions of the file to be owned by the Solr user by running
following command from the solr5_otmm/otmmcore/conf directory:
chown -R <solr username> schema.xml

5. Restart the Solr server by doing one of the following:

WINDOWS
Restart the Solr Windows Service in the Windows Services Console.

LINUX
Run the command following command:
sudo service solr restart

Note: If Solr is installed in an HA configuration, you must perform Step 1


to Step 5 on all OTMM servers.

6. Re-index the search index database. For more information, see “Re-indexing the
Search Index database” on page 170.

184 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.23. Configuring model-level required fields

Note: If Solr is installed in an HA configuration, re-index the search index


database once.

3.23 Configuring model-level required fields


When creating a metadata field in the Metadata Editor, if you create it as a required
field, then it is applied as a required field for all models using that field. However, if
you want a metadata field to be required for some models but optional in other
models, then do not initially create it as a required field. And then configure it as a
required field only in the desired models.

To configure fields as required for specific models:

1. Add the following component under the General configuration group on the
Settings page:
METADATA\REQUIRED_FIELDS

2. Add the following properties to the METADATA\REQUIRED_FIELDS


component for each required model as follows:
"MODEL_ID1"="METADATA_FIELD_ID1, METADATA_FIELD_ID2"

"MODEL_ID2"="METADATA_FIELD_ID3, METADATA_FIELD_ID4"

where
MODEL_ID is the property name

METADATA_FIELD_ID is the property value, which is a comma separated list of


required metadata field IDs. You can provide multiple properties for each
model.

Note: Replace all periods and spaces with the underscore (_) character for
MODEL_ID only.

3.24 Overwriting HTTP response headers


Custom servlet filters provide an option to overwrite HTTP header values by using
the values from the following properties files:

For the OTMM Web Administration tool

JBoss EAP and Wildfly


<TEAMS_HOME>/ear/artesia.ear/teams.war/WEB-INF/
responseheaders.properties

TomEE
<TEAMS_HOME>/ear/artesia/teams/WEB-INF/
responseheaders.properties

OpenText Media Management – Administration Guide 185


MEDMGT160300-AGD-EN-02
Chapter 3 Performing operations tasks

For the Web Desktop or Mobile client


JBoss EAP and Wildfly
<TEAMS_HOME>/ear/artesia.ear/otmmux.war/WEB-INF/
responseheaders.properties

TomEE
<TEAMS_HOME>/ear/artesia/otmmux/WEB-INF/
responseheaders.properties

Update the above files if you want to have more control over the HTTP response
headers.

3.25 Viewing recently access assets and folder


Users can view assets and folders that they has accessed recently. An asset or folder
is considered to be recently accessed based on a list of events that you can configure.
By default, Media Management tracks the following events as recently accessed:

Assets
• 30005 - Asset deleted
• 40014 - Asset added
• 60006 - Asset exported
• 70001- Asset viewed
• 80008 - Asset metadata updated

Folders
• 30019 - Folder was created
• 30020 - Folder metadata was updated
• 30021 - Folder deleted
• 70002 - Folder viewed in Inspector view

Note: All the events are in the EVENT_CTXTS table.

To configure the list of events for assets and folders recently accessed by
users:

1. To define the list of events for assets recently accessed by users, update the
following system setting, which is located under the SERVER\EVENTS
component:
ASSET_EVENT_IDS_TO_TRACK_RECENT_ACCESS

Note: The SERVER\EVENTS component belongs to the Events


configuration group. For more information, see “Editing a component and
properties” on page 136.

186 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
3.25. Viewing recently access assets and folder

2. To define the list of events for folders recently accessed by users, update the
following system setting, which is located under the SERVER\EVENTS
component:
FOLDER_EVENT_IDS_TO_TRACK_RECENT_ACCESS

Note: The SERVER\EVENTS component belongs to the Events


configuration group. For more information, see “Editing a component and
properties” on page 136.

3. To set a limit for the number of details that Media Management maintains for
assets and folders recently access by users, update the following system setting,
which is located under the ASSET\CONFIG component:
RECENT_ACCESS_LIMIT

Note: The ASSET\CONFIG component belongs to the General


configuration group. For more information, see “Editing a component and
properties” on page 136.

Tip: Setting a limit means that if you set the maximum limit to 20, then
Media Management will maintain the 20 most recently accessed asset and
folder details.

OpenText Media Management – Administration Guide 187


MEDMGT160300-AGD-EN-02
Chapter 4
Administering links

OTMM allows users to create relationships between assets, thereby linking them in a
meaningful way. While OTMM defines some relationships or link types at
installation time, you can also define custom link types.

4.1 Standard link types


The following table lists and describes the standard link types that are pre-
configured with OTMM. The following link types should not be modified as OTMM
business logic depends on them.

Table 4-1: Standard example link types

Code Name RECIP_LINK_TYPE Description


DERIVATIVE derivative DERIVATIVE_OF Is the relationship
between a copy and
the original asset.
DERIVATIVE_OF is-derivative-of DERIVATIVE Is the relationship
between the original
asset and its copy.
RELATED is-related-to RELATED Describes a generic
relationship between
assets.
PARENT is-parent-of CHILD Is the parent of an
asset.
CHILD is-child-of PARENT Is the child of an
asset.
BELONGTO belongs-to CONTAINS Belongs to an asset.
CONTAINS contains BELONGTO Contains other assets.
PLACEDGR placed graphic ARTESIA.LINKTYPE Is the link type for a
.ISPLACEDGR layout document that
OF contains graphics.
ARTESIA.LINKTYPE is-placed graphic-of PLACEDGR Is the link type for a
.ISPLACEDGROF parent asset that
contains graphics.
ARTESIA.LINKTYPE extracted XML CHILD Is an XML
.EXTRACTEDXML representation of an
asset.

OpenText Media Management – Administration Guide 189


MEDMGT160300-AGD-EN-02
Chapter 4 Administering links

Code Name RECIP_LINK_TYPE Description


ARTESIA.LINKTYPE extracted PDF CHILD Is a PDF
.EXTRACTEDPDF representation of an
asset.
PV belongs-to video Belongs to a video.
CLIP2VID has video clips Contains video clips.
USR-AST participant.subscribe Links a user to the
d asset to which they
are subscribed.

4.2 Creating links


All link types are defined in the OTMM schema in the LINK_TYPES table. Use SQL
commands to populate the columns as described in the following table.

Table 4-2: LINK_TYPES Table

Column Name Required Datatype Description


CODE Y VARCHAR2(100) A unique identifier
for the link type.
Generally a short
abbreviation. Used
internally to identify
the link type.
NAME Y VARCHAR2(80) The displayed name
for the link type.
RECIP_LINK_TYPE N VARCHAR2(100) The CODE of another
link type that should
be automatically
created when a
relationship is
created using the
current link type. An
example is to set
CODE='PARENT'
and this field to
'CHILD'.
BEHAVIOR N VARCHAR2(80) For future use.

190 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
4.2. Creating links

Column Name Required Datatype Description


STATUS N VARCHAR2(8) This field is optional.
It uses values from
META_DATA_STATUS
to assign a status to
the link type. As
administrator, you
can determine the
meaning of the status
option.
DESCR N VARCHAR2(249) A short description.
This field is optional
and serves to
document the current
relationship and the
conditions under
which it should be
used.
FOLLOW_LATEST Y VARCHAR2(1) Valid values are 'Y'
and 'N'. If set to
'Y', then the
relationships using
this link type are
created to the latest
version of the logical
UOI_ID for the
destination asset(s).
The default value is
'N'. In this case,
relationships are
created between the
source asset and the
physical UOI_ID that
is specified.
COPY_ON_CHECKI N VARCHAR2(1) in This column
N Oracle, determines whether
VARCHAR(1) in SQL links of this type
Server, and should be copied
NVARCHAR(1) in from the previous
SAP HANA. version of an asset to
the new version of an
asset during asset
check-in. The values
are either 'Y' or
'N'.

OpenText Media Management – Administration Guide 191


MEDMGT160300-AGD-EN-02
Chapter 5
Logging and messaging

This chapter presents information for troubleshooting common problems with


OTMM.

Log files created by OTMM are logged to the <TEAMS_HOME>/logs directory by


default. When troubleshooting an unexpected event or error, your first step should
be to ensure that the log level is high enough to provide pertinent information. Once
the log level is set properly and the error has been reproduced, a review of the
relevant log files should provide information related to the underlying problem. The
primary log for OTMM is the <TEAMS_HOME>/logs/smediamanager-appserver.
log file.

Should you need to contact Customer Support for assistance, you will be asked to
provide a description of the steps taken to reproduce the problem and the log files.
Details on where these files can be found, the information contained in them, and
how to set them up are provided in the following section.

5.1 Server logs


OTMM performs logging to alert the administrator of errors and warnings as well as
provide information about the operations that OTMM is performing. Logging is
performed through the use of the Jakarta Commons Logging framework. For more
information, see http://commons.apache.org/logging/. The Jakarta Commons
Logging framework enables the administrator to use a number of logging
implementation frameworks, formats, and configurations. The logging framework
that is configured by default for OTMM is the Apache Log4j™ framework. For more
information, see http://logging.apache.org/log4j/2.x/manual/index.html. The
following section provides details for configuring the default logging
implementation that has been provided by OTMM.

By default, OTMM log files can be found in the <TEAMS_HOME>/logs directory. The
application server may create multiple log files during its life span. By default, the
application server will update the existing log every night at midnight. The updated
log will indicate when it was updated. The mediamanager_appserver.log file will
always be the current log for the application server.

The mediamanager_appserver.log contains all log output for the OTMM business
services, web services, and web client applications.

OpenText Media Management – Administration Guide 193


MEDMGT160300-AGD-EN-02
Chapter 5 Logging and messaging

5.1.1 Changing the logging configuration


This section provides information about changing the logging configuration for
JBoss and TomEE.

5.1.1.1 Changing the logging configuration for JBoss


The configuration of logging is specified in the <JBOSS_HOME>/standalone/
configuration/logging.properties file.

The logging.properties file is overwritten when the OTMM server starts and with
each change to the logging subsystem. Any changes made to the file are not
persistent. If you want temporarily add to or change the log levels of specific
categories, make your modifications in the logging.properties file.

Any modifications you make to the XML configuration file, manually or using the
management console, are permanent in the logging.properties file; they will be
used in subsequent startups of the OTMM server.

To change the logging configuration using the Management Console in JBoss


EAP:

1. Sign in to the Management Console.

2. Click Configuration, expand Core in the Subsystems menu.

3. Click Logging.

4. Navigate to the Log Categories tab, the following are the logging tasks that you
can configure:

• Add and remove Log Categories


• Edit existing Log Categories level

To change the logging configuration using the Management Console in


Wildfly:

1. Sign in to the Management Console.

2. Click Configuration.

3. Click the Subsystems menu.

4. Click the View on the Logging option.

5. Navigate to the Log Categories tab, the following are the logging tasks that you
can configure:

• Add and remove Log Categories


• Edit existing Log Categories level

194 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
5.2. OpenText™ Secure MFT (Secure MFT) logs

To change the logging configuration using the Management Console XML


configuration:

• Edit the log level and other log configurations in the <JBOSS_HOME>/
standalone/configuration/otmm.xml file, which is located under the logging
subsystem.

5.1.1.2 Changing the logging configuration for TomEE


To change the logging configuration for TomEE:

1. In a text editor, open the <TOMEE_HOME>/conf/log4j.xml.


2. Edit the log level and other log configurations.

3. Restart the server.

5.1.2 Changing application server logs


The application server runs some OTMM server services as well as the Media
Management Web Client. The log level and other log configurations are managed
under the logging subsystem of the system configuration.

The settings that normally are adjusted here are the log levels for the com.opentext,
com.artesia, com.artesiatech, and ttsg_teams categories. The default level is
INFO. When diagnosing problems, OpenText recommends that you change the value
to DEBUG. For more information about how to change the logs levels of different
categories, “Changing the logging configuration” on page 194.

5.1.3 Viewing, debugging or tracing hibernate activities


To view, debug or trace Hibernate information:

• Add one of the following to the logging configuration:

• org.hibernate.SQL DEBUG

• org.hibernate.type TRACE

5.2 OpenText™ Secure MFT (Secure MFT) logs


This section discusses Secure MFT logs.

OpenText Media Management – Administration Guide 195


MEDMGT160300-AGD-EN-02
Chapter 5 Logging and messaging

5.2.1 Viewing the Secure MFT Enterprise server log


The server log for the OpenText™ Secure MFT (Secure MFT) Enterprise server can
be found in the Tomcat logs folder. On a typical Windows installation, the log file is
C:\Program Files\Apache Software Foundation\Tomcat 6.0\logs\mft.log.

5.2.2 OTMM Secure MFT logs


For diagnostics, Secure MFT tracing has to be explicitly enabled by configuring the
following environment variables:
• OTMFT_TRACE_ENABLED = True/False
This enables or disables Secure MFT tracing.
• OTMFT_TRACE_LEVEL=STANDARD/VERBOSE
This sets up the trace detail to Standard or Verbose.

The trace file is written to OpenTextMFTWebClientTrace.txt, and is created on the


desktop.

These environment variables can be leveraged for both the OTMM server end and
client end diagnostics. For diagnosing Secure MFT issues on the Media Management
Web Client end, define these variables and restart the browser before accessing
OTMM. For diagnosing Secure MFT issues on the Media Management server, you
must restart the server after defining these variables. In either case, the trace file is
generated on the desktop of the diagnosing end.

196 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
Chapter 6
Maintenance recommendations

This section provides general maintenance guidelines to help maintain optimal


performance for your OTMM installation.

The following table lists the recommended maintenance tasks administrators should
perform.

Table 6-1: Recommended OTMM Maintenance Activities

Task Interval Reference


(General Rule of Thumb)
Data Backup Daily, weekly, or monthly “Data backup guidelines”
on page 198.
Log File Maintenance Weekly or monthly “Log file maintenance”
on page 202.
Clean up Working Areas Job dependent “Cleaning up working areas”
on page 203.
Application Administration Varies by task “Application administration
Maintenance maintenance” on page 197.
Database Maintenance Varies by task “Database maintenance”
on page 198.
Custom Application Cleanup Monthly “Miscellaneous items”
on page 203.
JSP Cleanup Monthly “Miscellaneous items”
on page 203.

6.1 Application administration maintenance


OTMM administrators should perform the following general maintenance tasks.

Recycle Bin Maintenance (purge or undelete assets)


Deleted assets take up space in both the database and file system. If they are no
longer needed, they should be purged from the system. This can be done from
the Web Administration page. Navigate to the Recycle Bin and if you have any
deleted items, purge them.
Release Locks
There may be cases when assets are erroneously locked. For example, if a user
checks out an asset to edit it, a lock is placed on that asset. If that user then
moves on without saving the asset, or forgets to check the asset back in, the asset
remains locked. Other users will be prevented from editing that asset. If the
original user is not available to unlock the asset, an administrator can release the

OpenText Media Management – Administration Guide 197


MEDMGT160300-AGD-EN-02
Chapter 6 Maintenance recommendations

lock. This is done from the Web Administration page. Navigate to Release
Locks, select the objects for which the locks need to be released or select
everything, and then click Release.

Clear Caches
When any database changes are made, such as adding new lookup values or
when any cached settings have been changed, for those changes to be applied,
an administrator must clear the cache. In the Web Administration tool, on the
top-level menu, click Utilities > Clear caches, and then click Clear caches.

6.2 Database maintenance


Administrators should periodically perform the following database maintenance
tasks.

Client Session Tables


Periodically clean up client session tables by shutting down OTMM, then
running the <TEAMS_HOME>\bin\cleanup_web_sessions.bat script on
Windows or the cleanup_web_sessions.sh script on Linux, and then
restarting OTMM.

SQL Server
Make sure the SQL Server Agent is running. This controls the job that copies
data from the staging queue table to index_workqueue.

OTMM Database
Periodically back up the OTMM database.

6.3 Data backup guidelines


Administrators should apply the following data backup guidelines.

Note: Prior to backing up the OTMM files and repository directories, shut
down the OTMM service. In an HA environment, shut down the OTMM
service on all nodes. Prior to backing up the Solr index files, shut down the
OpenText Indexer service. In an HA environment, shut down the OpenText
Indexer service on all nodes. For more information about stopping the Indexer
service, see “Starting the OpenText Indexer as a service” on page 141.

OTMM files
After you have installed OTMM, you may want to back up the entire Media
Management folder, <TEAMS_HOME>, to allow for a quick restore in case of a
disaster recovery. Then from that point forward, as part of your site's regular
backup procedure, you should backup the following items all at the same time.
You should also perform a backup any time a new configuration is deployed to
OTMM.

198 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
6.3. Data backup guidelines

Repository directories
All data content is stored and retrieved from the repository directories. The
default location is <TEAMS_REPOSITORY_HOME>/data/repository, unless you
have optionally set the TEAMS_REPOSITORY_HOME environment variable to point
to a location other than the default area, in which case you will need to back up
that location.

Solr index files


You need to include the Solr index files in the regular backup procedure of your
site.

Important
After you revert to a backup of the Solr indexes, you must synchronize
the indexes with all asset updates that occurred since the backup was
taken. To successfully resynchronize the Solr indexes, you must enable
the Indexer restore log prior to backing up the Solr index files for the first
time.

Note: Performing a full re-index of Solr invalidates any existing backups of


the Solr index files that you created before the re-index was performed. For
more information, see “Re-indexing the Search Index database”
on page 170.

To enable the Indexer restore log:

1. On the top-level menu, click Settings.

2. Set the value of the ENABLE_INDEX_RESTORE_LOG system


configuration setting to Y.

Note: This setting is located under the INDEXING\COMMON


component, which belongs to the Search configuration group. For
more information, see “Editing a component and properties”
on page 136.

3. At a command prompt, do the following:

a. Change to the TEAMS_HOME\install\ant directory.

b. Enter the following Ant command:


ant start-index-restore-log

Tip: You can also stop and start the OpenText Indexer service instead
of running the Ant command. For more information, see “Starting the
OpenText Indexer as a service” on page 141.

To back up the Solr index files:

1. Stop the OpenText Indexer service.

OpenText Media Management – Administration Guide 199


MEDMGT160300-AGD-EN-02
Chapter 6 Maintenance recommendations

Notes
• In an HA environment, stop the Indexer on all nodes.
• Users can continue searching, adding, modifying, and deleting
assets during the backup process.

2. Back up the Solr index directory.

Notes
• In an HA environment, back up the indexer directory of the Solr
master instance.
• Capture the date and time when you took the backup. You will need
this information if you restore the backup.

Tips
• If Solr is installed on the same server as OTMM, the directory will
be in the one following locations:

WINDOWS
<TEAMS_HOME>\solr5_otmm\otmmcore\data\index

LINUX
<TEAMS_HOME>/solr5_otmm/otmmcore/data/index
• If Solr is installed on a remote server, the directory will be in the
one following locations:

WINDOWS
<SOLR5_OTMM_DIR>\solr5_otmm\otmmcore\data\index

LINUX
<SOLR5_OTMM_DIR>/solr5_otmm/otmmcore/data/index

3. Restart the OpenText Indexer service.

Note: In an HA environment, start the Indexer on all nodes.

200 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
6.3. Data backup guidelines

6.3.1 Reverting to a backup copy of the Solr index files


Important
Searching will be unavailable while you are the restoring the Solr backup
files. Search results will not reflect the current state of the asset collection in
OTMM until you run the sync-indexer-workqueue Ant task, and the
Indexer has had time to process the INDEX_WORKQUEUE.

To revert to a backup copy of the Solr index files:

1. Stop the OpenText Indexer service.

Note: In HA environment, stop the Indexer on all nodes.

2. Stop the Solr service.

Note: In HA environment, stop the Solr service on all nodes.

3. Restore the Solr backup files by deleting the current index directory, which is
located in the \solr5_otmm\otmmcore\data directory, and replacing it with the
backed up index directory.

Note: In HA environment, restore the Solr backup files on the Solr master
instance.

4. Run the following Ant task to repopulate the INDEX_WORKQUEUE table with
records for all the assets that have been added, modified, or deleted since the
backup was taken to synchronize the Solr index with the RDBMS:
ant -Dstart.date="<TIME>" sync-indexer-workqueue

• For SQL Server installations, the "<TIME>" format is "YYY-MM-DD hh:mm:ss.


000".

• For Oracle, PostgreSQL, and SAP HANA installations, the "<TIME>" format
is "YYYYMMDD HH24:mm:ss".

• The start.date is the date that the restored backup was created.

5. Start the Solr service.

Note: In HA environment, start the Solr service on all nodes.

6. Start the OpenText Indexer service.

Note: In HA environment, start the Indexer on all nodes.

OpenText Media Management – Administration Guide 201


MEDMGT160300-AGD-EN-02
Chapter 6 Maintenance recommendations

6.4 Log file maintenance


OTMM maintains application logs, including Tomcat, in the <TEAMS_HOME>/logs
directory. An administrator can take the following steps to reduce the size of these
log files:

mediamanager-appserver.log
This main application log file, which is located in <TEAMS_HOME>/logs, is
written using log4j. The amount of output is controlled by the logging
configuration. For more information, see “Changing the logging configuration”
on page 194.
It is possible to change the logging configuration in a way to produce a lot of
logging output. This might be useful in a troubleshooting scenario, but is
unnecessary in normal production mode. Periodically, review your settings and
make sure they are set appropriately. You can also clear logs that are older than
a month in the <TEAMS_HOME>/logs directory.

Workflow Logs
OTMM maintains user workflow activity logging (general access to OTMM) in
the WORKFLOW_LOGS table in the OTMM database. Under normal
circumstances, these logs are not necessary and can take up considerable
database and disk space. Also, if they are not managed properly, they can cause
“out of table” errors during normal operations. An administrator can help
manage and reduce the size of these logs by doing the following:
Locate the EVENT_CTXTS table in the OTMM database and change the value of
LOGGING_DEST from 2 to 0 for all events in the table that have a TAB_DEST of
'WORKFLOW_LOGS'.

Note: You should only do this for the events recorded to the
WORKFLOW_LOGS table. Events recorded to the STATUS_LOGS table
are necessary for OTMM to run correctly. Also, remember that the contents
of the WORKFLOW_LOGS table are used by the User Logs page of the
Media Management Web Client. Any disabled event no longer provides
feedback in the User Logs screen.

Status Logs
OTMM maintains import and export activity logging in the STATUS_LOGS
table in the OTMM database. If these logs need to be kept for auditing purposes,
you can migrate them to separate database tables for archiving and reporting.
Otherwise, remove any status logs older than two weeks.

Indexer Logs
To change the Indexer logging, modify the <TEAMS_HOME>/indexer/log4j.xml
file. For more information about the configuring this file, see the log4j
documentation.

202 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
6.5. Cleaning up working areas

6.5 Cleaning up working areas


The following areas are periodically cleaned up by the Managed Directory Timer as
specified through the following settings:
• CLEANUP_FILE_AGE_THRESHOLD, which is located under the APPLICATION
\CONTENT_SHARE component, which belongs to the General configuration
group.
• EXPORT_CLEANUP_FILE_AGE_THRESHOLD, which is located under the
APPLICATION\CONTENT_SHARE component, which belongs to the General
configuration group.

Note: You can access configuration groups through the Settings page. For
more information about configuration groups and components, see “Settings”
on page 130.

Additionally, OpenText recommends you clean up the following work areas


periodically.

Import and Export Working Areas


Clear all directories in the <TEAMS_HOME>/data/cs/working_area/import and
<TEAMS_HOME>/data/cs/working_area/export areas on a monthly basis. If
this maintenance is performed while OTMM is online, clear directories older
than one week.

6.6 Miscellaneous items


This section discusses custom application clean up and JSP pages.

6.6.1 Custom application clean up


If you have custom applications installed in the <TEAMS_HOME>\ear folder,
periodically clear the following folders, according to your application server,
because newly deployed temp wars are not automatically cleared:
• JBoss
<JBOSS_HOME>/standalone/tmp
• TomEE
• TOMEE_HOME/temp
• TOMEE_HOME/work

OpenText Media Management – Administration Guide 203


MEDMGT160300-AGD-EN-02
Chapter 6 Maintenance recommendations

6.6.2 JSP pages


If you have custom applications installed in the <TEAMS_HOME>\ear folder,
periodically clear the following folders, according to your application server,
because newly deployed temp wars are not automatically cleared.
• JBoss
<JBOSS_HOME>/standalone/tmp
• TomEE
• TOMEE_HOME/temp
• TOMEE_HOME/work

204 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
Chapter 7
Tuning considerations

This section outlines a number of standard enterprise-application tuning activities


and techniques that can help an organization achieve better performance from
OTMM implementations on both Windows and Linux. While these
recommendations may help you achieve the maximum performance from your
OTMM installation, OTMM cannot guarantee that these recommendations will
provide a noticeable or measurable performance impact on your system. In an effort
to measure the impact of these tuning activities, OpenText recommends that you
take a “timed benchmark” of common user actions before and after any of these
tuning activities. In addition, a complete system backup should be taken before any
of these steps are implemented.

OTMM can be installed with the application software and the database on the same
physical server or they can be installed on separate servers. For the remainder of this
section, the server where the application software is installed will be referred to as
the application server, and the server where the database is installed will be referred
to as the database server. You will need to follow all steps for both the application
server and database server setup and configuration, regardless of whether these
components are on the same or different servers.

Note: The application server settings or settings need to be done on all the
nodes of the cluster.

7.1 Application server tuning


This section discusses how you can improve performance.

7.1.1 JBoss server tuning parameters


Based on the application data and usage profile, you can tune the application server.
To improve the performance and throughput, you need to consider the following
areas and tune the settings:

• JVM Heap and GC Characteristics


• Connection pooling
• Thread pooling
• Object pools
• Logging

For more information about tuning, see the JBoss EAP or WildFly Application Server
documentation.

OpenText Media Management – Administration Guide 205


MEDMGT160300-AGD-EN-02
Chapter 7 Tuning considerations

7.1.2 Advanced OTMM architecture options


There are a number of advanced architecture options included with OTMM that can
improve OTMM performance. These options include:
• Separate the OTMM services and the OTMM database.
• Load-balance OTMM by installing and configuring multiple instances with a
load balancer.

7.1.3 Managing OTMM application log files


OTMM maintains application logs in the <TEAMS_HOME>/logs directory. As
administrator, you can do the following to reduce the size of these logs:
• The main application log file, mediamanagemer-appserver.log, is written using
log4j. The amount of output is controlled by the logging subsystem section in the
configuration. It is possible to configure this in such a way as to produce a lot of
logging output. This might be useful in a troubleshooting scenario, but is
unnecessary in normal production mode. Periodically, review your settings and
make sure they are set appropriately. For more information about how to change
the logs levels of different categories and other logging configurations, see
“Changing the logging configuration” on page 194.

7.1.4 Configuring datasource parameters


OTMM is a database intensive application. The allocation of database connections
for it should be optimized. Depending on the user activity and/or concurrent access
to OTMM, you should tune the datasource parameters in OTMM accordingly.

To modify the datasource configuration for OTMM for JBoss EAP:

1. Sign in to the Management Console.


2. Click Configuration, expand Connector, and click Databases.
3. On the Pools tab, configure the pool size.
4. On XA DATASOURCES, configure the pool size for ArtesiaTeamsPool.

To modify the datasource configuration for OTMM for Wildfly:

1. Sign in to the Management Console.


2. Click Configuration.
3. Click to Subsystem > Datasources > Non-XA.
4. Click ArtesiaJBossSequencePool > View.
5. On the Pool tab, configure the pool size.
6. Click XA > ArtesiaTeamsPool, and then configure pool size for
ArtesiaTeamsPool.

206 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
7.2. System setting tuning configuration

To modify the datasource configuration for OTMM for TomEE:

• In a text editor, open the TOMEE_HOME/conf/tomee.xml and edit it.

7.2 System setting tuning configuration


The Settings page contains the following tuning configuration settings. For more
information about how to edit these settings, see “Editing a component and
properties” on page 136.

Search Indexing
The following system setting property is available under the INDEXING\SOLR
component, which is belongs to the Search configuration group.

DEFAULT_CO This setting instructs the Solr server to commit a batch of updated
MMIT_TIME assets for indexing within the time (in seconds) that you specify. Each
batch of updated assets will be submitted to Solr with this time
attached. The DEFAULT_COMMIT_TIME time instructs the Solr server
to commit the updates within the time that you specify.

The following system setting properties are available under the INDEXING
\COMMON component, which is belongs to the Search configuration group.

ASSET_BLOC Specify the size of the block of assets the Indexer collects. The default
K_SIZE set (block) size is 1000 assets.
DEFAULT_PO Specify how often the Indexer will check with the RDBMS for asset
LL_INTERVAL updates. The default is 30 seconds.
NUM_THREA The Indexer uses multiple threads to process asset updates. Specify
DS the number of threads to process. The default number of threads is 2.
The best settings for the NUM_THREADS value are 1 to 4. Beyond 4
threads, there are no appreciable performance benefits.

Search Performance
The following system setting property is available under the SEARCH\SERVER
component, which is belongs to the Search configuration group.

DEFAULT_MA Default result set size for searches. The default is 1000.
X_HITS

Importing
The following system setting property is available under the IMPORT\SERVER
component, which is belongs to the Import configuration group.

FILE_COPY_C Specify the chunk size in the number of bytes for transferring data on
HUNK_SIZE the server. The default is 1048576 bytes (1 MB). You should take into
account the resources available on the server, for setting a huge value
may use up the resources on the client system and a “not enough
system resource exception” may be thrown.

OpenText Media Management – Administration Guide 207


MEDMGT160300-AGD-EN-02
Chapter 7 Tuning considerations

Cleanup Timers
The following system setting properties are available under the APPLICATION
\CONTENT_SHARE component, which is belongs to the General configuration
group.

CLEANUP_FILE_AGE_THRESHOLD Files older than the specified time will be


deleted. Value is in minutes. The default is
120.
EXPORT_CLEANUP_FILE_AGE_THRES Files older than the specified time will be
HOLD deleted (the value is in hours). The
recommended value is 24.

UX Performance
The following system setting property is available under the COMMON
\CLIENT component, which is belongs to the General configuration group.

BULK_OPERA Specify the limit of the number of assets to select for bulk operations.
TIONS_ASSET Users will receive a warning message if they exceed this number of
_LIMIT assets during a bulk operation.
The default is set to 1000.

The following system setting properties are available under the COMMON
\SERVER component, which is belongs to the General configuration group.

INBOX_RECO Specify the number of notifications displayed in the Inbox.


RD_COUNT The default is 30.
PROCESS_LIS Specify the number of jobs displayed in the Job Center. By default,
T_RECORD_C this is set to 20.
OUNT
PROCESS_POL Polling interval in seconds. By default, this is set to 30.
LING_INTERV
AL_IN_SECS

The following system setting properties are available under the UX\GENERAL
component, which is belongs to the API Configuration configuration group.

MAX_VALUES The maximum number of results desired for the type-ahead search
_TO_LOAD_T feature. The default, -1, means it is ignored, which means that all the
YPE_AHEAD results will be loaded.
TYPEAHEAD_ The minimum number of characters needed to invoke the“type
NUM_MIN_C ahead” feature.
HARS The default is 2.

208 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
7.3. Database tuning

FETCH_FORW Specify the number of assets to fetch in advance for any search.
ARD_ASSET_ Fetching all of the assets returned from a search query can slow down
COUNT processing in the case of a large number of search results, so by
configuring the number of assets to store in the cache, you can make
searching more efficient.
The default is 200.

The following system setting properties are available under the UX


\OBJECTBUILDER component, which is belongs to the API Configuration
configuration group.

THREADING_ Set to true if the object builder will run threaded. Threading will
ON make the creation of DAMObject from the server parallel.
The default is true.
THREAD_LOA The number of objects to process per thread. For example, if page
D size=100, and THREAD_LOAD=25, then four threads will be used
for the request.
The default is 25.
THREAD_POO The number of threads available to the object builder. If no threads
L_SIZE are available, processing will be single threaded on the calling thread.
The default is 40.

7.3 Database tuning


This section discusses database tuning.

7.3.1 Rebuilding indexes


Your indexes may get fragmented, especially if you are importing large numbers of
assets continuously. If this occurs, then your user performance can be significantly
degraded. To address this, the indexes have to be rebuilt. For more information
about how to rebuild indexes depending on the database you are using, see the
documentation for your database.

7.3.2 Oracle database tuning


In many OTMM implementations, three areas are typically not tuned for growing
databases: System Global Area (SGA), indexes, and statistics. While most default
settings in the Oracle database often work well for small user communities and tens
of thousands of assets, these same settings often do not work well for larger user
communities and hundreds of thousands of assets. This tuning exercise is often very
simple: the SGA can (and should) often be made much larger to utilize the available
memory on the server, database indexes should often be created where none exist
(especially on metadata fields that are used for queries), and database statistics
should often be collected, often as simple as executing a “compute statistics”
database command. For OTMM on Linux, administrators can also factor in the
information available through System Activity Reports (SAR) to get real-time

OpenText Media Management – Administration Guide 209


MEDMGT160300-AGD-EN-02
Chapter 7 Tuning considerations

information regarding the use of CPU, memory and swap space. Additional sources
of information on database tuning can be found at http://www.oracle.com, http://
docs.oracle.com, and http://www.orafaq.org.

7.3.2.1 Oracle optimizer


There are times when the Oracle optimizer can be improved by gathering
statistics. By using the gather_schema_stats proc, which is describe at http://
www.dba-oracle.com/art_builder_dbms_stats.htm, you can improve Oracle search
performance.

7.3.3 Managing OTMM tables


This section discusses how to manage OTMM tables.

7.3.3.1 Workflow log tables


OTMM maintains user workflow activity logging in the WORKFLOW_LOGS table
in the OTMM database. Under normal circumstances these logs are not necessary,
can take up considerable database/disk space, compete with OTMM for CPU and
disk cycles, and if not managed properly, result in “out of table” errors during
OTMM operation. An administrator can do the following to reduce the size of these
logs:

To reduce the size of the workflow activity logs:

1. Locate the EVENT_CTXTS table in the OTMM database.

2. Change the value of LOGGING_DEST from 2 to 0 for all events in the table that
have a TAB_DEST of 'WORKFLOW_LOGS'.

Important
Do this only for the events recorded to the WORKFLOW_LOGS table.
Events recorded to the STATUS_LOGS table are necessary for OTMM to
run correctly.

7.3.3.2 Auditing tables


There are several auditing tables (asset_security_log, security_policy_log, and
user_group_log) in OTMM. Customers need to have a policy where they remove old
content from these tables on a regular basis as they can get large. This is probably
only a real issue for asset_security_log as this one records adding and removing
asset to or from security policies. The other two will grow very slowly.

210 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
7.4. Search Index tuning

7.3.3.3 Session tables


OTMM maintains a table for holding the Active session information in the
CLIENT_SESSIONS table. There are several reasons which could cause the Active
sessions to not be deleted. This table has to be regularly cleaned up to avoid having
unwanted records held.

7.4 Search Index tuning


This section discusses how to tune the Search Index.

7.4.1 Solr server log files


The Solr server maintains application logs in the Solr logs directory. The main Solr
log is written using log4j. The amount of output is controlled by the log4j.
properties configuration file. On Windows, this file is located under the Solr install
directory, under the solr-5.3.1\server\resources subdirectory. On Linux, it is
located in the Solr writable files directory, which by default is /var/solr. You can
set this in such a way to produce a lot of logging output. You might find this useful
in a troubleshooting scenario, but is unnecessary in normal production
mode. Periodically review your settings and make sure they are set appropriately

7.5 Performing maintenance


Performing maintenance activities helps in reducing the overhead added over a
period of time. For more information, see “Maintenance recommendations“
on page 197.

OpenText Media Management – Administration Guide 211


MEDMGT160300-AGD-EN-02
Chapter 8
Field Locking

This section provides information about the LockUnlockUtility feature, which is


used to lock and unlock any metadata fields at asset level.

8.1 LockUnlockUtility
The LockUnLockUtility feature is used to lock and unlock any metadata fields at
asset level. The purpose of the field locking is to make some field values permanent
and locked on individual assets. Such fields could represent a wide range of
concepts for accounting, auditing, and archiving purposes. Administrators or
integrators can use this functionality in several scenarios to create a field that is
locked when a particular event occurs, such as the first time someone writes to it or
on a certain date.

The LockUnLockUtility feature captures the asset IDs and metadata fields
specified in an XML file and passes them to the following methods to lock or unlock
them.

In the SDK module


LockUnLockUtility uses the following services in com.artesia.asset.
metadata.services.AssetMetadataServices:

• public void lockAssetMetadataFields(List<AssetIdentifier>


assetIds, List<TeamsIdentifier> metadataFieldIds,
SecuritySession session)
• public void unlockAssetMetadataFields(List<AssetIdentifier>
assetIds, List<TeamsIdentifier> metadataFieldIds,
SecuritySession session)

LockUnlockUtility uses the following attribute and getter/setter:

• com.artesia.metadata.MetadataValue
• private boolean _isLocked = false
• public boolean isLocked()
• public void setIsLocked(boolean locked)

In the Server Module


LockUnlockUtility uses the following class:

• com.artesia.server.asset.metadata.entity.AssetMetadataFieldLock
• private AssetIdentifier _assetId
• private TeamsIdentifier _metadataFieldId

OpenText Media Management – Administration Guide 213


MEDMGT160300-AGD-EN-02
Chapter 8 Field Locking

• private List<MetadataValue> _metadataValues

LockUnlockUtility uses the following methods in com.artesia.server.


metadata.bean.AsseMetadataBean:

• public void lockAssetMetadataFields(List<AssetIdentifier>


assetIds, List<TeamsIdentifier> metadataFieldIds,
SecuritySession session)
• public void unlockAssetMetadataFields(List<AssetIdentifier>
assetIds, List<TeamsIdentifier> metadataFieldIds,
SecuritySession session)

8.1.1 Database design


The AssetMetadataFieldLock objects will be stored in the database across three
tables in the following way. The ASSET_METADATA_FIELD_LOCKS table contains
two columns for the UOI_ID and METADATA_FIELD_ID. These are used for storing the
AssetIdentifier of the asset instance on whom the Metadata Field represented by
the TeamsIdentifier stored in the METADATA_FIELD_ID column is locked.

The METADATA_FIELD_ID is referenced in the FIELD_ID column of the


METADATA_FIELDS table. The UOI_ID column in the
ASSET_METADATA_FIELD_LOCKS table is referenced in the UOI_ID column of
the UOIS table. The value for the Metadata Field is retrieved by using the
TABLE_NAME and COLUMN_NAME columns in the METADATA_FIELDS table and by
looking at the value in the NAME column in the TABLE for the UOI_ID. This can be
seen more clearly in the following example, where the Metadata Value will be stored
under the NAME column of the UOIS table.

Figure 8-1: AssetMetadataFieldLock Database Design

214 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
8.1. LockUnlockUtility

8.1.2 LockUnlockUtility.dtd
LockUnlockUtility.dtd is created to validate the input XML file, which contains
the set of assets and related metadata fields to be locked or unlocked. The
LockUnLockUtilityDtdResolver.java file has been added at the following
location:

server-utilities/java/com/artesia/server/tools/lockunLockfields/
LockUnLockUtilityDtdResolver.java

This file should be placed in the <TEAMS_HOME>\data folder.

Structure of the LockUnlockUtility.dtd:

<!ELEMENT LockUnLockUtility (asset+)>

<!ELEMENT asset (id,fields)>

<!ELEMENT id (#PCDATA)>

<!ELEMENT fields (field+)>

<!ELEMENT field EMPTY>

<!ATTLIST field fid CDATA #REQUIRED>

<!ATTLIST field lock (true|false) #REQUIRED>

8.1.3 LockUnlockUtility.bat
The LockUnlockUtility.bat file, located in the <TEAMS_HOME>\bin directory, is
used to run the LockUnlockUtility feature. When run, it will execute the following
class:

server-utilities/java/com/artesia/server/tools/lockunLockfields/
LockUnLockAssetFields.java

The syntax is as follows:

LockUnlockUtility.bat -user <user name> -password <password> -filename


<xmlfile>

The following are required parameters:

-user <user name>


OTMM user ID used to access this tool.

-password <password>
OTMM user ID password.

-filename <xmlfilename>
The XML file which contains the asset and related metadata fields information.

OpenText Media Management – Administration Guide 215


MEDMGT160300-AGD-EN-02
Chapter 8 Field Locking

Example 8-1: LockUnlockUtility.bat

<TEAMS_HOME>/bin/LockUnlockUtility.bat -user tsuper -password


tsuper -filename LockUnlockUtility.xml

8.1.4 LockUnlockUtility.xml
The LockUnlockUtility.xml file contains details of the asset metadata fields to be
locked or unlocked. The following shows the structure of this XML file:

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE LockUnLockUtility SYSTEM "/data/LockUnlockUtility.dtd">

<LockUnLockUtility>

<asset>

<id></id>

<fields>

<field fid = "" lock ="true" />

<field fid = "" lock ="false" />

</fields>

</asset>

</LockUnLockUtility>

The following provides a description of each element and attribute:

DOCTYPE
<!DOCTYPE LockUnLockUtility SYSTEM "/data/LockUnlockUtility.dtd">
specifies the DTD file location.

<LockUnLockUtility>
Root element, contains list of Asset Elements.

<asset>
Contains Asset ID, name and related metadata fields.

<id>
ID of an Asset.

<fields>
Contains set of metadata fields.

216 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
8.1. LockUnlockUtility

<field>
Represents a metadata field.

<fid>
ID of the metadata field.

<lock>
Contains true/false (true for locking, false for unlocking).

OpenText Media Management – Administration Guide 217


MEDMGT160300-AGD-EN-02
Chapter 9
Populating folder types

This section provides information about how to populate folder types in the OTMM
database using the Admin Utility.

9.1 Admin Utility for folder types


A folder type is a configuration that establishes the attributes of any instances of that
folder type. The configuration allows specification of the model associated with any
instances, which drives what metadata can be defined on the folder instance. The
configuration also defines what the folder types of the parents and children can be,
as well as several other attributes. The Admin Utility is used to populate the folder
types in the OTMM database. The following are key elements used in conjunction
with the Admin Utility:
• Admin Utility .DTD
• Admin Utility .BAT
• Folder Type .XML

These elements are described in the following sections.

9.1.1 AdminUtility.dtd
AdminUtility.dtd is newly created to define or restrict the standard structure of
the folder type XML file. The DTD file should be copied into the following directory:

<TEAMS_HOME>\data

9.1.2 AdminUtility.bat
The AdminUtility.bat file, located in the <TEAMS_HOME>/bin folder, is used to
populate the folder types in the OTMM database.

The syntax is as follows:

AdminUtility.bat -file c:\FolderTypeV3.0.xml -user <user> -password


<password>

Required parameters:

-file <parsing file>


The name and location of the input XML file.

-user <user id>


The user ID used to sign in to OTMM.

OpenText Media Management – Administration Guide 219


MEDMGT160300-AGD-EN-02
Chapter 9 Populating folder types

-password <password>
The password for the user ID used to sign in to OTMM.

Optional parameters:

-mode <delete>
Delete all existing folder types based on ID.

Example: C:\MediaManagement\Bin\> AdminUtility.bat -file c:


\FolderTypeV3.0.xml -user <user name> -password <password> -mode
<delete>

9.1.3 Folder type XML file


The folder type XML file contains the information pertaining to the folder types to
populate in the OTMM database.

The DOCTYPE declaration is as follows:

<!DOCTYPE ContainerTypes SYSTEM "/data/AdminUtility.dtd">

The following list describes the different elements in the XML file:

ContainerTypes
Root element containing a list of ContainerType elements.

ContainerType
Parent element containing all mandatory and optional data (elements):

<ID> </ID>
ID of the folder type. Leading and trailing spaces will be trimmed before
processing the ID. The maximum length of the ID is 40 characters. (Mandatory)

<Name> </Name>
Name of the folder type. (Mandatory).

<Description> </Description>
Description of the folder type. If nothing is specified or if this tag is not there,
then a null value or empty string will be populated into the database. (Optional)

<ModelIdentifier> </ModelIdentifier>
Specify any model name existing in the database. If the specified model is not
present or if the tag is not available in the XML, then the tool will not process
this folder type and will instead display an appropriate message. (Mandatory)

<ThumbnailFilePath> </ThumbnailFilePath>
Fully qualified path with the name of the small thumbnail image that will be
used.

<PreviewThumbnailPath> </PreviewThumbnailPath>
Fully qualified path with the name of the large thumbnail image that will be
used.

220 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
9.1. Admin Utility for folder types

<IsActive> </IsActive>
This attribute determines if the folder type is in an active or inactive state. In the
user interface, since all the operations are based on this field, some of the
operations may not be possible if the folder type is marked as inactive.
<RestrictedtoHaveSingleParent> </RestrictedtoHaveSingleParent>
Specifies whether the folder type is of the single parent type or not. If set to
FALSE, then the folder type can have more than one parent. If set to TRUE, then
the folder type cannot have more than one parent.
<IsRoot> </IsRoot>
This should always be FALSE. This attribute determines whether the folder type
is a root node or not. The utility is not supposed to populate any root nodes.
<AreContainerChildrenRestricted> </AreContainerChildrenRestricted>
This attribute determines whether the folder type is restricted or not. TRUE
means that this folder can only be a parent of the folders specified in the
<ListOfAllowedChildTypes> tag. FALSE means that this folder could be a
parent of any other folder in the system (including itself). For example:
In the following scenario, A, B, C, and D are four folders and the
AreContainerChildrenRestricted flag is set to FALSE for A, B, and C and is
set to TRUE for D.
A is the parent of B.
A is the parent of C.
Because the value of AreContainerChildrenRestricted for folder D is set to
TRUE, D cannot be a parent of A, B, C, and D (itself). D can be child of A, B, and
C.
D can be the parent of folder that has a container type defined in
ListOfAllowedChildTypes.

<CanContainAssets> </CanContainAssets>
This attribute determines whether the folder type can hold any assets or not. If
CanContainAssets is set to TRUE, that means the folders of this folder type can
hold assets. If CanContainAssets is set to FALSE, that means the folders of this
folder type can hold only folders but not direct assets.
<ListOfAllowedChildTypes> </ListOfAllowedChildTypes>
List of allowable child folder types. The user may choose from available folder
types. If nothing is specified, then all types are allowed. This is important only
when the <AreContainerChildrenRestricted> XML tag is set to TRUE.
<AllowedChildType> </AllowedChildType>
Name of the child folder type to be allowed. The name of the child folder type
specified here must exist in the system or it must be defined in the XML file,
before the definition of its parent. If the child folder is defined in the XML file
after the definition of the parent, this will result in an error and the restriction
will be ignored.
In the following example, the folder of this type will not accept any folders or
assets having “Action Movies” and “English Movies” folder types as its

OpenText Media Management – Administration Guide 221


MEDMGT160300-AGD-EN-02
Chapter 9 Populating folder types

children. The child or parent folders used in this XML file should have already
been created:

<ListOfAllowedChildTypes>
<AllowedChildType>ACTION MOVIES</AllowedChildType>
<AllowedChildType>English MOVIES</AllowedChildType>
</ListOfAllowedChildTypes>

<Inheritance Levels> </Inheritance Levels>


There are two different types of inheritance levels available:

• All Level
• One Level

<AllLevelInheritance> </AllLevelInheritance>
If a field is specified as All Level, the field will be accessible to all folders, assets,
and subfolders. For example:

<AllLevelInheritance>
<TeamsIdentifier>ARTESIA.FIELD.NAME</TeamsIdentifier>
</AllLevelInheritance>

Notes
• The same field name should not be mentioned for both One Level and
All Level inheritance.
• The Asset ID field (ARTESIA.FIELD.ASSET ID) cannot be defined as
inheritable.
• Filed names specified in this list need to exist in the Model specified in
the ModelIdentifier tag.
• ForceSet will always be set to TRUE in the API to affect One Level and
All Level inheritance.
• You cannot add Tabular Fields as a AllLevelInheritance and
OneLevelInheritance while working with folder type.

<OneLevelsInheritance> </OneLevelsInheritance>
If a field is specified as One Level, the field will be accessible to only to its
immediate folder and assets. For example:

<OneLevelsInheritance>
<TeamsIdentifier>ARTESIA.FIELD.NAME</TeamsIdentifier>
<TeamsIdentifier>ARTESIA.FIELD.DESCRIPTION</TeamsIdentifier>
<TeamsIdentifier>ARTESIA.FIELD.ID</TeamsIdentifier>
</OneLevelsInheritance>

Notes
• The same field name should not be mentioned for both One Level and All
Level inheritance.

222 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
9.1. Admin Utility for folder types

• The Asset ID field (ARTESIA.FIELD.ASSET ID) cannot be defined as


inheritable.
• Field names specified in this list must exist in the Model specified in the
ModelIdentifier tag.
• ForceSet must always be set to TRUE in the API to take affect of One Level
and All Level inheritance.
• You cannot add Tabular Fields as a AllLevelInheritance and
OneLevelsInheritance while working with folder type.

<ListOfAllowableUserGroups> </ListOfAllowableUserGroups>
List of User Groups who are allowed to create folder instances of this folder
type. (Mandatory) For example:

<ListOfAllowableUserGroups>
<AllowableUserGroupID>1</AllowableUserGroupID>
<AllowableUserGroupID>10</AllowableUserGroupID>
<AllowableUserGroupID>26</AllowableUserGroupID>
</ListOfAllowableUserGroups>

Note: User Groups specified in this list will be able to create folders of this
folder type. If this list is left empty, it is assumed that all users will be able
to create folders of this folder type.

OpenText Media Management – Administration Guide 223


MEDMGT160300-AGD-EN-02
Chapter 10
Partial deletion of assets

The Partial Deletion of Assets feature allows users to delete, undelete, and purge
assets from the system and database. However, you can specify what Content Kinds
will not be purged from the system. For example, consider a scenario where rights
or permissions to access specific content are about to expire or may have already
expired, and the metadata used for this asset has not yet expired. Depending on how
the Purge command has been configured, users may be able to delete all versions of
the asset but keep the metadata of the content.

Assets marked for selective deletion appear on the Recycle Bin page, where they can
be purged, and all the master files associated with the assets will be removed from
the file system and the database. The Content Kinds that are purged is determined
by settings, located under the WEB\GENERAL component, which belongs to the
General configuration group. For more information, see “Editing a component and
properties” on page 136.

10.1 Configuring purge system settings


To configure the Content Kinds that will not get purged during the execution of the
Purge command, use the CONTENT_KIND_NOT_TO_PURGE setting. These setting
parameters are effective only when the Delete Content Only option is selected in
the Delete dialog box during asset deletion.

To configure the Purge command, configure the CONTENT_KIND_NOT_TO_PURGE


setting (located under the WEB\GENERAL component, which belongs to the
General configuration group) by changing its value to one of the following:

• THUMBNAIL
• PREVIEW
• KEYFRAME
• SUPPORTING
• RENDITION

Notes
• To configure the Purge to command purge everything except thumbnails,
enter THUMBNAIL.
• To configure the Purge command to purge more than one Content Kind, use
a comma-separated list. For example, THUMBNAIL, PREVIEW.
• For more information about editing settings, see “Editing a component and
properties” on page 136.

OpenText Media Management – Administration Guide 225


MEDMGT160300-AGD-EN-02
Chapter 10 Partial deletion of assets

10.2 Implications of partially deleted assets


A partially deleted asset is an asset whose master file and one or more Content
Kinds have been deleted, leaving the metadata of the asset intact in the system.
When an asset is partially deleted—whether purged or not—the following list
indicates what actions will be enabled and disabled on the asset.

Note: The actions available for partially deleted assets are not the same as for
fully deleted assets.

The following features are allowed to operate on an asset marked for partial
deletion:
• Show Inspector
• Attach Content (it should be available only when a partially deleted asset is
purged)
• Undelete
• Add to folder

The following features are not allowed to operate on an asset marked for partial
deletion:
• Download
• Delete
• Check-Out
• Edit/Bulk-Edit
• Link
• Share
• Subscribe/Unsubscribe

An asset cannot be partially deleted if the asset is in any of the following states:
• Checked-out
• Deleted or partially deleted
• A metadata-only asset

226 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
10.3. Recycle Bin

10.3 Recycle Bin


In the Recycle Bin in the Web Administration tool, assets marked for complete
deletion will be shown as FULL in the What’s Deleted column. Assets marked for
content deletion, partial deletion, or selective deletion will be shown as PARTIAL.
When folders are marked for deletion, they also will appear in the Recycle Bin page,
with the Content Type shown as FOLDER and the What’s Deleted column shown
as FULL.

OpenText Media Management – Administration Guide 227


MEDMGT160300-AGD-EN-02
Chapter 11
Multilingual metadata

Multilingual metadata extends the existing OTMM metadata by allowing locale-


specific translations to metadata values. An asset’s multilingual metadata field
contains a default value. This default value is the same behavior that exists in
previous OTMM releases and is configured in the default locale. In addition to this
default value, each multilingual metadata field can contain value translations for
other locales. For example, a multilingual metadata field may contain a default value
“purple” in the default [en_US] locale. Translations for this value can be added:
[fr_FR] pourpre, [de_DE] lila, [el_GR] µωβ.

Providing translations in multiple locales allows a client application to display the


metadata in the user’s chosen locale. If the user’s locale is not available, the default
values are used.

OTMM provides SDK, RESTapi, and administrative support for scalar multilingual
metadata. The OTMM administration user interface provides the capability to create
multilingual metadata tables and configure multilingual metadata fields.

11.1 Configuring metadata locales


All multilingual metadata value translations are associated with a configured
metadata locale. Metadata locales are configured in the Metadata_Languages table
using the Metadata Language Configuration page. The default locale is en_US.

Note: Configure metadata locales before importing assets with multilingual


metadata. When a value is assigned to a multilingual metadata field, the
corresponding locale becomes in use. Locales that are currently in use cannot
be changed to be the default locale, and they cannot be removed from the list
of configured metadata locales.

To configure metadata locales:

1. On the top-level menu, click Metadata > Metadata language.


2. Click the plus sign (+) icon on the lower left to add a new metadata locale.

Tips
• To remove a locale, select and click the minus sign (-) icon on the lower
left.
• Set a language as the default locale by clicking its corresponding radio
button in the Default column.
3. In the Language column, choose the locale you want from the list of available
locales.

OpenText Media Management – Administration Guide 229


MEDMGT160300-AGD-EN-02
Chapter 11 Multilingual metadata

4. Click Update Languages.

11.2 Configuring multilingual metadata


Creating a multilingual metadata field is a two-step process:

1. Create a custom multilingual metadata table.


2. Use the new table to create a multilingual metadata field.

11.2.1 Creating custom multilingual metadata tables


To create custom multilingual metadata tables:

1. On the top-level menu, click Metadata > Custom table editor.

2. Click the plus sign (+) icon on the lower left to create a new metadata table.

Note: A multilingual check box is enabled for all TEXT (char, varchar)
columns in the metadata table.

3. Create the columns for the new metadata table.

4. Select the multilingual check box for the appropriate TEXT columns.

5. Click Create Table.

11.2.2 Creating multilingual metadata fields


Multilingual metadata fields are based on multilingual-enabled metadata tables.
Once a custom multilingual metadata table has been created, use the Metadata
Editor to create multilingual metadata fields.

To create multilingual metadata fields:

1. On the top-level menu, click Metadata > Metadata editor.

2. Click the Fields section on the left-hand side.

3. Click the plus sign (+) icon on the lower left to create a new field.

4. Enter a name for the field.

5. Select the multilingual table from the drop-down list.

6. Select a multilingual column from the drop-down list. The multilingual check
box will already be selected.

Note: You can optionally override the multilingual setting by clearing the
multilingual check box. The metadata field will then behave as a standard
metadata field with no translation capabilities.

7. Fill out the rest of the metadata form and click Apply.

230 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
11.3. Updating an existing metadata field to be multilingual

11.3 Updating an existing metadata field to be


multilingual
Updating an existing metadata field to be a multilingual metadata field is a two-step
process:

1. Modify an existing custom table and select the multilingual check box for one or
more columns.
2. Modify the associated metadata field and select the multilingual feature.

11.3.1 Upgrading existing custom metadata tables to be


multilingual
To upgrade existing custom metadata tables to be multilingual:

1. On the top-level menu, click Metadata > Custom table editor.

2. Click the name of the metadata table you want to make multilingual.

3. Text columns will have a multilingual check box enabled. Select the
multilingual check box for the multilingual fields.

4. Click Update.

Once the table has been updated, the metadata fields can be reconfigured to support
multilingual (translated) values.

11.3.2 Upgrade existing metadata field to be multilingual


Once a metadata table has been configured to support multilingual values, you can
then enable multilingual values for an existing metadata field.

To enable multilingual values for an existing metadata field:

1. On the top-level menu, click Metadata > Metadata editor.

2. Click the Fields section on the left-hand side.

3. Select the scalar metadata field.

4. Select the multilingual check box.

5. Clip Apply.

OpenText Media Management – Administration Guide 231


MEDMGT160300-AGD-EN-02
Chapter 11 Multilingual metadata

11.4 Importing and exporting multilingual metadata


values
Assets can be imported and exported in XML format. The OTMM tasset.DTD
describes the asset XML format. This file is automatically updated with the XML
definitions for the multilingual metadata fields. For more information about the
XML format, see OpenText Media Management - Integration Guide (MEDMGT160300-
AIN).

In the example used below in this section, assume the following scalar metadata
fields have been defined in the Metadata Editor:

CUSTOM.FIELD.MULTI_TEXT1
Metadata Table: ML_TEST
Multilingual Values Table: ML_TEST_L (configured by Custom Table Editor)
Metadata Table Column: TEXT_ML1

CUSTOM.FIELD.MULTI_TEXT2
Metadata Table: ML_TEST
Multilingual Values Table: ML_TEST_L (configured by Custom Table Editor)
Metadata Table Column: TEXT_ML2

For this example, the following changes will be made to the tasset.DTD file:

• The metadata table ELEMENT has been updated to include the metadata locale
table as an attribute. The metadata locale table is where the metadata translation
and locale values are stored. For example, the ML_TEST table is configured to
support multilingual metadata values in the ML_TEST_L table.
<!ELEMENT ML_TEST (ML_TEST_L*)>
• A new ELEMENT is added for the metadata locale table. The multilingual
columns used in multilingual metadata fields will be defined in the ATTLIST. In
addition to the metadata columns, the LOCALE column must be defined for the
multilingual metadata values.
So continuing the example above:

<!ELEMENT ML_TEST_L EMPTY>


<!ATTLIST ML_TEST_L
LOCALE CDATA #IMPLIED
TEXT_ML1 CDATA #IMPLIED
TEXT_ML2 CDATA #IMPLIED
>

The tasset.DTD is used to validate the XML asset metadata format used when
importing assets into OTMM.

232 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
11.4. Importing and exporting multilingual metadata values

11.4.1 Importing assets containing multilingual metadata


The OTMM Bulk Import utility imports assets using XML format to define each
asset’s metadata. The asset XML format has been expanded to include support for
multilingual metadata fields. Multilingual metadata values will be defined as sub
elements of the main metadata field. The locale translations for metadata are stored
in a table with a _L extension. For the above example, the XML metadata values are
defined as follows:

<TEAMS_ASSET_FILE>
<ASSETS>
<ASSET>
<METADATA>
<UOIS MODEL_ID="102" NAME="Bridge.jpg">

<!-- Multilingual metadata values specified in this block


-->
<ML_TEST TEXT_ML1="bridge text1" ANUM="12345"
TEXT_ML2="multilingual bridge 2" TEXT_REG1="regular
bridge">

<!-- German metadata value translation -->


<ML_TEST_L LOCALE="DE" TEXT_ML1="german bridge 1"
TEXT_ML2="german bridge 2" />

<!-- French metadata value translation -->


<ML_TEST_L LOCALE="FR" TEXT_ML1="French bridge 1"
TEXT_ML2="French bridge 2" />
</ML_TEST>
<!-- END: Multilingual metadata definition -->

</UOIS>
</METADATA>
<CONTENT>
<MASTER FILE="asset0000001" />
</CONTENT>

In this metadata example, the ML_TEST table has been configured to support
multilingual metadata. Scalar multilingual metadata fields are defined for the
ml_test.TEXT_ML1 and ml_test.TEXT_ML2 columns.

For a more information about the XML format and using the Bulk Import utility, see
OpenText Media Management - Integration Guide (MEDMGT160300-AIN).

OpenText Media Management – Administration Guide 233


MEDMGT160300-AGD-EN-02
Chapter 11 Multilingual metadata

11.4.2 Exporting assets containing multilingual metadata


The new XML format is also used to represent assets exported from OTMM. OTMM
will export multilingual metadata values when:

• Using the RESTapi export operations and the load_multilingual_values is set


to true.
• Using the SDK and the AssetMetadataRequest.
setLoadMultilingualFieldValues() is set as true.

The default for both of the above values is false. As a result, the Share option in
Media Management will export only the default multilingual metadata values. To
export all multilingual metadata values, a custom export operation is required.

11.5 Retrieving assets containing multilingual


metadata at the API level
While the HTML5 UI does not yet support the new multilingual metadata fields in
this Patch 1 release, it is possible to retrieve assets with multilingual values through
either the SDK or the REST API. The SDK and REST API methods for retrieving
assets are unchanged. The only difference is in the parameters passed to these
methods as part of the input.

For more information on the methods available for retrieving assets, see REST API
Swagger documentation and OpenText Media Management Programmer Guide (https://
knowledge.opentext.com/knowledge/llisapi.dll/Properties/69371555).

SDK
The SDK methods that retrieve assets are passed an AssetDataLoadRequest
object that controls what properties of the asset are returned. If this
AssetDataLoadRequest object has been configured to retrieve the metadata, it
can be configured to also retrieve the multilingual values associated with each
field by calling it’s setLoadMultilingualFieldValues(true) method. By
default, multilingual metadata values will not be returned when the metadata
for assets is retrieved.

REST API
The REST API methods that retrieve assets have an optional
load_multilingual_values parameter. To retrieve the multilingual values
associated with each field, set the value of this parameter to true. This
parameter is honored only when the load_type parameter is set to metadata or
full. For the custom load type, multilingual values can be requested using the
load_multilingual_field_values property of the data_load_request
parameter.
By default, multilingual metadata values will not be returned when the
metadata for assets is retrieved.

234 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
Chapter 12
Appendix A – Preference file

This appendix describes the naming conventions for the OTMM preference file,
Tresource, and the internal format of the preference file. It also provides definitions
of all of the individual preferences that can be set within a preference file.

12.1 Tresource file


The Tresource file is located in the <TEAMS_HOME>/data/cs/global directory of
each installation. Node-specific settings are configured in Tresource. First, settings
are checked in Tresource, if a setting is not available in Tresource, then it will be
retrieved from database.

The following are the node-specific settings that are stored in Tresource, which are
pre-configured and included with the OTMM installation:

[COMMON\SOLR]

"SOLR_URL"=""

"SOLR_HOST"=""

[INDEXING\SOLR]

DISABLE_INDEXING

[JNDI\CONFIG]

"INITIAL_CONTEXT_FACTORY"="org.jboss.naming.remote.client.
InitialContextFactory"

"FACTORY_URL_PACKAGES"="org.jboss.naming"

"PROVIDER_HOST"="remote://localhost:11099"

"USE_REMOTE_INTERFACES"="Y"

"USE_INTERNAL_CONTEXT_FACTORY_BUILDER"="N"

[COMMON\SERVER]

"DB_TYPE"=""

[COMMON\JDBC]

"JDBC_URL"=""

OpenText Media Management – Administration Guide 235


MEDMGT160300-AGD-EN-02
Chapter 12 Appendix A – Preference file

Note: Lines beginning with # are comment lines and are ignored by the
resource interpreter.

12.2 Tresource settings cache


When preferences are marked as non-volatile (“Volatile and nonvolatile
preferences” on page 238), they are cached in memory after they have been
retrieved for the first time. The memory cache is always checked first for a given
preference, thereby reducing device accesses and improving performance. If the
requested preference is not found in the cache, the search reverts to the next area,
that is the Tresource file, then the database. (Settings stored in the database are
available through the Settings page in the Web Administration tool. For more
information, see “Settings” on page 130.) The memory cache has a fixed size. If the
cache overflows, the least recently accessed preference is replaced, and the newly
accessed preference is cached.

12.3 Changing server preferences


To change the default settings for the OTMM server processes:

1. Make a backup copy of the current Tresource file.

2. Using an ASCII file editor, open the Tresource file, and then edit the
appropriate blocks for the preferences that you want to change. For information,
see “Preferences blocks” on page 237.

3. Save and close the file.

4. Restart the OTMM server processes to apply the preference changes.

236 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
12.4. Preferences blocks

12.4 Preferences blocks

Figure 12-1: Preferences Format

Preference blocks begin with a preference header. A preference header is created by


concatenating an OTMM component name (such as IMPORT, EDIT, SEARCH), a
backslash ( \ ), and a keyname (typically CLIENT or SERVER). The resulting string is
then surrounded by square brackets in the following format:

[COMPONENT\KEYNAME]

12.4.1 Preference value formats


Preference values can be either string or integer types. Integer and string preferences
are uniquely identified within a preference block by their preference name.

Specify a String value by surrounding the preference name with double quotation
marks, followed by an equal sign, and then the string value is also surrounded by
double quotation marks:

"Preference Name"="String Value"

Specify an Integer value by surrounding the preference name with double quotation
marks, followed by an equal sign, followed by the keyword DWORD: and then an
integer value:

"Preference Name"=DWORD:<integer>

OpenText Media Management – Administration Guide 237


MEDMGT160300-AGD-EN-02
Chapter 12 Appendix A – Preference file

12.5 Volatile and nonvolatile preferences


Preferences are volatile or nonvolatile. Nonvolatile preferences are cached in
memory after their first retrieval, while volatile preferences are never cached. Thus,
a change to a volatile preference takes effect immediately, while a nonvolatile
change only takes effect when the user restarts the session.

Preferences are nonvolatile by default. To mark a preference as nonvolatile, place a


[C] before its name. To mark a preference as volatile, place an [NC] before its name.

In the following example the integer value preference is cached by default. The color
preferences are all set to non-cached, since the user can change these.

[Preference\Server]
"Integer Value"=DWORD:1234
[NC]"color_COUNT"="3"
[NC]"color_0"="red"
[NC]"color_1"="green"
[NC]"color_2"="blue"

238 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
Chapter 13

Appendix B – System settings

This appendix lists the system settings that are available through the Settings page
and the Tresource file.

13.1 System configurations


This section lists the system settings that are available through the Settings page in
the Web Administration tool, and the Tresource file.

13.1.1 ADAPTIVE_MEDIA\CONFIG
ADAPTIVE_MEDIA_ENABLED
Set this to Y to enable populating the Adaptive Media Delivery URL in the asset
properties.
The default is N.

ADAPTIVE_MEDIA_URL
The base URL for the Adaptive Media Delivery server. The asset property will
have this value appended with logical UOI ID.

13.1.2 ADOBE\CCAPPS
CHECK_TIME_INTERVAL
Specify the time interval (in seconds) for polling the asset status from the server.

DEFAULT_PROPERTY_TEMPLATE_ID
Specify the default property template ID for import from the OpenText™ Media
Management Connector for Adobe Creative Cloud.

13.1.3 APPLICATION\CONTENT_SHARE
CLEANUP_FILE_AGE_THRESHOLD
Files older than the specified time will be deleted. Value is in minutes.
The default is 120 minutes.

EXPORT_CLEANUP_FILE_AGE_THRESHOLD
Files older than the specified time will be deleted (the value is in hours). The
recommended value is 24 hours.

Note: The changes to this setting will be applied after you restart the
Media Management server.

OpenText Media Management – Administration Guide 239


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

13.1.4 ASSET\CONFIG
ALLOW_FILE_NAME_CHANGE_IN_REPOSITORY
Set this value to TRUE to change file name in repository while renaming the
asset. The default value is FALSE.
DUPLICATE_CHECKER_ENABLED
Set to true to check if the name of the asset or folder exists. If the name is being
used, the user sees a warning and is asked to review the name of the asset or
folder to avoid duplication, or to continue, which results in duplicate names.

Notes
• The user is warned even if the asset or folder is in a deleted state.
• OTMM checks for duplication of the name of the asset at the system
level. It checks for the name of the folder, at the folder level.

By default, DUPLICATE_CHECKER_ENABLED is set to false.


RECENT_ACCESS_LIMIT
Specify the limit of the number of recently accessed folders and assets. The
default value is 25.

13.1.5 ASSET\METADATA_TRANSFORMERS
APPLY_VALUE_TRANSFORMATIONS
Set this value to true to turn on metadata value transformations.
VALUE_TRANSFORMERS
A comma separated list of the metadata value transformers that are applied
before metadata is saved.

Note: The changes to this setting will be applied only after you clear the
caches. In the Web Administration tool, on the top-level menu, click
Utilities > Clear caches, and then click Clear caches.

13.1.6 COLLABORATION\CONFIG
JOB_MANAGER_ROLE_ID
The Job Manager role ID for Collaborative Jobs. This setting is informational for
the HTML5 UI, and generally should not be changed.
JOB_ADMIN_USER
Specify an admin user name which will allow the retrieval of Collaborative Jobs
where no manager exists except those who have been deleted and disabled.
OpenText recommends you create an OTMM user specifically to manage
Collaborative Jobs. The default value is tsuper.
ASSET_PROXY_USER
Specify a proxy user name which will allow the retrieval of all assets for a
Collaborative Job when the Review Mode is set to All. The default value is

240 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

tsuper, but OpenText recommends you create an OTMM user specifically for
Collaborative Jobs which has permissions for viewing all OTMM assets. This
proxy user is required when the Review Mode is set to All.

Notes
• You must set STRICT_MODE_ONLY to N to apply this settings.
• If the Review Mode is configured as All for a Collaborative Job and
some of the assets are restricted by permissions, then all participants,
even those who do not have OTMM permissions to see the restricted
assets, will be able to view all the assets in the context of the Job as they
will be using the proxy user permissions.
• If the Review Mode is configured as Strict for a particular
Collaborative Job and some of the assets are restricted by permissions,
then only those users who have OTMM permissions for restricted assets
will see those assets in the context of the Job. Participants who do not
have sufficient permissions for the restricted assets will not see those
assets.

STRICT_MODE_ONLY
If Strict Mode is set to Y, "STRICT_MODE_ONLY"="Y", and the Collaborative Job
contains restricted assets, then only users who have sufficient permissions to
view the restricted assets will see them during the review process. If Strict
Mode is set to N, "STRICT_MODE_ONLY"="N", then an addition list will be
available within the Collaborative Job detail screen to allow Initiators to make
assets available to reviewers who do not have sufficient OTMM permissions to
view the assets.
By default, this value is set to Y.

13.1.7 COMMON\CLIENT
BULK_OPERATIONS_ASSET_LIMIT
Specify the limit on the number of assets to select for bulk operations. Users will
receive a warning message if they exceed this number during a bulk operation.

DEFAULT_LOCALE
The default locale for the Media Management Web Client.

SUPPORTED_LOCALES
The locale supported by the Media Management Web Client. Additional locales
can be added, separated by colons.

OpenText Media Management – Administration Guide 241


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

13.1.8 COMMON\JDBC
Java database connectivity (JDBC) preferences.

For supported versions of Oracle, see OpenText Media Management Technical


Specifications (https://knowledge.opentext.com/knowledge/llisapi.dll/Properties/
69371555), the following preference is necessary under COMMON\JDBC:

"JDBC_URL="jdbc:oracle:thin:@<hostname>:<port>:<oracle_sid>"
The JDBC protocol for an OTMM supported Oracle database instance.

Note: This setting is located in the TResource file.

JDBC_URL="jdbc:postgresql://<host>:<port>/<database_name>"
The JDBC protocol for an OTMM supported PostgreSQL database instance.

Note: This setting is located in the TResource file.

"JDBC_URL="jdbc:sqlserver://<host>:<port>"
The JDBC protocol for an OTMM supported SQL Server database instance.

Note: This setting is located in the TResource file.

JDBC_URL="jdbc: sap://<host>:<port>"
The JDBC protocol for an OTMM supported SAP HANA database instance.

Note: This setting is located in the TResource file.

13.1.9 COMMON\SERVER
ADMIN_EMAIL_ADDRESS
Email address of OTMM administrator.
The default is artesia@opentext.com.

BC_DATE_FMT
Date format for B.C. era dates.

DB_DISPLAY_DATE_FMT
This is the Oracle syntax format to use when displaying dates. The date must
contain a four-digit year and must be equivalent to the JDK date-format
"JDK_DISPLAY_DATE_FMT"="MM/dd/yyyy". Some discrepancies exist between
Oracle and JDK formats. For instance, Oracle prefers to have the DD and YYYY
capitalized for its formatting purposes, whereas the JDK prefers these in
lowercase. These settings must be synchronized for OTMM to convert date
objects into String objects and vice versa.
The default is MM/DD/YYYY.

242 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

DB_TYPE
The type of database.
• Use ORACLE if you are running the Oracle database.
• Use ora7d.dll if you are running Oracle on the Windows platform.
• Use SQLSERVER if you are running the SQL Server database.
• Use HANA if you are running the SAP HANA database.

Note: This setting is located in the TResource file.

EMAIL_SERVER
Address of email server. Email will use this configuration at the time of export.
The default is mail.wl.opentext.com.
EMAIL_SERVER_AUTHENTICATION_ENABLED
Set this to TRUE to enable SMTP server authentication.
The default setting is FALSE.
EMAIL_SERVER_PORT
Specify the port to connect to the SMTP Server.
EMAIL_SMTP_FROM_HOST
Specify a fully-qualified host domain name of the server connecting to your
SMTP server. If this entry is missing or empty, the default is the local host name.
FILE_COPY_CHUNK_SIZE
Specify the chunk size (number of bytes) for transferring data on the server. The
default is 1 MB. You should take into account the resources available on the
server, for setting a huge value may use up the resources on the client system
and a “not enough system resource” exception may be thrown.
INBOX_RECORD_COUNT
Specify the number of notifications displayed in the Inbox.
The default is 30.
JDK_DISPLAY_DATE_FMT
This is the JDK date-formatting equivalent to "DB_DISPLAY_DATE_FMT". Some
discrepancies exist between Oracle and JDK formats. For instance, Oracle must
have the DD and YYYY capitalized for its formatting purposes, whereas the JDK
must have these in lowercase. These settings must be synchronized for OTMM
to convert date objects into String objects or String objects to date objects.
The default is MM/dd/yyyy.
KEEP_ALIVE_UPDATE_ENABLED
Set this to false if you do not want the system to validate and update the last
ping time.

Note: OpenText recommends that you set KEEP_ALIVE_UPDATE_ENABLED


to false.

OpenText Media Management – Administration Guide 243


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

KEEP_ALIVE_UPDATE_INTERVAL
This setting specifies the session keep alive time. The value is in minutes.

MAX_BUFFER_SIZE
Set the maximum buffer size to capture stdout and stderr messages when a
command line tool, such as exiftool.exe, is executed in a separate process.
This value should be specified in KB. If this entry is not set, the default value of
100 KB will be used.
The default is 100.

ORACLE_XML_TYPE_DISABLE_CACHING
By default, Oracle caches XMLType objects. Due to a memory leak, the cache
continues to grow. You can disable caching using this setting. If you disable
caching, objects will be constructed every time.

PROCESS_LIST_RECORD_COUNT
Specify the number of jobs to be displayed in the Job Center.
The default is 20.

PROCESS_POLLING_INTERVAL_IN_SECS
Specify the frequency (in seconds) for updating process instance details in the
Job Center.
The default is 30 seconds.

RETRY_COUNT
Specify the number of times the content manager tries to access OTMM when
there is a network error.
The default value is 0.

RETRY_INTERVAL
Specify the interval of time, in seconds, between each RETRY_COUNT attempt.
The default value is 30.

TEXT_CONTENT_RETRIEVAL_MAX
Specify the number of seconds before on the size of text content that can be
retrieved through the AssetServices API (in megabytes).
The default is 10.

VALIDATE_POOLED_DB_CONN
Set this to TRUE to validate the Media Management session on each API method
call. Setting it to FALSE will disable the session validity check.
The default is N.

VALIDATE_SESSION_EXISTS
Set this to true to validate the OTMM session on each API method call. Setting
it to false disables the session validity check.
The default is TRUE.

244 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

13.1.10 COMMON\SOLR
MAX_CONNECTIONS
Specify the maximum number of active connections to Solr.
When SOLR_HIGH_AVAILABILITY is ON, MAX_CONNECTIONS limits the total
number of connections to a single Solr server. For example, this setting limits
connections to 200 concurrent requests to a single Solr server.
The default is 200.

Notes
• This setting is optional.
• You can adjust this value to control Solr search throughput performance.

MAX_PER_URL
When SOLR_HIGH_AVAILABILITY is ON, the MAX_PER_URL value controls the
maximum number of connections per route, where a route is a per-host subset of
the overall Solr server connections. For example, this setting limits the
maximum concurrent connections to 40 per route.
The default is 40.

Notes
• This setting is optional.
• You must set this value be less than or equal to the MAX_CONNECTIONS.
• You can adjust this value to control Solr search throughput performance.

SOLR_HIGH_AVAILABILITY
Indicates if Solr servers are configured in a master/slave configuration (“ON”) or
not (“OFF”). This value is set automatically by the Ant tasks configure-solr-
master and configure-solr-slave.

Note: When more than one Solr server is configured for OTMM, all Solr
servers are available to handle search requests. In addition, if the master
Solr server becomes unavailable due to hardware or network issues, a
slave can be re-configured to be the master and take over the indexing
tasks.

The default is OFF.


SOLR_HOST
The host ID for this Solr instance.

Note: This setting is located in the TResource file.

SOLR_URL
This is the URL to the Apache Solr server. This URL is used by the Search plug-
in and Indexer to locate the Solr server.

OpenText Media Management – Administration Guide 245


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

Note: This setting is located in the TResource file.

URL_LOOKUP
Stored procedure used to look up the Solr server location in a master/slave
configuration. This lookup is not used when SOLR_HIGH_AVAILABILITY is OFF.
The default is SOLR_MONITOR$getSolrServer.

13.1.11 CONTENT\CONFIG
BULKEDIT_WORKING_AREA
Specify the staging area for files for bulk editing assets.
The default is ${TEAMS_HOME}/data/cs/working_area/bulkedit.
DEFAULT_DOWNLOAD_COMPRESS_LEVEL
Specify the compression level for downloading exported files. Set this to either
-1 (default compression) or values between 1 (Best Speed) and 9 (Best
Compression). This value will only be used under certain circumstances.
The default is 1.
DEFAULT_EXPORT_AREA
Specify the directory where exported content is stored.
EXPORT_WORKING_AREA
Specify the staging directory where temporary data for export processing is
stored.
The default is <TEAMS_HOME>/data/cs/working_area/export.
IMPORT_WORKING_AREA
Specify the staging directory where temporary data for import processing is
stored.
The default is <TEAMS_HOME>/data/cs/working_area/import.
NAMED_AREA_NAMES
Define areas used for file transfer and referencing. Each named area must have a
corresponding mapping directory. This is a comma-delimited list of logical
names that map to physical locations. The default is IMPORT_WORKING_AREA,
TEAMS_HOME_AREA,DEFAULT_EXPORT_AREA,VIDEO_FILE_STAGING_AREA,
BULKEDIT_WORKING_AREA,EXPORT_WORKING_AREA.

Notes
• When choosing these disk locations, you should consider the disk
requirements for other components. For example, the
DEFAULT_EXPORT_AREA and the EXPORT_WORKING_AREA should be
distinct locations. Make sure these temporary work locations do not
conflict with Solr indexing.
• The changes to this setting will be applied only after you clear the
caches. In the Web Administration tool, on the top-level menu, click
Utilities> Clear caches, and then click Clear caches.

246 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

RESTRICTED_FILE_EXTENSIONS
Restrict file types from being uploaded to OTMM by specifying file extensions
in a comma separated list. Files containing these extensions will be restricted
from being uploaded to OTMM. For example, to restrict shell scripts and
executable files, enter the following:
exe,sh
By default, this setting is empty.
TEAMS_HOME_AREA
Specify the OTMM root directory.
The default is <TEAMS_HOME>.
VIDEO_FILE_STAGING_AREA
Specify the staging area where OTMM writes the files for the Transcode server.
The Transcode server processes files from this location. For UNIX environments,
specify this location as UNIX path only. For Windows, the user who is running
OTMM must have read and write access to this folder. The OTMM installer adds
the following value:
\\<transcode server host>\<staging area directory>

13.1.12 CONTENT_TRANSFER\CONFIG
BASE_URL
URL to the internal OTMM content transfer web application. Only specify this
value if the content transfer web application is not co-located with the other
OTMM web applications (not typical).

13.1.13 CREATIVEREVIEW\VIKI
Note: For more detailed information about Creative Review settings, see
OpenText Media Management Creative Review - Installation Guide and Release Notes
(MEDMGTPO160300-ACR).

APPROVE_TASK_ROLE_MAPPING
Configures the OTMM Job Participant role to the Vproof user role mapping for
the Approve Assets task. The value for the setting consists of one or more
comma separated mapping rules. Each mapping rule uses the following format:
<Job Participant role id>:<Vproof role id>

Notes
• You may enter an asterisk (*) for the Job Participant Role ID (matches all
role IDs), but not for the Vproof role ID.
• If you define multiple mapping rules, the first mapping rule that
matches any of the Job Participant roles that is assigned to the user will
be applied.
• OpenText recommends that the last mapping rule that you enter for the
setting use an asterisk (*) for the Job Participant Role ID.

OpenText Media Management – Administration Guide 247


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

APPROVAL_STATES_REQUIRE_COMMENT
Approval state IDs that require comment before submitting.
CREATIVEREVIEW_ENABLED
Set to Y to enable the Creative Review option, or N to disable it. The default is N
(disabled).
The default is Y.
FILE_EXTENSIONS_SUPPORTED_BY_VPROOF
List of file extensions that Vproof supported.
For more information, see OpenText Media Management Creative Review -
Installation Guide and Release Notes (MEDMGTPO160300-ACR).
INTERNAL_VIKI_SERVER_WSDLs
This entry only needs to be configured if the VIKI server has a virtual IP
configured for internal networks behind the firewall. By default, it will be the
same value as VIKI_SERVER_WSDL. For example:
http://<VIKI_SERVER_Internal_IP/Host Name>/Vbase/Services/
VproofApi/VproofApi.svc?wsdl "INTERNAL_VIKI_SERVER_WSDL"=""

METADATA_FIELDS_FOR_DESCRIPTION
Allows metadata fields to be passed as a description for each asset that is added
to a Creative Review. The comma separated list, which includes a metadata
model ID and metadata field ID, specifies the metadata field value that is passed
to the Creative Review page.
For example, if you want the field METADATA.FIELD_ID1 to be required for
MODEL.ID1 , and you want the field METADATA.FIELD_ID2 to for MODEL.ID1, add
the following:

MODEL.ID1:METADATA.FIELD_ID1, MODEL.ID2:METADATA.FIELD_ID2

Notes
• If the METADATA_FIELDS_FOR_DESCRIPTION setting is empty or not set,
ARTESIA.CATEGORY.ASSET DESCRIPTION is used as the default metadata
field that is passed to the Creative Review.
• If the metadata field is multilingual, the multilingual field value is used
based on user's locale setting. For more information, see “Multilingual
metadata“ on page 229.

NUMBER_OF_PREVIOUS_VERSION_FOR_REVIEW
Set the number of a previous version of an asset sent to Creative Review. If the
value is 0 (zero), then all asset versions since the start of the review are made
available on the Creative Review screen.
The default is 0.
PRODUCT_NAME
Specify the Creative Review package name.
The default is package.

248 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

REVIEW_TASK_ROLE_MAPPING
Configures the OTMM Job Participant role to the Vproof user role mapping for
the Review Assets task. The value for the setting consists of one or more comma
separated mapping rules. Each mapping rule uses the following format:
<Job Participant role id>:<Vproof role id>

Notes
• You may enter an asterisk (*) for the Job Participant Role ID (matches all
role IDs), but not for the Vproof role ID.
• If you define multiple mapping rules, the first mapping rule that
matches any of the Job Participant roles that is assigned to the user will
be applied.
• OpenText recommends that the last mapping rule that you enter for the
setting use an asterisk (*) for the Job Participant Role ID.

USE_PREVIEW_PROXY_FOR_CONTENT_TYPE
Content types that require a proxy file to be sent to the VIKI server.
If you do not specify a content type, the original file is sent to the VIKI server.
Content types can be overwritten by MIME types. For more information, see
USE_PREVIEW_PROXY_FOR_MIME_TYPE and
USE_RENDITION_PDF_FOR_MIME_TYPE.
The default is VIDEO,AUDIO.

USE_PREVIEW_PROXY_FOR_MIME_TYPE
Content types can be overwritten by MIME types.
This setting lists the MIME types for which Creative Review will send the
preview proxy file to the VIKI server.
The default is application/photoshop,image/eps,image/dng,image/x-
targa,application/postscript.

USE_RENDITION_PDF_FOR_CONTENT_TYPE
Content types that require a PDF proxy rendition to be sent to VIKI server. If
you do not specify the content type, the original file is sent to VIKI server.
Content types can be overwritten by MIME types. For more information, see
USE_PREVIEW_PROXY_FOR_MIME_TYPE and
USE_RENDITION_PDF_FOR_MIME_TYPE. The default is LAYOUT,MSOFFICE.

USE_RENDITION_PDF_FOR_MIME_TYPE
Content types for PDF renditions can be overwritten by MIME types This lists
the MIME types for which Creative Review will send a PDF rendition to the
VIKI server. The default is image/eps,application/postscript.

VIEW_ONLY_ROLE_ID
ID of reviewers.
The default is 10.

OpenText Media Management – Administration Guide 249


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

VIKI_CALLBACK_URL
The VIKI call back URL. It should look something like http://otmm:11090/
artesia-ux-ws/services/CreativeReviewCallbackService.

VIKI_SERVER_WSDL
The Viki server WSDL. Modify this setting to point to the Vproof server.
The format is http://<viki_server>/Vbase/Services/VproofApi/
VproofApi.svc?wsdl.

The following two entries are used to assign Viki roles:

VIKI_APPROVAL_ROLES
Role IDs for approvers.
The default is 30,40.

The following is a list of content/MIME types that require a proxy file to be sent to
the VIKI server. If the content/MIME type is not specified here, the original file will
be sent to the VIKI server. For more information about modifying the renditions of a
file sent to Vproof, see OpenText Media Management Creative Review - Installation
Guide and Release Notes (MEDMGTPO160300-ACR).
• USE_PREVIEW_PROXY_FOR_CONTENT_TYPE
• USE_PREVIEW_PROXY_FOR_MIME_TYPE
• USE_RENDITION_PDF_FOR_CONTENT_TYPE
• USE_RENDITION_PDF_FOR_MIME_TYPE

13.1.14 CREATIVEREVIEW
\VIKI_CONTENTMANAGER_DATASTORE_MAP
The following are the Content Manager ID mappings for VIKI Data Store values.

The default value is:

RemoteStoreOTMM

For more information about this OTMM server configuration, see OpenText Media
Management Creative Review - Installation Guide and Release Notes
(MEDMGTPO160300-ACR).
• ARTESIA_CONTENT_FILESYSTEM

250 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

13.1.15 EVENT_LOGGING\SERVER
NOTIFICATION_DIR
This is the notification data file directory, relative to <TEAMS_HOME>. The default
value should be sufficient for most applications.
The default is /data/notification.

SUBSCRIPTION_EMAIL_OPTION
Used to switch asset subscription email recipients between TO and BCC modes.
This entry is optional. If it is not set, the default value is TO.

13.1.16 EXPORT\SERVER
ASYNC_CONTENT_CHECK_INTERVAL
The number of seconds to wait before checking if asynchronously exported
content is complete.
The default is 600.

DEFAULT_DOWNLOAD_DELIVERY_TEMPLATE
Specify the download delivery template to be applied to export jobs. The default
template is ARTESIA.TRANSFORMER.PROFILE.DOWNLOAD.DEFAULT.

EMAIL_URL_EXPIRY_DURATION
The number of days after which the export URL will expire.
The default is 30.

Note: Some database action is necessary to cleanup the expired export


URLs and the associated asset entries.

EMAIL_URL_GENERATOR_IMPL
Specify the class name of the URL generator. For example, it could be com.
artesia.export.URLGeneratorImpl. It must implement the
AssetURLGenerator Interface.

FILE_HANDLING_TEMPLATE_DIR
Specify the custom file handling template directory to be used for export jobs.
The default is /data/exporttemplates.

Note: The changes to this setting will be applied only after you clear the
caches. In the Web Administration tool, on the top-level menu, click
Utilities > Clear caches, and then click Clear caches.

NO_COMPRESSION_SINGLE_FILE_EXPORT
Set the value to TRUE to skip the compression in the File Download Delivery
transformer when a single file is downloaded.
The default setting is TRUE.

OpenText Media Management – Administration Guide 251


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

13.1.17 HELP\CONFIG
For more information, see Section 19 “Appendix C – Deploying the OpenText
Private Help Server” in OpenText Media Management - Installation Guide
(MEDMGT160300-IGD).

13.1.18 IMAGE\CONFIG
DEFAULT_EXPORT_IMAGE_FORMAT
The output format of exported images if no format is specified.
The default is jpg.

DEFAULT_IMAGE_THUMBNAIL_FORMAT
The output format for thumbnail/preview images. Update the value with the
preferred format of the thumbnail and preview.
The default is JPG.

DNG_IMAGEMAGICK_PREVIEW_SETTINGS
The density of the generated preview file for the master asset of type DNG is set
as 72 dots per inch to enable the image rendering device to calculate the pixel
density properly.
The default is intent relative -sample 1024x768> -quality 95
-colorspace sRGB -strip -auto-orient -density 72.

DNG_IMAGEMAGICK_THUMBNAIL_SETTINGS
The density of the generated thumbnail file for the master asset of type DNG is
set as 72 dots per inch to enable the image rendering device to calculate the pixel
density properly.
The default is -intent relative -sample 500x375> -quality 95
-colorspace sRGB -strip -auto-orient -density 72.

IMAGEMAGICK_NOARG_COMMANDS
A comma-separated list of ImageMagick® command options that do not require
any input arguments. Administrators can add any additional commands in a
comma separated list. The following commands are already covered commands:
"-adjoin, -antialias, -append, -auto-gamma, -auto-level, -auto-orient, -black-
point-compensation, -clamp, -clip, -clip-mask, -clut, -coalesce, -combine, -
composite, -contrast, -deconstruct, -descend, -despeckle, -enhance, -equalize, -fft,
-flatten, -flip, -flop, -frame, -hald-clut, -help, -iconic, -identify, -ift, -immutable, -
linewidth, -maximum, -minimum, -monitor, -monochrome, -morphology, -
mosaic, -name, -negate, -normalize, -ping, -quiet, -regard-warnings, -remote, -
render, -respect-parentheses, -reverse, -screen, -seed, -separate, -shared-memory,
-silent, -strip, -subimage-search, -synchronize, -taint, -tile, -transform, -
transpose, -transverse, -trim, -unique-colors, -verbose, -version, -window-group,
-matteâ€

IMAGEMAGICK_PREVIEW_SETTINGS
The Preview settings for ImageMagick.

252 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

The default is -intent relative -sample 1024x768> -quality 95


-colorspace sRGB -strip -auto-orient.

IMAGEMAGICK_THUMBNAIL_SETTINGS
The Thumbnail settings for ImageMagick.
The default is -intent relative -sample 1024x768> -quality 95
-colorspace sRGB -strip -auto-orient.

MSOFFICE_DOCS_SPICER_PDF_PREVIEW_SETTINGS
The OpenText Spicer settings for generating PDF previews for MS Office
documents.
The default is -f50000,4.

MSOFFICE_DOCS_SPICER_THUMBNAIL_SETTINGS
The Spicer thumbnail settings for MS Office documents.
The default is -f10100 -ct -p1 -d1024.

Note: The -f<formatID>[,<subformatID>] and -p<page number>


parameters are required.

PDF_SPICER_PREVIEW_SETTINGS
The PDF preview settings for Spicer.

PDF_SPICER_THUMBNAIL_SETTINGS
The PDF Thumbnail settings for Spicer.
The default is -f10100 -d500 -ct.

Note: The -f<formatID>[,<subformatID>] (such as, -f10100) parameter


is required.

PSD_IMAGEMAGICK_PREVIEW_SETTINGS
The PSD Preview settings for ImageMagick.
The default is input-file#[0] -intent relative -sample
1024x768> -quality 95 -colorspace sRGB -strip.

13.1.19 IMPORT\SERVER
ASSET_INTERCEPTOR_CLASS
Specify the fully qualified class name that implements the
AssetImportInterceptor interface. You can examine and possibly modify the
asset objects being imported before they are saved using
AssetImportInterceptor. The AssetImportInterceptorImpl is the default
implementation that allows you to save the content in different content
managers based on asset mime type. By default, this entry is disabled. If you
want to use the default AssetImportInterceptor, enable this and configure the
MASTERCONTENT_CONTENTSTORE_MAPPING property.
The default is com.artesia.server.asset.imprt.
AssetImportInterceptorImpl.

OpenText Media Management – Administration Guide 253


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

DEFAULT_CONTENT_MANAGER_ID
Specify the content manager ID used to store content.
The default is ARTESIA.CONTENT.FILESYSTEM.
DEFAULT_CONTENT_TYPE
Indicates what type to assign to content if OTMM cannot detect the content type.
This is an optional parameter. If not specified, the content type defaults to
OTHER.
DEFAULT_MODEL_ID
The default model ID used for imports. Furnish the exact Model ID (not the
Legacy ID) for this entry.
The default is ARTESIA.MODEL.DEFAULT.
DEFAULT_WS_IMPORT_TIMEOUT
Time in milliseconds before the Webservice import times out.
The default is 21600000.
FILE_ATTR_MIME_TYPE_MAP
File attribute mapping for mime types String is in the format <file
attribute>:<mime type>, <file attribute>:<mime type>. The current implementation of
file attribute is only used for the Applet upload from the Mac and is in the form
Mac Creator/Mac File Type. For example, ART5/TEXT.
The default is ART5/TEXT:application_vnd.adobe-illustrator,*/
EPSF:image_eps,TVOD/MOOV:video_quicktime,*/JPEG:image_jpeg,*/
TIFF:image_tiff,8BIM/8BPS:application_vnd.adobe-photoshop,*/
PNG:image_png.

Note: The changes to this setting will be applied after you restart the
Media Management server.

FILE_COPY_CHUNK_SIZE
Specify the chunk size in the number of bytes for transferring data on the server.
The default is 1 MB. You should take into account the resources available on the
server, for setting a huge value may use up the resources on the client system
and a “not enough system resource” exception may be thrown.
KEYFRAME_CONTENT_MANAGER_ID
Specify the keyframe content manager ID that is used to store the keyframe
content.
The default is ARTESIA.CONTENT.FILESYSTEM.
MASTERCONTENT_CONTENTSTORE_MAPPING
Specify the comma separated mime types. These mime types determine which
content managers will be used for storing content. For each mime type
configured in this entry, you must add a mime type to the content manager
mapping located under the IMPORT\SERVER component, which belongs to the
Import configuration group.
For example, if you configured the following:

254 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

"MASTERCONTENT_CONTENTSTORE_MAPPING"="application/pdf,
application/vnd.adobe-indesign"
Then you must add the following mappings:
"APPLICATION_PDF"="ARTESIA.CONTENT.AMAZON.S3"
"APPLICATION_VND.ADOBE-INDESIGN"="ARTESIA.CONTENT.LEA"

Note: In the mime type to content manager mapping, replace the slash (/)
in the mime type with an underscore (_). Ensure that mime type are in
uppercase characters.

MAX_FILES_IN_DIR
When the number of files in the directory reaches the specified number, a new
directory is created.
The default is 1000.
MIME_TYPE_NO_MD5
This setting contains a comma-separated list of MIME types for which the MD5
generation will be skipped on import from the Web Client or the Bulk Import
utility. Use this setting to ignore MD5 calculations on large files (primarily
video) which noticeably slow down the import process. We recommend setting
this value for all video types as shown in the previous example.
The default is video/avi,video/dvd,video/mp4,video/mpeg,video/mpeg2,
video/mpg,video/quicktime.

PARTITION
Directory for storing imported files. If you have multiple nodes in an HA
environment, the value for this partition should be unique on each node in order
to avoid directory collision.
The default is vol0.
RENDITION_CONTENT_MANAGER_ID
Specify the rendition content manager ID that is used to store the rendition
content.
The default is ARTESIA.CONTENT.FILESYSTEM.

Note: The changes to this setting will be applied only after you clear the
caches. In the Web Administration tool, on the top-level menu, click
Utilities> Clear caches, and then click Clear caches.

USE_PROXY_FOR_CLIP
Allows clips to be played back in the Web Client even if the master video file is
of a mime type that cannot be played back. If the mimetype of the master video
is in the pipe (|) delimited list, clips created from the master will be set to the
mime type of the low resolution proxy for the master.
The default is video/mxf|video/gxf|video/x-dv|video/mp4.

Note: By default, 'video/mxf' and 'video/gxf' are not registered in OTMM.

OpenText Media Management – Administration Guide 255


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

USE_SHAGEN
Indicates whether to use Secure Hash Algorithm generation (Y=yes, N=no).
VIDEO_PROXY_CONTENT_MANAGER_ID
Specify the video and audio proxy content manager ID that is used to store the
video and audio proxy content.
The default is ARTESIA.CONTENT.LEA.

13.1.20 INDEXING\COMMON
ASSET_BLOCK_SIZE
Specify the size of the block of assets the Indexer collects. The default set (block)
size is 1000 assets.
CHECKIN_SQL
Used when the HIGH_AVAILABLILITY setting is ON. The Indexer uses this setting
to check in with the Indexer Monitor.
The default is INDEXER_MONITOR.checkinIndexer.
CHECKIN_TIMEOUT_SQL
Used when the HIGH_AVAILABLILITY setting is ON. This setting allows the
Indexer to check the Indexer Monitor idle timeout setting.
The default is SELECT INDEXER_MONITOR.get_timeout FROM DUAL.
DEFAULT_POLL_INTERVAL
Specify how often the Indexer will check with the RDBMS for asset updates. The
default is 30 seconds.
DISABLE_INDEXING
Used in secondary OTMM nodes to disable the Indexer.

Note: This setting is located in the TResource file.

ENABLE_INDEX_RESTORE_LOG
Set this to Y and the Indexer will generate a restore log that you can use to
resynchronize Solr after you restore the backup files of the Solr indexes. You
must stop and restart the Indexer service after enabling this setting. You can
only use backed up files that you take after you change the value of this setting
to Y and restart the Indexer service. The default is N.

Note: Performing a complete reindex of Solr invalidates any backup files


that you created prior to reindexing.

HIGH_AVAILABILITY
Indicates whether this installation is configured for High Availability. This value
is set automatically by the Ant task install-indexer-monitor-package.
The default is OFF.

Note: In an HA environment, there is one OTMM Indexer installed on


each OTMM machine. It is important to configure multiple indexers so

256 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

they can act in coordination. When OTMM is installed in a high availability


configuration, this setting should be set to ON.

JDBC_CONNECT_ATTEMPTS
Specify how many times the Indexer should retry the JDBC connection when
there are interruptions to the RDBMS connection. The default 0 is to continue
until the connection succeeds. Changing this value to a non-zero value will
cause the Indexer to stop if the connection cannot be re-established after
JDBC_CONNECT_ATTEMPTS.

MAX_DOWNTIME
Maximum tolerated down time for indexing updates in minutes.
The default is 5.

MODEL_FILTER
Specify the asset models to include when indexing.
The default is MODEL_ID <> 13.

NUM_THREADS
The Indexer uses multiple threads to process asset updates. Specify the number
of threads to process. The default number of threads is 2. The best settings for
the NUM_THREADS value are 1 to 4. Beyond 4 threads there are no appreciable
performance benefits.
The default is 2.

PRI_DONE_PROCEDURE
Specify the RDBMS stored procedures used to index asset updates resulting
from using the Metadata Editor (Partial Re-Indexing).
The default is PKG_OT_INDEXER$free_reindex_fields.

PRI_INIT_PROCEDURE
Specify the RDBMS stored procedures used to index asset updates resulting
from using the Metadata Editor (Partial Re-Indexing ).
The default is PKG_OT_INDEXER.init_reindex_fields.

REINDEX_PROCEDURE
The REINDEX_PROCEDURE is the RDBMS stored procedure that initializes the
INDEX_WORKQUEUE table for a complete search index rebuild.
The default is PKG_OT_INDEXER.init_full_refresh.

OpenText Media Management – Administration Guide 257


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

13.1.21 INDEXING\SOLR
DEFAULT_COMMIT_TIME
This setting instructs the Solr server to commit a batch of updated assets for
indexing within the time (in seconds) that you specify. Each batch of updated
assets will be submitted to Solr with this time attached. The
DEFAULT_COMMIT_TIME time instructs the Solr server to commit the updates
within the time that you specify.

13.1.22 JNDI\CONFIG
These entries tell an EJB lookup where to find the EJB server. You should not have to
change these settings. However, if you are running a new API program, you may
have to change the PROVIDER HOST value.

Note: The following are located in the TResource file.

"FACTORY_URL_PACKAGES"="org.jboss.naming"
Specify the property for the list of package prefixes to use when loading URL
context factories.

Note: This setting is located in the TResource file.

"INITIAL_CONTEXT_FACTORY"
Specify the property for the initial context factory to use. Use one of the
following:
JBoss
"INITIAL_CONTEXT_FACTORY"="org.jboss.naming.remote.client.
InitialContextFactory"

TomEE
"INITIAL_CONTEXT_FACTORY"="org.apache.openejb.
client.RemoteInitialContextFactory"

Note: This setting is located in the TResource file.

"PROVIDER_HOST
Provides the location (host name and port number) of the EJB application server.
Use one of the following:
JBoss
"PROVIDER_HOST="localhost:11099"

TomEE
"PROVIDER_HOST="ejbd://localhost:11099"

Notes
• This setting is located in the TResource file.

258 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

• If you specify the host name, ensure that it resolves to the IP address that
you specified. For example, in the JBoss parameter,
OTMM_JBOSS_BIND_ADDRESS:
"PROVIDER_HOST"="remote://10.96.83.163:11099"

"USE_INTERNAL_CONTEXT_FACTORY_BUILDER="N"
Specify whether to set your own InitialContextFactoryBuilder.

Note: This setting is located in the TResource file.

USE_REMOTE_INTERFACES
By setting this to Y, the communication that uses SDK will use EJB remote
interfaces.

Note: This setting is located in the TResource file.

13.1.23 JOB\CONFIG
ASSET_IDS_TO_LOAD_INTO_JOB
Specify the number of asset IDs to load into the job while retrieving the jobs. The
default value is 5.
ASSET_IDS_TO_LOAD_INTO_TASK
Specify the number of asset IDs to load into the task while retrieving the tasks.
The default value is 5.
CLEANUP_TIMER_INTERVAL
Number of seconds to wait before checking to see if the content of managed
directories can be cleaned up.
DEFAULT_ATTACHCONTENT
The name of the attach content job. The default name is AttachContent.
DEFAULT_BULK_EDIT
The name of the bulk edit job. The default name is BulkEdit
DEFAULT_CHECKIN
The name of the check-in job. The default name is CheckInAsset.
DEFAULT_EXPIRY_TIME_CLEANUP
Specify the default expiration cleanup time, in minutes, when creating managed
directories. If you do not set DEFAULT_EXPIRY_TIME_CLEANUP, the default
expiration time, 120 minutes, is used.

Note: This setting is optional.

DEFAULT_EXPORT
The name of the export job. The default name is Export.
DEFAULT_IMPORT
The name of the import job. The default name is Import.

OpenText Media Management – Administration Guide 259


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

DEFAULT_VIDEO_AUDIO
The name of the retranscode job. The default name is Retranscode.

DUE_DATE_INDICATOR_DAYS
This entry to get all the due tasks expiring within n number of days. The default
value is 3.

FIELD_MAPPING_DIR
This directory contains the data file for integrators to set up triggers that initiate
business processes based on changes in metadata.

FIELD_MAPPING_DIR_FILE
The data file name used by the trigger that initiates business processes based on
changes in metadata.

JOB_LIST_RECORD_COUNT
Specify the number of jobs to be displayed in the Job Center. The default value is
20.

JOB_STATUS_CHECK_INTERVAL
The number of milliseconds to wait before checking if the job is stopped.

JOBS_ALLOWED_TO_USERS
Specify comma-separated job-type names which allow users to initiate a job. The
following is the default:
Import,Export,CheckInAsset,AttachContent,BulkEdit,MoveContent,
Retranscode,Expiration,Trigger

JOBS_CLEANUP_DAYS
Gets all the jobs which are older than n number of days for cleaning. The default
value is 30.

JOBS_CLEANUP_SCHEDULE_RECURRENCES
Specify the Quartz corn expression to schedule the job cleanup scheduler. The
default value is 0 0 0 ? * *. This means that the scheduler is triggered at 12 AM
daily. Any changes that you make to this setting will be applied only after you
restart the OTMM server.

JOB_SERVICE_CONCRETE_CLASS
The concrete class of the job plugin service. Any changes that you make to this
setting will be applied only after you restart the OTMM server.

JOB_USER
The user who will be used for job-related activities, such as updating the
Transcode job status in OTMM. The default user is tsuper.

MAX_RECORDS_PER_CLEANUP_RUN
Specify the maximum number of managed directories to be cleanup in each
cleanup run. The default value is -1, which means that all eligible managed
directories will be cleaned up.

260 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

PAST_DAYS_OFFSET
Get all the jobs that are older than n number of days and it is honoured only for
PAST_DAYS and BEFORE_PAST_DAYS data range filters. The default value is 10.

TASK_LIST_RECORD_COUNT
Specify the number of tasks to be displayed in the Job Center. The default value
is 20.

13.1.24 LIGHTBOX\SERVER
LIGHTBOX_ASSET_LIMIT
Specify the asset limit for the Lightbox. The default is 10000.

13.1.25 MEDIAANALYSIS\GENERAL
Note: After modifying any of settings under MEDIAANALYSIS\GENERAL,
you must clear the caches.

ENABLE_MEDIAANALYSIS_DURING_INGEST
Set to true to activate the Rich Media Analysis Service during the ingest of
image assets, such as importing, checking in and attaching content. Setting this
to false deactivates the media analysis process during intake.
By default, this value is set to true.

MAX_ACTIVE_JOBS
Specify the maximum number of active jobs that are running in parallel to
process through the OpenText Media Management Rich Media Analysis Service.
By default, this value is set to 2.

MEDIAANALYSIS_ACCESS_URL
Specify the base URL for access to the Media Management Rich Media Analysis
Service. Use the following format:
protocol://MediaHost:port/rest/analytics/jobs

MEDIAANALYSIS_ENABLED
Set to true to activate the Rich Media Analysis Service to analyze image new
assets during ingest and for existing assets that are associated with a scheduled
job. Setting this to false deactivates Rich Media Analysis Service.
By default, this value is set to false.

OTMM_CALLBACK_URL
Specify the callback URL to be passed to the Media Management Rich Media
Analysis Service. Use the following format:
protocol://OTMMHost:port/teams/MediaAnalysisCallback.do

OpenText Media Management – Administration Guide 261


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

13.1.26 METADATA\CONFIG
ALLOWED_FILE_TYPES
Specify the list of file extensions delimited with a comma (,) to write metadata.
The default is JPEG,JPG,TIFF,GIF,EPS,PDF,PSD,IND,DNG.

CUSTOM_XMP_NAMESPACE
The namespace to use for writing custom XMP tags. If the value of this property
is empty, custom XMP tags will be associated with the namespace http://
opentext.com/otmm/1.0. Standard XMP tags will be associated with the
namespace http://ns.adobe.com/xap/1.0/.
By default, this setting is not active.

EXIFTOOL_CUSTOM_TAG_CONFIG_BUILDER_CLASSES
Specify the list of custom tag configuration for builder classes delimited with
comma (,).
The default is com.artesia.server.embedded.metadata.
EXIFCustomTagConfigBuilder,com.artesia.server.embedded.metadata.
IPTCCustomTagConfigBuilder,com.artesia.server.embedded.metadata.
XMPCustomTagConfigBuilder.

Note: The changes to this setting will be applied only after you clear the
caches. In the Web Administration tool, on the top-level menu, click
Utilities> Clear caches, and then click Clear caches.

WRITE_METADATA_ENABLED
Set this parameter to TRUE to enable write metadata.
The default is FALSE.

13.1.27 METADATA\LEGACY-CONFIG
CONTENT_SIZE_UNIT
The unit of size for content in the UOIS/OBJECT_STACKS table.
The default is BYTES.

RELOAD_METADATA_ON_SAVE
Whether to reload all metadata immediately after metadata has been saved. This
may be necessary if metadata values may be influenced by triggers.
The default is Y.

VIDEO_LINK_TYPES
The video link type IDs that cannot be saved using saveLinkInfo.
The default is PV,CLIP2VID.

262 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

13.1.28 METADATA\VALIDATOR
METADATA_VALIDATOR_CLASS
A configurable class used to run validation on metadata.
The default is com.artesia.server.metadata.validation.
ArtesiaMetadataValidator.

REQUIRED_FIELD_VALIDATION_DISABLED
Determines whether to validate required fields while creating property
templates.
The default is TRUE.

13.1.29 OTAG\GENERAL
OTAG_ADMIN_URL
The base URL for OTAG Administration Interface. This entry is required if you
deployed an App in the Gateway that will be sent notifications from OTMM.
Use the following form:
protocol://hostname:tomcat_portnumber

Note: This entry will be set automatically when you run the config-for-
gateway-app script.

TASK_MOBILE_APP_NAME
The name of the Task App deployed in the OTAG Administration Interface. This
entry is required if you deployed the Task App in the Gateway.

Note: This entry will be set automatically when you run the config-for-
gateway-app script.

TRUSTED_SERVER_KEY
The Trusted Server Key configured in the OTAG Administration Interface for
use by Media Management. This entry is required if you deployed an App in the
Gateway that will be sent notifications from the OTMM.

Note: This entry will be set automatically when you run the config-for-
gateway-app script.

WEBACCESS_URL
The WEBACCESS_URL is the base URL for OpenText™ AppWorks™ Gateway
(OTAG) web access. It should be in the form <protocol>://
<hostname>:<tomcat_portnumber>
The default is http://CONFIGUREME:8080.

OpenText Media Management – Administration Guide 263


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

13.1.30 OTDS\GENERAL
The following entries are for connecting to OTDS.

INTERNAL_OTDS_BASE_URL
This entry only needs to be configured if the OTDS server has a virtual IP
configured for internal networks behind the firewall. By default, it will be the
value same as OTDS_BASE_URL. For example:
http://<OTDS_SERVER_Internal_IP/Host Name>:18080

OTDS_BASE_URL
The base URL of OTDS services. This should be specified as <protocol http or
https>://<server where OTDS is installed>:<Tomcat port on which OTDS
is running>.

The default is http://CONFIGUREME:18080.

MINIMUM_POOL_SIZE
This property controls the performance of the OTMM connection to OTDS. This
value represents the minimum number of OTDS client proxies to be pooled.
The default value is 5.

MAXIMUM_POOL_SIZE
This property controls the performance of the OTMM connection to OTDS. If
there is a performance degradation due to the number of concurrent connections
between OTMM and OTDS, you can increase the pool size to improve the
performance to the maximum number of OTDS client proxies to be pooled.
The default value is 20.

OTMM_RESOURCE_ID
The unique resource identifier of the OTMM resource created in OTDS.

OTMM_USER_PARTITION
The name of the Media Management user partition created in OTDS. This user
partition should contain the admin user of Media Management.

UMS_RESOURCE_ID
The unique resource identifier of the UMS resource, created in OTDS.

The following entries are for user creation APIs (not user update operations):

OTMM_USER_PARTITION_ROOT_DN
The LDAP entry where users will be created in the directory server. The
template "$OU_NAME$" will be replaced with the domain name of the user
passed to the API.
The default is ou=Root,ou=$OU_NAME$,ou=IdentityProviders,dc=identity,
dc=opentext,dc=net.

264 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

USER_CANNOT_CHANGE_PASSWORD
This entry is used to set a property for the user that user cannot change their
password. This entry is only valid if
USER_MUST_CHANGE_PASSWORD_ON_FIRST_LOGIN is set to false.
The default is false.
USER_MUST_CHANGE_PASSWORD_ON_FIRST_LOGIN
This entry is used to determine whether the user has to change the password on
the first sign-in for a new user and after every password reset. The two entries,
USER_PASSWORD_NEVER_EXPIRES and USER_CANNOT_CHANGE_PASSWORD, will
only be considered if this entry is set to false.
The default is false.
USER_PASSWORD_NEVER_EXPIRES
This entry is used to set a property for the user that the user password never
expires. This entry is only valid if
USER_MUST_CHANGE_PASSWORD_ON_FIRST_LOGIN is set to false.
The default is true.
USE_USER_ATTRIBUTES_FROM_OTDS
This entry is used to control the user attributes from OTDS. When this is set to Y,
user attributes such as Role, Security Administrator, Group Administrator and
User Preference Template cannot be edited from the Media Management Web
Administration tool. For more information, see Section 9.1.2.1 “Configuring
Media Management user attributes in OTDS” in OpenText Media Management -
Integration Guide (MEDMGT160300-AIN).

13.1.31 OTDS\SYNCHRONIZATION
Used for specifying the default user settings while synchronizing data from OTDS
using Push Connector.

DEFAULT_USER_CANDIDATESECURITYPOLICYADMINISTRATOR
The default value of the candidateSecurityAdministrator OTMM user
property.
The default is false.
DEFAULT_USER_CANDIDATEUSERGROUPADMINISTRATOR
The default value of the candidateUserGroupAdministrator OTMM user
property.
The default is false.
DEFAULT_USER_EMAILADDRESS
The default value of the emailAddress OTMM user property.
DEFAULT_USER_ENABLED
This flag will be respected if OVERRIDE_USER_DISABLED_ATTRIBUTE is set to
TRUE. This flag will be used only during a create user event.
The default is true.

OpenText Media Management – Administration Guide 265


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

DEFAULT_USER_PREFERENCETEMPLATE
Specify the default user preference template name.

DEFAULT_USER_ROLE
The default role to assign to users where oTExtraAttr0 is not defined (must
exist in OTMM).
The default is 0.

OVERRIDE_USER_DISABLED_ATTRIBUTE
If set to false, the user disabled status in Media Management will be
synchronized with the user status in OTDS. It will be respected for both create
and update user events.
The default is false.

13.1.32 REPORT\CONFIG
BIRT_REPORT_CACHE_EXPIRATION_TIME
The expiration time for the BIRT report cache. Reports are regenerated after the
cache expiration time is met. Set this value to 0 minutes to generate new reports
for each request.

Note: Changes to this setting will take effect only after you restart the
OTMM server.

The default value is 30 minutes.

BIRT_REPORT_DESIGN_FOLDER
The directory that stores the designed reports.
The default value is /data/reports/birt_report_definitions.

BIRT_REPORT_ENABLED
Enables BIRT reporting functionality. Set this to true to enable BIRT reports for
users who have the DASHBOARD_REPORTS.VIEW FET.

Note: Changes to this setting will take effect only after you restart the
OTMM server.

The default value is false.

BIRT_WORKING_FOLDER
The directory where the generated reports are stored before they are sent to the
browser.

Note: Changes to this setting will take effect only after you restart the
OTMM server.

The default value is /data/cs/working_area/reports.

266 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

13.1.33 RESTAPI\CONFIG
CORS_EXPOSED_HEADERS
An optional entry that can be used to set the Access-Control-Expose-Headers
header sent back from Cross Origin Resource Sharing (CORS) requests.
CORS_ORIGIN_LIST
Comma separated list of origins allowed to perform CORS requests. An empty
list disallows all CORS requests. A value of "*" allows all CORS requests.
CSRF_FILTER_ENABLED
Enables or disables the cross-site request forgery (CSRF) filter. If you set this
value Y, the filter will process all the requests to check CSRF, except those that
are specified in the ignore list. The default value is N.
MAX_LIMIT
Maximum value allowed for the limit parameter when retrieving a collection
resource that implements pagination. This is also the default used when no
limit query parameter is supplied.
The default is 5000.
OTDS_SSO_HEADER_NAME
The HTTP header used by the OTDSHeaderTokenResolver class, if this class has
been configured in the SSO_RESOLVER entry.
SSO_RESOLVER
Specify the comma-separated, fully-qualified class names that implements the
ISSOResolver interface. The configured resolvers are invoked sequentially until
a non-null value is obtained and this value is used to create an OTMM session.

Note: Enter the following class to allow remote users who are requesting
to access widgets that were embedded on external web sites to sign in
without authentication:
"SSO_RESOLVER"="com.opentext.mediamanager.restapi.common.
sso.WidgetUserNameResolver"
You need to use this parameter in combination with
ALLOW_REMOTE_USER_LOGIN on page 270 and
WIDGET_USER_NAME on page 267. For more information about how to
configure this, see Section 9.1.3.3 “Configuring OTMM to allow remote
requests from external servers to access embedded widgets” in OpenText
Media Management - Integration Guide (MEDMGT160300-AIN).

USER_HEADER_NAME
The HTTP header used by the SimpleUserNameResolver class, if this class has
been configured in the SSO_RESOLVER entry.
WIDGET_USER_NAME
The sign-in name for remote requests submitted by users who are want to access
widgets that were embedded on an external web site. You need to use this in
combination with ALLOW_REMOTE_USER_LOGIN on page 270 and

OpenText Media Management – Administration Guide 267


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

SSO_RESOLVER on page 267. For more information about how to configure


this, see Section 9.1.3.3 “Configuring OTMM to allow remote requests from
external servers to access embedded widgets” in OpenText Media Management -
Integration Guide (MEDMGT160300-AIN).

13.1.34 RULEENGINE\CONFIG
RULE_SERVICE_PROVIDER
Specify the RuleEngineImplementation class for validation.
The default is com.artesia.server.rulesengine.drools.
DroolsRuleEngineImpl.

Note: Changes to this setting will be applied only after you clear the
caches. In the Web Administration tool, on the top-level menu, click
Utilities > Clear caches, and then click Clear caches.

13.1.35 SCHEDULER\CONFIG
MAX_SCHEDULER_THREADS
Specify the maximum number of threads that the job scheduler can use to run
the scheduled jobs. By default, this value is set to 2.

Note: Changes to this setting will be applied only after you restart the
OTMM server.

SCHEDULE_EXECUTE_USER
Specifies the default user who will execute the scheduled jobs. This user will
perform saved searches and content move operations; you must specify the sign-
in name of a user who has these privileges.

13.1.36 SEARCH\SERVER
DEFAULT_DATABASE_SEARCH_PLUGIN_ID
Default search plug-in ID to perform expert search. The default value is
ARTESIA.PLUGIN.SEARCH.DATABASE.

DEFAULT_MAX_HITS
Default result set size for searches.
The default is 1000.

DEFAULT_MAX_SUGGESTIONS
Specify the default list size for Search Suggestion requests.
The default is 5.

DEFAULT_OPERATOR
Use this operator with keyword searches where multiple terms are entered
without an operator between them. Use AND to narrow, and OR to widen results.
This entry is applicable only for Advanced Search and Keyword Search, not

268 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

database or expert search. You can override it by setting the defaultOperator


property of the Search object passed to the APIs.
The default is AND.

DEFAULT_SEARCH_PLUGIN_ID
The search plug-in ID to use for search requests submitted to the SDK which do
not explicitly specify which plug-in to use. This can be mapped to custom search
plug-ins as well. The following value is also valid:
ARTESIA.PLUGIN.SEARCH.SOLR.V1 for Solr searches.

The default is ARTESIA.PLUGIN.SEARCH.DATABASE.

DEFAULT_SUGGESTION_INDEX_ID
Specify the default index ID for Search Suggestion requests. The index ID must
match an index configured for generating suggestions in the search engine used.
The default is suggest_keyword.

DEFAULT_SUGGESTION_PLUGIN_ID
The search plug-in ID to use for Search Suggestion requests which do not
explicitly specify which plug-in to use. This can be mapped to custom search
plug-ins as well.
The default is ARTESIA.PLUGIN.SEARCH.SOLR.V1.

DISABLE_SEARCH_SUGGESTIONS
Specify whether the Search Suggestion feature should be disabled. Set to TRUE to
disable Search Suggestions. The default is FALSE.

SEARCH_FILTERS_FILE
Specify the file which contains the search filters to be used in configuring user
preferences.
The default is <TEAMS_HOME>/data/search/filters.xml.

SEARCH_HISTORY_LOG_EXTERNAL_SEARCHES
For debugging purposes, there may be cases where you only want to capture
internal searches in the Search Term Log. If you want to disable logging of non-
internal searches in these cases, set this to N.
The default is Y.

SEARCH_HISTORY_LOG_INTERNAL_SEARCHES
Use debugging purposes. There may be cases where you only want to capture
internal searches in the search term log file. To disable logging of non-internal
searches, set this to N.
The default is N.

SEARCH_HISTORY_LOGGING_ENABLED
Enables the Search Term Logging feature. The default is N. For more
information, see “Enabling search term logging” on page 168.

OpenText Media Management – Administration Guide 269


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

13.1.37 SEARCH\SOLR
CONDITIONALLY_RESTRICTED_MODELS
A comma separated list of numeric models IDs used to filter out certain models
from Solr search results. It is conditional in that it is only used for searches that
do not already contain a restriction on a model.
The default is 11.

ENUM_FACET_FIELD_IDS
A comma separated list of metadata field IDs that will use the Solr enum facet
method when Facets are generated for the field. This is not applicable to range,
interval, or cascading facet types.
For more information, see “Configuring enum Facet method” on page 177.

13.1.38 SECURITY\SERVER
The entries in this section are used to configure Single Sign-On (SSO).

Note: For more information, see Section 9.1 “Advanced security configuration”
in OpenText Media Management - Integration Guide (MEDMGT160300-AIN).

ALLOW_CASE_SENSITIVE_LOGIN_NAMES
By default, sign-in names are case-sensitive. To make sign-in names case
insensitive (that is, “tsuper” is the same as “Tsuper”), set the above parameter
equal to N.
The default is Y.

Notes
• This setting is only applicable if the OTMM application is using an
Oracle database and is respected during sign-in time only. Anything to
do with data is still case-sensitive.
• This entry does not affect the case-sensitivity for passwords, which are
always case-sensitive.

ALLOW_PREAUTHORIZED_USER_LOGIN
Specify if an external user is able to sign in to OTMM as a preauthorized user.
Values are Y or N.
The default is N.

ALLOW_REMOTE_USER_LOGIN
Specify whether to allow the remote user identity to automatically log the user
into OTMM without the need for the user to specify credentials. To enable SSO,
set this value to Y. The default is N.

Note: OTMM users can embed widgets on external web pages. To allow
OTMM to accept requests to access widgets that were embedded on an
external web site without authentication, set this to Y.

270 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

You need to use this parameter in combination with


WIDGET_USER_NAME on page 267 and SSO_RESOLVER on page 267.
For more information about how to configure this, see Section 9.1.3.3
“Configuring OTMM to allow remote requests from external servers to
access embedded widgets” in OpenText Media Management - Integration
Guide (MEDMGT160300-AIN).

NO_SESSION_URL
This is used to allow an integrator to control the destination while the SSO
feature is in use. If you do not set a NO_SESSION_URL variable, then a user
logging out of the application will immediately be logged back in since the
REMOTE_USER header will allow the user to sign in to the application.

OTDS_LOGIN_PAGE_ENABLED
Specify whether you want the OTDS sign-in page enabled. The default is false.

PREAUTHORIZED_USER_TRANSLATOR_CLASS
This is the fully qualified name of the class which is loaded and called when
preauthorized user translation is enabled.
The default is com.artesia.security.session.DefaultUserTranslator.

REMOTE_USER_TOKEN_NAME
Specify a custom HTTP header that contains the name of the remote user. This
entry is only used if you enabled a remote user to sign in using the
ALLOW_REMOTE_USER_LOGIN setting.

REMOTE_USER_TRANSLATOR_CLASS
If the REMOTE_USER variable does not match the OTMM user name, then the
REMOTE_USER variable will need to be translated to make it match. The most
common transformation required is to discard a domain name and/or convert
the name to lowercase. If you need to make this transformation, set the
REMOTE_USER_TRANSLATOR_CLASS entry to com.artesia.security.session.
DefaultUserTranslator. If you need to make some other kind of
transformation, then you must create and compile your own custom translator
class and point to it in this entry.
The default is com.artesia.security.session.DefaultUserTranslator.

SHOW_HOME_PAGE_ON_LOGOUT
Specify whether users are redirected to the home page after logging out (or
being timed out) and logging back in. If set to false, users will be redirected to
the last page they were on when they logged out or their session timed out.
The default is false.

OpenText Media Management – Administration Guide 271


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

13.1.39 SERVER\EVENTS
ASSET_EVENT_IDS_FOR_AUDIT
Specify comma separated asset event IDs for Audit tab filter list. The default is:
10001,20002,30005,30016,30026,40014,60006,60007,70001,80008,
80013,80014,110011

Note: The changes to this setting will be applied only after you clear the
caches. In the Web Administration tool, on the top-level menu, click
Utilities > Clear caches, and then click Clear caches.

ASSET_EVENT_IDS_TO_TRACK_RECENT_ACCESS
Specify comma separated event IDs for the asset events followed by
RecentAccessTrackingListener.

The default is 30005,40014,60006,70001,80008.

Note: The changes to this setting will be applied only after you clear the
caches. In the Web Administration tool, on the top-level menu, click
Utilities > Clear caches, and then click Clear caches.

EVENT_LISTENERS
Comma separated list of OTMM Event Listener class names configured to
receive Events configured to be sent to “internal” event listeners.
The following is the default:
com.artesia.server.event.listener.LogEventListener,com.
artesia.server.event.listener.LogEventIntoFileListener,,com.
artesia.server.event.listener.AssetSubscriptionEventListener,com.
artesia.server.event.listener.PasswordResetEventListener,com.
artesia.server.event.listener.CreativeReviewEventListener

EXTERNAL_NOTIFICATION_SERVICES
Comma separated fully qualified class names that implement the
ExternalNotificationService interface.
The default value is com.artesia.server.analytics.agent.
AnalyticsDataAgentNotifier,com.artesia.server.asset.notification.
DeliveryServiceNotification.

Note: The changes to this setting will be applied only after you clear the
caches. In the Web Administration tool, on the top-level menu, click
Utilities > Clear caches, and then click Clear caches.

FOLDER_EVENT_IDS_FOR_AUDIT
Specify the comma separated folder event IDs for Audit tab filter list. The
default settings is:
30019,30020,30021,30022,30023,30024,70002,80014,110012

272 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

Note: The changes to this setting will be applied only after you clear the
caches. In the Web Administration tool, on the top-level menu, click
Utilities > Clear caches, and then click Clear caches.

FOLDER_EVENT_IDS_TO_TRACK_RECENT_ACCESS
Specify the comma separated event IDs for the folder events followed by
RecentAccessTrackingListener.
The default is 30019,30021,30020,70002.

Note: The changes to this setting will be applied only after you clear the
caches. In the Web Administration tool, on the top-level menu, click
Utilities > Clear caches, and then click Clear caches.

PUBLISH_METADATA_CHANGE_EVENTS
Specify whether to publish the metadata change events.
The default is FALSE.

SKIP_NOTIFICATION_FOR_EVENTS
Specify the comma separated event IDs for which asset and folder subscription
email notifications will be skipped.

Note: Any changes that you make to this setting will come into effect only
after you restart the Media Management server.

By default, this value is empty.

TRIGGER_PROCESS_FOR_IMPORT
Specify whether to enable the trigger process invocation during imports. The
default value is False.
The default is FALSE.

13.1.40 TRANSCODE\SERVER
AUTOADD_TRANSCODE_QUEUE
Enables or disables the auto adding to the transcode queue when the user tries
to open the non-flash compatible proxy. When the user tries to play the non-
flash compatible proxy, then it will play in a new window and the transcode
queue is updated if this entry is set to true. If the entry is false, then the auto
add to transcode queue will be disabled.
The default is true.

ENABLE_PROXY_TRANSCODE
Enables or disables the Background Transcode Process for non-Flash compatible
proxies. The default value for this entry is false.

KEEP_ORIGINAL_PROXY
Specify whether to keep or delete the original proxy after the completion of the
transcoding process. The default value for this entry is true. Set it to false to
delete the original proxy.

OpenText Media Management – Administration Guide 273


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

PROXY_QUEUE_MONITOR_TIMER_INTERVAL
Specify the time interval to start the transcode job. This value must be specified
in seconds. The default value is 900 seconds or 15 minutes.

PROXY_TRANSCODE_BATCH_SIZE
Specify the maximum number of the transcode processes which will be
processed at a time. The default size is 1.

PROXY_TRANSCODE_END_TIME
This entry is used to set the end time of the Background Transcode Process for
the priority 1 and Priority 2 transcode assets and proxies. The default value for
this entry is 23:59.

PROXY_TRANSCODE_FROM_PROXY
Specify that transcode should happen from a proxy or from asset only. If the
value is set to true, the transcode should happen on proxy.
The default is true.

PROXY_TRANSCODE_START_TIME
This entry is used to set the start time of Background Transcode Process for the
priority 1 and Priority 2 transcode assets and proxies. The default value for this
entry is 00:00.

PROXY_TRANSCODE_USER
Specify the user to start the background transcode process.
The default is tsuper.

13.1.41 TRANSFER_SCHEME\ALT_SCHEME
MFT_ENTERPRISE_SERVER_URL
Specify the public URL of the (Secure MFT Enterprise server. For example:
http://<MFTHTTP Host Name>:8080/MFT

MFT_RETRY_COUNT
Specify the number of retries that the system would make in the event of any
network disruptions before failing the ongoing file transfer. The default is 5
times.

MFT_RETRY_INTERVAL
Specify the time interval in seconds between any two retry attempts. The default
is 5 seconds.

SCHEME_NAME
The name of the transfer scheme to use for import and export.
The default is MFT.

S-INTERNAL_MFT_ENTERPRISE_SERVER_URL
This entry only needs to be configured if the Secure MFT server has a virtual IP
configured for internal networks behind the firewall. By default, it will be the
same value as MFT_ENTERPRISE_SERVER_URL. For example:

274 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

http://<MFT_SERVER_Internal_IP/Host Name>:8080/MFT

S-MFT_RESOURCE_ID
The OTDS resource ID of the Secure MFT resource in OTDS.

S-SCHEME_SERVER_IMPLEMENTATION
The Transfer Scheme Server End Implementation class.
The default is com.artesia.transfer.mft.server.
MFTTransferSchemeServer.

13.1.42 TRANSFER_SCHEME\DEFAULT_SCHEME
HTTP_CHUNK_SIZE
Chunk size (in bytes) used by NIO to transfer files from the applet to the import
staging area when the default HTTP transfer scheme is used.

HTTP_SESSION_KEEP_ALIVE_PINGING_INTERVAL
Set the time interval (in seconds) which the server should be pinged to keep the
HTTP Session alive for the duration of a long running HTTP Transfer. OpenText
recommends keeping this time interval to a minimum, or about 75% of the
HTTP session timeout interval, so change it appropriately.
The default value is set to 25 minutes (1500 seconds), assuming a session
timeout of 30 minutes.

13.1.43 TRANSFER_SCHEME\SWITCH
TRANSFER_SIZE_THRESHOLD
The transfer payload size threshold (in bytes) at which the alternate transfer
scheme is used. This is not applicable if an alternate transfer scheme is not
specified.
The default is 1024.

Note: TRANSFER_SIZE_THRESHOLD is applicable to asset download and


export only.

13.1.44 TRANSFORMER\CONFIG
DEFAULT_TIMEOUT_IN_SEC
Timeout for OTMM transformers. A value of 0 means that there is no timeout.
The default is 0.

TRANSFORMATION_EVENT_ENABLED
Specify the value to enable or disable the transformation event.
The default is TRUE.

OpenText Media Management – Administration Guide 275


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

13.1.45 YOUTUBE\CONFIG
Use the following properties to populate the title and description for videos to be
uploaded to YouTube.

Note: You can add only simple field types to this section.

DEFAULT_FIELD_ID_YOUTUBE_ASSETS_DESCRIPTION
When uploading assets to YouTube, if the system cannot get a value for the
description from the
DEFAULT_MODEL_FIELD_ID_YOUTUBE_ASSETS_DESCRIPTION setting, then the
description is obtained from the configured comma separated fields. If multiple
fields are configured, the first field value will be picked up. If the first field value
is empty, then the next field value will be checked and so on.

DEFAULT_FIELD_ID_YOUTUBE_ASSETS_TITLE
When uploading assets to YouTube, if the system cannot get a value for the title
from the DEFAULT_MODEL_FIELD_ID_YOUTUBE_ASSETS_TITLE setting, then the
title is obtained from the configured comma separated fields.
If multiple fields are configured, the first field value will be picked up. If the first
field value is empty then the next field value will be checked and so on.

DEFAULT_MODEL_FIELD_ID_YOUTUBE_ASSETS_DESCRIPTION
Specify fields for each model that has a value which is used to set the description
for the assets uploaded to YouTube. You can configure multiple fields for a
model separated with a comma.
If multiple fields are configured for a model, the first field value will be picked
up. If the first field value is empty then the next field value will be checked and
so on.
Separate models and their corresponding fields using a colon (:). Separate
models using a pipe symbol (|). For example:
DEFAULT_MODEL_FIELD_ID_YOUTUBE_ASSETS_DESCRIPTION =
"MODEL_ID1:FIELD1,FIELD2|MODEL_ID2:FIELD1"

DEFAULT_MODEL_FIELD_ID_YOUTUBE_ASSETS_TITLE
Specify fields for each model that has a value which is used to set the title for the
assets uploaded to YouTube. You can configure multiple fields for a model
separated with a comma (,).
If multiple fields are configured for a model, the first field value will be picked
up. If the first field value is empty then the next field value will be checked and
so on.
Separate models and their corresponding fields uisng a : (colon). Separate
models using a pipe symbol (|). For example:
DEFAULT_MODEL_FIELD_ID_YOUTUBE_ASSETS_TITLE = "MODEL_ID1:FIELD1,
FIELD2|MODEL_ID2:FIELD1"

276 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

DEFAULT_YOUTUBE_ASSETS_DESCRIPTION
When uploading assets to YouTube, if the system cannot get a value for the
description from the
DEFAULT_MODEL_FIELD_ID_YOUTUBE_ASSETS_DESCRIPTION or
DEFAULT_FIELD_ID_YOUTUBE_ASSETS_DESCRIPTION settings, then the specified
value is set as a description for the assets.
DEFAULT_YOUTUBE_ASSETS_TITLE
When uploading assets to YouTube, if the system cannot get a value for the title
from the DEFAULT_MODEL_FIELD_ID_YOUTUBE_ASSETS_TITLE or
DEFAULT_FIELD_ID_YOUTUBE_ASSETS_TITLE settings, then the specified value is
set as a title for the assets.

13.1.46 UX\CACHE
Configuration parameters for the UX cache.

CACHE_CONFIG_URL
Path to the cache configuration file.
The default is file:///<TEAMS_HOME>/data/ux/ehcache-config.xml.
CACHEMANAGER_PROVIDER
The implementation class for the cache.
The default is com.artesia.ux.common.util.cache.EhCacheManager.
CATEGORY_CACHE_TYPE
The type of cache to use for vocabulary objects.
The default is category.
METADATA_CACHE_TYPE
The type of cache to use for metadata.
The default is metadata.
REQUEST_CACHE_ENABLED
Enable or disable the caching of request objects and data templates. Caching will
speed up object retrieval. If you are developing templates, you should set this to
FALSE to allow template changes to be applied without requiring a server
bounce.
The default is TRUE.
SECURITY_CACHE_TYPE
The type of cache to use for security data.
The default is security.
SESSION_CACHE_TYPE
The type of cache to use for session objects.
The default is session.
SYSTEM_CACHE_TYPE
The type of cache to use for system properties.

OpenText Media Management – Administration Guide 277


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

The default is system.

13.1.47 UX\CUSTOM
Configuration parameters for the UX customizations.

EXTERNAL_MODULE
The file used to configure the user interface extensions and other custom
modules that will be dynamically loaded by the Media Management client.
The default is <TEAMS_HOME>/data/ux/extensions/CustomModules.xml.

OBJECT_EDITOR_EXTENSION_FILE
Path to the object editor extensions that includes items like the lookup
configuration.
The default is <TEAMS_HOME>/data/ux/extensions/
ObjectEditorExtensions.xml".

13.1.48 UX\GENERAL
General configuration parameters for the UX.

COPY_ASSET_DESTINATION_LINKS
If true, links to the assets being copied will be replicated on the copies of the
assets.
The default is TRUE.

COPY_ASSET_INNER_LINKS
If true, links between assets being copied will be replicated to the copies of the
assets.
The default is TRUE.

COPY_ASSET_SOURCE_LINKS
If true, links originating from the assets being copied will be replicated on the
copies of the assets.
The default is TRUE.

DEFAULT_FACET_CONFIGURATON_NAME
The default value for facet configuration.
The default is set to ARTESIA.FACET.DEFAULT CONFIG.

DISPLAY_FOLDER_CHILD_COUNTS
Indicates whether to retrieve folder child counts in the HTML5 UI. The default
value is set to false.

DUE_DATE_INDICATOR_DAYS
Show due date for the tasks expiring within n number of days.
The default is 3.

278 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

ENABLE_TERMS_AND_CONDITIONS
Specify to show or hide the terms and conditions and to disable or enable the
Finish button for all the types of delivery templates (download, email, email
URL, FTP and FTP notify) using Share. The default value of this flag is set to Y.

FETCH_FORWARD_ASSET_COUNT
Specify the number of assets to fetch in advance for any search. The default is
200 assets. Fetching all of the assets returned from a search query can slow
down processing in the case of a large number of search results, so by
configuring the number of assets to store in the cache, you can make searching
more efficient.

FOLDER_TYPES_MASK_INFO
Specify mask coordinates for specified folder type IDs to set the limits when
users in the UX adjust the size of thumbnail images assigned to a folder. More
than one folder type can be specified, separating them with a semi colon (;) and
following the pattern <Folder type ID>=<coordinates>. If no coordinates are
specified for a given folder type, then users will be able to resize both the
thumbnail image and folder image (when coordinates are given, only the
thumbnail image can be resized).
The default is ARTESIA.BASIC.FOLDER=left:48,top:175,right:64,bottom:
96.

Note: You must modify this setting to correctly position folder thumbnail
images.

MAX_VALUES_TO_LOAD_TYPE_AHEAD
The maximum number of results desired for the type-ahead search feature. The
default value of -1 means it is ignored, which means that all the results will be
loaded.

NUM_OF_FOLDERS_TO_LOAD
This entry allows administrators to limit the number of sub folders to load while
browsing folders. This configuration can be used to restrict the number of
folders to be loaded in the folder tree so that branches containing an extremely
large number of folders do not negatively affect browsing performance. The
default value of -1 indicates that the number of folders to load is unlimited. If
you want to limit the number of folders to load, modify this setting on all
OTMM nodes and change it to the desired number of folders to load.
The default is -1.

TYPEAHEAD_NUM_MIN_CHARS
The minimum number of characters to type to invoke the type ahead feature.
The default is 2.

OpenText Media Management – Administration Guide 279


MEDMGT160300-AGD-EN-02
Chapter 13 Appendix B – System settings

13.1.49 UX\IMPORT
FOLDER_SELECTION_REQUIRED_IN_UX
Used to make folder selection a requirement when importing assets.
The default is FALSE.

MAX_IMPORT_FILE_SIZE
Specify the maximum file size limit for imported files. The value is in MB.
The default is 2000.

Note: The changes to this setting will be applied only after you clear the
caches. In the Web Administration tool, on the top-level menu, click
Utilities > Clear caches, and then click Clear caches.

13.1.50 UX\OBJECTBUILDER
Configuration for the Object Builder. It creates most of the entity data for the UX.

THREAD_LOAD
The number of objects to process per thread. For example, if page size=100, and
THREAD_LOAD=25, then four threads will be used for the request.
The default is 25.

THREAD_POOL_SIZE
The number of threads available to the object builder. If no threads are available,
processing will be single threaded on the calling thread.
The default is 40.

THREADING_ON
Set to true to run object builder in a separate thread. Threading makes the
creation of DAMObject from the server parallel.
The default is false.

13.1.51 VIDEO\TRANSCODE
AUDIO_BASE_URL
The BASE URL which identifies the server location where the Audio files can be
streamed from. For example, http:/// for HTTP progressive download, and
rtmp:////_definst_/mp3: for the Adobe® Media Server.

AUDIO_PROGRESSIVE_DOWNLOAD_URL
If the AUDIO_BASE_URL is set to a streaming server for clients that do not support
configured streaming server to play proxies, set this to the base URL of the
progressive download server for playing audio proxies.

AUDIO_TRANSCODE_JOB
This is used for the transcoded file format. Set it to the Rhozet Preset GUID or
Factory name in FlipFactory.

280 OpenText Media Management – Administration Guide


MEDMGT160300-AGD-EN-02
13.1. System configurations

DEFAULT_FRAMERATE
This entry is used to set the default frame rate value for input video files when
Telestream FlipFactory® cannot provide it in a response message.
The default is 29.97.
D