MSP: Install and Configure the Microsoft Project Interface
As an administrator, you can install and configure Microsoft Project (MSP) as a scheduling tool to integrate with
Clarity PPM. Install and configure Microsoft Project, the CA PPM Microsoft Project interface, and the Schedule Connect software on each client workstation. After each installation, restart each computer.
Changing the recommended settings and steps in this documentation can cause unexpected behavior. Undocumented settings can result in changes to project schedule dates, resource assignments, and costs. See KB 11553: How do Microsoft Project monthly patches impact Clarity PPM? If you need assistance, contact your administrator.
Install the Required Software
Before you install the Microsoft Project Interface, verify that you have installed the following third-party software:
- A supported version of Microsoft Project.
- A supported version of the Microsoft .NET Framework for Windows.
- A supported version of Microsoft Visual Studio Tools for Office Runtime
If you upgrade from a previous release of
Clarity PPM, remove, re-install, and update your Microsoft Project software and verify that data populates appropriately in Microsoft Project. Set the scheduling option to
Automaticwhen you always want to open the schedule in Microsoft Project.
Configure the Microsoft Project Interface
Grant User Access Rights
Clarity PPMaccess rights are required to view or manage projects with Microsoft Project.
Open a project
- Project - View Management - All (Read-Only)
- Project - Edit Management - All (Read/Write)
Create a project
- Project - Create
Display resources and roles to which you have been granted access rights
- Resource - Soft Book - All
- Resource - Hard Book - All
Change the allocations of a resource
- Resource - Soft Book
- Resource - Hard Book
You must have
Resource - Hard Bookrights to change the allocation of a resource who is hard-booked.
Set the baseline of a project
- Project - Edit Management - All
- Project - Modify Baseline
If you are granted the
Project - Modify Baselineright at the instance or organizational breakdown structure (OBS) level, you are implicitly granted the
Project - Edit Management - Allright. If you are granted the
Project - Modify Baseline - Allright at the global level, you are not granted the
Project - Edit Management - Allright. You must explicitly be granted the
Project - Editright and the
Project - Edit Managementright to set the baseline on a specific project.
Set Internet Explorer Browser Options
The following steps apply only if using Internet Explorer 11 instead of a more modern browser.
Prevent the file download window from appearing when the browser encounters an encrypted page by setting the following browser option. For more information, see the Microsoft Internet Explorer help.
Follow these steps:
- In Internet Explorer, select Tools, Internet Options and click the Advanced tab.
- Scroll to the Security section.
- Clear theDo not save encrypted pages to diskcheck box.
- Click OK.
Set the Windows Explorer Options
Prevent issues when saving projects from Microsoft Project to
Clarity PPMby setting the following Windows Explorer option. For more information, see the Microsoft Windows help.
Follow these steps:
- In Windows Explorer, click Organize and select Folder and search options.
- Click View.
- Clear theHide extensions for known file typescheck box.
- Click OK.
Note: Verify that
Hide extensions for known file typesis not selected. If the setting is selected, it can cause problems when you try to save Microsoft Project files.
Set the Trust Center Level in Microsoft Project
Configure the Microsoft Project settings to subsequently enable the
Clarity PPMMicrosoft Project Interface add-in installation macro.
Follow these steps:
- Open Microsoft Project.
- Select File, Options.
- Click Trust Center, Trust Center Settings.
- Click Add-ins. Clear therequire application add-ins to be signed by trusted publisheroption.
- Return to the Trust Center page.
- Click Macro Settings and select theenable all macrosoption.This setting can be changed after the installation.
Install the Microsoft Project Interface with Schedule Connect
The Schedule Connect interface enables the exchange of data between
Clarity PPMand Microsoft Project. Schedule Connect provides the following capabilities:
- Synchronized communication betweenClarity PPMand Microsoft Project.
- Improved performance when using the new XML version of theClarity PPMinterface with Microsoft Project. When opening and saving a project, all information is sent to and fromClarity PPMin one large block. The block is parsed and formatted in XML, and then opened in Microsoft Project.
- SSL and proxy server security without requiring you to open special ports.
Install a version of the Microsoft Project Interface and Schedule Connect that is the same version of your
Clarity PPMMicrosoft Project Interface / Schedule Connect is required when upgrading
Clarity PPM. Uninstall all the following components if they are present prior to upgrading:
- Clarity PPM Microsoft Project Interface
- Clarity PPM Schedule Connect
- Open Workbench (if installed)
If you have any custom views for Open Workbench (OWB), ensure that you save the custom views in a separate folder before you uninstall.
When upgraded, the latest product enhancements and bug fixes display.
Follow these steps:
- Close all instances of Microsoft Project.
- Download the Microsoft Project Interface using one of the following methods:
- : Navigate to Clients\MSPInterface\New and clickClarity PPMmediamspsetup.exe. If installing from the media, run the Schedule Connect installation manually. It does not run automatically as it does with the next option.
- : This download option includes Schedule Connect.Clarity PPMuser interface
- ClickHome,Personal,Account Settings.
- Click theSoftware Downloadstab. You must have theSoftware Download - Microsoft Project Interfaceaccess right to download the software.
- Click the appropriate compatible download link for eitherMicrosoft Project Interface (x86)orMicrosoft Project Interface (x64).
- SelectRunorSavewhen prompted to run or save the mspsetup.exe file. If you selectSave, open the file when you are ready to perform the installation.
- Select your language preference for the installer.To reduce unexpected behavior and variability in troubleshooting, set the same language in your integrated applications. For example, set the same language in Microsoft Project, the MSP interface connector, Microsoft Windows, andClarity PPM. Your Windows Regional Settings must always match the language of your Microsoft Project installation. SeeConfigure Windows Regional Settingsfor detailed steps.
- ClickOKto continue with the setup process.TheClarity PPMMicrosoft Project Interface withClarity PPMSchedule Connect Setup wizard opens.
- Follow the on-screen instructions.If you have an existing installation, clickYeswhen prompted to copy the files to the same directory.
- ClickFinishand exit the wizard when the installation is complete.The installation completed dialog appears after the installation is successful. If the installation fails, uninstall and reinstall the programs.
Configure Windows Regional Settings
If you set your language for Microsoft Project to Portuguese (Brazil), set your Windows Regional Settings to Portuguese (Brazil) to match. Match English (United States) in MSP with English (United States) in Windows. Non-matching Regional Settings can cause integration problems with decimal values such as % Complete or % Allocation. Non-matching language settings can also result in errors with successors and predecessors. In some cases, if you save a project with non-matching OS and application language settings, data loss can occur.
Follow these steps:
- In Windows 8.1 or 10, clickStart,Settings. In Windows 7, open your control panel and skip to Step 4.
- InWindows Settings, clickTime & Languageand then clickRegion & language.Changing the country or language in the screen example above does not resolve potential issues. Follow the steps listed here exactly.
- UnderRelated settings, clickAdditional date, time, & regional settings. You might see this option by scrolling down or to the right. Skip to Step 5.
- (Optional) As a shortcut:
- Windows 7, 8.1, and 10 users can open theControl Panel. (You can also press the Windows logo key and theRkey (Windows+R) and typecontrol panel.)
- Depending on theView bysetting, clickChange date, time, or number formatsor clickRegion.
- In theRegiondialog box, on theFormattab, change the language to match your Microsoft Project language setting. ClickOK.Do not clickAdditional settings.
Set Up the Server Connection
When you open a project from
Clarity PPMto update in Microsoft Project, you implicitly log in to
Clarity PPM. Schedule Connect remembers your settings. When logged in, a session is established for a target project instance and you do not need to log in again. You only need to enter your password the next time you save projects or browse for resources in
If you open a project from Microsoft Project and save it to
Clarity PPM, Schedule Connect connects you to the specified
Clarity PPMserver. Use these steps to set up a first-time connection to
If you are using federated single sign-on (SSO), you must have an open
Clarity PPMbrowser session. This browser session must be in the environment to which you are trying to connect, which is defined in the CA PPM Host field.
Follow these steps:
- With Microsoft Project open, click theClarity PPMIntegration menu or toolbar, and go to Open.
- Enter yourClarity PPMuser name and password, and click >>Setup.
- Complete the following fields:
- SSL Handling.Specifies the Secure Sockets Layer (SSL) handling preference.Values:
- Full. SSL is used for all communications including logins and data exchanges.
- Login. SSL is used when logging in and bypassed for all other data exchanges.
- None. No connection through SSL.
- CA PPM Host.Defines the name of theClarity PPMserver to which Microsoft Project is connected. This server defines the location from which you open a project, or to which you save a project. The login host is not the full URL.Default:<CA PPM Host>Example:corpName
- Port.The port for theClarity PPMserver.Example:80 is the default port for aClarity PPMserver.To determine the port number, verify the CSA application server settings, the application logon URL, or contact yourClarity PPMadministrator. Schedule Connect uses the field defining the port on the Application Entry URL to load information. Therefore, independent of the port field, this field must also contain a reference to<server_name>:<portnumber>.If you are using SSL, enter 443.
- Proxy Host.Defines the name of your proxy server. The proxy host is not the full URL. An entry for Proxy Host is only required when accessing an authenticating proxy.Example:corpProxyIf you are accessingClarity PPMthrough a nonauthenticating proxy, enter the proxy host and port in the CA PPM Host and Port fields.
- Port.Defines the port for the proxy server.
- Proxy User Name.Defines the user name for connecting to the proxy server.
- Proxy Password.Defines the password for connecting to the proxy server.
- Click OK.You are connected to theClarity PPMserver.
You can connect Schedule Connect to only one server at a time. To open or save projects to a different server, change the connections settings. When pointing Schedule Connect to another server, be sure to update the Proxy server setting if necessary.
Configure Microsoft Project Options
Set the Microsoft Project options to work effectively with
- In Microsoft Project, select File, Options.
- Click Schedule to set the Calculation option. This option determines if Microsoft Project automatically reschedules your plan. This setting affects what is displayed inClarity PPMwhen you save the plan back toClarity PPMafter scheduling is completed.
- On:Microsoft Project automatically schedules the plan every time you open aClarity PPMproject or when you tab out of the field you have edited.
- Off:Microsoft Project does not schedule your plan automatically every time you open a project or when you tab out of a field you have edited. As a result, several fields in Microsoft Project are not updated with the latest information. For example, the summary tasks do not display the updated roll-up values. For more information about what is not calculated, see theMicrosoft Project Help.
- Click Schedule to configure the calendar. Verify that the values in theCalendar options for this projectsection map to the values set inClarity PPM.For most organizations, you may need to update the following fields:
- Week starts on
- Fiscal year starts in
- The other fields map to your organization's settings.
- Click Advanced and clear theShow links between projects dialog on opencheck box in theCross project linking options for this projectsection. This feature is incompatible withClarity PPMexternal dependencies, and is ignored when selected.
- Click Save in the Project Options window. You can update the file location based on your requirements and you can save the MPP files to any folder. However, if you share your computer with other users and update master projects, set the file location to a commonly shared folder. See your Windows administrator for assistance.
Configure Default Settings in Microsoft Project
The business rules in
Clarity PPMand Microsoft Project are different. To normalize the Microsoft Project integration with
Clarity PPM, configure the default settings in Microsoft Project.
If you do not set these options, task and resource scheduling have inconsistencies. The inconsistencies appear after you save the project to
Clarity PPMfor the first time and then open it again in Microsoft Project. You configure the settings in:
- Microsoft Project Client
- Clarity PPM, when you prepare to import a legacy project plan for the first time.
Follow these steps:
- In Microsoft Project, select Tools, Options, and click Schedule.
- (Optional) Select Percentage for theShow assignment as anoption.
- Select Auto Scheduled for theNews tasks createdoption.All of the new tasks that are created inClarity PPMare calculated or auto-scheduled, depending on the overall project calculation setting. The new tasks that are created in Microsoft Project are not saved inClarity PPMunless the task is calculated.
- Select Project Start Date for theAuto scheduled tasks scheduled onoption.
- Select Days for theDuration is entered inoption. Ensure the duration is days for Microsoft Project before synchronizing.
- Enable the following options:
- Split in-progress tasks.Fills the gaps in work while using Resource Leveling.
- Tasks will always honor their constraint dates.Constraints are important for scheduling and override task relationships such as dependencies.
- (Optional)Show that scheduled tasks have estimated durations
- Calculate project after each edit.You receive instant feedback on Microsoft Project edits. The projects you export fromClarity PPMto Microsoft Project are calculated and up-to-date.
- Disable the following options:
- New tasks are effort driven.When a resource is added to a task that has an existing assignment, the remaining work is shared with the resource. The resource is not assigned to any new work. However, all new assignments inClarity PPMhave Estimate to Complete (ETC) calculated. Ensure thatClarity PPMand Microsoft Project are matched to calculate remaining work on new assignments.
- (Optional)New scheduled tasks have estimated durations
- Updating Task status updates resource statusDisable this option for the projects that are tracking through time sheets.If you set a task as 100 percent complete, the remaining work is moved to actual work irrespective of the Update Task status update resource status setting.
- (Optional) Inserted projects are calculated like summary tasks.
- (Optional) Actual costs are always calculated by Project.
- Select Tools, Options, and click General.Do not use the Date Format as an option that includes a time stamp.
- Select Tools, Options and click Advanced.
- Enable the following options:
- Allow cell drag and drop
- (Optional) Move selection after enter
- (Optional) Ask to update automatic links
- (Optional) Edit directly in cell
- (Optional) Edits to total task % complete will be spread to the status date
- (Optional) Calculate multiple critical paths
- (Optional) Select % Complete for the Default task Earned Value method option.
- (Optional) Select Baseline for the Baseline for Earned Value calculation.While configuring the options for an open project, a messageOptions for this project: <project name>.mppappears. Change the message toOptions for this project: All New Projects wherever required.TheClarity PPMrepository owns the Company, Project, and Resource calendars. Make changes to these calendars only usingClarity PPM. Changes made using Microsoft Project are dropped without an error message. If you need to create a calendar using Microsoft Project, ensure that calendar fields match the values inClarity PPM.
Configure Project Properties in Microsoft Project
To ensure that the Microsoft Project fields are mapped to
Clarity PPMfields, configure the properties of the project in Microsoft Project.
- In Microsoft Project, select File, Info, Project Information and click the Summary tab.
- Verify that the fields from the Summary tab, as listed in the following table, are mapped toClarity PPM.
Microsoft Project Field
Do not edit the Title, Manager, and Hyperlink Base.
Configure Resource Leveling in Microsoft Project
The Resource Leveling properties of a project act as the default properties for the new projects.
- Select Tools, Resource Leveling from Microsoft Project for project 1.
- Set theLeveling calculationsasManual.
- (Optional) Set theLook for overallocations on aDay by Day basis.
- (Optional) Set theLeveling ordertoStandard. Leveling can adjust individual assignments on a task.
- Disable theLeveling can create splits in remaining workoption.