add org_id in docs

open-metadata · Sep 19, 2024 · b24d5c9 · b24d5c9
1 parent ec98272
commit b24d5c9
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 17 deletions.
diff --git a/ingestion/src/metadata/ingestion/source/database/salesforce/connection.py b/ingestion/src/metadata/ingestion/source/database/salesforce/connection.py
@@ -26,7 +26,7 @@
 from metadata.ingestion.ometa.ometa_api import OpenMetadata
 
 
-def get_connection(connection: SalesforceConnection):
+def get_connection(connection: SalesforceConnection) -> Salesforce:
  """
  Create connection
  """

diff --git a/openmetadata-docs/content/v1.5.x/connectors/database/salesforce/index.md b/openmetadata-docs/content/v1.5.x/connectors/database/salesforce/index.md
@@ -49,6 +49,7 @@ These are the permissions you will require to fetch the metadata from Salesforce
 - **Username**: Username to connect to the Salesforce. This user should have the access as defined in requirements.
 - **Password**: Password to connect to Salesforce.
 - **Security Token**: Salesforce Security Token is required to access the metadata through APIs. You can checkout [this doc](https://help.salesforce.com/s/articleView?id=sf.user_security_token.htm&type=5) on how to get the security token.
+- **Organization ID**: Salesforce Organization ID is the unique identifier for your Salesforce identity. You can check out [this doc](https://help.salesforce.com/s/articleView?id=000385215&type=1) on how to get the your Salesforce Organization ID.
 - **Salesforce Object Name**: Specify the Salesforce Object Name in case you want to ingest a specific object. If left blank, we will ingest all the Objects.
 - **Salesforce API Version**: Follow the steps mentioned [here](https://help.salesforce.com/s/articleView?id=000386929&type=1) to get the API version. Enter the numerical value in the field, For example `42.0`.
 - **Salesforce Domain**: When connecting to Salesforce, you can specify the domain to use for accessing the platform. The common domains include `login` and `test`, and you can also utilize Salesforce My Domain.

diff --git a/openmetadata-docs/content/v1.5.x/connectors/database/salesforce/yaml.md b/openmetadata-docs/content/v1.5.x/connectors/database/salesforce/yaml.md
@@ -83,18 +83,24 @@ This is a sample config for Salesforce:
 
 {% codeInfo srNumber=5 %}
 
-**sobjectName**: Specify the Salesforce Object Name in case you want to ingest a specific object. If left blank, we will ingest all the Objects.
+**Organization ID**: Salesforce Organization ID is the unique identifier for your Salesforce identity. You can check out [this doc](https://help.salesforce.com/s/articleView?id=000385215&type=1) on how to get the your Salesforce Organization ID.
 
 {% /codeInfo %}
 
 {% codeInfo srNumber=6 %}
 
-**salesforceApiVersion**: Follow the steps mentioned [here](https://help.salesforce.com/s/articleView?id=000386929&type=1) to get the API version. Enter the numerical value in the field, For example `42.0`.
+**sobjectName**: Specify the Salesforce Object Name in case you want to ingest a specific object. If left blank, we will ingest all the Objects.
 
 {% /codeInfo %}
 
 {% codeInfo srNumber=7 %}
 
+**salesforceApiVersion**: Follow the steps mentioned [here](https://help.salesforce.com/s/articleView?id=000386929&type=1) to get the API version. Enter the numerical value in the field, For example `42.0`.
+
+{% /codeInfo %}
+
+{% codeInfo srNumber=8 %}
+
 **salesforceDomain**: When connecting to Salesforce, you can specify the domain to use for accessing the platform. The common domains include `login` and `test`, and you can also utilize Salesforce My Domain.
 By default, the domain `login` is used for accessing Salesforce.
 
@@ -108,13 +114,13 @@ By default, the domain `login` is used for accessing Salesforce.
 
 #### Advanced Configuration
 
-{% codeInfo srNumber=8 %}
+{% codeInfo srNumber=9 %}
 
 **Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.
 
 {% /codeInfo %}
 
-{% codeInfo srNumber=9 %}
+{% codeInfo srNumber=10 %}
 
 **Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to database during the connection. These details must be added as Key-Value pairs.
 
@@ -144,19 +150,22 @@ source:
  securityToken: securityToken
 ```
 ```yaml {% srNumber=5 %}
- sobjectName: sobjectName
+ organizationId: organizationId
 ```
 ```yaml {% srNumber=6 %}
- salesforceApiVersion: 42.0
+ sobjectName: sobjectName
 ```
 ```yaml {% srNumber=7 %}
- salesforceDomain: login
+ salesforceApiVersion: 42.0
 ```
 ```yaml {% srNumber=8 %}
+ salesforceDomain: login
+```
+```yaml {% srNumber=9 %}
  # connectionOptions:
  # key: value
 ```
-```yaml {% srNumber=9 %}
+```yaml {% srNumber=10 %}
  # connectionArguments:
  # key: value
 ```

diff --git a/...a-standard/schemas/entity/services/connections/database/salesforceConnection.md b/...a-standard/schemas/entity/services/connections/database/salesforceConnection.md
@@ -13,6 +13,7 @@ slug: /main-concepts/metadata-standard/schemas/entity/services/connections/datab
 - **`username`** *(string)*: Username to connect to the Salesforce. This user should have privileges to read all the metadata in Redshift.
 - **`password`** *(string)*: Password to connect to the Salesforce.
 - **`securityToken`** *(string)*: Salesforce Security Token.
+- **`organizationId`** *(string)*: Salesforce Organization ID.
 - **`sobjectName`** *(string)*: Salesforce Object Name.
 - **`databaseName`** *(string)*: Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.
 - **`salesforceApiVersion`** *(string)*: API version of the Salesforce instance. Default: `42.0`.

diff --git a/openmetadata-docs/content/v1.6.x-SNAPSHOT/connectors/database/salesforce/index.md b/openmetadata-docs/content/v1.6.x-SNAPSHOT/connectors/database/salesforce/index.md
@@ -49,6 +49,7 @@ These are the permissions you will require to fetch the metadata from Salesforce
 - **Username**: Username to connect to the Salesforce. This user should have the access as defined in requirements.
 - **Password**: Password to connect to Salesforce.
 - **Security Token**: Salesforce Security Token is required to access the metadata through APIs. You can checkout [this doc](https://help.salesforce.com/s/articleView?id=sf.user_security_token.htm&type=5) on how to get the security token.
+- **Organization ID**: Salesforce Organization ID is the unique identifier for your Salesforce identity. You can check out [this doc](https://help.salesforce.com/s/articleView?id=000385215&type=1) on how to get the your Salesforce Organization ID.
 - **Salesforce Object Name**: Specify the Salesforce Object Name in case you want to ingest a specific object. If left blank, we will ingest all the Objects.
 - **Salesforce API Version**: Follow the steps mentioned [here](https://help.salesforce.com/s/articleView?id=000386929&type=1) to get the API version. Enter the numerical value in the field, For example `42.0`.
 - **Salesforce Domain**: When connecting to Salesforce, you can specify the domain to use for accessing the platform. The common domains include `login` and `test`, and you can also utilize Salesforce My Domain.

diff --git a/openmetadata-docs/content/v1.6.x-SNAPSHOT/connectors/database/salesforce/yaml.md b/openmetadata-docs/content/v1.6.x-SNAPSHOT/connectors/database/salesforce/yaml.md
@@ -83,18 +83,24 @@ This is a sample config for Salesforce:
 
 {% codeInfo srNumber=5 %}
 
-**sobjectName**: Specify the Salesforce Object Name in case you want to ingest a specific object. If left blank, we will ingest all the Objects.
+**Organization ID**: Salesforce Organization ID is the unique identifier for your Salesforce identity. You can check out [this doc](https://help.salesforce.com/s/articleView?id=000385215&type=1) on how to get the your Salesforce Organization ID.
 
 {% /codeInfo %}
 
 {% codeInfo srNumber=6 %}
 
-**salesforceApiVersion**: Follow the steps mentioned [here](https://help.salesforce.com/s/articleView?id=000386929&type=1) to get the API version. Enter the numerical value in the field, For example `42.0`.
+**sobjectName**: Specify the Salesforce Object Name in case you want to ingest a specific object. If left blank, we will ingest all the Objects.
 
 {% /codeInfo %}
 
 {% codeInfo srNumber=7 %}
 
+**salesforceApiVersion**: Follow the steps mentioned [here](https://help.salesforce.com/s/articleView?id=000386929&type=1) to get the API version. Enter the numerical value in the field, For example `42.0`.
+
+{% /codeInfo %}
+
+{% codeInfo srNumber=8 %}
+
 **salesforceDomain**: When connecting to Salesforce, you can specify the domain to use for accessing the platform. The common domains include `login` and `test`, and you can also utilize Salesforce My Domain.
 By default, the domain `login` is used for accessing Salesforce.
 
@@ -108,13 +114,13 @@ By default, the domain `login` is used for accessing Salesforce.
 
 #### Advanced Configuration
 
-{% codeInfo srNumber=8 %}
+{% codeInfo srNumber=9 %}
 
 **Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.
 
 {% /codeInfo %}
 
-{% codeInfo srNumber=9 %}
+{% codeInfo srNumber=10 %}
 
 **Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to database during the connection. These details must be added as Key-Value pairs.
 
@@ -144,19 +150,22 @@ source:
  securityToken: securityToken
 ```
 ```yaml {% srNumber=5 %}
- sobjectName: sobjectName
+ organizationId: organizationId
 ```
 ```yaml {% srNumber=6 %}
- salesforceApiVersion: 42.0
+ sobjectName: sobjectName
 ```
 ```yaml {% srNumber=7 %}
- salesforceDomain: login
+ salesforceApiVersion: 42.0
 ```
 ```yaml {% srNumber=8 %}
+ salesforceDomain: login
+```
+```yaml {% srNumber=9 %}
  # connectionOptions:
  # key: value
 ```
-```yaml {% srNumber=9 %}
+```yaml {% srNumber=10 %}
  # connectionArguments:
  # key: value
 ```

diff --git a/...a-standard/schemas/entity/services/connections/database/salesforceConnection.md b/...a-standard/schemas/entity/services/connections/database/salesforceConnection.md
@@ -13,6 +13,7 @@ slug: /main-concepts/metadata-standard/schemas/entity/services/connections/datab
 - **`username`** *(string)*: Username to connect to the Salesforce. This user should have privileges to read all the metadata in Redshift.
 - **`password`** *(string)*: Password to connect to the Salesforce.
 - **`securityToken`** *(string)*: Salesforce Security Token.
+- **`organizationId`** *(string)*: Salesforce Organization ID.
 - **`sobjectName`** *(string)*: Salesforce Object Name.
 - **`databaseName`** *(string)*: Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.
 - **`salesforceApiVersion`** *(string)*: API version of the Salesforce instance. Default: `42.0`.

diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Salesforce.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Database/Salesforce.md
@@ -32,6 +32,12 @@ $$section
 Salesforce Security Token is required to access the metadata through APIs. You can check out [this doc](https://help.salesforce.com/s/articleView?id=sf.user_security_token.htm&type=5) on how to get the security token.
 $$
 
+$$section
+### Organization ID $(id="organizationId")
+
+Salesforce Organization ID is the unique identifier for your Salesforce identity. You can check out [this doc](https://help.salesforce.com/s/articleView?id=000385215&type=1) on how to get the your Salesforce Organization ID.
+$$
+
 $$section
 ### Object Name $(id="sobjectName")