Previous Topic: Upgrading to Release 3.1.01Next Topic: Configuring CA RiskMinder for Oracle RAC


Reinstalling RiskMinder

Depending on whether you had earlier deployed RiskMinder on a single system or on a distributed system, perform the tasks that are described in one of the following sections:

Reinstalling RiskMinder on a Single System

To reinstall RiskMinder on a single system, perform the tasks that are described in the following sections:

  1. Performing Complete Installation

    Note: While you install RiskMinder 3.1.01, ensure that you specify the same primary and backup database details from arcotcommon.ini in the $ARCOT_HOME/conf/ directory.

  2. Verifying the Database Setup
  3. Preparing Your Application Server
  4. Deploying Administration Console
  5. Logging In to Administration Console

    Important! Ensure that you use the current MA password and not the default password, because the MA password has been reset during the bootstrap process that you performed during 2.x installation.

  6. Starting RiskMinder Server
  7. Starting the Case Management Queuing Server
  8. Deploying User Data Service
  9. Deploying Sample Application
  10. Verifying the Installation

    Note: If there are any warnings during the Server startup and if your transactions fail, then the upgrade has not been performed successfully. You can revert to your initial setup by following the steps that are listed in (In Error Scenario Only) Reverting to Your Initial Setup.

  11. Using Sample Application
  12. Applying the Post-Installation Checklist
Performing Complete Installation

To install (and later configure) RiskMinder on Microsoft Windows successfully, the user account that you plan to use for the installation must belong to the Administrators group. Otherwise, some critical steps in the installation, such as DSN creation and configuration, and RiskMinder service creation, will not complete successfully, though the installation may complete without any errors.

Complete installation allows you to install all components of the RiskMinder package. These components include RiskMinder Server and the scripts that are required for setting up the database that you intend to use for RiskMinder.

Note: Before you proceed with the installation, ensure that all prerequisite software components are installed and the database is set up, as described in "Preparing for Installation" in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

Follow these steps:

  1. To run the installation wizard, navigate to the directory where the Arcot-RiskFort-3.1.01-Windows-Installer.exe file is located and double-click the file.

    The Welcome screen appears.

  2. Click Next to continue.

    The License Agreement screen appears.

  3. Carefully read the license agreement, select the I accept the terms of the License Agreement option, and click Next.

    The installer now checks if any other CA product is installed on the computer.

    If it does not find an existing CA product installation, then you are prompted for an installation directory. In this case, the Installation Location screen appears.

    If the installer detects an existing CA product installation (an existing ARCOT_HOME), then:

  4. Click Next to install in the specified directory.

    The Installation Type screen appears.

  5. Select Complete to install all components in one ARCOT_HOME and then click Next to continue.

    The Database Type screen appears.

  6. Depending on the type of database you have, you can select Microsoft SQL Server, Oracle Database, or MySQL. Click Next to proceed.

    If you selected Microsoft SQL Server, then the SQL Server Database Details screen appears.

    Note: If you are using a SQL database, then ensure that the ODBC Driver version you are using is the same as the one mentioned in "Preparing for Installation" in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

    If you selected Oracle on the Database Type screen, then the Oracle Database Details screen appears.

    Note: CA RiskMinder release 3.1.01 is now certified to work with Oracle Real Application Clusters (Oracle RAC). To use Oracle RAC with your RiskMinder Installation, select Oracle Database in this step, perform the next step (Step 7), and then perform the steps in Configuring CA RiskMinder for Oracle RAC (W).

    If you selected MySQL on the Database Type screen, then the MySQL Database Details screen appears.

  7. Based on your database choice in the preceding screen:

Parameter

Description

ODBC DSN

The installer creates the DSN by using this value. RiskMinder Server then uses this DSN to connect to the RiskMinder database. The recommended value to enter is arcotdsn.

Note: Database Source Name (DSN) specifies the information that is required to connect to a database by using an ODBC driver. This information includes database name, directory, database driver, User ID, and password.

Server

The host name or IP address of the RiskMinder datastore.

Default Instance

  • Syntax: <server_name>
  • Example: demodatabase

Named Instance

  • Syntax: <server_name>\<instance_name>
  • Example: demodatabase\instance1

User Name

The database user name for RiskMinder to access the database. This name is specified by the database administrator. (MS SQL Server, typically, refers to this as login.)

This user must have the create session and DBA rights.

Note: The User Name for the Primary and Backup DSNs must be different.

Password

The password associated with the User Name you specified in the previous field and which is used by RiskMinder to access the database. This password is specified by the database administrator.

Database

The name of the MS SQL database instance.

Port Number

The port at which the database listens to the incoming requests. The default port at which an MS SQL database listens is 1433. However, if you would like to specify another port, enter the port value in this field.

Parameter

Description

ODBC DSN

The installer creates the DSN by using this value. RiskMinder Server then uses this DSN to connect to the RiskMinder database. The recommended value to enter is arcotdsn.

Note: Database Source Name (DSN) specifies the information that is required to connect to a database by using an ODBC driver. This information includes database name, directory, database driver, User ID, and password.

User Name

The database user name for RiskMinder to access the database. This name is specified by the database administrator. (MS SQL Server, typically, refers to this as login.)

This user must have the create session and DBA rights.

Note: The User Name for the Primary and Backup DSNs must be different.

Password

The password associated with the User Name you specified in the previous field and which is used by RiskMinder to access the database. This password is specified by the database administrator.

Service ID

The Oracle System Identifier (SID) that refers to the instance of the Oracle database running on the server.

Port Number

The port at which the database listens to the incoming requests. The default port at which an Oracle database listens is 1521. However, if you would like to specify another port, enter the port value in this field.

Host Name

The host name or IP address of the RiskMinder datastore.

  • Syntax: <server_name>
  • Example: demodatabase
  1. After you specify the database details, test if you can successfully connect to the database by clicking the Test Data Source button and verify the result of the same in the field below the button.

    Note: If the connection was not successful, ensure that you have specified the correct database details and click Test Data Source again. Do not proceed with the installation unless the database connectivity is successful.

  2. Click Next to continue.

    The Encryption Configuration screen appears. Use this screen to select the encryption mode and configure the information that is used for encryption.

  3. Specify the following information:

Field Name

Description

Master Key

Specify the password for the Master Key, which is stored at <install_location>\Arcot Systems\conf\securestore.enc and will be used to encrypt the data stored in the database. By default, this value is set to MasterKey.

Note: If you want to change the value of Master Key after the installation, then regenerate securestore.enc with a new Master Key value. For more information, see appendix, "Changing Hardware Security Module Information After the Installation" in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

Configure HSM

Select this option only if you will use a Hardware Security Module (HSM) to encrypt the sensitive data.

If you do not select this option, then, by default, the data is encrypted by using the Software Mode.

PIN

Enter the password to connect to the HSM.

Choose Hardware Module

Choose one of the following HSMs that you plan to use:

  • Luna HSM
  • nCipher netHSM

HSM Parameters

 

Tip: The HSM parameter values are recorded in arcotcommon.ini, which is available in <install_location>\Arcot Systems\conf\. To change these values after installation, edit this file, as discussed in the section titled, Configuration Files and Options" in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

Set the following HSM information:

  • Shared Library: The absolute path to the PKCS#11 shared library corresponding to the HSM.
    For Luna (cryptoki.dll) and for nCipher netHSM (cknfast.dll), enter the absolute path and name of the DLL.
  • Storage Slot Number: The HSM slot where the 3DES keys used for encrypting the data are available.
    – For Luna, the default value is 0.
    – For nCipher netHSM, the default value is 1.

    The Pre-Installation Summary screen appears.

  1. Review the information about this screen, and if you must change a previous selection, then click Previous to do so. After you change the required selection, click Next to go to the next screen.
  2. Click Install to begin the installation process.

    The Microsoft Visual C++ 2010 x86 Redistributable Setup screen appears. This screen appears only if the current system where you are installing RiskMinder does not have Microsoft Visual C++ 2010 x86.

  3. On the Microsoft Visual C++ 2010 x86 Redistributable Setup screen:
    1. Select the I have read and accept the license terms option, and click Install.

      The Installation Progress screen appears. This may take a few seconds. After some time the Installation Is Complete screen appears.

    2. Click Finish to close the Microsoft Visual C++ 2010 x86 Redistributable Setup dialog and continue with the RiskMinder installation.

    The Installing Arcot RiskFort screen appears. This may take several minutes.

    After some time the Installation Complete screen appears.

  4. Click Done to complete the RiskMinder installation.

Installation Logs

After installation, you can access the installation log file (Arcot_RiskFort_Install_<timestamp>.log) in the <install_location> directory. For example, if you had specified the C:\Program Files directory as the installation directory, then the installation log file is created in the C:\Program Files directory.

If the installation fails for some reason, then error messages are recorded in this log file.

Verifying the Database Setup

After you run the required database scripts, verify that the RiskMinder schemas were seeded correctly. To do so:

  1. Log in to the RiskMinder database as the user who installed the database.

    Note: If you are following the upgrade path, then log in to the database as the user who upgraded the database.

  2. Run the following query:
    SELECT SERVERNAME, VERSION FROM ARRFSERVERS;
    

    You must see the following output as a result of the preceding query:

    SERVERNAME                   VERSION
    -------------------------  ----------------
    RiskFort                     3.1.01
    RiskFortCaseManagement       3.1.01
    
  3. Log out of the database console.
Preparing Your Application Server

Two components of RiskMinder, User Data Service (UDS) and Administration Console, are web-based and can be deployed on any of the following supported application servers:

Before you deploy the WAR files for these web applications on the application server of your choice, copy the files that are required by UDS and Administration Console to the appropriate location on your application server. This section walks you through the steps to copy the required crypto files to your application server and to deploy the WAR files of these web applications:

Step 1: Setting Java Home

Before you deploy the WAR files for UDS and Administration Console on the application server of your choice, ensure that you set the JAVA_HOME environment variable. This JAVA_HOME must be your application server JAVA_HOME.

In addition, %JAVA_HOME%\bin\ must be added to the PATH variable. If you fail to do so, then Administration Console, UDS, and other JDK-dependent components may fail to start.

Step 2: Copying Database Access Files to Your Application Server

UDS and Administration Console use the following files to access the RiskMinder database securely:

As a result, these files must be copied to the appropriate location on the application server where you have deployed these RiskMinder components. The following subsections provide information about copying these files for:

Apache Tomcat

To copy the files that are required for database access:

  1. Copy arcot-crypto-util.jar to <Tomcat_JAVA_HOME>\jre\lib\ext\.

    Here, <Tomcat_JAVA_HOME> represents the JAVA_HOME used by your Apache Tomcat instance.

  2. Copy ArcotAccessKeyProvider.dll to <Tomcat_JAVA_HOME>\jre\bin\.
  3. Restart the application server.

IBM WebSphere

To copy the files that are required for database access:

  1. Log in to WebSphere Administration Console.
  2. Click Environment, and then click Shared Libraries.
    1. From the Scope drop-down, select a valid visibility scope. The scope must include the target server or node on which the application is deployed.
    2. Click New.
    3. Enter the Name, for example, ArcotJNI.
    4. Specify the Classpath.

      This path must point to the location where the arcot-crypto-util.jar file is present and must also include the file name. For example, C:\Program Files\Arcot Systems\java\lib\arcot-crypto-util.jar.

    5. Enter the JNI Library path.

      This path must point to the location where the ArcotAccessKeyProvider.dll file is present.

  3. Click Apply to save the changes.
  4. Configure the server-level class loaders.
    1. Click Servers, and then click Application Servers.
    2. Under Application Servers, access the settings page of the server for which the configuration must be performed.
    3. Click Java and Process Management and then click Class Loader.
    4. Click New.
    5. Select default Classes loaded with parent class loader first and click OK.
    6. Click the auto-generated Class Loader ID.
    7. On the class loader Configuration page, click Shared Library References.
    8. Click Add, select ArcotJNI, and then click Apply.
    9. Save the changes.
  5. Copy ArcotAccessKeyProvider.dll to <WebSphere_JAVA_HOME>\jre\bin\.

    Here, <WebSphere_JAVA_HOME> represents the JAVA_HOME used by your IBM WebSphere instance.

  6. Restart the application server.

Oracle WebLogic

To copy the files that are required for database access:

  1. Copy ArcotAccessKeyProvider.dll to <WebLogic_JAVA_HOME>\jre\bin\.

    Here, <Weblogic_JAVA_HOME> represents the JAVA_HOME used by your Oracle WebLogic instance.

  2. Copy arcot-crypto-util.jar to <WebLogic_JAVA_HOME>\jre\lib\ext\.

    Note: Ensure that you use the appropriate <JAVA_HOME> used by WebLogic.

  3. Log in to WebLogic Administration Console.
  4. Navigate to Deployments.
  5. Enable the Lock and Edit option.
  6. Click Install and navigate to the directory that contains the arcot-crypto-util.jar file.
  7. Click Next to open the Application Installation Assistant.
  8. Click Next to display the Summary page.
  9. Click Finish.
  10. Activate the changes.
  11. Restart the application server.

JBoss Application Server

To copy the files that are required for database access:

  1. Copy ArcotAccessKeyProvider.dll to <JBoss_JAVA_HOME>\jre\bin\.

    Here, <JBoss_JAVA_HOME> represents the JAVA_HOME used by your JBoss Application Server instance.

  2. Copy arcot-crypto-util.jar to <JBoss_JAVA_HOME>\jre\lib\ext\.
  3. Restart the application server.
Step 3: Copying JDBC JAR Files to Your Application Server

RiskMinder requires the following JDBC JAR files for the supported databases:

The following subsections walk you through the steps for copying the JDBC JAR required for your database to one of the following application servers:

Apache Tomcat

To copy the required JDBC JAR file:

  1. Navigate to the location where you have downloaded the <Database_JAR> file.
  2. Copy the <Database_JAR> file to the following directory:
  3. Restart the server.

IBM WebSphere

To copy the required JDBC JAR file:

  1. Log in to the WebSphere Administration Console.
  2. Click Environment, and then click Shared Libraries.
    1. From the Scope list, select a valid visibility scope. The scope must include the target server or node on which the application is deployed.
    2. Click New.
    3. Enter the Name, say, JDBCJAR.
    4. Specify the Classpath.

      Important! This path must point to the location where the <Database_JAR> file is present and must include the file name.

    5. Click Apply to save the changes that were made.
  3. Configure server-level class loaders.
    1. Click Servers, and then click Application Servers.
    2. Under Application Servers, access the settings page of the server for which the configuration is performed.
    3. Click Java and Process Management, and then click Class Loader.
    4. Click New.
    5. Select default Classes loaded with parent class loader first and click OK.
    6. Click the auto-generated Class Loader ID.
    7. In the class loader Configuration page, click Shared Library References.
    8. Click Add, select JDBCJAR, and then click Apply.
    9. Save the changes that were made.
  4. Restart the application server.

Oracle WebLogic

Note: If you are using Oracle database, then do not perform the configurations that are mentioned in this section, because WebLogic supports Oracle database by default.

To copy the required JDBC JAR file in the case of Microsoft SQL Server:

  1. Copy the <Database_JAR> file to <Weblogic_JAVA_HOME>\lib\ext\.

    Here, <WebLogic_JAVA_HOME> represents the JAVA_HOME used by your Oracle WebLogic instance.

  2. Log in to the WebLogic Administration Console.
  3. Navigate to Deployments.
  4. Enable the Lock and Edit option.
  5. Click Install and navigate to the directory that contains the required <Database_JAR> file.
  6. Click Next to display the Application Installation Assistant page.
  7. Click Next to display the Summary page.
  8. Click Finish.
  9. Activate the changes.
  10. Restart the application server.

JBoss Application Server

To copy the required JDBC JAR file:

  1. Copy the JDBC JAR file to the following location on the JBOSS installation directory:
    <JBOSS_HOME>\server\default\lib\
    
  2. Restart the application server.
Step 4: (Mandatory for Oracle WebLogic 10.1) Creating Enterprise Archive Files

Most enterprise Application Servers (such as WebSphere and Weblogic) enable you to bundle the related Java ARchive (JAR) or Web ARchive (WAR) files from one vendor (say, CA) to a single enterprise application (or archive). As a result, all the related JARs or WARs can be deployed together, and can be loaded by a class loader. This archive also contains an application.xml file, which is generated automatically and describes how to deploy each bundled module.

By default, WAR files are provided to deploy UDS and Administration Console. However if necessary, you can also change the format of these files to Enterprise ARchive (EAR) and then deploy the EAR files.

As discussed in the following subsections, you can either generate separate EAR files for both UDS and Administration Console, or you can generate a single EAR file that contains both web archives.

Generating Separate EAR Files

To create a separate EAR file each for UDS and Administration Console:

  1. Open the Command Prompt window.
  2. Navigate to the <install_location>\Arcot Systems\tools\common\bundlemanager\ directory.
  3. To create the EAR file, run the following command:
    java -jar bundle-manager.jar -ear <filename.ear> -warList <filename.war>
    

    The preceding command generates individual EAR files that are available at:

    <install_location>\Arcot Systems\java\webapps\
    

Generating a Single EAR File

To create a single EAR file that contains UDS and Administration Console Web archives:

  1. Open the Command Prompt window.
  2. Navigate to the <install_location>\Arcot Systems\tools\common\bundlemanager\ directory.
  3. To create the EAR file, run the following command:
    java -jar bundle-manager.jar -ear <filename.ear> -warList arcotadmin.war arcotuds.war
    

    The preceding command generates a single EAR file that is available at:

    <install_location>\Arcot Systems\java\webapps\
    
Deploying Administration Console

Note: If you are deploying the Administration Console on IBM WebSphere 7.0, then instead of the following instructions, refer to the instructions in the topic that is titled "Deploying Administration Console on IBM WebSphere 7.0" in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

Administration Console is a browser-based interface to RiskMinder that enables you to customize the server configurations and manage the deployed system.

You need the arcotadmin.war file to deploy the RiskMinder Administration Console. All Administration Console information is logged in the arcotadmin.log file. After you deploy arcotadmin.war, you can verify if it was correctly deployed by using this log file (arcotadmin.log).

Note: To manage RiskMinder by using Administration Console, ensure that Administration Console can access the system where RiskMinder Server is installed by its host name.

To deploy the Administration Console WAR file on your application server, and to verify if it was successfully deployed, perform the following steps:

  1. Deploy arcotadmin.war in the appropriate directory on the application server.

    Note: The deployment procedure depends on the application server that you are using. See your application server vendor documentation for detailed instructions.
    For example, in the case of Apache Tomcat, you must deploy the WAR file at <APP_SERVER_HOME>\webapps\.

  2. (For 32-bit WebSphere Only) Configure reload of the Admin class when the application files are updated.
    1. Navigate to Application > Enterprise Applications and access the Admin settings page.
    2. Under Class loader order, select the Classes loaded with local class loader first (parent last) option.
    3. Under WAR class loader policy, select the Single class loader for application.
    4. Click Apply.
    5. Restart the Admin application.
  3. (For JBoss Only) Perform the following steps, if you have deployed Administration Console on JBoss Application Server:
    1. Copy the Bouncy Castle JAR file (bcprov-jdk15-146.jar) from <install_location>\Arcot Systems\java\lib\ to the following location:
      <JBOSS_HOME>\common\lib\
      
    2. Navigate to the following location:
      <JBOSS_HOME>\server\default\conf\
      
    3. Open jboss-log4j.xml file in a text editor.
    4. Add the following log configuration in the <log4j:configuration> section:
      <appender name="arcotadminlog" class="org.apache.log4j.RollingFileAppender">
      <errorHandler class="org.jboss.logging.util.OnlyOnceErrorHandler"></errorHandler>
      <param name="Threshold" value="INFO"/>
      <param name="MaxFileSize" value="10MB"/>
      <param name="MaxBackupIndex" value="100"/>
      <param name="Encoding" value="UTF-8"/>
      <param name="Append" value="true"/>
      <param name="File" value="${arcot.home}/logs/arcotadmin.log"/>
      <layout class="org.apache.log4j.PatternLayout">
      <param name="ConversionPattern" value="%d{yyyy-MM-dd hh:mm:ss,SSS z} : [%t] : %-5p : %-5c{3} : %m%n"/>
      </layout>
      <filter class="org.jboss.logging.filter.TCLMCFilter">
      <param name="AcceptOnMatch" value="true"/>
      <param name="DeployURL" value="arcotadmin.war"/>
      </filter>
      <!-- end the filter chain here -->
      <filter class="org.apache.log4j.varia.DenyAllFilter"></filter>
      </appender>
      
    5. Add the following log category:
      <category name="com.arcot">
      <priority value="INFO" />
      <appender-ref ref="arcotadminlog"></appender-ref>
      </category>
      

      Add the following category for cryptographic operations:

      <category name="com.arcot.crypto.impl.NCipherCrypter">
      <priority value="FATAL" />
      <appender-ref ref="arcotadminlog"></appender-ref>
      </category>
      
    6. Save and close the file.
    7. Take a backup of the existing JBoss logging libraries. These library files are available at:
      <JBOSS_HOME>\lib\
      
    8. Upgrade the JBoss logging libraries available at <JBOSS_HOME>\lib\ to version 2.1.1. The following table lists the JAR file names and the location from where you can download the files.

File Name

Location

jboss-logging-jdk-2.1.1.GA.jar

http://repo1.maven.org/maven2/org/jboss/logging/jboss-logging-jdk/2.1.1.GA/

jboss-logging-spi-2.1.1.GA.jar

http://repo1.maven.org/maven2/org/jboss/logging/jboss-logging-spi/2.1.1.GA/

jboss-logging-log4j-2.1.1.GA.jar

http://repo1.maven.org/maven2/org/jboss/logging/jboss-logging-log4j/2.1.1.GA/

  1. Restart the application server.
  2. Verify that the console was successfully deployed:
    1. Navigate to the following location:
      <install_location>\Arcot Systems\logs\
      
    2. Open the arcotadmin.log file in any editor and locate the following lines:
      • 2.0.3
      • Arcot Administration Console Configured Successfully.

      These lines indicate that your Administration Console was deployed successfully.

    3. Also ensure that the log files do not contain any FATAL and WARNING messages.
    4. Close the file.

Logging In to Administration Console

When you log in to Administration Console for the first time, use the Master Administrator (MA) credentials that are configured automatically in the database during the deployment.

To log in to Administration Console as MA:

  1. Launch the Administration Console in a Web browser window. The default URL for Administration Console is:
    http://<host>:<appserver_port>/arcotadmin/masteradminlogin.htm
    

    Note: The host and port information that you specify in the preceding URL must be of the application server where you deployed Administration Console.
    For example, in case of Apache Tomcat, the default host is localhost and port is 8080.

  2. Log in by using the default Master Administrator account credentials. The credentials are:
Starting RiskMinder Server

To start RiskMinder Server:

  1. Click the Start button on your desktop window.
  2. Navigate to Settings, Control Panel, Administrative Tools, and then Services.
  3. Locate and double-click Arcot RiskFort Service.
  4. Click Start in the service window.

Note: If you want to stop RiskMinder Server, then follow the Steps 1 through 3, and click the Stop button in the service window.

Starting the Case Management Queuing Server

To start Case Management Queuing Server:

  1. Click the Start button on your desktop window.
  2. Navigate to Settings, Control Panel, Administrative Tools, and then Services.
  3. Locate and double-click the Arcot RiskFort Case Management Queuing Service.
  4. Click Start in the service window.

Note: If you want to stop the Case Management Queuing Server, then follow the Steps 1 through 3, and click the Stop button in the service window.

Deploying User Data Service (UDS)

RiskMinder can access user data either from a relational database (RDBMS) or directly from an LDAP server by using UDS, which is an abstraction layer that provides RiskMinder seamless access to the third-party data repositories deployed by your organization.

You need the arcotuds.war file to deploy UDS, as follows:

  1. Deploy arcotuds.war on the application server. This file is available at:
    <install_location>\Arcot Systems\java\webapps\
    

    For example, in the case of Apache Tomcat, deploy the WAR file at <APP_SERVER_HOME>\webapps\.

    Note: The deployment procedure depends on the application server that you are using. See the application server vendor documentation for detailed instructions.

  2. (For WebSphere Only) Configure to reload the UDS class when the application files are updated.
    1. Navigate to Application, Enterprise Applications and access the UDS settings page.
    2. Under Class loader order, select the Classes loaded with local class loader first (parent last) option.
    3. Under WAR class loader policy, select the Single class loader for application.
    4. Click Apply to save the changes.
  3. (For JBoss Only) Perform the following steps, if you have deployed UDS on a JBoss application server:
    1. Copy the Bouncy Castle JAR file (bcprov-jdk15-146.jar) from <install_location>\Arcot Systems\java\lib\ to the following location:
      <JBOSS_HOME>\common\lib\
      
    2. Navigate to the following location:
      <JBOSS_HOME>\server\default\conf\
      
    3. Open jboss-log4j.xml file in a text editor.
    4. Add the following log configuration in the <log4j:configuration> section:
      <appender name="arcotudslog" class="org.apache.log4j.RollingFileAppender">
      <errorHandler class="org.jboss.logging.util.OnlyOnceErrorHandler"></errorHandler>
      <param name="Threshold" value="INFO"/>
      <param name="MaxFileSize" value="10MB"/>
      <param name="MaxBackupIndex" value="100"/>
      <param name="Encoding" value="UTF-8"/>
      <param name="Append" value="true"/>
      <param name="File" value="${arcot.home}/logs/arcotuds.log"/>
      <layout class="org.apache.log4j.PatternLayout">
      <param name="ConversionPattern" value="%d{yyyy-MM-dd hh:mm:ss,SSS z} : [%t] : %-5p : %-5c{3}(%L) : %m%n"/>
      </layout>
      <filter class="org.jboss.logging.filter.TCLMCFilter">
      <param name="AcceptOnMatch" value="true"/>
      <param name="DeployURL" value="arcotuds.war"/>
      </filter>
      <!-- end the filter chain here -->
      <filter class="org.apache.log4j.varia.DenyAllFilter"></filter>
      </appender>
      
    5. Add the following line in the com.arcot category that you created while Deploying Administration Console:

      <appender-ref ref="arcotudslog"></appender-ref>

    6. Add the following line in the cryptographic category that you created while Deploying Administration Console:

      <appender-ref ref="arcotudslog"></appender-ref>

    7. Save and close the file.
  4. Restart the application server.
  5. Verify if UDS was deployed successfully:

    Note: The arcotuds.log file is used for logging UDS-related information.

    1. Navigate to the following location:
      <install_location>\Arcot Systems\logs\
      
    2. Open the arcotuds.log file in any editor and locate the following line:
      • User Data Service (Version: 2.0.3) initialized successfully.

      This line indicates that UDS was deployed successfully.

    3. Also ensure that the log files do not contain any FATAL and WARNING messages.
    4. Close the file.
Deploying Sample Application

Important! Sample Application must not be used in production deployments. It is recommended that you build your own web application by using Sample Application as a code-reference.

Sample Application can be used to verify if RiskMinder was installed and configured properly. In addition, it demonstrates:

Sample Application is automatically installed as a part of Complete installation of RiskMinder. To deploy Sample Application:

  1. Deploy the riskfort-3.1.01-sample-application.war file from the following location:
    <install_location>\Arcot Systems\samples\java\
    
  2. If necessary, restart the application server.
  3. Access Sample Application in a Web browser window. The default URL for Sample Application is:
    http://<host>:<appserver_port>/riskfort-3.1.01-sample-application/index.jsp
    
Verifying the Installation

After you have seeded the database schema, deployed UDS and Administration Console, and bootstrapped the system, and started the Server, ensure that all these components have started correctly. The log files that you must verify for this purpose is arcotriskfort.log.

To verify if the server started correctly:

  1. Navigate to the following location:
       <install_location>\Arcot Systems\logs\
    
  2. Open the arcotriskfortstartup.log file in any editor and locate the following lines:
  3. Open the arcotriskfortcasemgmtserverstartup.log file in any editor and locate the following lines:

Note: Also ensure that the log files do not contain any FATAL and WARNING messages.

Using Sample Application

The following risk-evaluation operations can be performed by using Sample Application. Each of these operations is designed to run without error when RiskMinder is installed and functional.

Note: For information about running these operations, see the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

Applying the Post-Installation Checklist

It is recommended that you fill the following checklist with the installation and setup information for RiskMinder. This information is useful when you perform various administrative tasks.

Your Information

Example Entry

Your Entry

ARCOT_HOME

C:\Program Files\Arcot Systems

 

SYSTEM INFORMATION

Host Name

my-bank

 

User Name

administrator

 

Password

password1234!

 

Configured Components

 

 

RiskFort Server

Administration Console

User Data Service

 

ADMINISTRATION CONSOLE INFORMATION

Host Name

localhost

 

Port

8080

 

Master Administrator Password

mypassword1234!

 

USER DATA SERVICE INFORMATION

Host Name

localhost

 

Port

8080

 

Application Context Root

arcotuds

 

Reinstalling RiskMinder on a Distributed System

To reinstall RiskMinder on a distributed system, perform the tasks that are described in the following sections:

Important! Use the database that you had migrated earlier during the upgrade operation. In addition, install RiskMinder at the same location where the older release was installed. If you install in a different location, the RiskMinder Server does not start.

  1. Installing on the First System

    Note: While you install RiskMinder 3.1.01, ensure that you specify the same primary and backup database details from arcotcommon.ini in the $ARCOT_HOME/conf/ directory.

  2. Verifying the Database Setup
  3. Preparing Your Application Server
  4. Deploying Administration Console
  5. Logging In to Administration Console

    Important! Ensure that you use the current MA password and not the default password, because the MA password has been reset during the bootstrap process that you performed during 2.x installation.

  6. Starting RiskMinder Server
  7. Starting the Case Management Queuing Server
  8. Deploying User Data Service (UDS)
  9. Installing on the Second System
  10. Deploying Sample Application on the Second System
  11. Configuring Sample Application for Communication with RiskMinder Server
  12. Verifying the Installation

    Note: If there are any warnings during the Server startup, and if your transactions fail, then the upgrade has not been performed successfully. You can revert to your initial setup by following the steps that are listed in (In Error Scenario Only) Reverting to Your Initial Setup.

  13. Using Sample Application
  14. Applying the Post-Installation Checklist
Installing on the First System

To install (and later configure) RiskMinder on Microsoft Windows successfully, the user account that you plan to use for the installation must belong to the Administrators group. Otherwise, some critical steps in the installation, such as DSN creation and configuration, and the RiskMinder service creation, do not complete successfully, though the installation may complete without any errors.

In a distributed scenario, irrespective of how many systems you are distributing RiskMinder, Administration Console, Java SDKs, and Web services across, you typically install RiskMinder Server on the first system. Custom installation allows you to install only the selected components from the package. This option is recommended for advanced users.

Note: Before you proceed with the installation, ensure that all prerequisite software components are installed and the database is set up, as described in "Preparing for Installation" in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

To install the RiskMinder components, perform the following tasks:

  1. Navigate to the directory where the Arcot-RiskFort-3.1.01-Windows-Installer.exe file is located and double-click the file to run the installation wizard.

    The Welcome screen appears.

  2. Click Next to continue.

    The License Agreement screen appears.

  3. Carefully read the license agreement, select the I accept the terms of the License Agreement option, and click Next.

    The installer now checks if any other CA product is installed on the computer.

    If it does not find an existing CA product installation, then you are prompted for an installation directory. In this case, the Installation Location screen appears.

    If the installer detects an existing CA product installation (an existing ARCOT_HOME), then:

  4. Click Next to install in the specified directory.

    The Installation Type screen appears.

  5. Select Custom to install the selected components in one ARCOT_HOME.

    The Component Selection screen appears.

  6. Deselect the components that are not required. By default, all components are selected for the installation.

    For example, to install thev RiskMinder Server, Case Management Queuing Server, and Administration Console (without the SDKs and Sample Application) on the current system, select only the following options:

    1. Arcot Risk Evaluation Server
    2. Arcot Case Management Queuing Server
    3. Arcot Administration Console
    4. Arcot User Data Service

    Note: To install Sample Application only, select the Arcot RiskFort SDKs and Sample Application option and then proceed with the installation.

    The following table describes all components that are installed by the RiskMinder installer.

Component

Description

Arcot Risk Evaluation Server

This option installs the core Processing engine (RiskMinder Server) that serves the following requests from Administration Console:

  • Risk Evaluation
  • Configuration

In addition, this component also installs the following Web services that have been built into the server:

  • Risk Evaluation Web Service: Provides the web-based programming interface for risk evaluation with RiskMinder Server.
  • User Management Web Service: Provides the web-based programming interface for the creation and management of users.
  • Administration Web Service: Provides the web-based programming interface that is used by the RiskMinder Administration Console.

Arcot Case Management Queuing Server

This option installs the core Queuing engine (Case Management Queuing Server) that allocates cases to the Customer Support Representatives (CSRs) who work on these cases.

Note: At any given point in time, all instances of Administration Console can only connect to this single instance of Case Management Queuing Server.

Arcot RiskFort SDKs and Sample Application

This option provides programming interfaces (in form of APIs and Web services) that can be invoked by your application to forward risk evaluation requests to RiskMinder Server. This package comprises the following sub-components:

  • Risk Evaluation SDK: Provides the Java programming interface for risk evaluation with RiskMinder Server.
  • Sample Application: Demonstrates the usage of RiskMinder Java APIs. In addition, it can also be used to verify if RiskMinder was installed successfully, and if it is able to handle the risk evaluation requests.

For more information on configuring these components, see "Configuring RiskMinder SDKs and Web Services" in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

Arcot Administration Console

This option provides the Web-based interface for managing RiskMinder Server and risk evaluation-related configurations.

Arcot User Data Service

This option installs UDS that acts as an abstraction layer for accessing different types of user repositories, such as relational databases (RDBMSs) and directory servers (LDAPs.)

Note: If you did not select the Arcot Risk Evaluation Server option on this screen, then screens in Step 7 through Step 9 do not appear.

  1. Select Next to continue.

    The Database Type screen appears.

  2. Depending on the type of database you have, you can select Microsoft SQL Server, Oracle Database, or MySQL. Click Next to proceed.

    If you selected Microsoft SQL Server on the Database Type screen, then the SQL Server Database Details screen appears.

    Note: If you are using a SQL database, then ensure that the ODBC Driver version you are using is the same as the one mentioned in the "Configuring Database Server" in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

    If you selected Oracle Database on the Database Type screen, then the Oracle Database Details screen appears.

    Note: CA RiskMinder release 3.1.01 is now certified to work with Oracle Real Application Clusters (Oracle RAC). To use Oracle RAC with your RiskMinder Installation, select Oracle Database in this step, perform the next step (Step 9), and then perform the steps in Configuring CA RiskMinder for Oracle RAC (W).

  3. Based on your database choice in the preceding screen:

Parameter

Description

ODBC DSN

The installer creates the DSN by using this value. RiskMinder Server then uses this DSN to connect to the RiskMinder database. The recommended value to enter is arcotdsn.

Note: Database Source Name (DSN) specifies the information that is required to connect to a database by using an ODBC driver. This information includes database name, directory, database driver, User ID, and password.

Server

The host name or IP address of the RiskMinder datastore.

Default Instance

  • Syntax: <server_name>
  • Example: demodatabase

Named Instance

  • Syntax: <server_name>\<instance_name>
  • Example: demodatabase\instance1

User Name

The database user name for RiskMinder to access the database. This name is specified by the database administrator. (MS SQL Server, typically, refers to this as login.)

This user must have the create session and DBA rights.

Note: The User Name for the Primary and Backup DSNs must be different.

Password

The password associated with the User Name you specified in the previous field and which is used by RiskMinder to access the database. This password is specified by the database administrator.

Database

The name of the MS SQL database instance.

Port Number

The port at which the database listens to incoming requests. The default port at which an MS SQL database listens is 1433. However, if you would like to specify another port, enter the port value in this field.

Parameter

Description

ODBC DSN

The installer creates the DSN by using this value. RiskMinder Server then uses this DSN to connect to the RiskMinder database. The recommended value to enter is arcotdsn.

Note: Database Source Name (DSN) specifies the information that is required to connect to a database by using an ODBC driver. This information includes database name, directory, database driver, User ID, and password.

User Name

The database user name for RiskMinder to access the database. This name is specified by the database administrator. (MS SQL Server, typically, refers to this as login.)

This user must have the create session and DBA rights.

Note: The User Name for the Primary and Backup DSNs must be different.

Password

The password associated with the User Name you specified in the previous field and which is used by RiskMinder to access the database. This password is specified by the database administrator.

Service ID

The Oracle System Identifier (SID) that refers to the instance of the Oracle database running on the server.

Port Number

The port at which the database listens to the incoming requests. The default port at which an Oracle database listens is 1521. However, if you would like to specify another port, enter the port value in this field.

Host Name

The host name or IP address of the RiskMinder datastore.

  • Syntax: <server_name>
  • Example: demodatabase
  1. After you specify the database details, test if you can successfully connect to the database by clicking the Test Data Source button and verify the result of the same in the field below the button.

    Note: If the connection was not successful, ensure that you have specified the correct database details and click Test Data Source again. Proceed only if the database connectivity is successful.

  2. Click Next to continue.

    The Encryption Setup screen appears. Use this screen to select the encryption mode and configure the information that was used for encryption.

  3. Specify the following information:

Field Name

Description

Master Key

Specify the password for the Master Key, which is stored at <install_location>\Arcot Systems\conf\securestore.enc and will be used to encrypt the data stored in the database. By default, this value is set to MasterKey.

Note: If you want to change the value of Master Key after the installation, then regenerate securestore.enc with a new Master Key value. For more information, see appendix, "Changing Hardware Security Module Information After the Installation" in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

Configure HSM

Enter y if you want to use a Hardware Security Module (HSM) to encrypt the sensitive data. Alternatively, enter n to use the software encryption.

If you do not select this option, then, by default, the data is encrypted by using the Software Mode.

PIN

Enter the password to connect to the HSM.

Choose Hardware Module

Choose one of the following HSMs that you plan to use:

  • Luna HSM
  • nCipher netHSM

HSM Parameters

 

Note: The HSM parameter values are recorded in arcotcommon.ini, which is available in <install_location>\Arcot Systems\conf\. To change these values after installation, edit this file, as discussed in "Configuration Files and Options" in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

Set the following HSM information:

  • Shared Library: The absolute path to the PKCS#11 shared library corresponding to the HSM.
    For Luna (cryptoki.dll) and for Cipher netHSM (cknfast.dll), enter the absolute path and name of the DLL.
  • Storage Slot Number: The HSM slot where the 3DES keys used for encrypting the data are available.
    – For Luna, the default value is 0.
    – For nCipher netHSM, the default value is 1.

    The Pre-Installation Summary screen appears.

  1. Review the information on this screen, and if you must change a previous selection, then click Previous to do so. After you change the required selection, click Next to go to the next screen.
  2. Click Install to begin the installation process.

    The Microsoft Visual C++ 2010 x86 Redistributable Setup screen appears. This screen appears only if the current system where you are installing RiskMinder does not have Microsoft Visual C++ 2010 x86.

  3. On the Microsoft Visual C++ 2010 x86 Redistributable Setup screen:
    1. Select the I have read and accept the license terms option, and click Install.

      The Installation Progress screen appears. This may take a few seconds. After some time, the Installation Is Complete screen appears.

    2. Click Finish to close the Microsoft Visual C++ 2010 x86 Redistributable Setup dialog and continue with the RiskMinder installation.

    The Installing Arcot RiskFort screen appears. This may take several minutes. After some time the Install Complete screen appears.

  4. Click Done to complete the installation.

Installation Logs

After installation, you can access the installation log file (Arcot_RiskFort_Install_<timestamp>.log) in the <install_location> directory. For example, if you had specified the C:\Program Files directory as the installation directory, then the installation log file is created in the C:\Program Files directory.

If the installation fails for some reason, then error messages are recorded in this log file.

Verifying the Database Setup

After you run the required database scripts, verify that the RiskMinder schemas were seeded correctly. To do so:

  1. Log in to the RiskMinder database as the user who installed the database.

    Note: If you are following the upgrade path, then log in to the database as the user who upgraded the database.

  2. Run the following query:
    SELECT SERVERNAME, VERSION FROM ARRFSERVERS;
    

    You must see the following output as a result of the preceding query:

    SERVERNAME                   VERSION
    -------------------------  ----------------
    RiskFort                      3.1.01
    RiskFortCaseManagement        3.1.01
    
  3. Log out of the database console.
Preparing Your Application Server

Two components of RiskMinder, User Data Service (UDS) and Administration Console, are web-based and can be deployed on any of the following supported application servers:

Before you deploy the WAR files for these web applications on the application server of your choice, copy the files that UDS and Administration Console require to the appropriate location on your application server. This section walks you through the steps to copy the required crypto files to your application server and to deploy the WAR files of these web applications:

Step 1: Setting Java Home

Before you deploy the WAR files for UDS and Administration Console on the application server of your choice, ensure that you set the JAVA_HOME environment variable. This JAVA_HOME must be your application server JAVA_HOME.

In addition, %JAVA_HOME%\bin\ must be added to the PATH variable. If you fail to do so, then Administration Console, UDS, and other JDK-dependent components may fail to start.

Step 2: Copying Database Access Files to Your Application Server

UDS and Administration Console use the following files to access the RiskMinder database securely:

As a result, these files must be copied to the appropriate location on the application server where you have deployed these RiskMinder components. The following subsections provide information about copying these files for:

Apache Tomcat

To copy the files:

  1. Copy arcot-crypto-util.jar to <Tomcat_JAVA_HOME>\jre\lib\ext\.

    Here, <Tomcat_JAVA_HOME> represents the JAVA_HOME used by your Apache Tomcat instance.

  2. Copy ArcotAccessKeyProvider.dll to <Tomcat_JAVA_HOME>\jre\bin\.
  3. Restart the application server.

IBM WebSphere

To copy the files:

  1. Log in to WebSphere Administration Console.
  2. Click Environment, and then click Shared Libraries.
    1. From the Scope drop-down, select a valid visibility scope. The scope must include the target server or node on which the application is deployed.
    2. Click New.
    3. Enter the Name, for example, ArcotJNI.
    4. Specify the Classpath.

      This path must point to the location where the arcot-crypto-util.jar file is present and must also include the file name. For example, C:\Program Files\Arcot Systems\java\lib\arcot-crypto-util.jar.

    5. Enter the JNI Library path.

      This path must point to the location where the ArcotAccessKeyProvider.dll file is present.

  3. Click Apply to save the changes.
  4. Configure the server-level class loaders.
    1. Click Servers, and then click Application Servers.
    2. Under Application Servers, access the settings page of the server for which the configuration must be performed.
    3. Click Java and Process Management and then click Class Loader.
    4. Click New.
    5. Select default Classes loaded with parent class loader first and click OK.
    6. Click the auto-generated Class Loader ID.
    7. On the class loader Configuration page, click Shared Library References.
    8. Click Add, select ArcotJNI, and then click Apply.
    9. Save the changes.
  5. Copy ArcotAccessKeyProvider.dll to <WebSphere_JAVA_HOME>\jre\bin\.

    Here, <WebSphere_JAVA_HOME> represents the JAVA_HOME used by your IBM WebSphere instance.

  6. Restart WebSphere.

Oracle WebLogic

To copy the files:

  1. Copy ArcotAccessKeyProvider.dll to <WebLogic_JAVA_HOME>\jre\bin\.

    Here, <WebLogic_JAVA_HOME> represents the JAVA_HOME used by your Oracle WebLogic instance.

  2. Copy arcot-crypto-util.jar to <WebLogic_JAVA_HOME>\jre\lib\ext\.

    Note: Ensure that you use the appropriate <JAVA_HOME> used by WebLogic.

  3. Log in to WebLogic Administration Console.
  4. Navigate to Deployments.
  5. Enable the Lock and Edit option.
  6. Click Install and navigate to the directory that contains the arcot-crypto-util.jar file.
  7. Click Next to open the Application Installation Assistant.
  8. Click Next to display the Summary page.
  9. Click Finish.
  10. Activate the changes.
  11. Restart the server.

JBoss Application Server

To copy the files:

  1. Copy ArcotAccessKeyProvider.dll to <JBoss_JAVA_HOME>\jre\bin\.

    Here, <JBoss_JAVA_HOME> represents the JAVA_HOME used by your JBoss Application Server instance.

  2. Copy arcot-crypto-util.jar to <JBoss_JAVA_HOME>\jre\lib\ext\.
  3. Restart the application server.
Step 3: Copying JDBC JAR Files to Your Application Server

RiskMinder requires the following JDBC JAR files for the supported databases:

The following subsections walk you through the steps for copying the JDBC JAR required for your database to one of the following application servers:

Apache Tomcat

To copy the required JDBC JAR file:

  1. Navigate to the location where you have downloaded the <Database_JAR> file.
  2. Copy the <Database_JAR> file to the following directory:
  3. Restart the application server.

IBM WebSphere

To copy the required JDBC JAR file:

  1. Log in to the WebSphere Administration Console.
  2. Click Environment, and then click Shared Libraries.
    1. From the Scope list, select a valid visibility scope. The scope must include the target server or node on which the application is deployed.
    2. Click New.
    3. Enter the Name, say, JDBCJAR.
    4. Specify the Classpath.

      Important! This path must point to the location where the <Database_JAR> file is present and must include the file name.

    5. Click Apply to save the changes that were made.
  3. Configure server-level class loaders.
    1. Click Servers, and then click Application Servers.
    2. Under Application Servers, access the settings page of the server for which the configuration is performed.
    3. Click Java and Process Management, and then click Class Loader.
    4. Click New.
    5. Select default Classes loaded with parent class loader first and click OK.
    6. Click the auto-generated Class Loader ID.
    7. In the class loader Configuration page, click Shared Library References.
    8. Click Add, select JDBCJAR, and then click Apply.
    9. Save the changes that were made.
  4. Restart the application server.

Oracle WebLogic

Note: If you are using Oracle database, then do not perform the configurations that are mentioned in this section, because WebLogic supports Oracle database by default.

To copy the required JDBC JAR file in case of Microsoft SQL Server:

  1. Copy the <Database_JAR> file to <Weblogic_JAVA_HOME>\lib\ext\.

    Here, <WebLogic_JAVA_HOME> represents the JAVA_HOME used by your Oracle WebLogic instance.

  2. Log in to the WebLogic Administration Console.
  3. Navigate to Deployments.
  4. Enable the Lock and Edit option.
  5. Click Install and navigate to the directory that contains the required <Database_JAR> file.
  6. Click Next to display the Application Installation Assistant page.
  7. Click Next to display the Summary page.
  8. Click Finish.
  9. Activate the changes.
  10. Restart the application server.

JBoss Application Server

To copy the required JDBC JAR file:

  1. Copy the JDBC JAR file to the following location on the JBOSS installation directory:
    <JBOSS_HOME>\server\default\lib\
    
  2. Restart the application server.
Step 4: (Mandatory for Oracle WebLogic 10.1) Creating Enterprise Archive Files

Most enterprise Application Servers (such as WebSphere and WebLogic) enable you to bundle the related Java ARchive (JAR) or Web ARchive (WAR) files from one vendor (say, CA) to a single enterprise application (or archive). As a result, all the related JARs or WARs can be deployed together, and can be loaded by a class loader. This archive also contains an application.xml file, which is generated automatically and describes how to deploy each bundled module.

By default, WAR files are provided to deploy UDS and Administration Console. However if necessary, you can also change the format of these files to Enterprise ARchive (EAR) and then deploy the EAR files.

As discussed in the following subsections, you can either generate separate EAR files for both UDS and Administration Console, or you can generate a single EAR file that contains both Web archives.

Generating Separate EAR Files

To create a separate EAR file each for UDS and Administration Console, follow these steps:

  1. Open the Command Prompt window.
  2. Navigate to the <install_location>\Arcot Systems\tools\common\bundlemanager\ directory.
  3. To create the EAR file, run the following command:
    java -jar bundle-manager.jar -ear <filename.ear> -warList <filename.war>
    

    The preceding command generates individual EAR files that are available at:

    <install_location>\Arcot Systems\java\webapps\
    

Generating a Single EAR File

To create a single EAR file that contains UDS and Administration Console Web archives:

  1. Open the Command Prompt window.
  2. Navigate to the <install_location>\Arcot Systems\tools\common\bundlemanager\ directory.
  3. To create the EAR file, run the following command:
    java -jar bundle-manager.jar -ear <filename.ear> -warList arcotadmin.war arcotuds.war
    

    The preceding command generates a single EAR file that is available at:

    <install_location>\Arcot Systems\java\webapps\
    
Deploying Administration Console

Note: If you are deploying the Administration Console on IBM WebSphere 7.0, then instead of the following instructions, see the instructions in "Deploying Administration Console on IBM WebSphere 7.0" in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

Administration Console is a browser-based interface to RiskMinder that enables you to customize the server configurations and manage the deployed system.

You need the arcotadmin.war file to deploy the RiskMinder Administration Console. All Administration Console information is logged in the arcotadmin.log file. After you deploy arcotadmin.war, you can verify if it was correctly deployed by using this log file (arcotadmin.log). This log file is in the %ARCOT_HOME%\Arcot Systems\logs directory.

Note: To manage RiskMinder by using Administration Console, ensure that Administration Console can access the system where RiskMinder Server is installed by its hostname.

To deploy the Administration Console WAR file on your application server, and to verify if it was successfully deployed, follow these steps:

  1. Deploy arcotadmin.war in the appropriate directory on the application server.

    Note: The deployment procedure depends on the application server that you are using. See your application server vendor documentation for detailed instructions.
    For example, in the case of Apache Tomcat, you must deploy the WAR file at <APP_SERVER_HOME>\webapps\.

  2. (For 32-bit WebSphere Only) Configure reload of the Admin class when the application files are updated.
    1. Navigate to Application > Enterprise Applications and access the Admin settings page.
    2. Under Class loader order, select the Classes loaded with local class loader first (parent last) option.
    3. Under WAR class loader policy, select the Single class loader for application.
    4. Click Apply.
    5. Restart the Admin application.
  3. (For JBoss Only) Perform the following steps if you have deployed Administration Console on JBoss Application Server:
    1. Copy the Bouncy Castle JAR file (bcprov-jdk15-146.jar) from <install_location>\Arcot Systems\java\lib\ to the following location:
      <JBOSS_HOME>\common\lib\
      
    2. Navigate to the following location:
      <JBOSS_HOME>\server\default\conf\
      
    3. Open jboss-log4j.xml file in a text editor.
    4. Add the following log configuration in the <log4j:configuration> section:
      <appender name="arcotadminlog" class="org.apache.log4j.RollingFileAppender">
      <errorHandler class="org.jboss.logging.util.OnlyOnceErrorHandler"></errorHandler>
      <param name="Threshold" value="INFO"/>
      <param name="MaxFileSize" value="10MB"/>
      <param name="MaxBackupIndex" value="100"/>
      <param name="Encoding" value="UTF-8"/>
      <param name="Append" value="true"/>
      <param name="File" value="${arcot.home}/logs/arcotadmin.log"/>
      <layout class="org.apache.log4j.PatternLayout">
      <param name="ConversionPattern" value="%d{yyyy-MM-dd hh:mm:ss,SSS z} : [%t] : %-5p : %-5c{3} : %m%n"/>
      </layout>
      <filter class="org.jboss.logging.filter.TCLMCFilter">
      <param name="AcceptOnMatch" value="true"/>
      <param name="DeployURL" value="arcotadmin.war"/>
      </filter>
      <!-- end the filter chain here -->
      <filter class="org.apache.log4j.varia.DenyAllFilter"></filter>
      </appender>
      
    5. Add the following log category:
      <category name="com.arcot">
      <priority value="INFO" />
      <appender-ref ref="arcotadminlog"></appender-ref>
      </category>
      Add the following category for cryptographic operations: 
      <category name="com.arcot.crypto.impl.NCipherCrypter">
      <priority value="FATAL" />
      <appender-ref ref="arcotadminlog"></appender-ref>
      </category>
      
    6. Save and close the file.
    7. Take a backup of the existing JBoss logging libraries. These library files are available at:
      <JBOSS_HOME>\lib\
      
    8. Upgrade the JBoss logging libraries available at <JBOSS_HOME>\lib\ to version 2.1.1. The following table lists the JAR file names and the location from where you can download the files.

File Name

Location

jboss-logging-jdk-2.1.1.GA.jar

http://repo1.maven.org/maven2/org/jboss/logging/jboss-logging-jdk/2.1.1.GA/

jboss-logging-spi-2.1.1.GA.jar

http://repo1.maven.org/maven2/org/jboss/logging/jboss-logging-spi/2.1.1.GA/

jboss-logging-log4j-2.1.1.GA.jar

http://repo1.maven.org/maven2/org/jboss/logging/jboss-logging-log4j/2.1.1.GA/

  1. Restart the application server.
  2. Verify that the console was successfully deployed:
    1. Navigate to the following location:
      <install_location>\Arcot Systems\logs\
      
    2. Open the arcotadmin.log file in any editor and locate the following lines:
      • 2.0.3
      • Arcot Administration Console Configured Successfully.

      These lines indicate that your Administration Console was deployed successfully.

    3. Also ensure that the log files do not contain any FATAL and WARNING messages.
    4. Close the file.

Logging In to Administration Console

When you log in to Administration Console for the first time, use the Master Administrator (MA) credentials that are configured automatically in the database during the deployment.

To log in to Administration Console as MA:

  1. Launch the Administration Console in a Web browser window. The default URL for Administration Console is:
    http://<host>:<appserver_port>/arcotadmin/masteradminlogin.htm
    

    Note: The host and port information that you specify in the preceding URL must be of the application server where you deployed Administration Console.
    For example, in case of Apache Tomcat, the default host is localhost and port is 8080.

  2. Log in by using the default Master Administrator account credentials. The credentials are:
Starting RiskMinder Server

To start RiskMinder Server:

  1. Click the Start button on your desktop window.
  2. Navigate to Settings, Control Panel, Administrative Tools, and then Services.
  3. Locate and double-click Arcot RiskFort Service.
  4. Click Start in the service window.

Note: If you want to stop RiskMinder Server, then follow the Steps 1 through 3, and click the Stop button in the service window.

Starting the Case Management Queuing Server

To start Case Management Queuing Server:

  1. Click the Start button on your desktop window.
  2. Navigate to Settings, Control Panel, Administrative Tools, and then Services.
  3. Locate and double-click the Arcot RiskFort Case Management Queuing Service.
  4. Click Start in the service window.

Note: If you want to stop the Case Management Queuing Server, then follow the Steps 1 through 3, and click the Stop button in the service window.

Deploying User Data Service (UDS)

RiskMinder can access user data either from a relational database (RDBMS) or directly from an LDAP server by using UDS, which is an abstraction layer that provides RiskMinder seamless access to the third-party data repositories deployed by your organization.

You need the arcotuds.war file to deploy UDS, as follows:

  1. Deploy arcotuds.war on the application server. This file is available at:
    <install_location>\Arcot Systems\java\webapps\
    

    For example, in the case of Apache Tomcat, deploy the WAR file at <APP_SERVER_HOME>\webapps\.

    Note: The deployment procedure depends on the application server that you are using. See the application server vendor documentation for detailed instructions.

  2. (For WebSphere Only) Configure to reload the UDS class when the application files are updated.
    1. Navigate to Application, Enterprise Applications and access the UDS settings page.
    2. Under Class loader order, select the Classes loaded with local class loader first (parent last) option.
    3. Under WAR class loader policy, select the Single class loader for application.
    4. Click Apply to save the changes.
  3. (For JBoss Only) Perform the following steps if you have deployed UDS on a JBoss application server:
    1. Copy the Bouncy Castle JAR file (bcprov-jdk15-146.jar) from <install_location>\Arcot Systems\java\lib\ to the following location:
      <JBOSS_HOME>\common\lib\
      
    2. Navigate to the following location:
      <JBOSS_HOME>\server\default\conf\
      
    3. Open jboss-log4j.xml file in a text editor.
    4. Add the following log configuration in the <log4j:configuration> section:
      <appender name="arcotudslog" class="org.apache.log4j.RollingFileAppender">
      <errorHandler class="org.jboss.logging.util.OnlyOnceErrorHandler"></errorHandler>
      <param name="Threshold" value="INFO"/>
      <param name="MaxFileSize" value="10MB"/>
      <param name="MaxBackupIndex" value="100"/>
      <param name="Encoding" value="UTF-8"/>
      <param name="Append" value="true"/>
      <param name="File" value="${arcot.home}/logs/arcotuds.log"/>
      <layout class="org.apache.log4j.PatternLayout">
      <param name="ConversionPattern" value="%d{yyyy-MM-dd hh:mm:ss,SSS z} : [%t] : %-5p : %-5c{3}(%L) : %m%n"/>
      </layout>
      <filter class="org.jboss.logging.filter.TCLMCFilter">
      <param name="AcceptOnMatch" value="true"/>
      <param name="DeployURL" value="arcotuds.war"/>
      </filter>
      <!-- end the filter chain here -->
      <filter class="org.apache.log4j.varia.DenyAllFilter"></filter>
      </appender>
      

      Add the following line in the com.arcot category that you created in Deploying Administration Console:

      <appender-ref ref="arcotudslog"></appender-ref>
      
    5. Add the following line in the cryptographic category that you created in Deploying Administration Console:
      <appender-ref ref="arcotudslog"></appender-ref>
      
    6. Save and close the file.
  4. Restart the application server.
  5. Verify if UDS was deployed successfully:

    Note: The arcotuds.log file is used for logging UDS-related information.

    1. Navigate to the following location:
      <install_location>\Arcot Systems\logs\
      
    2. Open the arcotuds.log file in any editor and locate the following line:
      • User Data Service (Version: 2.0.3) initialized successfully.

      This line indicates that UDS was deployed successfully.

    3. Also ensure that the log files do not contain any FATAL and WARNING messages.
    4. Close the file.
Installing on the Second System

After you install the RiskMinder Server and Administration Console, install the other remaining components on the second system in this distributed environment. The specific components to install must have been determined when you performed your planning in "Planning the Deployment" in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

Note: Before you proceed with the installation, ensure that all prerequisite software components are installed on this system as described in "Preparing for Installation" in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

To install the RiskMinder components on the subsequent system:

  1. Copy the installer file Arcot-RiskFort-3.1.01-Windows-Installer.exe on the target (second) system.
  2. Double-click the installer to run it.
  3. Follow the installer instructions from Step 2 in Installing on the First System until you reach the Choose Install Set screen.
  4. Select the components that you want to install.

    Typically, you install the Java SDKs for Risk Evaluation and Sample Application.

  5. After you have selected all the components, follow the steps from Step 7 through Step 16 in Installing on the First System to complete the installation process.
Deploying Sample Application

Important! Sample Application must not be used in production deployments. It is recommended that you build your own web application by using Sample Application as a code-reference.

Sample Application can be used to verify if RiskMinder was installed and configured properly. In addition, it demonstrates:

Note: If you did not install Sample Application during the installation, then you can install only Sample Application by running the installer again and by selecting the SDKs and Sample Application options and proceed with the installation.

To deploy Sample Application on your application server:

  1. Deploy the riskfort-3.1.01-sample-application.war file from the following location:
    <install_location>\Arcot Systems\samples\java\
    
  2. If necessary, restart the application server.
  3. Access Sample Application in a Web browser window. The default URL for Sample Application is:
    http://<host>:<appserver_port>/riskfort-3.1.01-sample-application/index.jsp
    
Configuring Sample Application for Communication with RiskFort Server

The riskfort.risk-evaluation.properties file provides the parameters for the Java SDK and Sample Application to read RiskMinder Server information. Therefore, after deploying Sample Application, configure it to communicate with RiskMinder Server. This file is only available after you deploy the RiskFort Sample Application WAR file, riskfort-3.1.01-sample-application.war.

To configure the riskfort.risk-evaluation.properties file:

  1. Navigate to the riskfort.risk-evaluation.properties file on your application server.

    In case of Apache Tomcat, this file is available at:

    <App_Home\riskfort-3.1.01-sample-application>\WEB-INF\classes\properties\
    

    Here, <App_Home\riskfort-3.1.01-sample-application\> represents the directory path where RiskMinder application WAR files are deployed.

  2. Open the riskfort.risk-evaluation.properties file in an editor window and set the value for the following parameters:

    A default value is specified for the remaining parameters in the file. You can change these values, if necessary. For more information about configuration parameters, see "riskfort.risk-evaluation.properties" in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

  3. Optional: Perform this step only if you configured SSL-based communication.

    Set the following parameters:

    Important! In the absolute path that you specify, ensure that you use \\ or / instead of \. This is because the change may not work, if you use the conventional \ that is used in Microsoft Windows for specifying paths.

  4. Save the changes and close the file.
  5. To ensure that these changes are reflected, restart the application server.
Verifying the Installation

To verify if the server started correctly:

  1. Navigate to the following location:
       <install_location>\Arcot Systems\logs\
    
  2. Open the arcotriskfortstartup.log file in any editor and locate the following lines:
  3. Open the arcotriskfortcasemgmtserverstartup.log file in any editor and locate the following lines:

Note: Also ensure that the log files do not contain any FATAL and WARNING messages.

Using Sample Application

The following risk-evaluation operations can be performed by using Sample Application. Each of these operations is designed to run without error when RiskMinder is installed and functional.

Note: For information about running these operations, see the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.

Applying the Post-Installation Checklist

It is recommended that you fill the following checklist with the installation and setup information for RiskMinder. This information is useful when you perform various administrative tasks.

Your Information

Example Entry

Your Entry

ARCOT_HOME

C:\Program Files\Arcot Systems

 

SYSTEM INFORMATION

Host Name

my-bank

 

User Name

administrator

 

Password

password1234!

 

Configured Components

 

 

RiskFort Server

Administration Console

User Data Service

 

ADMINISTRATION CONSOLE INFORMATION

Host Name

localhost

 

Port

8080

 

Master Administrator Password

mypassword1234!

 

USER DATA SERVICE INFORMATION

Host Name

localhost

 

Port

8080

 

Application Context Root

arcotuds

 

(In Error Scenario Only) Reverting to Your Initial Setup

During upgrade, if there are any warnings during the Server startup and if your transactions fail, then you may want to revert to your initial setup.

To revert to the initial setup:

  1. Uninstall RiskMinder 3.1.01.

    Note: For information about the procedure to uninstall RiskMinder, see "Uninstalling RiskMinder" in the CA RiskMinder Installation and Deployment Guide for UNIX Platforms.

  2. Install the RiskMinder release to which you want to revert. For example, 1.x or 2.x.

    Note: For installation instructions, see the CA RiskMinder Installation and Deployment Guide that is shipped with the corresponding release.

  3. Navigate to the location where the ARCOT_HOME_BACKUP directory is available.
  4. Copy the contents of ARCOT_HOME_BACKUP to your current ARCOT_HOME.
  5. Replace the ArcotAccessKeyProvider.dll file in <JAVA_HOME used by Application Server>\jre\bin with the backup that you created while performing the procedure described in Migrating the Database to Release 2.2.7 for Arcot Common Components.
  6. Deploy the web components, such as the Administration Console and UDS.
  7. Restore the database from the backup that you had taken before you began the upgrade procedure.
  8. Start RiskMinder Server and Case Management Queuing Server.
  9. Test the installation.

Performing Post-Upgrade Tasks

This section describes the tasks that you must perform after upgrading to release 3.1.01.

Follow these steps:

  1. If you disabled database replication before upgrade, then after you upgrade to RiskMinder 3.1.01 enable replication for the backup database.
  2. If you configured SSL for the following ports in RiskMinder 2.2.7, then reconfigure SSL.

    Reconfigure SSL as follows:

    This configuration is required because most administrative tasks, such as instance management and protocol configuration, are done using these ports in Administration Console in release 3.1.01.

    Note: For instructions on setting up SSL between Administration Console and RiskMinder Server or Case Management Queuing Server, see "Configuring SSL" in the CA RiskMinder Administration Guide.

  3. Set the Base Currency Code for your organization from the Miscellaneous Configurations screen.

    Note: For more information about setting the organization-specific base currency code, see Managing Global Configurations" in the CA RiskMinder Administration Guide.

  4. If there are any rules with a score of 0 and you want to use these rules for scoring, then change the score to a nonzero value, like 1 or 2.

Replacing Deprecated Rules with New Rules

Four of the predefined rules have been deprecated in release 3.1. Alternative rules have been introduced for these deprecated rules. The following table lists the deprecated and new rules and rule mnemonics:

Deprecated Rule Name and Rule Mnemonic

New Rule Name and Rule Mnemonic

DeviceID Known (DEVICEIDCHECK)

Unknown DeviceID (UNKNOWNDEVICEID)

Device MFP Match (SIGMATCH)

Device MFP Not Match (MFPMISMATCH)

User Associated with DeviceID (USERDEVICEASSOCIATED)

User Not Associated with DeviceID (USERDEVICENOTASSOCIATED)

User Known (USERKNOWN)

Unknown User (UNKNOWNUSER)

Important! Although these rules have been deprecated, they are still available and can be used after the upgrade. However, it is recommended that you replace each deprecated rule with the corresponding new rule by making the required changes in the rule expression.

For any of the four deprecated rules, if the rule evaluates to No, then the rule is considered to have matched and it is used for scoring. In contrast, each of the other predefined rules is considered to have matched when they evaluate to Yes.

In each of the four new rules that is introduced in release 3.1, if the rule evaluates to Yes, then the rule is considered to have matched. In this way, the four new rules are consistent with the other predefined rules.

The following table lists examples that highlight the difference between the deprecated rules and new rules:

Sample Use Case

Deprecated Rule

Deprecated Rule Result

New Rule

New Rule Result

User does not exist in the RiskMinder database.

USERKNOWN

No

UNKNOWNUSER

Yes

DeviceID does not exist in the RiskMinder database.

DEVICEIDCHECK

No

UNKNOWNDEVICEID

Yes

MFP does not exist in the RiskMinder database.

SIGMATCH

No

MFPMISMATCH

Yes

User is not associated with the DeviceID.

USERDEVICEASSOCIATED

No

USERDEVICENOTASSOCIATED

Yes

Follow these steps:

  1. Log in to the administration console.
  2. In the Rule Configurations Report for all organizations and rulesets, verify whether any of the mnemonics that are listed in the Rule expression column of the report belong to the list of deprecated mnemonics.
  3. If a rule uses a deprecated mnemonic and if you do not want to use the deprecated mnemonic, use the corresponding new mnemonic.

    To modify a rule expression:

    1. Log in to the administration console as the GA or OA.
    2. If you have logged in as the GA and you want to perform this procedure for a system ruleset, click the Services and Server Configurations tab.
    3. If you have logged in as the GA or OA to perform this procedure for a single organization:

      Activate the Organizations tab.

      Click the Search Organization link under Manage Organizations.

      Click the Search button on the Search Organization page to display the list of organizations.

      Click the name of the organization.

      Click the RiskFort Configuration tab.

    4. Under the Rules Management section on the side-bar menu, click the Rules and Scoring Management link.

      The Rules and Scoring Management page appears.

    5. From the Select a Ruleset list, select the ruleset for which this configuration is applicable.

      The configuration information for the specified ruleset appears.

    6. Click the rule that you want to modify.

      The Rule Builder page opens.

    7. Make the required changes in the Rule being developed text field.
    8. Save the changes and close the Rule Builder page.
  4. Migrate the modified rule to the production environment, and then refresh the cache.

    Note: For detailed information about migrating a rule to the production environment and refreshing the cache, see the CA RiskMinder Administration Guide.

Reviewing Configuration Changes After the Upgrade

For information about the configuration changes made by the upgrade process, see “Reviewing Configuration Changes After Upgrade” in the CA RiskMinder Installation and Deployment Guide for Microsoft Windows.