for server administrators

e-Spirit AG

Table of Contents

1. Introduction

FirstSpirit can be used to create complex websites that are subject to multiple requirements. These requirements are always individual and project-specific. However, they are also increasingly influenced by the expectations of the website users simply presenting information is no longer sufficient in today's world. On the contrary, websites should also be modern, interactive, and should make an impression.

This is where the VideoManagementPro module comes in, which integrates the VideoManager Pro from MovingIMAGE24 into a FirstSpirit project. The available videos are presented in both FirstSpirit Clients in a report. From this report, videos can be referenced to the page via drag-and-drop.

The VideoManagementPro module therefore provides editors with a convenient way to add videos to a website. They can carry out all the necessary steps within FirstSpirit and do not have to switch between the two systems.

This document describes the installation and configuration of the module on the FirstSpirit Server. All necessary modifications that have to be made in the project are described in the VideoManagementPro manual.

1.1. Architecture

The underlying structure of the VideoManagementPro module is divided into three areas (see figure Architecture):

  • FirstSpirit Server
  • movingimage environment
  • Live system
Figure 1. Architecture

These three areas interact in accordance with a defined schema:

  1. The first area is the FirstSpirit Server, on which the VideoManagementPro module is installed. Within the editing environment, it provides information on the videos available and supplies embed codes for both the preview as well as the generation of live pages. This facilitates the integration of the videos used into the project.
  2. In doing so, the module communicates with VideoManager Pro, which represents the second area. It is a component of the movingimage environment and provides the REST-based movingimage Platform API for communication with FirstSpirit.
  3. The live system, which corresponds to the third area, also communicates with VideoManager Pro. However, in contrast to the FirstSpirit Server, communication is facilitated by the generated embed codes of the videos used.

All available videos are managed within VideoManager Pro and are merely referenced in FirstSpirit. This takes place in the report via the API and on the live page, as well as in the preview via the embed codes provided by VideoManager Pro.

1.2. Technical requirements

The VideoManagementPro module has the following technical requirements:

  • FirstSpirit (isolated or legacy mode) version 2018-08 or higher
  • Java 8 or higher

TheVideoManagementPro module uses the Java Architecture for XML Binding (JAXB) and the JavaBeans Activation Framework (JAF). Since Java 9, neither of these have been part of the Java SE Platform. If the FirstSpirit Server is running on Java 9 or higher, the JAXB must be added to it specifically. The JAF only has to be declared to FirstSpirit in version 2018-09 and higher. For this purpose the jaxb-fs-library-2.3.0.fsm and jaf-fs-library-1.2.0.fsm modules, which declare the JAXB and the JAF server-wide, are included in the delivery.

In order to edit video information, VideoManager Pro is displayed in the AppCenter in SiteArchitect. This is why a corresponding license is required in which the use of the AppCenter (parameter license.APPTAB_SLOTS) is activated.

Tampering with fs_license.conf will invalidate the license. If changes are necessary, please contact the Technical Support team.

The VideoManagementPro module functions cannot be used in conjunction with the external FirstSpirit preview.

2. Installation and configuration

Various components must be installed and configured in order to use the functions supported by the VideoManagementPro module. The steps to be completed are described in the following sub-chapters.

2.1. Module installation

Use the videomanagementpro-<version number>.fsm file supplied to add the module on the FirstSpirit Server. To install the module, open the ServerManager and select Server propertiesModules.

Module management in the server properties
Figure 2. Module management in the server properties

The main panel contains a list of modules installed on the FirstSpirit Server. After clicking Install, select the videomanagementpro-<version number>.fsm file supplied with the module and click Open to confirm your selection. After successful installation, a VideoManagementPro folder is added to the list and must be given All permissions (see figure Module management in the server properties).

After any module installation or update, the FirstSpirit Server needs to be restarted.

2.2. Proxy support

If all access to the VideoManagementPro module is via a proxy server, this proxy server must be declared to the module. To do this, open the ServerManager and expand the folder for theVideoManagementPro module under Server propertiesModules to select its service (see figure VideoManagementPro Service).

VideoManagementPro Service
Figure 3. VideoManagementPro Service

The Configure button opens the configuration dialog for the service, in which the following information has to be entered (see figure HTTP proxy settings):

Enter the URI of the proxy server in this field using the format http://Host:Port or https://Host:Port.
If the proxy server uses authentication, enter the login data in these two fields.
HTTP proxy settings
Figure 4. HTTP proxy settings

2.3. Configuring caching

The VideoManagementPro module uses caching in various components to improve performance when generating and editing videos. The MI24 Video Permission Service and the MI24 Video Search Service are among these components.

Caching can be configured differently in each of these components. As the configuration options for both services are identical, the following description also applies to the configuration of the MI24 Video Permission Service. The ServerManager displays the folder for theVideoManagementPro module under Server propertiesModules. This folder can be expanded to select its service (see figure VideoManagementPro MI24 Video Search Service).

VideoManagementPro MI24 Video Search Service
Figure 5. VideoManagementPro MI24 Video Search Service

The Configure button opens the configuration dialog for the service, in which the following information has to be entered (see figure Cache configuration for the MI24 Video Search Service):

Invalidation method

Enter the invalidation method for detecting and invalidating outdated entries in the cache in this field. Possible methods are:

  • Expire after access - Invalidates cache entries after the last access and once the invalidation duration has expired (this is the default method).
  • Expire after write - Invalidates cache entries after they have been added to the cache and once the invalidation duration has expired.
Invalidation duration
Enter the duration in minutes after which invalidation of a cache entry is triggered in this field (the default value is 5 minutes).
Cache configuration for the MI24 Video Search Service
Figure 6. Cache configuration for the MI24 Video Search Service