OpenText Media Management 16.2
OpenText Media Management 16.2
OpenText Media Management 16.2
Installation Guide
MEDMGT160200-IGD-EN-01
OpenText™ Media Management
Installation Guide
MEDMGT160200-IGD-EN-01
Rev.: 2017-Apr-24
This documentation has been created for software version 16.2.
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.
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
Disclaimer
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
1 Overview ..................................................................................... 9
1.1 Media Management system and its components ................................. 9
1.1.1 Architecture ...................................................................................... 9
1.1.2 Terminology .................................................................................... 10
1.1.2.1 OTDS terminology ........................................................................... 11
1.2 Recommended configuration ........................................................... 12
14.4.1 Installing Media Management on the first cluster node ..................... 187
14.4.2 Installing Media Management on other cluster nodes ...................... 187
14.4.3 Configuring Media Management on all cluster nodes ....................... 188
14.4.3.1 Configuring OTMM with JBoss on all cluster nodes ......................... 188
14.4.3.2 Configuring OTMM with TomEE on all cluster nodes ....................... 190
14.4.3.3 Enabling failover of the client API (optional) .................................... 194
14.4.4 Testing Media Management on the first node .................................. 195
14.4.5 Media Management Indexer configuration on the cluster nodes ....... 195
14.4.6 Solr configuration on cluster nodes ................................................. 199
14.4.6.1 Solr master configuration ............................................................... 200
14.4.6.2 Solr slave configuration ................................................................. 200
14.4.6.3 Configuring Solr on a remote host for HA ........................................ 200
14.4.6.4 Solr master failover ....................................................................... 200
14.5 Using the Metadata Editor in an HA environment ............................ 203
14.6 Risks ............................................................................................ 203
This guide will step you through a complete installation of OpenText™ Media
Management (OTMM), including a description of the overall architecture of an
OTMM system along with the requirements and configuration options for each
component.
All OpenText products are provided as part of the OTMM Master Installer, which
will guide you through the installation of each of these products. Some products are
licensed separately and are not included, such as the database software, and are
identified as prerequisite software.
Figure 1-1 does not include the relational database, which is used to store persistent
data. For more information, see “Database setup” on page 24.
The primary focus of this guide is to install the core OTMM software. This guide
provides an overview of the required software necessary to create a functional
OTMM system, but it does not provide details for installing other required software.
Refer to the appropriate installation guide when installing the other prerequisite
software such as the OpenText and third party products. When appropriate, this
guide will provide guidance for installing other software when specific OTMM-
related choices need to be made.
1.1.2 Terminology
The following terminology is used throughout this document:
• The server where the Media Management application software is installed will
be referred to as the Application Server.
• The server where the database is installed will be referred to as the Database
Server.
• The server where video Transcode server is installed will be referred to as the
Transcode Server.
• The server where OpenText™ Directory Services (OTDS) is installed will be
referred to as the OTDS Server.
This guide covers installation instructions for both Windows and RedHat Enterprise
Linux (Linux). When specific example commands are given, they are specified with
either Linux or Windows syntax. You need to replace TEAMS_HOME with the OTMM
installation directory.
Part of the installation process is ant-driven. Apache Ant™ is bundled and does not
need to be installed separately to execute the specified Ant targets. For more
information, see http://ant.apache.org/.
Note: References to the Media Management Web Client or OTMM Web Client
mean the HTML5 UI, which was introduced in version 10.5.
User Partition
User partitions are self-contained copies of user information that allow you to
organize your users into a structured hierarchy of users, groups, and
organizational units. A user partition within Directory Services is represented by
a unique name. You can have multiple, concurrent user partitions within
Directory Services. There are three types of user partitions:
Resource
Resources represent each multi-user component that you want to connect to
your Directory Services server for synchronization and authentication. Each
resource within Directory Services is represented by a unique name and
resource identifier. When you create a resource, Directory Services automatically
creates an access role allowing the user that created the resource to access it.
Push Connector
An OTDS Framework that allows Users/Groups to be synchronized with
applications that traditionally stored Users/Groups in Database.
Note: Media Management needs to share its repository folder with the
Audio/Video streaming server.
Notes
• You can optionally install Adaptive Media Delivery.
• Adaptive Media Delivery integrates with Data Collector separately from
OTMM.
Database server
A relational database server required by OpenText products. For more
information about supported database engines, see OpenText Media
Management Technical Specifications (https://knowledge.opentext.com/knowledge/
cs.dll/Properties/66025283).
Streaming Server
IIS or Apache HTTPD can be used to provide progressive download of audio/
video content in OTMM. Media Management also supports the Adobe® Media
Server and Wowza Streaming Engine™ to provide streaming capabilities for
long running audio and video assets in Media Management.
Note: When using a Video Transcode Server, you will need to provide a
shared data area where Media Management and the Video Transcode
Server can stage video assets. For more information about setting up audio
and video, see “Configuring video and audio“ on page 85.
Important
The time clock for all the servers must be synchronized for the software
components to work together effectively. To keep the time consistent on all
machines, set up the Windows Time Service or Network Time Protocol
(NTP ).
1. OTDS
For more information, see OpenText Directory Services - Installation and
Administration Guide (OTDS160200-IWC).
2. Core Media Management
For more information, see “Phase 2 - Core Media Management” on page 17.
3. Post-installation software
For more information, see “Phase 3 - Post-installation software” on page 18.
Notes
• OTDS Web Client is included in the installation.
• For more information, see OpenText Media Management Technical
Specifications (https://knowledge.opentext.com/knowledge/cs.dll/Properties/
66025283).
• When you are using Apache TomEE (TomEE) as the application server and
you are installing OTDS and OTMM on the same server, do not set the
CATALINA_HOME global environment variable. OTDS and OTMM services
will not start correctly when CATALINA_HOME is set globally. Both Apache®
Tomcat™ (Tomcat) and TomEE refer to this variable in their scripts.
2. Test the OTDS installation by launching a web browser and pointing to the
following:
<http_or_ https>://<OTDS>:<Tomcat_port>/otds-admin
where
OTDS is the server where OTDS is installed
Tomcat_port is the Tomcat port on which OTDS is running
Solr
See one of the following:
• “Installing and configuring Solr on Windows” on page 43
• “Installing and configuring Solr on Linux” on page 61
ImageMagick®
“Installing ImageMagick on Linux” on page 60
Video Transcoder
Might require a separate license.
• Harmonic Rhozet™ Carbon Coder™ (Rhozet) and Carbon Server
http://www.harmonicinc.com/product/promedia-carbon
• Telestream FlipFactory® (FlipFactory ) and Telestream FactoryArray®
(FactoryArray)
http://www.telestream.net/flipfactory/overview.htm
• Telestream Vantage® (Vantage)
http://www.telestream.net/vantage/overview.htm
• FFmpeg
This is open source.
http://ffmpeg.org/
3. Verify and configure the push connector. For more information, see “Verifying
and Configuring Push Connector for Media Management“ on page 77.
This chapter provides an overview of the installation of the core Media Management
system.
3.1 Requirements
Media Management and the OpenText components are supported for the following
platforms:
Operating System
• Windows Server
• RedHat Enterprise Linux
• CentOS
Relational Database
• Oracle
• SQL Server
• PostgreSQL
OTDS
Download OTDS from OpenText My Support (https://support.opentext.com)
and install it.
Set the JAVA_HOME environment variable to the location of the JDK installation
and add %JAVA_HOME%\bin to the path environment variable. For example, C:
\Program Files\Java\jdk1.8.0_66.
Application server
Notes
• Windows - Use the JBoss EAP Installer method, as Media
Management supports this method only.
• Linux - Use the JBoss EAP Installer or ZIP version methods.
• You must install and configure JBoss EAP. For more information, see
“Installing and configuring JBoss” on page 22.
Apache TomEE
Download TomEE from:
http://tomee.apache.org/downloads.html
You must install and configure TomEE. For more information, see
“Installing and configuring TomEE” on page 23.
Notes
• You must perform these configurations on all Media Management nodes.
• For more information about versions, see OpenText Media Management
Technical Specifications (https://knowledge.opentext.com/knowledge/cs.dll/
Properties/66025283).
• If you are upgrading, take any necessary actions on pending or unconsumed
JMS messages, as they will not be migrated to the upgraded version of
OTMM.
• Download JBoss EAP, and set the JBOSS_HOME environment variable to map to
the path of the JBoss installation folder. For example:
C:\jboss-eap-6.4
Notes
• Windows - Use the JBoss EAP Installer method, as Media Management
supports this method only.
• Linux - Use the JBoss EAP Installer or ZIP version methods.
• If you use the JBoss installer to install JBoss, use the default selections and
install it.
C:\wildfly-9.0.2.Final
• Add the TOMEE_HOME environment variable to map the path of the folder that is
located in the TomEE instance. For example:
C:\apache-tomee-plus-7.0.2
Notes
• You must perform these configurations on all OTMM nodes.
• For more information about versions, see OpenText Media Management
Technical Specifications (https://knowledge.opentext.com/knowledge/cs.dll/
Properties/66025283).
Notes
• For more information, see OpenText Media Management Technical
Specifications (https://knowledge.opentext.com/knowledge/cs.dll/Properties/
66025283).
• The application server must be running on a Windows platform to use SQL
Server as a database.
Ensure that there is enough disk space and allocated database space on your
database server for the Media Management schema. Your requirements will
vary depending on the number and type of assets you will be storing. OpenText
recommends that for a production environment, you should allocate resources
based on your requirements for the number of assets.
Note: Use the SQL Server configuration manager to change the TCP port
of the SQL server to use a unique port. By default, it will be running on
port 1433. Disable the TCP dynamic ports.
1. Install Oracle.
For more information about the supported version of the database, see
OpenText Media Management Technical Specifications (https://
knowledge.opentext.com/knowledge/cs.dll/Properties/66025283).
Ensure that the following Oracle product components are installed on the
Media Management database server:
Note: If you plan to use a container database with Oracle 12c, create a
pluggable database and use this database for Media Management. To
do this, specify the service name of this pluggable database during the
Media Management installation, instead of the service name of the
container database.
• OracleNet Services.
• Oracle JDBC/ Interfaces.
• Oracle Database Utilities (SQLPlus used during installation and upgrade).
• Oracle Java Products.
• processes = 100
• open_cursors = 500
• job_queue_processes = 10 (must be 4 or higher; 10 recommended)
Obtain the password or access to DBA personnel with this password. Ask the
DBA to temporarily change it for the installation if they are not comfortable
disclosing it to you. The Media Management schema installation creates the
database owner, database tables, roles, and tablespaces required by Media
Management.
Note: You can create a user or use an existing user with the following set
of roles and system privileges, instead of a system user for installation.
Required roles
1. Connect with Admin option.
2. Resource with Admin option.
a. Run the following command to test the current maximum file descriptor
value:
cat /proc/sys/fs/file-max
b. To adjust the max file descriptor setting, edit the /etc/sysctl.conf file as
the root (administrative) user by adding a new value for fs.file-max, and
then run the following command to apply the change:
/sbin/sysctl -p
Note: You must set the value of the maximum file descriptor to be
greater than the value that you set for file descriptor allotment in Step
8.
• TEAMS_CATALOG_DATA
• TEAMS_CATALOG_IDX
• TEAMS_CONTEXT_DATA
• TEAMS_CONTEXT_IDX
• TEAMS_CS_DATA
• TEAMS_CS_IDX
• TEAMS_OBJSTACKS_DATA
• TEAMS_OBJSTACKS_IDX
• TEAMS_PM_DATA
• TEAMS_PM_IDX
• TEAMS_UOIS_DATA
• TEAMS_UOIS_IDX
1. Install PostgreSQL.
Notes
• For more information about the supported version of the database, see
OpenText Media Management Technical Specifications (https://
knowledge.opentext.com/knowledge/cs.dll/Properties/66025283). You can
download the Linux and Windows distributions from http://
www.postgresql.org/download.
• Ensure that there is enough disk space and allocated database space on
your database server for the Media Management schema. Your
requirements will vary depending on the number and type of assets you
will be storing. OpenText recommends that, for a production
environment, you should allocate disk space based on your
requirements for the number and type of assets.
• If you are installing using a binary, confirm that the binary was built
with XML support. If you are building from a source, configure it with
the --with-libxml option.
Note: The above configuration opens the database for access to all.
You might want to restrict access to only a select group of machines or
users. For more information about how to do this, see the PostgreSQL
documentation.
3. Obtain the database “Superuser” user and password.
• TEAMS_CATALOG_DATA
• TEAMS_CATALOG_IDX
• TEAMS_CONTEXT_DATA
• TEAMS_CONTEXT_IDX
• TEAMS_CS_DATA
• TEAMS_CS_IDX
• TEAMS_OBJSTACKS_DATA
• TEAMS_OBJSTACKS_IDX
• TEAMS_PM_DATA
• TEAMS_PM_IDX
• TEAMS_UOIS_DATA
• TEAMS_UOIS_IDX
7. Create the following root directory and subdirectories for each module, and
then run the installer:
Notes
• The installer expects this specific folder structure on the database server.
On Windows, the owner of the PostgreSQL service or process must have
read-write permissions to these folders. On Linux, the user who is
configured to run the PostgreSQL service/process must own these
folders.
• There are six logical modules (CATALOG, CONTEXT, CS, OBJSTACK, PM and
UOIS) that each have data and index tablespaces associated with them.
• During installation, the installer asks for the root directories for the data
tablespaces, <some_location>/data, and <some_location>/index
tablespaces.
1. To verify the disk space requirements for the OTMM Application and content
repository, do the following:
• Ensure that there is enough disk space available on your OTMM application
server for the Media Management servers and content repository. The disk
space requirement for the initial installation is approximately 1 GB. Your
requirements will vary depending on the size and type of files you will be
storing in Media Management.
2. To create an OS user who will own the OTMM application files, do one of the
following:
• Locate the OTMM software ISO image and license files and copy or mount
them onto the application server.
Notes
• OTMM requires at least one user partition in OTDS. The OTMM installer can
create one non-synchronized user partition with the default user tsuper.
Note: OTMM provides support for multiple user partitions. The user
partitions can be synchronized, non-synchronized, or a combination of
both.
Before creating the new user partition in OTDS, review the following
information about user partitions for the OTMM Administrator user creation:
All Synchronized
If the security policies allow creation of a non-domain user in LDAP/AD,
then create OTMM Administration user in LDAP/AD. If the security
policies of your organization do not allow creation of a non-domain user in
LDAP/AD, then create a non-synchronized user partition and create the
Administration user in this partition. This partition can be designated as the
“default” partition.
All Non-Synchronized
Create OTMM Administrator user in any of these partitions which can be
designated as the “default” partition.
Notes
• For more information, see OpenText Directory Services - Installation and
Administration Guide (OTDS160200-IWC).
• After installing and configuring OTMM, you can designate a user other
than tsuper as administrator, then disable the tsuper user in OTDS as
well as in the Media Management Administration Client and set the
“System Administrator” Role to the designated user.
Note: Using this file is optional, but it is recommended for administrators who
need to perform multiple installations and keep a reference of parameters for
later use.
Note: In the current version of OTMM, the installer no longer embeds the JVM
for installation. The JRE is automatically picked from the JAVA_HOME
environment variable.
This section describes the steps performed in the Media Management installation
and configuration process. Before installing Media Management, ensure you have
reviewed and performed the necessary steps from the previous chapters before
performing the steps in this chapter.
Note: If you select a Unicode database during the installation, the file system
where the OTMM files are shared or stored must support Unicode file names.
Notes
• OpenText recommends that you use this method to install OTMM.
• To pre-populate the installation screens with default responses, you can
specify values of the installation parameters in the
mediamanagement_config.txt configuration file. You can edit these
values during the install.
• Console
A text-based mode where parameters are read from your configuration file,
mediamanagement_config.txt. You cannot change these values during the
installation process. This mode requires your intervention to proceed to
subsequent steps.
Note: Prior to launching the installer, you must specify the values of the
installation parameters in the mediamanagement_config.txt file. This file
is mandatory if you are installing using console mode.
• Silent
A text-based mode where parameters are read from your configuration file,
mediamanagement_config.txt. You cannot change these values during the
installation process. This mode requires no user interaction.
Note: Prior to launching the installer, you must specify the values of the
installation parameters in the mediamanagement_config.txt file. This file
is mandatory if you are installing using silent mode.
Note: If you are using the configuration file, you must use the fully-
qualified path name. For example:
G:\OTMM\Disk1\InstData\NoVM\install.bat -i gui -f C:
\mediamanagement_config.txt
4. On the License Agreement page, if you agree with the terms, select I accept the
terms of the License Agreement, and click Next.
5. On the Java/App Server Configuration page, do the following, and then click
Next:
6. On the Database Selection page, select your database and click Next.
7. On the Choose Product Features page, for a typical installation, select the
Schema and Application check boxes. This installs the Schema and Application,
providing the minimal software to start the Media Management application
after installation.
8. At the Select Install Folder page, select the folder where you want to install the
Media Management application.
Important
Do not use spaces in the installation directory.
9. On the Select Repository Folder page, select the folder where you want to store
the Media Management repository and click Next. If you do not specify a value
for <TEAMS_REPOSITORY_HOME>, the default system location, <TEAMS_HOME>/
data/repository, will be used.
10. On the Database Schema Configuration page, specify the database schema
settings and click Next.
Notes
• If the selected database is SQL Server, then the correct port number
should be mentioned. For example, the port number of the default
instance or named instance on which the Media Management database
will be created.
• Clear the Test Database Connection check box if you do not want to
test the connectivity to the database with the configured parameters.
• Oracle and PostgreSQL users - When specifying the paths for the Data File
Directory and Index File Directory, the path must be a local file path from
the database server perspective. Also, OpenText recommends that you select
the Create table space option
• SQL Server users - Verify that the SQL Server Agent Service is running.
Important
For installations on SQL Server database, it is mandatory to supply the
system administrator credentials at this screen. No other user
credentials, regardless of the level of permissions, can be used.
12. On the OTDS Configuration page, do the following to specify the OTDS
configuration parameters:
a. In the OTDS Base URL box, enter the base URL of OTDS. You must specify
this parameter as follows:
<http or https>://<OTDS>:<Tomcat_port>
where
<OTDS> is the server where OTDS is installed
<Tomcat_port> is the Tomcat port on which OTDS is running
Notes
• If you do not edit this resource name, the sign-in page will display
the OTMM resource on the sign-in.
• You need to create the resource name for OTMM in OTDS. If you
select the schema install, the name of the resource provided must
not exist in OTDS. For secondary node installations, ensure that this
entry has the same value as the primary node.
e. In the OTMM Use Partition box, enter the name of the user partition in
OTDS.
By default, this partition is used in OTMM. If you select the Create Non
Synchronized Partition and Default User check box, the installer creates a
partition with the above name, and tsuper user with the specified
credentials. If you select the check box for the schema installations, the
OTMM User Partition references to a non-existing partition in OTDS. For
secondary node installations, these are ignored.
f. Select the Create Non Synchronized Partition and Default User check box
for the installer to create a partition with the name that you used in Step
12.e, and tsuper user with the specified credentials.
g. Do one of the following:
Note: This will be the default password for the OTMM user, tsuper.
13. On the Video Transcode configuration page, select the Transcode server that
you want, and then click Next.
• Transcode Port - Provide the port number of the Transcode server. The
default port is displayed, but can be changed if necessary.
• Transcode User - Provide the user account details of FlipFactory where your
factories are created. The default user account name that is shipped with
Media Management is displayed.
• Video File Staging Area - Shared location where video/audio assets will be
copied to submit them for transcoding. This shared location must be having
write access to the Media Management user and read access to the
Transcode server. For more information, see “Configuring video and audio“
on page 85.
15. If any validation errors occur during the installation, an Installation Validation
Errors dialog box appears. If this dialog box appears, review the following files:
• <TEAMS_HOME>/logs/installation/installerValidation.log
• <TEAMS_HOME>/MediaManagement_InstallLog.log
• <TEAMS_HOME>/logs/installation/admin_user.log
• <TEAMS_HOME>/logs/installation/activate_resource.log
Note: This log file will only be generated if you have selected to install
schema and application. This file should contain a message saying
“Resource key is successfully stored” if the resource is successfully
activated and the related information is stored in Media Management.
If this log contains any errors or exceptions, there is no need to reinstall
Media Management. This step can be done manually after finishing the
installation. For more information, see “Verifying the OTMM
installation“ on page 169.
16. After a successful installation, the Install Complete page appears. Note that not
all errors are deemed errors by the installer, so it is generally a good practice to
review the log files after an installation to verify the installation was successful.
For more about debugging errors information, see “Monitoring and
troubleshooting tips during installation” on page 42.
17. At the end of the installation process, you will be prompted to restart the
system. If you do not restart the system, the application may not work or
behave as expected.
18. After the installation has been completed, install your license files. The license
key on the Media Management ISO provides a two-user regular license. The
purpose of this license is to get the system started. You should have also
received your customer-specific license separately. The license consists of two
files: license.dat and license. These two files should be copied to
<TEAMS_HOME>\servers, overwriting the two files placed there during
installation.
Note: You must use the fully-qualified path name for the configuration
file. For example:
G:\OTMM\Disk1\InstData\NoVM\install.bat -i console -f C:
\mediamanagement_config.txt
where
i specifies the mode of installation to be launched.
Note: You must use the fully-qualified path name for the configuration
file. For example:
G:\OTMM\Disk1\InstData\NoVM\install.bat -i silent -f C:
\mediamanagement_config.txt
In GUI mode, you can also check the other command prompt window that opened
when the install program started. This window typically has verbose debug
information. This output window will close automatically when the installer exits,
thus it is important to review the messages before exiting from the installer.
Note: These log files only get written when you exit the installer.
C:> cd '%TEAMS_HOME%\install\ant'
Note: By default, the OTMM Indexer updates the Solr index. During
installation, the user name for the OTMM Indexer is set to “tsuper” and the
password is “tsuper”. If you used a different administrative user and
password, you can change the sign-in credentials. For more information, see
section 3.4 “Changing the Indexer sign-in information” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
1. Create a folder for Solr on the server where you will be installing Solr. For
example, C:\SolrInstall.
3. On the OTMM server, set up the Solr index that is specific to OTMM, by
running one of the following Ant commands from %TEAMS_HOME%\install\
ant.
Notes
• The Ant command that you use depends on the port number on which
you plan to run Solr. By default, Solr uses 8983 as its port number.
When you configure Solr to run as a Windows service, you will have the
option of configuring an alternate port number.
• Setting up the index creates a Solr index on the Media Management
installation in the <TEAMS_HOME>\solr5_otmm folder and updates all the
configuration files.
• If you will be running Solr on port 8983, run the following Ant command:
ant create-solr-index
• If you will be running Solr on a non-default port number, run the following
Ant command:
ant -DSolr.port=<port number> create-solr-index
Notes
• Leave a copy of the solr5_otmm folder on the OTMM server. You can
use it to configure Solr locally, and then copy the changes to the remote
instance
• In the following steps, the location of the solr5_otmm folder on the Solr
server will be referred to as SOLR5_OTMM_DIR.
5. On the Solr server, configure Solr to recognize the OTMM Solr index area by
doing the following:
a. Copy the nssm-2.24.zip file from the Windows Media Management ISO
path, <Media Management ISO>\SOLR\nssm-2.24.zip, to the Solr server.
b. Extract nssm-2.24.zip to in a folder that you create. For example, C:
\SolrServiceInstaller.
Note: This creates a subfolder structure with the root nssm-2.24. For
example, C:\SolrServiceInstaller\nssm-2.24.
c. From a command prompt, change to the nssm-2.24 directory.
d. Do one of the following to run Solr on the default port number, 8983, or an
alternate port number:
• To run Solr on the default 8983 port number, run the following
command:
installSolrService <SOLR_ROOT>
where
<SOLR_ROOT> is the SOLR_ROOT directory path.
installSolrService C:\SolrInstall\solr-5.3.1
installSolrService C:\SolrInstall\solr-5.3.1
8. Use your browser to verify that the Solr Administration user interface is
available:
http://solr_host:8983/solr
Note: Use the port number that you configured the Solr Windows service
to run on. The Solr server log file is available in the <SOLR_ROOT>\server\
logs folder.
9. Update the OTMM installation to refer to the Solr host by editing the SOLR_HOST
and SOLR_URL entries in the Tresource file to point to the remote Solr instance,
as follows:
[COMMON\SOLR]
"SOLR_HOST"="<solr_host>"
"SOLR_URL"="http://<solr_host>:8983/solr"
Notes
Note: Use the port number that you configured the Solr Windows service
to run on.
3. Set up the Solr index that is specific to OTMM, by running one of the following
Ant commands from %TEAMS_HOME%\install\ant.
Notes
• The Ant command that you use depends on the port number on which
you plan to run Solr. By default, Solr uses 8983 as its port number.
When you configure Solr to run as a Windows service, you will have the
option of configuring an alternate port number.
• Setting up the index creates a Solr index in the %TEAMS_HOME%
\solr5_otmm folder and updates all the configuration files.
• If you will be running Solr on port 8983, run the following Ant command:
ant create-solr-index
• If you will be running Solr on a non-default port number, run the following
Ant command:
ant -DSolr.port=<port number> create-solr-index
4. To configure Solr to recognize the OTMM Solr index area, do the following:
a. Copy the nssm-2.24.zip file from the Windows Media Management ISO
path, <Media Management ISO>\SOLR\nssm-2.24.zip, to the Solr server.
b. Extract the contents of the nssm-2.24.zip in a folder that you create. For
example:
C:\SolrServiceInstaller
c. From a command prompt, change to the nssm-2.24 directory.
d. Do one of the following to run Solr on the default port number, 8983, or an
alternate port number:
• To run Solr on the default 8983 port number, run the following
command:
installSolrService <SOLR_ROOT>
where
<SOLR_ROOT> is the SOLR_ROOT directory path.
installSolrService C:\SolrInstall\solr-5.3.1
Note: Use the port number that you configured the Solr Windows service
to run on. The Solr server log file is available in the <SOLR_ROOT>\server\
logs folder.
• To set this node’s Solr server as the Master, run the following:
ant configure-solr-master
These Ant tasks update the configuration in the local solr5_otmm index
directory.
Note: There can be only one Solr Master server. If you configure a second
node to be a Master, you will get an error when you run the Ant task.
3. To propagate the Solr configuration changes that you made in Step 2 to the
remote Solr server, do the following:
This chapter describes the steps performed in the Media Management installation
and configuration process. Before installing Media Management, ensure you have
reviewed and performed the necessary steps from the prior chapters before
performing the steps in this chapter. Following the installation, you should check if
any Service Packs are available to install.
Notes
• Linux users must mount the ISO as the Linux root user.
• If you select a Unicode database during the installation, the file system
where the OTMM files are shared or stored must support Unicode file
names.
Notes
A text-based mode where parameters are read from your configuration file,
mediamanagement_config.txt. You cannot change the values during the
installation process. This mode requires your intervention to proceed to
subsequent steps.
Note: Prior to launching the installer, you must specify the values of the
installation parameters in the mediamanagement_config.txt file. This file
is mandatory if you are installing using console mode.
• Silent
A text-based mode where parameters are read from your configuration file,
mediamanagement_config.txt. You cannot change the values during the
installation process. This mode requires no user interaction.
Note: Prior to launching the installer, you must specify the values of the
installation parameters in the mediamanagement_config.txt file. This file
is mandatory if you are installing using silent mode.
Note: If you are using the configuration file, you must use the fully-
qualified path name. For example:
<ISOPATH>/OTMM/Disk1/InstData/NoVM/install.sh -i gui -f
/home/otmmuser/mediamanagement_config.txt
4. On the License Agreement page, after reading the license agreement, click I
accept and click Next.
5. On the Java/App Server Configuration page, do the following, and then click
Next:
Important
Do not use spaces in the installation directory.
10. On the Select Repository Folder page, select the folder where you want the
Media Management repository stored and click Next. If you do not specify a
value for <TEAMS_REPOSITORY_HOME>, the default system location, which is
<TEAMS_HOME>\data\repository, will be used.
11. On the Database Schema Configuration page, enter the Database Schema
Configuration and click Next.
Note: When specifying the paths for the Data File Directory and Index
File Directory, the path must be a local file path from the database server
perspective. Also, OpenText recommends that you select the Create table
space option.
12. On the Application Configuration page, set the application configuration
details and click Next.
13. On the OTDS Configuration page, do the following to specify the OTDS
configuration parameters:
a. In the OTDS Base URL box, enter the base URL of OTDS. You must specify
this parameter as follows:
<http or https>://<OTDS>:<Tomcat_port>
where
<OTDS> is the server where OTDS is installed
<Tomcat_port> is the Tomcat port on which OTDS is running
Notes
• If you do not edit this resource name, the sign-in page will display
the OTMM resource on the sign-in.
• You need to create the resource name for OTMM in OTDS. If you
select the schema install, the name of the resource provided must
not exist in OTDS. For secondary node installations, ensure that this
entry has the same value as the primary node.
e. In the OTMM Use Partition box, enter the name of the user partition in
OTDS.
By default, this partition is used in OTMM. If you select the Create Non
Synchronized Partition and Default User check box, the installer creates a
partition with the above name, and tsuper user with the specified
credentials. If you select the check box for the schema installations, the
OTMM User Partition references to a non-existing partition in OTDS. For
secondary node installations, these are ignored.
f. Select the Create Non Synchronized Partition and Default User check box
for the installer to create a partition with the name that you used in Step
13.e, and tsuper user with the specified credentials.
g. Do one of the following:
Note: This will be the default password for the OTMM user, tsuper.
14. On the Video Transcode configuration page, select the desired Transcode
server and click Next.
• Video File Staging Area – Shared location where video/audio assets will be
copied to for transcoding. This shared location must have write access to the
Media Management user and read access to the Transcode server. For more
information, see “Configuring video and audio“ on page 85.
15. On the Pre-Installation Summary page, verify the installation properties. Click
the Previous button to make changes if necessary, and then click Install.
16. If any validation errors occur during the installation, an Installation Validation
Errors dialog box will open. If this dialog box opens, review the
installerValidation.log file to see a detailed list of the validation errors.
This validation log is located in:
<TEAMS_HOME>/logs/installation/installerValidation.log
You should also review the following installation log:
<TEAMS_HOME>/MediaManagement_InstallLog.log.
17. On the Install Complete page, click Done to complete the installation.
18. Sign out, and then sign in using the Linux user account that used to install
Media Management.
19. After the installation has been completed, install your license files. The license
key on the Media Management ISO provides a two-user regular license. The
purpose of this license is to get the system started. You should have also
received your customer-specific license separately. The license consists of the
license.dat and license files. These two files must be copied to
<TEAMS_HOME>/servers, overwriting the two files placed there during
installation.
2. Copy the mediamanagement_config.txt from the ISO to a location and fill all
the installation parameters required for your installation.
Note: You must use the fully-qualified path name for the configuration
file. For example:
<ISOPATH>/OTMM/Disk1/InstData/NoVM/install.sh -i console -f
$HOME/mediamanagement_config.txt
2. Copy the mediamanagement_config.txt from the ISO to a location and fill all
the installation parameters required for your installation.
Note: You must use the fully-qualified path name for the configuration
file. For example:
<ISOPATH>/OTMM/Disk1/InstData/NoVM/install.sh -i silent -f
$HOME/mediamanagement_config.txt
In GUI mode, you can also check the other Command Prompt window that opened
when the install program started. This window typically has verbose debug
information. This output window closes automatically when the installer has
finished, so it is important to review the messages before exiting from the installer.
Note: These log files only get written after you exit the installer.
% cd '$TEAMS_HOME/install/ant'
% ant create-admin-user
Note: This section is applicable when the root user is performing the OTMM
installation.
Media Management is installed as the root user. Therefore, the root user’s .profile
and .bash_profile files are updated with the OTMM environment variables.
After a successful installation, the OTMM user must copy these OTMM settings to
their local .profile or .bash_profile startup files.
• TEAMS_HOME
• JAVA_HOME
• JBOSS_HOME
If OTMM is installed by the root user, the ownership of the OTMM and
APP_SERVER_HOME directories must be changed to the OTMM user account.
1. If the OTMM user account is, for example otmmuser, then issue the following
commands to change the directory ownership:
JBoss
chown -R otmmuser $JBOSS_HOME
TomEE
chown -R otmmuser $TOMEE_HOME
4. If the installation fails, install the listed prerequisites and re-run the RPM
installation command.
5. Verify that the /usr/bin directory is in the Media Management user’s PATH.
By default, ImageMagick is install in the /usr/bin directory.
Notes
• If the provided binary has any library dependency problems, generate the
binary from the ImageMagick source. The ImageMagick source is available
at http://www.imagemagick.org.
• ImageMagick uses the dcraw utility to convert dng images. For dng image
conversions, download and install thedcraw rpm. Also, prior to downloading
and installing the RPMs, you must resolve any dcraw library dependency
problems.
If you do not already have XVFB installed on your Linux machine, the install
packages are provided with the Media Management installation.
Note: You only need to install this if you want to generate thumbnail and
preview images for PDF and MS Office documents and if you want to generate
PDF previews for MS Office documents. For all other MIME types,
ImageMagick will be used to generate thumbnail and preview images.
To install XVFB:
Note: By default, the OTMM Indexer updates the Solr index. During
installation, the user name for the OTMM Indexer is set to “tsuper” and the
password is “tsuper”. If you used a different administrative user and
password, you can change the sign-in credentials. For more information, see
section 3.4 “Changing the Indexer sign-in information” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
Note: If the specified user does not exist, the installation script will
create it. If your organization has specific requirements for
creating new user accounts, then you should create the user before
running the script. OpenText recommends that the Solr User does
not have root permissions for security reasons.
• The Solr Port is the port number used by the Solr service.
d. To install Solr with the default options, run the following command:
sudo bash ./install_solr_service.sh solr-5.3.1.tgz
3. To set up the Solr index that is specific to OTMM, do one of the following:
• If your Solr installation uses the default port number, 8983, run the
following ant command from $TEAMS_HOME/install/ant:
ant create-solr-index
• If your Solr installation uses an alternate port number, run the following ant
command from $TEAMS_HOME/install/ant:
ant -DSolr.port=<port number> create-solr-index
Notes
• Leave a copy of the solr5_otmm directory on the OTMM server. You
can use it to configure Solr locally, and then copy the changes to the
remote instance.
• In the following steps, the location of the solr5_otmm directory on the
OTMM server are referred to as SOLR5_OTMM_DIR.
5. Change the permissions of the solr5_otmm directory to be owned by the Solr
user by running the following command from below its parent directory:
chown -R <solr username> solr5_otmm
where
< solr username> is the Solr user that you used when you installed Solr
6. To configure Solr to recognize the OTMM Solr index area, do the following:
a. In a text editor, open the solr.xml file located in the /data subdirectory
below the Writable Files Directory that you chose when you installed Solr.
<str name="coreRootDirectory"><SOLR5_OTMM_DIR></str>
where
<SOLR5_OTMM_DIR> is the solr5_otmm directory copied to the Solr server.
For example:
<str name="coreRootDirectory">/var/solr5_otmm</str>
Note: Use the port number that you configured the Solr service to run on.
The Solr server solr.log file is available in the logs subdirectory below
the Writable Files Directory that you chose when you installed Solr. If you
used the default location, it is /var/solr/logs).
9. Update the OTMM installation to refer to the Solr host by editing the SOLR_HOST
and SOLR_URL entries in the Tresource file as follows:
[COMMON\SOLR]
"SOLR_HOST"="<solr_host>"
"SOLR_URL"="http://<solr_host>:8983/solr"
Notes
• The Tresource file is located in the <TEAMS_HOME>/data/cs/global
directory of each installation.
• Use the port number that you configured the Solr service to run on.
Note: Use the port number that you configured the Solr service to run on.
• The Solr Port is the port number used by the Solr service.
e. To install Solr to use the OTMM user as the Solr user and use the default
values for all other options, run the following command:
sudo bash ./install_solr_service.sh solr-5.3.1.tgz -u <OTMM
username>
2. To set up the Solr index that is specific to OTMM, do one of the following:
• If your Solr installation uses the default port number, 8983, run the
following ant command from $TEAMS_HOME/install/ant:
ant create-solr-index
• If your Solr installation uses an alternate port number, run the following ant
command from $TEAMS_HOME/install/ant:
ant -DSolr.port=<port number> create-solr-index
3. To configure Solr to recognize the OTMM Solr index area, do the following:
a. In a text editor, open the solr.xml file located in the /data subdirectory
below the Writable Files Directory that you chose when you installed Solr.
b. Add the following immediately after the initial <solr> start tag:
<str name="coreRootDirectory"><TEAMS_HOME>/solr5_otmm</str>
where
<TEAMS_HOME> is the TEAMS_HOME location. For example:
<str name="coreRootDirectory">/usr/local/share/otmm/
solr5_otmm</str>
Note: Use the port number that you configured the Solr service to run on.
The Solr server solr.log file is available in the logs subdirectory below
the Writable Files Directory that you chose when you installed Solr. If you
used the default location, it is /var/solr/logs).
• To set this node’s Solr server as the Master, run the following:
ant configure-solr-master
These Ant tasks update the configuration in the local solr5_otmm index
directory.
Note: There can be only one Solr Master server. If you configure a second
node to be a Master, you will get an error when you run the Ant task.
3. To propagate the Solr configuration changes that you made in Step 2 to the
remote Solr server, do the following:
a. Stop the Solr service on the remote Solr server by running the following
command:
sudo service solr stop
b. Copy the local <TEAMS_HOME>/solr5_otmm index folder to the remote Solr
host.
c. Overlay the new or updated index on top of the solr5_otmm folder on the
Solr server, the SOLR5_OTMM_DIR that you created in “To install Solr on a
remote server:“ on page 62.
d. Reset the permissions of the solr5_otmm directory to be owned by the Solr
user by executing the following command from its parent directory:
chown -R <solr username> solr5_otmm
where
<solr username> is the Solr user you configured when you installed Solr
e. Restart the Solr service on the remote Solr host by running the following
command:
sudo service solr start
This section provides information about the tasks that you need to perform after the
installation.
port = 11099
disabled = ${openejb.profile.custom}
threads = 200
backlog = 200
discovery = ejb:ejbd://{bind}:{port}
gzip = false
Notes
• This parameter specifies multicast address to use for cluster
information. Ensure that this multicast address is unique for each of
the OTMM configurations in the network.
• In an HA cluster deployment, you must configure all the nodes of
the cluster to have the same value for all the multicast address.
server =
org.apache.openejb.server.discovery.MulticastDiscoveryAgent
bind = 235.25.20.3
port = 6142
disabled = false
group = default
WINDOWS
<JBOSS_HOME>/bin/otmm-standalone.conf.bat
UNIX
<JBOSS_HOME>/bin/otmm-standalone.conf
Note: You must ensure that all the configurations have unique values for
the following parameters:
• OTMM_JBOSS_NODE_NAME
The value of the parameter specifies the unique node name within the
cluster.
• OTMM_JBOSS_DEFAULT_MULTICAST_ADDRESS
The value of the parameter specifies the multicast address to use for cluster
formation. Ensure that this multicast address is unique for each of the
OTMM configurations in the network.
• OTMM_JBOSS_MESSAGING_GROUP_ADDRESS
The value of the parameter specifies the multicast address to use for JBoss
messaging group. Ensure that this multicast address is unique for each of the
OTMM configurations in the network.
• OTMM_JBOSS_MOD_CLUSTER_ADDRESS
The value of the parameter specifies the multicast address to use.
• OTMM_JBOSS_BIND_ADDRESS
The value of the parameter specifies the resolvable IP or host name (fully
qualified domain name) of the OTMM server.
OTMM_JBOSS_NODE_NAME=PRODNODE1
OTMM_JBOSS_DEFAULT_MULTICAST_ADDRESS=232.232.10.79
OTMM_JBOSS_MESSAGING_GROUP_ADDRESS=232.232.11.79
OTMM_JBOSS_MOD_CLUSTER_ADDRESS=232.232.12.79
OTMM_JBOSS_BIND_ADDRESS=10.25.96.25
https://access.redhat.com/documentation/en-US/
JBoss_Enterprise_Application_Platform/6.4/html/
Administration_and_Configuration_Guide/sect-XA_Datasources.html#sect-
XA_Recovery (https://access.redhat.com/documentation/en-US/
JBoss_Enterprise_Application_Platform/6.4/html/
Administration_and_Configuration_Guide/sect-XA_Datasources.html#sect-
XA_Recovery )
Notes
3. Update the value of the PROVIDER_HOST property with the value of the
OTMM_JBOSS_BIND_ADDRESS parameter or the host name of the OTMM server. If
you specify the host name, ensure that it resolves to the IP address given in the
OTMM_JBOSS_BIND_ADDRESS parameter. For example:
PROVIDER_HOST"="remote://10.96.25.95:11099
Note: For more information about this parameter, see “Configuring JBoss”
on page 70.
3. Update the value of the PROVIDER_HOST property with the value of the host
name of the OTMM server. If you specify the host name, ensure that it resolves
to the IP address given in the bind property in the %TOMEE_HOME%\conf\conf.d
\ejbd.properties file. For example:
"PROVIDER_HOST"="ejbd://10.96.25.95:11099"
You need to install MediaInfo on Linux only. For Windows installations, MediaInfo
is installed as part of the OTMM installation.
Note: Perform the following steps on all the cluster nodes individually.
Note: Install the RPM packages as user who has privileges to install using
the rpm -ivh option.
a. libzen0-0.4.31-1.x86_64.RHEL_6.rpm
b. libmediainfo0-0.7.76-1.x86_64.RHEL_6.rpm
c. mediainfo-0.7.76-1.x86_64.RHEL_6.rpm
Notes
• If you are using Active Directory, this column should be populated with
the fully qualified domain name system (DNS) of the current domain. For
more information, see OpenText Directory Services - Installation and
Administration Guide (OTDS160200-IWC).
The above preconfigured settings prevent the application from being embedded in
another application. If you want the OTMM application to be used in another
application, you must set the headers in the responseheaders.properties file,
which available in the following locations:
If you want to embed the OTMM application in a another application, you must set
the X-Frame-Options to ALLOW-FROM http://including.application.com as
follows:
X-Frame-Options=ALLOW-FROM http://including.application.com
For more information about the AssetInterceptor API, see section 4.12 “Asset
interceptor API” in OpenText Media Management - Integration Guide
(MEDMGT160200-AIN).
Note: How you enable secure session cookies depends on your configuration.
If you are using a web server in front and are terminating SSL at the web
server, you need to configure secure session cookies in the application server.
<session-config>
<cookie-config>
<http-only>true</http-only>
<path>/</path>
<secure>true</secure>
</cookie-config>
</session-config>
This log files contain plaintext passwords. You can delete it files after completing a
successful installation.
http://www.ghostscript.com/download/gsdnld.html
Important
Before configuring the Push Connector, make sure the OpenText Media
Manager service is running.
Note: This section is only required if you cleared the Create Non
Synchronized Partition and Default User check box during the OTMM
installation process. For more information, see “Installing OTMM on
Windows” on page 35.
Note: The OTDS group is accessible from the Settings page in the Web
Administration tool. For more information, see section 2.13.2.3 “Editing a
component and properties” in OpenText Media Management -
Administration Guide (MEDMGT160200-AGD).
• Media Management URL: The URL for the Media Management server;
use the fully qualified host name.
Note: For HA configurations, the host and port of the URL should
be the same as the load-balancer to Media Management.
• User name of Administrator: Name of the Media Management
administrator.
b. In the Password of Administrator box, enter the password of the Media
Management administrator.
c. Click Test connection to make sure the connection information works.
Note: The User Group details will not be pushed to Media Management.
7. Click Finish.
Note: Even though events are only raised for the mapped groups, the
Media Management Administration client displays all of the groups.
Note: Prior to integrating, you must have Data Collector and the OpenText
Analytics products installed.
IHUB_WEBAPPS_DIR
Refers to the folder for iHub Web applications. For example:
IHUB_WEBAPPS_DIR=C:\OpenText\InformationHub\modules\BIRTiHub\iHub
\web\webapps
IHUB_INSTALL_DIR
Refers the root installation folder for all iHub components. For example:
IHUB_INSTALL_DIR=C:\OpenText\InformationHub
Note: For new iHub version 16.x installations, the default root installation
folder is C:\OpenText\InformationHub.
<IHUB_WEBAPPS_DIR>/axis2
b. Create a local working folder, such as IHUB_INSTALL_DIR/axis2.
c. Extract the <IHUB_INSTALL_DIR>/axis2-1.7.1.war.zip to the new
working folder, <IHUB_INSTALL_DIR>/axis2.
d. At the command prompt, change to the following directory:
<IHUB_WEBAPPS_DIR>/axis2
e. Extract the following to the local /webapps/axis2 folder:
<IHUB_INSTALL_DIR>/axis2/axis2.war
f. Verify that the following subfolders were created:
• axis2-web folder
• META-INF folder
• WEB-INF folder
• org folder
3. To configure and build OTDS RSSE, do the following on the OTMM server:
• OTDS_BASE_URL=http://<otds-hostname>:<otds-port>/otdsws/v1
• OTDS_QUERY_USER=otadmin@otds.admin
• OTDS_QUERY_PASS=<otadmin password>
• IHUB_HOME_FOLDER=/home
Note: OpenText recommends that you keep the default value for
the IHUB_HOME_FOLDER setting.
d. Compile the OTDS RSSE Axis2 service, by doing the following:
4. To verify the Axis2 OTDS RSSE service, do the following on the iHub server:
a. In a web browser, navigate to the iHub System Console URL. For example:
http://<ihubhost>:8500/sysconsole
b. Sign in to the System Console using the sysadmin account.
c. Restart the web service for the iHub cluster, by doing the following:
Note: For the web component, stopping the service will change
the status from green to red, and starting will change the status to
green.
v. Click the Web context menu, choose Start Service, and wait for the
status to change to green.
d. Verify that the OTDS RSSE deployed as an Axis2 service by doing the
following:
• Port Number – Accept the default value, 8700, unless you changed
the port number.
• Context Path – Enter /axis2/services/OTDSRSSE.
Tip: To restart the cluster, click the Manage Cluster icon >
Stop Cluster. Wait for all statuses of the services to display as
red. Then, click the Manage Cluster icon > Start Cluster.
Notes
• After restarting, you might need to enable the default volume.
• For more information about enabling, and stopping and
starting a cluster, see OpenText™ Information Hub Installation,
Configuration, and Administration Guide (https://
knowledge.opentext.com/knowledge/llisapi.dll/Properties/
61446610).
5. Verify that the OTDS users have access to iHub by doing the following:
username@domain
To grant the new user read-execute permission to the iHub dashboards and
reports in OTMM:
2. Sign in as Administrator.
Note: For more information about the dedicated iHub user, mmihubuser,
see “Configuring a dedicated iHub user for OTMM” on page 83
a. In the panel on the right, navigate to the OTMM16 folder, click , then
click Share.
b. Click the Users radio button.
c. In the Available list, choose the dedicated iHub user, mmihubuser, and
then click the right arrow to move it to the Selected list.
d. Select the following check boxes:
• Visible
• Execute
• Read
• Apply these privilege settings to the contents of the folder
This chapter describes the steps necessary to configure your Media Management
installation for video and audio. This includes installing and configuring the
FlipFactory or Vantage server from Telestream, or Harmonic ProMedia Carbon (also
referred to in this guide as Rhozet) server, or FFmpeg server. It also includes steps
necessary to set up the Media Streaming and download servers, such as Adobe
Media Server , IIS, Wowza Streaming Engine, or Apache. If you are not planning to
process and store audio or video content, you may skip this chapter.
Note: If you do plan to process audio or video using Rhozet Carbon Coder,
you must request the software and license from OpenText Customer Support if
you have not received it yet.
Preset
This is specific to Rhozet. A preset saves the settings that define a specific
output. For example, you could have a preset called QuickTime MP4 with H.264
for Streaming, which saves the H.264 and QuickTime parameters used for
streaming output from your web server. It also specifies the path for output
files. Rhozet includes 100+ presets.
Media Management defines presets for various output types (for import or
export of videos). A preset is identified by a hexadecimal string of 32 characters.
GUID
The Globally Unique Identifier (GUID) of a Preset is specific to Rhozet. This is
how a Preset is referred to in the APIs when called from the Media Management
server.
Profile
This is specific to Rhozet.
VIDEO_TRANSCODE_CLASS
• For the FlipFactory server - 'com.artesia.video.transcode.services.
FlipFactoryTranscodeServices'
• For the Rhozet server - 'com.artesia.video.transcode.services.
RhozetTranscodeServices'
• For the Vantage server - ‘com.artesia.video.transcode.services.
VantageTranscodeServices’
• For the FFMPEG server - 'com.artesia.video.transcode.services.
FFMpegTranscodeServices'
Default class name of the Media Management Video adapter class. It is used to
submit and manage video transcode jobs on the Transcode server.
You can configure this setting through the VIDEO\TRANSCODE component,
which belongs to the Video configuration group. You can access this group from
the Settings page in the Web Administration tool. For more information, see
section 2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
TRANSCODE_HOST
Details of the server where the Transcode server is installed.
You can configure this setting through the VIDEO\TRANSCODE component,
which belongs to the Video configuration group. You can access this group from
the Settings page in the Web Administration tool. For more information, see
section 2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
FlipFactory only
If FlipFactory is configured in LoadBalance/FactoryArray, provide all
hostnames in an array like the following example:
"SERVER1:PORT,SERVER2:PORT"
If the port is not configured, the default value from TRANSCODE_PORT will
be used.
Vantage only
If Vantage is used as the Transcode server, then the value of this entry
should be specified as http://server:port.
If Vantage is configured in LoadBalance/Array, then you must provide
details of all nodes in an array like the following example:
http://server1:port1,http://server2:port2
Rhozet only
Specify the host name of server where Rhozet is installed. For example:
"SERVER1"
FFmpeg only
Specify the host name of server where FFmpeg is installed.
Notes
• If you are using FFmpeg as the Transcode server and FFmpeg is running
on the same server as OTMM, set the value of this entry to localhost.
• If the FFmpeg server is running remotely, use the one of the following
formats for the host name:
• hostname:port
• ip addresss:port
TRANSCODE_PORT
Use one of the following values:
• 9000, which is the default port to invoke FlipFactory HTTP APIs from Media
Management.
• 1120, which is the default port to invoke Rhozet APIs from Media
Management.
Note: When using Vantage, this entry is ignored because the port is
specified in the above entry.
TRANSCODE_USER
The user name or account name for the FlipFactory server. All factories used in
Media Management must be created with this user name only, for example,
'otmm'.
TRANSCODE_CATEGORY
On a Vantage server, this is the name of the category containing the default
Media Management workflows. For example, MediaMgmt.
You can configure this setting through the VIDEO\TRANSCODE component,
which belongs to the Video configuration group. You can access this group from
the Settings page in the Web Administration tool. For more information, see
section 2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
TARGET_PATH
A shared network path for the Transcode server where the transcode output
files will be written to. The user who executes OTMM must have read access to
this path and the Transcode server must have write access to this path. This
entry value is added from the installer. For example:
\\<transcode server host>\<transcode_working_folder>
Notes
VIDEO_FILE_STAGING_AREA
Folder where Media Management stages video content for transcoding. The user
executing OTMM must have read and write access to this folder. The Transcode
server will read the content from this location. This entry value gets added from
the installer. For example:
\\<transcode server host>\<staging area directory>
Note: Linux - This shared folder must be mounted to a Linux folder. The
Media Management user must have write access to it. For example:
/usr/local/<mount_point_directory>
VIDEO_BASE_URL
Set the base URL to the video server for playing video proxies. The base URL is
of the form:
Note: The streaming server may be installed on the same host as Media
Management or on a different host.
AUDIO_BASE_URL
Set the base URL to the server for playing audio proxies. The base URL is of the
form:
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, set this to the base URL of
the progressive download server for playing video proxies. The base URL is of
the form:
http://<web-server>/<application name for http progressive download>
You can configure this setting through the VIDEO\TRANSCODE component,
which belongs to the Video configuration group. You can access this group from
the Settings page in the Web Administration tool. For more information, see
section 2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
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. The base URL is of the
form:
http://<web-server>/<application name for http progressive download>
You can configure this setting through the VIDEO\TRANSCODE component,
which belongs to the Video configuration group. You can access this group from
the Settings page in the Web Administration tool. For more information, see
section 2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
WORKING_PATH
This path must have the same value as the VIDEO_FILE_STAGING_AREA entry.
Notes
• For FlipFactory, this path must be always in the UNC path format. For
example,
"\\<transcode server host>\<staging area directory>"
• This value must be configured on Linux.
Note: This Linux-only entry must have a back slash ("\") at the end. For
example:
"\\<transcode server host>\<transcode working file directory>\"
the Settings page in the Web Administration tool. For more information, see
section 2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
Note: This output working area can be the same staging area used for
transcoding input (VIDEO_FILE_STAGING_AREA, UNC_REPOSITORY).
UNIX_RELATIVE_VIDEO_WORKING_AREA
This is for Linux only.
Linux mount path to the Transcode server output working folder
(UNIX_VIDEO_WORKING_AREA_UNC).
Note: This Linux-only entry must have a forward slash ("/") at the end. For
example:
"/usr/local/<mount_point_directory>/"
Note: This path can be the same local directory path used to stage
transcode input files.
PRIMARY_KEYFRAME
The key-frame index used to create the thumbnail. By default this is 2, which
means the third keyframe in the video is set as the thumbnail.
If this key-frame index number is greater than the highest frame index number
of the video asset, the highest frame index number (the last key frame) will be
used to generate the thumbnail. If this number is a negative number, the lowest
frame index number (the first key frame) will be used to generate the thumbnail.
Note: The thumbnail can be changed within the OTMM UX application for
each individual video.
<FILE_EXTENSION>_EXPORT_CLIP_TRANSCODE_JOB
When the export of a video clip is processed without giving any conversion, this
entry determines the output format of the video clip. The output factory/preset/
workflow is considered based upon the extension of its parent (Master) video
file. For example, while exporting a MP4 video clip asset, it uses the factory/
preset/workflow that is configured using the following entry for the output
video clip.
"MP4_EXPORT_CLIP_TRANSCODE_JOB"="<factory name of mp4> or <mp4 preset
GUID>"
DEFAULT_EXPORT_CLIP_TRANSCODE_JOB
This is the default output factory/preset/workflow considered if the extension of
its parent (Master) video file is not configured.
Note: This is specific to video clip assets only. The default value is
configured as MP4, but can be changed to any format.
Note: Creating the user is only required for Windows systems. Linux systems
will mount the shared video staging area. When mounting the shared folder,
read/write access to the mounted file system must be provided to the local
Media Management user ID.
For simplicity, OpenText recommends that you set up only one share and use it for
reading the input file and writing the output files. The shared storage can reside on
any of the following:
• The Media Management server.
• The Transcode server.
• A separate storage, such as a NAS.
WINDOWS
The key requirement is that both OTMM and the transcoder are executing with a
user ID that has both read and write capabilities and that both servers can
access the shared storage.
LINUX
The key requirement is the OTMM user has both read and write access to the
local mounted transcode folders and the transcode user has read and write
capabilities to the Windows shared folders.
Notes
• \\TranscodeSrv\staging_area - On the Transcode server machine, create a
folder such as D:\staging_area and enable this folder for access by the
Windows common user by clicking the folder properties, share, and then
add the user and grant permissions.
• On the Windows Media Management server, edit the Media Management
setting to include this shared staging area path. You should specify the
following value as a network UNC path in the VIDEO_FILE_STAGING_AREA
setting in the CONTENT\CONFIG component, which belongs to the
General configuration group. You can access this group from the Settings
page in the Web Administration tool. For more information, see section
2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
\\TranscodeSrv\staging_area
• \\TranscodeSrv\transcode_wf - It is recommended that this be the same as
the staging_area. If this folder needs to be in a different location, then
create this folder on the Transcode server machine and enable it for read
access for the common user. Click the folder properties, share, and then add
user and grant permissions.
In this example, the shared transcode folders are located on an independent File
Server.
• In this example, the shared transcode folders are located on an independent File
Server.
• On the File Server, create the transcode_wf (output) folder and the
staging_area (input) folder.
• Share both folders giving the common user read and write access to both
folders.
• Set the VIDEO_FILE_STAGING_AREA setting value as follows:
WINDOWS
"VIDEO_FILE_STAGING_AREA"="\\TranscodeSrv\staging_area"
UNIX
VIDEO_FILE_STAGING_AREA" = "/<mount_point>/staging_area
Note: OpenText recommends that you use a single share for simplicity.
Note: You can edit these settings through the Settings page in the Web
Administration tool. For more information, see section 2.13.2.3 “Editing a
component and properties” in OpenText Media Management - Administration
Guide (MEDMGT160200-AGD).
Carbon Coder is a stand-alone application which runs on a single system that can be
used for production purposes. Because video and audio transcoding requires more
CPU cycles than typical applications, OpenText recommends installing Carbon
Coder on a separate Windows server. For a list of supported operating systems for
Rhozet, see the Rhozet documentation.
Notes
• For more information about versions, see OpenText Media Management
Technical Specifications (https://knowledge.opentext.com/knowledge/cs.dll/
Properties/66025283).
• The supported operating systems for Rhozet may differ from those
supported for Media Management.
• Rhozet may need all the available CPU cycles, depending on the volume of
media.
• For more information about dependencies, installation instructions, and
other related information, see the Rhozet Carbon Coder documentation.
Prior to installing Rhozet Carbon Coder, make sure you have the license
dongle available.
https://www.harmonicinc.com/media/2016/06/ProMediaCarbon_3_20_UGuide.pdf.
Prior to setting up video transformations, you must install Rhozet Carbon Coder.
For more information about dependencies, installation instructions, and other
related information, see the Rhozet documentation.
7. Restart the Nexus Server by running the services.msc command, and then
select Nexus Server > restart.
8. Open the Rhozet Carbon Admin. It may need a couple minutes to import
presets and build the updated preset list.
10. Verify the presets and profile which are imported by selecting the following
items from the left navigation panel of the Preset Editor:
11. Restart Rhozet Carbon Coder by running the services.msc command, and
then select Nexus Server > restart.
12. Verify the GUIDs for each of the presets on the Media Management server as
follows:
• VIDEO_TRANSCODE_JOB → otmm_default_import_profile.
• PROXY_VIDEO_TRANSCODE_JOB → MP4 import.
• EXPORT_VIDEO_TRANSCODE_JOB → AVI export preset.
• AUDIO_TRANSCODE_JOB → Audio import.
• EXPORT_VIDEO_TRANSCODE_JOB_WMV → Windows media streaming.
The following are additional GUIDs which are preconfigured, but are part of the
optional export transformers, which are installed separately:
• EXPORT_VIDEO_TRANSCODE_JOB_WMV
• EXPORT_VIDEO_TRANSCODE_JOB_IPHONE
• EXPORT_VIDEO_TRANSCODE_JOB_MOBILE
• EXPORT_VIDEO_TRANSCODE_JOB_MOV
• EXPORT_VIDEO_TRANSCODE_JOB_F4V
• EXPORT_VIDEO_TRANSCODE_JOB_MP4
• EXPORT_VIDEO_TRANSCODE_JOB_AVI
For both these sets, the values are pre-configured as seen through the Settings page
in the Web Administration tool. Do not modify them unless you need to create your
own custom presets and profile. For more information about how to modify custom
presets and profiles, see Rhozet Carbon Coder User Guide.
Notes
• You should verify that the GUIDs defined through the Settings page exist
using the Rhozet Carbon Admin preset editor. If they do not exist, you can
configure your own presets following the instructions below.
• Media Management uses Profiles to interact with Rhozet while importing
assets and uses Presets for exporting assets. To conform to Media
Management specifications for keyframes of 320x240, you must configure a
custom Video Keyframe GUID.
1. To setup Rhozet to capture thumbnails from videos, open the Preset editor by
clicking Start > Programs > Rhozet > Carbon Coder > Carbon Coder Admin.
3. If the Thumbnail selected is not exactly as required, then Copy this Preset and
edit it by clicking Edit Preset for the copied thumbnail. A sample is given
below.
• Optional: Set the Pathto the destination folder to be the same as the folder
where the Proxy Videos are picked up, for example, \\TranscodeSrv\
transcode_wf.
Important
Make sure that the Write First Frame (checkbox) attribute is set to
TRUE. This is required for generating all the keyframes and making sure
that the Media Management features, including Media Catalog, will
function correctly.
Import jobs are submitted to Rhozet by the Media Management server using the
Carbon APIs to queue jobs to Rhozet for transcoding using the Profile represented
by VIDEO_TRANSCODE_JOB. These files are staged to a Media Management pick up
folder using the Media Management APIs.
The following steps are needed for Media Management APIs to interact with Rhozet
Carbon Coder APIs:
Note: Make sure the Transcode server can access the Media Management host
via a browser. The Media Management URL is configured using the
WEB_APPS_BASE_URL setting that is configured through the Settings page in the
Web Administration tool. For more information, see section 2.13.2.3 “Editing a
component and properties” in OpenText Media Management - Administration
Guide (MEDMGT160200-AGD).
"MXF_EXPORT_CLIP_TRANSCODE_JOB"="{C5CECA39-
C3E4-4A72-9468-28F325C894CF}"
"3GP_EXPORT_CLIP_TRANSCODE_JOB"="{D6E6040B-21D1-426B-
BF69-7971B6A46B90}"
Additional Configuration for Linux only:
Add the following settings Linux under the VIDEO\TRANSCODE
component, which belongs to the Video configuration group. The path
must end with / or \ as follows.
"UNIX_VIDEO_WORKING_AREA_UNC"="\\<Working area server>
\<Shared Folder>\"
"UNIX_RELATIVE_VIDEO_WORKING_AREA"="<local path to the shared
folder>/"
Also, add the following settings for Windows and Linux, under the
VIDEO\TRANSCODE section:
"AUDIO_BASE_URL"="http://IIS_Server/IIS_App"
"VIDEO_BASE_URL"="http://IIS_Server/IIS_App"
• Through the Settings page, which is accessible from the Web Administration
tool, configure the RHOZET\PROFILE component, which belongs to the Video
configuration group, as follows:
Note: For more information about editing settings, see section 2.13.2.3
“Editing a component and properties” in OpenText Media Management -
Administration Guide (MEDMGT160200-AGD).
The following section is used for importing video assets into Media
Management. This example configuration shows the index values of the default
profile 'VIDEO_TRANSCODE_JOB'.
[RHOZET\PROFILE]
"PROXY_INDEX"="0"
"KEYFRAME_INDEX"="1"
"CLOSEDCAPTION_INDEX"="2"
PROXY_INDEX, KEYFRAME_INDEX and CLOSEDCAPTION_INDEX indicate the
respective positions of the presets present in the profile.
If you want to create a new profile, you can use the Carbon Coder interface to
create a new profile. The profile must include a preset for proxy and a preset for
keyframes.
PROXY_INDEX should specify all the indices where Presets related to proxy
creation are present in the Rhozet profile. If multiple indices are provided, only
the first proxy will be considered.
KEYFRAME_INDEX should specify all the indices where Presets related to keyframe
generation are present in the Rhozet profile.
Note: The indices should be specified as comma separated values and the
first index should start from zero.
The following video configuration samples (for Windows and for Linux) have the
following assumptions:
• The shared transcode folders are located on the Transcode server machine.
• The staging area folder name is staging area. This is where the videos are input
to the Transcode server.
• The transcode working file area is transcode_wf. This is where the video
Transcode server writes out transcoded files.
• The Rhozet Carbon Coder host name is rhozetSrv in which the “H:” drive has
the staging area and Transcode working file area.
"VIDEO_FILE_STAGING_AREA"="\\rhozetSrv\staging_area"
Notes
• The General configuration group is accessible from the Settings page in the
Web Administration tool. For more information about editing the
configurations settings, see section 2.13.2.3 “Editing a component and
properties” in OpenText Media Management - Administration Guide
(MEDMGT160200-AGD).
"VIDEO_FILE_STAGING_AREA"="/usr/local/share/staging_area"
"WORKING_PATH"="/usr/local/share/staging_area"
"UNC_REPOSITORY"="\\rhozetSrv\staging_area"
"UNIX_VIDEO_WORKING_AREA_UNC"="\\rhozetSrv\transcode_wf\"
"UNIX_RELATIVE_VIDEO_WORKING_AREA"="/usr/local/share/
transcode_wf/"
Notes
• The Video configuration group is accessible from the Settings page in the
Web Administration tool. For more information about how to edit settings,
see section 2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
• The trailing slashes at the end of UNIX_VIDEO_WORKING_AREA_UNC and
UNIX_RELATIVE_VIDEO_WORKING_AREA are required.
• Make sure the Media Management server is accessible from the Rhozet
server because HTTP notifications are sent to from the Rhozet server to the
Media Management server.
Note: For more information about versions, see OpenText Media Management
Technical Specifications (https://knowledge.opentext.com/knowledge/cs.dll/
Properties/66025283).
8. Copy the otmm.xsl file from the style sheets folder of the extracted ZIP to the
$flipfactory$\http\metadata\stylesheets folder. For example:
C:\Program Files (x86)\Telestream\FlipFactory\http\metadata
\stylesheets
or load balancer. The host configured here should be reachable from the
FlipFactory server.
c. Replace all the occurrences of $OTMM_HTTP_PORT$ with the http port where
the OTMM server was configured. In case of single node, the default value
is 11090. If a load balancer or proxy is configured, specify the port as http
port on which the load balancer or proxy is running. The OTMM host name
and HTTP port configured in the above steps are used to send a http
notification after a transcode job is done on the FlipFactory server.
d. Change the values of the attributes personal and username to <username>
for the account tag where <username> is the new user account name in
FlipFactory.
e. Rename otmm.xml to <username>.xml and copy the file to the
$flipfactory$\Xml\accounts\import folder. For example, C:\Program
Files (x86)\Telestream\FlipFactory\Xml\accounts\import.
f. Restart the FlipFactory service to import the new user into FlipFactory.
g. Update the TRANSCODE_USER setting with the new user created above. This
property is located under the VIDEO\TRANSCODE component, which
belongs to the Video configuration group. This group is accessible from the
Settings page in the Web Administration tool. For more information about
editing a component, see section 2.13.2.3 “Editing a component and
properties” in OpenText Media Management - Administration Guide
(MEDMGT160200-AGD).
12. If you have already configured your factory with a FlipFactory user account, for
example “demo”, and you want to use the same account name for Media
Management, then you must delete the “demo” account first (deleting an
account removes all the old configurations) and rename otmm.xml to demo.xml.
14. Sign in to FlipFactory with the OTMM account, which will be created
automatically by the XML file.
Note: You must enable the Media Trimming setting for all factories configured
through the Settings page in the Web Administration tool for export video
transformations.
The factories, which are configured under following transcode job settings, are ready
to use after the configurations described in this section are complete. The following
settings are located under the VIDEO\TRANSCODE component, which belongs to
the VIDEO configuration group. This group is accessible from the Settings page in
the Web Administration tool. For more information, see section 2.13.2.3 “Editing a
component and properties” in OpenText Media Management - Administration Guide
(MEDMGT160200-AGD).
• VIDEO_TRANSCODE_JOB
• PROXY_VIDEO_TRANSCODE_JOB
• EXPORT_VIDEO_TRANSCODE_JOB
• AUDIO_TRANSCODE_JOB
• DEFAULT_EXPORT_CLIP_TRANSCODE_JOB
• MOV_EXPORT_CLIP_TRANSCODE_JOB
• F4V_EXPORT_CLIP_TRANSCODE_JOB
• FLV_EXPORT_CLIP_TRANSCODE_JOB
• AVI_EXPORT_CLIP_TRANSCODE_JOB
• WMV_EXPORT_CLIP_TRANSCODE_JOB
• MP4_EXPORT_CLIP_TRANSCODE_JOB
• MPG_EXPORT_CLIP_TRANSCODE_JOB
• MXF_EXPORT_CLIP_TRANSCODE_JOB
• 3GP_EXPORT_CLIP_TRANSCODE_JOB
The following additional factories, which are pre-configured, are part of optional
export transformers installed separately:
• EXPORT_VIDEO_TRANSCODE_JOB_WMV
• EXPORT_VIDEO_TRANSCODE_JOB_IPHONE
• EXPORT_VIDEO_TRANSCODE_JOB_MOBILE
• EXPORT_VIDEO_TRANSCODE_JOB_MOV
• EXPORT_VIDEO_TRANSCODE_JOB_F4V
• EXPORT_VIDEO_TRANSCODE_JOB_MP4
• EXPORT_VIDEO_TRANSCODE_JOB_AVI
The values of both of these sets are pre-configured. The settings are located under
the VIDEO\TRANSCODE component, which belongs to the VIDEO configuration
group. This group is accessible from the Settings page in the Web Administration
tool. For more information, see section 2.13.2 “Configuring components” in
OpenText Media Management - Administration Guide (MEDMGT160200-AGD). Do not
modify these settings unless you need to create your own custom factories. For more
information about creating custom factories, see FlipFactory User Guide (http://
www.telestream.net/download-files/flipfactory/7-2/FlipFactory_UserGuide.pdf).
Note: You should verify that the factories defined in through the Settings page
in the Web Administration tool exist using the FlipFactory console. If not, you
can configure your own factories by using the following instructions.
For Media Management APIs to interact with FlipFactory APIs, configure the
settings using the VIDEO\TRANSCODE component, which belongs to the Video
configuration group. You need to update the host, port, and factory names of the
factories required for Media Management to transcode audio and video assets. The
Video group is accessible from the Settings page in the Web Administration tool.
For more information about editing components, see section 2.13.2.3 “Editing a
component and properties” in OpenText Media Management - Administration Guide
(MEDMGT160200-AGD). The following is a sample configuration.
When you submit jobs to the FlipFactory server, the FlipFactory server tries to
submit the job to the primary node first. If the primary node fails to respond,
the FlipFactory server falls back to the next node in the list. If the port number
is the default for all FlipFactory servers in FactoryArray, then enter the port
details in the TRANSCODE_PORT setting. If any port details are missed in the
above entry, the FlipFactory server uses the TRANSCODE_PORT value of the
setting as the default. The TRANSCODE_PORT setting is located under the VIDEO
\TRANSCODE component, which belongs to the Video configuration group.
For more information, see section 2.13.2.3 “Editing a component and
properties” in OpenText Media Management - Administration Guide
(MEDMGT160200-AGD).
"TRANSCODE_PORT"="9000"
"PRIMARY_KEYFRAME"="3"
"VIDEO_TRANSCODE_JOB"="otmm_import_default"
"PROXY_VIDEO_TRANSCODE_JOB"="otmm_import_proxy"
"EXPORT_VIDEO_TRANSCODE_JOB"="otmm_export_avi"
"AUDIO_TRANSCODE_JOB"="otmm_import_audio"
"EXPORT_VIDEO_TRANSCODE_JOB_WMV"="otmm_export_wmv"
"EXPORT_VIDEO_TRANSCODE_JOB_IPHONE"="otmm_export_iphone"
"EXPORT_VIDEO_TRANSCODE_JOB_MOBILE"="otmm_export_mobile"
"EXPORT_VIDEO_TRANSCODE_JOB_MOV"="otmm_export_quicktime"
"EXPORT_VIDEO_TRANSCODE_JOB_F4V"="otmm_export_f4v"
"EXPORT_VIDEO_TRANSCODE_JOB_MP4"="otmm_export_mpeg4"
"EXPORT_VIDEO_TRANSCODE_JOB_AVI"="otmm_export_avi"
"DEFAULT_FRAMERATE"="29.97"
"TRANSCODE_USER"="otmm"
"DEFAULT_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_mpeg4"
"MOV_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_quicktime"
"F4V_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_f4v"
"FLV_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_flash"
"AVI_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_avi"
"WMV_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_wmv"
"MP4_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_mpeg4"
"MPG_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_mpg"
"MXF_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_mxf"
"3GP_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_mobile"
Also, for both Windows and Linux, note the following under the VIDEO
\TRANSCODE component, which belongs to the VIDEO configuration group:
"AUDIO_BASE_URL"="http://IIS_Server/IIS_App"
"VIDEO_BASE_URL"="http://IIS_Server/ IIS_App"
WINDOWS
Navigate to the VIDEO_FILE_STAGING_AREA property, and enter \
\TranscodeSrv\video_staging in the Value column.
LINUX
Navigate to the VIDEO_FILE_STAGING_AREA property, and enter /usr/local/
mount_point/video_staging in the Value column.
Note: The Video group is accessible from the Settings page in the Web
Administration tool. For more information about editing components, see
section 2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
"VIDEO_FILE_STAGING_AREA"="\\flipFactorySrv\staging_area"
Note: The General group is accessible from the Settings page in the Web
Administration tool. For more information about editing components, see
section 2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
"VIDEO_FILE_STAGING_AREA"="/usr/local/share/staging_area"
"WORKING_PATH"="/usr/local/share/staging_area"
"UNC_REPOSITORY"="\\flipFactorySrv\staging_area"
Notes
• The VIDEO_FILE_STAGING_AREA setting is located under the CONTENT
\CONFIG component, which belongs to the General configuration group.
• The UNC_REPOSITORY and WORKING_PATH settings are located under the
VIDEO\TRANSCODE component, which belongs to the Video
configuration group.
• The General and Video group are accessible from the Settings page in the
Web Administration tool. For more information about editing components,
see section 2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
For FlipFactory, the transcode working file directory has to be configured in the
factory product destination of FlipFactory server and must be in the network UNC
path.
"UNIX_VIDEO_WORKING_AREA_UNC" = "\\flipFactorySrv\transcode_wf\"
"UNIX_RELATIVE_VIDEO_WORKING_AREA" = "/usr/local/share/transcode_wf/"
Note: For more information about versions, see OpenText Media Management
Technical Specifications (https://knowledge.opentext.com/knowledge/cs.dll/
Properties/66025283).
Follow the instructions in the Vantage Domain Management Guide, which can be
found here:
http://www.telestream.net/pdfs/user-guides/
Vantage_Domain_Management_Guide_6.3.pdf
7. Open the Vantage Management Console, sign in as a user with the Vantage
administrator role, and perform the following steps:
a. Navigate to Workflow Design Items > Media Nicknames and import all
the media nicknames in the videotransformer_workflows\vantage
\MediaNicknames folder in the extracted location.
b. Navigate to Workflow Design Items > Metadata Labels and import all the
metadata labels in the videotransformer_workflows\vantage
\MetadataLabels folder in the extracted location.
c. Navigate to Workflow Design Items > Attachment Nicknames and import
all the attachment nicknames in the videotransformer_workflows\
vantage\AttachmentNicknames folder in the extracted location.
8. Open Vantage Workflow Designer and sign in as a Vantage user and perform
the following steps to import all the default Vantage Workflows into a category.
a. Select File > Create New Category and create a new category, for example,
MediaMgmt.
b. Import all the workflows in the videotransformer_workflows\vantage
\Workflows\MediaMgmt folder in the extracted location by right-clicking
the newly created category in the left-hand side pane and selecting Import
Workflows.
c. Click File > Batch Workflow Operations and select all the workflows
associated with the above category and click Activate.
Note: The following transcode job settings are located under the VIDEO
\TRANSCODE component, which belongs to the VIDEO group. For more
information, see section 2.13.2.3 “Editing a component and properties” in
OpenText Media Management - Administration Guide (MEDMGT160200-AGD).
• VIDEO_TRANSCODE_JOB
• PROXY_VIDEO_TRANSCODE_JOB
• EXPORT_VIDEO_TRANSCODE_JOB
• AUDIO_TRANSCODE_JOB
• DEFAULT_EXPORT_CLIP_TRANSCODE_JOB
• MOV_EXPORT_CLIP_TRANSCODE_JOB
• F4V_EXPORT_CLIP_TRANSCODE_JOB
• FLV_EXPORT_CLIP_TRANSCODE_JOB
• AVI_EXPORT_CLIP_TRANSCODE_JOB
• WMV_EXPORT_CLIP_TRANSCODE_JOB
• MP4_EXPORT_CLIP_TRANSCODE_JOB
• MPG_EXPORT_CLIP_TRANSCODE_JOB
• MXF_EXPORT_CLIP_TRANSCODE_JOB
• 3GP_EXPORT_CLIP_TRANSCODE_JOB
The following additional pre-configured factories are part of the optional export
transformers which are installed separately.
• EXPORT_VIDEO_TRANSCODE_JOB_WMV
• EXPORT_VIDEO_TRANSCODE_JOB_IPHONE
• EXPORT_VIDEO_TRANSCODE_JOB_MOBILE
• EXPORT_VIDEO_TRANSCODE_JOB_MOV
• EXPORT_VIDEO_TRANSCODE_JOB_F4V
• EXPORT_VIDEO_TRANSCODE_JOB_MP4
• EXPORT_VIDEO_TRANSCODE_JOB_AVI
Note: The above workflows and factories are pre-configured. Do not modify
them unless you need to create your own custom workflows. The settings are
located under the VIDEO\TRANSCODE component, which belongs to the
VIDEO configuration group. This group is accessible from the Settings page in
the Web Administration tool. For more information, see section 2.13.2
“Configuring components” in OpenText Media Management - Administration
Guide (MEDMGT160200-AGD).
For Media Management APIs to interact with Vantage APIs, configure the VIDEO
\TRANSCODE component, which belongs to the Video configuration group. You
need to update the host and workflow names of the workflows required for Media
Management to transcode audio and video assets.
"UNC_REPOSITORY"="\\TranscodeSrv\video_staging"
"VIDEO_TRANSCODE_CLASS"="com.artesia.video.transcode.services.
VantageTranscodeServices"
"TRANSCODE_HOST"="http://Vantage_SERVER:8676"
TARGET_PATH - \\<transcode server host>
\<transcode_working_folder>
Notes
"PRIMARY_KEYFRAME"="3"
"VIDEO_TRANSCODE_JOB"="otmm_import_default"
"PROXY_VIDEO_TRANSCODE_JOB"="otmm_import_proxy"
"EXPORT_VIDEO_TRANSCODE_JOB"="otmm_export_avi"
"AUDIO_TRANSCODE_JOB"="otmm_import_audio"
"EXPORT_VIDEO_TRANSCODE_JOB_WMV"="otmm_export_wmv"
"EXPORT_VIDEO_TRANSCODE_JOB_IPHONE"="otmm_export_iphone"
"EXPORT_VIDEO_TRANSCODE_JOB_MOBILE"="otmm_export_mobile"
"EXPORT_VIDEO_TRANSCODE_JOB_MOV"="otmm_export_quicktime"
"EXPORT_VIDEO_TRANSCODE_JOB_F4V"="otmm_export_f4v"
"EXPORT_VIDEO_TRANSCODE_JOB_MP4"="otmm_export_mpeg4"
"EXPORT_VIDEO_TRANSCODE_JOB_AVI"="otmm_export_avi"
"DEFAULT_FRAMERATE"="29.97"
"TRANSCODE_CATEGORY"="MediaMgmt"
"DEFAULT_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_mpeg4"
"MOV_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_quicktime"
"F4V_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_f4v"
"FLV_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_flash"
"AVI_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_avi"
"WMV_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_wmv"
"MP4_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_mpeg4"
"MPG_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_mpg"
"MXF_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_mxf"
"3GP_EXPORT_CLIP_TRANSCODE_JOB"="otmm_export_mobile"
Also, for both Windows and Linux, note the following under the VIDEO
\TRANSCODE component, which belongs to the VIDEO configuration group:
"AUDIO_BASE_URL"="http://IIS_Server/IIS_App"
"VIDEO_BASE_URL"="http://IIS_Server/ IIS_App"
Note: The Video group is accessible from the Settings page in the Web
Administration tool. For more information about editing component settings,
see section 2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
WINDOWS
"VIDEO_FILE_STAGING_AREA"="\\TranscodeSrv\video_staging"
LINUX
"VIDEO_FILE_STAGING_AREA"="/usr/local/mount_point/video_staging"
"VIDEO_FILE_STAGING_AREA"="\\VantageSrv\staging_area"
Notes
• The VIDEO_FILE_STAGING_AREA setting is located under the CONTENT
\CONFIG component, which belongs to the General configuration group.
This group is accessible from the Settings page in the Web Administration
tool. For more information about how to edit settings, see section 2.13.2.3
“Editing a component and properties” in OpenText Media Management -
Administration Guide (MEDMGT160200-AGD).
• In Vantage, the transcode working file directory has to be configured in the
Vantage server factory product destination and must be a network UNC
path.
"VIDEO_FILE_STAGING_AREA"="/usr/local/share/staging_area"
"WORKING_PATH"="/usr/local/share/staging_area"
"UNC_REPOSITORY"="\\VantageSrv\staging_area"
Notes
• The VIDEO_FILE_STAGING_AREA setting is located under the CONTENT
\CONFIG component, which belongs to the General configuration group.
This group is accessible from the Settings page in the Web Administration
tool. For more information about how to edit settings, see section 2.13.2.3
“Editing a component and properties” in OpenText Media Management -
Administration Guide (MEDMGT160200-AGD).
• The UNC_REPOSITORY and WORKING_PATH settings are located under the
VIDEO\TRANSCODE component, which belongs to the Video
configuration group. For more information about how to edit settings, see
section 2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
• In Vantage, the transcode working file directory has to be configured in the
factory product destination of the Vantage server and must be in the
network UNC path:
"UNIX_VIDEO_WORKING_AREA_UNC" = "\\VantageSrv\transcode_wf\"
1. Install FFmpeg.
2. Integrate Media Management with FFmpeg.
3. Run the FFmpeg transcoder.
To install FFmpeg:
2. Extract the downloaded static builds to the server where you want FFmpeg to
run.
3. Include the folder’s path that contains executable files from the extracted
location in operating system user’s PATH environment variable.
WINDOWS
An old version of ffmpeg.exe is available in the ImageMagick
installation directory. Rename ffmpeg.exe to _ffmpeg.exe in the
ImageMagick installation directory to use the latest version of the file.
LINUX
Edit the ${TEAMS_HOME}/bin/artesia-process-manager-wrapper-
unix.conf service configuration file to append the location of FFmpeg
in PATH_TO_CUSTOM_EXECUTABLES. You must do this as a separate task
in addition to editing the PATH environment variable to append the
FFmpeg location.
WINDOWS
Open a new command prompt, and run the following:
ffmpeg.exe
UNIX
On a terminal, run the following:
ffmpeg
You can use these settings after performing the configurations described in this
section.
For Media Management APIs to interact with FFmpeg, configure the settings under
the VIDEO\TRANSCODE component. This component belongs to the Video
configuration group, which is accessible from the Settings page in the Web
Administration tool. For more information about components, see section 2.13.2.3
“Editing a component and properties” in OpenText Media Management -
Administration Guide (MEDMGT160200-AGD).
Note: When you use the same OTMM server for multiple OTMM
servers, you must user different target paths for
each OTMM server.
Specify list of servers along with port where FFmpeg is
running externally.
# "TRANSCODE_HOST"="SERVER1:port1, SERVER2:port2"
"VIDEO_TRANSCODE_JOB"="-loglevel warning -y -i
OTMM__INPUT__FILE -r 1/10 -s 500x376 -f image2
OTMM__OUTPUT__FILE%4d.jpg -s 640x352 -aspect 16:9 -r 29.97 -
b:v 8000000 -b:a 96000 -ar 48000 MEDIA_TRIM_SETTINGS
OTMM__OUTPUT__FILE.mp4"
"PROXY_VIDEO_TRANSCODE_JOB"="-loglevel warning -y -i
OTMM__INPUT__FILE -s 640x352 -aspect 16:9 -r 29.97 -b:v
8000000 -b:a 96000 -ar 48000 -ac 2 MEDIA_TRIM_SETTINGS
OTMM__OUTPUT__FILE.mp4"
#The following additional settings are part of the optional
export
transformers which are installed separately
"EXPORT_VIDEO_TRANSCODE_JOB"="-loglevel warning -y -i
OTMM__INPUT__FILE -s 640x352 -aspect 16:9 -r 29.97 -b:v
"DEFAULT_EXPORT_CLIP_TRANSCODE_JOB"="-loglevel warning -y -i
OTMM__INPUT__FILE -s 640x352 -aspect 16:9 -r 29.97 -b:v
8000000 -b:a 96000 -ar 48000 -ac 2 MEDIA_TRIM_SETTINGS
OTMM__OUTPUT__FILE.mp4"
"MOV_EXPORT_CLIP_TRANSCODE_JOB"="-loglevel warning -y -i
OTMM__INPUT__FILE -s 720x480 -r 29.97 -b:a 64000 -ar 44100 -
ac 2 MEDIA_TRIM_SETTINGS OTMM__OUTPUT__FILE.mov"
"F4V_EXPORT_CLIP_TRANSCODE_JOB"="-loglevel warning -y -i
OTMM__INPUT__FILE -s 640x352 -aspect 4:3 -r 29.97 -b:v 128000
-b:a 96000 -ar 48000 -ac 1 MEDIA_TRIM_SETTINGS
OTMM__OUTPUT__FILE.f4v"
"FLV_EXPORT_CLIP_TRANSCODE_JOB"="-loglevel warning -y -i
OTMM__INPUT__FILE -s 640x480 -aspect 16:9 -r 30 -b:v 3000000 -
b:a 96000 -ar 44100 MEDIA_TRIM_SETTINGS
OTMM__OUTPUT__FILE.flv"
"AVI_EXPORT_CLIP_TRANSCODE_JOB"="-loglevel warning -y -i
OTMM__INPUT__FILE -s 320x240 -r 15 -ar 48000 -ac 1
MEDIA_TRIM_SETTINGS OTMM__OUTPUT__FILE.avi"
"WMV_EXPORT_CLIP_TRANSCODE_JOB"="-loglevel warning -y -i
OTMM__INPUT__FILE -s 640x480 -aspect 1 -r 30 -b:v 1000000 -
b:a 5000 -ar 8000 -ac 1 MEDIA_TRIM_SETTINGS
OTMM__OUTPUT__FILE.wmv"
"MP4_EXPORT_CLIP_TRANSCODE_JOB"="-loglevel warning -y -i
Notes
• For both Windows and Linux, note the following settings under the
CONTENT\CONFIG component, which belongs to the General
configuration group:
WINDOWS
"VIDEO_FILE_STAGING_AREA"="\\TranscodeSrv\video_staging"
LINUX
"VIDEO_FILE_STAGING_AREA"="/usr/local/mount_point/
video_staging"
• The FFmpeg settings use templates, such as OTMM__OUTPUT__FILE%4d,
OTMM__OUTPUT__FILE, OTMM__INPUT__FILE, and MEDIA_TRIM_SETTINGS,
that will be replaced at runtime before submitting a job to FFmpeg.
OpenText recommends that you do not edit these templates, as it will result
in errors.
• For the value of the VIDEO_TRANSCODE_JOB setting, do not change the order
of keyframe generation and proxy generation. Also, for keyframe generation,
do not add any FFmpeg command line options after the -f option. That is,
'-f image2 OTMM__OUTPUT__FILE%4d.jpg' must always be together.
• You must update the staging area using the VIDEO_FILE_STAGING_AREA setting.
For more information, see Example 9-11, “Windows video staging configuration”
on page 126 and Example 9-12, “Linux video staging configuration”
on page 126. This setting is located under the CONTENT\CONFIG 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
section 2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
The following are sample video staging configurations for Windows and Linux.
/FFMPEG/ffmpeg_config.txt
You can install the FFmpeg Transcode service using the following methods:
For more information, see “Installing FFmpeg Transcoder service using the
setup screens” on page 128.
Console
A text-based mode where parameters are read from your configuration file,
ffmpeg_config.txt. You cannot change these values during the installation
process. This mode requires your intervention to proceed to subsequent steps.
Note: Prior to launching the installer, you must specify the values of the
installation parameters in the ffmpeg_config.txt file. This file is
mandatory if you are installing using console mode.
For more information, see “Installing FFmpeg Transcoder service using the
console” on page 130.
Silent
A text-based mode where parameters are read from your configuration file,
ffmpeg_config.txt. You cannot modify values during the installation process.
This mode requires no user interaction.
Note: Prior to launching the installer, you must specify the values of the
installation parameters in the ffmpeg_config.txt configuration file. The
configuration file is mandatory if you are installing using silent mode.
For more information, see “Installing FFmpeg Transcoder service silently”
on page 131.
Operating Systems
• Windows Server
• Linux
• CentOs
Databases
• Oracle
• SQL Server
• PostgreSQL
Database
The FFmpeg Transcode service installation requires a separate database and a
pre-configured database user. This user must have permissions to create tables,
triggers and views. Ensure that you are able to sign in using this database user.
Notes
Java
You must install the JRE on the remote server and set the Java executable in the
path of the user who is running the utility. For more information, see OpenText
Media Management Technical Specifications (https://knowledge.opentext.com/
knowledge/cs.dll/Properties/66025283).
Note: To use GUI mode on Linux, you need an X-Windows interface. You need
to set DISPLAY in your environment and have an X-Windows server running
on your local computer. For example, if you have connected to the Linux server
from your Windows computer, you need to have software such as OpenText™
Exceed™ TurboX (ETX) installed and running. Be sure to set your DISPLAY in
your Linux environment prior to running the installation. For example:
where
1. Mount the appropriate platform specific Media Management ISO on the system
where you want to install the FFmpeg Transcode service.
Windows
mediamgmt_16.2_windows.iso
Linux
mediamgmt_16.2_linux.iso
WINDOWS
<Mounted location>\FFMPEG>Disk1\InstData\VM\install.exe -i gui
-f <PATH_TO_ffmpeg_config.txt>
LINUX
<Mounted location>/FFMPEG>/Disk1/InstData/VM/install.bin -i gui
-f <PATH_TO_ffmpeg_config.txt>
where
-i specifies the mode of installation to be launched. The default mode is GUI, if
no mode is passed. The GUI mode launches the setup screens.
-f specifies the configuration file that is used to provide pre-populated values
during the install procedure. The configuration file is optional in this
installation mode.
Note: If you are using the configuration file, you must use the fully-
qualified path name for the configuration file. For example:
G:\FFMPEG\Disk1\InstData\VM\install.exe -i gui -f c:
\ffmpeg_config.txt
4. On the License Agreement page, click I accept the terms of the License
Agreement, and then click Agree.
5. On the Choose Install Folder page, provide the location were you want to
install the FFmpeg Transcode service.
6. On the Choose Install set page, for a typical install, select the Schema and
Install FFmpeg Transcode Service check boxes to install the database schema
and the FFmpeg Transcode service, which provides the minimal software to
start the FFmpeg Transcode service.
• Immediate
Terminates the FFmpeg Transcode service process when you stop the
FFmpeg Transcode service.
• Complete
Waits for all the running Transcode jobs to complete and then shuts down
when you stop the FFmpeg Transcode service.
Notes
• If any errors occur during the install, see the logs files in <FFMPEG_HOME>
\logs\installation location.
• After a successful installation, the Complete page appears. Click Done,
and then restart the system manually.
Note: Prior to launching the installer, you must specify the values of the
installation parameters in the ffmpeg_config.txt configuration file.
1. Mount the appropriate platform specific Media Management ISO on the system
where you want to install the FFmpeg Transcode service.
WINDOWS
mediamgmt_16.2_windows.iso
LINUX
mediamgmt_16.2_linux.iso
WINDOWS
<Mounted location>\FFMPEG>Disk1\InstData\VM\install.exe -i
console -f <PATH_TO_ffmpeg_config.txt>
LINUX
<Mounted location>/FFMPEG>Disk1/InstData/VM/install.bin -i
console -f <PATH_TO_ffmpeg_config.txt>
where
-i specifies the mode of installation to be launched.
Note: You must use the fully-qualified path name for the configuration
file. For example:
G:\FFMPEG\Disk1\InstData\VM\install.exe -i console -f c:
\ffmpeg_config.txt
Notes
• If any errors occur during the install, see the logs files in <FFMPEG_HOME>
\logs\installation location.
• Restart the system manually.
Note: Prior to launching the installer, you must specify the values of the
installation parameters in the ffmpeg_config.txt configuration file.
1. Mount the appropriate platform specific Media Management ISO on the system
where you want to install the FFmpeg Transcode service.
WINDOWS
mediamgmt_16.2_windows.iso
LINUX
mediamgmt_16.2_linux.iso
WINDOWS
<Mounted location>\FFMEG>Disk1\InstData\VM\install.exe -i
silent -f <PATH_TO_ffmpeg_config.txt>
LINUX
<Mounted location>/FFMPEG>Disk1/InstData/VM/install.bin -i
silent -f <PATH_TO_ffmpeg_config.txt>
where
-i specifies the mode of installation to be launched.
Note: You must use the fully-qualified path name for the configuration
file. For example:
G:\FFMPEG\Disk1\InstData\VM\install.exe -i silent -f c:
\ffmpeg_config.txt
Notes
• If any errors occur during the install, see the logs files in <FFMPEG_HOME>
\logs\installation location.
• Restart the system manually.
WINDOWS
Start the FFmpegTranscodeService.
LINUX
ffmpegService start
Note: You can find the generated log file in the <FFMPEG_HOME> directory.
WINDOWS
Tip: You can also use the Control Panel to uninstall the
FFmpegTranscoder from the list of applications installed on the
server.
LINUX
Sign in as the FFmpeg installed user, navigate to $FFMPEG_HOME/
UninstallFFmpegTranscoder, and the run the following command:
./Uninstall\ FFmpegTranscoder
2. Click Uninstall.
3. Click Done.
<FILE_EXTENSION>_EXPORT_CLIP_TRANSCODE_JOB
For example, while exporting a MP4 (FILE_EXTENSION) video clip asset, it uses the
factory/preset that is configured under following entry for output video clip:
"MOV_EXPORT_CLIP_TRANSCODE_JOB"
"F4V_EXPORT_CLIP_TRANSCODE_JOB"
"FLV_EXPORT_CLIP_TRANSCODE_JOB"
"AVI_EXPORT_CLIP_TRANSCODE_JOB"
"WMV_EXPORT_CLIP_TRANSCODE_JOB"
"MP4_EXPORT_CLIP_TRANSCODE_JOB"
"MPG_EXPORT_CLIP_TRANSCODE_JOB"
"MXF_EXPORT_CLIP_TRANSCODE_JOB"
"3GP_EXPORT_CLIP_TRANSCODE_JOB"
If any clip asset parent extension is not configured under the VIDEO\TRANSCODE
component which belongs to the VIDEO configuration group, then the following
default setting is used to submit a video transcode job, which generates output
based on the default factory/preset under it.
"DEFAULT_EXPORT_CLIP_TRANSCODE_JOB"
Notes
• The DEFAULT_EXPORT_CLIP_TRANSCODE_JOB setting is located under the
VIDEO\TRANSCODE component, which belongs to the VIDEO
configuration group. This group is accessible from the Settings page in the
Web Administration tool. For more information about how to edit settings,
see section 2.13.2.3 “Editing a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
• This is specific to video clip assets only. The default value is configured for
MP4, but can be changed to any format.
1. Install IIS.
7. Click Add and enter the MIME types for the various list of file name extensions
and associated content types that are served as static files by the web server.
Note: The Video group is accessible from the Settings page in the Web
Administration tool. For more information about how to edit the settings
of a component, see section 2.13.2.3 “Editing a component and properties”
in OpenText Media Management - Administration Guide (MEDMGT160200-
AGD).
Note: For more information about versions, see OpenText Media Management
Technical Specifications (https://knowledge.opentext.com/knowledge/cs.dll/
Properties/66025283).
Note: The shared folder should be accessible from the Wowza Server. The
User Account Log on options of the Wowza services can be updated with
details of a user who has access to the otmm repository shared folder.
5. Restart the Wowza Streaming Engine 4.0.1 and Wowza Streaming Engine
Manager 4.0.1 services.
6. On the Media Management server, edit the following settings which are located
under the VIDEO\TRANSCODE component, which belongs to the Video
configuration group:
"VIDEO_BASE_URL"="rtmp://<Wowza server name>:<port number>/
<application>/_definst_/mp4:"
"AUDIO_BASE_URL"="rtmp://<Wowza server name>:<port number>/
<application>/_definst_/mp3:"
Notes
• The Video group is accessible from the Settings page in the Web
Administration tool. For more information about how to edit the
To enable Apache:
1. Check if Apache is installed by issuing the following command as the root user:
rpm –qa | grep -i http
Notes
"AUDIO_BASE_URL"=" http://servername/linkname"
• The Video group is accessible from the Settings page in the Web
Administration tool. For more information about how to edit the
settings of a component, see section 2.13.2.3 “Editing a component and
properties” in OpenText Media Management - Administration Guide
(MEDMGT160200-AGD).
You may use an existing installation or download the Adobe Media Server from:
http://www.adobe.com/products/adobe-media-server-standard.html
A suitable license is needed depending on your needs. The options are explained on
the website.
You may install AMS on the same host as Media Management or on a separate host.
AMS hosted on the application server enables a dedicated AMS with faster access to
the media.
To install AMS:
1. Follow the instructions for the appropriate Installer and set up AMS.
2. Select the default ports for Adobe Media Server , 1935, and HTTP Proxy, 8134.
Accept the Apache install option to enable HTTP delivery.
Notes
Note: To avoid port conflicts, do not run AMS on the same server as IIS or
Apache unless AMS runs on a separate port.
Note: These instructions represent the simplest configurations for a quick start.
For more complex configurations, see the Adobe Media Server documentation.
Note: The Apache HTTP service should be started with a user who has
administrative privileges and has access to TEAMS_REPOSITORY_HOME.
You must create a common Windows user, fmsuser on both Media Management
server and AMS with permissions to play files from the repository folder.
Note: Both the AMS service and the AMS administrative service must be set
up with the shared user as the “Log on” user.
1. Run lusrmgr.msc to create fmsuser with the name of the AMS user on AMS
server.
2. Click Server Manager > Configuration > Services > Adobe Media Server >
properties. Change the log on user ID to fmsuser.
3. Run lusrmgr.msc to create fmsuser with the name AMS user on the Media
Management server. Make sure the passwords match and are correctly set.
4. Click Repository > properties and then add fmsuser as a user and in the Share
and Security tabs and grant at least read permissions.
5. Restart Adobe Media Server. You can also restart Adobe Media Administration
Server with the same user credentials.
9.7.4.4 Setting up the base URL for the AMS streaming server
To set up the base URL for AMS streaming server, you must edit the values of the
following settings:
HTTP proxying is enabled by default and is configured to local port 8134. AMS
normally listens for RTMPT connections on port 80, which is the default port for
HTTP connections. If a RTMPT request is blocked (for example, by firewall rules) or
AMS receives an unknown request through the tunneling port, AMS will forward
the request across the configured proxy port. For more information about HTTP
Proxy configuration parameters, see the Adobe online documentation:
http://kb2.adobe.com/cps/408/kb408205.html
For more information about administering and configuring Adobe Media Server ,
see https://helpx.adobe.com/adobe-media-server/config-admin/topics.html.
For more information about configuration security features, see the Adobe Media
Server Configuration and Administration documentation on the Adobe website.
Image Conversions
These conversions may be used when exporting images to convert them to
specific formats and sizes. For more information about image transformer
settings, see OpenText Media Management - Integration Guide (MEDMGT160200-
AIN).
Video Conversions
These conversions may be used when exporting videos to convert them to
specific formats. For more information about video conversion settings, see
OpenText Media Management - Integration Guide (MEDMGT160200-AIN). For
information on optional video configurations, see “Optional video
configurations” on page 141.
1. You can install the optional image transformers by running this command from
the <TEAMS_HOME>/install/ant directory:
ant install-image-transformers
2. If you need to remove any of the installed transformers, delete the entries for
the installed transformers from the following tables in the order specified:
a. EXPORT_TRANS_CONTENT_TYPE_MAP
b. TRANSFORMER_INSTANCES
c. TRANSFORMER_ATTRIBUTES
d. TRANSFORMERS
2. If you need to remove any of the installed transformers, delete the entries for
the installed transformers from the following tables in the order specified:
1. EXPORT_TRANS_CONTENT_TYPE_MAP
2. TRANSFORMER_INSTANCES
3. TRANSFORMER_ATTRIBUTES
4. TRANSFORMERS
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.
1. Click Windows Start Menu > All Programs > Administrative Tools > Services.
3. Click Start. If Media Management and the database are on different servers, you
can configure Media Management to start automatically.
Tips
• To stop the Media Management server, run the following command:
mediamanagement-process-manager stop
1. Select Windows Start Menu > Programs > Administrative Tools > Services.
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
The Media Management 16.2 upgrade supports upgrade installations from Media
Management versions 10.5 or 16.
This chapter provides upgrade instructions for Windows and Linux upgrades.
Notes
• Media Management 16.2 no longer requires OpenText™ Enterprise Process
Services (EPS). You can uninstall EPS, unless you require it for other
purposes.
• Any custom process that you developed using Enterprise Process Services
must be migrated to Spring Batch® jobs. For more information, see OpenText
Media Management - Integration Guide (MEDMGT160200-AIN).
• Creative Reviews have become Reviews and Approval Tasks within a Job.
During the upgrade to Media Management 16.2, each existing Creative
Review is converted to a new Job that contains a Review or Approval Task
for each Review Participant.
Important
The new Jobs Collaboration does not have the user roles None or Viewer.
The conversion will not create a Task for any user who was assigned the role
None or Viewer in an existing Creative Review in a previous version of
OTMM. Hence, users who were assigned these roles will be removed from a
new and equivalent Collaboration Job.
The upgrade program is delivered on the Media Management ISO and guides you
through the upgrade of the schema and application.
WINDOWS
Stop the OpenText Media Manager service.
LINUX
Run the following command:
mediamanagement-process-manager stop
• <TEAMS_HOME>
Important
Take special care to back up the servers folder where the OTDS
sign-in information is stored. The license files are also stored in this
location.
• Your database.
• Any customizations and configurations you have deployed in OTMM.
3. Back up all your customization configurations performed in OTMM. You may
need to reapply the configurations and redeploy the customizations when the
upgrade is completed.
Notes
• OTDS is supported on the Solaris platform. It is not a requirement to
migrate these products to the Linux platform.
Important
The following information is applicable only if you are upgrading from
OTMM version 10.5 to version 16.2.
• Note all of the custom components and system settings under custom
components added in Tresource file. The description for custom
components and settings will not be preserved during upgrade. You will
need to add these descriptions manually on the Setting page in the Web
Administration tool after the upgrade is complete. For more information,
see section 2.13.2.1 “Adding a component and properties” in OpenText
Media Management - Administration Guide (MEDMGT160200-AGD).
• Note all of the custom settings that you added under the pre-configured
components included with OTMM. You will need to add these custom
settings manually through the Setting page in the Web Administration
tool after the upgrade is complete. For more information, see section
2.13.2.1 “Adding a component and properties” in OpenText Media
Management - Administration Guide (MEDMGT160200-AGD).
• Click JBoss EAP and enter the location of the JBoss home directory.
• WildFly and enter the location of the WildFly home directory.
5. On the Execution Type page, click Upgrade, and then click Next.
6. On the Choose Product Features page, for a typical upgrade, select the Schema
and Application check boxes to upgrade the schema and application, providing
the minimal software to start the Media Management application after
installation.
Important
If the selected database is SQL Server, then you must provide the correct
port number. For example, the port number of the default instance or
named instance on which the Media Management database will be
created.
Notes
• Make sure to supply the same Media Management database user
credentials that are set for the current installation. These values will not
Notes
• If any errors occur during the upgrade, see section 12.2.5 “Continuing
after upgrade errors” in OpenText Media Management - Installation Guide
(MEDMGT160200-IGD).
• After a successful upgrade, the Complete page appears. When the
upgrade is complete, you are prompted to restart the system. If you do
not restart the system, the application may not work or behave as
expected.
Note: To use GUI mode on Linux, you need an X-Windows interface. You need
to set DISPLAY in your environment and have an X-Windows server running
on your local computer. For example, if you have connected to the Linux server
from your Windows computer, you need to have software such as OpenText™
Exceed™ TurboX (ETX) installed and running. Be sure to set your DISPLAY in
your Linux environment prior to running the installation. For example:
where
<ISOPATH>/OTMM/Disk1/InstData/NoVM/install.sh
3. On the License Agreement page, if you agree with the terms, select I accept the
terms of the License Agreement, and click Next.
4. On the Java/App Server Configuration page, do the following, and then click
Next:
• Click JBoss EAP and enter the location of the JBoss home directory.
5. On the Execution Type page, click Upgrade, and then click Next.
6. On the Choose Product Features page, for a typical upgrade, select the Schema
and Application check boxes to upgrade the schema and application, providing
the minimal software to start the Media Management application after
installation.
Notes
Notes
• If any errors occur during the upgrade, see section 12.2.5 “Continuing
after upgrade errors” in OpenText Media Management - Installation Guide
(MEDMGT160200-IGD).
• After a successful upgrade, sign out, and then sign in using the Linux
user account that was used to install Media Management.
1. Copy the mediamanagment_config.txt file to a local folder and edit the file to
match the version 16.2 installation values.
Tip: You can find the current values can be found in the following
locations:
• <TEAMS_HOME>/install/ant/build.cfg file
Notes
• Because you are upgrading, you are not required to update the OTDS
configuration and video configuration settings in the
mediamanagement_config.txt file.
In the DATABASE SELECTION settings, set the values of the following
settings to 0 or leave them empty:
• Oracle - CREATE_TABLE_SPACE
• Postgres - CREATE_POSTGRESQL_TABLE_SPACE
WINDOWS
<ISOPATH>/OTMM/Disk1/InstData/NoVM/install.bat -i console -f
<FULL_PATH_TO>/mediamanagement_config.txt
LINUX
<ISOPATH>/OTMM/Disk1/InstData/NoVM/install.sh -i console -f
<FULL_PATH_TO>/mediamanagement_config.txt
1. Copy the mediamanagment_config.txt file to a local folder and edit the file to
match the 16.2 installation values.
Notes
• Because you are upgrading, you are not required to update the OTDS
configuration and video configuration settings in the
mediamanagement_config.txt file.
In the DATABASE SELECTION settings, set the values of the following
settings to 0 or leave them empty:
• Oracle - CREATE_TABLE_SPACE
• Postgres - CREATE_POSTGRESQL_TABLE_SPACE
2. Mount the appropriate platform specific Media Management ISO,
mediamgmt_16.2_windows.iso or mediamgmt_16.2_linux.iso.
WINDOWS
<ISOPATH>/OTMM/Disk1/InstData/NoVM/install.bat -i silent -f
<FULL_PATH_TO>/mediamanagement_config.txt
LINUX
<ISOPATH>/OTMM/Disk1/InstData/NoVM/install.sh -i silent -f
<FULL_PATH_TO>/mediamanagement_config.txt
WINDOWS
Restart the system.
LINUX
Sign out, and then sign in using the Linux user account that was used to
install Media Management.
During the upgrade, the schema is validated to find any schema conflicts between
the two instances. If conflicts are found during the schema validation, the upgrade
process will report an error and stop. There are other reasons that the upgrade
process may fail.
1. Determine the upgrade error. If any errors occur during the upgrade, review the
following files to determine the reason for the failure:
• <TEAMS_HOME>/logs/installation/upgradeValidation.log
• <TEAMS_HOME>/MediaManagement_InstallLog.log
• <TEAMS_HOME>/logs/installation/upgradeValidator.log
• <TEAMS_HOME>/ddl_install/log/upgrade_schema.log
• <TEAMS_HOME>/ddl_install/log/UnicodeUpgrade.sql.log
Note: This LOG file will only be created for the SQL Server database.
2. If any errors occur while upgrading the schema, see the <TEAMS_HOME>/
ddl_install/log/upgrade_schema.log file for a list of problems.
4. Resolve any upgrade issues that were identified before running the upgrade
again.
Note: The following sections are applicable only if you are upgrading from
version 10.5:
• “Updating custom system settings and custom components” on page 156
• “Configuring JBoss after upgrading” on page 156
• “ Updating Provider_HOST after upgrading” on page 157
• “Updating saved search conditions” on page 159
If you have any custom system settings that were added the pre-configured
components included with OTMM, those system settings will not be listed in system
settings in Web Administration tool. You need to add them manually to the user
interface. For more information about adding system settings, see section 2.13.2.1
“Adding a component and properties” in OpenText Media Management -
Administration Guide (MEDMGT160200-AGD).
Additionally, if you have custom settings and components, descriptions will not be
added by default. You need to add descriptions manually through the Web
Administration tool. For more information about editing system settings, see section
2.13.2.3 “Editing a component and properties” in OpenText Media Management -
Administration Guide (MEDMGT160200-AGD).
After upgrading Media Management, you must configure JBoss. For more
information, see “Configuring JBoss” on page 70.
After upgrading, update the value of the PROVIDER_HOST property value in the
[JNDI\CONFIG] section of the Tresource file. For more information, see “Updating
PROVIDER_HOST” on page 72.
• Delete the tmp and data folders from the %JBOSS_HOME%\standalone location
before you start the OpenText Media Manager service.
Categories were replaced by Folders. You can use a utility to perform a one-time
migration of all Categories to the Folder hierarchy of OTMM and migrate the assets
to the specific folders. This utility that performs the migration is an Ant target,
migrate-category-to-folder.
Notes
Before running the utility, you must configure the teams.properties file.
Note: The migration utility prompts you for the teams.password. Use the
password of the OTMM user with administrator privileges who is running the
utility.
This section is applicable only if you are upgrading from version 10.5.
Notes
• This utility might take long time, depending upon the number of
records in the system.
• The <TEAMS_HOME>/logs/installation/UpdateSavedSearches.log
is created. Use this LOG file to verify that the process ran successfully.
• In the Web Administration tool, set the TARGET_PATH system setting to a shared
network path for the video or audio Transcode server where the Transcode
output file will be written. For example:
TARGET_PATH="\\<transcode server host>\<transcode_working_folder>"
Note: For more information about versions, see OpenText Media Management
Technical Specifications (https://knowledge.opentext.com/knowledge/cs.dll/
Properties/66025283).
Note: Perform the following steps on all the cluster nodes individually.
Note: Perform the following steps on all the cluster nodes individually. You
must have root privileges to install the RPM packages.
a. libzen0-0.4.31-1.x86_64.RHEL_6.rpm
Tip: To run the above using the rpm -ivh <packagename> command,
enter the following:
rpm -ivh libzen0-0.4.31-1.x86_64.RHEL_6.rpm
b. libmediainfo0-0.7.76-1.x86_64.RHEL_6.rpm
c. mediainfo-0.7.76-1.x86_64.RHEL_6.rpm
Note: Prior to updating the video configuration, verify that there are no active
jobs running on the Vantage server.
5. Replace all occurrences of the string $OTMM_HOST_NAME$ with the OTMM server
details. This can be the name or IP of the OTMM node or load balancer. The
host that you configure must be accessible from the Vantage server.
6. Replace all the occurrences of $OTMM_HTTP_PORT$ with the HTTP port where
you configured the OTMM server. In the case of a single node, the default value
is 11090.
Notes
• If you configured a load balancer or proxy, specify the port as the HTTP
port on which the load balancer or proxy is running. The OTMM host
name and HTTP port configured in Step 5 and Step 6 are used to make
web service notifications after a transcode job is executed on the
Vantage server.
• Ensure that the OTMM host you configured in Step 5 is accessible from
the Vantage server over the HTTP port configured in Step 6.
Note: This deletes all the old jobs belonging to these workflows.
• otmm_import_audio
• otmm_import_proxy
• otmm_import_default
9. Click File > Batch Workflow Operations, and then select the following
workflows that associated with the category in Step 8:
otmm_import_audio
otmm_import_proxy
otmm_import_default
If you are installing a new version of FFmpeg, see “Configuring video using
FFmpeg” on page 121.
1. 1. Stop Tomcat.
5. Restart Tomcat.
WINDOWS
Stop the OpenText Indexer service from the Services menu.
LINUX
Run the following command:
<TEAMS_HOME>/bin/indexer-process-manager stop
WINDOWS
Start the OpenText Indexer service from the Services menu.
LINUX
Run the following command:
<TEAMS_HOME>/bin/indexer-process-manager start
• schema-no-suggestions.xml
• unicode-schema-no-suggestions.xml
• schema.xml
• unicode-schema.xml
• whitespace-schema.xml
WINDOWS
Stop the OpenText Indexer service from the Services menu.
LINUX
Run the following command:
<TEAMS_HOME>/bin/indexer-process-manager stop
WINDOWS
Start the OpenText Indexer service from the Services menu.
LINUX
Run the following command:
<TEAMS_HOME>/bin/indexer-process-manager start
The section provides information about upgrading the FFmpeg Transcoder service
in multi-tenanat environment or externally.
WINDOWS
Stop the FFmpeg Transcoder service.
LINUX
Run the following command:
ffmpegService stop
WINDOWS
At the command prompt, change to the <TEAMS_HOME>/install/ant
folder, and then run the following command:
ant build-ffmpeg-external-transcoder
LINUX
On a terminal on an OTMM server, navigate to <TEAMS_HOME>/install/
ant, and then run the following Ant target:
ant build-ffmpeg-external-transcoder
WINDOWS
Start the FFmpeg Transcoder service.
LINUX
Run the following command:
ffmpegService start
Note: If you performed a reindex of Solr, you need to wait until the reindex is
complete before verifying that search is working.
After you installed the application, optional components, and service pack, and you
stared the application, you need to verify the installation.
1. Open the web browser and enter the URL of the OTMM Web Client. For
example:
http://localhost:11090/otmm (http://localhost:11090/mediamanager)
2. Sign in to the Media Management client using the accounts set up.
3. Test the install by performing some basic tasks, such as the following
• Import assets
• Export assets
• Search for assets
• Add a folder
For a complete list of marker files, see the following JBoss documentation: https://
access.redhat.com/site/documentation/en-US/
JBoss_Enterprise_Application_Platform/6.4/html/
Administration_and_Configuration_Guide/index.html
Each of the marker files are prefixed with the deployment package name. For Media
Management, it is artesia.ear. The .dodeploy marker is an instruction to the
application server to deploy the application package. The rest indicate the
deployment states for the application package.
If for some reason, the deployment fails, you will find the <TEAMS_HOME>/ear/
artesia.ear.failed marker file.
To re-deploy the package after undertaking any corrections, rename the artesia.
ear.failed marker file to artesia.ear.dodeploy. To verify if the deployment was
successful, ensure that you have the artesia.ear.deployed marker file in the
<TEAMS_HOME>/ear directory.
4. Using the OTDS Web Client, edit the OTMM resource and verify that the Push
Connector is configured.
5. Verify the date on the OTMM and OTDS server are synchronized.
6. On the OTMM server, verify the OTDS sign-in information by doing the
following:
1. Verify that the property template was created. For more information, see
“Creating Property Templates” on page 76.
1. Verify that the Solr server is running by entering its URL in a web browser.
The format is: http://<solr_hostname>:8983/solr.
Note: If any of the above steps fail, Solr is not configured correctly.
Check you configuration.
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.
7. Encrypt the new password file using the following Ant task:
ant encrypt-indexer-login
Indexing fails. The Indexer log reports that it is unable to communicate with
OTMM.
4. To test this, use the Solr URL to query the Solr index directly. The format of
the Solr URL is: http://<solr_hostname>:8983/solr.
Indexing fails. The Indexer log reports that it is unable to communicate with Solr.
1. Check the Solr configuration to verify that location of the index is correct.
4. To test this, use the Solr URL to query the Solr index directly.
1. Verify that the transcode host is configured properly and that the port is not
blocked by a firewall.
2. Verify that all shared folders are configured as required for OTMM.
Notes
• OTMM and the Transcode server must share files. If the permissions
are not set correctly on the shared folders, transcode fails.
• If the shared folders are not configured correctly, transcode fails.
Vantage
If you are using Vantage, do the following:
1. Verify that the transcode host and transcode category are configured
properly.
3. Verify that all shared folders are configured as required for OTMM.
Notes
• OTMM and the Transcode server must share files. If the permissions
are not set correctly on the shared folders, transcode fails.
• If the shared folders are not configured correctly, transcode fails.
FFmpeg
If you are using FFmpeg, do the following:
2. Verify that the FFmpeg and/or MediaInfo executables are available in a user
path.
3. Verify that all shared folders are configured as required for OTMM.
Notes
• OTMM and the Transcode server must share files. If the permissions
are not set correctly on the shared folders, transcode fails.
• If the shared folders are not configured correctly, transcode fails.
13.1.6 Analytics
Analytics reports and dashboards are not working. com.artesia.analytics
errors in the application server log.
Analytics reports and dashboards are not working. Data is not being imported
to the Data Collector CSV files for the tenant ID.
1. Verify the Data Agent configuration through the Analytics page in the Web
Administration tool.
2. Verify that the Data Collector server is running on the configured host and
port location.
3. Verify that the iHub console URL is valid. Test this by signing in directly to
the iHub console using a web browser.
4. Verify that the OTMM report and dashboard paths are valid in iHub.
• Verify that the Adaptive Media Delivery server is running. Check the URL
using the following format:
<protocol>://<deliveryserver_host>:<port> /adaptivemedia/
<ping_from_OTMM_server>.
• Verify that the Spicer executable is available in a user path. Complete the
Spicer transformer install step.
For Windows, verify that the Spicer executable file is available in the user path. If it
is already available in the user path, verify that Microsoft Visual C++ Redistributable
for Visual Studio 2012 is installed. This should be automatically installed as part of
installation. If it is not installed, you can install it from the <TEAMS_HOME>\install\
vcredist folder. When you double-click the EXE installation file, you are presented
with the repair and uninstall options, if it is already installed.
2. Verify that the OTMM repository is accessible to the Adobe Media Server.
This chapter defines High Availability (HA) and how the Media Management
application can be configured to best support highly available needs. It does not
define a service level agreement between Media Management and the customer.
Instead, it helps the customer understand the architecture of Media Management
solutions in relation to a highly available environment.
Note: Instructions are provided for both Windows and Linux. When specific
examples are given, if you are on Linux and the Windows syntax is used, you
need to replace the <TEAMS_HOME> in the Windows syntax with your value,
$TEAMS_HOME, and replace the backward slashes with forward slashes. If you
are on Windows and the Linux syntax is used, you need to replace the
TEAMS_HOME in the Linux syntax with your value, $TEAMS_HOME, and replace
the forward slashes with backward slashes.
As described by Microsoft, HA does not provide for 100 percent availability 100
percent of the time. The goal of HA is to ensure the application is available as much
as possible within the means of the application, hardware, and hosting systems
capabilities.
The following sections detail each of the processes along with an explanation of
which HA options are available if the system becomes unresponsive.
replicate HTTP session information so that a users browser session is not lost if
an application server node fails. For more information about how to perform
this configuration, see “Enabling Session Replication” on page 180.
Note: There are significant performance impacts when you enable this
behavior because HTTP session information must be replicated on all nodes.
The HTTP session replication is enabled only for the following web applications in
Media Management:
• HTML5 user interface (otmmux.war)
• Web Administration user interface (teams.war)
• REST API (restapi.war)
This means that HTTP session information pertaining to these WARs is replicated
among all the nodes.
By enabling session replication, if one of the instances is not reachable, the Web
Administration, HTML5 user interface application and REST API web application
users who were on that instance, are automatically redirected to the other instance in
the cluster.
Note: Even if you enable this mode, OTMM requires that you enable Sticky
Sessions in the Load balancer. If a node fails in any application other than the
web applications where the session replication is enabled, users must sign in
again.
Note: In the web.xml file, you must add the tags as per the deployment
descriptor tags order. The order is: icon, display-name, description,
distributable, context-param, filter, filter-mapping,listener,
servlet, servlet-mapping, and so on.
For example:
<web-app xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://
java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
version="3.0">
<description>
....
<distributable/>
...
<filter>
...
<listener>
...
</web-app>
Note: You must perform this procedure on all nodes in the cluster.
HA Capability
Search is provided by one or more Solr/slave instances. Indexing can be
redirected using Media Management Ant tasks.
14.2.5 Indexer
The Indexer component is responsible for extracting change records from the Media
Management database and updating the search index.
HA Capability
The Indexer Monitor is an automated process that makes sure an Indexer
process is always available to process data. In an HA environment, only one
Indexer is active at any one time even though Indexers are installed on each
Media Management host. If the active Indexer becomes inactive, one of the other
available Indexers automatically becomes the active Indexer and takes over the
indexing tasks.
14.2.6 Database
The database maintains the system data and metadata for the Media Management
application. The Media Management business services leverages JDBC drivers to
communicate with the database.
HA Capability
To provide HA support for the Media Management application, OpenText
recommends that you configure your Oracle database in a cluster with at least
two nodes. The Media Management application server can then be configured to
leverage the transparent application failover (TAF) capabilities.
The JDBC and ODBC drivers are designed to leverage the TAF capabilities of the
Oracle database, providing connect-time failover.
HA Capability
In a Media Management HA environment, Solr is set up as a master/slave
configuration. One Solr server is configured as the master and is responsible for
indexing. Other installed Solr servers are configured as slaves. Slaves replicate
the Solr index files on their local host. All Solr servers can be used for searching.
HA Requirements
The database data files must be placed on an HA capable shared SAN device.
The storage device selected for the HA configuration must be capable of providing
clustering to ensure that all application nodes can access content (read and write)
files at any time.
HA Options
The Media Management repository must be placed on an HA capable shared
SAN device.
Note: You must use the same network user ID when installing Media
Management on all nodes. Using the same user ID facilitates resource sharing
in the HA cluster.
Therefore, Media Management has a single point of failure in Secure MFT. The
impact of an Secure MFT failure is limited. If any component of the Enterprise
Server, the web services or the Transfer Server, fails after the Secure MFT-
based file transfer starts, the import or export activity would also fail.
However, if either of these components becomes inaccessible before the Secure
MFT-based file transfer is committed to, Media Management reverts to native
HTTP-based transfer.
• TEAMS_REPOSITORY_HOME
• IMPORT_WORKING_AREA
• DEFAULT_EXPORT_AREA
• VIDEO_FILE_STAGING_AREA
• BULKEDIT_WORKING_AREA
• Linux only - UNIX_RELATIVE_VIDEO_WORKING_AREA
Note: When choosing these shared storage areas, you should consider other
component disk needs. For example, the DEFAULT_EXPORT_AREA and the
EXPORT_WORKING_AREA directories should be separate. Make sure these
temporary work areas do not conflict with the disk requirements for Solr
indexing.
14.3.2 Setting up HA
Note: For more information about versions, see OpenText Media Management
Technical Specifications (https://knowledge.opentext.com/knowledge/cs.dll/
Properties/66025283).
Note: On Linux, you must mount the Media Management ISO as the Linux
root user.
Note: After a successful installation, set the ownership of the install folder to
Linux only the product user. For example:
a. Perform the instructions To update the OTDS Push Connector for all
OTDS cluster nodes.
b. Perform the instructions To configure the OTDS Push Connector for
Media Management only once.
1. When installing Media Management on the other cluster nodes, install only the
OTMM Application, deselect the Schema option, and then point to the existing
database which was created as part of the first cluster node installation.
Tip: You can use the same mediamanagment_config.txt settings that you
used when you set up the first OTMM cluster node. Copy this
configuration file to the current OTMM cluster node before running the
installer on the current node.
2. Install OTMM.
Note: Oracle users - Do not select the Create table space option.
3. Copy the files in the <TEAMS_HOME>/servers folder from the first node to the
<TEAMS_HOME>/servers folder on the remaining nodes of the cluster.
8. Edit the VIDEO and AUDIO component settings to match those configured on
the first cluster node. For more information and for sample configurations, see
“Configuring video and audio“ on page 85.
Note: For a Windows cluster, you might need to use a UNC path, such as
\\sharedhost\repository, if the application server cannot access a
mounted drive when it is run as a Windows service. You must ensure that
the user running the OpenText Media Manger service has read and write
access to the shared repository.
2. Configure the JBoss settings for the first cluster node in one of the following:
WINDOWS
<JBOSS_HOME>/bin/ otmm-standalone.bat
LINUX
<JBOSS_HOME>/bin/otmmstandalone.sh
4. Search for web subsystem and add an attribute called instance-id. Record the
value of the attribute because you must specify the same name in the Load
Balancer configuration of the cluster setup. You must provide a unique name on
each node. Preferably, provide the same value as OTMM_JBOSS_NODE_NAME,
which is configured in the otmm-standalone.conf.bat file on Windows or the
otmm-standalone.conf file on Linux. For example:
JBoss EAP
<subsystem xmlns="urn:jboss:domain:web:2.2" default-
virtualserver="default-host" native="false" instance-id="otmm-
node2">
WildFly
<subsystem xmlns="urn:jboss:domain:undertow:2.0" instance-
id="otmm-node2">
Note: This step is required only if you are using an AJP protocol-based
software load balancer, such as Apache Web Server configured with
mod_JK or mod_proxy_ajp.
5. Verify that the configuration group component settings are consistent with the
first OTMM cluster node through the Settings page. Verify the settings for any
optional installation configuration items that are installed. For more information
about the Settings page, see OpenText Media Management - Administration Guide
(MEDMGT160200-AGD).
6. Configure the OTMM node in the load balancer by mapping requests for the
following URLs from the load balancer to the OTMM server:
• /artesia-ws
• /artesia-ws/*
• /artesia-ux-ws
• /artesia-ux-ws/*
• /content
• /content/*
• /otmm
• /otmm/*
• /otmmapi
• /otmmapi/*
• /swagger-ui
• /swagger-ui/*
• /teams
• /teams/*
• /hostedhelp/*
Note: For a Windows cluster, you might need to use a UNC path, such as
\\sharedhost\repository, if the application server cannot access a
mounted drive when it is run as a Windows service. You must ensure that
the user running the OpenText Media Manger service has read and write
access to the shared repository.
2. Adapt JmsResourceAdapter in the tomee.xml file on all cluster nodes by
changing ServerUrl to use the hostname of the respective node instead of the
localhost.
BrokerXmlConfig = xbean:file:../conf/
activemq.xml
ServerUrl = nio://hostname:54545?
soTimeout=60000&daemon=true&keepAlive=true&
connectionTimeout=120000&wireFormat.tcpNoDelayEnabl
ed=true&wireFormat.maxInactivityDuration=240000&
;wireFormat.maxInactivityDurationInitalDelay=120000
</Resource>
<transportConnectors>
<transportConnector name="nio"
enableStatusMonitor="true" uri="nio://localhost:54545?
soTimeout=60000&daemon=true&keepAlive=true&
connectionTimeout=120000&wireFormat.tcpNoDelayEnabl
ed=true&wireFormat.maxInactivityDuration=240000&
;wireFormat.maxInactivityDurationInitalDelay=120000"/>
</transportConnectors>
<transportConnectors>
<transportConnector name="nio"
enableStatusMonitor="true" uri="nio://hostname:54545?
soTimeout=60000&daemon=true&keepAlive=true&
connectionTimeout=120000&wireFormat.tcpNoDelayEnabl
ed=true&wireFormat.maxInactivityDuration=240000&
;wireFormat.maxInactivityDurationInitalDelay=120000"/>
</transportConnectors>
Note: The load balancer will use the same unique identifier.
OpenText recommends that you use the same identifier per TomEE
node.
b. Configure the cluster communication using Apache Tribes
SimpleTcpCluster by adding or adapting the following XML element in the
%TOMEE_HOME%/conf/server.xml file.
Note: Ensure that the multicast address is not yet used within the
targeted network environment.
<Cluster
className="org.apache.catalina.ha.tcp.SimpleTcpCluster"
channelSendOptions="8">
<Channel
className="org.apache.catalina.tribes.group.GroupChannel">
<Membership
className="org.apache.catalina.tribes.membership.McastService
" address="228.0.11.4" port="45567" frequency="500"
dropTime="3000" />
<Receiver
className="org.apache.catalina.tribes.transport.nio.NioReceiv
er" address="auto" port="4000" autoBind="100"
selectorTimeout="5000" maxThreads="6" />
<Sender
className="org.apache.catalina.tribes.transport.ReplicationTr
ansmitter">
<Transport
className="org.apache.catalina.tribes.transport.nio.PooledPar
allelSender" />
</Sender>
<Interceptor
className="org.apache.catalina.tribes.group.interceptors.TcpF
ailureDetector" />
</Channel>
<Valve
className="org.apache.catalina.ha.tcp.ReplicationValve"
filter="" />
<Valve
className="org.apache.catalina.ha.session.JvmRouteBinderValve
" />
<Deployer
className="org.apache.catalina.ha.deploy.FarmWarDeployer"
tempDir="/tmp/war-temp/" deployDir="/tmp/war-deploy/"
watchDir="/tmp/war-listen/" watchEnabled="false" />
<ClusterListener
className="org.apache.catalina.ha.session.ClusterSessionListe
ner" />
</Cluster>
c. Add or adapt the following XML element in the %TOMEE_HOME%/conf/
context.xml file.
<Manager
className="org.apache.catalina.ha.session.DeltaManager"
expireSessionsOnShutdown="false"
notifyListenersOnReplication="true"/>
6. Verify that the configuration group component settings are consistent with the
first OTMM cluster node through the Settings page. Check the settings for any
optional installation configuration items that you installed. For more
information about the Settings page, see OpenText Media Management -
Administration Guide (MEDMGT160200-AGD).
7. Configure the OTMM node in the load balancer by mapping requests for the
following URLs from the load balancer to the OTMM server:
• /artesia-ws
• /artesia-ws/*
• /artesia-ux-ws
• /artesia-ux-ws/*
• /content
• /content/*
• /otmm
• /otmm/*
• /otmmapi
• /otmmapi/*
• /swagger-ui
• /swagger-ui/*
• /teams
• /teams/*
• /hostedhelp/*
1. Provide a comma-delimited list of hosts and port numbers for each of the
application server nodes.
2. Provide the port number to the remote port of the application server. Typically,
the port used is 11099 and it is defined in the <JBOSS_HOME>\standalone\
configuration\otmm.xml file.
"PROVIDER_HOST"="remote://OTMM-Node1:11099,remote://
OTMMNode2:11099"
where
OTMM-Node1 and OTMMNode2 are Media Management instances in a two-
node cluster.
For more information about the TResource file, see OpenText Media Management
- Administration Guide (MEDMGT160200-AGD).
org.apache.openejb.server.discovery.MulticastDiscoveryAgent
bind = 235.25.20.3
port = 6142
disabled = false
group = default
"PROVIDER_HOST"="ejbd://multicastaddress:11099"
where
multicast address is the bind parameter value in the %TOMEE_HOME%
\conf\multicast.properties file.
For more information about the TResource file, see OpenText Media Management
- Administration Guide (MEDMGT160200-AGD).
1. Stop the Indexer on all the nodes by running one of the following commands:
WINDOWS
Stop the OpenText Indexer service from the Services menu.
LINUX
At the command prompt, run the following command:
<TEAMS_HOME>/bin/stopIndexer.sh
a. Install pgAgent.
Notes
• If your Media Management database is on Linux, connect to the
Media Management database using the database credentials that
you configured during installation, and then execute the following
statement.
create extension pgagent;
• If your Media Management database is on Windows and you
installed pgAgent through the Application Stack Builder from
EnterpriseDB, run the following scripts on the Media Management
database using the database credentials that you configured during
installation:
<pgagent installation directory>/pgagent.sql <pgagent
installation directory>>/pgagent_update.sql (if present)
• For more information about setting up pgAgent as a service on
your operating system, see http://www.pgadmin.org/docs/dev/
pgagent.html.
3. Register the Indexer on the first cluster node with the Indexer Monitor by
entering the following command, at the command prompt, from the
TEAMS_HOME>\install\ant directory:
ant configure-indexer-ha
4. On the first cluster node, start the Indexer Monitor by entering the following
command, at the command prompt, from the <TEAMS_HOME>\install\ant
directory:
ant create-indexer-monitor-job
Tip: To stop the Indexer Monitor at any time, enter the following
command:
ant drop-indexer-monitor-job
5. On all other nodes, register their the Indexers with the Index Monitor by
entering the following command from the <TEAMS_HOME>\install\ant
directory:
ant configure-indexer-ha
WINDOWS
Start the OpenText Indexer service from the Services menu.
LINUX
At the command prompt, enter the following command:
<TEAMS_HOME>/bin/startIndexer.sh
• Set the amount of inactive time it will wait before trying to switch the active
Indexer. The default is five minutes.
• Set the frequency for how often to perform its checks. The default is two minutes.
• Set the debug log level, which controls how much information is logged in the
INDEXER_MONITOR_LOG table. The default is 0, the minimum amount.
The Indexer Monitor consists of several tables, functions, procedures, and triggers in
the Media Management database which can be installed and configured using
several Ant scripts.
Note: All the ant scripts mentioned in the following sections should all be
run on the first node from the <TEAMS_HOME>/install/ant directory.
Note: The debug log level controls the amount of logging information
added to the INDEXER_MONITOR_LOG table.
The default Media Management installation assumes one Solr server per OTMM
application install node.
1. Choose any node in the OTMM cluster to be the master Solr server.
1. Run the following Ant task to set up the slave Solr configuration:
ant configure-solr-slave
The Indexer only detects the Solr master failure while it is actively indexing assets.
For example, the Solr master server fails at 1:00 AM. At 10:00 AM users sign in to
OTMM and update assets. As the Indexer attempts to update the assets, it discovers
that the Solr master server failed. If MAX_DOWNTIME is set to five minutes, the Indexer
sends an email to ADMIN_EMAIL_ADDRESS at 10:05 AM, five minutes after it discovers
the failure. An email is not sent if the Solr master connection becomes available
before the MAX_DOWNTIME limit.
Notes
• You can configure the ADMIN_EMAIL_ADDRESS and MAX_DOWNTIME through
the Settings page. For more information, see Section 2.13.2 “Configuring
components” in OpenText Media Management - Administration Guide
(MEDMGT160200-AGD).
• By default, the MAX_DOWNTIME is set to five minutes.
1. Sign in to the OTMM instance where the Solr server is the server that you want
to become the new master.
2. At the command prompt, enter the following command from the
<TEAMS_HOME>/install/ant directory:
ant disable-solr-master
Note: Running this command disables the current Solr master in the
SOLR_MONITOR_TABLE.
3. At the command prompt, enter the following command from the
<TEAMS_HOME>/install/ant directory:
ant configure-solr-master
Notes
• Running this command causes the current host's Solr server to become
the new master server.
• If this OTMM node’s Solr server is remote, copy the configuration from
the local <TEAMS_HOME>/solr5_otmm/otmm/conf to the remote server’s
index, and then restart the Solr server.
• For Linux systems, after copying the conf directory to the remote
server, but prior to restarting the Solr server, change the permissions of
the directory to be owned by the Solr user by executing the chown -R
<solr username> conf command from the solr5_otmm/otmmcore
directory.
• There is a chance that some indexed assets might not have been
replicated to the slave before the failure. In that case, the administrator
may want to repopulate the INDEX_WORKQUEUE following the
instructions Section 6.3.1 “Reverting to a backup copy of the Solr search
index” in OpenText Media Management - Administration Guide
(MEDMGT160200-AGD), skipping the index restoration in step 3.
• For this task, the start.date will be the time of the Solr failure.
Important
On all other HA nodes, issue the following command from the
<TEAMS_HOME>/install/ant directory to configure the slaves to point to the
new Solr master:
ant update-solr-slave
If this OTMM node's Solr server is remote, copy the configuration from the
local <TEAMS_HOME>/solr_otmm/otmmcore/conf to the remote server's
index, and then restart the Solr server.
Notes
• For Linux systems, after copying the conf directory to the remote server, but
prior to restarting the Solr server, change the permissions of the directory to
be owned by the Solr user by executing the chown -R <solr username>
conf command from the solr5_otmm/otmmcore directory.
• Searching will continue after a Solr master failure. New assets will not be
reflected in the search results until all the slave nodes have successfully
replicated from the new master.
2. To configure the node as a slave, run the following Ant task from the
<TEAMS_HOME>/install/ant directory:
ant configure-solr-slave
Notes
• If this OTMM node's Solr server is remote, copy the configuration from
the local <TEAMS_HOME>/solr5_otmm/otmmcore/conf folder to the
remote server's index, and then restart the Solr server.
• If you are running on Linux, after copying the conf directory to the
remote server, change the permissions of the directory to be owned by
the Solr user by executing the chown -R <solr username> conf
command from the solr5_otmm/otmmcore directory.
The Solr server will reload the new slave configuration and the machine will now
work as a Solr slave node.
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.
14.6 Risks
The following risks exist with this configuration and must be managed. They
include the following:
• Any custom background processes must be designed and built to appropriately
provide HA support.
• Support for in-flight session failover is not provided.
This appendix provides instructions for how to uninstall and clean your
environment. These instructions are helpful if you are performing multiple
installations or test installations.
1. Windows - Navigate to Programs and Features and select it. For example, in
the classic view of Control Panel, select Start > Settings > Control Panel >
Programs and Features.
Note: There is a known issue where the uninstall will sometimes fail with
an exception that says ...iawin32.dll not found. iawin32.dll is not
available in %TEAMS_HOME%\UninstallMediaManagement\resource.
The cause of this is the uninstaller is running using 32–bit Java instead of
64–bit. If you are getting this exception, run the following at the command
prompt from the %teams_home%\UninstallMediaManagement\ directory:
"Uninstall MediaManagement" LAX_VM "%java_home%\java.exe"
3. Linux - Sign in to the Linux machine as the root user and perform the following:
4. Click Next.
6. Select the OTDS Resource for OTMM check box to delete the OTDS Resource
that was created during the OTMM installation.
7. Select Yes, restart my system and click Done. The system will restart and the
Media Management application will be removed from the system.
8. After Media Management has been removed and the system has been restarted,
verify that the OpenText Media Manger and OpenText Indexer services have
been removed. If they have not been removed, then use the following
commands to delete them:
sc delete OpenTextMediaManagementService
sc delete OpenTextIndexer
• indexer-process-manager
Note: You can perform this task using the root user or the user who
configure OpenText Media Management on Linux as part of the post-
installation tasks.
Notes
• It is possible to uninstall Media Management as the OTMM user on Linux.
When a non-root user has uninstalled Media Management on Linux, the /
var/.com.zerog.registry.xml file must be manually edited to remove the
Media Management products and components information. When editing
this file, take care to only remove the Media Management related entries.
• For more information about how to uninstall OTDS, see OpenText Directory
Services - Installation and Administration Guide (OTDS160200-IWC).
1. Oracle database - To delete the Oracle schema, run the following command
while logged in as the “system” user:
Drop user <teams_owner> cascade;
2. SQL Server database - To delete the SQL Server database, do the following:
b. Expand the SQL Server Agent and open the Job Activity Monitor. Delete
the Indexer Update job related to your database.
c. Expand the databases and right-click your database to delete it. Select the
Close all connections check box.
f. If any of these deletions fail, some of the processes you are trying to delete
may still be running. If so, expand Management and open the Activity
Monitor to determine if there are processes that need to be stopped and
then deleted.
ii. Drop the Media Management tablespaces. For more information, see
Step 6 on page 30.
Tip: If you are not sure where this was installed, you can be inspect the
properties of the Solr service in the Windows Services panel. The
nssm-2.24 folder will be listed as part of the Path to executable
property.
• The solr-5.3.1 folder where the Solr distribution was installed.
Tip: If you are not sure where this was installed, you can be inspect the
properties the HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\
services\Solr5.3.1\Parameters registry entry.
• If Solr was installed on a separate server from Media Management, the
\solr5_otmm folder containing the OTMM specific Solr indexes and
configuration.
Tip: If you are not sure where this was installed, you determine this
from the coreRootDirectory entry in the solr5.3.1\server\solr\
solr.xml file below the solr5.3.1 folder.
• The directory underneath which the Solr distribution was installed. This will
be referred to as the SOLR_INSTALL_ROOT in the following instructions. The
Solr installer defaults to /opt, but you can override this during installation.
Tip: If you are not sure where this was installed, you determine it from
the SOLR_INSTALL_DIR entry in the /etc/init.d/solr script. If this
entry is set to /opt/solr, then /opt would be the
SOLR_INSTALL_ROOT.
• The directory used by Solr to store writable files. This will be referred to as
the SOLR_FILES_DIR in the following instructions. The Solr installer defaults
to /var/solr, but you can override this during installation.
Tip: If you are not sure where this was installed, you can determine it
from the SOLR_ENV entry in the /etc/init.d/solr script. If this entry
is set to /var/solr/solr.in.sh, then /var/solr would be
SOLR_FILES_DIR.
Tip: If you are not sure where this was installed, you can determine it
from the coreRootDirectory entry in the <SOLR_FILES_DIR>/data/
solr.xml file.
4. Delete the Solr installation directory and the symbolic link below the
SOLR_INSTALL_ROOT by running the following commands:
sudo rm <SOLR_INSTALL_ROOT>/solr
sudo rm -r <SOLR_INSTALL_ROOT>/solr-5.3.1
6. Remove the Solr service boot script by running the following command:
sudo rm /etc/init.d/solr
3. If you did not select the OTDS Resource for OTMM check box when you
uninstalled Media Management, and you want to use the same resource for
OTMM that you used previously, then deactivate it or configure a new OTMM
resource on the OTDS server. For more information, see “Configuring OTMM
resources in OTDS” on page 32.
Before installing, the user-entered parameters for installation are validated. This list
contains the validation checks that are performed.
Database • Verify that only one database type, Oracle, SQL Server, or PostgreSQL,
Validation has been selected.
• Verify that a database connection can be established.
Application Verify that the base installation directory does not contain the terms
Validation 'teams' or 'data'.
Note: The Private Help Server can support multiple OpenText products. If the
Private Help Server has already been installed within your organization to
support another OpenText product, you can add the OpenText Media
Management online help to that installation.
Setting up the Private Help Server requires you to complete the following general
tasks:
Notes
• The OpenText Private Help Server Kit contains two similarly named files,
one compatible with Apache Tomcat 7.x and the other with Apache Tomcat
8.x. During the setup process, you will need to rename these files by
removing the version information for the file that is compatible with your
version of Apache Tomcat.
• The OpenText Private Help Server Kit supports two help file branches, help
and pi_hosted, and contains support files for each branch. OpenText Media
Management uses the pi_hosted branch.
After you extract the files, you should see an OpenText OpenText Private Help
Server Kit directory that includes the following:
1. Create the directory where you will extract the online help files, for example C:
\ot_docs.
The <help_root> directory can exist on any local drive, but its path must not
contain any names with spaces.
2. Extract the sample help files in the docs.zip file into the <help_root> directory.
Note: Always use the Extract all option when you extract OpenText online
help files.
• context.properties
• index.html
2. Open the docsmapperapi.xml file in a text editor, and then locate the
<Context> element.
3. Replace the <help_root> with the full path to the help file directory you created
in “To create the <help_root> directory:“.
For example, using the folder created above, the setting for Apache Tomcat 7.x
on Windows is:
<Context aliases="/docs/pi_hosted=C:/ot_docs/docs/pi_hosted">
1. Create a folder where the configuration properties file will be stored, known as
the properties root directory. For example, C:\ot_docsconfig.
Note: You can create the properties root directory on any local drive, but
the directory path must:
• Not contain any spaces or special characters.
• Contain the subdirectories \properties\docsmapper. For example, if
the properties root directory is C:\ot_docsconfig, the full path is C:
\ot_docsconfig\properties\docsmapper.
webserverHelpRoot
The Tomcat root URL for the local help. The URL contains the following
information:
http://<host>:<port>/docsapimapper/docs/pi_hosted
where <host> is the server where Tomcat is deployed and <port> is the port
on which Tomcat listens. For example, on a server named host.
mycompany.com listening on port 8080, the setting is:
http://host.mycompany.com:8080/docsapimapper/docs/pi_hosted
Note: Specify the full server name or IP address as the <host> value.
Do not use localhost. Also, the value you use must be used in all
<host> settings, including URLs. IP address will not resolve to host
names and host names will not resolve to IP address.
techDocs Root
The path to the directory where the help files are stored. For example, C:/
ot_docs/docs/pi_hosted.
<product_code>
Each OpenText product online help is identified by a specific product code.
In the <PRODUCT CODE> section of the file, create a new line and specify
your product code as <product_code>=<product_code>.
The product code setting for OpenText Media Management is: medmgtmod
medmgt
# <PRODUCT CODE>
# Product directory mapping - will be the same as the
OpenText product name setting in the live Private Help Server
implementation.
# See your product documentation for the specific value for
your product.
# Some OpenText product codes are:
# Media Management: medmgt=medmgt
# InfoFusion: inf=inf
# Web Experience Management: wcmgt=wcmgt
# NOTE: test=test is required to verify the initial set up.
test=test
medmgtmod
medmgt
Important
Verify that Tomcat services are not running when you complete these tasks.
4. Start Tomcat.
Note: The Test Page is intended to verify that your Private Help Server is
installed and configured correctly. The page uses a simple method to request
the help files that may not work with all online help formats. Do not attempt to
modify the page to access other online help files or beyond the tasks described
in the procedure below.
1. Extract the Test Help Page - Private Help Server.zip file to a working
directory.
Note: Always use the Extract all option when you extract OpenText online
help files.
3. Locate the urlRoot: setting, and then replace the <host> and <port> values with
your Tomcat server name and the port on which it listens.
1. Stop Tomcat.
2. Extract the additional help files to the help root folder you created in “To create
the <help_root> directory:“.
Note: Always use the Extract all option when you extract OpenText online
help files.
3. Update the Private Help Server help registry by executing the following
command at a command line prompt:
java -jar <tomcat_home>\webapps\OTHelpServer\WEB-INF\lib
\HelpServer-<version>.jar -d <help_dir> -s
where <tomcat_home> is the path to your Tomcat installation, <version> is an
optional version number in the jar file name and <help_dir> is the help root
folder. For example, the following command updates the help registry for a
help root folder C:\ot_docs\docs\pi_hosted:
java -jar C:\PROGRA~1\APACHE~1\TOMCAT~1.0\webapps\OTHelpServer
\WEB-INF\lib\HelpServer-16.0.0.jar -d C:\ot_docs\docs\pi_hosted -s
4. Edit the pidocsapimapper.properties file and add the product code for your
help on the line below the test setting test=test. For more information, see
“Creating a configuration properties directory” on page 216.
5. Restart Tomcat.
To access the help files, you can use the TestPage.html file as long as you modify
the settings to reflect the values for your help. You can gather these settings from the
file path after you extract the help files to the help folder.
<helproot>/docs/pi_hosted/<product>/<version>/<module>/<language>/
<type>
For example, the OpenText Web Experience Management - Content Workspaces Help
(WCMGT-H-UGD) version 16.2 online help extracts to the following path:
<helproot>/docs/pi_hosted/wcmgt/v160200/wcmgt-h-ugd/en/ofh
So, to use the TestPage.html file, the JavaScript settings must be updated as
follows:
product: 'wcmgt',
version: 'v160200',
type: 'ofh',
module: 'wcmgt-h-ugd'
• Verify that you are using the correct slashes in any folder paths you must specify
in settings. The direction of slashes in folder paths can matter for some operating
systems.
• Verify that the Tomcat classpath is set correctly. The path you specify should not
include the properties\docsmapper folders; it should specify the path to the
folder where you created those subfolders. For more information about setting
the Tomcat classpath, see “Installing the descriptor and application files”
on page 218.
• Analyze the log files in the <Tomcat_home>\logs folder, including the
hosteddocslog.<date> file for more information.
Note: Do not change these unless you are setting up a Private Help Server or
as instructed by OpenText.
• Configuring the following settings by enter the appropriate value under the
Value column:
• BASE_URL – Enter the URL of your OpenText Private Help Server private
server.