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 [2022/08/21 22:48] – ↷ Links adapted because of a move operation administrator6000_case_study:0400_configuration:0900_fine_tuning:0100_documents [2026/08/13 00:55] (current) – ↷ Links adapted because of a move operation localdev
Line 8: Line 8:
 With this feature users will be able to invoke the operation that will display a PDF document listing loans, reservations, fees and payments of a particular member. Users will then be able to print out this document. Users should be able to invoke this operation while they are viewing/editing the form of a particular member. With this feature users will be able to invoke the operation that will display a PDF document listing loans, reservations, fees and payments of a particular member. Users will then be able to print out this document. Users should be able to invoke this operation while they are viewing/editing the form of a particular member.
  
-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 //**Aware IM**// supports (MS-Word, MS Excel, Text etc), however, the only document type capable of iteration is “Report” (see also the “Reports” section in the [[docs:1300_user_guide|Aware IM User Guide]]). 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 “Working with Report/Presentation Designer” section of the Aware IM User Guide 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 Aware IM 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 18: Line 18:
 Now we can define the master report called “Member details”. The layout of this report includes several sub-report elements (take a look at the final layout of the document in the sample configuration). Note that this report assumes that there is a particular instance of the ''Member'' object in the context – that’s why it refers to the attributes of the Member object inside its tags. It is also worth drawing your attention to the queries that identify the source of data for sub-report elements. If we look, for example, at the sub-report element that prints out “Member payment” report we will see that the query for the sub-report element looks like this: Now we can define the master report called “Member details”. The layout of this report includes several sub-report elements (take a look at the final layout of the document in the sample configuration). Note that this report assumes that there is a particular instance of the ''Member'' object in the context – that’s why it refers to the attributes of the Member object inside its tags. It is also worth drawing your attention to the queries that identify the source of data for sub-report elements. If we look, for example, at the sub-report element that prints out “Member payment” report we will see that the query for the sub-report element looks like this:
  
-<code aim>FIND Payment WHERE Payment IN Member.Payments ORDER BY Payment.AppliedOn</code>+<code aim>FIND Payment WHERE Payment IN Member.Payments ORDER BY Payment.AppliedOn </code>
  
 This query finds all payments of the member object that is assumed to be in the context. This query finds all payments of the member object that is assumed to be in the context.
Line 24: Line 24:
 Note also that the report has no “Details” section – this is because the report itself does not display any lists (lists are shown inside the sub-reports). Note also that the report has no “Details” section – this is because the report itself does not display any lists (lists are shown inside the sub-reports).
  
-Now that we have finally defined all our documents we can define the operation that will display the master report. The operation will be invoked from the form of the ''Member'' object, so we open the ''Member'' object for editing, select the “Main” form in the Forms tab, click on the Panel Operations property of the form and then click on the “Add” button to define a new panel operation. We define an operation called “Printable version” of the “Create Document” type and select the name of the document “Member details”. Then we save the changes to the Member object. Note that //**Aware IM**// automatically puts the ''Member'' object being viewed/edited into the context, so it is available for the “Member details” report, which expects it.+Now that we have finally defined all our documents we can define the operation that will display the master report. The operation will be invoked from the form of the ''Member'' object, so we open the ''Member'' object for editing, select the “Main” form in the Forms tab, click on the Panel Operations property of the form and then click on the “Add” button to define a new panel operation. We define an operation called “Printable version” of the “Create Document” type and select the name of the document “Member details”. Then we save the changes to the Member object. Note that //**AwareIM**// automatically puts the ''Member'' object being viewed/edited into the context, so it is available for the “Member details” report, which expects it.
  
 =====  Payment receipt ===== =====  Payment receipt =====
Line 30: Line 30:
 Another improvement that we will introduce is the improvement to the “Register Payment” operation. Once the user finishes registering the payment the system will ask the user if she wants to display the receipt. If the user answers yes, the system will display the page, which lists the details of the member, the payment amount, description etc. Another improvement that we will introduce is the improvement to the “Register Payment” operation. Once the user finishes registering the payment the system will ask the user if she wants to display the receipt. If the user answers yes, the system will display the page, which lists the details of the member, the payment amount, description etc.
  
-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 //**Aware IM**// 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. 
  
-<note>The document expects the ''Payment'' object to be in the context of any operation that is using the document.</note>+<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> 
  
 Now we need to modify our [[6000_case_study:0400_configuration:0700_operations:1500_register_payment|RegisterPayment]] process to: Now we need to modify our [[6000_case_study:0400_configuration:0700_operations:1500_register_payment|RegisterPayment]] process to:
Line 41: Line 41:
  
 <code aim>DISPLAY QUESTION 'Display receipt?' <code aim>DISPLAY QUESTION 'Display receipt?'
-IF Question.Reply = 'Yes' THEN DISPLAY DOCUMENT 'Payment receipt'</code>+IF Question.Reply = 'Yes' THEN DISPLAY DOCUMENT 'Payment receipt' </code>
  
 The entire process, therefore, looks like this: The entire process, therefore, looks like this:
Line 47: Line 47:
 <code aim>ENTER NEW Payment WITH Payment.Member = Member <code aim>ENTER NEW Payment WITH Payment.Member = Member
 DISPLAY QUESTION 'Display receipt?' DISPLAY QUESTION 'Display receipt?'
-IF Question.Reply = 'Yes' THEN DISPLAY DOCUMENT 'Payment receipt'</code>+IF Question.Reply = 'Yes' THEN DISPLAY DOCUMENT 'Payment receipt' </code>
  
-<note>The first action puts the ''Payment'' object that the “Payment receipt” document expects in the context.</note>+<callout type="primary" icon="true" title="note"> The first action puts the ''Payment'' object that the “Payment receipt” document expects in the context.</callout>