Skip to main content

How to create new Document templates


Each analytical Document (report, olap, dashboard, etc.) an end-user can access in the user page in Talend DQ Portal is based on a released Document template. This template goes through different stages before reaching the ready-to-use state in the end-user page.

  • A model "template" is usually created by the BI developer using a specific external software. From Talend DQ Portal, the BI developer attaches this model to a document template, defines the document template parameters and sets the document template state to Test in order to make it accessible by the BI tester.
  • The BI tester tests the Document template and if the test results are error free, the Document template state should be changed to Released.
  • Released Documents are accessible by end-users through the end-user page of Talend DQ Portal according to the rights assigned to end-users by the BI administrator. For further information on access rights, see Managing access rights on menus and analytical documents.
Information noteNote: Talend DQ Portal groups the administrator, developer and tester roles under one unique role: BI administrator. When you access the Portal using the administrator login information, you have the developer, tester and administrator rights at the same time.
Information noteNote: Document templates types used in Talend DQ Portal are jrxml and dashboard templates. Dashboard templates include jrxml and OpenLaszlo.

As an administrator, you can access a page which lists all the document templates registered in Talend DQ Portal if you click the icon and select Functionalities management.

The following procedure explains how to create a new Document template in the BI administrator page.

  • You have accessed Talend DQ Portal as an administrator.

  • A template "model" has already been created.

To create a Document template in the BI administrator page, do the following:
  1. On the toolbar, click the icon to open the Document browser page.

    All the Documents accessible by the tdq_user in the user page have been created by default in Talend DQ Portal.

  2. On top of the page, click Create Document > Generic Document.

  3. Define the attributes of the Document template as the following:




    the Document unique identifier.


    the Document name.


    a brief description of the Document.


    this field shows if the Document is a Report, an On-line analytical processing (OLAP), a Data Mining model, a Dashboard, etc.


    the Engine used by this Document.

    Data source

    the data source from which this Document reads data.


    this field indicates the stage at which the Document template is: Development, Test or Released. Moreover, the document template can also be Suspended if it cannot be executed anymore.

    Refresh seconds

    the number of seconds used to refresh this Document.


    indicates whether the Document is visible when it is in Released state.

    Visibility restrictions

    a logical expression that can be used to hide this Document.

  4. Click the Browse... button next to the Template field and select the file containing the model of the Document template. This model can be created with an external application suitable for the specific type of the analytical document.

  5. From the Functionalities Tree to the right, select the folder under which you want to insert this new Document template.

  6. If needed, click Show document templates to the right to display a table of the created templates.

    From this table, you can manage listed templates.

  7. Click Save.

    The new Document is listed in the Document browser page, and a new table opens below the Document Details page.

The next step to finalize the creation of the Document template is to define all the parameters necessary to the template, including the list of values.

  1. In the lower part of the Document Details page, start defining the parameters of the analytical Document as the following:




    the title of the document parameter.

    Analytical driver

    the list of values that is applied to this document.

    Url Name

    the key of the parameter: the url for the document execution will contain an attribute with key specified by the content of this field and value specified by the parameter value.


    If you define more than one parameter for the document, these parameters are sorted by this number.

  2. Define as many parameters as necessary by clicking the New tab.

  3. Click the icon to save the new document or to save the document and go back to the document list.

    The new Document is listed in the Document browser page.

For more information, refer to SpagoBI documentation.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!