Skip to content

Commit 3368552

Browse files
kyuan-mongodbkyuan-mongodb
authored
DOCSP-42977 bic nested components
2 parents 4c59716 + 84a6d63 commit 3368552

31 files changed

+985
-723
lines changed

‎source/includes/auth-mechanisms-example.rst

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,37 @@
44
- id: uidpwd
55
content: |
66

7-
.. example::
7+
For example, to authenticate as user ``grace`` using the ``admin``
8+
database and the Challenge and
9+
Response (``SCRAM-SHA-1``) authentication mechanism, write
10+
the username in this format:
811

9-
To authenticate as user ``grace`` using the ``admin``
10-
database and the Challenge and
11-
Response (``SCRAM-SHA-1``) authentication mechanism, write
12-
the username in this format:
12+
.. code-block:: none
1313
14-
.. code-block:: none
15-
16-
grace?source=admin
14+
grace?source=admin
1715
1816
- id: ldap
1917
content: |
2018

21-
.. example::
22-
23-
To authenticate as user ``grace`` with the |ldap|
24-
(``PLAIN``) authentication mechanism, write the
25-
username in this format:
19+
For example, to authenticate as user ``grace`` with the |ldap|
20+
(``PLAIN``) authentication mechanism, write the
21+
username in this format:
2622

27-
.. code-block:: none
23+
.. code-block:: none
2824
29-
grace?mechanism=PLAIN&source=$external
25+
grace?mechanism=PLAIN&source=$external
3026
3127
- id: kerberos
3228
content: |
3329

34-
.. example::
35-
36-
To authenticate as user ``grace`` on the ``EXAMPLE.COM``
37-
`Kerberos realm <https://web.mit.edu/kerberos/krb5-latest/doc/admin/realm_config.html>`__
38-
with the Kerberos authentication mechanism, write the
39-
username in this format:
30+
For example, to authenticate as user ``grace`` on the ``EXAMPLE.COM``
31+
`Kerberos realm <https://web.mit.edu/kerberos/krb5-latest/doc/admin/realm_config.html>`__
32+
with the Kerberos authentication mechanism, write the
33+
username in this format:
4034

41-
.. code-block:: none
35+
.. code-block:: none
4236
43-
[email protected]?mechanism=GSSAPI&source=$external
37+
[email protected]?mechanism=GSSAPI&source=$external
4438
4539
For more information about Kerberos configuration, see
4640
:doc:`/tutorial/kerberos`.

‎source/includes/auth-options.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,4 @@ username as URI-style query parameters:
3939
Not required if :setting:`~security.defaultMechanism` is set in your
4040
|bi| :ref:`configuration file <config-format>`.
4141

42-
.. note::
43-
X.509 is not supported.
42+
**X.509 is not supported.**

‎source/includes/fact-geospatial-views.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
1-
.. note::
2-
3-
|bi-short| does not recognize geospatial fields
4-
when reading from a :ref:`view <schema-with-views>`.
1+
|bi-short| does not recognize geospatial fields
2+
when reading from a :ref:`view <schema-with-views>`.

‎source/includes/odbc-manager-keywords.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
a. Add a keyword value pair by clicking the :guilabel:`Add` button.
1+
i. Add a keyword value pair by clicking the :guilabel:`Add` button.
22

33
#. Modify the :guilabel:`Keyword` by double-clicking on it, entering
44
the desired keyword, then pressing enter.

‎source/includes/steps-connect-tableau-mongosql-plugin-macos.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ content: |
1616
is required. To create a system DSN, follow the steps below:
1717
1818
19-
.. include:: /includes/steps/create-system-dsn-auth-macos.rst
19+
.. include:: /includes/steps-create-system-dsn-auth-macos.rst
2020
---
2121
ref: start-tableau-macos
2222
level: 4

‎source/includes/steps-connect-tableau-mongosql-plugin-windows.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ content: |
1717
:abbr:`DSN (Data Source Name)` configured to use the {+odbc-driver+}
1818
is required. To create a system DSN, follow the steps below:
1919
20-
.. include:: /includes/steps/create-system-dsn-auth.rst
20+
.. include:: /includes/steps-create-system-dsn-auth.rst
2121
2222
---
2323
ref: start-tableau-windows

‎source/includes/steps-connect-tableau-mongosql-ssl-macos.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ content: |
1414
:abbr:`DSN (Data Source Name)` configured to use the {+odbc-driver+}
1515
is required. To create a system DSN, follow the steps below:
1616
17-
.. include:: /includes/steps/create-system-dsn-auth-ssl-macos.rst
17+
.. include:: /includes/steps-create-system-dsn-auth-ssl-macos.rst
1818
---
1919
ref: start-tableau-ssl-macos
2020
level: 4

‎source/includes/steps-connect-tableau-mongosql-ssl-windows.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ content: |
1616
:abbr:`DSN (Data Source Name)` configured to use the {+odbc-driver+}
1717
is required. To create a system DSN, follow the steps below:
1818
19-
.. include:: /includes/steps/create-system-dsn-auth-ssl.rst
19+
.. include:: /includes/steps-create-system-dsn-lettered.rst
2020
2121
---
2222
ref: start-tableau-windows

‎source/includes/steps-connect-tableau-without-auth-macos.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ content: |
1515
:abbr:`DSN (Data Source Name)` configured to use the {+odbc-driver+}
1616
is required. To create a system DSN, follow the steps below:
1717
18-
.. include:: /includes/steps/create-system-dsn-no-auth-macos.rst
18+
.. include:: /includes/steps-create-system-dsn-no-auth-macos.rst
1919
---
2020
title: Start Tableau.
2121
ref: start-tdc-no-auth-macos

‎source/includes/steps-connect-tableau-without-auth-windows.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ content: |
1616
:abbr:`DSN (Data Source Name)` configured to use the {+odbc-driver+}
1717
is required. To create a system DSN, follow the steps below:
1818
19-
.. include:: /includes/steps/create-system-dsn-no-auth.rst
19+
.. include:: /includes/steps-create-system-dsn-no-auth.rst
2020
---
2121
title: Start Tableau.
2222
ref: start-tdc-no-auth-windows

‎source/includes/steps-create-system-dsn-auth-macos.rst

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
a. Launch ODBC Manager.
2+
3+
.. note::
4+
5+
ODBC Manager is included with the |odbc-driver-name|.
6+
7+
.. include:: /includes/temp-warn-odbc-catalina.rst
8+
9+
#. Click :guilabel:`System DSN`, then click :guilabel:`Add`.
10+
11+
.. figure:: /images/bi-connector/odbc-manager.png
12+
:alt: ODBC Manager DSN configuration
13+
:align: center
14+
15+
#. Select a |odbc-driver-name| from the list of available drivers.
16+
17+
Select either the :guilabel:`MongoDB ANSI ODBC` driver or the
18+
:guilabel:`MongoDB Unicode ODBC` driver, then click :guilabel:`OK`.
19+
20+
.. include:: /includes/fact-ansi-unicode-driver.rst
21+
22+
#. Enter a :guilabel:`Data Source Name (DSN)`.
23+
24+
Optionally enter a :guilabel:`Description`.
25+
26+
.. note::
27+
28+
Do not close the setup window. Proceed to the next step.
29+
30+
#. Add the necessary keywords.
31+
32+
.. include:: /includes/odbc-manager-keywords.rst
33+
34+
Using the procedure above, add the following keywords:
35+
36+
.. list-table::
37+
:widths: 50 50
38+
:header-rows: 1
39+
40+
* - Keyword
41+
- Value
42+
43+
* - **SERVER**
44+
- The hostname or IP address of the |bi| host.
45+
46+
.. important::
47+
48+
Use ``127.0.0.1`` to connect via TCP to localhost.
49+
Specifying a value other than an IP address, will attempt to
50+
connect via Unix socket.
51+
52+
* - **PORT**
53+
- The :abbr:`IANA (Internet Assigned Numbers Authority)`
54+
`port number <https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml>`_
55+
for the |bi|. The default is ``3307``.
56+
57+
* - **DATABASE**
58+
- The database to use after connecting.
59+
60+
**You must use this keyword when connecting with Microsoft Excel.**
61+
62+
.. include:: /includes/fact-odbc-parameters.rst
63+
64+
For example, your user DSN configuration should look similar to
65+
the following:
66+
67+
.. figure:: /images/bi-connector/odbc-manager-dsn-config.png
68+
:alt: ODBC Manager DSN configuration
69+
:align: center
70+
71+
.. note::
72+
73+
Do not close the setup window. Proceed to the next step.
74+
75+
#. Add the authentication keywords.
76+
77+
.. include:: /includes/odbc-manager-keywords.rst
78+
79+
Using the procedure above, add the following keywords:
80+
81+
.. list-table::
82+
:widths: 50 50
83+
:header-rows: 1
84+
85+
* - Keyword
86+
- Value
87+
88+
* - **UID**
89+
- The username for the user that can access the active
90+
|bi| database.
91+
92+
.. include:: /includes/auth-options.rst
93+
94+
.. include:: /includes/auth-mechanisms-example.rst
95+
96+
* - **PWD**
97+
- The password associated with the :guilabel:`UID`.
98+
99+
.. include:: /includes/fact-db-pwd-special-char.rst
100+
101+
.. include:: /includes/fact-odbc-parameters.rst
102+
103+
For example, your user DSN configuration should look similar to
104+
the following:
105+
106+
.. figure:: /images/bi-connector/odbc-manager-dsn-config-auth.png
107+
:alt: ODBC Manager DSN configuration
108+
:align: center
109+
110+
#. Click :guilabel:`OK` to finish creating the DSN.

‎source/includes/steps-create-system-dsn-auth-macos.yaml

Lines changed: 0 additions & 50 deletions
This file was deleted.

0 commit comments

Comments
 (0)