Merge pull request #17 from cloudsufi/feature/mdFiles

Md Files
cloudsufi · Jun 6, 2023 · 04b9bcf · 04b9bcf
2 parents 1a9aa84 + cb52c07
commit 04b9bcf
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 42 deletions.
diff --git a/docs/SuccessFactors-batchsource.md b/docs/SuccessFactors-batchsource.md
@@ -4,22 +4,25 @@ The SuccessFactors Batch Source plugin enables bulk data integration from Succes
 platform. You can configure and execute bulk data transfers from SuccessFactors Entities without any coding.
 
 ## Properties
-You can configure the following properties for the SuccessFactors.
+You can configure the following properties for the SAP SuccessFactors.
 
 **Note**: The following indicators are used to define the fields:  
 **M** - Indicates Macros are supported for the respective field  
 **O** - Optional field
 
 ## Basic
 **Reference Name:** Name used to uniquely identify this source for lineage,
-annotating metadata, etc.
-**SAP SuccessFactors Base URL (M)**: SAP SuccessFactors Base URL.
+annotating metadata, etc.  
 **Entity Name (M)**: Name of the Entity to be extracted.
 
-## Credentials
-
+## Connection
+**Use Connection:** Whether to use a connection. If a connection is used, you do not need to provide the credentials.  
+**Connection:** Name of the connection to use. Entity Names information will be provided by the connection.
+You also can use the macro function ${conn(connection-name)}.  
 **SAP SuccessFactors Logon Username (M)**: SAP SuccessFactors Logon Username for user authentication.  
-**SAP SuccessFactors Logon Password (M)**: SAP SuccessFactors Logon password for user authentication.
+**SAP SuccessFactors Logon Password (M)**: SAP SuccessFactors Logon password for user authentication.  
+**SAP SuccessFactors Base URL (M)**: SAP SuccessFactors Base URL.  
+
 
 ## Advance Option:
 

diff --git a/docs/SuccessFactors-connector.md b/docs/SuccessFactors-connector.md
@@ -0,0 +1,23 @@
+# SAP SuccessFactors Connection
+
+Description
+-----------
+Use this connection to access data in SAP SuccessFactors.
+
+Properties
+----------
+**Name:** Name of the connection. Connection names must be unique in a namespace.
+
+**Description:** Description of the connection.
+
+**SAP SuccessFactors Logon Username (M)**: SAP SuccessFactors Logon Username for user authentication.  
+
+**SAP SuccessFactors Logon Password (M)**: SAP SuccessFactors Logon password for user authentication.
+
+**SAP SuccessFactors Base URL (M)**: SAP SuccessFactors Base URL.
+
+
+Path of the connection
+----------------------
+To browse, get a sample from, or get the specification for this connection.  
+/{entity} This path indicates a SuccessFactors entity. A entity is the only one that can be sampled.
diff --git a/widgets/SuccessFactors-batchsource.json b/widgets/SuccessFactors-batchsource.json
@@ -4,42 +4,6 @@
   },
   "display-name": "SAP SuccessFactors",
   "configuration-groups": [
-    {
-      "label": "Basic",
-      "properties": [
-        {
-          "widget-type": "textbox",
-          "label": "Reference Name",
-          "name": "referenceName",
-          "widget-attributes": {
-            "placeholder": "Used to uniquely identify this source for lineage, annotating metadata etc."
-          }
-        },
-        {
-          "widget-type": "textbox",
-          "label": "Entity Name",
-          "name": "entityName",
-          "widget-attributes": {
-            "placeholder": "SAP SuccessFactors Entity name. For example, People"
-          },
-
-          "plugin-function": {
-            "method": "POST",
-            "widget": "outputSchema",
-            "plugin-method": "getSchema"
-          }
-        },
-        {
-          "label": "browse",
-          "widget-type": "connection-browser",
-          "widget-category": "plugin",
-          "widget-attributes": {
-            "connectionType": " SUCCESSFACTORS",
-            "label": "Browse"
-          }
-        }
-      ]
-    },
     {
       "label": "Connection",
       "properties": [
@@ -93,6 +57,42 @@
         }
       ]
     },
+    {
+      "label": "Basic",
+      "properties": [
+        {
+          "widget-type": "textbox",
+          "label": "Reference Name",
+          "name": "referenceName",
+          "widget-attributes": {
+            "placeholder": "Used to uniquely identify this source for lineage, annotating metadata etc."
+          }
+        },
+        {
+          "label": "browse",
+          "widget-type": "connection-browser",
+          "widget-category": "plugin",
+          "widget-attributes": {
+            "connectionType": " SUCCESSFACTORS",
+            "label": "Browse"
+          }
+        },
+        {
+          "widget-type": "textbox",
+          "label": "Entity Name",
+          "name": "entityName",
+          "widget-attributes": {
+            "placeholder": "SAP SuccessFactors Entity name. For example, People"
+          },
+
+          "plugin-function": {
+            "method": "POST",
+            "widget": "outputSchema",
+            "plugin-method": "getSchema"
+          }
+        }
+      ]
+    },
     {
       "label": "Advanced",
       "properties": [