Differences

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

--- docs:2500_config_apps:1300_add_edit_doctemp [2022/08/25 00:00] – removed - external edit (Unknown date) 127.0.0.1
+++ docs:2500_config_apps:1300_add_edit_doctemp [2025/06/12 03:58] (current) – Change to AwareIM aware_support3
@@ Line 1: / Line 1: @@
+[<10>]
+====== Adding/Editing Document Templates ======
+The following section describes how to work with the editor of document templates when adding a new document template or editing an existing one. Document templates are described in the [[docs:2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0200_doc_gen|Document Generation]] section.
+The editor of document templates can be started as described in the [[docs:2500_config_apps:0300_work_config_elements|Working with Configuration Elements]] section. The following properties should be specified:
+===== Name =====
+Specify the name of the document template uniquely identifying it within the business space version. The name of the document template must be unique among the names of other document templates defined in the business space version. Any identifier is acceptable as a name. Space symbols in the name are allowed.
+===== Description =====
+Specify any text that describes what the document template is for, how it is used etc. Providing a description is not mandatory but is highly recommended. Any description if defined is included into the generated documentation for the business space version – see [[docs:2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0200_doc_gen|Generating Documentation]].
+===== Type =====
+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 //**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.
+  - //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 (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 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.
+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 //**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 =====
+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 ====
+This option indicates that the data should be determined from the context of the document template usage. For example, the user can select certain instance(s) of a business object and run the report using these instances as the data source. Or some attribute of a business object of the Document type initialises itself with the document template – in this case the document will use the data of this business object’s instance – see [[docs:2500_config_apps:0700_add_edit_attributes:0700_doc_attrib|Setting Properties of Document Attributes]].
+==== All instances of the specified business object  ====
+This option indicates that regardless of how the document template is used, it will use all instances of the specified business object as its data source. If you select this option you must select the name of the business object as well.
+==== Run query  ====
+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 ====
+The options of this property determine whether the document or report will be accessible for viewing/editing by end users – see [[docs:2000_concepts:0900_prod_feats:0200_working_with_docs_reports:0300_reports:#user_defined_documents_and_reports|User Defined Documents and Reports]].
+==== Design of the document====
+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).
+====Import====
+Importing a layout of a document template can be useful if you want to re-use the same layout in a different document template. Layouts of reports can also be re-used in presentations of business objects and business object groups – see [[docs:2500_config_apps:0500_add_edit_objects:0300_define_presentations|Defining Presentations]]. To import the existing layout of the document template click on the {{docs:icons:icon_import.png?nolink&20}} icon at the top of the editor. Depending on the type of the document template either the File Selection Dialog or the Directory Selection dialog will be displayed. Specify the name of the import file or the directory that contains the single layout file of the appropriate type and any resources (such as images).
+==== Export====
+Exporting a layout of a document template can be useful if you want to re-use the same layout in a different document template. Layouts of reports can also be re-used in presentations of business objects and business object groups – see [[docs:2500_config_apps:4200_report_designer|Defining Presentations]]. To export the existing layout of the document template click on the {{docs:icons:icon_export.png?nolink&20}} icon at the top of the editor. Depending on the type of the document template either the File Selection Dialog or the Directory Selection dialog will be displayed. Specify the name of the file or the directory to export the layout file and any resources of the document template (such as images for HTML templates or reports) into.