Page History
| Info | ||||
|---|---|---|---|---|
| ||||
AQ_Document_Generate is used for generating a file from a Document element or Page | ||||
| Tip | ||||
| A Note on persistence has been added to clarifiy how the persistence parameter will work in 11. The behavior changes compared to 10. |
This service generates a file from a document (or page).
...
To generate a file the document or page which is modeled in studio has Encore has to be specified. The service will return the file id and put it in the attribute specified in 'FileId'. Also the type and the file name must be specified. Currently only PDF documents can be generated. To be able to store the generated file somewhere, the connection has to be stated. With the parameter 'Persistence' a modeler can specify whether the file should be generated and stored permanently or temporary. For the latter case the file will be removed from the connection when the session/request is expired. By setting the 'CreateInstance' and 'Relation' it is possible to state whether an instance should be created automatically and whether it has to be added to a relation. The last parameter (UpdateFileId) could be useful in case of overwriting an existing file, for example if you only want to have only one kind of file.
...
This service has the following comparable components:
...
| Name | Description | Direction | Type | Required | Example |
|---|---|---|---|---|---|
| Document | The name of the document as it is stored in studioEncore. | Input | Document | FalseNo1 | Application |
| Page | The name of the page as it is stored in studioEncore. | Input | Page | FalseNo1 | - |
| FileName | The schema to generate a file name. | Input | Expression | TrueYes | "Application " + TODAY + ".pdf" |
| FileType | The file type that is to be generated. | Input | String | TrueYes | pdf (specify without quotes) |
| Connection | The connection2 on which the generated file should be stored. | Input | String | TrueYes | onfilesystem |
| Persistence | Store a generated document temporary or permanently. | Input | Domain | TrueYes | Permanent |
| CreateInstance | Create a new instance. | Input | Boolean | TrueYes | Yes |
| Relation | The newly created instance will be linked to the given relation. | Input | Relation | FalseNo | Applications.RelApplication |
| UpdateFileID | The file id that should be overwritten. | Input | Attribute | FalseNo | - |
| FileID | The attribute that contains the file id. | Output | Attribute | TrueYes | Document.Id |
| AuthorizedRoles | Select roles that are authorized for this document | Input | Role(s) | FalseNo | Junior, Senior |
| CaseId | The id of the case where the document is generated for3 When using the Process-Engine the value of this field is set as process_id in the metadata When using the Case-Engine, this field must be omitted. It will automatically be filled with the caseId during task execution. | Input | Expression | FalseNo | Control.CaseId |
The Unauthorized exit is triggered when updating a file for which the user does not have one of the required roles.
...
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
Include Page [Editor] Note on Persistence[Editor] Note on Persistence
Overview
Content Tools