MSP: Install and Configure the Microsoft Project Interface

ccppmop158
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.
3
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
For supported versions for your release of
Clarity PPM
, see the Release Notes.
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
Automatic
when you always want to open the schedule in Microsoft Project.
Configure the Microsoft Project Interface
Grant User Access Rights
The following
Clarity PPM
access 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 Book
rights 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 Baseline
right at the instance or organizational breakdown structure (OBS) level, you are implicitly granted the
Project - Edit Management - All
right. If you are granted the
Project - Modify Baseline - All
right at the global level, you are not granted the
Project - Edit Management - All
right. You must explicitly be granted the
Project - Edit
right and the
Project - Edit Management
right 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:
  1. In Internet Explorer, select Tools, Internet Options and click the Advanced tab.
  2. Scroll to the Security section.
  3. Clear the
    Do not save encrypted pages to disk
    check box
    .
  4. Click OK.
Set the Windows Explorer Options
Prevent issues when saving projects from Microsoft Project to
Clarity PPM
by setting the following Windows Explorer option. For more information, see the Microsoft Windows help.
Follow these steps:
  1. In Windows Explorer, click Organize and select Folder and search options.
  2. Click View.
  3. Clear the
    Hide extensions for known file types
    check box
    .
  4. Click OK.
Note
: Verify that
Hide extensions for known file types
is 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 PPM
Microsoft Project Interface add-in installation macro.
Follow these steps:
  1. Open Microsoft Project.
  2. Select File, Options.
  3. Click Trust Center, Trust Center Settings.
  4. Click Add-ins. Clear the
    require application add-ins to be signed by trusted publisher
    option.
  5. Return to the Trust Center page.
  6. Click Macro Settings and select the
    enable all macros
    option.
    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 PPM
and Microsoft Project. Schedule Connect provides the following capabilities:
  • Synchronized communication between
    Clarity PPM
    and Microsoft Project.
  • Improved performance when using the new XML version of the
    Clarity PPM
    interface with Microsoft Project. When opening and saving a project, all information is sent to and from
    Clarity PPM
    in 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 PPM
application.
Upgrading the
Clarity PPM
Microsoft 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
  • ClarityAddin
  • 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.
For supported versions for your release of
Clarity PPM
, see the Release Notes.
When upgraded, the latest product enhancements and bug fixes display.
Follow these steps:
  1. Close all instances of Microsoft Project.
  2. Download the Microsoft Project Interface using one of the following methods:
    • Clarity PPM
      media
      : Navigate to Clients\MSPInterface\New and click
      mspsetup.exe
      . If installing from the media, run the Schedule Connect installation manually. It does not run automatically as it does with the next option.
    • Clarity PPM
      user interface
      : This download option includes Schedule Connect.
      1. Click
        Home
        ,
        Personal
        ,
        Account Settings.
      2. Click the
        Software Downloads
        tab. You must have the
        Software Download - Microsoft Project Interface
        access right to download the software.
      3. Click the appropriate compatible download link for either
        Microsoft Project Interface (x86)
        or
        Microsoft Project Interface (x64)
        .
      4. Select
        Run
        or
        Save
        when prompted to run or save the mspsetup.exe file. If you select
        Save
        , open the file when you are ready to perform the installation.
  3. 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, and
    Clarity PPM
    . Your Windows Regional Settings must always match the language of your Microsoft Project installation. See
    Configure Windows Regional Settings
    for detailed steps.
  4. Click
    OK
    to continue with the setup process.
    The
    Clarity PPM
    Microsoft Project Interface with
    Clarity PPM
    Schedule Connect Setup wizard opens.
  5. Follow the on-screen instructions.
    If you have an existing installation, click
    Yes
    when prompted to copy the files to the same directory.
  6. Click
    Finish
    and 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:
  1. In Windows 8.1 or 10, click
    Start
    ,
    Settings
    . In Windows 7, open your control panel and skip to Step 4.
    msp_win_01.png
  2. In
    Windows Settings
    , click
    Time & Language
    and then click
    Region & language
    .
    msp_win_02.png
    Changing the country or language in the screen example above does not resolve potential issues. Follow the steps listed here exactly.
  3. Under
    Related settings
    , click
    Additional date, time, & regional settings
    . You might see this option by scrolling down or to the right. Skip to Step 5.
  4. (Optional) As a shortcut:
    1. Windows 7, 8.1, and 10 users can open the
      Control Panel
      . (You can also press the Windows logo key and the
      R
      key (
      Windows
      +
      R
      ) and type
      control panel
      .)
      msp_win_03.png
    2. Depending on the
      View by
      setting, click
      Change date, time, or number formats
      or click
      Region
      .
      msp_win_04.png
  5. In the
    Region
    dialog box, on the
    Format
    tab, change the language to match your Microsoft Project language setting. Click
    OK
    .
    msp_win_05.png
    Do not click
    Additional settings
    .
Set Up the Server Connection
When you open a project from
Clarity PPM
to 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
Clarity PPM
.
If you open a project from Microsoft Project and save it to
Clarity PPM
, Schedule Connect connects you to the specified
Clarity PPM
server. Use these steps to set up a first-time connection to
Clarity PPM
.
If you are using federated single sign-on (SSO), you must have an open
Clarity PPM
browser 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:
  1. With Microsoft Project open, click the
    Clarity PPM
    Integration menu or toolbar, and go to Open.
  2. Enter your
    Clarity PPM
    user name and password, and click >>Setup.
  3. 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.
      Default:
      Full
      Select Full.
    • CA PPM Host.
      Defines the name of the
      Clarity PPM
      server 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 the
      Clarity PPM
      server.
      Example:
      80 is the default port for a
      Clarity PPM
      server.
      To determine the port number, verify the CSA application server settings, the application logon URL, or contact your
      Clarity PPM
      administrator. 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:
      corpProxy
      If you are accessing
      Clarity PPM
      through 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.
  4. Click OK.
    You are connected to the
    Clarity PPM
    server.
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
Clarity PPM
.
  1. In Microsoft Project, select File, Options.
  2. Click Schedule to set the Calculation option. This option determines if Microsoft Project automatically reschedules your plan. This setting affects what is displayed in
    Clarity PPM
    when you save the plan back to
    Clarity PPM
    after scheduling is completed.
    • On:
      Microsoft Project automatically schedules the plan every time you open a
      Clarity PPM
      project 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 the
      Microsoft Project Help
      .
  3. Click Schedule to configure the calendar. Verify that the values in the
    Calendar options for this project
    section map to the values set in
    Clarity 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.
  4. Click Advanced and clear the
    Show links between projects dialog on open
    check box in the
    Cross project linking options for this project
    section. This feature is incompatible with
    Clarity PPM
    external dependencies, and is ignored when selected.
  5. 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 PPM
and 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 PPM
for 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:
  1. In Microsoft Project, select Tools, Options, and click Schedule.
  2. (Optional) Select Percentage for the
    Show assignment as an
    option.
  3. Select Auto Scheduled for the
    News tasks created
    option.
    All of the new tasks that are created in
    Clarity PPM
    are calculated or auto-scheduled, depending on the overall project calculation setting. The new tasks that are created in Microsoft Project are not saved in
    Clarity PPM
    unless the task is calculated.
  4. Select Project Start Date for the
    Auto scheduled tasks scheduled on
    option.
  5. Select Days for the
    Duration is entered in
    option. Ensure the duration is days for Microsoft Project before synchronizing.
  6. Enable the following options:
    1. Split in-progress tasks.
      Fills the gaps in work while using Resource Leveling.
    2. Tasks will always honor their constraint dates.
      Constraints are important for scheduling and override task relationships such as dependencies.
    3. (Optional)
      Show that scheduled tasks have estimated durations
    4. Calculate project after each edit.
      You receive instant feedback on Microsoft Project edits. The projects you export from
      Clarity PPM
      to Microsoft Project are calculated and up-to-date.
  7. Disable the following options:
    1. 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 in
      Clarity PPM
      have Estimate to Complete (ETC) calculated. Ensure that
      Clarity PPM
      and Microsoft Project are matched to calculate remaining work on new assignments.
    2. (Optional)
      New scheduled tasks have estimated durations
    3. Updating Task status updates resource status
      Disable 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.
    4. (Optional) Inserted projects are calculated like summary tasks.
    5. (Optional) Actual costs are always calculated by Project.
  8. Select Tools, Options, and click General.
    Do not use the Date Format as an option that includes a time stamp.
  9. Select Tools, Options and click Advanced.
  10. Enable the following options:
    1. Allow cell drag and drop
    2. (Optional) Move selection after enter
    3. (Optional) Ask to update automatic links
    4. (Optional) Edit directly in cell
    5. (Optional) Edits to total task % complete will be spread to the status date
    6. (Optional) Calculate multiple critical paths
  11. (Optional) Select % Complete for the Default task Earned Value method option.
  12. (Optional) Select Baseline for the Baseline for Earned Value calculation.
    While configuring the options for an open project, a message
    Options for this project: <project name>.mpp
    appears. Change the message to
    Options for this project: All New Projects wherever required
    .
    The
    Clarity PPM
    repository owns the Company, Project, and Resource calendars. Make changes to these calendars only using
    Clarity 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 in
    Clarity PPM
    .
Configure Project Properties in Microsoft Project
To ensure that the Microsoft Project fields are mapped to
Clarity PPM
fields, configure the properties of the project in Microsoft Project.
  1. In Microsoft Project, select File, Info, Project Information and click the Summary tab.
  2. Verify that the fields from the Summary tab, as listed in the following table, are mapped to
    Clarity PPM
    .
Microsoft Project Field
Clarity PPM
Field
Status
Title
ProjectName
Required
Subject
Optional
Not required
Author
Optional
Not required
Manager
Project Manager
Required
Company
Department
Not required
Category
Optional
Not required
Keywords
Optional
Not required
Comments
Optional
Not required
Hyperlink Base
Guidelines
Required
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.
  1. Select Tools, Resource Leveling from Microsoft Project for project 1.
  2. Set the
    Leveling calculations
    as
    Manual
    .
  3. (Optional) Set the
    Look for overallocations on a
    Day by Day basis.
  4. (Optional) Set the
    Leveling order
    to
    Standard
    . Leveling can adjust individual assignments on a task.
  5. Disable the
    Leveling can create splits in remaining work
    option.