From cb52c07b4bc3124f25a274c658d107c66b3bc574 Mon Sep 17 00:00:00 2001 From: Shubhangi-cs Date: Fri, 3 Mar 2023 10:30:36 +0530 Subject: [PATCH] Md Files --- docs/SuccessFactors-batchsource.md | 15 +++--- docs/SuccessFactors-connector.md | 23 ++++++++ widgets/SuccessFactors-batchsource.json | 72 ++++++++++++------------- 3 files changed, 68 insertions(+), 42 deletions(-) create mode 100644 docs/SuccessFactors-connector.md diff --git a/docs/SuccessFactors-batchsource.md b/docs/SuccessFactors-batchsource.md index 4c52e7f..27966f1 100644 --- a/docs/SuccessFactors-batchsource.md +++ b/docs/SuccessFactors-batchsource.md @@ -4,7 +4,7 @@ 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 @@ -12,14 +12,17 @@ You can configure the following properties for the SuccessFactors. ## 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 new file mode 100644 index 0000000..3430674 --- /dev/null +++ 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. \ No newline at end of file diff --git a/widgets/SuccessFactors-batchsource.json b/widgets/SuccessFactors-batchsource.json index ec36453..b7efdc1 100644 --- 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": [