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
docs:2500_config_apps:1300_add_edit_doctemp [2024/11/07 00:16] – [Type] seandocs:2500_config_apps:1300_add_edit_doctemp [2025/06/12 03:58] (current) – Change to AwareIM aware_support3
Line 16: Line 16:
 ===== Type ===== ===== Type =====
      
-Select the type of the document template from the "Type" combo box. //**Aware IM**// comes with the following pre-defined types:+Select the type of the document template from the "Type" combo box. //**AwareIM**// comes with the following pre-defined types:
  
-  - //Report// – the document template represents a report. This type is different from other types of the document templates in the way //**Aware IM**// handles it when it creates a document from a document template – see [[docs:2000_concepts:0900_prod_feats:0200_working_with_docs_reports|Reports]].+  - //Report// – the document template represents a report. This type is different from other types of the document templates in the way //**AwareIM**// handles it when it creates a document from a document template – see [[docs:2000_concepts:0900_prod_feats:0200_working_with_docs_reports|Reports]].
   - //Text document //– the document template represents an ASCII text.   - //Text document //– the document template represents an ASCII text.
   - //MS Excel document //– the document template represents a Microsoft Excel file (.XLS).   - //MS Excel document //– the document template represents a Microsoft Excel file (.XLS).
   - //MS Word document //– the document template represents a Microsoft Word file (.doc) – this document type is not available under Linux and Mac OS X operating systems.   - //MS Word document //– the document template represents a Microsoft Word file (.doc) – this document type is not available under Linux and Mac OS X operating systems.
   - //MS Word document (XML format)//   - //MS Word document (XML format)//
-    - this document type represents an MS Word document saved in the XML format. It can be used as a replacement for MS Word documents on Linux and Mac OS X operating systems if an Aware IM server is running on the above platform and the client browsers are running on the Windows platform. In this case the XML file will be displayed in the browser properly using MS Word.+    - this document type represents an MS Word document saved in the XML format. It can be used as a replacement for MS Word documents on Linux and Mac OS X operating systems if an AwareIM server is running on the above platform and the client browsers are running on the Windows platform. In this case the XML file will be displayed in the browser properly using MS Word.
   - //HTML document //– the document template represents an HTML file.   - //HTML document //– the document template represents an HTML file.
 In addition to the pre-defined types it is possible to plug-in custom types – see [[docs:3500|Programmers Reference Guide]]. In addition to the pre-defined types it is possible to plug-in custom types – see [[docs:3500|Programmers Reference Guide]].
  
-<callout type="primary" icon="true" title="note"> If a document type is not supported on a particular platform it is possible to define an alternative document that //**Aware IM**// will automatically use instead of the original document on the unsupported platform. The alternative document must have the same name as the original document followed by the suffix //Alternative//. For example, if we defined the document OutgoingLetter of the MS-Word type (not supported on non-Windows platforms) and we want the configured application to work both on Windows and non-Windows platforms we can define the alternative document //OutgoingLetterAlternative// in the format supported on this platform (for example, plain text). We can define more than one alternative document for different platforms, for example //OutgoingLetterAlternative//Mac etc.</callout>+<callout type="primary" icon="true" title="note"> If a document type is not supported on a particular platform it is possible to define an alternative document that //**AwareIM**// will automatically use instead of the original document on the unsupported platform. The alternative document must have the same name as the original document followed by the suffix //Alternative//. For example, if we defined the document OutgoingLetter of the MS-Word type (not supported on non-Windows platforms) and we want the configured application to work both on Windows and non-Windows platforms we can define the alternative document //OutgoingLetterAlternative// in the format supported on this platform (for example, plain text). We can define more than one alternative document for different platforms, for example //OutgoingLetterAlternative//Mac etc.</callout>
  
 ===== Data shown in the document template ===== ===== Data shown in the document template =====
      
-The options of this property determine the source of data that //**Aware IM**// should use when generating documents from document templates. This data is used to replace the contents of tags used in the document template (if any) with the appropriate attribute values (see [[docs:2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0200_doc_gen|Document Generation]]). The following options can be specified:+The options of this property determine the source of data that //**AwareIM**// should use when generating documents from document templates. This data is used to replace the contents of tags used in the document template (if any) with the appropriate attribute values (see [[docs:2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0200_doc_gen|Document Generation]]). The following options can be specified:
  
 ==== Determined at run time ==== ==== Determined at run time ====
Line 43: Line 43:
 ==== Run query  ==== ==== Run query  ====
  
-This option indicates that //**Aware IM**// should always run the specified query and use the instances of the business objects that it finds as the data source for the document generation. If you select this option you must also specify whether //**Aware IM**// should run one of the queries already defined in the business space version (select the “Existing query” radio button and select the query from the combo box) or it should run the query specifically created for this purpose (select the “Custom query” radio button and press the Edit button to define the query – see [[docs:2500_config_apps:1100_add_edit_queries|Adding/Editing Queries]]).+This option indicates that //**AwareIM**// should always run the specified query and use the instances of the business objects that it finds as the data source for the document generation. If you select this option you must also specify whether //**AwareIM**// should run one of the queries already defined in the business space version (select the “Existing query” radio button and select the query from the combo box) or it should run the query specifically created for this purpose (select the “Custom query” radio button and press the Edit button to define the query – see [[docs:2500_config_apps:1100_add_edit_queries|Adding/Editing Queries]]).
  
 ===== End user access ==== ===== End user access ====
Line 52: Line 52:
 ==== Design of the document==== ==== Design of the document====
  
-If you select the "Report" document type Aware IM will display the [[docs:2500_config_apps:4200_report_designer|Report Designer]] in the working area of the editor. You can design the layout of the report using the Report Designer.+If you select the "Report" document type AwareIM will display the [[docs:2500_config_apps:4200_report_designer|Report Designer]] in the working area of the editor. You can design the layout of the report using the Report Designer.
  
 For all other types of document templates you should create the design of the document using the appropriate software (for example, create Word document using Microsoft Word software) and import this document into the editor (see below). For all other types of document templates you should create the design of the document using the appropriate software (for example, create Word document using Microsoft Word software) and import this document into the editor (see below).
  • Last modified: 2024/11/07 00:16