Skip to content

Getting ready to install Module Suite

Overview of the Module Suite installation process

This guide describes the step-by-step procedure that will lead to the installation of the Module Suite on a Content Server environment, including the following components:

  • Content Script
  • Beautiful WebForms
  • Smart Pages
Install Module Suite components separately

If you are only interested in installing a subset of the available components, please check the dedicated installation guides for additional guidance:

Depending on the characteristics of the target environment (Unix/Linux or Windows, single server or clustered, ...) different options might be provided for each installation phase.

The following high-level phases will be covered:

  1. Deployment
    This phase covers the deployment of the software binaries on the target system. From Module Suite 4.0.0 onward, deployment is performed by uploading OpenText System Center packages; legacy 3.x releases used platform-specific click-through installers (see Deploy with OpenText System Center).

  2. Installation
    This phase covers the "installation" phase of the deployed Modules within the target Content Server system. The operation is performed through the standard OpenText Content Server Administration tools.

  3. Activation
    This phase covers the available procedures to apply the required software keys and activate the Module Suite software. The operations are performed using AnswerModules Administration tools available within the Content Server Admin pages and standard OpenText Content Server Administration tools.

  4. Configuration
    This phase covers the minimum set of post-installation configuration steps that are necessary to get the software up and running. This includes importing certain core libraries and components in the system. The operations are performed using AnswerModules Administration tools available within the Content Server Admin pages.

  5. Post-installation patching
    From time to time, hotfixes and patches are released to provide new features and address product issues. It is always suggested to keep the system up-to-date with all relevant patches and hotfixes, starting from the initial installation.

Installing on a Clustered Environment

When installing on a clustered Content Server environment, the overall installation procedure will vary.

In a clustered environment it is mandatory to install the Module Suite components on all nodes, but it is important to notice that the single installation steps must not be performed on each single node separately, as certain operations already affect the whole cluster.

At a high level, the suggested procedure is to perform a complete installation on the primary node of the cluster, and then reconcile the remaining nodes.

Please refer to the Installing on a clustered environment guide for detailed info.

Prerequisites

This guide assumes certain resources to be readily available while performing the installation. Please ensure the following have been provisioned before starting the installation process:

  • Admin-level access to the servers on which the software will be installed

  • Admin user access to the Content Server instance.

  • The Module Suite System Center packages (or legacy installers for 3.x) compatible with the target environment and platform version

    System Center package naming

    Before proceeding with the installation, make sure the package Module Suite version, target platform release, and operating system match your environment.

    From 4.0.0 onward, components are delivered as OpenText System Center compatible archives. The file name encodes the module, suite version, platform version, and OS suffix (win or unx):

    • anscontentscript_4_0_0_26.1_unx.tar.gz — Content Script on Unix/Linux for Content Suite 26.1
    • anscontentscript_4_0_0_24.2_win.tar.gz — Content Script on Windows for Content Suite 24.2

    The same pattern applies to other modules (for example ansbwebform_4_0_0_26.1_unx.tar.gz, anscontentsmartui_4_0_0_24.2_win.tar.gz) and to extension packages.

    Note: Legacy 3.x releases used Windows .exe or Unix .bin click-through installers. Those procedures are documented in Deploying on Windows and Deploying on Unix/Linux.

  • A valid AnswerModules activation key, either in plain text format or in OTCS Configuration Export XML format. The latter is the suggested option as it will prevent errors due to manual input.

    Keys and System Fingerprint
    • An activation key is only required starting from version 1.7.0 of the Module Suite.
    • Starting from version 2.0.0 activation keys are bound to the system’s fingerprint.
    How do I get an activation key?

    In order to activate Module Suite you need a valid activation key. Activation keys can be requested to AnswerModules Support by providing the OpenText Content Server System Fingerprint.

    You can read your's environment fingerprint from the OpenText Admin Pages as shown below

  • Any relevant hotfixes released for the Module Suite version being installed

    Hotfixes

    Hotfixes and patches are continuously published on the AnswerModules Support Portal. Check the availability of applicable patches when starting a new installation.

    E.g. https://support.answermodules.com/portal/en/kb/articles/module-suite-3-5-0-hotfixes-and-patches

Next Steps

Once all the prerequisites are met, please proceed to the Deployment phase: