Dev to main

full-ifrs17-template/Constants/Consts.ipynb → full-ifrs17-template/Constants/CalculationEngine.ipynb

@@ -18,11 +18,11 @@
         {
             "cell_type": "code",
             "source": [
-                "var projectName = \"ifrs17ce\";",
-                "\nvar environmentName = \"dev\";",
+                "var projectName = \"ifrs17\";",
+                "\nvar environmentName = \"v1.0.0\";",
                 "\nvar notebookName = \"CalculationEngine\";",
                 "\nvar calculationEngine = $\"#!import \\\"//{projectName}/{environmentName}/{notebookName}\\\"\";"
             ]
         }
     ]
-}
+}

full-ifrs17-template/Database/Configure.ipynb

@@ -27,7 +27,7 @@
         {
             "cell_type": "code",
             "source": [
-                "#!import \"../Constants/Consts\"",
+                "#!import \"../Constants/CalculationEngine\"",
                 "\n#!eval calculationEngine"
             ]
         },

full-ifrs17-template/Database/PersonalConnectionExample.ipynb

@@ -0,0 +1,25 @@
+{
+    "metadata": {
+        "authors": [],
+        "kernelspec": {
+            "display_name": "Formula Framework",
+            "language": "C#",
+            "name": "C#"
+        },
+        "language_info": {
+            "file_extension": ".cs",
+            "mimetype": "text/plain",
+            "name": "C#"
+        }
+    },
+    "nbformat": 4,
+    "nbformat_minor": 5,
+    "cells": [
+        {
+            "cell_type": "code",
+            "source": [
+                "var connectionStringMsSql = \"here enter your connection string\";"
+            ]
+        }
+    ]
+}

full-ifrs17-template/Export/MapTemplate.ipynb

@@ -26,13 +26,17 @@
         {
             "cell_type": "markdown",
             "source": [
-                "This Notebook exports the Data nodes, states, and parameters for the target partition to a spreadsheet file which can be read, modified, and is ready to be re-imported."
+                "This notebook exports the data nodes, data node states, and data node parameters belonging to a specific data partition into an excel file.",
+                "\n<br> This file contains reference data used to prepopulate dropdows and validations to facilitate editing.",
+                "\n<br> This can be modified and imported in the calculation engine to create and modify data."
             ]
         },
         {
             "cell_type": "markdown",
             "source": [
-                "After setting the desired target Partition, the Data present in the workspace is ready to be exported. "
+                "After setting the desired target Partition, the Data present in the workspace is ready to be exported. ",
+                "\n",
+                "\nThe default location of the exported files is the project file storage. A **download** link is generated and available for as long as the session is active. "
             ]
         },
         {
@@ -44,16 +48,17 @@
         {
             "cell_type": "markdown",
             "source": [
-                "Choose to run the Map Template either with the set of Systemorph data in memory or with the data present in the Database. Uncomment the desired option."
+                "Choose to run the Map Template either with the set of Systemorph data in memory or with the data present in the Database: ",
+                "\n- #!eval-notebook \"../Database/Configure\" : connects to a physical Database",
+                "\n- #!eval-notebook \"../Import/CloseImportTemplate\" : uses the in-memory set up",
+                "\n",
+                "\nWe use here the in-memory set up."
             ]
         },
         {
             "cell_type": "code",
             "source": [
-                "/* The DataSource is configured and connected to real database */",
-                "\n//#!eval-notebook \"../Database/Configure\"",
-                "\n/* The Systemorph set of dimensions + mockdata are dispatched to the unconfigured in-memory DataSource */",
-                "\n#!eval-notebook \"../Initialization/InitSystemorphBaseToMemory\""
+                "#!eval-notebook \"../Import/CloseImportTemplate\""
             ]
         },
         {
@@ -77,7 +82,9 @@
         {
             "cell_type": "markdown",
             "source": [
-                "# Map Template: Data Node"
+                "# Map Template: Data Node",
+                "\n",
+                "\n[DataNodes](https://portal.systemorph.cloud/project/ifrs17/env/v1.0.0/DataModel/DataStructure#data-node) defines the properties of [Portfolios](https://portal.systemorph.cloud/project/ifrs17/env/v1.0.0/DataModel/DataStructure#portfolios) and [Group of Contracts](https://portal.systemorph.cloud/project/ifrs17/env/v1.0.0/DataModel/DataStructure#group-of-contracts)."
             ]
         },
         {
@@ -89,13 +96,8 @@
         {
             "cell_type": "code",
             "source": [
-                "static var partition = new PartitionByReportingNode() { ReportingNode = \"CH\" };"
-            ]
-        },
-        {
-            "cell_type": "code",
-            "source": [
-                "await Workspace.Partition.SetAsync<PartitionByReportingNode>( partition );"
+                "static var partition = new PartitionByReportingNode() { ReportingNode = \"CH\" };",
+                "\nawait Workspace.Partition.SetAsync<PartitionByReportingNode>( partition );"
             ]
         },
         {
@@ -120,7 +122,9 @@
         {
             "cell_type": "markdown",
             "source": [
-                "# Map Template: Data Node State"
+                "# Map Template: Data Node State",
+                "\n",
+                "\n[Data Node State](https://portal.systemorph.cloud/project/ifrs17/env/v1.0.0/DataModel/DataStructure#data-node-state) defines whether the instance is active (used in import/output) or inactive (present in the DataSource but not used in input/output operations)."
             ]
         },
         {
@@ -132,19 +136,20 @@
         {
             "cell_type": "code",
             "source": [
-                "static var partition = new PartitionByReportingNodeAndPeriod() { ReportingNode = \"CH\", Year = 2020, Month = 12 };"
+                "static var partition = new PartitionByReportingNodeAndPeriod() { ReportingNode = \"CH\", Year = 2020, Month = 12 };",
+                "\nawait Workspace.Partition.SetAsync<PartitionByReportingNode>( new PartitionByReportingNode() { ReportingNode = partition.ReportingNode } );"
             ]
         },
         {
-            "cell_type": "code",
+            "cell_type": "markdown",
             "source": [
-                "await Workspace.Partition.SetAsync<PartitionByReportingNode>( new PartitionByReportingNode() { ReportingNode = partition.ReportingNode } );"
+                "## Export"
             ]
         },
         {
             "cell_type": "markdown",
             "source": [
-                "## Export"
+                "The data is retrieved for the Workspace and prepared for export."
             ]
         },
         {
@@ -158,6 +163,12 @@
                 "\n                        .ToArray();"
             ]
         },
+        {
+            "cell_type": "markdown",
+            "source": [
+                "Export is performed."
+            ]
+        },
         {
             "cell_type": "code",
             "source": [
@@ -172,7 +183,9 @@
         {
             "cell_type": "markdown",
             "source": [
-                "# Map Template: Data Node Parameter"
+                "# Map Template: Data Node Parameter",
+                "\n",
+                "\n[Data Node Parameters](https://portal.systemorph.cloud/project/ifrs17/env/v1.0.0/DataModel/DataStructure#data-node-parameters) are defined at the Group of Contract level and are used during the import calculation. "
             ]
         },
         {
@@ -184,19 +197,20 @@
         {
             "cell_type": "code",
             "source": [
-                "static var partition = new PartitionByReportingNodeAndPeriod() { ReportingNode = \"CH\", Year = 2020, Month = 12 };"
+                "static var partition = new PartitionByReportingNodeAndPeriod() { ReportingNode = \"CH\", Year = 2020, Month = 12 };",
+                "\nawait Workspace.Partition.SetAsync<PartitionByReportingNode>( new PartitionByReportingNode() { ReportingNode = partition.ReportingNode } );"
             ]
         },
         {
-            "cell_type": "code",
+            "cell_type": "markdown",
             "source": [
-                "await Workspace.Partition.SetAsync<PartitionByReportingNode>( new PartitionByReportingNode() { ReportingNode = partition.ReportingNode } );"
+                "## Export"
             ]
         },
         {
             "cell_type": "markdown",
             "source": [
-                "## Export"
+                "The data is retrieved for the Workspace and prepared for export."
             ]
         },
         {
@@ -212,6 +226,12 @@
                 "\n                                            .ToArray() );"
             ]
         },
+        {
+            "cell_type": "markdown",
+            "source": [
+                "Export is performed."
+            ]
+        },
         {
             "cell_type": "code",
             "source": [