Clarity

As there are often questions or problems with the successful installation of the Microsoft (MSP) add-in and OpenWorkbench (OWB) please find some tips and pointers below for the successful install/uninstall of the scheduler add-ins.

Notes:
- with MSP2010 and MSP2013 some documented pre-requisites are required to be installed prior to installing the MSP add-in. These are documented in the Project Management Guide and/or the Installation guide:
office-kb2075992-fullfile-x86-glb.exe [a patch for MSP 2010] - not needed for MSP2013
Microsoft .NET Framework 4 [dotNetFx40_Full_x86_x64.exe]
Microsoft Visual Studio 2010 Tools for Office Runtime [vstor40_x86.exe or vstor40_x64.exe, depending on whether you are running a 32- or 64-bit version of Windows, respectively].
Java Runtime version (JRE)

- with Clarity r13.2 support for 64-bit MSP versions was introduced. This requires that 64-bit JRE version needs to be installed as well as the 64-bit ScheduleConnect software. If 32-bit MSP is used or OWB (which at present is 32-bit application only) then you will need to have 32-bit JRE and 32-bit Schedule Connect installed.

- if the machine already had previous versions of the MSP or OWB, then a clean uninstall of the older version including the Schedule Connect part has to be ensured prior to installing the newer version.
Uninstall and - if necessary - thorough clean up steps are included below.

- the schedulers require a specific version of Java installed and depending on whether your scheduler is 32-bit or 64-bit needs to be the corresponding JRE type. Please note, you can have both 32-bit and 64-bit either same or different build versions installed on a PC


Manually uninstalling and re-installing MSP Interface, Open Workbench and Scheduler Connect Instructions:
-------------------------------------------------------------------------------------------------------------------------------
1. Ensure you do the following with an OS user that has Administrative rights [the quickest and safest way, is to make the OS user part of the Administrators group].
2. Remove from Microsoft Project any dependency on the MSP Interface software, first:
For MSP 2010/MSP2013:
-
launch MSP;
-
go to File -> Options -> Add-Ins;
-
at the bottom of the page, you’ll see a drop-down list labelled Manage; ensure that it reads “COM Add-ins” and click on the button Go;
-
select CAClarityAddIn and click on Remove;
-
go to File -> Info;
-
click on the Organizer button;
-
in the Organizer dialog box, select the Modules tab;
-
remove all modules whose name begins with Niku_* (Niku_API, Niku_Baseline, etc.) and CA_IntegrationHooks;
-
close MSP; if a debug error comes up, choose Debug, then delete all text and close out, choosing Yes or OK at the prompts.

For MSP 2007 and earlier:
-
launch MSP;
-
go to Tools -> Customize -> Toolbars;
-
click on the Toolbars tab and remove the CA Clarity PPM Integration toolbar;
-
go to Tools -> Organizer -> Modules tab, and remove all modules whose name begins with Niku_* (Niku_API, Niku_Baseline, etc.) and CA_IntegrationHooks, if present;
-
close MSP; if a debug error comes up, choose Debug, then delete all text and close out, choosing Yes or OK at the prompts.


3.
Uninstall all Clarity products from the users Workstation via the normal Windows Add/Remove Programs facility. This could include:
Microsoft Project Interface
Open Workbench
Schedule Connect
CAClarityAddIn
The order in which the products are removed is not relevant.

4.
Clean out the Registry.
-
Run regedit
-
Select File -> Export and enter a File Name to store the back-up of the registry just in case]
-
Once finished saving that, delete the following keys:
HKEY_CLASSES_ROOT\Applications\Schedlink.exe
HKEY_CURRENT_USER\Software\Niku
HKEY_LOCAL_MACHINE\Software\Wow6432Node\Niku
HKEY_LOCAL_MACHINE\Software\Niku
Please note that some of the keys may not exist; also, deleting each key will delete all of their subkeys too [which is what we want].

5.
Reboot the system.

6.
Go to Add/Remove Programs again and check that there is no trace left of the products that you have removed at step 1.

7.
Delete the following folders:
C:\Program Files\CA\Clarity\CA Clarity PPM MSPInterface
C:\Program Files\CA\Clarity\CA Clarity PPM Schedule Connect
C:\Program Files\CA\Clarity Setups
C:\Program Files\Open Workbench

Please note that on workstations running a 64-bit version of Windows, the folder names will be prefixed with C:\Program Files (x86)\ instead of C:\Program Files\.

8.
If you have Windows SDK installed, open a command prompt and go to the following directory and execute the :

For 32-bit Windows:
C:\Program Files\Microsoft SDKs\Windows\v7.0A\Bin\NETFX 4.0 Tool

For 64-bit Windows:
C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\Bin\NETFX 4.0 Tool

and from there run:

mage.exe /cc

This will clear the .NET Manifest cache, and is needed in order to ensure that the MSP Interface AddIn will re-install correctly.

9.
Reboot the system again. The manual uninstallation is now complete.

10.
Ensure that Java is installed; the exact version of Java that is needed depends on the Clarity version.
You can download the correct Java installation software from your Clarity site [log into Clarity, then go to Account Settings -> Software Downloads]. Keep in mind that, in version 12.1.0, due to a bug, Clarity would let you download Java 1.5, while the correct version for that Clarity version is Java 1.6; therefore, if running Clarity 12.1.0, you must download Java 1.6.0_20 either from the Clarity installation image, or from the Internet. This problem does not exist in 12.1.1 and later.
If you decide to download Java from the Internet, keep in mind that all Clarity components prior to Clarity r13.2 are 32-bit, so the Java 32-bit VM must be downloaded and installed.
If you have a 64-bit workstation, note that 64-bit Java can be installed on the same machine, at the same time, and even for the same version; this will not interfere with the MSP Interface or OWB as long as, obviously, each Java version resides in its own installation directory.

11.
For MSP 2010/MSP2013 only, you need to ensure that the prerequisites are installed [they are not included in the MSP Interface, they need to be downloaded from Microsoft website]:
Microsoft Project Professional 2010, 32-bit version;
From r13.2 onwards Microsoft Project Professional 2010 & 2013, 32-bit or 64-bit version supported
office-kb2075992-fullfile-x86-glb.exe [a patch for MSP 2010];
Microsoft .NET Framework 4 [dotNetFx40_Full_x86_x64.exe];
Microsoft Visual Studio 2010 Tools for Office Runtime [vstor40_x86.exe or vstor40_x64.exe, depending on whether you are running a 32- or 64-bit version of Windows, respectively].
Support for 64bit MSP versions is only with r13.2 and upwards. If you use MSP 32-bit version, then you will have to install 32 bit SchedConnect and JRE version; if MSP 64-bit then you will need the 64 bit SchedConnect and JRE.

12.
For MSP 2010/MSP2013, before re-installing the Microsoft Project Interface:
-
launch MSP;
-
go to File -> Options -> Trust Centre;
-
click on the Trust Centre Settings button;
-
in the Trust Centre dialog box, go to the Add-ins section; if the check-box labelled “Require Application Add-ins to be signed by Trusted Publisher”, is checked, temporarily uncheck it in order to allow the installation of the MSP Interface Add-in [which, as of release 13.0, is not digitally signed];
-
still in the Trust Centre dialog box, go to the Macro Settings section; temporarily select the option labelled “Enable all macros”.

13.
Re-install Microsoft Project Interface and/or OWB, ensuring that you download the installation software from your Clarity site [log into Clarity, then go to Account Settings -> Software Downloads]. Please install the MSP/OWB version that comes with the server version in order to prevent compatibility problems due to mismatched server and client version [especially after an upgrade of Clarity].

14.
For MSP 2010/MSP2013, after re-installing the Microsoft Project Interface:
-
open MSP;
-
if prompted to Enable Macros, do so; this prompt will appear only the first time you open MSP after the installation of the MSP Interface;
-
ensure that a new tab labelled “CA Clarity PPM Integration” appears in the ribbon, usually between the View and Team tabs;
-
if, at step 10, you disabled the option “Require Application Add-ins to be signed by Trusted Publisher” and/or changed the settings for Macro Settings, you may now restore the old values;
-
close down MSP.

15.
For MSP 2007 and earlier, after re-installing the Microsoft Project Interface:
-
open MSP;
-
ensure the “Macro Security” setting is set to Low; this is needed only for the duration of this step;
-
close MSP down;
-
go to C:\Program Files\CA\Clarity\CA Clarity PPM MSPInterface\data;

double-click on MSPAdd2K.mpp
-
choose Enable Macros if prompted; MSP will close down automatically shortly after that;
-
open MSP and ensure that a new toolbar or menu labelled “CA Clarity PPM-integration” is available;
-
you can now restore the “Macro Security” setting to your level of preference.
-
close down MSP.

MSP and OWB are now ready for normal use.

Thank you Ruth. Some tip.
That will be the new single truth.

That clearly states that you can have both 32 and 64 bit jre installed and the version should match your MS Project/OWB and schedule connect

Could you please elaborate on the difference between Schedule Connect and CAClarityAddIn

Martti K.

Hi Martti,

not sure what you mean about the difference between Schedule Connect and CA Clarity AddIn but I'll give my layman's terms explanation - please feel free anybody to correct me:
Schedule Connect is the software that will allow both MSP and OWB to actually connect to the Clarity server while CA Clarity AddIn is specif to the MSP integration (the macros etc. to have MSP "understand" the Clarity data).

Hence, should you have OWB and MSP installed on the same PC, you would only need to install ScheduleConnect (32-bit) once - provided your MSP is 32-bit :-), and would have CA Clarity PPM Microsoft Project Interface & CA Clarity AddIn, and OWB installed. Now, the exact difference between CA Clarity PPM Microsoft Project Interface & CA Clarity AddIn I can't tell you but with MSP2010 I have sometimes seen that the former was installed but the Toolbar was missing in MSP if the latter wasn't installed correctly (this is the .vsto part of the installation).

If you use OWB only then you should have Schedule Connect and OWB installed.

Hope this helps.

Ruth

Thanks for sharing this useful tip, Ruth :smile

NJ

Thank you again for this private education.

So Schedule connect is the software that connetcs MS Project/OWB with Clarity and CA Clarity Addin is the macro for MS project which you do not have when using OWB (I use only OWB).
Correct me if I am wrong, but the macro was only in MS Project 2007 and earlier (ie prior to MS Project 2010).

Your answer brings up another interesting question:
Can you use MS Project and OWB on the same workstation?
My understanding was that the Schedule connect is different for MS Project and OWB and therefore you could use only either scheduler. Is that correct?

However, 64 bit MS Project changes that, because then you can use 32 bit OWB and 64 bit MS Project each one having their own Schedule connect.

Martti K.

You can have MSP and OWB installed on the same machine, however, it is not recommended to open the same PROJECT sometimes in OWB and then sometimes in MSP because each scheduler has its own algorithm and they will "step on each others toes" so to speak.

As for different schedule Connect, then I have only seen a problem with one particular version (r12.1.3.5 where mspsetup included older consetup than the owbsetup which resulted in OWB throwing an error about incompatibility problem.

As for the questions regarding macros or not with MSP2010 and upwards, I know that we don't use the MSPAdd2K.mpp macro install bit any longer but am not sure whether this means that no macros at all are used any longer. Sorry.

Martti.

The CAClarityAddIn is a VSTO file for MSP 2010+ support to make the CA Clarity PPM Integration piece mimic the new look and feel for MSP 2010 and higher. It auto installed the macro VBA files that had to be double clicked on for the MSPI for MSP 2007 and lower.

Schedule Connect is the piece that talks directly to the Clarity Application Server and it used by both OWB and MSP. Without it you cannot authenticate with the clarity app server and as such not touch the Clarity data.

Regarding 64 and 32 bit together.

If you are used to running the MSP Integration and OWB together on the same workstation, which has never been a recommended course of action., if you are using 64 Bit MSP with Clarity 13.2, you will not be to run OWB on the same system, as it still only has 32 bit support. While you can have 2 different versions of Java installed (32 or 64 bit), I do not believe the same hold for Schedule Connect.

32 Bit MSP will still allow you to have OWB on the same system since it requires the 32 bit Java as will it's packaged SC piece.

As Ruth has already stated, most of the MSP Integration greenpapers, as well as, the product documentation recommend picking a scheduler (MSP or OWB) and sticking with it at the project level. Data discrepancies WILL occur if you toggle between the two for the same project plan.

Remember if your plan looks different in MSP than it does in OWB, CA owns the code for OWB, it does not for MSP. ;-)

Regards,
Jenn

JENN RINELLA
Technology Architect III
RNAM OP PST&M BUS TRANSFORMATION TOOLS

Ericsson
jenn.rinella@ericsson.com
www.ericsson.com

Thanks for sharing all this great information with the community Ruth! :grin:

wunru01 wrote:

As there are often questions or problems with the successful installation of the Microsoft (MSP) add-in and OpenWorkbench (OWB) please find some tips and pointers below for the successful install/uninstall of the scheduler add-ins.

Notes:
- with MSP2010 and MSP2013 some documented pre-requisites are required to be installed prior to installing the MSP add-in. These are documented in the Project Management Guide and/or the Installation guide:
office-kb2075992-fullfile-x86-glb.exe [a patch for MSP 2010] - not needed for MSP2013
Microsoft .NET Framework 4 [dotNetFx40_Full_x86_x64.exe]
Microsoft Visual Studio 2010 Tools for Office Runtime [vstor40_x86.exe or vstor40_x64.exe, depending on whether you are running a 32- or 64-bit version of Windows, respectively].
Java Runtime version (JRE)

- with Clarity r13.2 support for 64-bit MSP versions was introduced. This requires that 64-bit JRE version needs to be installed as well as the 64-bit ScheduleConnect software. If 32-bit MSP is used or OWB (which at present is 32-bit application only) then you will need to have 32-bit JRE and 32-bit Schedule Connect installed.

- if the machine already had previous versions of the MSP or OWB, then a clean uninstall of the older version including the Schedule Connect part has to be ensured prior to installing the newer version.
Uninstall and - if necessary - thorough clean up steps are included below.

- the schedulers require a specific version of Java installed and depending on whether your scheduler is 32-bit or 64-bit needs to be the corresponding JRE type. Please note, you can have both 32-bit and 64-bit either same or different build versions installed on a PC


Manually uninstalling and re-installing MSP Interface, Open Workbench and Scheduler Connect Instructions:
-------------------------------------------------------------------------------------------------------------------------------
1. Ensure you do the following with an OS user that has Administrative rights [the quickest and safest way, is to make the OS user part of the Administrators group].
2. Remove from Microsoft Project any dependency on the MSP Interface software, first:
For MSP 2010/MSP2013:
-
launch MSP;
-
go to File -> Options -> Add-Ins;
-
at the bottom of the page, you’ll see a drop-down list labelled Manage; ensure that it reads “COM Add-ins” and click on the button Go;
-
select CAClarityAddIn and click on Remove;
-
go to File -> Info;
-
click on the Organizer button;
-
in the Organizer dialog box, select the Modules tab;
-
remove all modules whose name begins with Niku_* (Niku_API, Niku_Baseline, etc.) and CA_IntegrationHooks;
-
close MSP; if a debug error comes up, choose Debug, then delete all text and close out, choosing Yes or OK at the prompts.

For MSP 2007 and earlier:
-
launch MSP;
-
go to Tools -> Customize -> Toolbars;
-
click on the Toolbars tab and remove the CA Clarity PPM Integration toolbar;
-
go to Tools -> Organizer -> Modules tab, and remove all modules whose name begins with Niku_* (Niku_API, Niku_Baseline, etc.) and CA_IntegrationHooks, if present;
-
close MSP; if a debug error comes up, choose Debug, then delete all text and close out, choosing Yes or OK at the prompts.


3.
Uninstall all Clarity products from the users Workstation via the normal Windows Add/Remove Programs facility. This could include:
Microsoft Project Interface
Open Workbench
Schedule Connect
CAClarityAddIn
The order in which the products are removed is not relevant.

4.
Clean out the Registry.
-
Run regedit
-
Select File -> Export and enter a File Name to store the back-up of the registry just in case]
-
Once finished saving that, delete the following keys:
HKEY_CLASSES_ROOT\Applications\Schedlink.exe
HKEY_CURRENT_USER\Software\Niku
HKEY_LOCAL_MACHINE\Software\Wow6432Node\Niku
HKEY_LOCAL_MACHINE\Software\Niku
Please note that some of the keys may not exist; also, deleting each key will delete all of their subkeys too [which is what we want].

5.
Reboot the system.

6.
Go to Add/Remove Programs again and check that there is no trace left of the products that you have removed at step 1.

7.
Delete the following folders:
C:\Program Files\CA\Clarity\CA Clarity PPM MSPInterface
C:\Program Files\CA\Clarity\CA Clarity PPM Schedule Connect
C:\Program Files\CA\Clarity Setups
C:\Program Files\Open Workbench

Please note that on workstations running a 64-bit version of Windows, the folder names will be prefixed with C:\Program Files (x86)\ instead of C:\Program Files\.

8.
If you have Windows SDK installed, open a command prompt and go to the following directory and execute the :

For 32-bit Windows:
C:\Program Files\Microsoft SDKs\Windows\v7.0A\Bin\NETFX 4.0 Tool

For 64-bit Windows:
C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\Bin\NETFX 4.0 Tool

and from there run:

mage.exe /cc

This will clear the .NET Manifest cache, and is needed in order to ensure that the MSP Interface AddIn will re-install correctly.

9.
Reboot the system again. The manual uninstallation is now complete.

10.
Ensure that Java is installed; the exact version of Java that is needed depends on the Clarity version.
You can download the correct Java installation software from your Clarity site [log into Clarity, then go to Account Settings -> Software Downloads]. Keep in mind that, in version 12.1.0, due to a bug, Clarity would let you download Java 1.5, while the correct version for that Clarity version is Java 1.6; therefore, if running Clarity 12.1.0, you must download Java 1.6.0_20 either from the Clarity installation image, or from the Internet. This problem does not exist in 12.1.1 and later.
If you decide to download Java from the Internet, keep in mind that all Clarity components prior to Clarity r13.2 are 32-bit, so the Java 32-bit VM must be downloaded and installed.
If you have a 64-bit workstation, note that 64-bit Java can be installed on the same machine, at the same time, and even for the same version; this will not interfere with the MSP Interface or OWB as long as, obviously, each Java version resides in its own installation directory.

11.
For MSP 2010/MSP2013 only, you need to ensure that the prerequisites are installed [they are not included in the MSP Interface, they need to be downloaded from Microsoft website]:
Microsoft Project Professional 2010, 32-bit version;
From r13.2 onwards Microsoft Project Professional 2010 & 2013, 32-bit or 64-bit version supported
office-kb2075992-fullfile-x86-glb.exe [a patch for MSP 2010];
Microsoft .NET Framework 4 [dotNetFx40_Full_x86_x64.exe];
Microsoft Visual Studio 2010 Tools for Office Runtime [vstor40_x86.exe or vstor40_x64.exe, depending on whether you are running a 32- or 64-bit version of Windows, respectively].
Support for 64bit MSP versions is only with r13.2 and upwards. If you use MSP 32-bit version, then you will have to install 32 bit SchedConnect and JRE version; if MSP 64-bit then you will need the 64 bit SchedConnect and JRE.

12.
For MSP 2010/MSP2013, before re-installing the Microsoft Project Interface:
-
launch MSP;
-
go to File -> Options -> Trust Centre;
-
click on the Trust Centre Settings button;
-
in the Trust Centre dialog box, go to the Add-ins section; if the check-box labelled “Require Application Add-ins to be signed by Trusted Publisher”, is checked, temporarily uncheck it in order to allow the installation of the MSP Interface Add-in [which, as of release 13.0, is not digitally signed];
-
still in the Trust Centre dialog box, go to the Macro Settings section; temporarily select the option labelled “Enable all macros”.

13.
Re-install Microsoft Project Interface and/or OWB, ensuring that you download the installation software from your Clarity site [log into Clarity, then go to Account Settings -> Software Downloads]. Please install the MSP/OWB version that comes with the server version in order to prevent compatibility problems due to mismatched server and client version [especially after an upgrade of Clarity].

14.
For MSP 2010/MSP2013, after re-installing the Microsoft Project Interface:
-
open MSP;
-
if prompted to Enable Macros, do so; this prompt will appear only the first time you open MSP after the installation of the MSP Interface;
-
ensure that a new tab labelled “CA Clarity PPM Integration” appears in the ribbon, usually between the View and Team tabs;
-
if, at step 10, you disabled the option “Require Application Add-ins to be signed by Trusted Publisher” and/or changed the settings for Macro Settings, you may now restore the old values;
-
close down MSP.

15.
For MSP 2007 and earlier, after re-installing the Microsoft Project Interface:
-
open MSP;
-
ensure the “Macro Security” setting is set to Low; this is needed only for the duration of this step;
-
close MSP down;
-
go to C:\Program Files\CA\Clarity\CA Clarity PPM MSPInterface\data;

double-click on MSPAdd2K.mpp
-
choose Enable Macros if prompted; MSP will close down automatically shortly after that;
-
open MSP and ensure that a new toolbar or menu labelled “CA Clarity PPM-integration” is available;
-
you can now restore the “Macro Security” setting to your level of preference.
-
close down MSP.

MSP and OWB are now ready for normal use.