Reports General Attributes and Parameters

Report General Attributes

Each report has the following general attributes:

NameThe name of the report; this is only used within Mail & Deploy to identify the report.
DescriptionThe description of the report; the description is displayed in Mail & Deploy Hub (see Hub) and can be requested by consumers of Mail & Deploy API (see API)
ConditionAn optional expression (see Expressions) that evaluates to either True or False. If the condition is not fulfilled, the report document will not be created.
Preview File Type
The file type in which preview report documents of the report shall be created.
Default CultureThis is the default culture to apply when creating the report document (see Culture Awareness). This option is not available for all report types.
Allow Custom Culture
This setting determines if a custom culture may be supplied when requesting a report document based on the report through the Mail & Deploy Hub (see Hub) or Mail & Deploy API (see API).

True. In this case, users can provide a custom culture when requesting the report.

False. In this case, users can not provide a custom culture when requesting the report; the default culture will be used.


This option is not available for all report types.

You can manage report general attributes using the following buttons:

Click this button to insert a value in the condition field.
Click this button to expand the condition field.
Click this button to see a preview of the selected report document (see Preview)
Click this button to manage Hub authorizations (see Hub Authorizations)
Click this button to replace the datasource (see Replacing Datasource)


Report Parameters 

By using report parameters, data can be passed on to the report by whatever initiates the execution of the task (e.g. a user who requests the creation of a report document based on the report through Mail & Deploy Hub or in a task by using a Create Report Document Action), which will then be used to influence the creation of the report document (e.g. by filtering a datasource). 

You can set report parameters using the following buttons next to the parameters field.

Click this button to create a new parameter. A new dialogue will show up that allows you to enter the new name and the caption of the parameter and set Default Values. 
Click this button to edit an existing parameter. 
Click this button to delete the currently existing parameters.

Each report parameter has the following attributes:

NameThe name of the report parameter; this is only used within Mail & Deploy to identify the report parameter.
CaptionThis is the caption of the report parameter which will be used in Mail & Deploy Hub (see Hub) when users are required to enter the value of the report parameter.
ValuesThe language in which user interfaces shall be displayed to the user.A list of expression (see Expressions) which will be used as the default values of the report parameter.
E-Mail AddressThe e-mail address of the user. This attribute is only required if e-mails shall be sent to the user.

You can access the values of report parameters in expressions (see Expressions) within the context of the report (see Report Parameter). 

Hub Value Range Provider 

These settings allow you to define, how values can be passed to the report parameter when requesting the report through the hub (see Hub). 


The following types are available:

None. 

This means that there is no value range provided to the user; therefore, the user can enter free text to be passed as the value of the parameter.

Custom Value Range. 

This means that users can select one value from a pre-defined list of values (see Expressions) to be passed as the value of the parameter. When you select this type, an expression list will appear that allows you to add expressions whose values will be presented to the user when requesting a report document.

User Custom Property Value Range. 
This type allows you to present the user a drop-down of values to choose from; the available values will be taken from a custom property of that user ( see Custom Properties). With this option, you can achieve user-specific value ranges.


User Windows Account Name. 
This type will set the value of the parameter to the windows account name (in domain\accountname format) of the user that performs the report document request through the hub. This could, for example, be used to then filter a QlikView Document datasource access table ( Filter Datasource Field Action) to the value of the parameter so that the requested report document only contains data which the requesting user is allowed to see.


Preparation Actions 

This is a list of actions (see Actions) which will be executed before the report document will be created. These actions can, for instance, be used to filter datasource fields or activate bookmarks in order to prepare the datasource to be in exactly the state required for the report document to contain the necessary data.


Tags 

This is a list of key-value pairs which will be evaluated during the creation of a report document after the preparation actions have been executed.The expression (see Expressions) that makes up the value of the tag will, therefore, be evaluated when the datasources involved are in a defined state. When creating a report document from the report during the execution of a task (see Tasks) the values of these tags can be accessed and used in an expression (see Expressions). 

Tags can be managed using the following buttons:

Click this button to create a new tag.
Click this button to edit the currently selected tag.
Click this button the create a copy of the currently selected tag.
Click this button to delete the currently selected tag.

Each tag has the following attributes:

NameThe name of the tag; this is only used within Mail & Deploy to identify the tag.
ValueAn expression (see Expressions) that evaluates to the value of the tag.
Example: A report that creates a report document which contains monthly statistics for a given sales region. Such a report would have a report parameter that can be set to the sales region to create the report document for and a preparation action that filters the underlying datasource to the sales region you want to create the report document for. If such a report document would be created in the context of a task (see Tasks) and shall then be saved to the file system (see Save Report Document to File System Action), you would probably want to use the name of the sales region as a part of your file name or directory path; however, you cannot simply use the value of the datasource field that contains the name of the sales region in the expression used when saving the report document, because at that stage the underlying datasource might no longer be filtered to the sales region that the report document has been created for; therefore, you should add a new tag that contains the name of the sales region, because tags are evaluated at a stage where the underlying datasource is still filtered to whatever the preparation actions of the report dictate. When saving the report to the file system, you can access the tag in the expression (see Expressions) that defines the file path to save the report document to.



M
Mail is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.