۶Ƶ

DocumentationCampaignCampaign Classic v7 Documentation

[On-premise/hybrid only]{class="badge yellow" title="Applies to on-premise and hybrid deployments only"}

Installing packages with Linux installing-packages-with-linux

Last update: Thu Sep 26 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

۶Ƶ Campaign comes with the nlserver package which contains the binaries and configuration files for a given version.

The installation commands enables you to:

  • Copy the files to /usr/local/neolane
  • Create an ۶Ƶ Campaign Linux account (and the associated group), which is created with /usr/local/neolane as its home directory
  • Create an automatic script /etc/init.d/nlserver6 for use at startup, or create a systemd unit
NOTE
The neolane system user must not have been created before the command was run. The neolane user is created automatically during installation.
The home directory linked to the neolane user is also created automatically in /usr/local/neolane. Please make sure there is sufficient space on the /usr/local disk.

You can run the ping hostname command to make sure the server can reach itself.

Distribution based on RPM packages distribution-based-on-rpm--packages

AVAILABILITY
Starting v7.4.1, XML libraries for RPM Linux packages are no longer included in Campaign. You must install these librairies.

To install ۶Ƶ Campaign onto an RPM (RHEL, CentOS) operating system, follow these steps:

  1. Get the ۶Ƶ Campaign package. The name of the file is nlserver6-v7-XXXX-0.x86_64.rpm, where XXXX is the ۶Ƶ Campaign build number.

    note caution
    CAUTION
    Make sure you use the correct file name for your version of ۶Ƶ Campaign in the command samples of this section.

  2. To install it, connect as root and execute the following command, where XXXX is the ۶Ƶ Campaign build number:

    code language-none 
    yum install nlserver6-v7-XXXX-0.x86_64.rpm

    The rpm file has dependencies on packages that you can find on CentOS/Red Hat distributions. If you don’t want to use some of these dependencies (for example, if you want to use Oracle JDK instead of OpenJDK), you may have to use the “nodeps” option of rpm:

    code language-none 
    rpm --nodeps -Uvh nlserver6-v7-XXXX-0.x86_64.rpm

Note that most of the listed dependencies are mandatory and nlserver cannot start if they are not installed (the exception is opendk; another JDK can be installed).

The bc command, mandatory for executing the netreport, is not available by default on all Linux distributions. To check whether the command is available, run the which bc command. If not, you have to install it.

With CentOS, you must install the bc.x86_64 package: connect as root and run the following command:

yum install bc.x86_64

Distribution based on APT (Debian) distribution-based-on-apt--debian-

To install ۶Ƶ Campaign on a Debian 64 bit operating system, apply the following steps:

  1. Get the ۶Ƶ Campaign package. The name of the file is nlserver6-v7-XXXX-linux-2.6-amd64.deb, where XXXX is the ۶Ƶ Campaign build number.

    note caution
    CAUTION
    Make sure you use the correct file name for your version of ۶Ƶ Campaign in the command samples of this section.

  2. To install it, connect as root and execute the following command, where XXXX is the ۶Ƶ Campaign build number:

    code language-none 
    apt install ./nlserver6-v7-XXXX-linux-2.6-amd64.deb

Personalizing parameters personalizing-parameters

Some parameters can be personalized via the customer.sh file

If you are performing the installation for the first time, the customer.sh file might not yet exist on the server.

Create it and make sure it has execution rights. If this is not the case, enter the following command:

chmod +x /usr/local/neolane/nl6/customer.sh

Server encoding server-encoding

By default, the server is started in an iso8859-15 environment. Nevertheless, the server can be started in an UTF-8 environment.

CAUTION
This change impacts the interactions with the file system (files loaded via a workflow or a JavaScript script) and on the file encoding. We therefore recommend using the default environment.

To create a Japanese instance, you must use a UTF-8 environment.

To enable the UTF-8 environment, use the following command:

mkdir -p /usr/local/neolane/nl6
touch /usr/local/neolane/nl6/unicodeenv

Environment variables environment-variables

The following environment variables must be defined correctly.

Certain combinations require changes to the environment used for executing ۶Ƶ Campaign. A specific file (/usr/local/neolane/nl6/customer.sh) can be created and edited to add modifications specific to the ۶Ƶ Campaign environment.

If necessary, edit the customer.sh file using the vi customer.sh command and adapt the configuration or add missing lines:

  • For the Oracle client:

    code language-none 
    export ORACLE_HOME=/usr/local/instantclient_10_2
export TNS_ADMIN=/etc/oracle
export LD_LIBRARY_PATH=$ORACLE_HOME/lib:$LD_LIBRARY_PATH

    The content of the ORACLE_HOME environment variable matches the Oracle installation directory.

    The content of the TNS_ADMIN variable has to match the location of the tnsnames.ora file.

  • For LibreOffice:

    To run ۶Ƶ Campaign on an existing version of LibreOffice, additional configurations are required: you need to specify the access paths to the installation directory. For instance:

    • Debian

      Default values for OOO_INSTALL_DIR and OOO_BASIS_INSTALL_DIR are provided. You can override them in customer.sh if your layout of the LibreOffice installation is different:

      code language-none 
      export OOO_BASIS_INSTALL_DIR=/usr/lib/libreoffice/
export OOO_INSTALL_DIR=/usr/lib/libreoffice/

    • CentOs

      Use the following default values:

      code language-none 
      export OOO_BASIS_INSTALL_DIR=/usr/lib64/libreoffice/
export OOO_INSTALL_DIR=/usr/lib64/libreoffice/

  • For Java Development Kit (JDK):

    By default, the configuration script of the ۶Ƶ Campaign environment (~/nl6/env.sh) searches for the JDK installation directory. However, it is recommended to specify which JDK needs to be used. To do this, you can force the JDK_HOME environment variable using the following command:

    code language-none 
    export JDK_HOME=/usr/java/jdkX.Y.Z
    note note
    NOTE
    Make sure that the JDK version used matches the directory name.

    To test the JDK configuration, log in as the ۶Ƶ Campaign system user with the following command:

    code language-none 
    su - neolane

You must restart the ۶Ƶ Campaign service in order for the changes to be taken into account.

The commands are as follows:

systemctl stop nlserver
systemctl start nlserver

Oracle Client in Linux oracle-client-in-linux

When using Oracle with ۶Ƶ Campaign, you need to configure the Oracle client layers in Linux.

  • Use the full client

  • TNS definition

    The TNS definitions must be added during the installation phase. To do this, use the following commands:

    code language-none 
    cd /etc
mkdir oracle
cd oracle
vi tnsnames.ora

  • Environment variables

    Refer to Environment variables.

  • Configuration for ۶Ƶ Campaign

    To finalize the installation of the Oracle client for ۶Ƶ Campaign, you need to create a symbolic link for the .so file used by ۶Ƶ Campaign.

    To do this, use the following commands:

    code language-none 
    cd /usr/lib/oracle/10.2.0.4/client/lib
ln -s libclntsh.so.10.1 libclntsh.so

In case of an issue, make sure the packages listed in the Oracle installation documentation are correctly installed.

Installation checks installation-checks

You can now perform an initial installation test using the following commands:

su - neolane
nlserver pdump

When ۶Ƶ Campaign is not started, the response is:

no task

First start-up of the server first-start-up-of-the-server

Once the installation test is complete, enter the following command:

nlserver web

The following information is then displayed:

17:11:03 >   Application server for ۶Ƶ Campaign Classic (7.X YY.R build XXX@SHA1) of DD/MM/YYYY
17:11:03 >   Web server start (pid=17546, tid=-151316352)...
17:11:03 >   Creating server configuration file '/usr/local/[INSTALL]/nl6/conf/serverConf.xml' via '/usr/local/[INSTALL]/nl6/conf/fra/serverConf.xml.sample'
17:11:03 >   Creating server configuration file '/usr/local/[INSTALL]/nl6/conf/config-default.xml' via '/usr/local/[INSTALL]/nl6/conf/models/config-default.xml'
17:11:03 >   Server started
17:11:08 >   Stop requested (pid=17546)
17:11:08 >   Web server stop(pid=17546, tid=-151316352)...

These commands let you create config-default.xml and serverConf.xml configuration files. All the parameters available in the serverConf.xml are listed in this section.

Press Ctrl+C to stop the process, then enter the following command:

nlserver start web

The following information is then displayed:

12:17:21 >   Application server for ۶Ƶ Campaign Classic (7.X YY.R build XXX@SHA1) of DD/MM/YYYY
12:17:21 >   Running task 'web@default' ('nlserver web -tracefile:web@default -instance:default -detach -tomcat -autorepair') in a new process
12:17:21 >   Application server for ۶Ƶ Campaign Classic (7.X YY.R build XXX@SHA1) of DD/MM/YYYY
12:17:21 >   Web server start (pid=29188, tid=-1224824320)...
12:17:21 >   Creating server configuration file '/usr/local/[INSTALL]/nl6/conf/serverConf.xml' via '/usr/local/[INSTALL]/nl6/conf/fra/serverConf.xml.sample'
12:17:22 >   Tomcat started
12:17:22 >   Server started

To stop it, enter:

nlserver stop web

The following information is then displayed:

12:18:31 >   Application server for ۶Ƶ Campaign Classic (7.X YY.R build XXX@SHA1) of DD/MM/YYYY
12:18:31 >   Stop requested for 'web@default' ('nlserver web -tracefile:web@default -instance:default -detach -tomcat -autorepair', pid=29188, tid=-1224824320)...
12:18:31 >   Stop requested (pid=29188)
12:18:31 >   Web server stopped (pid=29188, tid=-1224824320)...

Password for the internal identifier password-for-the-internal-identifier

The ۶Ƶ Campaign server defines a technical login called internal that has all rights on all instances. Just after installation the login does not have a password. It is mandatory to define one.

Learn more in this section.

recommendation-more-help
601d79c3-e613-4db3-889a-ae959cd9e3e1