Health Report, Job Monitor, Governor Settings, and Data Warehouse Audit Dashboard

A system health report, log analysis portlets, currently running jobs monitor, and data warehouse audit dashboard are available to support the security and diagnostics needs of administrators.
ccppmop1551
A system health report, log analysis portlets, currently running jobs monitor, and data warehouse audit dashboard are available to support the security and diagnostics needs of administrators.
  • The health report shows system status for the application, database, and data warehouse.
  • The health report also detects any non-compliant governor settings (maximum data limits). 
  • A related discovery analysis report detects system customizations.
  • The Log Analysis page includes system statistics, daily page or XOG views, and log data.
  • A Job Monitor page shows the currently running jobs.
  • In 15.6 and higher, a new Data Warehouse Audit dashboard shows the latest progress of the Load Data Warehouse job. 
 
 
2
 
 
HID_admin_health_report
Required Access Rights
  • To run the Health Report, verify that you have the 
    Administration - Application Setup
     global access right.
  • To view the Log Analysis portlets, verify that you have the 
    Administration – Access
     right and that you are assigned to the Log Analysis Access group.
  • To run the tomcat access logs, verify that you have the 
    Jobs - Access
     right. Also verify that you have the following instance level job definition access right: 
    Job - Run
     on 
    Tomcat access log import/analyze
    .
View or Download a Clarity PPM System Health Report
System health including the 
Clarity PPM
 application servers, database, and data warehouse is important. As an administrator, application support engineer, or help desk technician, you want to maintain operations and minimize downtime. Before contacting other support professionals or engaging with the online community, you want a quick assessment of 
Clarity PPM
 system health. 
 
Follow these steps:
 
  1. Log in to Classic PPM with administrative access rights.
  2. Click the 
    Administration
     menu. Under 
    Security and Diagnostics
    , select 
    Health Report
    .
  3. Select one of the following tabs:
    •  
      Summary
      : This tab lists the health status and completion percentage for the application, database, and data warehouse. The % Completed value calculates the total number of settings that require a value during a new install or upgrade. The health report summary shows you what portion those required settings have a value. For example, 
      88% Complete
       indicates that you are still missing valid values for the remaining 12 percent of all settings. When the report shows Setup Complete and a green status icon, the health for that category is good. When setup is not complete, a red icon appears. Click Details to view one of the three other tabs.
    •  
      Application
      : This tab shows application server details. Settings include file locations, URLs, Java version, JVM, LDAP, SSO, SSL, and ports. You also see instance-specific configurations for CSA, background (bg), and beacon services. 
      • To verify settings for the 
        New User Experience
        , expand Application Instance (app), New User Experience. The 
        ppm-ux
         attribute appears with a red icon when a newer version is available but is not deployed. The 
        New User Experience
         features are delivered and updated through a separate Java WAR file. WAR files should have a META-INF folder.
      • To verify settings for governor limits, expand Governor Limits.
      • To switch the status of the on-the-fly RateMatrix property, click Enable or Disable. When enabled, the application applies the PRJ_RT_RATES_EXTRACTION rate matrix options. This setting is disabled by default.
    •  
      Database
      : This tab provides information about database connectivity, table spaces, database options, and server parameters. 
    •  
      Data Warehouse
      : This tab provides information about data warehouse connectivity, table spaces, data warehouse options, and server parameters. Settings include JDBC URL, database timezone mismatch, database size, and ETL job timeout for the Load Data Warehouse job. This tab also includes setup information for time slices and other application settings for the data warehouse. 
      : Click the 
      Fix It
       link to navigate to the application page where you can fix the non-compliant setting. For example, a red icon and 
      Fix It
       link appear to help you set up entities or time slices.
  4. To view the recommended values for each setting on the Database and Data Warehouse tabs:
    1. The Recommended field provides the required values to achieve compliance and improve system health. If no exact value is recommended, the field remains empty. 
    2. Hover your mouse over the Status icon to view a recommendation to fix the listed item.
    3. As an Oracle database administrator, you might have permissions to V_$PARAMETER. If you do, expand Database Parameters to view the health of your database and data warehouse parameters. If you do not have permissions, hover over the status icon to show the command to grant access.
  5. To export the complete health report to Excel, click the Download Health Report button on the Summary tab. Open the HealthReport.xlsx.zip file to view the HealthReport.xlsx file in Excel.
: The previously available health check in CSA is no longer available in this release. Use the new health report tabbed pages, download a health report to Excel, or run the command line health report instead.
Command Line Health Report
To run the health report from a command line, enter the following command:
admin healthreport
Health Report Exclusions
In SaaS and FedRAMP environments, the health report database and data warehouse tabs do not list the following items:
  • JDBC URL
  • Database parameters
  • SQLNET parameters
Governor Settings (Maximum Data Limits)
Governor settings optimize performance by enforcing maximum limits on specific data. For example, the maximum size allowed for an uploaded document is 20 megabytes and the maximum number of rows you can export to Excel is 25,000. These limits help prevent a minority of users from degrading the performance of the majority of other users.
In the current release of Clarity PPM, administrators can override a default limit, up to the given critical limit.
The following table lists the recommended and enforced governor settings:
Name
Governor Field
DESCRIPTION
DEF_LIMIT
CRITICAL_LIMIT
UNITS
 
Document Size
DMS_DOCUMENT_MAX_SIZE
Maximum file size for a document during initial upload.
(Any pre-existing document that exceeds the setting is not validated by the governor.)
20
50
MB
 
Export to Excel
E2E_MAX_ROWS
Maximum number of rows that you can export to Excel from Classic PPM.
25,000
75,000
rows
 
Objects/NSQL Limit
MAX_FETCH_LIMIT
Maximum number of rows that can be fetched by NSQL in a list view or grid portlet.
(Only applies if you configure aggregation on the list view or grid portlet.)
50,000
100,000
rows
 
SQL GEL Rows
MAX_SQL_GEL_ROWS
Maximum number of SQL query rows that you can retrieve by running a GEL script.*
100,000
120,000
rows
 
CSV GEL Rows
MAX_CSV_GEL_ROWS
Maximum GEL CSV rows allowed
25,000
50,000
rows
 
Timesheet Tasks
MAX_TIMESHEET_TASKS
Maximum number of tasks in a timesheet.
250
300
tasks
 
Max XML Nodes
MAX_XML_NODES
Maximum number of nodes that you can read or write through XOG.
150,000
400,000
nodes
 
Max Investment Attributes
PFM_LIMITS_MAX_INV_ATTRS
Maximum number of attributes in a portfolio.
700
700
attributes
 
PFM Limit on Roles
PFM_LIMITS_MAX_ROLES
Maximum number of roles in a portfolio.
75
100
roles
 
Export to Excel (App)
E2E_MAX_ROWS_APP
Maximum rows for Export to Excel, application level setting
25,000
75,000
rows
 
Export to Excel Timer
E2E_TIMER
Maximum time for an export to Excel before ending the export.
600
720
seconds
 
Max To-Do Items for a Task
MAX_TODOS_PER_TASK
Maximum number of to-do items for a task.
25
40
to-do items
 
Max documents
DMS_MAX_DOCUMENTS
Maximum documents allowed in a single upload session.
5
10
files
 
Max attachments
ODF_MAX_ATTACHMENTS
Maximum conversation attachments allowed for ODF object
5
10
files
 
CSV Import Limit
CSV_IMPORT_LIMIT
Maximum records allowed for CSV import processing
250
500
rows
 
CSV Export Limit
E2CSV_MAX_ROWS
Maximum records allowed for CSV export
25,000
75,000
rows
 
Export to CSV Timer
E2CSV_TIMER
Timer for Export to CSV
1,800
2,000
seconds
 
Maximum request parameters
MAX_REQUEST_PARAMETER_COUNT
Maximum request parameters in any Classic PPM user interface HTTP request
1,800
1,800
parameters
*In 15.5.1, the same limit for Excel is enforced for CSV with MAX_CSV_GEL_ROWS=25000. Do not confuse this limit with MAX_SQL_GEL_ROWS=100000. Until you upgrade to 15.5.1 or newer, avoid creating GEL scripts that attempt to read, run, or append records in a very large CSV file. Out-of-memory errors and application outages can occur. 
 The approved defaults are enforced to optimize or maintain performance. We recommend that on-premise administrators do not adjust these settings. Clarity PPM 15.6 and previous releases detect any changes in the governors.properties file without a restart of the server. As an administrator, you can disable (not recommended) a governor entry using a -999 value in the governors.properties file.
The following limits are not set by the governor settings but are hard-coded in the New User Experience:
Setting
Maximum
Units
Maximum number of columns in a board layout.
100
columns
Maximum rows to export to CSV.
250,000
rows
Maximum number of fields in a configurable Details panel
200
fields
New! Clarity PPM 15.6.1 Governor Limits Stored in the PPM Database
Governor limits are now stored in the database for you after upgrading or installing 15.6.1 or newer.
  • New installations are set to the recommended values shown above.
  • Upgrades preserve your previous settings.
New API for Managing Governor Limits
  1. Server setting required for the API calls to work
     <accessToServerStatus allow="ALL" />
  2. Navigate to the following API landing page:
     http(s)://<server>:<port>/niku/serverstatus/governorlimits 
     
  3. To view the response in HTML format use the following URL:
     http(s)://<server>:<port>/niku/serverstatus/governorlimits?run=html
  4. To get the results of the violators use the following url:
     http(s)://<server>:<port>/niku/serverstatus/governorlimits?type=violators
     
New Admin Commands
A series of 
admin governors
 commands are available for on-premise administrators to extend the governor limits up to the critical limit only (not recommended, but permitted by the system).
  • These commands are the exclusive method allowed and supported for temporarily bypassing the governor limits up to the established critical limits
  • Critical limits were determined based on the max numbers set across all our SaaS customers
  • The only way to bypass the critical limits is through a direct database update (not supported or recommended)
The commands support set, unset (also known as reset or restore defaults), and list options:
admin governors -set <governorKey> <governorValue>
admin governors -list <governorKey|all|violated>
admin governors -unset <governorKey|all> set to default and enables governor
 
Example
:
C:\Windows\System32>admin governors -list MAX_SQL_GEL_ROWS Code: MAX_SQL_GEL_ROWS Current Limit: 110000 Critical Limit: 120000 Default Limit: 100000 Active: true # # # # # # # # # # # # # # # # # #
Download a Customization Discovery Analysis Report
This report was designed for CA Technologies Global Delivery teams, CA Support, and advanced administrators when preparing to migrate an on-premise environment to a SaaS environment. Some customizations allowed in an on-premise environment might not be permitted in a SaaS environment. Non-compliant objects and other factors determine an estimated level of complexity on the report cover page.
 
Follow these steps:
 
  1. Log in to 
    Clarity PPM
     with administrative access rights.
  2. Click the 
    Administration
     menu. Under 
    Security and Diagnostics
    , select 
    Health Report
    .
  3. Below the Summary tab, click the 
    Download Discovery Analysis Report
     button. The output contains about 20 tabs of data including non-compliant objects, data sources, and grid portlets. Discuss these customizations before upgrading or changing environments.
  4. (Optional) For large deployments, the Discovery Analysis report is also available as a job for your convenience. To prepare this report, select the Active check box for the PPM Customization Discovery Analysis job. The job produces an Excel spreadsheet which can also be e-mailed to the recipient that is specified in the job parameters at the time of execution.
More Information
See 
PPM Customization Discovery Analysis Job
 in Jobs Reference in the English edition of the documentation.
View System Statistics and Log Data
Use the Log Analysis portlets to examine system performance. These portlets automate the process of parsing the application server log files and storing them in the database for visual analysis. Use these portlets to identify performance bottlenecks, frequently accessed features, response times, peak hours, and more.
 
Follow these steps:
 
  1. Log in to 
    Clarity PPM
     with administrative access rights.
  2. Refer to the 
    Required Access Rights
     section at the start of this document. To refresh the data in these portlets, you first run a job to export the data from the server and import it into the application database.
  3. Click the 
    Administration
     menu. Under 
    Security and Diagnostics
    , select 
    Log Analysis
    .
  4. Select one of the following tabs:
    1.  
      System Stats by Hour/Day
      : Use this tab to view average server response times, total sessions, and a list of the slowest actions performed for a specific day.
    2.  
      System Stats by Month
      : Use this tab to view monthly page views and XOG requests for all servers or grouped by server. You can also view monthly session counts. 
    3.  
      Daily Page/XOG Views
      : Use this tab to analyze the top 20 slowest pages. For example, you could troubleshoot the slowest pages and then optimize them for improved performance. This tab includes page views by service or server, daily page views, average response times by day, XOG requests by service or server, their average response times, and the total number of XOG calls by day.
  5. Enter your filter criteria:
    1. Select a 
      Date
      .
    2. Select an 
      Environment
       such as 
      All
       or 
      local
      .
    3. Select a 
      Hostname
       such as 
      All
       or a specific application server.
    4. Click 
      Filter
      .
  6. To export the data, click the 
    Log Data Export
     tab. Specify the 
    Environment
     and the date range for the exported data. Each row of exported data shows the date, total page views by all users, the average page response time in seconds, the total number of XML Open Gateway (XOG) requests, the average XOG response time, and the unique session count for that day.
  7. To configure any of the portlets on these tabs, click 
    Configure
     if available. To export the data to Excel or PowerPoint, click Export to Excel or Export to PowerPoint. Not all portlets support these options.
In the following Average Response Time by Server example, slower response times were observed at 9:00 am for a specific day. Further analysis revealed a group of users running similar queries, jobs, and processes. Response times were improved when a time-consuming process was rescheduled.
 Log Analysis portlet example. 
The following example shows the data that you can find in the Slow Actions by Day portlet.
URL
Time (secs)
Start
End
Hostname
Method
Bytes
Session Cookie
Username
security.loginAction
18.5
20180223 14:20:10
20180223 14:21:34
myserver.name1
POST
42,300
S131430_DD778-4012
user12
unreadPushNotificationsCount
12.3
20180223 15:44:17
20180223 15:45:08
myserver.name2
GET
6,100
S131437_EE778-4014
admin14
The associated username for a session ID helps you trace user activity in the system. For example, after user_01 deleted a custom object in Studio, user_02 began to notice delays and slower performance on another page indicated in the URL column.
When a user logs in to the application, a trigger records their username and associated session ID cookie value.
Jobs Monitor
As an administrator, view the Jobs Monitor to identify the background jobs that are currently running on each server.
 
Follow these steps:
 
  1. Log in to 
    Clarity PPM
     with administrative access rights.
  2. Select 
    Administration,  Security and Diagnostics
    Jobs Monitor
    . The following information appears:
    •  
      Job Name
      : The instance of the job that is currently running.
    •  
      Run ID
      : The instance ID for the currently running job.
    •  
      Job ID
      : The ancestor or parent ID for the running job.
    •  
      Job Definition Name
      : The ancestor or parent job name.
    •  
      Job Definition ID
      : The ancestor or parent job definition.
    •  
      Description
      : An optional description of the job.
    •  
      Scheduler Server
      : The server that queued the job process and that is now running the job. For example, [email protected]_server1.xx.yyy
View the Data Warehouse Audit Dashboard
New! Video: Load Data Warehouse Job Audit Dashboard Available in Clarity PPM 15.6
 

 
 
Follow these steps:
 
  1. Log in to Classic PPM with administrative access rights.
  2. Click 
    Administration,  Security and Diagnostics
    Data Warehouse
    .
  3. (Optional) To search the audit data, click 
    + Expand Filter
    , enter your filter criteria, and click 
    Filter
    .
  4. The 
    Data Warehouse Audit
     portlet displays the following fields:
    • Data Warehouse Table Name
    • Update Date
    • Load Start Date-Time Stamp
    • Load End Date-Time Stamp
    • Duration (seconds)
    • Row Count
  5. Examine the audit data. For example, sort by row count or duration to examine the heaviest table loads.
  6. If any errors occurred, the companion 
    Data Warehouse Error
     portlet displays the following fields:
    • Data Warehouse Table Name
    • Error Message
    • Error Number
    • SQL Command
  7. (Optional) Click 
    Options
     to configure the audit or errors portlet. You can also export the data. For example, export an offending SQL command to a CSV file and send to your troubleshooting team.
The following image shows an example of the Data Warehouse Audit dashboard in Clarity PPM 15.6:
 This image shows the Clarity PPM Data Warehouse Audit dashboard