docs: viya

docs/dci-deploysasviya.md

@@ -0,0 +1,79 @@
+---
+layout: article
+title: DC SAS 9 Deployment
+description: How to deploy Data Controller in a production SAS 9 environment
+og_image: https://docs.datacontroller.io/img/dci_deploymentdiagram.png
+---
+
+# SAS 9 Deployment
+
+## Overview
+Data Controller for SAS 9 consists of a frontend, a set of Stored Processes, a staging area, and a database library.  The library can be a SAS Base engine if desired, however this can cause contention (eg table locks) if end users are able to connect to the datasets directly, eg via Enterprise Guide or Base SAS.
+A database that supports concurrent access is recommended.
+
+## Backend
+
+1 - Import `/sas/import.spk` using SAS Management Console.  Make a note of the root location in which this was deployed - as this will be added to the `appLoc` value in the `index.html` file in the [frontend](#frontend) deployment.
+
+2 - Create a physical staging directory.  This folder will contain the logs and CSV files generated by Users.  The SAS Spawned Server account (eg `sassrv`) will need write access to this location.
+
+3 - Update the library to point to a schema in your preferred database
+
+4 - Deploy the physical tables and register them in metadata.  For this, simply compile and run the `mpe_build()` macro using an  account with appropriate privileges.
+
+!!! note
+    Make sure the SAS Spawned Server account (eg `sassrv`) can access these tables!
+
+## Frontend
+The Data Controller front end comes pre-built, and ready to deploy to the root of the SAS Web Server (mid-tier), typically `!SASCONFIG/LevX/Web/WebServer/htdocs` in SAS 9.
+
+Deploy as follows:
+
+1 - Unzip dcfrontend.zip and upload the entire `datacontroller` directory to the static content server.
+
+2 - Open the `index.html` file and update the `appLoc` value to the location where the Stored Processes were deployed earlier.
+
+It should now be possible to use the application - simply navigate to `YOURSASWEBLOC:port/yourRoot/datacontroller` and sign in!
+
+The next step is to [configure](dcc-tables.md) the tables.
+
+## Deployment Diagram
+
+The below areas of the SAS platform are modified when deploying Data Controller:
+
+<img src="/img/dci_deploymentdiagram.svg" height="350" style="border:3px solid black" >
+
+### Client Device
+
+Nothing needs to be deployed or modified on the client device.  We support a wide range of browsers (the same as SAS).  Browsers make requests to the SAS Web Server, and will cache assets such as JS, CSS and images.  Some items (such as dropdowns) are kept in local storage to improve responsiveness.
+
+### SAS Mid Tier
+
+The front end is deployed to the SAS Web Server as described [above](/dci-deploysas9/#frontend).  This requires making a dedicated public folder in the htdocs directory.
+
+### SAS Application Server
+
+Given the enhanced permissions needed of the system account, a dedicated / secured STP instance is recommended as described [here](/dci-stpinstance).
+
+All deployments of Data Controller also make use of a staging directory.  This is used to store CSV and Excel files as uploaded by end users.  This directory should NOT be accessible by end users - only the SAS system account (eg sassrv) requires access to this directory.
+
+A typical small deployment will grow by a 10-20 mb each month.  A very large enterprise customer, with 100 or more editors, might generate up to 1 GB or so per month, depending on the size and frequency of the Excel EUCs and CSVs being uploaded.  Web modifications are restricted only to modified rows, so are typically just a few kb in size.
+
+### SAS Metadata Server
+
+The items deployed to metadata include:
+
+ * Folder tree
+ * Stored Processes
+ * Library Object & tables
+
+ After the installation process (which updates `settings` and removes the `makedata` STP), there are no write actions performed against metadata.
+
+### Databases
+
+We strongly recommend that the Data Controller configuration tables are stored in a database for concurrency reasons, however it is also possible to use a BASE engine library.
+
+We provide the DDL for creating the tables, we have customers in production using Oracle, Postgres, Netezza, SQL Server to name a few.
+
+Data Controller does NOT modify schemas! It will not create or drop tables, or add/modify columns or attributes.  Only rows can be modified using the tool.
+

docs/img/dci_deploymentdiagramviya.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:lucid="lucid" width="1700" height="940"><g transform="translate(-85.19999999999993 -220)" lucid:page-tab-id="zESAseJvf9q~"><path d="M0 0h1870.4v1323.2H0z" fill="#fff"/><path d="M1151.2 266h614v874h-1660V240h996zm-1046 0h1046" stroke="#000" stroke-width="2" fill="#fff"/><use xlink:href="#a" transform="matrix(1,0,0,1,113.19999999999993,240) translate(0 16.6)"/><use xlink:href="#b" transform="matrix(1,0,0,1,113.19999999999993,240) translate(42.25 16.6)"/><use xlink:href="#c" transform="matrix(1,0,0,1,113.19999999999993,240) translate(143.10000000000002 16.6)"/><path d="M770 828l33.6-28H1100v246.4l-28 33.6H770z" stroke="#000" stroke-width="2" fill="#fff"/><path d="M770 828l33.6-28H1100l-28 28z" stroke="#000" stroke-width="2" fill="#e6e6e6"/><path d="M1072 828l28-28v246.4l-28 33.6z" stroke="#000" stroke-width="2" fill="#ccc"/><use xlink:href="#d" transform="matrix(1,0,0,1,778,836) translate(0 16.6)"/><use xlink:href="#e" transform="matrix(1,0,0,1,778,836) translate(41.95 16.6)"/><use xlink:href="#f" transform="matrix(1,0,0,1,778,836) translate(124.70000000000002 16.6)"/><path d="M810 869h213v171H810z" stroke="#000" stroke-width="2" fill="#c7e8ac"/><path d="M790 901.75h40v20h-40zM790 987.25h40v20h-40z" stroke="#000" stroke-width="2" fill="#c7e8ac"/><use xlink:href="#g" transform="matrix(1,0,0,1,836.6,886.1) translate(26.625 14.4)"/><use xlink:href="#h" transform="matrix(1,0,0,1,836.6,886.1) translate(97.425 14.4)"/><path d="M1340 840l33.6-28H1660v246.4l-28 33.6h-292z" stroke="#000" stroke-width="2" fill="#fff"/><path d="M1340 840l33.6-28H1660l-28 28z" stroke="#000" stroke-width="2" fill="#e6e6e6"/><path d="M1632 840l28-28v246.4l-28 33.6z" stroke="#000" stroke-width="2" fill="#ccc"/><use xlink:href="#i" transform="matrix(1,0,0,1,1348,848) translate(0 16.6)"/><path d="M1382.86 992h231.43v70h-231.44z" stroke="#000" stroke-width="2" fill="#fff"/><path d="M1362.86 999.5h40v20h-40zM1362.86 1034.5h40v20h-40z" stroke="#000" stroke-width="2" fill="#fff"/><use xlink:href="#j" transform="matrix(1,0,0,1,1413.1428571428569,999) translate(20.799999999999997 14.4)"/><use xlink:href="#k" transform="matrix(1,0,0,1,1413.1428571428569,999) translate(79.30000000000001 14.4)"/><path d="M1393.57 884h215.72v70h-215.73z" stroke="#000" stroke-width="2" fill="#c7e8ac"/><path d="M1373.57 891.5h40v20h-40zM1373.57 926.5h40v20h-40z" stroke="#000" stroke-width="2" fill="#c7e8ac"/><use xlink:href="#l" transform="matrix(1,0,0,1,1420.7142857142856,891) translate(17.674999999999997 14.4)"/><use xlink:href="#m" transform="matrix(1,0,0,1,1420.7142857142856,891) translate(61.575 14.4)"/><use xlink:href="#n" transform="matrix(1,0,0,1,1420.7142857142856,891) translate(12.75 36)"/><use xlink:href="#o" transform="matrix(1,0,0,1,1420.7142857142856,891) translate(86.7 36)"/><use xlink:href="#p" transform="matrix(1,0,0,1,1420.7142857142856,891) translate(96.7 36)"/><path d="M1340 372l38.4-32H1660v321.6l-32 38.4h-288z" stroke="#000" stroke-width="2" fill="#fff"/><path d="M1340 372l38.4-32H1660l-32 32z" stroke="#000" stroke-width="2" fill="#e6e6e6"/><path d="M1628 372l32-32v321.6l-32 38.4z" stroke="#000" stroke-width="2" fill="#ccc"/><use xlink:href="#d" transform="matrix(1,0,0,1,1348,380) translate(0 16.6)"/><use xlink:href="#q" transform="matrix(1,0,0,1,1348,380) translate(41.95 16.6)"/><use xlink:href="#r" transform="matrix(1,0,0,1,1348,380) translate(94.85000000000001 16.6)"/><use xlink:href="#s" transform="matrix(1,0,0,1,1348,380) translate(129.8 16.6)"/><use xlink:href="#t" transform="matrix(1,0,0,1,1348,380) translate(139.8 16.6)"/><path d="M1400 520h200v74.12h-200z" stroke="#000" stroke-width="2" fill="#c7e8ac"/><path d="M1380 528.53h40v20h-40zM1380 565.6h40v20h-40z" stroke="#000" stroke-width="2" fill="#c7e8ac"/><use xlink:href="#u" transform="matrix(1,0,0,1,1424,527.4117647058823) translate(15.649999999999991 14.4)"/><use xlink:href="#v" transform="matrix(1,0,0,1,1424,527.4117647058823) translate(52.55 14.4)"/><use xlink:href="#w" transform="matrix(1,0,0,1,1424,527.4117647058823) translate(45 36)"/><use xlink:href="#x" transform="matrix(1,0,0,1,1424,527.4117647058823) translate(30.64999999999999 57.6)"/><path d="M1400 612.65h200v74.1h-200z" stroke="#000" stroke-width="2" fill="#c7e8ac"/><path d="M1380 621.18h40v20h-40zM1380 658.24h40v20h-40z" stroke="#000" stroke-width="2" fill="#c7e8ac"/><use xlink:href="#y" transform="matrix(1,0,0,1,1424,620.0588235294118) translate(14.649999999999991 14.4)"/><use xlink:href="#z" transform="matrix(1,0,0,1,1424,620.0588235294118) translate(19.64999999999999 14.4)"/><use xlink:href="#A" transform="matrix(1,0,0,1,1424,620.0588235294118) translate(61.599999999999994 14.4)"/><use xlink:href="#B" transform="matrix(1,0,0,1,1424,620.0588235294118) translate(43.625 36)"/><use xlink:href="#C" transform="matrix(1,0,0,1,1424,620.0588235294118) translate(35.64999999999999 57.6)"/><path d="M1401.43 420h200v74.12h-200z" stroke="#000" strokeLine truncated