{"componentChunkName":"component---smooth-doc-smooth-doc-src-templates-doc-js","path":"/docs/report-templates/auxiliary-information/","result":{"data":{"mdx":{"fields":{"pageType":"doc","title":"Auxiliary Information","editLink":""},"body":"var _excluded = [\"components\"];\nfunction _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }\nfunction _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var s = Object.getOwnPropertySymbols(e); for (r = 0; r < s.length; r++) o = s[r], t.includes(o) || {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }\nfunction _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (e.includes(n)) continue; t[n] = r[n]; } return t; }\n/* @jsxRuntime classic */\n/* @jsx mdx */\n\nvar _frontmatter = {\n \"title\": \"Auxiliary Information\",\n \"description\": \"auxiliary information\",\n \"section\": \"Report Templates\",\n \"order\": 36\n};\nvar layoutProps = {\n _frontmatter: _frontmatter\n};\nvar MDXLayout = \"wrapper\";\nreturn function MDXContent(_ref) {\n var components = _ref.components,\n props = _objectWithoutProperties(_ref, _excluded);\n return mdx(MDXLayout, _extends({}, layoutProps, props, {\n components: components,\n mdxType: \"MDXLayout\"\n }), mdx(\"h1\", {\n \"id\": \"auxiliary-information\"\n }, mdx(\"a\", {\n parentName: \"h1\",\n \"href\": \"#auxiliary-information\",\n \"aria-label\": \"auxiliary information permalink\",\n \"className\": \"anchor\"\n }, mdx(\"svg\", {\n parentName: \"a\",\n \"aria-hidden\": \"true\",\n \"focusable\": \"false\",\n \"height\": \"16\",\n \"version\": \"1.1\",\n \"viewBox\": \"0 0 16 16\",\n \"width\": \"16\"\n }, mdx(\"path\", {\n parentName: \"svg\",\n \"fillRule\": \"evenodd\",\n \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n }))), \"Auxiliary Information\"), mdx(\"br\", null), mdx(\"h2\", {\n \"id\": \"styles\"\n }, mdx(\"a\", {\n parentName: \"h2\",\n \"href\": \"#styles\",\n \"aria-label\": \"styles permalink\",\n \"className\": \"anchor\"\n }, mdx(\"svg\", {\n parentName: \"a\",\n \"aria-hidden\": \"true\",\n \"focusable\": \"false\",\n \"height\": \"16\",\n \"version\": \"1.1\",\n \"viewBox\": \"0 0 16 16\",\n \"width\": \"16\"\n }, mdx(\"path\", {\n parentName: \"svg\",\n \"fillRule\": \"evenodd\",\n \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n }))), \"Styles\"), mdx(\"p\", null, \"Report templates in PathcoreFlow use Cascading Style Sheets (\", mdx(\"abbr\", {\n parentName: \"p\",\n \"title\": \"Cascading Style Sheets\"\n }, \"CSS\"), \") to style the generated reports. More information about the supported \", mdx(\"abbr\", {\n parentName: \"p\",\n \"title\": \"Cascading Style Sheets\"\n }, \"CSS\"), \" specifications can be found in the \", mdx(\"a\", {\n parentName: \"p\",\n \"href\": \"https://doc.courtbouillon.org/weasyprint/stable/api_reference.html#css\"\n }, \"WeasyPrint documentation\")), mdx(\"h3\", {\n \"id\": \"style-example\"\n }, mdx(\"a\", {\n parentName: \"h3\",\n \"href\": \"#style-example\",\n \"aria-label\": \"style example permalink\",\n \"className\": \"anchor\"\n }, mdx(\"svg\", {\n parentName: \"a\",\n \"aria-hidden\": \"true\",\n \"focusable\": \"false\",\n \"height\": \"16\",\n \"version\": \"1.1\",\n \"viewBox\": \"0 0 16 16\",\n \"width\": \"16\"\n }, mdx(\"path\", {\n parentName: \"svg\",\n \"fillRule\": \"evenodd\",\n \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n }))), \"Style Example\"), mdx(\"p\", null, \"This example \", mdx(\"abbr\", {\n parentName: \"p\",\n \"title\": \"Cascading Style Sheets\"\n }, \"CSS\"), \" style will set the font to sans-serif for the container class, sets the max width to 3 inches and text aligned to center for the signature class, sets the max width of an image in the signature class to 100%, and creates a border around any images.\"), mdx(\"pre\", null, mdx(\"code\", {\n parentName: \"pre\",\n \"className\": \"language-css\"\n }, \"/* Define your CSS styles here */\\n\\n.container {\\n font-family: sans-serif;\\n}\\n\\n.signature {\\n max-width: 3in;\\n text-align: center;\\n}\\n\\n.signature img {\\n max-width: 100%;\\n}\\n\\nimg {\\n border-style: solid;\\n}\\n\")), mdx(\"h2\", {\n \"id\": \"static-data\"\n }, mdx(\"a\", {\n parentName: \"h2\",\n \"href\": \"#static-data\",\n \"aria-label\": \"static data permalink\",\n \"className\": \"anchor\"\n }, mdx(\"svg\", {\n parentName: \"a\",\n \"aria-hidden\": \"true\",\n \"focusable\": \"false\",\n \"height\": \"16\",\n \"version\": \"1.1\",\n \"viewBox\": \"0 0 16 16\",\n \"width\": \"16\"\n }, mdx(\"path\", {\n parentName: \"svg\",\n \"fillRule\": \"evenodd\",\n \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n }))), \"Static Data\"), mdx(\"p\", null, \"Predefined data can be added to a report in a flexible way by adding it to the \", mdx(\"strong\", {\n parentName: \"p\"\n }, \"Static Data\"), \" tab. Data entered there can be accessed inside the template via the variable \", mdx(\"inlineCode\", {\n parentName: \"p\"\n }, \"static_data\"), \". The data is specified using the JavaScript Object Notation (\", mdx(\"abbr\", {\n parentName: \"p\",\n \"title\": \"JavaScript Object Notation\"\n }, \"JSON\"), \") format. See this \", mdx(\"a\", {\n parentName: \"p\",\n \"href\": \"https://www.w3schools.com/js/js_json_syntax.asp\"\n }, \"introduction to \", mdx(\"abbr\", {\n parentName: \"a\",\n \"title\": \"JavaScript Object Notation\"\n }, \"JSON\"), \" syntax\"), \" for more information.\"), mdx(\"h3\", {\n \"id\": \"static-data-example\"\n }, mdx(\"a\", {\n parentName: \"h3\",\n \"href\": \"#static-data-example\",\n \"aria-label\": \"static data example permalink\",\n \"className\": \"anchor\"\n }, mdx(\"svg\", {\n parentName: \"a\",\n \"aria-hidden\": \"true\",\n \"focusable\": \"false\",\n \"height\": \"16\",\n \"version\": \"1.1\",\n \"viewBox\": \"0 0 16 16\",\n \"width\": \"16\"\n }, mdx(\"path\", {\n parentName: \"svg\",\n \"fillRule\": \"evenodd\",\n \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n }))), \"Static Data Example\"), mdx(\"p\", null, \"This section shows the report template code to display output from \", mdx(\"inlineCode\", {\n parentName: \"p\"\n }, \"static_data\"), \".\"), mdx(\"pre\", null, mdx(\"code\", {\n parentName: \"pre\"\n }, \"

Static Data

\\n\\n\\n\\n{# Outputs string variables 'name' and 'date' from static_data #}\\n

\\n Name: {{ static_data['name'] }}
\\n Date: {{ static_data['date'] }}\\n

\\n\")), mdx(\"p\", null, \"This section shows the Static Data values in \", mdx(\"abbr\", {\n parentName: \"p\",\n \"title\": \"JavaScript Object Notation\"\n }, \"JSON\"), \" format.\"), mdx(\"pre\", null, mdx(\"code\", {\n parentName: \"pre\",\n \"className\": \"language-json\"\n }, \"{\\n \\\"foo\\\": [\\n \\\"define\\\",\\n \\\"your\\\",\\n \\\"static\\\",\\n \\\"data\\\",\\n \\\"here\\\"\\n ],\\n \\\"name\\\": \\\"value\\\",\\n \\\"date\\\": \\\"2020-08-18\\\"\\n}\\n\")), mdx(\"h2\", {\n \"id\": \"snapshots\"\n }, mdx(\"a\", {\n parentName: \"h2\",\n \"href\": \"#snapshots\",\n \"aria-label\": \"snapshots permalink\",\n \"className\": \"anchor\"\n }, mdx(\"svg\", {\n parentName: \"a\",\n \"aria-hidden\": \"true\",\n \"focusable\": \"false\",\n \"height\": \"16\",\n \"version\": \"1.1\",\n \"viewBox\": \"0 0 16 16\",\n \"width\": \"16\"\n }, mdx(\"path\", {\n parentName: \"svg\",\n \"fillRule\": \"evenodd\",\n \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n }))), \"Snapshots\"), mdx(\"p\", null, \"Snapshots can be displayed alongside their associated image or on their own within a report. If the desire is to only display snapshots, a snapshot container needs to be created within the report template. A snapshot container is an array of selected snapshots from the report folder.\"), mdx(\"details\", null, mdx(\"summary\", null, \" To create a snapshot container \"), mdx(\"ol\", null, mdx(\"li\", {\n parentName: \"ol\"\n }, mdx(\"p\", {\n parentName: \"li\"\n }, \"Open a report template for editing. See \", mdx(\"a\", {\n parentName: \"p\",\n \"href\": \"/flow/manual/latest/docs/report-templates/working-with-reports/\"\n }, \"Working With Reports\"), \" for details\")), mdx(\"li\", {\n parentName: \"ol\"\n }, mdx(\"p\", {\n parentName: \"li\"\n }, \"Click on the \", mdx(\"strong\", {\n parentName: \"p\"\n }, \"Snapshots\"), \" tab\")), mdx(\"li\", {\n parentName: \"ol\"\n }, mdx(\"p\", {\n parentName: \"li\"\n }, \"Click on the \", mdx(\"strong\", {\n parentName: \"p\"\n }, \"+ Add Snapshot Container\"), \" button\")), mdx(\"li\", {\n parentName: \"ol\"\n }, mdx(\"p\", {\n parentName: \"li\"\n }, \"Type a name for the container in the \", mdx(\"strong\", {\n parentName: \"p\"\n }, \"Display Name\"), \" field\")), mdx(\"li\", {\n parentName: \"ol\"\n }, mdx(\"p\", {\n parentName: \"li\"\n }, \"Type a value in the \", mdx(\"strong\", {\n parentName: \"p\"\n }, \"Template Name\"), \" field\"), mdx(\"ul\", {\n parentName: \"li\"\n }, mdx(\"li\", {\n parentName: \"ul\"\n }, \"This is the name of the snapshot container used within the report template. For example, if you name the container \\\"selected\", \"_\", \"features\\\", the list of snapshots would be accessed as the variable \", mdx(\"inlineCode\", {\n parentName: \"li\"\n }, \"snapshots.selected_features\")))), mdx(\"li\", {\n parentName: \"ol\"\n }, mdx(\"p\", {\n parentName: \"li\"\n }, \"(Optional) Enable the \", mdx(\"strong\", {\n parentName: \"p\"\n }, \"Required\"), \" toggle if the report must contain snapshots\")), mdx(\"li\", {\n parentName: \"ol\"\n }, mdx(\"p\", {\n parentName: \"li\"\n }, \"Set the \", mdx(\"strong\", {\n parentName: \"p\"\n }, \"between\"), \" values to the range of snapshots allowed or required in the report. (i.e., to force the user to select up to 5 snapshots to be included in the report, set \", mdx(\"strong\", {\n parentName: \"p\"\n }, \"between\"), \" values to 1 and 5)\")))), mdx(\"details\", null, mdx(\"summary\", null, \" To delete a snapshot container \"), mdx(\"ol\", null, mdx(\"li\", {\n parentName: \"ol\"\n }, mdx(\"p\", {\n parentName: \"li\"\n }, \"Open a report template for editing. See \", mdx(\"a\", {\n parentName: \"p\",\n \"href\": \"/flow/manual/latest/docs/report-templates/working-with-reports/\"\n }, \"Working With Reports\"), \" for details\")), mdx(\"li\", {\n parentName: \"ol\"\n }, mdx(\"p\", {\n parentName: \"li\"\n }, \"Click on the \", mdx(\"strong\", {\n parentName: \"p\"\n }, \"Snapshots\"), \" tab\")), mdx(\"li\", {\n parentName: \"ol\"\n }, mdx(\"p\", {\n parentName: \"li\"\n }, \"Locate the container to be removed\")), mdx(\"li\", {\n parentName: \"ol\"\n }, mdx(\"p\", {\n parentName: \"li\"\n }, \"Click on the \", mdx(\"img\", {\n parentName: \"p\",\n \"src\": \"/flow/manual/latest/d1045fe887948a6744b903a0da9d9da3/table-trash.svg\",\n \"alt\": \"Delete Container\"\n }), \" button at the bottom left of the container block\")))), mdx(\"h3\", {\n \"id\": \"snapshots-example\"\n }, mdx(\"a\", {\n parentName: \"h3\",\n \"href\": \"#snapshots-example\",\n \"aria-label\": \"snapshots example permalink\",\n \"className\": \"anchor\"\n }, mdx(\"svg\", {\n parentName: \"a\",\n \"aria-hidden\": \"true\",\n \"focusable\": \"false\",\n \"height\": \"16\",\n \"version\": \"1.1\",\n \"viewBox\": \"0 0 16 16\",\n \"width\": \"16\"\n }, mdx(\"path\", {\n parentName: \"svg\",\n \"fillRule\": \"evenodd\",\n \"d\": \"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"\n }))), \"Snapshots Example\"), mdx(\"pre\", null, mdx(\"code\", {\n parentName: \"pre\"\n }, \"{# Begins looping through all the snapshots in the snapshot container 'container1' #}\\n{% for snapshot in snapshots['container1'] %}\\n {# Displays the title, id and description of each snapshot #}\\n
\\n

Title: {{ snapshot.title }}

\\n

ID: {{ snapshot.id }}

\\n

Description: {{ snapshot.description }}

\\n {# Displays the snapshot #}\\n \\n
\\n{% endfor %}\\n\")));\n}\n;\nMDXContent.isMDXComponent = true;","tableOfContents":{"items":[{"url":"#auxiliary-information","title":"Auxiliary Information","items":[{"url":"#styles","title":"Styles","items":[{"url":"#style-example","title":"Style Example"}]},{"url":"#static-data","title":"Static Data","items":[{"url":"#static-data-example","title":"Static Data Example"}]},{"url":"#snapshots","title":"Snapshots","items":[{"url":"#snapshots-example","title":"Snapshots Example"}]}]}]}}},"pageContext":{"id":"0dab69d3-3ec5-54b7-aaf5-b9a95ac13cb1"}},"staticQueryHashes":["1086510573","1106176283","1122327541","2140385554","2719290676","3597609067","4027383558"]}