{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"9521fc53-562a-443a-ba4c-5b2d4ac7c8c2"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"99eff79a-27c6-4a6c-a8d3-feb34200225c"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Create folder","type":"text"}]},{"type":"paragraph","content":[{"text":"Folder name will be used as report script name","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Create config.json file","type":"text"}]},{"type":"paragraph","content":[{"text":"This file consists of the following parts:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"strong"}]},{"text":" - name of the script, should be the same as folder name","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"description","type":"text","marks":[{"type":"strong"}]},{"text":" - default description for report","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"rootClass","type":"text","marks":[{"type":"strong"}]},{"text":" - name of the class of objects used as subtree roots","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"classes","type":"text","marks":[{"type":"strong"}]},{"text":" - list of the classes used in report script","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"relations","type":"text","marks":[{"type":"strong"}]},{"text":" - definitions of relations between classes","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"'classes' part structure","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"strong"}]},{"text":" - name of the class","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fields","type":"text","marks":[{"type":"strong"}]},{"text":" - array of fields used in report","type":"text"}]}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":" \"classes\":[\n {\n \"name\":\"report_class_name_1\",\n \"fields\":[\n \"field1name\",\n \"Custom 1\"\n ]\n },\n {\n \"name\":\"report_class_name_2\",\n \"fields\":[]\n }\n ]","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"'relations' part structure","type":"text"}]},{"type":"paragraph","content":[{"text":"For each class (if required) we have to define list of its children classes.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":" \"relations\":{\n \"report_class_name_1\":[\n \"report_class_name_2\"\n ]\n }","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Prepare python script (report_script.py)","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"in this file create class ReportGenerator(ReportGeneratorInterface) - please remember to add following import:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"from reporting_service.ReportGeneratorInterface import ReportGeneratorInterface","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ReportGeneratorInterface has following abstract methods which should be implemented (details for these methods below):","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"def prepare_data_frames(self, data_frames) - main method with all data preparations\ndef get_pdf_template(self) - creates template object for pdf generation\ndef get_pdf_css_file(self) - get path of css file for pdf generation\ndef get_template_vars(self, data_frames) - prepare template variables based on data frames returned by prepare_data_frames method\ndef get_excel_template(self) - get path of file with excel template\ndef get_float_format(self) - get float format in python style, e.g. '%.3f'\ndef get_excel_data_row_styles(self) - get row styles for excel report (not required)\ndef get_excel_columns_width(self) - get columns width for excel report (not required)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"get_pdf_template","type":"text"}]},{"type":"paragraph","content":[{"text":"imports","type":"text"}]},{"type":"codeBlock","content":[{"text":"from pathlib import Path\nfrom jinja2 import FileSystemLoader, Environment","type":"text"}]},{"type":"paragraph","content":[{"text":"example","type":"text"}]},{"type":"codeBlock","content":[{"text":"def get_pdf_template(self):\n p = Path(__file__).parent\n template_loader = FileSystemLoader(searchpath = p)\n # noinspection JinjaAutoinspect\n template_env = Environment(loader = template_loader)\n return template_env.get_template(\"template.html\")","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"get_float_format","type":"text"}]},{"type":"codeBlock","content":[{"text":"def get_float_format(self):\n return '%.3f'","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"get_pdf_css_file","type":"text"}]},{"type":"codeBlock","content":[{"text":"def get_pdf_css_file(self):\n return Path(__file__).parent / \"style.css\"","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"get_excel_template","type":"text"}]},{"type":"codeBlock","content":[{"text":"def get_excel_template(self):\n return Path(__file__).parent / \"template.xlsx\"","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"prepare_data_frames(self, data_frames)","type":"text"}]},{"type":"paragraph","content":[{"text":"Object data_frames contains data from FMA collected as a dictionary. There is one, required data frame \"hierarchy\" which contains pairs parentId - childId. Other data frames are available under the class names given in the config.json file.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"get_excel_data_row_styles","type":"text"}]},{"type":"paragraph","content":[{"text":"In this method one can set styles for each data set.","type":"text"}]},{"type":"paragraph","content":[{"text":"Style sections:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"columns ","type":"text","marks":[{"type":"strong"}]},{"text":"- set style for selected columns (by name)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"rows","type":"text","marks":[{"type":"strong"}]},{"text":" - set style of each row","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"evenRow ","type":"text","marks":[{"type":"strong"}]},{"text":"- set style of each even row","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"lastRow","type":"text","marks":[{"type":"strong"}]},{"text":" - set style of selected columns in the last row in data set","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Available style properties:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"bgColor","type":"text","marks":[{"type":"strong"}]},{"text":" - cell background color ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"bold","type":"text","marks":[{"type":"strong"}]},{"text":" - if True, font in cell will be bold","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"italic","type":"text","marks":[{"type":"strong"}]},{"text":" - if True, font in cell will be italic","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"def get_excel_data_row_styles(self):\n return {\n 'floors': {\n 'columns': {\n },\n 'rows': {\n 'bgColor': 'EBEFF2'\n },\n 'evenRow': {\n 'bgColor': 'D4DCE6'\n },\n 'lastRow': {\n 'B': {\n 'bgColor': 'FFFF00',\n 'bold': True\n },\n 'C': {\n 'bgColor': 'FFFF00',\n 'bold': True\n }\n }\n },\n 'floors_tenants': {\n 'columns': {\n 'A': {}\n },\n 'rows': {\n 'bgColor': 'EBEFF2'\n },\n 'evenRow': {\n 'bgColor': 'D4DCE6'\n },\n 'lastRow': {\n 'E': {\n 'bgColor': 'FFFF00',\n 'italic': True\n }\n }\n },\n 'rooms': {\n 'columns': {\n 'A': {}\n },\n 'rows': {\n 'bgColor': 'EBEFF2'\n },\n 'evenRow': {\n 'bgColor': 'D4DCE6'\n },\n 'lastRow': {\n 'E': {\n 'bgColor': 'FFFF00',\n 'italic': True\n }\n }\n }\n }","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"get_excel_columns_width","type":"text"}]},{"type":"paragraph","content":[{"text":"In this method one can set width of selected columns. ","type":"text"}]},{"type":"codeBlock","content":[{"text":"def get_excel_columns_width(self):\n return {\n 'A': 30,\n 'B': 30,\n 'C': 30,\n 'D': 30,\n 'E': 30,\n 'F': 30,\n 'G': 30,\n 'H': 30\n }","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Create Excel template (xlsx file)","type":"text"}]},{"type":"paragraph","content":[{"text":"We can build an excel template by defining columns and their style, and using macros we can insert different values or the content of data sets in selected places.","type":"text"}]},{"type":"paragraph","content":[{"text":"Macro is specified by double curly braces. ( {{ macro_name }} )","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":593,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1280,"id":"ef635d40-9ab9-4edc-bfa4-9ae0c1a359dc","collection":"contentId-2589718","type":"file","height":278}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Create PDF template","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"HTML template","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n\n \n \n\n\n

Areor för {{ vars.byggnad }} {{ vars.date }}

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Ort	{{ vars.ort }}
Campus	{{ vars.campus }}
Byggnad	{{ vars.byggnad }}
Status	{{ vars.status }}

Areasammanställning

\n {{ vars.floors }}\n
\n {{ vars.rooms }}\n\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"CSS style file","type":"text"}]},{"type":"codeBlock","content":[{"text":"@page {\n size: A4 landscape;\n}\n\nbody {\n font-size: 75%;\n color: #222;\n background: #fff;\n font-family: \"Helvetica Neue\", Arial, Helvetica, sans-serif;\n}\n\n\n/* Headings\n-------------------------------------------------------------- */\n\nh2,h3 { font-weight: normal; color: #111; }\n\nh2 { font-size: 2em; margin-bottom: 0.75em; }\nh3 { font-size: 1.5em; line-height: 1; margin-bottom: 1em; }\n\ntable { margin-bottom: 1.4em; width:100%;}\nth { font-weight: bold; }\nthead th { background: #c3d9ff; }\nth,td,caption { padding: 4px 10px 4px 5px; }\ntd.firstcol { font-weight: bold; }\n\n/*\n You can zebra-stripe your tables in outdated browsers by adding\n the class \"even\" to every other table row.\n */\ntbody tr {text-align: center }\ntbody tr:nth-child(even) td,\ntbody tr.even td {\n background: #e5ecf9;\n}\n\n.properties { width: 40%; }\n.properties, .properties td {\n border: 1px solid black; background: #ffffff\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported