Uploading a Custom Report Template


You can upload a BIRT template to host it on Reporting Tool or reuse the template created by the online editor in the other environment or OU. The uploaded template takes effect for the current OU only. For more information about custom templates, see Report Template.

Prerequisites


  • You need to be assigned the required asset permission and operation permission, and a menu group containing the Templates menu. If not assigned, contact the application administrator.

  • If you want to upload a BIRT template, you need to prepare a BIRT template (a rptdesign file or a ZIP file containing a rptdesign file). For how to create a BIRT template, see the BIRT documentation Create BIRT report.

  • If you want to upload a template created by the online editor, you need to prepare a template created by the online editor (a JSON file or a ZIP file containing a JSON file). For how to create a template by the online editor, see Creating a Custom Report Template.

Procedure

Uploading a BIRT template


  1. Select Templates from the left navigation pane.

  2. Hover over New Template and select Upload. Enter the following information and click Save.

    • Template Name: Enter up to 50 characters as the template name.

    • Source: Select BIRT.

    • Source File: Upload a rptdesign file or a ZIP file containing a rptdesign file created in BIRT.

    • Parameter: After a source file is uploaded and verified, the parameters in the file are listed in the parameter list. You can set the listed parameters as template parameters based on actual needs. The default value of template parameters are customizable. For more information about template parameters, see Template/Non-template Parameters.

    • Language: Select one or more languages from the drop-down list. Chinese, English, Japanese, and Spanish are supported.

    • Description: Enter up to 200 characters as the template description.

    • Snapshot: Upload a picture of up to 2 M as the template snapshot.

Uploading a Template Created by the Online Editor


  1. Select Templates from the left navigation pane.

  2. Hover over New Template and select Upload. Enter the following information.

    • Template Name: Enter up to 50 characters as the template name.

    • Source: Select Template Editor.

    • Source File: Upload a JSON file or a ZIP file containing a JSON file created in BIRT.

    • Parameter: After a source file is uploaded and verified, the parameters in the file are listed in the parameter list. You can set the listed parameters as template parameters based on actual needs. The default value of template parameters are customizable. For more information about template parameters, see Template/Non-template Parameters.

    • Language: Select one or more languages from the drop-down list. Chinese, English, Japanese, and Spanish are supported.

    • Description: Enter up to 200 characters as the template description.

    • Snapshot: Upload a picture of up to 2 M as the template snapshot.

  3. Click Next to redirect to the Edit Template page. After editing the template according to your needs, click Publish to officially publish the current template to the unified template list.

Results


Once uploaded, the template appears in the template list. You can view its details and perform the following actions on it: