You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.
The AQ_DocumentLink container shows a link where a Blueriq document can be downloaded. The Document will be generated once the user clicks the download link.
Requirements
For documents to be generated (and this container to work) the Document Renderer Service is needed, you have to set this up and the Document Renderer Client component has to be configured.
Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| asset-name | The asset which is used to display the link text (name is without quotes). | Asset name | Yes |
| asset-type | The format for the asset-name. This is standard Text (without quotes). | String | Yes |
| document-name | The name of the document that will be generated, name should be between double quotes, e.g. "Document". Either this parameter or the page-name parameter must be given. | Expression | No |
| page-name | The name of the page that will be generated, name should be between double quotes, e.g. "Document". Either this parameter or the document-name parameter must be given. | String | No |
| document-type | The document type of the output file, e.g. "pdf". This must be enclosed in double quotes. | String | Yes |
| optional-parameters | Optional text to append to the link. This must be enclosed in double quotes. | String | No |
Overview
Content Tools
4 Comments
Ciarán Lier
I just learned that the document-name is also the name of the actual Document in Blueriq which will be generated for download. Is this information correct?
If not where and how do we specify which document we want to generate and can we specify a custom flow for generation (to load more information to the profile for instance).
Unknown User (m.schadd)
That information is correct. We have received a feature request for this before, so please create a new one and state your urgency so that we can re-prioritize. As an alternative, you can generate a document using Service call type: AQ_Document_Generate service to upload a file to a (memory) connection, and give it a name there. The end user can then download it using the Container type: AQ_File_Download container.
Bas de Keulenaar
What are the possible output files within Blueriq, only "pdf" is mentioned in the documentation?
Unknown User (a.jansen)
Hi Bas de Keulenaar, also communicated about this over email. PDF indeed, as in most use cases our customers don't want to hand out editable documents to their customers. Think for example of an insurance policy document, or the summary of a subsidy application.