| Both sides previous revision Previous revision Next revision | Previous revision |
| ref:a_f:a:display_document [2026/08/13 00:43] – ↷ Page moved from a_f:a:display_document to ref:a_f:a:display_document localdev | ref:a_f:a:display_document [2026/08/13 07:20] (current) – external edit 127.0.0.1 |
|---|
| * ''DISPLAY DOCUMENT'' (Id() | StringLiteral()) [ ''AS MESSAGE'' ][ ''USING'' StringLiteral()] [ ''MERGE INTO ONE'' ] [ ''NEW WINDOW'' ][ ''MERGE WITH'' AttributeIdentifier()][ ''DELETE AFTER'' INTEGER_LITERAL] | * ''DISPLAY DOCUMENT'' (Id() | StringLiteral()) [ ''AS MESSAGE'' ][ ''USING'' StringLiteral()] [ ''MERGE INTO ONE'' ] [ ''NEW WINDOW'' ][ ''MERGE WITH'' AttributeIdentifier()][ ''DELETE AFTER'' INTEGER_LITERAL] |
| |
| where Id() or StringLiteral() is the name of the document template to be displayed. Before the document template is displayed the action calculates and fills in attribute values used inside tags in the template (see also the “[[docs:2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0200_doc_gen|Document Generation]]” section). | where Id() or StringLiteral() is the name of the document template to be displayed. Before the document template is displayed the action calculates and fills in attribute values used inside tags in the template (see also the “[[2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0200_doc_gen|Document Generation]]” section). |
| |
| Consider the following rules: | Consider the following rules: |
| when the template is displayed. | when the template is displayed. |
| |
| <callout type="primary" icon="true" title="note"> If ''AS MESSAGE'' keyword is specified the text of the document will be displayed in a pop-up message box. This option is only suitable for text or HTML document templates.</callout> | <alert type="primary" icon="fa info-circle"> |
| | **note** |
| |
| | If ''AS MESSAGE'' keyword is specified the text of the document will be displayed in a pop-up message box. This option is only suitable for text or HTML document templates.</alert> |
| |
| <callout type="primary" icon="true" title="note"> You can specify a query in ''USING'' keyword. AwareIM will use the query as the data source for the document. AwareIM will produce as many documents as there are instances returned by the query. If ''MERGE INTO ONE'' keyword is not used AwareIM will display all instances on screen (the user will have to click on an icon next to each entry to see the document). If ''MERGE INTO ONE'' keyword is specified AwareIM will automatically merge all documents into one document and show it to the user immediately.</callout> | |
| |
| <callout type="primary" icon="true" title="note"> ''AS HTML'' keyword can be used to display reports in the HTML format rather than the default PDF format</callout> | <alert type="primary" icon="fa info-circle"> |
| | **note** |
| |
| <callout type="primary" icon="true" title="note"> ''AS XLS'' keyword can be used to display reports in the XLS format rather than the default PDF format</callout> | You can specify a query in ''USING'' keyword. AwareIM will use the query as the data source for the document. AwareIM will produce as many documents as there are instances returned by the query. If ''MERGE INTO ONE'' keyword is not used AwareIM will display all instances on screen (the user will have to click on an icon next to each entry to see the document). If ''MERGE INTO ONE'' keyword is specified AwareIM will automatically merge all documents into one document and show it to the user immediately.</alert> |
| |
| <callout type="primary" icon="true" title="note"> ''NEW WINDOW'' keyword can be used to display documents in a separate browser window</callout> | <alert type="primary" icon="fa info-circle"> |
| | **note** |
| |
| <callout type="primary" icon="true" title="note"> ''MERGE WITH'' keyword can be used to merge the displayed document with any other document stored in some object in an attribute of the ''DOCUMENT'' type (at the moment this is only supported for PDF documents), for example | ''AS HTML'' keyword can be used to display reports in the HTML format rather than the default PDF format</alert> |
| |
| | <alert type="primary" icon="fa info-circle"> |
| | **note** |
| |
| <code aim>DISPLAY DOCUMENT AccountOpeningLetter MERGE WITH SystemSettings.TermsAndConditionsDoc </code></callout> | ''AS XLS'' keyword can be used to display reports in the XLS format rather than the default PDF format</alert> |
| |
| <callout type="primary" icon="true" title="note"> ''DELETE AFTER'' keyword can be used to specify a number of seconds after which the generated document will be deleted on the server for security reasons. If not specified, the document will be deleted when the user logs out. For example to delete the document after 15 seconds use the following: | <alert type="primary" icon="fa info-circle"> |
| | **note** |
| |
| <code aim>DISPLAY DOCUMENT AccountOpeningLetter DELETE AFTER 15 </code></callout> | ''NEW WINDOW'' keyword can be used to display documents in a separate browser window</alert> |
| | |
| | <alert type="primary" icon="fa info-circle"> |
| | **note** |
| | |
| | ''MERGE WITH'' keyword can be used to merge the displayed document with any other document stored in some object in an attribute of the ''DOCUMENT'' type (at the moment this is only supported for PDF documents), for example |
| | |
| | |
| | <code aim>DISPLAY DOCUMENT AccountOpeningLetter MERGE WITH SystemSettings.TermsAndConditionsDoc </code></alert> |
| | |
| | <alert type="primary" icon="fa info-circle"> |
| | **note** |
| | |
| | ''DELETE AFTER'' keyword can be used to specify a number of seconds after which the generated document will be deleted on the server for security reasons. If not specified, the document will be deleted when the user logs out. For example to delete the document after 15 seconds use the following: |
| | |
| | <code aim>DISPLAY DOCUMENT AccountOpeningLetter DELETE AFTER 15 </code></alert> |
| |
| |