From 04b44f40ba9f25fb47c469a5c341731d6e3b6905 Mon Sep 17 00:00:00 2001
From: Allan Bowe <>
Date: Sun, 20 Sep 2020 20:23:04 +0200
Subject: [PATCH] docs: updates to description of SASjsConfig items

---
 src/types/SASjsConfig.ts | 35 ++++++++++++++++++++++++++++++++---
 1 file changed, 32 insertions(+), 3 deletions(-)

diff --git a/src/types/SASjsConfig.ts b/src/types/SASjsConfig.ts
index 53c866a..f6cc02a 100644
--- a/src/types/SASjsConfig.ts
+++ b/src/types/SASjsConfig.ts
@@ -1,8 +1,8 @@
 import { ServerType } from './ServerType'
 
 /**
- * Specifies the configuration for the SASjs instance.
- *
+ * Specifies the configuration for the SASjs instance - eg where and how to 
+ * connect to SAS. 
  */
 export class SASjsConfig {
   /**
@@ -11,11 +11,24 @@ export class SASjsConfig {
    * streamed.
    */
   serverUrl: string = ''
+  /**
+   * The location of the Stored Process Web Application.  By default the adapter
+   * will use '/SASStoredProcess/do' on SAS 9.
+   */
   pathSAS9: string = ''
+  /**
+   * The location of the Job Execution Web Application.  By default the adapter
+   * will use '/SASJobExecution' on SAS Viya.
+   */
   pathSASViya: string = ''
   /**
    * The appLoc is the parent folder under which the SAS services (STPs or Job
-   * Execution Services) are stored.
+   * Execution Services) are stored.  We recommend that each app is stored in
+   * a dedicated parent folder (the appLoc) and the services are grouped inside
+   * subfolders within the appLoc - allowing functionality to be restricted
+   * according to those groups at backend.
+   * When using appLoc, the paths provided in the `request` function should be
+   * _without_ a leading slash (/).
    */
   appLoc: string = ''
   /**
@@ -26,6 +39,22 @@ export class SASjsConfig {
    * Set to `true` to enable additional debugging.
    */
   debug: boolean = true
+  /**
+   * The name of the compute context to use when calling the Viya APIs directly.
+   * Example value: 'SAS Job Execution compute context'
+   * If set to missing or empty, and useComputeApi is true, the adapter will use
+   * the JES APIs.  If provided, the Job Code will be executed in pooled 
+   * compute sessions on this named context.
+   */
   contextName: string = ''
+  /**
+   * Set to `false` to use the Job Execution Web Service.  To enhance VIYA
+   * performance, set to `true` and provide a `contextName` on which to run
+   * the code.  When running on a named context, the code executes under the
+   * user identity.  When running as a Job Execution service, the code runs
+   * under the identity in the JES context.  If no `contextName` is provided, 
+   * and `useComputeApi` is `true`, then the service will run as a Job, except
+   * triggered using the APIs instead of the Job Execution Web Service broker.
+   */
   useComputeApi = false
 }