Page tree
Skip to end of metadata
Go to start of metadata

The option to add a new advanced report template is available under Administration > Template Management > Report templates.

You can add an advanced report template in the following modes:

To add an advanced report template in Basic mode

To add a new advanced report template in basic (default) mode, perform the following task:

  1. Select Administration > Template Management > Report templates and click Add a new advanced report template.

  2. Under the General tab in the Add report template page, provide values for the following template properties:

    PropertyDescription
    General
    NameA name for the new report template.
    DescriptionA brief description of the template.
    GroupSelect a group for the template.
    Result nameClick to select the parameters you want to include in the report result name. You can select one or all of the following parameters:
    • %REPNAME%: Name of the report.
    • %REPTEMPLNAME%: Name of the report template.
    • %REFDATE%: Reference date for the report.
    • %REFDATEFROM%: Initial point of the reference interval.
    • %PARAM.<param_name>%: Custom report parameter. <param_name> is the name of the custom parameter.
    File nameClick to select the parameters you want to include in the report file name. The parameters are the same as above.
    Parameters provided by defaultThe parameters provided by default for this type of report. Generally these are: refdate, user, password, jdbcurl, jdbcdrv, and datahubwsurl.
    Report by domain

    Select any of the following options:

    • Disabled: Do not create domain-specific reports.
    • Enabled, using the 'appid' parameter: Uses the 'appid' parameter in addition to default parameters, to create domain-specific reports.
    Available formatsSelect all formats supported by the template. The formats you select here will be available when you create a report based on this template. The available formats are: HTML, PDF, XLS, DOC, PPT, CSV.
    View dependencySelect the applicable views to base the template on.
    Template file

    Click Upload to upload a template file, for example, the .rptdesign format BIRT reports created using the Integration Studio Report Designer tool. For more information, refer to Developing custom Report Templates.

    Notes

    You can upload only the file names that begin with a letter (upper/lowercase) or number, and have maximum 254 characters except '/', '\' or  ';'.


  3. Click Save.

To add an advanced report template in Advanced mode

Adding a template in advanced mode allows you to add Date, Creation and Execution parameters and repeat sets to your template.

To add a new advanced report template in advanced mode, perform the following task:

  1. Select Administration > Template Management > Report templates and click Add a new advanced report template.
  2. Towards the bottom-right of the General tab in the Add report template page, click Advanced.

    The following additional tabs are added to the page:

  3. Enter values for the following template properties.

    PropertyDescription
    General tab
    NameA name of the new report template.
    DescriptionA brief description.
    GroupSelect a group for the template.
    Result nameClick to select the parameters you want to include in the report result name. You can select one or all of the following parameters:
    • %REPNAME%: Name of the report.
    • %REPTEMPLNAME%: Name of the report template.
    • %REFDATE%: Reference date for the report.
    • %REFDATEFROM%: Initial point of the reference interval.
    • %PARAM.<param_name>%: Custom report parameter. <param_name> is the name of the custom parameter.
    File nameClick to select the parameters you want to include in the report file name. The paramters are the same as above.
    Parameters provided by defaultThe parameters provided by default for this report type. Generally, these are: refdate, user, password, jdbcurl, jdbcdrv, and datahubwsurl.
    Report by domain

    Select any of the following options:

    • Disabled: Do not create domain-specific reports.
    • Enabled, using the 'appid' parameter: Uses the 'appid' parameter in addition to default parameters, to create domain-specific reports.
    VisibilitySelect the visibility setting for the report template:
    • Reporter - The report templates will be visible to users with roles that have the 'Workspace section - Reports - Edit' activity.
    • Admin - The report templates will be visible to users with roles that have 'Enable a user to instantiate global report' activity.
    Available formatsSelect all formats supported by the template. The formats you select here will be available when you create a report based on this template. The available formats are: HTML, PDF, XLS, DOC, PPT, CSV.
    View dependencySelect the applicable views to base the template on.
    Template file

    Click Upload to upload a template file, for example, the .rptdesign format BIRT reports created using the Integration Studio Report Designer tool. For more information, refer to Developing custom Report Templates.

    Note

    • Ensure that you do not upload file names beginning with '.' or '/' as they can result in path traversal
    • BMC recommends you to use antivirus to check for the upload of malicious files
    Date parameters tab

    Reference date (refdate parameter) section

    UsedReport uses reference date parameter (refdate parameter): If selected, the report must use the date period you set in Definition as a reference date to extract data.
    After you select this property, the following sub-properties are introduced:
    • Definition: Select a preset reference date definition period for the report to extract data from, or enter a Custom definition period in days.
      Preset Definition values are: Yesterday, Two days ago, Seven days ago, Last week, 30 days ago, and Last month.
    • Customization: Select this option if you want the ability to customize this report at run time.

    refdate is crucial if you ever need to recover reports. If a report template ignores the reference date and uses the current date when it is generated, it cannot be run for a period in the past, and report recovery is not possible. Report recovery is managed by the Report Executor task. For more information, refer to the Configuring the Report Executor task.

    Reference FROM date (refdate_from parameter) section

    UsedReport uses reference FROM date parameter (refdate_from parameter): If selected, the report must use the date period you set in Definition as a reference from date to extract data.
    After you select this property, the following sub-properties are introduced:
    • Definition: Select a preset reference from date definition period for the report to extract data from, or enter a Custom definition period in days.
      Preset Definition values are: One day before refdate, Two days before refdate, Seven days before refdate, A complete week before refdate, 30 days before refdate, A complete month before refdate.
    • Customization: Select this option if you want the ability to customize this report at run time.
    Creation parameters tab
    Number of parametersSelect the number of creation parameters that you want to configure. The tab is refreshed with the following field-sets for each (>1) parameter:
    • Parameter name: Name of the parameter. For example: rep_param_1.
    • Parameter label: Label for the parameter. For example: CLM Report - Derived.
    • Parameter type: Data type of the parameter. Select any one of the following:
      • Text: Plain text (string) value.
      • Date: A value that has a date data type.
      • Integer positive value: A positive integer value.
      • Combo-box fixed values: Static drop-down values. Introduces the following box:
        • Parameter option values: Specify semi-colon separated values for the drop–down and click Apply. Example: List_item1; List_item2; List_item3
      • Combo box - query extracted values: Query extracted dynamic drop-down values. Introduces the following box for you to type the conditional query:
        • Parameter fill query: Type the query using given operators to extract values to be used for the drop-down selection in the text area.
    • Default text: Allows you to specify a default text value for the Text parameter type.
    • Parameter is repeated: Select any one option:
      • No: Do not repeat.
      • Repeat, based on repeat set: Repeat based on the specified Creation repeat set.
    Repeat parametersSpecify whether or not any creation parameters should have a repeat set:
    • Yes: A Creation repeat set tab is added in which you can configure the repeat set.
    • No: Default selection. Do not include a repeat set for creation parameters.
    Parameter is repeatedSelect any one option:
    • No: Do not repeat based on the specified Creation repeat set.
    • Repeat, based on repeat set: Repeat based on the specified Creation repeat set. (See below)
    Creation repeat set (sub-tab)
    TypeSelect from the following types of repeat set values for Creation parameters you defined above:
    • Disable: Disable the current creation repeat set.
    • Fixed values: A predefined list of semi-colon separated values. Introduces the Values box.
      • Values: Enter semi-colon separated values and click Apply. Introduces the Labels section.
        • Labels: Modify default labels for these values.
    • Query extracted values: A dynamic list of values extracted from a query that you specify in the Query box.
    Execution parameters tab
    Number of parametersSelect the number of execution parameters that you want to configure. The tab is refreshed with the following field-sets for each (>1) parameter:
    • Parameter name: Name of the parameter. For example: repo_param_1.
    • Parameter label: Label for the parameter. For example: CLM Execution - Derived.
    • Parameter type: Data type of the execution parameter. Select any one of the following:
      • Text: Plain text (string) value.
      • Date: A value that has a date data type.
      • Integer positive value: A positive integer value.
      • Combo-box fixed values: Static drop-down values. Introduces the following box:
        • Parameter option values: Specify semi-colon separated values for the drop–down and click Apply. Example: List_item1; List_item2; List_item3
      • Combo box - query extracted values: Query extracted dynamic drop-down values. Introduces the following box for you to type the conditional execution query:
        • Parameter fill query: Type the execution query using given operators to extract values to be used for the drop-down selection in the text area.
    • Default text: Allows you to specify a default text value for the Text parameter type.
    • Parameter is repeated: Select any one option:
      • No: Do not repeat.
      • Repeat, based on repeat set: Repeat based on the specified Execution repeat set.
    Repeat parameters?Specify whether or not any execution parameters should have a execution repeat set:
    • Yes: An Execution repeat set tab is added in which you can configure the execution repeat set.
    • No: Default selection. Do not include a repeat set for execution parameters.
    Parameter is repeatedSelect any one option:
    • No: Do not repeat based on the specified Execution repeat set.
    • Repeat, based on repeat set: Repeat based on the specified Execution repeat set. (See below)
    Execution repeat set (sub-tab)
    TypeSelect from the following types of repeat set values for Execution parameters you defined above:
    • Disable: Disable the current execution repeat set.
    • Fixed values: A predefined list of semi-colon separated values. Introduces the Values box.
      • Values: Enter semi-colon separated values and click Apply. Introduces the Labels section.
        • Labels: Modify default labels for these values.
    • Query extracted values: A dynamic list of values extracted from a query that you specify in the Query box.
  4. Click Save.