Configure General System Settings

ccppmop1571
HID_admin_configure_general
As an administrator, you can configure system settings to enable the 
New User Experience
. You can also manage settings for passwords, documents, advanced reporting, and custom chart colors. Add site links for convenient access by users. Enter translated text for field labels and error messages. Other settings include data warehouse fiscal time period data, consistent chart colors, company name, TSV links for Export to Excel, and GZip HTML encoding.
 
 
2
 
 
Enable the New User Experience
Enable the 
New User Experience
 for project managers, resource managers, and team members. 
 Before you can enable the 
New User Experience
, install the PMO Accelerator. Without the accelerator, the options for the 
New User Experience
 are disabled. See Install the PMO Accelerator Add-In and PMO Sample Data.
 
Follow these steps:
 
  1. Click 
    Administration
    General Settings
    System Options
    .
  2. In the 
    New User Experience section
    , select 
    Activate New User Experience
    .
    This option provides a global switch that controls whether the 
    New User Experience
     is accessible to users. If you do not activate this option and a user tries to access the 
    New User Experience
     using the following URL, they are redirected to Classic PPM:
    http(s)://<servername>/pm
     
  3. To enable the new timesheet user interface, select 
    Activate Timesheets
     and click 
    Save
    . This option provides a global switch that controls whether the new timesheets are accessible to users. To activate the new timesheets, first activate the 
    New User Experience
    . When you activate the new timesheets, the following changes occur:
    • The timesheet menu link and Current Timesheet icon are removed from the classic user interface.
    • In Administration, Project Management, Timesheet Options - Default Content and Layout section, the following columns remain in the 
      Available Columns
       field. These fields are not needed to configure the new timesheets. The data for these fields is automatically incorporated into the new timesheets:
      • Investment
      • Investment ID
      • Phase 
    • In Administration, Project Management, Timesheet Options - Default Content and Layout section, the following columns no longer appear in the 
      Available Columns
       field:
      • Task ID
      • Short Name
      • Parent
      • Parent ID
      • Phase ID
      • Start
      • Finish
      • Posted Actuals
      • Baseline
      • Role
      • Incident Category
      • Notes Icon
    • In Administration, Project Management, Timesheet Options - Default Time Entry Options section, the following fields are removed:
      • Default Sorting
      • Disable Indirect Time Entries
      • Enable Note Date
      • The remaining fields are reset to stock default values. It is important to revisit this section again after activating the new timesheets.
    • Timesheet notifications are sent from the 
      New User Experience
      .
    • Users can create timesheets in the 
      New User Experience
       only.
  • We recommend that teams use either the new timesheets or the classic timesheets. Do not switch between both.
  • Provide your users with the URL or a menu link to the 
    New User Experience
    . For more information, see Getting Started with the New User Experience.
  • New timesheet notification links automatically go to the specific timesheet for a specific team member. For example:
    https://<servername>/pm/#/timesheets/timesheet?resourceId=5003033&timeperiodId=5004050
     
Set Document Management Options
You can set options that determine how attachments and uploaded documents are accessed by other users. Settings including file scanning and download options.
You can also limit the file extensions that are authorized when users upload documents. After you specify the file extensions, a message appears listing the supported extensions whenever users upload a document. Unauthorized file types cannot be uploaded and a warning appears. If you do not specify a file extension list, you can upload any file.
 These options apply to both the classic PPM interface and the 
New User Experience
. The file extension restrictions do not apply to documents that users upload using XOG.
 
Follow these steps: 
 
  1. Click 
    Administration
    General Settings
    System Options
    .
  2. Configure the following fields:
    •  
      Authorized File Extensions
      Leave this field empty, the default, to allow users to upload all file types. To restrict file types, enter a list of file extensions that you want to allow users to upload. Separate each file extension with a comma and no spaces. For example, you enter 
      doc,docx,pdf,xls,xlsx,ppt,pptx,jpg,gif. Y
      ou are now prohibiting any other file types that are not listed. In this example, a PNG image file is blocked. A user cannot upload a PNG file for their personal avatar icon or in a conversation. The authorized file extensions apply to the document management system, avatar images, Studio attachment attributes, project status reports (PDF), and in the 
      Clarity PPM
       
      New User Experience
      . The file extensions do not apply to documents that you upload using XOG.
    •  
      Enable File Scanning of Documents
      Select the check box to scan the uploaded documents. If the check box is clear, uploaded documents are not scanned. You can specify a virus scanning command-line program for all uploaded documents in CSA. When the program or shell script of your choice detects a problem with a given document, it may return an error code and reject the document. A warning appears on the document manager page. Documents uploaded using attachment attributes or XOG are not scanned.
      Default:
       Cleared
    •  
      Allow Non-Participants to Access Documents
      : This setting applies globally as the default value for all future documents that users upload. The setting can be changed for each document.
    •  
      Enable Document Download
      : Adds the 
      Download All
       and 
      Incremental Download
       actions on the 
      Collaboration
       tab.
      •  
        Maximum File Size for Document Download
        : Specify a limit for the total file sizes in the 
        Download All
         or 
        Incremental Download
         actions. The software won't allow users to download documents when their total size exceeds this limit.
      •  
        Warning File Size for Document Download
        : Specify a limit that is lower than the maximum allowed. When the total uncompressed file size exceeds this limit, users receive a warning. They can cancel the download or continue. The actual size of the compressed ZIP file can be lower than the warning limit.
  3. Click 
    Save
    .
Set Other System Options
You can set other system options, such as company name, graph formats, document download, and file compression.
 
Follow these steps:
 
  1. Click 
    Administration
    General Settings
    System Options
    .
  2. In the Other section, complete the following fields and save your settings:
    •  
      Company Name
      Defines your company name that is displayed on the About page.
      Limit:
       80 characters
    •  
      Chart Colors
      Specifies custom colors for use with charts. To enter the name and hexadecimal RGB values for a new color, click the Color Palette link.
    •  
      Use Consistent Chart Colors
      Defines whether you want to use consistent chart colors.
      Default:
       Cleared
      Select the check box.
    •  
      Use GZip HTML Encoding
      Specifies the use of compression for HTML pages.
      Default:
       Selected
Enable SAML Authentication
The Enable SAML Authentication option allows Clarity PPM to accept SAML responses from Identity Providers such as OKTA or Auth0. 
  •  On-Premise Customers
    : This option is currently not applicable to Clarity PPM On-Premise customers. If you select this option, users will experience authentication issues.
  •  
    On-Demand Customers
    : Please do not make any changes to this option. This setting governs the authentication mechanism of your Clarity PPM On-Demand environment. If you update this option, users will face authentication issues. 
 
Configure Subscription Compliance Setup - Enable Telemetry
Telemetry is a capability that is integrated into 
Clarity PPM
 to send product usage and system configuration data to CA Technologies, a Broadcom Company (CA). This data helps CA gain insights into customers' product usage, understand their software needs, and focus on the features and platforms that are most commonly used. 
Telemetry 
 
DOES NOT
 
 collect any personally identifiable information (PII). It is 
MANDATORY 
to enter your Site ID when you are configuring the Subscription Compliance Setup section.  
 Telemetry is disabled for the Federal Risk and Authorization Management Program (FedRAMP) environments. 
 
Clarity PPM Telemetry Scenarios
 
You can configure telemetry to support two primary scenarios in 
Clarity PPM
 
 
Scenario 1
: You wish to save telemetry data locally in 
Clarity PPM
.  .
 
Telemetry Blank.jpg
 
In this scenario, open the 
System Options
 page, enter your Site ID in the
 Configure Compliance Setup
 section, and save your changes. The 
Opt-In
 checkbox is 
 
NOT SELECTED
 
 by default. Hence, your data will not be sent to CA Technologies. However, your data will be stored in 
Clarity PPM
. You can review and export this data by accessing the Telemetry Data Export portlet on the License Information page. 
 
 
 
Scenario 2
: You wish to share telemetry data with CA Technologies.
In this scenario, complete the 
Configure Compliance Setup
 section based on the steps given below to send data to CA Technologies. 
Clarity PPM
 sends data to CA Technologies only when you:
  1. Select the 
    Opt-In
     checkbox while completing the Configure Compliance Setup section.
  2. Use the 
    Production Environment
     field to specify that you are configuring a production instance of 
    Clarity PPM
 
Subscription Compliance.jpg
 
 
Follow these steps
:
  1. Log into 
    Clarity PPM
     as an administrator.
  2. Click 
    Administration
    General Settings
    System Options
    .
  3. In the Subscription Compliance Section, complete the following fields:
    •  
      Site ID
       (Mandatory)
      Specifies the enterprise ID that you use to access the CA Support website. See Identify Your Site ID Using the CA Support Website.
    •  
      Production Environment
      Specifies if you are configuring a production instance of 
      Clarity PPM
      . Select "Yes" for a Production Environment and "No" for other environments. 
    •  
      PLA Customer
      Specifies if your organization has opted to participate in the Subscription Portfolio License Agreement.
    •  
      Opt-In
      Specifies if you want to send telemetry data to CA Technologies
       
       
    •  
      Charge Identifier
      Specifies the name or chargeback ID of a department associated with paying for 
      Clarity PPM
       usage in your enterprise.
    •  
      Instance
      Specifies the type of installation instance such as Product Development, Enterprise Sales Training, or Product Marketing.
    •  
      Product Version
       (Auto-populated based on the product version installed)
      Specifies the version number of the product.
    •  
      Domain Name
       (Auto-populated)
      Specifies the Primary App Service HTTP/HTTPs URL. This information is extracted from the Clarity System Administrator (CSA) application URL field. 
    •  
      Error Notification Email
      Specifies the email addresses of users who need to be notified if 
      Clarity PPM
       is unable to send Telemetry data to CA Technologies. 
      Clarity PPM
       sends telemetry data to CA Technologies on a scheduled basis. If 
      Clarity PPM
       is unable to send Telemetry data, the users listed here will receive an email. You can specify multiple email addresses by using a comma to separate them. 
    •  
      SaaS Environment
       (Auto-populated)
      Specifies if the environment is SaaS or On-Premise. This field is set to "No" if you are using On-Premise 
      Clarity PPM
      .
    •  
      Use Proxy
      Specifies the proxy server settings that can be used to send telemetry data to CA Technologies. 
      Clarity PPM
       On-Premise customers who have not connected their application servers to the internet can use the proxy server to send telemetry data to CA Technologies.
      •  
        Proxy URL
        Specifies the URL of the proxy server.
      •  
        Username
        Specifies the username to access the proxy server.
      •  
        Password
        Specifies the password to access the proxy server.
  4. Save your changes.
To learn about the license count information for Clarity PPM based on license type review View User Counts by License Type.
Identify Your Site ID Using the CA Support Website 
 
Site ID.gif
 
 
 
 
Clarity PPM
 
 
customers can identify their Site ID by logging into the CA Support website.
 
 
 
Follow these steps:
 
  1. On your web browser, navigate to https://casupport.broadcom.com/ 
     
  2. Click 
    Sign In
     and enter your username and password.
  3. Click 
    MY ACCOUNT
    SITE ACCESS REQUEST
     to open the Site Access Request page page.
  4. Click 
    Admin Access 
    to view the User Administration Access Request page.
  5. Your organization's name and Site ID are displayed.
 
Data Transmitted by Telemetry Job
 
 
Clarity PPM
 sends the following data to CA Technologies as a part of the Telemetry capability:
Name
Description
Source
site id
Specifies your organization's site ID that is listed on the CA Support portal.
Maps to the value of 
Site ID
 field in the Subscription Compliance Setup section.
Provided by customer
opt-in
Specifies if you want to send telemetry data to CA Technologies
Maps to the value of the Opt-in field in the Subscription Compliance Setup section
Provided by customer
instance_id
Specifies the type of installation instance such Development, Training, Business Unit, etc.
Maps to value of 
Instance
 field in the Subscription Compliance Setup section.
Provided by customer
product_sku
Specifies the Stock Keeping Unit (SKU) of 
Clarity PPM
 
Generated by 
Clarity PPM
 
sku_description
Specifies the description of the SKU of 
Clarity PPM
 
Generated by 
Clarity PPM
 
SaaS environment
Specifies if you are using a SaaS or an On-Premise version of 
Clarity PPM
 
Generated by 
Clarity PPM
 
product version
Specifies the version number of 
Clarity PPM
 implemented in your organization
Maps to value of 
Product Version
 field in the Subscription Compliance Setup section
Generated by 
Clarity PPM
 
pla_enabled
Specifies if your organization has opted to participate in the Subscription Portfolio License Agreement
Maps to value of 
PLA Customer
 field in the Subscription Compliance Setup section
Provided by customer
date_collected
Specifies the date on which telemetry data is sent to CA Technologies
Generated by 
Clarity PPM
 
monthly_usage
Specifies the count of active users in 
Clarity PPM
 who have Full Function access, Restricted Function access, View Function access
Generated by 
Clarity PPM
 
chargeback_id
Specifies the name or chargeback ID of a department associated with paying for 
Clarity PPM
 usage in your enterprise
Maps to value of 
Charge Identifier
 field in the Subscription Compliance Setup section
Provided by customer
domain_name
Specifies the Primary App Service HTTP/HTTPs URL used to access 
Clarity PPM
 
Maps to value of 
Domain
 field in the Subscription Compliance Setup section
Generated by 
Clarity PPM
 
 
Clarity PPM
 considers a Creator license and a Demo license as a Full license, Participant license as a Restricted license, and the Viewer license as a View Only license while reporting Telemetry data.
 
Import SSL Certificate into the Java TrustStore
 
You need to import an SSL Certificate into the Java TrustStore only if you are:
  • Using a proxy to send telemetry data to the CA Technologies 
 
AND
 
  • Using a self-signed SSL Certificate on the proxy. 
While self-signed SSL Certificates will encrypt your data, they are not honored by most web browsers and JAVA because the certificate is not issued by a trusted certificate authority.  To resolve this issue, you need to import the SSL Certificate into the Java TrustStore. 
 
Follow these steps:
 
  1. Locate your X.509 SSL Certificate. They are generally .CER files. 
  2. Place the certificate file in the Java/jre/lib/security directory. 
     If you have multiple versions of Java on your system, ensure you select the version that was installed with 
    Clarity PPM
    . You can review that checking the value of the JAVA_HOME environment variable.
  3. Open the command prompt and navigate to the JAVA_HOME/lib/security folder. 
  4. Execute the following command:
    keytool -importcert -keystore cacerts -file "certificate name" -alias "alias name" 
     
     Ensure that you remember the alias name you provide in this step. You will need it if you want to delete the certificate from the Java TrustStore.
  5. Enter the keystore password. The default password of the keystore is "changeit". 
  6. When you are prompted to trust the certificate, type "yes" and press Enter. 
You have now imported the self-signed SSL Certificate into the Java TrustStore. 
 
Telemetry_ImportJAVA.png
 
 
Troubleshoot Telemetry Issues
 
If 
Clarity PPM
 encounters an issue with Telemetry, it creates an entry in the bg-ca.log file. A few issues that customers can encounter are:
  •  
    Mandatory data such as Site ID, Production Environment, and PLA Customer is missing
    You will encounter this issue if you have not completed the Configure Subscription Compliance Setup section on the System Options page. In such a scenario, you will see the following message in the bg-ca.log file:
    "Subscription Compliance Setup is incomplete. Please contact your system administrator to complete this under System Options”.
     
     
  •  
    Post to Telemetry data to CA Technologies is not successful
    You will see an error message in the bg-ca.log file. If you have provided relevant email addresses in the Error Notification Email field
    those users would receive an email from 
    Clarity PPM
     
    .  
     
View and Configure Advanced Reporting Options
You can view Advanced Reporting fields in the Advanced Reporting section. This section includes the following fields:
  • Advanced Reporting Server URL
  • Organization ID
  •  
    Clarity PPM
     Database Schema name
  • Data Warehouse Database Schema name
Use this information to create a server connection for Jaspersoft Studio Professional if you are using this tool for report development and domain creation.
To govern the synchronization of Jaspersoft Advanced Reporting roles from 
Clarity PPM
, select the Allow Jaspersoft Role synchronization option. The option when selected allows the Jaspersoft advanced reporting roles to synchronize with corresponding 
Clarity PPM
 access groups using the 
Synchronize Jaspersoft Roles
 job.
A Jaspersoft role is synchronized, provided the following conditions are true:
  • The role has the same ID as a 
    Clarity PPM
     access group.
  • The user assigned to the Jaspersoft role exists in Jaspersoft.
See 
Jobs Reference
 for more information about the Synchronize Jaspersoft Roles job.
 
Follow these steps:
 
  1. Click 
    Administration
    General Settings
    System Options
    .
    The system options page appears.
  2. In the Advanced Reporting section, view the Advanced Reporting field values.
Create Custom Chart Colors
You can create a chart color palette at the system level that allows the system to assign colors to a created chart. The palette applies even when you have selected the Use Consistent Chart Colors option. If you do not create a chart color palette, the system assigns chart colors using the default color palette.
You can add an unlimited number of colors to a color palette. When you add a color to the color palette, your custom color palette replaces the out-of-the-box color palette. To reset the default palette, remove or empty the custom palette. Only one color palette can be active at a time.
When you create a custom chart color palette, you can also change the order in which a color picks from the palette. The consistent color key (selected at the chart level) uses this order to distribute colors in the chart. If you do not specify an order, then the system uses the order that you used to assign a color.
In addition, you can delete custom chart colors or can reorder the colors.
 
Follow these steps:
 
  1. Click 
    Administration
    General Settings
    System Options
    .
  2. In the Other section of the System Options page, click the [Color Palette] link for the Chart Colors field.
  3. Click New on the Chart Colors page.
  4. Complete the following fields:
    •  
      Name
      Defines a name for your color.
    •  
      RGB
      Specifies the hexadecimal value that represents a color for your chart.
      Example:
       The character combination 0000FF specifies the color Blue.
  5. Save the changes.
    The changes are saved and the chart colors page appears.
  6. Click Order.
    The chart color order page appears.
  7. Define the order for assigning colors in the color palette, and save.
Select Consistent Chart Colors
You can set consistent chart colors at the system level. By default, this setting is not active. After you configure this system option, you can use the colors in a chart portlet. 
The Use Consistent Chart Colors option specifies whether to assign colors to charts based on the consistent color key that is defined at the chart portlet level. When you select Use Consistent Chart Colors, the Consistent Color Key and Use Consistent Colors fields appear on the Options page when you or other users configure the chart portlet.
 
Follow these steps:
 
  1. Click 
    Administration
    General Settings
    System Options
    .
  2. In the Other section of the System Options page, select 
    Use Consistent Chart Colors
    .
  3. Save the changes.
  4. Configure a chart portlet to use consistent colors. See 
    Configure Consistent Colors for Studio Chart Portlets
     in CA Clarity PPM Studio Reference for details.
Change a Company Name
You can change the company name that appears on the 
Clarity PPM
 About page.
 
Follow these steps:
 
  1. Click 
    Administration
    General Settings
    System Options
    .
  2. In the Other section of the System Options page, complete the following field:
    •  
      Company Name
      Defines the name that displays as your company name on the 
      Clarity PPM
       about page.
      Limits:
       80 characters
  3. Save the changes.
Enable the TSV Links (Export to Microsoft Excel)
Select the Enable TSV links for the Export to Excel option to export both the TSV data and the TSV links to Excel. Only the permissible number of TSV links are displayed. Disable this option to export only the TSV data and not the TSV links.
 Microsoft Excel supports up to 65,530 hypertext references (HREF). When exporting data from 
Clarity PPM
 to Microsoft Excel, hyperlinked cells do not appear as links when the row count exceeds that limit. If the number of TSV links exceed this limit, an error message appears to alert you.
You can add, change, and delete site links that appear in the Site Links section of the overview pages. By default, this section displays the Favorite Photo section on the right side of the page.
If you no longer require a link, delete the link.
 You can test the link by viewing page links from the Site Links section of the overview page.
 
Follow these steps:
 
  1. Click 
    Administration
    General Settings
    Site Links
    .
    The page links page appears.
  2. Click 
    New
    .
  3. Complete the following fields, and then click 
    Save
    :
    •  
      Link Name
      Defines the name of the page link that displays on the overview page.
      Limit:
       32 characters
    •  
      URL
      Defines the web address that is used to display the page when you click the page link. Enter the correct URL link because 
      Clarity PPM
       does not validate the URL.
      Limit:
       240 characters.
Manage Field Text Translation
You can provide different language localizations for selected field text on the Administration pages. You can include the translations for different languages, which are based on your company requirements. The translation function is available if you see the following Translate icon next to a field:
 
image2017-2-27 17:0:9.png
 
 
Follow these steps:
 
  1. Click the 
    Translate
     icon next to any field that supports this option.
     For example, the Translate icon appears with the Action Name field. Click Administration, Data Administration, Processes and select a process (or create a new process). Click Start Step and select one of the Actions (or create and save a new action). The Action Name field shows the Translate icon.
  2. Enter the field text localization for each language that you require.
  3. Click 
    Save and Return
    .