You are on page 1of 11

CU Installation Guide

Clarity Connect 3.x

AUTHOR Clarity Connect

LAST UPDATE March 10, 2016

© 2015 PROPRIETARY & CONFIDENTIAL 1 OF 11


Contents
Step 1: Worksheet ....................................................................................................... 3
Step 2: Patch Installer .................................................................................................. 3
Step 3: Reporting ....................................................................................................... 10
Contacting Clarity Support ......................................................................................... 11
Appendix: Manual Rollback ....................................................................................... 11

© 2015 PROPRIETARY & CONFIDENTIAL 2 OF 11


Step 1: Worksheet

Please fill out the worksheet before starting the installation of the Clarity Connect
CU as the values will be used throughout the installer.

Configuration Value
Runtime Database server
Ex. Sql-01
Runtime Database name
Ex. CcMain
Datawarehouse server
Ex. Sql-01
Datawarehouse name
Ex. CcMain_DW
Connect Directory (Including
Instance Folder)
Ex. C:\Program Files\Clarity
Consulting\Clarity Connect

Step 2: Patch Installer

Important: Install cumulative updates during a planned outage period, as updates


may take several hours.
Log on to the application server as a user with

• local admin rights


• read rights on the runtime and data warehouse databases
• query rights on the runtime and data warehouse databases
• create/alter table rights on the runtime and data warehouse
databases

© 2015 PROPRIETARY & CONFIDENTIAL 3 OF 11


Start the Clarity Connect Patch Installer and use the Worksheet above to fill in the
values throughout each window.

The Patch Installer will automatically create a backup of the entire Connect
directory and restore it in case of any issues. In addition, it will automatically test
the connections to the databases and notify the user of any issues before
proceeding with the installation.

The Patch Installer automatically stops any running services and starts them at the
end of the installation.

Attention: If the services are manually stopped prior to running the Patch Installer,
they will have to be manually started.

Installer Dialog Parameters

© 2015 PROPRIETARY & CONFIDENTIAL 4 OF 11


 Runtime Database server
 Runtime Database name
 Datawarehouse server
 Datawarehouse name

*If a database connection


fails, the user will be notified
for further troubleshooting.

© 2015 PROPRIETARY & CONFIDENTIAL 5 OF 11


 Connect Directory

© 2015 PROPRIETARY & CONFIDENTIAL 6 OF 11


*Active calls on the server
will not prevent the Patch
Installer from running, but
will result in a prompt to the
user.

*All active services will


automatically stopped by the
patch installer.

© 2015 PROPRIETARY & CONFIDENTIAL 7 OF 11


*Indexes may take several hours
to complete.

© 2015 PROPRIETARY & CONFIDENTIAL 8 OF 11


*Previously running services
will be automatically started.

© 2015 PROPRIETARY & CONFIDENTIAL 9 OF 11


Step 3: Reporting

The Reporting folder of the Clarity Connect CU contains RDL files that should be
manually uploaded to SQL Server Reporting Service (SSRS) server.

1. Log in to SQL Server Reporting Service (SSRS) server as a user with local
admin rights.
2. Locate the Reports Folder used by Clarity Connect. By default, this folder is
named Main.

3. Open the folder and click on Upload file in the toolbar.

4. Browse for the RDL File on the machine.


Example: CU/Reporting/3.1/DataReport.rdl
5. Once the file is selected, the File to upload and Name fields should be
automatically filled in. Next, check the “Override item if exists” checkbox.
6. Click OK to upload the file.
*Repeat for all RDL files.

© 2015 PROPRIETARY & CONFIDENTIAL 10 OF 11


Contacting Clarity Support

To report an issue, contact Clarity Connect support via e-mail at


ccsupportdesk@claritycon.com, or log on to the support web portal at
https://connectsupport.claritycon.com.
For immediate assistance, give us a call at 1.855.983.6368 or 1.312.863.3103.
Appendix: Manual Rollback

The Patch Installer has a built-in feature to automatically roll back changes if a failure
is encountered during the patching process.
A manual rollback can also be performed by following the steps below:
1. Log on to the application server as a user with local admin rights.
2. Stop all Clarity Connect services using Windows Services.
3. Stop the Clarity Connect website and Application Pool using IIS.
4. Navigate to the Backups folder located in Connect Directory (on the Worksheet
Parameter table).
5. Extract the content of the desired backup to a temporary folder.
6. Replace all contents in the Connect Directory (on the Worksheet Parameter
table) with the data from the temporary folder.
7. Start all Clarity Connect services using Windows Services.
8. Start the Clarity Connect website and Application Pool using IIS.

© 2015 PROPRIETARY & CONFIDENTIAL 11 OF 11

You might also like