Installing Semarchy Convergence for DI Analytics

Prerequisite

Semarchy Convergence for DI Analytics has the following requirements:

Semarchy Convergence for DI Analytics runs on any operating system meeting these requirements.

Installation

Semarchy Convergence for DI Analytics is shipped as .war file that is deployed on the application server.

Before proceeding:

  1. Make sure that the application server uses a Java version 1.6 or above
  2. Define a SEMARCHY_DI_WEBAPP_HOME environment variable, pointing to the folder into which Semarchy Convergence for DI Analytics will store its parameters and repository information.

Warning: For the SEMARCHY_DI_WEBAPP_HOME variable, it is preferable to use a folder separated from the installation folder of the application server. It is recommended to set up a backup process for this folder.

Tip: The name of the SEMARCHY_DI_WEBAPP_HOME variable can include the port into which the Semarchy Convergence for DI Analytics instance runs. For example: SEMARCHY_DI_WEBAPP_HOME_8081 to specify a second installation of Semarchy Convergence for DI Analytics. Use this mechanism when there are two instances of Semarchy Convergence for DI Analytics running in the same server.

Right Management

Semarchy Convergence for DI Analytics authentication uses application server’s authentication and roles.
You must declare users, roles and assign roles to users in the application server.

The following roles are supported by Semarchy Convergence for DI Analytics for defining the connected user’s privileges:

Configuring Apache Tomcat

Apache Tomcat Setup

To setup Semarchy Convergence for DI Analytics on Apache Tomcat:

  1. Declare the SEMARCHY_DI_WEBAPP_HOME environment variable in the profile of the user who will start the application server, or declare this variable in the /bin/setenv.bat or /bin/setenv.sh file.
  2. Add the users and roles to Tomcat, for example by modifying the /conf/tomcat-users.xml file in the Apache Tomcat installation directory.
  3. Start the Tomcat server using the /bin/startup.bat or /bin/startup.sh script
  4. Copy the .war file into Tomcat’s /webapps folder. Tomcat will automatically deploy the application.

Managing users and roles in Apache Tomcat

To add your users and roles when using a default Tomcat configuration, you must modify the /conf/tomcat-users.xml file in the Apache Tomcat installation directory.

The following example shows how to configure a new administrator user, who has two Semarchy Convergence for DI Analytics roles - analyticsAdmin and analyticsConnect - and two Tomcat roles - admin-gui and manager-gui -.

<tomcat-users>
<user name="youruser" 
      password="yourpassword"
      roles="admin-gui, manager-gui, analyticsAdmin, analyticsConnect" 
      />
</tomcat-users>

Configuring JBoss

JBoss 7

JBoss 7 Setup

To setup Semarchy Convergence for DI Analytics on JBoss 7:

  1. Declare the SEMARCHY_DI_WEBAPP_HOME environment variable in the profile of the user who will start the application server.
  2. Add the users and roles in JBoss 7 (see the note below).
  3. Start JBoss 7.
  4. Copy the .war file provided by Semarchy in the JBoss deployments folder. JBoss will auto-deploy the application.

Managing users and roles in JBoss 7

  1. Add the two files named analytics-users.properties and analytics-users.roles.properties in the domain or standalone folder according to your installation.
  2. In the analytics-users.properties file add a user with its password as shown in the example below:
  3. In the analytics-users.roles.properties file add the roles for this user as shown in the example below:
  4. Add the following text to the standalone.xml or domain.xml file according to your installation:
<security-domain name="analyticsRealm">
  <authentication>
    <login-module code="UsersRoles" flag="required">
      <module-option name="usersProperties" 
             value="${jboss.server.config.dir}/analytics-users.properties"/>
      <module-option name="rolesProperties" 
             value="${jboss.server.config.dir}/analytics-roles.properties"/>
    </login-module>
  </authentication>
</security-domain>

Note: Contact your JBoss administrator for more information about adding users to JBoss.

JBoss 6

JBoss 6 Setup

To setup Semarchy Convergence for DI Analytics on JBoss 6:

  1. Declare the SEMARCHY_DI_WEBAPP_HOME environment variable in the profile of the user who will start the application server.
  2. Add the users and roles in JBoss 6 (see the note below).
  3. Start JBoss 6.
  4. Copy the .war file provided by Semarchy in the JBoss deployments folder. JBoss will auto-deploy the application.

Managing users and roles in JBoss 6

  1. Add the two files named analytics-users.properties and analytics-users.roles.properties in the server\default\conf\prop\ folder in your JBoss installation folder.
  2. In the analytics-users.properties file add a user with its password as shown in the example below:
  3. In the analytics-users.roles.properties file add the roles for this user as shown in the example below:
  4. Add the following text to the server\default\conf\login-config.xml file:
<application-policy name="analyticsRealm">
  <authentication>
    <login-module code="org.jboss.security.auth.spi.UsersRolesLoginModule" flag="required">
      <module-option name="usersProperties">
         props/analytics-users.properties
      </module-option>
      <module-option name="rolesProperties">
         props/analytics-roles.properties
      </module-option>
      <module-option name="unauthenticatedIdentity">
         anonymous
      </module-option>
    </login-module>
  </authentication>
</application-policy>

Note: Contact your JBoss administrator for more information about adding users to JBoss.