chore(release): 1.1.1

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+<a name="1.1.1"></a>
+## [1.1.1](https://github.com/macropeople/dcdocs.github.io/compare/v1.1.0...v1.1.1) (2020-01-25)
+
+
+
 <a name="1.1.0"></a>
 # [1.1.0](https://github.com/macropeople/dcdocs.github.io/compare/v1.0.0...v1.1.0) (2019-01-26)
 

docs/dcc-groups.md

@@ -0,0 +1,4 @@
+# Data Controller for SAS® - Adding Groups
+
+## Overview
+By default, Data Controller will work with the SAS Groups defined in metadata.  It is also possible to define custom groups with Data Controller itself - to do this simply add the user and group name (and optionally, a group description) in the `DATACTRL.MPE_GROUPS` table.

docs/dcc-security.md

@@ -14,3 +14,27 @@ For guidance with adding SAS users, see [SAS Documentation](http://support.sas.c
 In order to surface a table to a new group, simply add a record to the `DATACTRL.MPE_SECURITY` table.  The `library.dataset` value should go in the `BASE_TABLE` field, the level of access (either _EDIT_ or _APPROVE_) should go in the `ACCESS_LEVEL` field, and the exact name of the relevant metadata group should go in the `SAS_GROUP` field.  The change should then be submitted, and approved, at which point the new security setting will be applied.
 
 ![Screenshot](img/securitytable.png)
+
+## EDIT vs APPROVE
+
+The `EDIT` permission determines which groups will be able to upload CSVs and submit changes via the web interface for that table.  The `APPROVE` permission determines which groups will be able to approve those changes, and hence enable the target table to be loaded.  If you wish to have members of a particular group both edit AND approve, then two lines (one for each group) must be entered, per table.
+
+
+## Determining Group Members
+
+Before adding a group to Data Controller, it helps to know the members of that group!  The following options are available:
+
+1 - Use SAS Management Console
+
+2- Use Code
+
+The "code" option can be performed as follows:
+
+```
+/* get macro library */
+filename mc url "https://raw.githubusercontent.com/macropeople/macrocore/master/macrocore.sas";
+%inc mc;
+/* call macro */
+%mm_getgroupmembers(YOURGROUPNAME)
+/* the above will create a dataset containing the group members */
+```

docs/dcc-tables.md

@@ -13,7 +13,7 @@ Adding tables to the Data Controller is a matter of configuration, specifically
 Each table to be edited in the Data Controller is represented by one record in `DATACTRL.MPE_TABLES`.  The fields should be populated as follows:
 
 ### LIBREF
-The libref of the table.  If not pre-assigned, DC will assign it at runtime using the first definition found in metadata, using this [macro](https://github.com/Boemska/macrocore/blob/master/meta/mm_assigndirectlib.sas).
+The libref of the table.  If not pre-assigned, DC will assign it at runtime using the first definition found in metadata, using this [macro](https://github.com/macropeople/macrocore/blob/master/meta/mm_assigndirectlib.sas).
 
 ### DSN
 The dataset (table) name as visible when assigning a direct libref connection to `LIBREF`.

docs/dci-evaluation.md

@@ -0,0 +1,53 @@
+# Data Controller for SAS® - Evaluation Version
+
+## Overview
+A free version of Data Controller is available for evaluation purposes. Compiled into a single SPK, it is very easy to install and configure.  However it must not be used in production environments for all the reasons mentioned in the [caveats](#caveats) section.
+
+<iframe src="https://player.vimeo.com/video/328175910" width="640" height="360" frameborder="0" allowfullscreen></iframe>
+
+## Installation
+
+### Deployment
+
+#### Import
+Simply import the SPK (using SAS Management Console or Data Integration Studio) to the desired location in the metadata tree.  During the import (step 5 of the wizard), be sure to change the location of the library (BASE engine) to a **directory folder** to which the Stored Process system account (eg `sassrv`) has **write access**.
+
+#### Permissions
+Be sure that the user account you will use in the [configuration(#Configuration) step below has WRITE METADATA (WM) on the `/DataController/Admin` and `/DataController/Data` folders, and that anyone who will use the app has READ.
+
+### Configuration
+
+Navigate to the web application (eg `https://[YOURHOST]/SASStoredProcess?_action=1063`) and find the location where the app was imported.  Then run the `/DataController/Admin/configurator` stored process.
+
+!!! note
+    Use the same user account as you used to import the SPK, to avoid metadata permissions issues!  This may mean logging out / logging back in to the web application.
+
+![evaltree](img/dci_evaltree.png)
+
+This displays a screen with a choice of SAS Metadata Groups (to which your account belongs) can be chosen. Selecting any of these groups will build / rebuild all the configuration tables (placing logs in a subfolder of the previously configured library location) and provide the chosen group with **unrestricted** access to the tool.
+
+![evaltree](img/dci_evalconfig.png)
+
+!!! note
+    "Unrestricted access" is provided by code logic.  Once installed, Data Controller does not ever update or modify metadata.  During installation, the services in the `/Admin` folder are updated (configuration) or removed (to prevent accidental reinstall).  Also the tables are registered in the `/Data` folder using `proc metalib`.
+
+## Usage
+
+Simply navigate to the imported location from the Stored Process Web App, right click on the 'clickme' stored process, and open in new window!
+
+![evaltree](img/dci_evallaunch.png)
+
+
+## Caveats
+
+The demo version has been optimised for a rapid install, and should not be considered for production / commercial use, or for use by more than 2-5 people, for the following reasons:
+
+1) Static content is compiled into SAS web services, which is inefficient (not scalable)
+
+2) Requires BASE engine for config tables, with high risk of table locks
+
+3) Not licenced for commercial (or production) use, and not supported
+
+4) The embedded HandsOnTable library is not licenced for commercial use without a licence key
+
+Contact Macro People support for a full-featured, fully licenced, scalable and supported deployment of Data Controller at your earliest convenience!

docs/dci-frontend.md

@@ -1,7 +1,7 @@
 # Data Controller for SAS® - Frontend Deployment
 
 ## Overview
-The Data Controller front end was built on the Angular seed app from Boemska AppFactory®.  As such it comes bundled with standard features such as log handling and SASLogon redirects.  It is deployed the the root of the SAS Web Server (mid-tier), typically `htdocs`.
+The Data Controller front end comes pre-built, and ready to deploy to the root of the SAS Web Server (mid-tier), typically `htdocs`.
 
 ## Instructions
 

docs/dci-troubleshooting.md

@@ -6,3 +6,45 @@
 ## Internet Explorer - blank screen
 If you have an older, or 'locked down' version of Internet Explorer you may get a blank / white screen when navigating to the Data Controller url.  To fix this, click settings (cog icon in top right), *Compatibility View settings*, and **uncheck** *Display intranet sites in Compatibility view* as follows:
 ![menu](img/dci-trouble1.png)
+
+## Workspace Server Type Only
+Data Controller requires the OS account to have disk write privileges for a number of reasons:
+
+* log capture
+* folder creation (initial setup)
+* table creation (demo version)
+* writing staging data (editors)
+* updating databases / datasets (approvers)
+
+On Viya, this is the default case.
+
+On SAS 9, if your Stored Process Shared Server account (typically `sassrv`) is unavailable, or overly restricted, you may need to use a Workspace Server account for your STPs.  This means that your Approvers must have the requisite access to perform the database updates.
+
+The imported version of Data Controller is set up to work with the Stored Process Server.  To switch this to Workspace Server, you can run the following code *after* importing the SPK:
+
+```
+/* get the macros (or download / %include seperately) */
+filename mc url "https://raw.githubusercontent.com/macropeople/macrocore/master/macrocore.sas";
+%inc mc;
+
+/* put the path to your Data Controller folder here */
+%let DCROOT=/YOUR/META/PATH/DataController;
+
+/* this will extract all the objects in that folder */
+%mm_getfoldertree(root=&dcroot, outds=stps)
+
+/* this creates the program to update all the STPs in that folder */
+filename tmp temp;
+data _null_;
+  set stps;
+  file tmp;
+  if publictype='StoredProcess' then do;
+  str=cats('%mm_updatestpservertype(target='
+   ,path,'/',name,',type=WKS)');
+  put str;
+  end;
+run;
+
+/* run the program */
+%inc tmp;
+```

docs/emails.md

@@ -0,0 +1,31 @@
+# Data Controller for SAS® - Emails
+
+## Overview
+Data Controller enables email alerts for users when tables are:
+
+* SUBMITTED - a proposed change has been submitted.
+* APPROVED - the proposed change was approved and applied.
+* REJECTED - the proposed change was rejected.
+
+Emails are sent after any post edit / post approve hooks.  They can be sent when specific tables are updated, or when any tables in a particular library are updated, or for all changes to all tables.  See configuration section below.
+
+Email addresses are looked for first in `DCXXXXXX.MPE_EMAILS`.  If they are not found there, then a metadata search is made (the first email found in metadata for that user is used).
+
+## Setup
+As not every site has emails configured, this feature is switched OFF by default.
+To switch it on, navigate to `DCXXXXXX.MPE_CONFIG` and set the value for `DC_EMAIL_ALERTS` to be `YES` (uppercase).
+
+![alerttable](img/mpe_alertconfig.png)
+
+!!! tip
+    If your Stored Process session does not have the email options configured, then the appropriate options statement must be invoked.  These options may need to be done at startup, or in the configuration file.  See [documentation](https://documentation.sas.com/?cdcId=pgmsascdc&cdcVersion=9.4_3.4&docsetId=lrcon&docsetTarget=n05iwqtqxzvtvun1eyw11nrd9i9r.htm&locale=en)
+
+## Configuration
+The `DCXXXXXX.MPE_ALERTS` table must be updated with the following attributes:
+
+* ALERT_EVENT - either `*ALL*`, `SUBMITTED`, `APPROVED` or `REJECTED`
+* ALERT_LIB - either `*ALL*` or the libref to be alerted on
+* ALERT_DS - either `*ALL*` or the dataset name to be alerted on
+* ALERT_USER - the metadata name (not displayname) of the user to be alerted
+
+If your site does not put emails in metadata, then the user emails must instead be entered in `DCXXXXXX.MPE_EMAILS`.

docs/evaluation-licence-agreement.md

@@ -0,0 +1,50 @@
+# Data Controller for SAS® Evaluation Agreement
+The terms and conditions contained below constitute a legal agreement. This agreement ("Agreement") contains herein the entire agreement between the licensee ("You") and Macro People Ltd ("Macro People Ltd"). Read this agreement carefully. By downloading, installing, and/or examining the product, you acknowledge:
+
+1 - You are authorized to enter this agreement for and on behalf of your company, and are doing so, and 2 - You have read, understand and agree that you and the company shall be bound by these terms and conditions and every modification and addition provided for.
+
+Software products included with this product that are not Macro People Ltd products are licensed to you by the software provider. Please refer to the license contained in the provider’s product for their terms of use.
+
+## 1. License Grant.
+Macro People Ltd grants you a limited, non-exclusive, non-transferable license to use, **for evaluation/non-production purposes only**, the Macro People Ltd software program(s) known as Data Controller for SAS® (the "Software") - and related product documentation - at no charge, subject to the terms and restrictions set forth in this License Agreement. You are not permitted to use the Software in any manner not expressly authorized by this License. You acknowledge and agree that ownership of the Software and all subsequent copies thereof regardless of the form or media are held by Macro People Ltd.
+
+## 2. Term of Agreement.
+Your license is effective until terminated by Macro People Ltd (at the sole discretion of Macro People Ltd and without notice). The License will terminate automatically if you fail to comply with any of the limitations or other requirements described herein. At termination you shall cease all use of the Software and destroy all copies, full or partial, of the Software.
+
+## 3. Ownership Rights.
+The Software and related documentation are protected by United Kingdom copyright laws and international treaties. Macro People Ltd, third party component providers and open source component providers own and retain all right, title and interest in and to the Software and related documentation, including all copyrights, patents, trade secret rights, trademarks and other intellectual property rights therein.
+
+## 4. Use of Name and Trademarks.
+You shall not use the name, trade names or trademarks of Macro People Ltd or any of its affiliates in any advertising, promotional literature or any other material, whether in written, electronic or other form, without prior approval.
+
+## 5. Restrictions
+5.1 - You may not rent, lease, lend, redistribute or sublicense the Software. You may not copy the Software other than to make archival or backup copies - provided that the backup copy includes all copyright or other proprietary notices contained on the original. You may not copy related product documentation. You may not modify, reverse engineer, decompile, or disassemble the Software, except to the extent the such restriction is expressly prohibited by applicable law.
+
+5.2 - Certain components of the Software are provided under various Open Source licenses that have been made available to Macro People Ltd. You may modify or replace only these Open-Sourced Components; provided that (i) the resultant Software is used in place of the unmodified Software, on a single computer; and (ii) you otherwise comply with the terms of this License and any applicable licensing terms governing use of the Open-Sourced Components. Macro People Ltd is not obligated to provide any maintenance, technical or other support for the resultant Software.
+
+## 6. Exclusion of Warranties.
+THE SOFTWARE IS PROVIDED TO LICENSEE “AS IS”, AND ANY USE BY LICENSEE OF THE SOFTWARE WILL BE AT LICENSEE’S SOLE RISK. Macro People Ltd makes no warrranties relating to the softwtare, and disclaims all warranties (express or implied), including without limitation those of merchantability and fitness for any particular purpose.
+
+## 7. Limitation of Liability.
+In no event shall Macro People Ltd be liable for any incidental, special, indirect or consequential damages whatsoever, including, without limitation, damages for loss of profits, loss of data, business interrupton or any other commercial damages or losses, arising out of or related to your use or inability to use the Macro People Ltd software, however caused, regardless of the theory of liabilty (contract, tort or otherwise) and even if Macro People Ltd has been advised of the possibility of such damages.
+
+## 8. Governing law and jurisdiction
+8.1 - This agreement and any disputes or claims arising out of or in connection with its subject matter are governed by and construed in accordance with the law of England.
+
+8.2 - The parties irrevocably agree that the courts of England have exclusive jurisdiction to settle any dispute or claim that arises out of or in connection with this agreement.
+
+
+## 9. Assignment/Transfers.
+You may not assign or transfer this Agreement, in whole or in part, without the prior written consent of Macro People Ltd. Any attempted assignment or transfer in violation of this Section will be null and void.
+
+## 10.Third Party Acknowledgements
+
+(A) Aspects of the Software utilize or include third party software and other copyrighted material. Acknowledgements, licensing terms and disclaimers for such material are available when accessing the Software on the Macro People Ltd website, and your use of such material is governed by their respective terms.
+
+(B) The Software includes certain software provided under various Open Source licenses. You may obtain complete machine-readable copies of the source code and licenses for the Open Source software at the Macro People Ltd Open Source website (https://docs.datacontroller.io/licenses). Open Source Software is distributed WITHOUT ANY WARRANTY, without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
+
+## 11. Severability.
+If any provision of this Agreement is held invalid, illegal or unenforceable, the validity, legality and enforceability of any of the remaining provisions of this Agreement shall not in any way be affected or impaired.
+
+## 12. Entire Agreement.
+This Agreement is the entire agreement between you and Macro People Ltd concerning the Software and all related documentation and supersedes any other prior or contemporaneous agreements or communications with respect to the Software and related documentation, either written or oral.

docs/img/datacontroller.svg

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 22.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 2000 520.7" style="enable-background:new 0 0 2000 520.7;" xml:space="preserve">
+<style type="text/css">
+	.st0{fill:#E0E0E0;}
+	.st1{fill:#8EC63F;}
+	.st2{font-family:'APompadourBoldSample';}
+	.st3{font-size:205.7454px;}
+	.st4{letter-spacing:5;}
+</style>
+<path class="st0" d="M321.9,198.2c3.3,0.4,6.5,0.7,9.8,1.1c7.9,1.1,15.6,2.6,22.8,6.3c2.1,1.1,4.1,2.3,5.6,4.2
+	c2.4,2.8,2.3,5.8-0.1,8.6c-2.5,2.8-5.7,4.4-9.1,5.7c-7.9,3.1-16.2,4.5-24.6,5.2c-13.7,1.1-27.2,0.6-40.6-2.6
+	c-4.4-1-8.7-2.4-12.6-4.6c-1.5-0.8-2.9-1.8-4.2-3c-3.6-3.5-3.6-7.2,0.1-10.5c4-3.6,8.9-5.3,13.9-6.7c7-2,14.1-3,21.3-3.5
+	c0.6,0,1.3,0.2,1.8-0.3C311.2,198.2,316.6,198.2,321.9,198.2z"/>
+<path class="st1" d="M266.2,280.3c6.4,8.2,15.5,11.2,24.9,13.2c18.6,4,37.2,3.5,55.3-2.9c5.6-2,10.8-4.7,14.5-9.7
+	c0.6-0.8,0.9-0.4,1.2,0.2c0.6,1.3,0.9,2.6,0.9,4c0,4.9,0,9.9,0,14.8c0,3.2-1.5,5.7-3.7,7.9c-4.6,4.6-10.4,7.1-16.5,9
+	c-12.3,3.8-24.9,4.6-37.6,3.7c-9.5-0.7-18.7-2.5-27.4-6.4c-3.7-1.7-7.1-3.7-9.8-6.8c-2.1-2.4-3.2-5.1-3.2-8.3c0.1-4.5,0-9,0-13.5
+	C264.8,283.7,265.1,282,266.2,280.3z"/>
+<path class="st0" d="M266.3,249.4c5.3,7.1,12.7,10.1,20.6,12.2c18.9,5,37.8,4.9,56.5-0.7c6.2-1.8,12-4.5,16.5-9.4
+	c0.6-0.6,1-2,1.7-1.8c1,0.3,1,1.7,1.3,2.8c0.4,1.7,0.2,3.4,0.2,5.1c0,3.4-0.1,6.7,0,10.1c0.2,4.2-1.5,7.5-4.6,10.2
+	c-4.7,4.2-10.4,6.7-16.5,8.3c-20.5,5.5-40.9,5.4-61-1.6c-4.9-1.7-9.4-4.1-13-8c-2.2-2.4-3.3-5.2-3.3-8.5c0.1-4.4,0-8.9,0-13.3
+	C264.8,253,265.1,251.2,266.3,249.4z"/>
+<path class="st1" d="M266.1,219.7c1.5,4.4,5.1,6.4,8.9,8.2c6.8,3.2,14.1,4.7,21.4,5.6c14.5,1.8,29,1.6,43.3-1.4
+	c5.8-1.2,11.4-2.8,16.5-6c2.9-1.8,4.4-3.5,5.4-6.3c1,1.4,1.3,2.9,1.3,4.4c0,5,0.1,9.9,0,14.9c-0.1,4.2-2.5,7.2-5.6,9.7
+	c-5.8,4.6-12.6,7-19.7,8.6c-18.8,4.1-37.4,3.8-55.7-2.4c-4.8-1.6-9.4-3.9-13.1-7.5c-2.8-2.7-4.3-5.8-4.2-9.8c0.1-4.3,0-8.6,0-12.9
+	C264.8,222.9,265.1,221.3,266.1,219.7z"/>
+<path class="st0" d="M380.9,353.9c16.3,0.9,25-19.1,13.2-30.4c-12.4-11.9-32.8-0.8-29.6,16c-73.7,47-168.5-23.3-141.5-108.7
+	l-18.2-12.2C163.9,327.3,289.8,419.2,380.9,353.9z M375.7,330.4c7.6-7.9,19.7,3.1,12.6,11.4C380.8,350.5,367.6,338.8,375.7,330.4z"
+	/>
+<path class="st1" d="M232.2,193.7c11.7,11.2,31,2,29.9-14c73.6-47.4,168.9,22.8,141.9,108.5l18.2,12.2
+	c39.7-105.6-80.8-200.7-174-136.8C230.7,160,219.4,181.4,232.2,193.7z M250.6,186.8c-7.8,8.1-20.1-3.7-12.3-11.8
+	C246.1,166.9,258.4,178.7,250.6,186.8z"/>
+<text transform="matrix(1 0 0 1 500.2032 330.8743)"><tspan x="0" y="0" class="st0 st2 st3 st4">Data</tspan><tspan x="463.1" y="0" class="st1 st2 st3 st4">Controller</tspan></text>
+</svg>

mkdocs.yml

@@ -10,11 +10,17 @@ pages:
     - Security: dcc-security.md
     - Selectboxes: dcc-selectbox.md
     - Dates / Datetimes: dcc-dates.md
+    - Emails: emails.md
+    - Groups: groups.md
 - Installing Data Controller:
     - System Requirements: dci-requirements.md
     - Backend: dci-backend.md
     - Frontend: dci-frontend.md
     - Troubleshooting: dci-troubleshooting.md
+- Evaluation (Demo) Version:
+    - Installation: dci-evaluation.md
+    - Evaluation Licence: evaluation-licence-agreement.md
+    - Other Licences: licences.md
 
 markdown_extensions:
   - admonition
@@ -41,4 +47,4 @@ theme:
     code: 'Ubuntu Mono'
   favicon: img/favicon.ico
   custom_dir: 'theme'
-copyright: All rights reserved ©2018 Macro People Ltd.
+copyright: All rights reserved ©2020 Macro People Ltd.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "dcdocs",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dcdocs",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Documentation repo for Data Controller",
   "main": "index.js",
   "directories": {