{"id":263,"date":"2022-11-11T11:50:45","date_gmt":"2022-11-11T10:50:45","guid":{"rendered":"http:\/\/souslesens.org\/?page_id=263"},"modified":"2024-06-25T15:23:37","modified_gmt":"2024-06-25T13:23:37","slug":"documentation","status":"publish","type":"page","link":"http:\/\/souslesens.org\/index.php\/documentation\/","title":{"rendered":"Technical Design Documents"},"content":{"rendered":"\n<p class=\"has-ti-accent-color has-text-color has-link-color has-x-large-font-size wp-elements-df520ec88ce7d63750f9411295ed8a9f\">Technical Design Documents<\/p>\n\n\n\n<p>Pdf documents for developers (this documentation is under construction so it is evolving every week)<\/p>\n\n\n\n<p>Present version :<strong> preliminary  edited on 2023\/03\/18<\/strong> <\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>PDF version<\/td><td>PDF version<\/td><td>Mindmap PDF<\/td><td>Xmind file<\/td><\/tr><tr><td>SLS TDD Development Deployment Configuration  (draft) <\/td><td><a href=\"http:\/\/souslesens.org\/?page_id=684\">view pdf<\/a><\/td><td><a href=\"http:\/\/souslesens.org\/?page_id=914\" data-type=\"page\" data-id=\"914\">view PDF<\/a><\/td><td><a href=\"http:\/\/souslesens.org\/?page_id=934\" data-type=\"page\" data-id=\"934\">Xmind<\/a><\/td><\/tr><tr><td>SLS TDD User Interface Components (draft) <\/td><td><a href=\"http:\/\/souslesens.org\/?page_id=678\">view pdf<\/a><\/td><td><a href=\"http:\/\/souslesens.org\/index.php\/slsv-user-interface-components-mind-map\/\" data-type=\"page\" data-id=\"713\">view PDF<\/a><\/td><td><a href=\"http:\/\/souslesens.org\/?page_id=935\" data-type=\"page\" data-id=\"935\">Xmind<\/a><\/td><\/tr><tr><td>SLS TDD Code Structure Map (draft) <\/td><td><a href=\"http:\/\/souslesens.org\/?page_id=692\">view pdf<\/a><\/td><td><a href=\"http:\/\/souslesens.org\/index.php\/slsv-code-structure-mind-map\/\" data-type=\"page\" data-id=\"712\">view PDF<\/a><\/td><td><a href=\"http:\/\/souslesens.org\/?page_id=937\" data-type=\"page\" data-id=\"937\">Xmind<\/a><\/td><\/tr><tr><td>SLS TDD &amp; System Components (draft) <\/td><td><a href=\"http:\/\/souslesens.org\/index.php\/slsv-technical-design-systemcomponents-mapping\/\">view pdf<\/a><\/td><td><a href=\"http:\/\/souslesens.org\/?page_id=915\" data-type=\"page\" data-id=\"915\">view PDF<\/a><\/td><td><a href=\"http:\/\/souslesens.org\/?page_id=938\" data-type=\"page\" data-id=\"938\">Xmind<\/a><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<p><\/p>\n\n\n\n<h3 class=\"wp-block-heading has-ti-bg-inv-color has-text-color has-link-color wp-elements-f673c0788007377418a8826dcbc36fbd\"><a>1&nbsp;GENERAL DESCRIPTION OF APPLICATION :<\/a><\/h3>\n\n\n\n<p>SousLeSens (also called &#8220;SLSV&#8221;) is a set of tool to visualize and manipulate graphs, manage search and implement semantic web applications.<\/p>\n\n\n\n<p>It\u2019s open source (MIT license), all code listed on <a href=\"https:\/\/github.com\/souslesens\">SousLeSens GitHub<\/a>, &nbsp;Web site is <a href=\"http:\/\/souslesens.org\/\">souslesens.org<\/a> for wiki &amp; documentation.<\/p>\n\n\n\n<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-28f84493 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:100%\">\n<figure class=\"wp-block-table\"><table><tbody><tr><td><img decoding=\"async\" src=\"http:\/\/souslesens.org\/wp-content\/uploads\/2023\/03\/OWL-1.jpg\" alt=\"\"><\/td><td><img decoding=\"async\" src=\"http:\/\/souslesens.org\/wp-content\/uploads\/2023\/03\/semanticWeb.jpg\" alt=\"\"><\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div>\n<\/div>\n\n\n\n<h3 class=\"wp-block-heading has-ti-bg-inv-color has-text-color has-link-color wp-elements-de0715c73a4f393fde1a54be607869bd\"><a>2&nbsp;Technology solution<\/a><\/h3>\n\n\n\n<p><strong>Senslesens has created like a &lt;Semantical Web&gt; Client\/Server application.<\/strong><strong><\/strong><\/p>\n\n\n\n<p><strong>The application has initialized like a &lt;Node\/Express JS&gt; project with IDE &lt;WebStrom&gt; since 2020.&nbsp; Its principals\u2019 functions realized directly by &lt;JavaScript&gt; language, and ontologies sources and database are with &lt;SparQL&gt; +&lt;SQL server&gt;<\/strong><strong><\/strong><\/p>\n\n\n\n<p><strong>Communication between front and server are used &lt;Rest API&gt; implemented by &lt;Express JS&gt;<\/strong><strong><\/strong><\/p>\n\n\n\n<p><strong>Style applicated is Pug (Jade) for view Engie , and CSS style <\/strong><strong><\/strong><\/p>\n\n\n\n<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-28f84493 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:100%\">\n<figure class=\"wp-block-table is-style-regular has-small-font-size\"><table><tbody><tr><td><img decoding=\"async\" src=\"http:\/\/souslesens.org\/wp-content\/uploads\/2023\/03\/NodeExpressJS.jpg\" alt=\"\"><\/td><td><img decoding=\"async\" src=\"http:\/\/souslesens.org\/wp-content\/uploads\/2023\/03\/SPARQL-2.jpg\" alt=\"\"><\/td><td><img decoding=\"async\" src=\"http:\/\/souslesens.org\/wp-content\/uploads\/2023\/03\/Jquery-1.jpg\" alt=\"\"><\/td><td><img decoding=\"async\" src=\"http:\/\/souslesens.org\/wp-content\/uploads\/2023\/03\/SQL-1.jpg\" alt=\"\" style=\"width: 50px;\"><\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div>\n<\/div>\n\n\n\n<p><strong>In 2022, application has added a new component: &lt;ConfigEditor&gt;, this component has created by &lt;React JS&gt; with &lt;Type Script&gt; .&nbsp;&nbsp; And it was also updated to &lt;Docker compose&gt; run time solution, one for web application server and another side for &lt;SPARQL&gt; server. <\/strong><\/p>\n\n\n\n<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-28f84493 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:100%\">\n<figure class=\"wp-block-table table{ border-color:transparent;}\"><table><tbody><tr><td><img decoding=\"async\" src=\"http:\/\/souslesens.org\/wp-content\/uploads\/2023\/03\/ReactJs.jpg\" alt=\"\"><\/td><td><img decoding=\"async\" src=\"http:\/\/souslesens.org\/wp-content\/uploads\/2023\/03\/docker.jpg\" alt=\"\"><\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div>\n<\/div>\n\n\n\n<h3 class=\"wp-block-heading has-ti-bg-inv-color has-text-color has-link-color wp-elements-740437a522bd886cebce39dfade0bc34\"><a>3&nbsp;Architecture &amp; System COMPONENTS <\/a><\/h3>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"714\" src=\"http:\/\/souslesens.org\/wp-content\/uploads\/2023\/04\/Architecture-1024x714.png\" alt=\"\" class=\"wp-image-905\" srcset=\"http:\/\/souslesens.org\/wp-content\/uploads\/2023\/04\/Architecture-1024x714.png 1024w, http:\/\/souslesens.org\/wp-content\/uploads\/2023\/04\/Architecture-300x209.png 300w, http:\/\/souslesens.org\/wp-content\/uploads\/2023\/04\/Architecture-768x535.png 768w, http:\/\/souslesens.org\/wp-content\/uploads\/2023\/04\/Architecture.png 1105w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>Please reference to <strong>&lt;<a href=\"http:\/\/souslesens.org\/index.php\/slsv-technical-design-systemcomponents-mapping\/\">TDD-SLSV_SYS_Components<\/a> &gt; Technical Design Document of SLS System Components<\/strong> to get all detail documentation<\/p>\n\n\n\n<h3 class=\"wp-block-heading has-ti-bg-inv-color has-text-color has-link-color wp-elements-c9bacf00490e5609492cfc0f9fad25c0\"><a>4&nbsp;User Interface (UI) components<\/a><\/h3>\n\n\n\n<p>Please reference to <strong>&lt;<a href=\"http:\/\/souslesens.org\/?page_id=678\">TDD-SLSV_UI_Components<\/a>&gt; Technical Design Document of SLS UI Components<\/strong> to get all detail documentation<\/p>\n\n\n\n<h3 class=\"wp-block-heading has-ti-bg-inv-color has-text-color has-link-color wp-elements-00f1b50127b9699bc9a4aac53db6ed91\"><a>4.1&nbsp;Main interface &lt;Vocables&gt;<\/a><\/h3>\n\n\n\n<p><strong>It\u2019s a principal interface of application, it includes next main functions &lt;Tools&gt; components:<\/strong><strong><\/strong><\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Lineage<\/strong><strong><\/strong><\/li>\n\n\n\n<li><strong>KG creator<\/strong><strong><\/strong><\/li>\n\n\n\n<li><strong>Standardizer<\/strong><strong><\/strong><\/li>\n\n\n\n<li><strong>ConfigEditor<\/strong><strong><\/strong><\/li>\n\n\n\n<li><strong>Business Admin<\/strong><\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading has-ti-bg-inv-color has-text-color has-link-color wp-elements-fb6653e2f683018ac3b9357b81585506\"><a>4.2&nbsp;Interface &lt; Yasguy &gt;<\/a><\/h3>\n\n\n\n<p>Triple generation page<\/p>\n\n\n\n<h3 class=\"wp-block-heading has-ti-bg-inv-color has-text-color has-link-color wp-elements-a51ca81e913c04bcb68ed50571041fad\"><a>4.3&nbsp; Interface &lt; Ontocommons&gt;<\/a><\/h3>\n\n\n\n<p>&lt;SousLeSens&gt; Community connection API<\/p>\n\n\n\n<h3 class=\"wp-block-heading has-ti-bg-inv-color has-text-color has-link-color wp-elements-aa773e70b3d61cdfb232999cb99647dc\"><a>4.4 Graphical part:<\/a><\/h3>\n\n\n\n<p><strong>&nbsp;&lt;node&gt;&nbsp; <\/strong><\/p>\n\n\n\n<p><strong>&lt; individual&gt;<\/strong><\/p>\n\n\n\n<h3 class=\"wp-block-heading has-ti-bg-inv-color has-text-color has-link-color wp-elements-b6ad7629c6910d293889bba9289042d6\"><a>5&nbsp;Development contents<\/a><\/h3>\n\n\n\n<h3 class=\"wp-block-heading has-ti-bg-inv-color has-text-color has-link-color wp-elements-a8accab7a49e5e62f2fd73ba1dd07e47\"><a>5.1&nbsp;Tree structure of code<\/a><\/h3>\n\n\n\n<p>Please reference to <strong>&lt; <a href=\"http:\/\/souslesens.org\/?page_id=692\">TDD-SLSV_Code_Structure<\/a>&gt;<\/strong> <strong>Technical Design Document of SLS <em>Code Structure<\/em> <\/strong>&nbsp;to get all detail documentation<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>\/bin&nbsp; # Server side code<\/li>\n\n\n\n<li>\/public&nbsp; # Web Client side code<\/li>\n\n\n\n<li>\/api &nbsp;# Server side API code<\/li>\n\n\n\n<li>\/scripts # Installation script folder<\/li>\n\n\n\n<li>\/views&nbsp;&nbsp; # Pug(Jade) node express js project view engineer<\/li>\n\n\n\n<li>\/data &nbsp;&nbsp;# pdf, image, csv, etc<\/li>\n\n\n\n<li>\/config_templates&nbsp; # Configuration templates will be used during installation cycle , called by installation script<\/li>\n\n\n\n<li>\/cypress &nbsp;# UI test file folder<\/li>\n\n\n\n<li>\/tests&nbsp; &nbsp;# test file folder<\/li>\n\n\n\n<li>\/mainapp&nbsp; # ConfigEditor component folder (React)<\/li>\n\n\n\n<li>\/model&nbsp; # ConfigEditor component folder (React)<\/li>\n\n\n\n<li>\/node_modules&nbsp;&nbsp;# External dependencies folder (generated after &#8220;npm install&#8221; or \u201cnpm ci\u201d)<\/li>\n\n\n\n<li>\/config&nbsp; # Run time configuration files folder&nbsp;(generated after &#8220;node \/scripts\/init_config.js&#8221; during first deployment)<\/li>\n\n\n\n<li>\/docs #coments&#8217; documents generation folder<\/li>\n\n\n\n<li>\/java #java-jena code folder<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading has-ti-bg-inv-color has-text-color has-link-color wp-elements-a872e4b91bb27757b811528a488fbf9c\"><a><strong>5.2&nbsp;<\/strong>Settings, Environement, Deployment<\/a><\/h3>\n\n\n\n<p><strong>See &lt; <a href=\"http:\/\/souslesens.org\/?page_id=684\">TDD_SLSV_Dev_Deploy_Prod_Env<\/a>&gt;<\/strong> <strong>Technical Design Document of SLS Dev Deploy Production to get more information for development, deployment process and also configuration of application<\/strong><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Technical Design Documents Pdf documents for developers (this documentation is under construction so it is evolving every week) Present version : preliminary edited on 2023\/03\/18 PDF version PDF version Mindmap PDF Xmind file SLS TDD Development Deployment Configuration (draft) view pdf view PDF Xmind SLS TDD User Interface Components (draft) view pdf view PDF Xmind [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-263","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"http:\/\/souslesens.org\/index.php\/wp-json\/wp\/v2\/pages\/263","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/souslesens.org\/index.php\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"http:\/\/souslesens.org\/index.php\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"http:\/\/souslesens.org\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/souslesens.org\/index.php\/wp-json\/wp\/v2\/comments?post=263"}],"version-history":[{"count":49,"href":"http:\/\/souslesens.org\/index.php\/wp-json\/wp\/v2\/pages\/263\/revisions"}],"predecessor-version":[{"id":1729,"href":"http:\/\/souslesens.org\/index.php\/wp-json\/wp\/v2\/pages\/263\/revisions\/1729"}],"wp:attachment":[{"href":"http:\/\/souslesens.org\/index.php\/wp-json\/wp\/v2\/media?parent=263"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}