Report designers can upload their templates from Document Studio
into Publishing Document Builder
and turn them into reports that their teams can use to generate document-style reports.
About this task
You can create large templates to generate your document-style reports with multiple
sections. Or, you can also use a template for each section so that you can quickly assemble small
reusable components into one large report. For example, a table of contents template can be used in
many different reports.Important: You must be assigned the Report Designer role to
create reports.
You can upload the following resource types:
- JavaScript files
- Style sheets
- Templates
Procedure
-
Open the Resources tab of Publishing Document Builder.
-
Upload resources:
-
Click Upload resource.
-
Enter a name and description for the resource and select the type of file to upload.
- If you want to store the resource in a folder, click
Select folder and then choose or create a folder.
-
Browse to find the file.
-
Add tags to the resource so that you can easily find the resource later.
-
Select the Make public checkbox if you want other designers to use this
resource when designing reports.
-
Click Upload.
The resource is added to the list. Templates appear in the Templates
tab. The style sheets appear in the Style sheets tab. The reports appear in
the Reports tab and JavaScript
files appear in the Scripts tab.
-
Click Create a report.
Tip: You can also select the check boxes for multiple templates and then click the
Create report from template icon
. The templates appear in the Templates that are used in this report
list.
-
In the Available templates list, drag templates to the
Templates used in this report column.
You can search for templates by template name, description, or tag. The order of the templates
matches the order that the templates are used in the report.
-
Select the output formats, and enter a name and description for the report.
-
Add any tags for the report.
- If you want to store the report in a folder, click Select folder
and then choose or create a folder.
-
Determine the availability of the report. You have two options:
- Select the Make public checkbox so that other users can generate
document-style reports from this report.
- Select the Make available for document generation checkbox. The report
appears on the Reports tab for designers to generate document-style reports
from. Do not select this checkbox to keep the report in draft state, so only report designers or
administrators can view it.
-
Click Save or Save and configure. If you click
Save and configure, you can specify properties to configure data sources,
variables, output, and metadata.
- In the Variables tab, select the data type from the list:
- Simple text: Simple text is the default data type. Enter any value in
the Value field.
-
Multi-value text: Enter comma-separated values in the
Value field.
- Boolean: Enter true or
false in the Value field.
- Date: Enter date in
DD-MM-YYYY
format in the
Value field.
- User: If Publishing Document Builder
is registered with Jazz® Team Server, enter JTS users as
comma-separated values in the Value field.
Users can include or exclude the email notification of the template variables in the
following ways:
- If the user with pub_admin role sets the property Include
variables in email notification to true in Mail section of Runtime variables tab, template variable details are included in
the email notification that is sent from Publishing Document Builder.
- The user with pub_report_designer role can exclude selected variable details
from the email notification. To exclude, select the variable in the Variables
tab, and then deselect the Include in email notification checkbox.
- Click Save.
-
If you change or modify a template that you uploaded in Document Studio,
you must update the template in Publishing Document Builder:
-
In the Edit column, click Update template icon .
-
In the Update template window, edit the fields if needed or browse to the
updated template.
-
Click Update.
-
To delete a template, in the Actions column, click Delete icon .
You can only delete templates or style sheets that are not used in any reports.
-
To quickly preview a report before you generate a document-style reports:
-
Click the Reports tab on the
Resources tab.
-
In the Actions column for the report that you want, select the
Preview document-style report icon .
-
Connect to a data source if prompted and click Preview.
-
When the job finishes, click Download document-style
reports icon in the Status column.
You can save the document-style reports or the compressed file that contains the
document-style report and log file.
-
To see all the reports that use a particular resource, in the Actions column, click the
Show reports icon .
A window opens that lists the reports that use this template or style sheet, and whether the
report is on a schedule.
-
If your document-style report has a connection that uses an SSL certificate as the
authentication method, click the Manage certificate icon to edit, or delete
certificates.
-
To download a template, click the Show link icon in the Actions column.
You can then download the template from the URL that is provided.
Results
You can see the report on the Reports tab.
What to do next
Generate a document-style report from the report.