Configure the Data Warehouse and Advanced Reporting

2
ccppmod156
HID_admin_configure_adv_reporting
Use Advanced Reporting to create ad hoc views of 
Clarity PPM
 data and save the views as reports. You can then email the reports, export them, display them on a dashboard, or consume them as is. To create ad hoc views, report builders can select from a set of advanced reporting domains that contain default product data. The domains are the metadata layer to the 
Clarity PPM
 data warehouse (DWH). You need the PMO Accelerator add-in with Jaspersoft Advanced Reporting content to view domains and reports. See the 
PMO Accelerator Release Notes
 for more information.
 
 
2
 
 
Advanced Reporting Data Components
The following diagram shows the advanced reporting data components. The data warehouse and the advanced reporting domains form the foundation of the reporting architecture. For data warehouse schema and domain field definitions, see the Advanced Reporting and Database Schema Index.
Advanced Reporting Data Components
Advanced Reporting Data Components
The CA PPM Data Warehouse
The data warehouse (DWH) is the main data source for the advanced reporting solution. Advanced Reporting lets you create both ad hoc reports and Jaspersoft Studio reports that you can display on a dashboard. The data warehouse schema is optimized specifically for reporting and analytics. The schema includes the investment, resource, portfolio, timesheet, and project objects.
The following five (5) jobs update the data warehouse:
  •  
    Load Data Warehouse
    : This job loads the data incrementally or in full.
  •  
    Load Data Warehouse Access Rights
    : This job loads user permissions.
  •  
    Create Data Warehouse Trend
    : This job creates new data warehouse trending information.
  •  
    Update Data Warehouse Trend
    : This job updates selected trending tables with the latest information.
  •  
    Delete Data Warehouse Trend
    : This job removes selected trends from the data warehouse.
The DWH schema is populated at scheduled intervals by the Load Data Warehouse and the Load Data Warehouse Access Rights jobs. These two ETL jobs extract the relevant data from the PPM database, transform the data, and load it into the data warehouse.
A standard set of table prefixes, lookups, fact tables, and queries are used in the data warehouse to work with any reporting tool. See CA PPM Data Warehouse (DWH) Conventions. The data warehouse can be extended to include custom objects and attributes.
The PMO Accelerator add-in includes Jaspersoft Studio reports. These SQL reports are written directly against the data warehouse. A few of these reports are written against the 
Clarity PPM
 database.
: For better performance, write your reports against a data source and not against the domain layer. We also recommend that you write all reports against the data warehouse data source. Use the PPM database as your data source only if the required data is not available in the data warehouse. Performance is better when you use the data warehouse data source.
 To write more sophisticated reports directly against the data warehouse or the database, download a client tool such as Jaspersoft Studio. For information about Jaspersoft Studio, see the Jaspersoft Community.
View Objects and Attributes Included in the Data Warehouse
Only the most commonly used stock objects and attributes in the product are included in the data warehouse by default.  These same objects and attributes are visible in the domains. To identify these objects and attributes, use the following procedure:
 
Follow these steps:
 
  1. Click 
    Administration
    Studio
    Objects
    .
  2. In the 
    Objects
     list, a check mark appears in the 
    Data Warehouse
     column to identify the included objects. You can also open the object and view the 
    Include in the Data Warehouse
     check box.
  3. Select an object and click the 
    Attributes
     tab.
  4. In the 
    Attributes
     list, a check mark appears in the 
    Data Warehouse
     column to identify the included attributes. You can also open the attribute and view the 
    Include in the Data Warehouse
     check box.
: Certain object attributes that are automatically included in the data warehouse do not have the Data Warehouse field selected. These attributes are also visible in the domains.
The following object attributes are included in the data warehouse. However, the Data Warehouse field does not appear selected for these attributes.
Project
% Complete % Expended Actuals Actuals for Labor Resources Actuals Sum for Labor Resources ACWP Alignment BAC Baseline Cost Baseline Usage BCWP BCWP Override BCWS Budgeted Benefit Budgeted Capital Cost Budgeted Capital % Budgeted Cost Budgeted IRR Budgeted MIRR Budgeted NPV Budgeted Operating % Budgeted Operating Cost Budgeted ROI Cost Variance % CPI Current Baseline for Labor Resources Current Baseline Sum for Labor Resources Current Baseline Variance for Labor Resources Current Baseline Variance Sum for Labor Resources CV Detailed Budget Actual Benefit Detailed Budget Benefit Detailed Budget Capital Cost Detailed Budget Cost Detailed Budget Operating Cost Detailed Forecast Cost Detailed Planned Actual Benefit Detailed Planned Benefit Detailed Planned Capital Cost Detailed Planned Cost Detailed Planned Operating Cost EAC EAC(AT) EAC(T) EAC for Labor Resources EAC Sum for Labor Resources ETC ETC(AT) ETC(Cost) ETC for Labor Resources ETC Sum for Labor Resources Initial Investment Override Value for Reinvestment Rate Override Value for Total Cost of Capital Planned Benefit Planned Capital % Planned Capital Cost Planned Cost Planned IRR Planned MIRR Planned NPV Planned Operating % Planned Operating Cost Planned ROI Projected Cost Variance Projected Cost Variance % Projected Effort Variance Projected Effort Variance % Schedule to Baseline Schedule Variance % SPI Total Effort Total Labor Effort
Task
% Complete % Expended Actuals ACWP BAC Baseline Cost Baseline Duration Baseline Usage Baseline Variance BCWP BCWP Override BCWS Cost Variance % CPICV Duration EAC EAC(AT) EAC(T) ETC ETC(AT) ETC(Cost) ETC(T) Finish Variance Schedule Variance % SPI Total Effort
Benefit Plan
Total Actual Benefit Total Benefit Total Billing Benefit
Benefit Plan Detail
Actual Benefit Benefit Billing Benefit Percentage Total Actual Benefit Total Benefit Total Billing Benefit Variance
Cost Plan
Total Cost Total Revenue Total Units
Cost Plan Detail
Actual Cost Actual Revenue Actual Units Billing Cost Billing Cost Total Billing Revenue Billing Revenue Total Cost Cost Total Cost Variance Revenue Revenue Total Revenue Variance Units Units Total
Team
Actuals Allocation Allocation Cost Baseline Cost Baseline Usage Baseline Variance Capitalization % ETC Hard Allocation Hard Allocation Cost Incident Actuals Total Actuals Total Usage
Portfolio
Distributed Benefits Distributed Benefits (Total) Distributed Capital Cost Distributed Capital Cost (Total) Distributed Cost Distributed Cost (Total) Distributed Operating Cost Distributed Operating Cost (Total) Distributed Overall Roles Distributed Overall Roles (Total) Target Benefits Target Capital Cost Target Operating Cost Target Overall Roles Target Total Cost Target Total Roles
Assignment
% Complete % Expended Actual Cost Actuals Actuals (Compare To) Baseline Cost Baseline Usage ETC ETC (Compare To) ETC Cost Max % Load Pending Actuals Proposed ETC Total Effort
Configure the Data Warehouse
Over time, you can configure the data warehouse settings to adjust to your changing business needs. For example, you initially set up the data warehouse for English but later decide to add more languages for localization.
 Whenever you change the data warehouse configuration, run the Load Data Warehouse job with the Full Load option selected.
Specify the languages, entity for fiscal periods, and other options that allow you to eliminate unused slice periods. The settings help reduce the number of fact records stored and the processing time for populating the Data Warehouse.
 After modifying the fields that are described in the following procedure, run the 
Load Data Warehouse
 job with Full Load selected. Changes to the field 
Entity for Fiscal Periods
 result in a resource-intensive operation because all fiscal fields within the data warehouse are recalculated.
 
Follow these steps:
 
  1.  Click 
    Administration
    General Settings
    System Options.
     
  2. In the 
    Data Warehouse Options
     section, complete the following fields:
    •  
      Languages
      Specifies the language localizations that are included in the Data Warehouse. Multiple languages result in increased storage requirements on the Data Warehouse server.
      Note:
       Always select English. Otherwise, the Load Data Warehouse job fails.
    •  
      Entity for Fiscal Periods
      Specifies the entity that is used to determine the fiscal periods for use in all Data Warehouse fiscal period data calculations. Setting the entity for the first time or updating the entity creates Data Warehouse time slice requests. Hence, the initial run or any subsequent runs (after updating the entity) of the Time Slicing job takes longer than normal.
      Initially setting an entity or updating it also updates the fiscal entity and fiscal period type for the Data Warehouse fiscal time slice requests. Do not set or change the entity when a time slice rollover is in progress. If you do, an error message appears. Wait until the rollover completes and then set the entity. To determine which slice requests are in the rollover, check the expiration date on the time slices. A slice request with an expiration date that matches one of the following is in the rollover: 
      • blank or no date
      • Earlier than the current date
      • Same as the current date
      Allow the slice request to complete processing before setting the entity. 
      The entity must have Monthly (or 13 period) fiscal time periods set up to cover the time range of the time slice requests. Otherwise, the time slice requests are ignored when the Time Slicing job runs. If both Monthly and 13 Periods fiscal time periods per year exist, Monthly takes priority.
      Select at least one period data (Weekly, Monthly, or Fiscal). If you do not select the period data, the Load Data Warehouse job for both full and incremental loads fail with an error message.
       
       
    •  
      Include Weekly Period Data
      Specifies if you want to look at the data by week. When selected, facts are loaded in weekly increments.
    •  
      Include Monthly Period Data
      Specifies if you want to look at the data by months. When selected, facts are loaded in monthly increments.
    •  
      Include Fiscal Period Data
      Specifies if you want to look at the data by fiscal time periods. When selected, facts are loaded in fiscal time periods. The fiscal time period is determined by the value set in the Entity for Fiscal Periods field.
    •  
      Consistent Fiscal Periods Across Entities
      Specifies if the fiscal time period dates are consistent across the entities. Select this option if your organization has the same accounting periods across all entities. Leave the option unchecked if you have entities with different fiscal periods. You experience better performance when the option is selected. If you have only one entity, do not select the check box.
    •  
      Include Only Financial Plan of Record
      Specifies whether to include all financial plans (cost plans, budget plans, and benefit plans) or only the current budget plan and the cost plan of record in the Data Warehouse. By default, only the current budget plan, the cost plan of record, and associated benefit plans are included in the Data Warehouse. To report on only the current budget plan or the cost plan of record, keep the option selected. To compare old plans with current plans on investments, uncheck this option. Unchecking this option can impact the Data Warehouse performance. You might notice a significant difference in the load time for large data sets.
  3. Save your changes.
  4. Run the following jobs in the listed order:
    • Time Slice
    • Load Data Warehouse
    • Load Data Warehouse Access Rights
Configure the Data Warehouse Time Slices
Time slices with the Data Warehouse option selected determine the ranges for the Data Warehouse facts. Data Warehouse time slice requests are system requests and cannot be deleted.
The Data Warehouse time slice requests default to the following time periods, which are based on the database server system date:
  • One year back and forward for Daily. The From Date of the slice request is one year before the system date.
  • One year back and forward for Weekly. The From Date is one year before the system date. The From Date is the same day as the First Day of Work Week defined under Administration,  Project Management Settings.
  • Three years back and forward for Monthly. The From Date is three years before the system date and is always the first day of the month.
  • Three years back and forward for Fiscal. The From Date is three years before the system date. The From Date is the start date of the fiscal period for the entity that is selected for the Data Warehouse. The fiscal period that is referenced is of type Monthly or 13 Period, whichever is set for the entity.
     The entity must have Monthly (or 13 Period) fiscal time periods set up to cover the range of the time slice requests. Otherwise, the time slice requests are ignored when the Time Slice job runs.
Verify that the ranges work for your business needs. To update the From Date and Number of Periods, open a time slice and change the properties.
Rules for Setting the From Date and Number of Periods
 By default, the Data Warehouse time slice requests are set consistently for each slice period (Daily, Weekly, Monthly, Fiscal). If you edit these slice requests, set the From Date and Number of Periods to be the same for each slice period type. If the From Date and Number of Periods are not set correctly, the data in the Data Warehouse is inconsistent.
Follow these rules when setting the From Date and Number of Periods for the Data Warehouse time slice requests:
  • Verify that there is only one daily time slice request.
  • For all weekly time slice requests, the From Date must be the same day as the First Day of the Work Week in the Project Management settings. For example, if the First Day of the Work Week is a Monday, then set all weekly time slice requests with a From Date that is a Monday.
  • For all monthly time slice requests, the From Date must always be the first of a month.
  • For all fiscal time slice requests, the From Date must correspond to the start date of a Monthly (or 13 Period) fiscal period type.
  • The time slice ranges must include the start and finish dates of the investments on which you regularly report. For example, if you have two-year investments, set the time slices to cover two years back and forward to include all relevant data in the Data Warehouse.
Enable Custom Objects and Attributes for the Data Warehouse
To view any preexisting custom objects and attributes in the domains, explicitly enable them for inclusion in the Data Warehouse. Depending on their permissions, report users only see the data in the domains that is Data Warehouse-enabled by their system administrators. Verify that the custom objects and attributes that you want to enable for the Data Warehouse exist in the product. For more information about objects and attributes, see 
 
Clarity PPM
 
 S
tudio Development. 
 
 Enable a custom master object for the Data Warehouse before enabling a custom sub object of the master object. Otherwise, the option to include the sub object in the data warehouse appears disabled. Similarly, enable an object for the Data Warehouse first, before enabling the custom attributes of that object.
 
Follow these steps:
 
  1. Click 
    Administration
    Studio
    Objects
    .
  2. To enable a custom object for the Data Warehouse, complete the following steps:
    1. Click the object name to open its properties.
    2. Select the 
      Include in the Data Warehouse
       check box and save.
  3. To enable each custom attribute for the Data Warehouse, complete the following steps:
    1. With the object open, click 
      Attributes
      .
    2. Click the attribute name to open its properties.
    3. Select the 
      Include in the Data Warehouse
       check box and save.
      To enable multiple custom attributes at once, select them on the object attributes list page and then select 
      Include in Data Warehouse
      .
  4. Click 
    Save and Return
    .
  5. Run the Load the Data Warehouse job to include the custom objects and attributes in the Data Warehouse and domains. See Run or Schedule a Job 
    .
     
  6. Check the Custom Master Objects domain to verify that your custom object appears in the domain. Check the other domains to verify that your custom attributes appear in the respective domains. For information about what custom attributes are included in which domains, see 
    Advanced Reporting Domains in this article
    .
Update Calculated and Number Custom Attributes Included in the Data Warehouse
You can update the formulas or decimal places for any custom attributes (calculated or number) that are included in the Data Warehouse. We recommend that you build and validate the formulas for the calculated attributes before including the attributes in the Data Warehouse.
 
Follow these steps:
 
  1. Deselect the 
    Include in the Data Warehouse
     check box for the attribute to disable it for the Data Warehouse.
  2. Run the Load Data Warehouse job to remove the attribute from the Data Warehouse and domains.
  3. Build the new formula that is associated with the custom calculated attribute and validate. Or, change the decimal places for the number custom attribute.
  4. Select the 
    Include in the Data Warehouse
     check box for the attribute to enable it for the Data Warehouse.
  5. Rerun the Load Data Warehouse job to add back the attribute to the Data Warehouse and domains.
Disable Custom Objects and Attributes from the Data Warehouse
 
Follow these steps:
 
  1. Disable all the custom sub objects for that master object. Next, disable the custom master object from the Data Warehouse.
    Disabling the master object also disables the custom attributes for the master and sub objects from the Data Warehouse.
  2. Run the Load Data Warehouse job for the changes to take effect. Verify that the Full Load option is selected when running the job.
    Run the job at least once before re-enabling an object or attribute for the Data Warehouse.
 Do not delete or disable any attribute available from an add-in because doing so can break reporting functionality. Before disabling custom objects or attributes from the Data Warehouse, verify that those objects and attributes are not used in any views or reports. We recommend that you notify all users to remove those objects or attributes from any views or reports that are currently using them. If the users do not remove those objects or attributes from the views or reports, they cannot create views and reports. The existing views and reports become unusable. A system error appears when they try to access the existing views or reports.
 
Workaround
 
You can work around the system error and can allow users access to the previously saved views and reports.
 
Follow these steps:
 
  1. Re-enable the disabled or deleted objects or attributes for the Data Warehouse.
  2. Read the custom objects and attributes to the Data Warehouse and domains by running the Load the Data Warehouse job.
  3. Access the ad hoc views and reports that use the re-enabled objects or attributes. Manually remove the appropriate objects or attributes from the ad hoc views and reports and save.
  4. Disable the custom objects or attributes from the Data Warehouse by deselecting the 
    Include in the Data Warehouse
     check box.
  5. Run the Load the Data Warehouse job to remove the custom objects and attributes from the Data Warehouse and domains.
 You can disable multiple custom attributes at once by selecting them on the attributes list page and then selecting 
Exclude from Data Warehouse
.
Manage Security for Advanced Reporting
To manage security for advanced reporting, manage the following key areas:
  •  
    Advanced reporting users and roles
    : Keep the user information synchronized between 
    Clarity PPM
    and Jaspersoft.
  •  
    User and Shared folders:
     To control the sharing of content, manage the folder structure.
  •  
    Repository content items:
     Manage access to the folder contents.
 
Clarity PPM
 users access the Jaspersoft user interface by selecting the Advanced Reporting option from the Home menu. Token-based authentication is used to auto-authenticate 
Clarity PPM
 users for Jaspersoft without requiring separate login. When successfully authenticated, the 
Clarity PPM
 users can access the advanced reporting home page in the Jaspersoft application.
Verify Prerequisites
Verify that you have completed the following requirements:
  • The PMO Accelerator add-in with Jaspersoft Advanced Reporting content is available. See the 
    PMO Accelerator Release Notes
    .
  • A list of users with advanced reporting access rights or groups exist in 
    Clarity PPM
    . See Configure User Accounts, Skills, and Access Rights.
  • You have the administration access right to assign the Advanced Reporting access rights to 
    Clarity PPM
     users or groups.
Assign Access Rights to Users
Grant the appropriate Advanced Reporting access rights to the 
Clarity PPM
 users. For example, to allow users to run reports, assign the following access rights:
  • Advanced Reporting - Navigate
  • Advanced Reporting - Report Create
For detailed descriptions of the advanced reporting access rights, see 
Advanced Reporting Access Rights
 under 
Access Rights Reference 
in the English edition of the documentation.
For information about how to view the access rights that are assigned to each license type, see View User Counts by License Type.
Synchronize Users Between 
Clarity PPM
 and Jaspersoft
Synchronize the users between 
Clarity PPM
 and Jaspersoft using one of the following methods:
  • Synchronize interactively to ensure that whenever user properties are updated in 
    Clarity PPM
    , they also get updated in Jaspersoft. The update is triggered when the user clicks the Advanced Reporting link in 
    Clarity PPM
    .
  • Run the Create and Update Jaspersoft Users job in incremental mode (with the Full Sync option unselected). Selects the delta and updates the properties and roles or permissions of the new or updated users in 
    Clarity PPM
    .
 
Synchronize Users Interactively 
 
The interactive synchronization method synchronizes user properties (user name, user ID, or email) from 
Clarity PPM
 to Jaspersoft. The system uses this method for synchronizing user properties for only the logged in user in the following cases:
  • There is a change in the user properties.
  • The user is accessing Jaspersoft for the first time.
The system checks the CMN_JASPER_SYNCED_USERS table for any changes to the user properties since the last sync date. The user is not synchronized again with Jaspersoft if there are no changes to the user properties.
 
Follow these steps:
 
  1. Log in to 
    Clarity PPM
     with the credentials of the user that you want to synchronize with Jaspersoft.
  2. Click 
    Home
    Personal
    Advanced Reporting
    .
    A new user is created in Jaspersoft. 
Whenever a user accesses advanced reporting from 
Clarity PPM
, the user login parameters (theme, locale, or time zone) are passed to Jaspersoft. If during a session, any of these parameters change, the updates are applied in the next session.
 
Run or Schedule the Create and Update Jaspersoft Users Job
 
Run or schedule the Create and Update Jaspersoft Users job to synchronize the following information from 
Clarity PPM
 to Jaspersoft for all new and existing users:
  • User roles that are based on 
    Clarity PPM
     advanced reporting access rights.
  • User profile attributes such as theme, language, locale, and time zone.
 
Follow these steps:
 
  1. Click 
    Home
    Personal
    Reports and Jobs
    .  
  2. Click 
    Jobs
     and run the Create and Update Jaspersoft Users job.
  3. (Optional) Schedule the job to run at a recurring interval.
    For more information about running or scheduling jobs, see Run or Schedule a Job 
    .
     
 
Recommendations for Running the Create and Update Jaspersoft Users Job
 
We recommend that you run the job as opposed to interactively synchronizing the users in the following situations:
  • As part of initial data setup between 
    Clarity PPM
     and Jaspersoft, when you create or update users in bulk.
  • You have inactivated or locked a user or a group of users in 
    Clarity PPM
    . You want to inactivate these users in Jaspersoft too. In this case, running the job is the only way to inactivate these users in Jaspersoft.
  • The Jaspersoft Reporting server goes down while updating user properties in 
    Clarity PPM
    . In this case, you cannot interactively synchronize the users. When the Jaspersoft server is back up, run the job to update the user properties.
  • An active 
    Clarity PPM
     user with Advanced Reporting access rights is disabled in Jaspersoft by the Jaspersoft superuser. The next run of the job makes the user active again in Jaspersoft.
Run the job with the "Full Sync" option selected in the following situations:
  • To synchronize all the 
    Clarity PPM
     active Advanced Reporting users with Jaspersoft.
  • To remove all empty user-specific folders under the Users folder that have names corresponding to 
    Clarity PPM
     resource IDs.
  • To remove all the inactive or locked 
    Clarity PPM
     Advanced Reporting users from Jaspersoft.
    The user-specific folders and their content remain intact even after the users are removed from Jaspersoft. The Jaspersoft administrator must manually delete the user-specific folders and their content.
If you do not select the Full Sync option, the job synchronizes only the 
Clarity PPM
 active Advanced Reporting users with Jaspersoft. The job does not perform any removal-related actions.
 
Automatic Completion of Tasks
 
Run the Create and Update Jaspersoft Users job with or without the Full Sync mode to automatically complete the following tasks:
  • Create advanced reporting users in Jaspersoft provided the following conditions are true:
    • The users do not already exist in Jaspersoft.
    • The users are active in 
      Clarity PPM
       and are assigned any of the advanced reporting access rights.
  • Pass user properties from 
    Clarity PPM
     to Jaspersoft. Also, update the properties whenever they are updated in 
    Clarity PPM
    .
  • Assign users appropriate roles in Jaspersoft. The roles are based on the advanced reporting access rights that are assigned in 
    Clarity PPM
    .
  • Update the license type counts in 
    Clarity PPM
     based on the advanced reporting access rights that are assigned to users.
  • Reactivate a valid 
    Clarity PPM
     user in Jaspersoft who has been disabled or deleted by the Jaspersoft superuser. The user must be still active in 
    Clarity PPM
    .
  • Update corresponding roles in Jaspersoft when advanced reporting access rights are updated for users in 
    Clarity PPM
    . For example, if all the advanced reporting access rights are revoked for a user in 
    Clarity PPM
    , the corresponding user role is revoked in Jaspersoft. The user remains active in both 
    Clarity PPM
     and Jaspersoft. The license types are also updated in 
    Clarity PPM
     based on the updated access rights.
Assign Roles to Users, and Allow Access to the Repository
The Synchronize Jaspersoft Roles job assigns users to appropriate roles in Jaspersoft that are based on their advanced reporting access rights. The advanced reporting roles determine the blocks that appear on the advanced reporting home page. For example, users who are assigned to the ROLE_ADHOC_DESIGNER role can view the Ad Hoc Views block, and so on. The ROLE_USER does not view any blocks on the home page. Users can navigate to the repository folders to see the content that they can access.
The following list describes the default advanced reporting roles. The designer roles can create content but cannot change the default repository content. The administrator role can change the default repository content and the user role has no access to the repository content.
  • ROLE_USER. Allows read only access to the Users folder so they can see the folder but cannot delete it. Assigns execute access to the Themes folder for out-of-the-box 
    Clarity PPM
     themes.
  • ROLE_ADHOC_DESIGNER. Allows the right to create ad hoc views from a domain and save them. They can edit, copy, or delete ad hoc views that they create, create reports from ad hoc views, and delete existing ad hoc views.
  • ROLE_REPORT_DESIGNER. Allows the right to create and view reports, create a report from an ad hoc view or a query, or from Jaspersoft Studio. They can save a report, edit the definition of a Jaspersoft report in the repository, and copy or delete an existing report. The role also allows view access to the Public folder.
  • ROLE_DASHBOARD_DESIGNER. Allows the right to view dashboards and reports, create a dashboard from a report, and save a dashboard. They can edit, copy, or delete their existing dashboards.
  • ROLE_ADMINISTRATOR. Allows full access on SHARED folder and its sub folders. They can delete the SHARED folder and have administer access to the Users folders. They have read-only access to the Themes folder and the Public folder.
  • ROLE_DATASOURCE_DESIGNER. Allows the right to define connections between Jaspersoft and their database or other data source referenced by their reports and domains. They can create, edit, and delete data sources
  • ROLE_DOMAIN_DESIGNER. Allows permission to create, edit, and delete domains.
 The advanced reporting roles that are assigned based on the advanced reporting access rights only provide create privileges, not view or edit privileges. To run a report, an advanced reporting user needs additional PMO roles that provide view access to the repository content. They either need a PMO role that has access to a specific report or a PMO role that has access to all reports. You need the PMO Accelerator add-in with Jaspersoft Advanced Reporting content to access additional advanced reporting roles. See 
PMO Accelerator Advanced Reporting Content
 for more information.
 
Follow these steps:
 
  1. In 
    Clarity PPM
    , grant the users the required advanced reporting access rights. Alternately, assign the users to the PMO Advanced Reporting access groups that automatically assign the group rights to the users.
    For example, to allow a user to access all the project management reports, assign the user to the PMO Advanced Reporting Project Management access group. For information about which PPM access groups correspond to which Jaspersoft roles, see 
    Advanced Reporting Roles and Permissions
     in the English edition of the documentation.
  2. Click 
    Home
    Personal
    Reports and Jobs
    .
     
    Click 
    Jobs
     and run the Synchronize Jaspersoft Roles job.
    The job assigns the advanced reporting roles to the users based on their access group assignment in PPM. For example, the job assigns the CSK_ROLE_PROJECT_MANAGEMENT in Jaspersoft to the users in the PMO Advanced Reporting Project Management access group. For more information about the Synchronize Jaspersoft Roles job, see 
    Jobs Reference
     in the English edition of the documentation.
  3. Click 
    Home
    Personal
    Advanced Reporting
    .
    The Advanced Reporting home page opens in the Jaspersoft® application.
If you are not satisfied with the permissions available to each role by default or through the PMO roles, create custom roles. Create the custom roles under the Users and Shared folders in Jaspersoft. Next, grant the required permissions to the custom roles for access to the repository content. The custom roles are not overwritten by the Synchronize job or during upgrade.
 For information about creating roles and assigning permissions, access the Jaspersoft Community web site and click the Documentation link or Docs link. On the Documentation page, select the version of Jaspersoft that corresponds to your 
Clarity PPM
 release. Then click the link for the 
JasperReports Server Administration Guide
. See the 
 
Clarity PPM
 
 
Release Notes
 for the Jaspersoft version that corresponds to your 
Clarity PPM
 release.
Manage User and Shared Repository Folders
The repository folders maintain the access to the advanced reporting content.
 To get a 
Clarity PPM
 folder structure in your repository with the default advanced reporting content, install the PMO Accelerator add-in with Jaspersoft Advanced Reporting content. See 
PMO Accelerator Advanced Reporting Content
 for more information.
Administrators can see all repository folders and the items within these folders.
The Shared folder includes the following sub folders that are empty by default:
  • Ad Hoc Components (includes Ad Hoc Reports)
  • Dashboards
  • Reports
All users with advanced reporting access rights have read, write, and delete permissions to the Shared folder. They can add content to this folder and can create custom folders under this folder. However, they cannot delete the folders or their content. Only the Jaspersoft administrator can delete this folder, its sub folders, and their content. The custom folders and their content remain unchanged during an upgrade.
The content of the Shared folder also remains intact on upgrade. Once deleted, this folder is recreated only on upgrade without any content inside it.
 The Users folder is read-only and appears grayed-out. Users cannot create folders under the Users folder. The Jaspersoft administrator can create user-specific folders under the Users folder and can assign administrative rights to the users for their specific folders. The Jaspersoft administrator can follow any naming convention for the user-specific folders. However, when the Create and Update Jaspersoft Users job runs in Full Sync mode, any empty user-specific folders under Users are deleted provided the folder names correspond to 
Clarity PPM
 resource IDs.
To make your folder structure more granular, or to control the sharing of content more, create your own folders under Shared. We recommend that you do not create any custom folders or content in the 
Clarity PPM
 folder or its sub folders. Any content in the 
Clarity PPM
 folder or its sub folders is overwritten during an upgrade.
 For information about creating folders, access the Jaspersoft Community web site and click the Documentation link or Docs link. On the Documentation page, select the version of Jaspersoft that corresponds to your 
Clarity PPM
 release. Then click the link for the 
JasperReports Server Administration Guide
. See the 
 
Clarity PPM
 Release Notes
 for the Jaspersoft version that corresponds to your 
Clarity PPM
 release.
Manage Repository Content Items
Repository content items include domains, reports, ad hoc views, and dashboards. Install the PMO Accelerator add-in with Jaspersoft Advanced Reporting content to access the CA PPM folder structure with default content. 
We recommend that you do not change the default permissions for the following roles:
  • ROLE_ADHOC_DESIGNER
  • ROLE_ADMINISTRATOR
  • ROLE_DASHBOARD_DESIGNER
  • ROLE_DATASOURCE_DESIGNER
  • ROLE_DOMAIN_DESIGNER
  • ROLE_REPORT_DESIGNER
  • ROLE_USER
The permissions are associated with the folders in the CA PPM folder structure. Any changes to the permissions may get overwritten by an upgrade or patches:
The PMO accelerator add-in includes a set of "CSK_" roles. See Advanced Reporting Roles and Permissions for more information about these roles. You can use these roles to secure the CA PPM folder content. The "CSK_" role permissions may get overwritten during an upgrade or patches. However, any users who are assigned to these roles are preserved. Alternatively, you can create your own custom roles to secure the CA PPM folder structure. The custom roles permissions are not overwritten by an upgrade or patches.
 For information about setting folder permissions, visit the Jaspersoft Community and click the Documentation or Docs link. Then click the link for the 
JasperReports Server Administration Guide
. On the Documentation page, select the supported version of Jaspersoft for your 
Clarity PPM
 release (see the Release Notes).
Advanced Reporting Domains
The advanced reporting domains provide business representations of the 
Clarity PPM
 Data Warehouse, enabling you to interact with your data. Create ad hoc views and reports by selecting fields from a list of domains. By default, the domains contain the most frequently used product data and are dynamically updated whenever the Load Data Warehouse and Load Data Warehouse Access Rights jobs refresh the Data Warehouse. If you add custom objects or attributes to the product, you can flag these custom objects and attributes to be included in the Data Warehouse and the domains.
 To view out-of-the-box domains and reports, you need the PMO Accelerator add-in with Jaspersoft Advanced Reporting content. See the 
PMO Accelerator Release Notes
 and 
PMO Accelerator Add-in Setup
 for more information. 
Report builders use an interactive web-based designer to create ad hoc views. Ad hoc views are charts, tables, and cross tabs that let you analyze data from the domains. They can also use the ad hoc views to generate ad hoc reports which they can share or output in the following ways:
  • Single standalone report
  • Multiple relates reports on a dashboard
  • Word, PDF, Excel, PowerPoint documents, or other formats
  • Email attachment
 
Domain Content 
 
Domain fields are organized into sets and items. The sets act like folders that you can expand to view the items in that set. For example, the Investments set in the Investment Management domain include the following items or fields that are generic to all investment types:
  • Investment Name
  • Investment ID
  • Investment Type
  • Description
  • Investment Manager
  • Start Date
  • Finish Date
 For detailed information about the domain fields, see 
Advanced Reporting Domain Field Descriptions
 on the Advanced Reporting and Database Schema Index.
Each domain also includes any custom sub objects and attributes that you add to the 
Clarity PPM
 objects. For example, custom attributes that you add to the Investment object show up in the Custom set under the Investment set in the Investment Management domain. Custom attributes that you add to the Team object show up in the Custom set under the Team set in the Investment Management domain, and so on.
Custom sub objects that you add to the 
Clarity PPM
 objects show up under the Custom set for the objects. They appear in their own sub object set having the name of the sub object. For example, if you add a custom “Country” sub object to the Investment object, this sub object appears in the Custom set for the Investment object under a set named “Country”.
 
Domain Permissions
 
Any item level security that is defined in the product for projects, investments, and resources are utilized in the domains. For example, if you have access to view specific projects in the product, you can view the same projects in the domains.
The project and investment view rights in the product secure following domains. Users can view the projects and investments in these domains to which they have access in the product.
  • Idea Management
  • Application Management
  • Investment Management
  • Project Management
  • Financial Management
The resource view rights in the product secure the following domains. Users can view the resources and timesheets in these domains to which they have access in the product.
  • Resource Management
  • Time Management
If you have the PMO Accelerator add-in with Jaspersoft Advanced Reporting content, extra advanced reporting roles and corresponding domain permissions are available to you. For more information about these roles and their assigned permissions, see the .
Application Management Domain
The Application Management domain includes summary information about the application investment. The domain also includes financial summary data for applications but not detailed financial planning data. For information about detailed financial planning data for applications, see the Financial Management domain.
The portfolio attributes included in this domain are primarily for filtering applications by portfolios.
The domain includes data from the following 
Clarity PPM
 objects:
  • Investment
  • Team
  • Financials
  • Application
The object data is further broken down into the following high-level sets of items:
  • Investments
  • General
  • OBS
  • Portfolio
  • Program
  • Team
  • Financial
  • Investment Totals
  • Weekly Periods
  • Calendar Periods
  • Fiscal Periods
  • Settings
  • Internal ID
 
Custom Fields
 
This domain is updated if you add custom sub objects or fields to the following objects in the product: Investment, Team, Application, and Financials.
  • If you add a custom field to the Investment object in 
    Clarity PPM
     and this field is Data Warehouse-enabled, the custom field appears in the Application Management domain under the Application set in a Custom folder.
  • If you add a custom field to the Team object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Team set in a Custom folder.
  • If you add a custom field to the Application object in 
    Clarity PPM
     and this field is Data Warehouse-enabled, the custom field appears in the Application Management domain under the Application set in a Custom folder.
  • If you add a custom field to the Financials object in 
    Clarity PPM
     and this field is Data Warehouse-enabled, the custom field appears in the this domain under the Financial set in a Custom folder.
If you have custom sub objects as children of the Investment or Application objects, the sub objects appear as their own sets under the Custom folder in this domain. The corresponding sub object fields appear under the sub object sets. We do not currently add custom sub objects of the Financials sub object to the Investment domain.
Custom Master Objects Domain
The Custom Master Objects domain includes custom master objects data and the child sub object data. The custom master objects are not related to any of the 
Clarity PPM
 out-of-the-box objects. You can only look at one custom master object and its sub objects at a time in the ad hoc viewer.
 To include custom master objects in this domain, first enable these objects for the Data Warehouse. For more information, see Enable Custom Objects and Attributes for the Data Warehouse.
 
Example: Adding a Custom Object
 
The Documentation Management company is considering renovating its conference rooms across all the offices in the country. To help figure out the cost, they gather information about all the conference rooms in the various offices. The company creates the following custom data and enables it for the Data Warehouse so they can view and analyze it using the ad hoc viewer:
A custom master object that is named Offices and that includes the following custom attributes:
  • Location
  • Square Feet
  • Number of Employees
A custom sub object that is named Conference Rooms for the Offices master object. The sub object includes the following custom attributes:
  • Has Video Conferencing
  • Available Seating
  • Room Number
Financial Management Domain
The Financial Management domain includes detailed financial planning data from cost, budget, and benefit plans for investments. The financial planning data appears broken down by charge codes, cost types, and other grouping attributes, in fiscal time periods only (not calendar or weekly periods). The domain also includes work-in-process transaction data at the transaction level.
Summary investment-level financial data is not part of this domain. For summary level financial data, see the Investment Management domain.
 The domain displays data for financial users. If you are not using Financial Management, you can see the domain fields but there will not be any data for the fields.
The domain includes data from the following 
Clarity PPM
 objects:
  • Financials
  • Benefit Plan
  • Benefit Plan Details
  • Cost Plan
  • Cost Plan Detail
The object data is broken down into the following high-level sets of items:
  • OBS
  • Investments
  • Internal IDs
 
Custom Fields
 
This domain is updated if you add custom sub objects or fields to the following objects in the product: Financials. Cost Plan, Cost Plan Detail, Benefit Plan, and Benefit Plan Detail.
  • If you add a custom field to the Financials object in 
    Clarity PPM
     and this field is Data Warehouse-enabled, the custom field appears in the Financial Management domain under the Financials set in a Custom folder.
  • If you add a custom field to the Cost Plan object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Cost Plan set in a Custom folder.
  • If you add a custom field to the Cost Plan Details object in 
    Clarity PPM
     and this field is Data Warehouse-enabled, the custom field appears in this domain under the Cost Plan Detail set in a Custom folder.
  • If you add a custom field to the Benefit Plan object in 
    Clarity PPM
     and this field is Data Warehouse-enabled, the custom field appears in this domain under the Benefit Plan set in a Custom folder.
  • If you add a custom field to the Benefit Plan Detail object in 
    Clarity PPM
     and this field is Data Warehouse-enabled, the custom field appears in this domain under the Benefit Plan Detail set in a Custom folder.
If you have custom sub objects as children of the Financials object, the sub objects appear as their own sets under the Custom folder in this domain. The corresponding sub object fields appear under the sub object sets. We do not currently add custom sub objects of the Financials sub object to the Investment domain.
Idea Management Domain
The Idea Management domain includes summary information about the idea investment. The domain also includes team and high-level financial information for ideas. The portfolio attributes included in this domain are used primarily for filtering ideas by portfolios.
 Incidents are not included in this domain. They are only included in the Time Management domain.
The domain includes data from the following 
Clarity PPM
 objects:
  • Investment
  • Team
  • Financials
  • Idea
The object data is further broken down into the following high-level sets of items:
  • Investments
  • General
  • OBS
  • Portfolio
  • Program
  • Team
  • Financial
  • Investment Totals
  • Weekly Periods
  • Calendar Periods
  • Fiscal Periods
  • Settings
  • Internal IDs
 
Custom Fields
 
This domain is updated if you add custom fields to the following objects in 
Clarity PPM
: Investment, Team, Ideas, and Financials.
  • If you add a custom field to the Investment object in 
    Clarity PPM
     and this field is Data Warehouse-enabled, the custom field appears in the Idea Management domain under the Idea set in a Custom folder.
  • If you add a custom field to the Team object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Team set in a Custom folder.
  • If you add a custom field to the Idea object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Idea set in a Custom folder.
  • If you add a custom field to the Financials object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Financial set in a Custom folder.
If you have custom subobjects as children of the Investment or Idea objects, the subobjects appear as their own sets under the Custom folder in this domain. The corresponding subobject fields appear under the subobject sets. We do not currently add custom sub objects of the Financials sub object to the Investment domain.
Investment Management Domain
The Investment Management domain includes summary information about all investment types and their teams. This domain only includes information that is common to all investment types (project, asset, application, and so on). For example, no information about assignments is included because some investments do not have assignments.
The portfolio attributes included in this domain are used primarily for filtering investments by portfolios.
The domain also includes financial summary data for investments, but not detailed financial planning data. For information about detailed financial planning data, see the Financial Management domain.
The investment Management domain includes data from the following objects:
  • Investment
  • Team
  • Financials
The object data is further broken down into the following high-level sets of items:
  • Investments
  • General
  • OBS
  • Portfolio
  • Program
  • Team
  • Financial
  • Investment Totals
  • Weekly Periods
  • Calendar Periods
  • Fiscal Periods
  • Settings
  • Internal IDs
 For detailed information about the sets and the items included in each set, see 
Advanced Reporting Domain Field Descriptions
 on the Advanced Reporting and Database Schema Index on CA Support Online.
 
Custom Fields
 
This domain is updated if you add custom fields to the following objects: Investment, Team, and Financials
  • If you add a custom field that is Data Warehouse-enabled to the Investment object in 
    Clarity PPM
    , the custom field appears in the Investment Management domain under the Investment set in a Custom folder.
  • If you add a custom field to the Team object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Team set in a Custom folder.
  • If you add a custom field to the Financials object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Financials set in a Custom folder.
If you have custom sub objects as children of the Investment object, the sub objects appear as their own sets under the Custom folder in this domain. The corresponding sub object fields appear under the sub object sets. If you have custom sub objects as children of the Team object, the sub objects appear as their own sets under the Custom folder in this domain. The corresponding sub object fields appear under the sub object sets. We do not currently add custom sub objects of the Financials sub object to the Investment domain.
Project Management Domain
The Project Management domain includes attributes that apply specifically to the Project investment such as programs, tasks, teams, assignments, risks, issues, and change requests. The portfolio attributes included in this domain are used primarily for filtering projects by portfolios. You can see which projects are covered under which portfolios. The financial attributes in this domain are only at the project summary level and not at the plan detail level. For detailed financial planning attributes, see the 
Financial Management 
domain.
The Project Management domain includes the following objects:
  • Investment
  • Project
  • Team
  • Financials
  • Task
  • Assignment
  • Issue
  • Risk
  • Change Request
The object data is further broken down into the following high-level sets of items:
  • Projects
  • Custom
  • General
  • OBS
  • Portfolio
  • Program
  • Team
  • Tasks
  • Financial
  • Project Totals
  • Weekly Periods
  • Calendar Periods
  • Fiscal Periods
  • Issues
  • Risks
  • Change Requests
  • Internal IDs
 
Custom Fields
 
The domain is updated if you add custom fields to the following objects in 
Clarity PPM
: Investment, Team, Project, Financials, Task, Assignments, Issues, Risks, and Change Requests.
  • If you add a custom field to the Investment object in 
    Clarity PPM
     and this field is Data Warehouse-enabled, the custom field appears in the Project Management domain under the Project set in a Custom folder.
  • If you add a custom field to the Team object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Team set in a Custom folder.
  • If you add a custom field to the Project object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Project set in a Custom folder.
  • If you add a custom field to the Financials object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Financials set in a Custom folder.
  • If you add a custom field to the Task object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Task set in a Custom folder.
  • If you add a custom field to the Assignments object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Assignments set in a Custom folder.
  • If you add a custom field to the Issues object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Issues set in a Custom folder.
  • If you add a custom field to the Risks object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Risks set in a Custom folder.
  • If you add a custom field to the Change Requests object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Change Requests set in a Custom folder.
The custom fields and sub objects for the Investment and Project objects are not differentiated and appear randomly in a Custom set under the General set.
If you have custom sub objects as children of the Investment or Project objects, the sub objects appear as their own sets under the Custom folder in this domain. The corresponding sub object fields appear under the sub object sets. We do not currently add custom sub objects of the Financials sub object to the Investment domain.
Resource Management Domain
The Resource Management domain includes investment, team, assignment, and task data from a resource perspective.
The domain includes data from the following objects:
  • Resource
  • Team
  • Assignment
The custom attributes for these objects, any custom sub objects, and the attributes for the sub objects also appear in this domain.
The object data is further broken down into the following high-level sets of items:
  • Resources
  • General
  • OBS
  • Investments
  • Financial
  • Weekly Periods
  • Calendar Periods
  • Fiscal Periods
  • Settings
  • Internal Ids
 
Custom fields 
 
  • If you add a custom field to the Resource object in 
    Clarity PPM
     and this field is Data Warehouse-enabled, the custom field appears in the Resource Management domain under the Resource set in a Custom folder.
  • If you add a custom field to the Team object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Team set in a Custom folder.
  • If you add a custom field to the Assignment object in 
    Clarity PPM
     and the field is Data Warehouse-enabled, the field appears in this domain under the Assignment set in a Custom folder.
If you have custom sub objects as children of the Investment or Resource objects, the sub objects appear as their own sets under the Custom folder in this domain. The corresponding sub object fields appear under the sub object sets.
Time Management Domain
The Time Management domain includes actual timesheets and missing time information for users who are managing timesheets or keeping time. The domain provides timesheet detail at the date worked level. The domain does not include any rolled up data. For summary timesheet data, see the 
Investment Management
 domain.
Timesheets that were never created appear under Missing Time. Missing time for existing timesheets appear under Time Sheets. The domain also includes incidents data.
 If you are not using the Timesheets component of the product for timekeeping, you can see the domain fields but there will not be any data for the fields.
The domain data is broken down into the following high-level sets of items:
  • OBS
  • Resources
  • Missing Time
  • Time Sheets
  • Internal IDs
 This domain does not include any custom objects or attributes.
Manage User Interface (UI) Themes
The Themes folder is one of the repository folders in Jaspersoft that includes the default 
Clarity PPM
 user interface themes. Each sub folder under the Themes folder corresponds to a default 
Clarity PPM
 user interface theme. As a user with ROLE_ADMINISTRATOR privileges, you can view the default themes in the folders. You can set a user interface theme if necessary, but you cannot delete any of the default themes.
When the users access Advanced Reporting, the user interface theme in Jaspersoft changes to match the user interface theme setting in 
Clarity PPM
.
 The "default" user interface theme folder always appears highlighted in Jaspersoft. For example, you set a Blue user interface theme in 
Clarity PPM
. Later, when you access Advanced Reporting, you get the look-and-feel based on the Blue user interface theme in 
Clarity PPM
. However, the "default" user interface theme folder appears highlighted in Jaspersoft. This behavior is true for all default user interface themes in 
Clarity PPM
.
 When a user accesses advanced reporting, the selected user interface theme during that user session is saved as a profile attribute for that user in Jaspersoft. If the user interface theme changes later, the user must log out and back in to reflect the change in their profile attribute.
If a custom user interface theme is set in 
Clarity PPM
, this custom theme does not appear automatically in Jaspersoft. In addition, the custom theme is not automatically available to the out-of-the box reports or the ad hoc reports.
To display a corresponding custom theme in Jaspersoft and use it to display the out-of-the box reports and the ad hoc reports, complete the following tasks:
  • Create a custom theme in Jaspersoft corresponding to the CA PPM theme.
  • Create a corresponding custom report style template for the out-of-the-box reports.
  • Create a corresponding custom ad hoc report template for the ad hoc reports.
For more information about creating style templates, see the Jaspersoft Studio tutorials on the Jaspersoft community web site.
Create a Custom User Interface Theme
Create a custom theme in Jaspersoft corresponding to a custom theme in 
Clarity PPM
 so the advanced reporting users can have a seamless experience.
 We recommend that a person with adequate knowledge of style sheets edit the.css files to reflect the correct styles for a custom theme.
 
Follow these steps:
 
  1. In 
    Clarity PPM
    , click 
    Home
    Personal
    Advanced Reporting
    .
  2. From the submenu, click 
    View
    Repository
     and inside your organization folder (for example, 
    corporate
    ), expand the 
    Themes
     folder.
  3. Right-click the ca_ppm_default folder and select 
    Download the Theme
    .
    A zip file, named ca_ppm_default.zip is downloaded to your local machine.
  4. Open the zip file, edit the following style sheets that are based on your requirements, and zip the style sheets again into a new zip file (for example, ca_ppm_modified.zip):
    • overrides_custom.css
    • overrides_ie8.css
    • pageSpecific.css
    Name the modified zip file anything that you want. Remember to include the .css files directly under the zip file.
  5. In the 
    Repository
    , right-click the 
    Themes
     folder and select 
    Upload a Theme
    .
  6. In the pop-up window, complete the following fields:
    •  
      Theme Name 
      Defines the custom theme name. Follow the naming convention: ca_ppm_
      <custom theme id in Clarity> 
      to name your custom theme
      For example, if a custom theme in 
      Clarity PPM
       has the ID 
      aruba
      , you can name the custom theme in Jaspersoft 
      ca_ppm_aruba
      . Name your theme correctly in Jaspersoft. An incorrectly named theme does not work.
    •  
      Select File (.zip) 
      Specifies the zip file containing the style sheets for the custom theme. Browse and select the modified zip file that you created.
  7. Click 
    Upload
    .
  8. Verify that a 
    ca_ppm_aruba
     folder appears under the 
    Themes
     folder. When you select this folder, all the .css files that are included in the folder appear listed.
Create a Custom Report Style Template
All reports refer to the styles included in the default report style template. Add new styles or modify the properties of the default report style template. Do not remove any of the predefined styles or change their names.
We recommend using Jaspersoft Studio to edit the .
jrtx
 file to reflect the correct styles for a custom report style template.
 To run the reports using a custom user interface theme, create a custom report style template. An error message appears if you try to run a stock report without creating a custom report style template.
 
Follow these steps:
 
  1. In Jaspersoft Studio, connect to the JasperReports server from the Repository Explorer view.
    The repository folder structure opens in the Jaspersoft Studio application.
  2. Expand the 
    Clarity PPM
     folder and navigate to the Templates folder.
  3. Right-click the Report Style Template (Default) template and select Download to File.
    A file that is named reportStyleTemplate_ca_ppm_default.jrtx is downloaded to your local machine.
  4. Rename the template file keeping the reportStyleTemplate_ca_ppm_ prefix. For example, rename the template file to reportStyleTemplate_ca_ppm_aruba.jrtx.
  5. In Jaspersoft Studio, right-click the Templates folder and select New.
    The Add Resource wizard appears.
  6. Select Template and click Next.
  7. In the pop-up window, complete the requested information. The following fields require explanation:
    •  
      Name
      Defines the report style template name. Name the report style template anything that you want.
    •  
      ID
      Defines the report style template ID. Follow the naming convention: reportStyleTemplate_ca_ppm_<custom theme id in 
      Clarity PPM
      > for your report style template ID. For example, if a custom theme in 
      Clarity PPM
       has the ID ‘aruba’, name the report style template ID in Jaspersoft as: reportStyleTemplate_ca_ppm_aruba.
  8. Click Next. Click Upload\Download Resource and select Upload from File System.
  9. Select the report style template file that you created in your local machine.
  10. Verify that the new report style template appears under the Templates folder.
  11. Right-click the new report style template and select Open In Editor.
  12. Modify any styles by clicking the styles on the Styles node, in the Outline view, changing their properties, and saving.
  13. Right-click the new report style template and select Properties. Do not select Open In Editor before uploading your new report style template. If you do, you can lose your changes.
  14. Click Upload\Download Resource and select Upload from Workspace.
    The new report style template is available in Jaspersoft.
Create a Custom Ad Hoc Report Template
All ad hoc reports refer to the styles that are included in the default ad hoc report template. Add new styles or modify the properties of the default ad hoc report template. Do not remove any of the predefined styles or change their names.
We recommend that you use Jaspersoft Studio to edit the 
.JRxml
 file to reflect the correct styles for a custom ad hoc report template.
 To run the ad hoc reports using a custom user interface theme, create a custom ad hoc template. An error message appears if you try to run an ad hoc report without creating a custom ad hoc report template.
 
Follow these steps:
 
  1. In Jaspersoft Studio, connect to the JasperReports server from the Repository Explorer view.
    The repository folder structure opens in the Jaspersoft Studio application.
  2. Expand the 
    Clarity PPM
     folder and navigate to the Templates folder.
  3. Right-click the Ad Hoc Report Template (Default) JRxml and select Download to File.
    A file named adHocReportTemplate_ca_ppm_default.jrxml is downloaded to your local machine.
  4. Rename the template file keeping the adHocReportTemplate_ca_ppm_ prefix. For example, rename the template file to adHocReportTemplate_ca_ppm_aruba.jrxml.
  5. In Jaspersoft Studio, right-click the Templates folder and select New.
    The Add Resource wizard appears.
  6. Select JRxml and click Next.
  7. In the pop-up window, complete the requested information. The following fields required explanation:
    •  
      Name 
      Defines the ad hoc report template name. You can name the ad hoc report template anything that you want.
    •  
      ID 
      Defines the ad hoc report template ID. Follow the naming convention: adHocReportTemplate_ca_ppm_<custom theme id in 
      Clarity PPM
      > to name your ad hoc report template ID. For example, if a custom theme in 
      Clarity PPM
       has the ID ‘aruba’, name the ad hoc report template ID in Jaspersoft as: adHocReportTemplate_ca_ppm_aruba.
  8. Click Next. Click Upload\Download Resource and select Upload from File System.
  9. Select the ad hoc report template file that you created in your local machine.
  10. Verify that your new ad hoc report template appears under the Templates folder.
  11. Right-click the new ad hoc report template and select Open In Editor.
  12. Modify the styles by clicking the styles on the Styles node, into the Outline view, changing their properties, and saving.
  13. Publish your changes to the server.
    The new ad hoc report template is available in Jaspersoft.
As part of the Data Warehouse installation, a Database Link (Oracle) or a Linked Server (MSSQL) to the 
Clarity PPM
 schema is created. The link lets you query the 
Clarity PPM
 schema from the Data Warehouse schema.
 If you do not use the Database Link (Oracle) or Linked Server (MSSQL) properly, system performance is impacted significantly. Do not use the links to query large volumes of data. If querying large volumes of data from the 
Clarity PPM
 schema using a link, we recommend that you query the 
Clarity PPM
 schema directly to get all the data instead of linking from the Data Warehouse. Test the performance of both before deciding on the best option.
Use the Database Link in Jaspersoft Studio reports through parameters. The following examples provide sample syntax for use with Oracle or MSSQL:
 
Oracle Example
 
[email protected]$P!{dwhDBLink}
Where TABLE_NAME is the 
Clarity PPM
 table or view name.
 
MSSQL Example
 
[$P!{dwhDBLink}].$P!{dwhDBName}.niku.TABLE_NAME
Where TABLE_NAME is the 
Clarity PPM
 table or view name.
Improve Reporting Performance with Jaspersoft Governor Settings
The following Jaspersoft Governor settings ensure better reporting performance and relieve stress on the database:
  • The governor limit on the Jaspersoft reports database connection has a timeout set to 15 minutes (900000 milliseconds). Report queries running longer than 15 minutes close and the user receives an error indicating the timeout. We recommend that users filter their report data so it runs within 15 minutes.
  • By default, the governor limit on the Jaspersoft report pages is set to 500. The report output cannot exceed this limit. This limit applies to all output formats.
Advanced Reporting User Parameters
Advanced Reporting lets you create ad hoc views of 
Clarity PPM
 data, save the views as reports, display the reports on a dashboard, and run and schedule the reports. Advanced Reporting uses the Jaspersoft® application to manage ad hoc views, reports, and dashboards. The reporting solution passes user parameters from 
Clarity PPM
 to Jaspersoft. As an administrator or report developer, use these parameters to compare user properties in Jaspersoft for existing users with the properties in 
Clarity PPM
.
 Manage user properties from 
Clarity PPM
. If you change user properties in Jaspersoft only, those user properties are overwritten with the properties set in 
Clarity PPM
 the next time the user logs in to Advanced Reporting.
When a 
Clarity PPM
 user accesses Advanced Reporting for the first time, the user is automatically created in Jaspersoft and certain parameters are passed to Jaspersoft. If you later update Advanced Reporting access rights for the user in 
Clarity PPM
, the corresponding roles for this user are automatically updated in Jaspersoft. Similarly, if you update certain user properties in 
Clarity PPM
, the corresponding Jaspersoft properties are also updated. The user status is also controlled from 
Clarity PPM
. For example, if a user is designated inactive or locked in 
Clarity PPM
, the user also becomes inactive or locked in Jaspersoft.
The following table shows how the user properties are mapped between the application. These parameters are defined at the user level (that is, you have different parameter values for each user). You can use the information in this table to compare user properties in 
Clarity PPM
 with the properties in Jaspersoft.
 
 
Clarity PPM
 
 
Jaspersoft
Field
Example
Attribute Name
Jaspersoft Location
Parameter Type
User Name
cuser
User ID
Properties
Native to Jaspersoft. Must populate from 
Clarity PPM
.
User Login Name
(appears in upper right corner of all pages)
Carol User
User Name
Properties
Native to Jaspersoft. Must be populated from 
Clarity PPM
.
User Locale
en_US
Locale
Login
Native to Jaspersoft. Must be populated from 
Clarity PPM
.
User Time Zone
(GMT-05:00) Eastern Time
Time Zone
Login
Native to Jaspersoft. Must be populated from 
Clarity PPM
.
User Email Address
Email
Properties
Native to Jaspersoft. Must be populated from 
Clarity PPM
.
User Language
en
ppmUserLanguage
Profile Attribute
Custom attribute. Must be populated from 
Clarity PPM
 to Jaspersoft.
UI Theme
default
ppmUserUITheme
Profile Attribute
Custom attribute. Must be populated from 
Clarity PPM
 to Jaspersoft.
 
More Information: