Differences

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

Link to this comparison view

Both sides previous revision Previous revision
3400_how_to:0500_reports_and_documents [2026/08/13 07:33] – Imported by DokuWiki Advanced Plugin aware_support33400_how_to:0500_reports_and_documents [2026/08/13 07:43] (current) – Imported by DokuWiki Advanced Plugin aware_support3
Line 5: Line 5:
 <accordion autoclose> <accordion autoclose>
 <anchor id="design_a_report"> <anchor id="design_a_report">
-<accordion-item title="Design a Report" type="primary">+<accordion-item title="Design a Report">
 To design a report you have to configure a document template of the Report type and define its layout using the [[2500_config_apps:4200_report_designer|Report Designer]]. See the “[[2500_config_apps:1300_add_edit_doctemp|Adding/Editing Document Templates]]” section for details. To design a report you have to configure a document template of the Report type and define its layout using the [[2500_config_apps:4200_report_designer|Report Designer]]. See the “[[2500_config_apps:1300_add_edit_doctemp|Adding/Editing Document Templates]]” section for details.
 </accordion-item> </accordion-item>
  
 <anchor id="produce_and_print_out_a_report"> <anchor id="produce_and_print_out_a_report">
-<accordion-item title="Produce and Print Out a Report" type="primary">+<accordion-item title="Produce and Print Out a Report">
 For the user to be able to produce and print out a report the report layout and the corresponding operation have to be configured. To design a report you have to configure a document template of the Report type (report template) and define its layout using the Report Designer (see the “[[2500_config_apps:1300_add_edit_doctemp|Adding/Editing Document Templates]]” section). To get //**AwareIM**// to produce the report so that the user can see it and print it out you can do either of the following: For the user to be able to produce and print out a report the report layout and the corresponding operation have to be configured. To design a report you have to configure a document template of the Report type (report template) and define its layout using the Report Designer (see the “[[2500_config_apps:1300_add_edit_doctemp|Adding/Editing Document Templates]]” section). To get //**AwareIM**// to produce the report so that the user can see it and print it out you can do either of the following:
  
Line 20: Line 20:
  
 <anchor id="refer_to_database_fields_in_a_report"> <anchor id="refer_to_database_fields_in_a_report">
-<accordion-item title="Refer to Database Fields in a Report" type="primary">+<accordion-item title="Refer to Database Fields in a Report">
 When you design a report you can refer to attributes of business objects using tag elements – see the “[[2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0200_doc_gen|Document Generation]]” section for details. When you design a report you can refer to attributes of business objects using tag elements – see the “[[2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0200_doc_gen|Document Generation]]” section for details.
 </accordion-item> </accordion-item>
  
 <anchor id="perform_calculations_in_a_report"> <anchor id="perform_calculations_in_a_report">
-<accordion-item title="Perform Calculations in a Report" type="primary">+<accordion-item title="Perform Calculations in a Report">
 When you design a report you can define calculations to be performed inside tag elements. You can use any expressions allowed by the Rule Language. The common expression is, for example, to calculate the sum total of the attribute: When you design a report you can define calculations to be performed inside tag elements. You can use any expressions allowed by the Rule Language. The common expression is, for example, to calculate the sum total of the attribute:
  
Line 33: Line 33:
  
 <anchor id="group_records_in_a_report"> <anchor id="group_records_in_a_report">
-<accordion-item title="Group Records in a Report" type="primary">+<accordion-item title="Group Records in a Report">
 Sometimes you may want to group the data shown in a report by some criteria and print out a special header and/or footer for each group. To do this you need to configure the following: Sometimes you may want to group the data shown in a report by some criteria and print out a special header and/or footer for each group. To do this you need to configure the following:
  
Line 42: Line 42:
  
 <anchor id="include_related_records_in_a_report"> <anchor id="include_related_records_in_a_report">
-<accordion-item title="Include Related Records in a Report" type="primary">+<accordion-item title="Include Related Records in a Report">
 You can show values of attributes of business objects related to a particular business object on a report. For example, if a PurchaseOrder object is related to an OrderLineItem object via a multiple relationship you can show which order line items are related to a particular purchase order on the report. You can show values of attributes of business objects related to a particular business object on a report. For example, if a PurchaseOrder object is related to an OrderLineItem object via a multiple relationship you can show which order line items are related to a particular purchase order on the report.
  
Line 53: Line 53:
  
 <anchor id="conditionally_include_an_element_in_a_report"> <anchor id="conditionally_include_an_element_in_a_report">
-<accordion-item title="Conditionally Include an Element in a Report" type="primary">+<accordion-item title="Conditionally Include an Element in a Report">
 Sometimes it may be necessary to include a particular element (such as text or image) in the report only under certain conditions (for example, you may show sensitive data to one category of users but not others). In this case you can define a conditional element in the layout of your report and specify the conditions of printing. See the “[[2500_config_apps:4200_report_designer|Reports]]” and “[[2500_config_apps:4200_report_designer:0300_edit_elements:0900_conditional_elements|Editing Conditional Element]]” sections for details. Sometimes it may be necessary to include a particular element (such as text or image) in the report only under certain conditions (for example, you may show sensitive data to one category of users but not others). In this case you can define a conditional element in the layout of your report and specify the conditions of printing. See the “[[2500_config_apps:4200_report_designer|Reports]]” and “[[2500_config_apps:4200_report_designer:0300_edit_elements:0900_conditional_elements|Editing Conditional Element]]” sections for details.
 </accordion-item> </accordion-item>
  
 <anchor id="use_conditions_to_print_elements_in_different_colors"> <anchor id="use_conditions_to_print_elements_in_different_colors">
-<accordion-item title="Use Conditions to Print Elements in Different Colors" type="primary">+<accordion-item title="Use Conditions to Print Elements in Different Colors">
 Sometimes the same element may be shown with different properties (for example, in different colors) depending on some conditions – for example you can show the account balance in red if it is less than, say, 100 dollars and in green otherwise. This can be achieved by defining a conditional element in the layout of the report. The element will print the text in different colors depending on the conditions - see the “[[2500_config_apps:4200_report_designer:0300_edit_elements|Reports]]” and “[[2500_config_apps:4200_report_designer:0300_edit_elements:0900_conditional_elements|Editing Conditional Element]]” sections for more details.</accordion-item> Sometimes the same element may be shown with different properties (for example, in different colors) depending on some conditions – for example you can show the account balance in red if it is less than, say, 100 dollars and in green otherwise. This can be achieved by defining a conditional element in the layout of the report. The element will print the text in different colors depending on the conditions - see the “[[2500_config_apps:4200_report_designer:0300_edit_elements|Reports]]” and “[[2500_config_apps:4200_report_designer:0300_edit_elements:0900_conditional_elements|Editing Conditional Element]]” sections for more details.</accordion-item>
  
 <anchor id="enumerate_elements_in_a_report"> <anchor id="enumerate_elements_in_a_report">
-<accordion-item title="Enumerate Elements in a Report" type="primary">+<accordion-item title="Enumerate Elements in a Report">
 Quite often you need to print out either the total number of data records in the report (or page or group) or the sequence number of a data record in the report (or page or group). This can be achieved by using the ''[[ref:a_f:f:af:element_count|ELEMENT_COUNT]]'' or ''[[ref:a_f:f:af:element_counter|ELEMENT_COUNTER]]'' functions.  Quite often you need to print out either the total number of data records in the report (or page or group) or the sequence number of a data record in the report (or page or group). This can be achieved by using the ''[[ref:a_f:f:af:element_count|ELEMENT_COUNT]]'' or ''[[ref:a_f:f:af:element_counter|ELEMENT_COUNTER]]'' functions. 
  
Line 69: Line 69:
  
 <anchor id="re_use_a_report"> <anchor id="re_use_a_report">
-<accordion-item title="Re-use a Report" type="primary">+<accordion-item title="Re-use a Report">
 If you want to use the layout of a report in a different report you can export the layout of the first report and then import it into the second report. See the “[[2500_config_apps:1300_add_edit_doctemp|Adding/Editing Document Templates]]” section for details on how to export and import the report layout. If you want to use the layout of a report in a different report you can export the layout of the first report and then import it into the second report. See the “[[2500_config_apps:1300_add_edit_doctemp|Adding/Editing Document Templates]]” section for details on how to export and import the report layout.
  
Line 75: Line 75:
  
 <anchor id="store_documents_and_files"> <anchor id="store_documents_and_files">
-<accordion-item title="Store Documents and Files" type="primary">+<accordion-item title="Store Documents and Files">
 In //**AwareIM**// documents and files are stored in attributes of the Document type. See the “[[2500_config_apps:0700_add_edit_attributes:0700_doc_attrib|Attributes of Document Type]]” and “[[2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0100_doc_man|Document Management]]” sections for more details. In //**AwareIM**// documents and files are stored in attributes of the Document type. See the “[[2500_config_apps:0700_add_edit_attributes:0700_doc_attrib|Attributes of Document Type]]” and “[[2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0100_doc_man|Document Management]]” sections for more details.
 </accordion-item> </accordion-item>
  
 <anchor id="do_a_document_merge"> <anchor id="do_a_document_merge">
-<accordion-item title="Do a 'Document Merge'" type="primary">+<accordion-item title="Do a 'Document Merge'">
 //**AwareIM**// can perform “document merge” of Microsoft Word documents, Microsoft Excel documents, plain text documents and HTML documents. If you want to provide the “document merge” functionality in your system you have to configure document templates of any of the above mentioned types (see the “[[2500_config_apps:1300_add_edit_doctemp|Adding/Editing Document Templates]]” section). Alternatively you can use document templates defined by the end user (Developer Edition only) //**AwareIM**// can perform “document merge” of Microsoft Word documents, Microsoft Excel documents, plain text documents and HTML documents. If you want to provide the “document merge” functionality in your system you have to configure document templates of any of the above mentioned types (see the “[[2500_config_apps:1300_add_edit_doctemp|Adding/Editing Document Templates]]” section). Alternatively you can use document templates defined by the end user (Developer Edition only)
  
Line 100: Line 100:
  
 <anchor id="let_end_users_defined_their_own_reports_document_templates_and_queries"> <anchor id="let_end_users_defined_their_own_reports_document_templates_and_queries">
-<accordion-item title="Let End Users Defined Their Own Reports, Document Templates and Queries" type="primary">+<accordion-item title="Let End Users Defined Their Own Reports, Document Templates and Queries">
 This is described in the “[[docs:2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0300_reports:#user_defined_documents_and_reports|User Defined Documents and Reports]]” and “[[2000_concepts:0600_data_retrieval:0300_query_build_op_mode|Building Query]]” sections. This is described in the “[[docs:2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0300_reports:#user_defined_documents_and_reports|User Defined Documents and Reports]]” and “[[2000_concepts:0600_data_retrieval:0300_query_build_op_mode|Building Query]]” sections.
 </accordion-item> </accordion-item>
  
 <anchor id="implement_multiple_files_upload_for_documents"> <anchor id="implement_multiple_files_upload_for_documents">
-<accordion-item title="Implement Multiple Files Upload for Documents" type="primary">+<accordion-item title="Implement Multiple Files Upload for Documents">
 //**AwareIM**// does not support “multiple allowed” for attributes of the Document type, however, there is a way for you to implement “Multiple file upload” functionality when the user selects several documents at once and uploads them all to the system. In order to implement this functionality you need the following: //**AwareIM**// does not support “multiple allowed” for attributes of the Document type, however, there is a way for you to implement “Multiple file upload” functionality when the user selects several documents at once and uploads them all to the system. In order to implement this functionality you need the following:
  
Line 119: Line 119:
  
 <anchor id="let_users_edit_documents"> <anchor id="let_users_edit_documents">
-<accordion-item title="Let Users Edit Documents" type="primary">+<accordion-item title="Let Users Edit Documents">
 There are two ways you can let users edit documents that they store in the attribute of the Document type. There are two ways you can let users edit documents that they store in the attribute of the Document type.
  
Line 161: Line 161:
  
 <anchor id="work_with_embedded_spreadsheets"> <anchor id="work_with_embedded_spreadsheets">
-<accordion-item title="Work with Embedded Spreadsheets" type="primary">+<accordion-item title="Work with Embedded Spreadsheets">
 Embedded spreadsheets can be used to display data as an Excel table or to get Excel to perform calculations that can then be written into attributes of business objects and stored in the database. This can be especially useful if you already have existing Excel spreadsheets that you want to re-use to perform some calculations.  Embedded spreadsheets can be used to display data as an Excel table or to get Excel to perform calculations that can then be written into attributes of business objects and stored in the database. This can be especially useful if you already have existing Excel spreadsheets that you want to re-use to perform some calculations.