Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
6000_case_study:0400_configuration:0900_fine_tuning:0100_documents [2026/08/13 00:55] – ↷ Page moved from docs:6000_case_study:0400_configuration:0900_fine_tuning:0100_documents to 6000_case_study:0400_configuration:0900_fine_tuning:0100_documents localdev6000_case_study:0400_configuration:0900_fine_tuning:0100_documents [2026/08/13 07:20] (current) – external edit 127.0.0.1
Line 10: Line 10:
 Before we can configure such an operation we need to configure a document. This document will need to list loans, reservations, fees and payments of a member. There are different types of documents that //**AwareIM**// supports (MS-Word, MS Excel, Text etc), however, the only document type capable of iteration is “Report” (see also the “[[2000_concepts:0900_prod_feats:0200_working_with_docs_reports|Reports]]” section). Also, report is only capable of displaying lists of one particular object and we need to display lists of several different objects. Fortunately report supports a concept of “sub-reports”, where there is a single master document containing one or more sub-report documents, each of them performing its own iteration. This means that we need to define several reports – one to display loans, another - to display reservations etc; and we also need a master report to combine all these reports in one document. Before we can configure such an operation we need to configure a document. This document will need to list loans, reservations, fees and payments of a member. There are different types of documents that //**AwareIM**// supports (MS-Word, MS Excel, Text etc), however, the only document type capable of iteration is “Report” (see also the “[[2000_concepts:0900_prod_feats:0200_working_with_docs_reports|Reports]]” section). Also, report is only capable of displaying lists of one particular object and we need to display lists of several different objects. Fortunately report supports a concept of “sub-reports”, where there is a single master document containing one or more sub-report documents, each of them performing its own iteration. This means that we need to define several reports – one to display loans, another - to display reservations etc; and we also need a master report to combine all these reports in one document.
  
-We will start by configuring documents that will be used as sub-reports within our master document. To add a new document to the configuration right click on the “Document templates, reports” node in the Elements Tree and select “New” from the pop-up menu. Enter the name of the new document “Member payments” in the list of document properties and select the type of the document “Report”. The report editor will be displayed in the working area of the screen. The Report Designer is described in detail in the “[[docs:2500_config_apps:4200_report_designer|Working with Report/Presentation Designer]]” section and we will not be going through it in detail here. You can have a look at the final document in the sample configuration of the Library application located in the “samples” directory of your AwareIM installation.+We will start by configuring documents that will be used as sub-reports within our master document. To add a new document to the configuration right click on the “Document templates, reports” node in the Elements Tree and select “New” from the pop-up menu. Enter the name of the new document “Member payments” in the list of document properties and select the type of the document “Report”. The report editor will be displayed in the working area of the screen. The Report Designer is described in detail in the “[[2500_config_apps:4200_report_designer|Working with Report/Presentation Designer]]” section and we will not be going through it in detail here. You can have a look at the final document in the sample configuration of the Library application located in the “samples” directory of your AwareIM installation.
  
 Once we are happy with the layout of the document we click on the “Save” button in the toolbar or select File/Save from the menu of the Configuration Tool. The new document appears in the list of documents in the Elements Tree. Once we are happy with the layout of the document we click on the “Save” button in the toolbar or select File/Save from the menu of the Configuration Tool. The new document appears in the list of documents in the Elements Tree.
Line 32: Line 32:
 The page that will be displayed if the user asks for the receipt will be represented by an HTML document. We add the new document to our configuration in much the same way we have defined our reports. The difference is that the type of the document is “HTML” and that we prepare the document template not in the Report Designer but in any HTML editor of our choice. We define a new document of the HTML type, enter its name “Payment receipt” and click on the “Import” button on the documents editor to import the layout of the page that we have prepared in the HTML editor. We need to put all the layout files (including the HTML file and any images and/or styles) into a separate directory and specify the name of this directory when we import the layout. You can have a look at the layout of the “Payment receipt” document in the configuration of the Library application located in the “samples” directory of your //**AwareIM**// installation.  The page that will be displayed if the user asks for the receipt will be represented by an HTML document. We add the new document to our configuration in much the same way we have defined our reports. The difference is that the type of the document is “HTML” and that we prepare the document template not in the Report Designer but in any HTML editor of our choice. We define a new document of the HTML type, enter its name “Payment receipt” and click on the “Import” button on the documents editor to import the layout of the page that we have prepared in the HTML editor. We need to put all the layout files (including the HTML file and any images and/or styles) into a separate directory and specify the name of this directory when we import the layout. You can have a look at the layout of the “Payment receipt” document in the configuration of the Library application located in the “samples” directory of your //**AwareIM**// installation. 
  
-<callout type="primary" icon="true" title="note"> The document expects the ''Payment'' object to be in the context of any operation that is using the document.</callout> +<alert type="primary" icon="fa info-circle"> 
 +**note**
  
-Now we need to modify our [[docs:6000_case_study:0400_configuration:0700_operations:1500_register_payment|RegisterPayment]] process to:+ The document expects the ''Payment'' object to be in the context of any operation that is using the document.</alert>  
 + 
 +Now we need to modify our [[6000_case_study:0400_configuration:0700_operations:1500_register_payment|RegisterPayment]] process to:
  
   - Ask the user if she wants the system to display a receipt   - Ask the user if she wants the system to display a receipt
Line 49: Line 52:
 IF Question.Reply = 'Yes' THEN DISPLAY DOCUMENT 'Payment receipt' </code> IF Question.Reply = 'Yes' THEN DISPLAY DOCUMENT 'Payment receipt' </code>
  
-<callout type="primary" icon="true" title="note"> The first action puts the ''Payment'' object that the “Payment receipt” document expects in the context.</callout> +<alert type="primary" icon="fa info-circle"> 
 +**note** 
 + 
 + The first action puts the ''Payment'' object that the “Payment receipt” document expects in the context.</alert>