Calyx RIM Viewing 5.5 CHF 7 Upgrade Guidelines

Upgrade Calyx RIM Viewing

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

To upgrade Calyx RIM Viewing:
  1. Stop the Apache Tomcat service.
  2. Copy the config.xml, dbconfig.properties, mailconfig.properties, License.xml, LdapConfig.xml,configIdP.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 or copy configIdP.xml and ldap-map.xml files only if the authentication mode you are using is IdP. 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. Backup the struts-config.xml file from the <drive>:\Program Files\Apache Software Foundation\Tomcat<version>\webapps\I4V\WEB-INF folder.
    The struts-config.xml file will not exist for Calyx RIM Viewing 5.5 CHF 6 and some its values must be copied to config.xml. Refer to step 16 for the details.
  4. Remove the I4V folder and I4V.war file (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"/>
    Note: The default settings for these values in config.xml are listed below. Make sure that you have changed your parameters to those indicated with your own settings. Example: instead of <property name="cacheLocation" value="C:\\data\\EDRCache"/>, by default you will have <property name="attachmentsLocation" value="D:\\$($INSTANCE.I4V_DATA_TAG)_data\\attachments"/>. Put your own settings instead of D:\\$($INSTANCE.I4V_DATA_TAG)_data\\attachments. 
    <property name="attachmentsLocation" value="D:\\$($INSTANCE.I4V_DATA_TAG)_data\\attachments"/> 
<property name="bulkIndexPoolSize" value="2"/> 
<property name="cacheLocation" value="D:\\$($INSTANCE.I4V_DATA_TAG)_data\\EDRCache"/> 
<property name="edmsTempLocation" value="D:\\$($INSTANCE.I4V_DATA_TAG)_data\\EDMSTemp"/> 
<property name="enableAutoIndex" value="true"/> 
<property name="enableBulkIndex" value="true"/> 
<property name="indexLocation" value="D:\\$($INSTANCE.I4V_DATA_TAG)_data\\lucene"/> 
<property name="rememberUserName" value="false"/>
<property name="serverPDFStream" value="true"/>
<property name="fileNameForAutoRegister" value="index.xml"/>
<property name="enableAutoRegister" value="true"/>
  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 22 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.

    The example below is for one Domain only, copy your values to <map> element for several Domains if required. 

    <property name="vendor" value="your value"/>
<property name="singleSignOn" value="your value"/>
<property name="initialContextFactory" value="com.sun.jndi.ldap.LdapCtxFactory"/>
<property name="timeOut" value="your value"/>
<property name="domains">
    <map>
<entry value="your value" key="domain"/>
<entry value="your value" key="url"/>
<entry value="your value" key="rootdn"/>
<entry value="your value" key="rootpassword"/>
<entry value="your value" key="searchContext"/>
<entry value="your value" key="userIdAttributeName"/>
<entry value="your value" key="searchStrategy"/>
<entry value="your value" key="enableSubgroupsLookup"/>
</map>
  15. If using the IdP, take note of the following values i.e. your value, from the configIdP.xml file.
    The configIdP.xml file is typically found in C:\temp\config.

    The example below is for Azure authentication type only, the properties for Okta authentication type differ. 

    accessTokenUri="your value/your value/oauth2/token" 
appLogoutUri="your value/common/oauth2/logout?post_logout_redirect_uri=your value" 
baseUrl="https://login.microsoftonline.com" 
clientId="your value" 
clientSecret="your value" 
graphApiVersion="1.6" 
graphUri="https://graph.windows.net" 
issuerBaseUri="https://sts.windows.net" 
keyDiscoveryUri="https://login.windows.net/common/discovery/keys" 
nameIdP="your value" 
tenantId="your value" 
timestampTolerance="10" 
trustedApplications="" 
urlToRedirect="your value" 
userAuthorizationUri="your value/your value/oauth2/authorize"
  16. 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.
  17. Copy the values backed-up from the struts-config.xml file to the 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. 
     <!-- SubmissionContextPlugin -->    
<property name="threadSleepTimeForAutoRegister" value="7200000"/>    
<property name="fileNameForAutoRegister" value="register.txt"/>    
<!-- NotificationPlugin -->
<property name="threadSleepTimeForDataExchange" value="7200000"/>
<property name="fileNameForDataExchange" value="InSight_for_Viewing_Sub_Status_"/>
<!-- UserCredentialsPlugin -->
<property name="encryptedDefaultPassword" value="true"/>
<property name="defaultUserName" value="admin"/>
<property name="defaultPassword" value="9JyRLx3FI57OMijKdwfnug=="/>
    Table 1. Old struts-config.xml property names and new config.xml property names
    struts-config.xml config.xml
    threadSleepTime (SubmissionContextPlugin) threadSleepTimeForAutoRegister
    configFileName fileNameForAutoRegister
    threadSleepTime(NotificationPlugin) threadSleepTimeForDataExchange
    notificationFileName fileNameForDataExchange
    encrypted encryptedDefaultPassword
    username defaultUserName
    password defaultPassword
  18. 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.
  19. Take note of the values from the mailconfig.properties file, which is typically present in C:\temp\config.
  20. Start Apache Tomcat service.
  21. 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.
  22. Enter the values for the database configuration in the Database Configuration Details section. Click Update.
    Authentication Mode Description
    LDAP or LDAP Authentication Only If you are using either LDAP or LDAP Authentication Only mode for authentication, click No in the confirmation message and move to step 23.
    IdP or IdP Authentication Only If you are using either IdP or IdP Authentication Only mode for authentication, click No in the confirmation message and move to step 24.
    Else, click Yes and move to step 25.
  23. 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 in 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 in the confirmation message window.
  24. Select the authentication mode under Authentication Mode drop-down.
    1. Enter the details noted in step 15 or as required.
    2. Click Update and then click Yes in the confirmation message window.
    3. If you want to add multiple IdP providers, click No.
    4. Click Add, select the Provider Type and enter the other details as required.
    5. Perform the same steps to add multiple IdP providers.
    6. Click Update and then click Yes in the confirmation message window.
  25. Restart Apache Tomcat service.
  26. 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 or IdP account with Administrator privileges for IdP or IdP 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.
  27. In the Administrator console, click Server Settings. Select the E-mail Configuration tab and enter the values as required:
    Field Name Value
    SMTP Host Name Enter the name/IP address of the SMTP server.
    SMTP Server Port No 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.