Creating reports

You can create different types of reports in TrueSight Capacity Optimization. For details, see the following sections:

 

To create a basic report based on existing analyses and models (With a video)

The following video (1:44) illustrates how to create a by-exception basic report with a time-forecasting model to display resources that are likely to saturate.

icon-play.png https://youtu.be/9Y3aAXs4uh0

  1. Select Workspace > All Domains > domainName > Works folder.
    Details of the Works folder for the selected domain are displayed.
  2. In the Works table, select Add > Add report.
    The BMC TrueSight Capacity Optimization Report Wizard opens.
  3. On the WELCOME screen, click Next.
  4. On the CHOOSE TYPE screen, select Basic Report - based on existing Analyses and Models, and click Next.
    Report wizard.png
  5. On the Add ANALYSES OR MODELS screen, select analyses or models from the Source navigation tree, and add them to the Selection table using the >> button or by clicking+dragging them. In the Selection table, hover over the analysis or model name, and click X to remove it.
    Add_analyses.png
  6. Click Next.

  7. On the SCHEDULING screen, select the following scheduling properties for this report and click Next.

    basic_report_scheduling.png

    Default scheduling options are pre-selected for you. If you want to keep these defaults, you can skip making selections here and proceed to Step 8

    Scheduling options

  8. On the NAME screen, enter a Name and Description (mandatory) for this report and click Next.
    basic_report_name.png

  9. On the SUMMARY screen, click Finish to create the report.

↑ Back to top

To create a basic report based on a basic report template

  1. Select Workspace > All Domains > domainName > Works folder.
    Details of the Works folder for the selected domain are displayed.
  2. In the Works table, select Add > Add report.
    The BMC TrueSight Capacity Optimization Report Wizard opens.
  3. On the WELCOME screen, click Next.
  4. On the CHOOSE TYPE screen, select Based on a Template and click Next.

  5. On the TEMPLATE TYPE screen, select the following options and click Next:

  6. ENTITY FILTER screen: Based on the Template group and basic report template you select in step 5, the wizard displays this screen to enable you to select entities to add to the basic report. Under Select the entities, select one of the following options and then click Next: 
    1. All systems/business drivers in container domain: Include all entities present in the container domain to the Basic Report.
    2. All systems/business drivers in container domain and its subdomains: Include all entities in the container domain and its sub-domain to the Basic Report.
    3. Use a custom entity filter: Include a specific entity from the list to the basic report.
    4. Use a composition of entity filters: Select specific entities from the list to include in the basic report and then click Add to include multiple entities from the list. You can select either the AND or OR operator for entity inclusion.
  7. TIME FILTER screen: Based on the Template group and basic report template you have selected in step 5, the wizard displays this screen to enable you to select a time filter to apply to the report. Under Select the time filter to apply, select any one time filter and then click Next. 
    If the basic report template that you have selected in step 5 was originally saved with, or already includes a time filter, you can skip making a selection for this step and proceed to set Scheduling options in Step 8
    • Use existing time filter (global or local): Select a time filter from the list.
    • Specify custom time filter: If you want to specify a custom time filter, select this option, and click Next.

    • Define custom time filter: This screen appears only if you select Specify custom time filter. Select any one of the following options, and click Next.

      • In The time period from and to options, select a definitive time period using the calendar and manually entering time values in 24-hour HH:MM:SS format.
      • Time range: Specify a time range by entering The last <n>days/years/months/weeks/hours from execution time. Select Including current day to add the current day to this time range.

    • Advanced custom time filter: Click Advanced in the Define custom time filter screen to enter advanced and highly complex custom time filter properties. The following table describes each property in detail.

      Advanced custom time filter properties

  8. SCHEDULING: Select the following scheduling properties for the report and click Next.

    Default scheduling options are preselected for you. If you want to keep these defaults, you can skip this screen and proceed to Step 9.

    Scheduling options

  9. Name:  Enter a Name. By default, the name field is populated based on the selected template. You can specify a different name. You must type a Description for this report and click Next.

  10. Summary: Click Finish at the summary screen to create the Report.

↑ Back to top

To create a composite basic report by using existing basic reports (With a video)

You can create a composite basic report from more than one existing basic reports that have been generated for same or different domain.

The following video (2:00) illustrates the process of creating a composite report based on an existing basic report.

icon-play.png https://youtu.be/rpERHtNpXkQ

  1. Select Workspace > All Domains > domainName > Works folder.
    Details of the Works folder for the selected domain are displayed.
  2. In the Works table, select Add > Add report.
    The BMC TrueSight Capacity Optimization Report Wizard opens.
  3. On the WELCOME screen, click Next.
  4. On the CHOOSE TYPE screen, select Composite Basic Report - based on existing Basic Reports and click Next.
  5. On the ADD BASIC REPORT screen, select the basic report from the Source navigation tree, and add them to the Selection table using the >> button or by clicking+dragging them. In the Selection table, hover over the Basic report name, and click X to remove it.
    Aggregated report.png
  6. Click Next.

  7. On the SCHEDULING screen, select the following scheduling properties for the report and click Next.

    Default scheduling options are preselected for you. If you want to keep these defaults, you can skip this screen and proceed to Step 8

    Scheduling options

  8. On the Name screen, enter a Name. By default, the name field is populated based on the selected template. You can specify a different name. You must type a  Description for this report and click Next.

  9. On the Summary screen, click Finish at the summary screen to create the Report.

↑ Back to top

To create a composite report by combining reports of all leaf domains

Create a composite report by consolidating the reports of all the leaf domains of a domain. These reports for leaf domains are created at runtime after you configure the report parameters and run the report. Use this composite report when you have large number of leaf domains. The report saves your time to manually create a report for each leaf domain and combine these reports into a single composite report. After the composite report is created, the leaf domain reports are not retained. They exist only during runtime and cannot be accessed.

Important

The APIs listed on this page are available only when you apply Patch 2 (20.02.02) of TrueSight Capacity Optimization 20.02.

Important

  • This composite report is available only when you apply Patch 2 (20.02.02) of TrueSight Capacity Optimization 20.02.
  • The composite report includes the reports of maximum five nested sub-domains. 
  • The reports are created for a maximum of 30 leaf domains.

To configure the report parameters and run the report, perform the following steps:

  1. Select Workspace > All Domains > domainName > Add works > Add report.
    or
    Select Workspace > All Domains > domainName > Works > Add > Add report.
  2. In the report wizard, select Composite Report - based on a Report Template.
  3. Select a template group and a template to be used for creating the report.
  4. Select all entities of leaf domains to include in the report or a custom entity filter. For information about configuring the entity filter, see Entity filter parameters.
  5. Select a time filter for the report data collection. For details, see Time filter parameters.
  6. Configure the report generation schedule, export formats, and email settings. 
  7. Specify a name and an optional description for the report.
  8. Click Finish.
    The composite report is created and listed under the domain folder.
  9. Click Run report now.
    The report is generated in the specified export formats.

To customize a composite report to display the domain names and their hierarchy

Each subdomain report that is included in a composite report contains charts of entities in the subdomain. You can customize the composite report to display the domain names and their hierarchy below the title of each entity chart. Additionally, you can customize the report to display the root domain name after the analysis title. This information helps you to understand the context of each entity chart for ease of analysis.

To customize the composite report, perform these steps:

  1. Navigate to the analysis report that is selected as a template while creating the composite report.
  2. Edit the analysis that is included in the report.
  3. On the Chart options tab, add one of the following macros in the Subtitles field:
    1. %SUBREP_BREADCRUMB% to display the complete domain hierarchy
    2. %SUBREP_BREADCRUMB_n% to display the partial domain hierarchy
      where n indicates the subdomain level up to which you want to view the hierarchy. For example, specify %SUBREP_BREADCRUMB_2% to display the hierarchy up to the last two levels from the entity subdomain level.

      composite_report_domain_names.png
  4. To display the root domain name after the analysis title, append the following macro to the analysis title in the Name field.
    %SUBREP_DOMAIN_n%
    where n indicates the root domain level. 
    cr_analysis_title_root_domain_name.png

    Note: This macro is valid only for the composite report. Therefore, it is not included in the list of macros that you can select for the analysis.
  5. Save the changes and run the analysis.
  6. Navigate to the report that includes the modified analysis.
  7. Perform these steps to save the report again as a template:
    1. Click Save as template.
    2. Under Save as, select Overwrite template.
    3. Click Save.
  8. Navigate to the composite report and run it again.
  9. Download the report and verify the changes.

To create an advanced report based on an advanced report template (With a video)

The following video (3:54) illustrates the process of creating a report based on an advanced report template.

icon-play.pnghttps://youtu.be/qWkz3trUlQQ

  1. Select Workspace > All Domains > domainName > Works folder.
    Details of the Works folder for the selected domain are displayed.
  2. In the Works table, select Add > Add report.
    The BMC TrueSight Capacity Optimization Report Wizard opens.
  3. On the WELCOME screen, click Next.
  4. On the CHOOSE TYPE screen, select Advanced Report - based on an Advanced Report Template and click Next.

  5. On the TEMPLATE TYPE screen, select the following options and click Next:

  6. ENTITY FILTER screen: Based on the Template group and basic report template you select in step 5, the wizard displays this screen to enable you to select entities to add to the basic report. Under Select the entities, select one of the following options and then click Next:
    1. All systems/business drivers in container domain: Include all entities present in the container domain to the Basic Report.
    2. All systems/business drivers in container domain and its subdomains: Include all entities in the container domain and its sub-domain to the Basic Report.
    3. Use a custom entity filter: Include a specific entity from the list to the basic report.
    4. Use a composition of entity filters: Select specific entities from the list to include in the basic report and then click Add to include multiple entities from the list. You can select either the AND or OR operator for entity inclusion.
  7. TIME FILTER screen: Based on the Template group and basic report template you have selected in step 5, the wizard displays this screen to enable you to select a time filter to apply to the report. Under Select the time filter to apply, select any one time filter and then click Next.
    If the basic report template that you have selected in step 5 was originally saved with, or already includes a time filter, you can skip making a selection for this step and proceed to set Scheduling options in Step 8
    • Use existing time filter (global or local): Select a time filter from the list.
    • Specify custom time filter: If you want to specify a custom time filter, select this option, and click Next.

    • Define custom time filter: This screen appears only if you select Specify custom time filter. Select any one of the following options, and click Next.

      • In The time period from and to options, select a definitive time period using the calendar and manually entering time values in 24-hour HH:MM:SS format.
      • Time range: Specify a time range by entering The last <n>days/years/months/weeks/hours from execution time. Select Including current day to add the current day to this time range.

    • Advanced custom time filter: Click Advanced in the Define custom time filter screen to enter advanced and highly complex custom time filter properties. The following table describes each property in detail.

      Advanced custom time filter properties

  8. SCHEDULING: Select the following scheduling properties for the report and click Next.

    Default scheduling options are preselected for you. If you want to keep these defaults, you can skip this screen and proceed to Step 9

    Scheduling options

  9. Name:  Enter a Name. By default, the name field is populated based on the selected template. You can specify a different name. You must type a  Description for this report and click Next.

  10. Summary: Click Finish at the summary screen to create the Report.

To create a report using the Report Cart (With a video)

The following video (1:48) illustrates the process of creating a basic report by using the report cart.

icon-play.pnghttps://youtu.be/k4eBGX6twOA

To add existing analyses and models in a domain to the Report Cart and create a report based on them, perform the following task:

  1. Select Workspace > All Domains > Domain > Works folder and select an Analysis or Model (Analysis) you want to include in the report.
  2. In the Analysis details page displayed on the right, click Add to Report Cart.
    An information box under the Add to report cart button displays the The analysis has been successfully added to the current report message.
    Repeat this operation for all analyses that you want to include in the new report, and then proceed to Step 3.
  3. Click the Report Cart link in the upper right corner of the console, next to Home, to open the Report Cart page.
    The Report Cart page has two tables, Analyses in the report and Models in the report, that list all the analyses that you added to the Report Cart to add to the new report.
    You can delete individual entries by clicking delete icon.png.
  4. Under the tables, enter the following properties for the new report that the Report Cart will create:
    1. Name: A name for the new report.
    2. Description: A brief description of the report.
    3. Save in domains: Select the domain(s) in which the new report should be saved. The available domain choices are domains from which you selected the Analysis.
  5. Click Save.
    The new report is saved  and is added to the hierarchy under the Works folder of the domain you selected.
    To customize the newly created report, see Editing a report.

↑ Back to top

Related topics

Viewing-and-managing-reports

Creating-reports-and-report-templates

Adding-an-advanced-report-template

Viewing-report-groups-and-report-results

Viewing-the-details-of-Report-templates

Creating-an-advanced-report-template-using-BIRT-in-Integration-Studio

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*