Installing Calyx RIM Viewing

Perform the following procedure if you are upgrading from a previous version of Calyx RIM Viewing.

1. Stop the Apache Tomcat service.
2. Copy the config.xml, dbconfig.properties, mailconfig.properties, License.xml, LdapConfig.xml and ldap-map.xml files from the <drive>:\Program Files\Apache Software Foundation\Tomcat <version>\webapps\I4V\WEB-INF\config folder to a temporary location such as C:\temp\config.
   Note: Copy Ldapconfig.xml and ldap-map.xml files only if the authentication mode you are using is LDAP. If you are deleting a repository, delete the respective context file from the path: C:\Program Files\Apache Software Foundation\Tomcat <version>\conf\Catalina\localhost.

   Note: If you are deleting a repository, delete the respective context file from the path: C:\Program Files\Apache Software Foundation\Tomcat <version>\conf\Catalina\localhost
3. Copy the struts-config.xml file from the <drive>:\Program Files\Apache Software Foundation\Tomcat <version>\webapps\I4V\WEB-INF folder to a temporary location such as C:\temp\config.
4. Remove the I4V folder and I4V.warfile (if present), found under the webapps subfolder.
   You can find the webapps subfolder in your Tomcat installation directory. On a Windows system, this is typically C:\Program Files\Apache Software Foundation\Tomcat <version>\webapps.
5. Delete the Catalina folder from the Tomcat installation directory.
   On a Windows system, this is typically C:\Program Files\Apache Software Foundation\Tomcat <version>\work.
6. Copy the I4V.war file to your webapps subfolder.
   You can find the webapps subfolder in your Tomcat installation directory. On a Windows system, this is typically C:\Program Files\Apache Software Foundation\Tomcat <version>\webapps.
7. Start the Apache Tomcat service.
   When you start the Apache Tomcat service, the I4V folder is created under the webapps folder.
8. After five or more minutes stop the Apache Tomcat service.
9. Remove the I4V.war file from the <drive>:\Program Files\Apache Software Foundation\Tomcat <version>\webapps folder.
10. Copy the following values (i.e. your value) from the config.xml file in C:\temp\config into the config.xml file present in the <drive>:\Program Files\Apache Software Foundation\Tomcat <version>\webapps\I4V\WEB-INF\config folder.
    Important: DO NOT REPLACE THE FILES, ONLY REPLACE THE VALUES.

    
    				<property name="cacheLocation" value="your value"/> 
    				<property name="indexLocation" value="your value"/> 
                <property name="attachmentsLocation" value="your value"/> 
    				<property name="showClosedAnnotation" value="your value"/> 
    				<property name="maxNoOfLoginAttempts" value="your value"/> 
    				<property name="RemoveRegistertxtFile" value="false"/> 
    				<property name="useFileTagTranslation" value="your value"/> 
    				<property name="interceptorEnable" value="your value"/>
    			 

11. In the config.xml file, search for the <property name=auto_registration_listeners_list> and specify the e-mail address within <email>[email protected]</email> to receive e-mail notification on auto registration.
12. In the config.xml file, set the <property name="Asynchronous_registration" value="your value"/> and under <asynchronous_app_register_mail_list> specify the e-mail addresses of the users to whom the mail notifications should be sent on asynchronous application registration.
    If you change the setting to <property name="Asynchronous_registration" value="false"/> then there is no need to specify the e-mail addresses of the users.
13. Take note of the database values present in the dbconfig.properties file.
    These values would be used to configure the database via the user interface in step 21 of this procedure. The dbconfig.properties file is typically found in C:\temp\config.
14. If using the LDAP, take note of the following values i.e. your value, from the LdapConfig.xml file.

    The LdapConfig.xml file is typically found in C:\temp\config.

     
    				<property name="vendor"value="your value"/> 
    				<property name="url" value="your value"/> 
    				<property name="rootdn" value="Admin user [email protected]"/> 
    				<property name="rootpassword" value="your value"/> 
    				<property name="userPwdAttributeName"value="your value"/> 
    				<property name="userIdAttributeName" value="your value"/> 
    				<property name="searchContext" value="CN=<yourCN>, DC=<yourDC_part1>, DC=<yourDC_part2>"/> 
    				

15. Replace the ldap-map.xml file from the <drive>:\Program Files\Apache Software Foundation\Tomcat <version>\webapps\I4V\WEB-INF\config folder with the one present under C:\temp\config.
16. Copy the values from struts-config.xml file in C:\temp\config into the struts-config.xml file in the <drive>:\Program Files\Apache Software Foundation\Tomcat <version>\webapps\I4V\WEB-INF folder.
    Important: DO NOT REPLACE THE FILE, ONLY REPLACE THE VALUES.

    
    				<plug-in className="com.liquent.insight.viewing.plugins.SubmissionContextPlugin">
    				<set-property property="threadSleepTime" value="your value"/>
    				<set-property property="configFileName" value="your value"/>
    				</plug-in>
    				<plug-in className="com.liquent.insight.viewing.business.dataExchange.I4R.notification.NotificationPlugin">
    				<set-property property="threadSleepTime" value="your value"/>
    				<set-property property="notificationFileName" value="your value"/>
    				</plug-in>
    				<plug-in className="com.liquent.insight.viewing.plugins.UserCredentialsPlugin">
    				<set-property property="encrypted" value="your value"/>
    				<set-property property="username" value="your value"/>
    

17. Replace the file License.xml from <drive>:\Program Files\Apache Software Foundation\Tomcat <version>\webapps\I4V\WEB-INF\config folder with the one present under C:\temp\config.
18. Take note of the values from the mailconfig.properties file, which is typically present in C:\temp\config.
19. Start Apache Tomcat service.
20. Log on to the Viewing Administrator Console using URL <http://xxxx/I4V/> with the default Administrator account. Perform the applicable instructions in this step for your system.
21. Enter the values for the database configuration in the Database Configuration Details section. Click Update.
    • If you are using either LDAP or LDAP Authentication Only mode for authentication, click No in the confirmation message and move to the next step.
    • Else, click Yes and move to step 23.
22. Select the authentication mode under Authentication Mode drop-down.
    1. Enter the details noted in step 14 or as required.
    2. To use Single Sign-on feature, select the option Single SignOn.
    3. Click Update and then click Yes to the confirmation message window.
    4. If you want to add multiple domains, click No.
    5. Click Add Domain and enter the other details as required.
    6. Perform the same steps to add multiple domains.
    7. Click Update and then click Yes to the confirmation message window.
23. Restart Apache Tomcat service.
24. Log on to the Viewing Administrator Console using the default Administrator account for Database authentication, or LDAP account with Administrator privileges for LDAP or LDAP Authentication Only mode.
    If you have opted for the Single SignOn feature, you will be able to access the Viewing Administrator Console without having to enter the credentials.
25. In the Administrator console, click Server Settings. Select the E-mail Configuration tab and enter the values as required:
    • SMTP Host Name – Enter the name/IP address of the SMTP server.
    • SMTP Server Port – Enter the server port number. By default it will be 25. (Change the port, if necessary.)
    • SMTP User Name – Enter the username of the SMTP server. (This step is applicable for external e-mail exchange servers only.)
    • SMTP User Password – Enter the username of the SMTP server. (This step is applicable for external e-mail exchange servers only.)
    • Administrator Email – Enter the e-mail address from which all the e-mails are to be sent.
      Note: The recipient will see this in the from address when they receive the e-mail.
    • Server Name – Enter the server name.
      Note: Recipients will see the server name when they receive e-mails.

    Note: Select the option SSL Enabled only if you are using an external e-mail exchange server that requires SSL.
    The functionality is now installed, active, and ready to use. For database and cache migration, refer to the applicable procedure in the Database Migration Guide.