Add howto for export and import commands

furti · Jan 24, 2019 · 1021a5e · 1021a5e
1 parent 7e4d55c
commit 1021a5e
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/Documentation/Howto/General/create_report_collection.md b/Documentation/Howto/General/create_report_collection.md
@@ -0,0 +1,31 @@
+# How to create a report collection
+
+If you work on multiple projects, it is very likely that you want to use the same reports over and over again. This is pretty easy to achieve.
+
+Lets assume you have a document and you already created some reports there. Now select a report and click the `Export Report` button.
+
+![Export Report](../../../Resources/Icons/ExportConfig.svg)
+
+A file dialog will be shown. Now select a folder and enter a name for the Report.
+This command creates a JSON file. This is a simple text file. So you can open it with your favourite text editor if you want and check out its content. But it might look something like this:
+
+```json
+{
+    "statements": [
+        {
+            "header": "Test",
+            "htmlStatement": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0//EN\" \"http://www.w3.org/TR/REC-html40/strict.dtd\">\n<html><head><meta name=\"qrichtext\" content=\"1\" /><style type=\"text/css\">\np, li { white-space: pre-wrap; }\n</style></head><body style=\" font-family:'MS Shell Dlg 2'; font-size:8.25pt; font-weight:400; font-style:normal;\">\n<p style=\" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;\">Select count(*) from document</p></body></html>",
+            "plainTextStatement": "Select count(*) from document",
+            "printResultInBold": true,
+            "skipColumnNames": true,
+            "skipRowsAfter": true
+        }
+    ]
+}
+```
+
+Now when you start a new project, you can click the `Import Report` button.
+
+![Import Report](../../../Resources/Icons/ImportConfig.svg)
+
+Again a file dialog will be shown. Select the previously saved file and a Report will be created in your document with the same contents as the one we exported earlier.
diff --git a/README.md b/README.md
@@ -112,6 +112,8 @@ more...
 
 [... add a Result Row for a Statement](./Documentation/Howto/General/add_result_row_in_report.md)
 
+[... create a report collection](./Documentation/Howto/General/create_report_collection.md)
+
 ### Architecture
 [... get a list of arch objects by role](./Documentation/Howto/Arch/get_number_of_objects_by_role.md)