dc/docs.datacontroller.io
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: licence updates

Browse Source
This commit is contained in:
Allan Bowe 2020-01-25 20:42:02 +01:00
parent c81fb2dfd5
commit d235cbb6c3
4 changed files with 8656 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/dci-evaluation.md
View File

@ -3,25 +3,33 @@
## 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
Simply import the SPK 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 which the Stored Process system account (sassrv) has write access to. Also, make sure that your user account has WRITE METADATA (WM) on the imported Data Controller DATA folder, and that anyone who will use the app has READ.
#### 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 [YOURHOST]/SASStoredProcess web application and 'list available stored processes'. Find the location where the app was imported, open the Admin subfolder and run the 'configurator' stored process.
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 urestricted access to the tool.
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. Data Controller does not update or modify any metadata, except the `[YOURHOST/PATH]/Admin/Data_Controller_Settings` Stored Process (in which the the aforementioned logic is applied).
"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

42
docs/dci-troubleshooting.md
View File

@ -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;
```

51
docs/evaluation-licence-agreement.md Normal file
View File

@ -0,0 +1,51 @@
# Data Controller for SAS® Evaluation Agreement
THE TERMS AND CONDITIONS CONTAINED BELOW CONSTITUTE A LEGAL AGREEMENT. THIS AGREEMENT ("AGREEMENT") CONTAINS THE ENTIRE AGREEMENT BETWEEN THE LICENSEE ("YOU") AND MACRO PEOPLE LTD ("MACRO PEOPLE LTD") WITH REGARD TO THE TERMS AND CONDITIONS DESCRIBED BELOW. 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 Kony. 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.

8550
docs/licences.md Normal file
View File

File diff suppressed because it is too large Load Diff