You are viewing the documentation for Blueriq 15. Documentation for other versions is available in our documentation directory.

What is it for?

AQ_Document_Generate is used for generating a file from a Document or Page

This service generates a file from a document (or page).

Introduction

Comparable components

This service has the following comparable components:

In contrast to the AQ_Document_Renderer this service uses a connection to store the file on, which is more flexible. The AQ_DocumentLink can only be used when this container is shown on a page.

Parameters

NameDescriptionDirectionTypeRequiredExample
DocumentThe name of the document as it is stored in studio.InputDocumentFalse1Application
PageThe name of the page as it is stored in studio.InputPageFalse1-
FileNameThe schema to generate a file name.InputExpressionTrue"Application " + TODAY + ".pdf"
FileTypeThe file type that is to be generated.InputStringTruepdf (specify without quotes)
ConnectionThe connection2 on which the generated file should be stored.InputStringTrueonfilesystem
PersistenceStore a generated document temporary or permanently.InputDomainTruePermanent
CreateInstanceCreate a new instance.InputBooleanTrueYes
RelationThe newly created instance will be linked to the given relation.InputRelationFalseApplications.RelApplication
UpdateFileIDThe file id that should be overwritten.InputAttributeFalse-
FileIDThe attribute that contains the file id.OutputAttributeTrueDocument.Id
AuthorizedRolesSelect roles that are authorized for this documentInputRole(s)FalseJunior, Senior
CaseIdThe id of the case where the document is generated for3InputExpressionFalseControl.CaseId

The Unauthorized exit is triggered when updating a file for which the user does not have one of the required roles.

1) One of them is necessary otherwise there is nothing to generate.

2) See How to setup a connection.

3) The CaseId is used to add to the Trace Engine and to create an event on the case's timeline. It was added in Blueriq 12.12.

Note on persistence

The following rules apply for the Persistence parameter:
Connection TypePersistenceClusteredNotes
MemoryTemporaryNoThe file is stored temporarily for the duration of the current request. At the end of the request the file is deleted. Memory connections and temporary persistence should be used when an uploaded/received file is immediately sent to a 3rd party system during the same request.
MemoryTemporaryYes
MemoryPermanentNoPermanently storing files in a memory connections is not allowed. The Runtime will throw an exception when trying to permanently store files in a memory connection
MemoryPermanentYes
Other / FileSystemTemporaryNoThe file is stored temporarily for the duration of the current session. At the end of the session the file is deleted.
Other / FileSystemTemporaryYesThe file is stored temporarily for the duration of the current session and a Quartz job is scheduled to delete the file.
Other / FileSystemPermanentNoThe file is permanently stored in the connection and must be explicitly deleted when no longer needed.
Other / FileSystemPermanentYes