|
| 1 | +a. Start the Microsoft ODBC Data Sources program. |
| 2 | + |
| 3 | + Choose the program version (64-bit or 32-bit) which is |
| 4 | + appropriate for your system and ODBC driver version. |
| 5 | + |
| 6 | +#. Select the ``System DSN`` tab. |
| 7 | + |
| 8 | +#. Click the ``Add`` button. |
| 9 | + |
| 10 | + .. figure:: /images/bi-connector/windows-odbc-administrator.png |
| 11 | + :alt: Screenshot of the Windows ODBC Administrator application |
| 12 | + :figwidth: 550px |
| 13 | + |
| 14 | +#. Select a |odbc-driver-name| from the list of available drivers. |
| 15 | + |
| 16 | + Select either the :guilabel:`MongoDB ODBC ANSI Driver` or the |
| 17 | + :guilabel:`MongoDB ODBC Unicode Driver`, then click |
| 18 | + :guilabel:`OK`. |
| 19 | + |
| 20 | + .. include:: /includes/fact-ansi-unicode-driver.rst |
| 21 | + |
| 22 | +#. Fill in the necessary form fields. |
| 23 | + |
| 24 | + Click the :guilabel:`Details` button to expose the lower half of the form. |
| 25 | + |
| 26 | + The following form fields are required: |
| 27 | + |
| 28 | + .. list-table:: |
| 29 | + :header-rows: 1 |
| 30 | + :widths: 30 70 |
| 31 | + |
| 32 | + * - Field Name |
| 33 | + - Description |
| 34 | + |
| 35 | + * - :guilabel:`Data Source Name` |
| 36 | + - A name of your choice. |
| 37 | + |
| 38 | + * - :guilabel:`TCP/IP Server` |
| 39 | + - Address of the server where your |
| 40 | + :binary:`~bin.mongosqld` process is running. If you have enabled |
| 41 | + |bi-short| on `MongoDB Atlas |
| 42 | + <https://www.mongodb.com/cloud/atlas>`_, you can find the |
| 43 | + hostname of the server where :binary:`~bin.mongosqld` is running |
| 44 | + in the `connection information |
| 45 | + <https://docs.atlas.mongodb.com/connect-to-cluster/#connect-to-your-cluster>`_ |
| 46 | + for your cluster. |
| 47 | + |
| 48 | + * - :guilabel:`Port` |
| 49 | + - Port number of your :binary:`~bin.mongosqld` |
| 50 | + process. |
| 51 | + |
| 52 | + * - :guilabel:`Database` |
| 53 | + - The name of the database to connect to, e.g. ``test``. |
| 54 | + |
| 55 | +#. (Optional) If authentication is enabled, provide connection information. |
| 56 | + |
| 57 | + The following fields are required when running with |
| 58 | + :option:`--auth <mongosqld --auth>` enabled or when connecting to an |
| 59 | + {+bi-atlas-short+} instance. |
| 60 | + |
| 61 | + .. list-table:: |
| 62 | + :header-rows: 1 |
| 63 | + :widths: 30 70 |
| 64 | + |
| 65 | + * - Field Name |
| 66 | + - Description |
| 67 | + |
| 68 | + * - :guilabel:`User` |
| 69 | + - Username of the :manual:`MongoDB user </core/security-users/>` |
| 70 | + who is authenticated to use your target database. |
| 71 | + |
| 72 | + .. include:: /includes/auth-options.rst |
| 73 | + |
| 74 | + .. include:: /includes/auth-mechanisms-example.rst |
| 75 | + |
| 76 | + * - :guilabel:`Password` |
| 77 | + - The authenticated user's password. |
| 78 | + |
| 79 | + .. include:: /includes/fact-db-pwd-special-char.rst |
| 80 | + |
| 81 | + * - :guilabel:`Authentication` |
| 82 | + - The default authentication method. When using the |
| 83 | + {+odbc-driver+}, this field is not required. |
| 84 | + |
| 85 | + To use the :doc:`authentication plugin |
| 86 | + </reference/auth-plugin-c>` in conjunction with |
| 87 | + another ODBC driver, fill in this field with the |
| 88 | + string ``mongosql_auth``. |
| 89 | + |
| 90 | +#. (Optional) If TLS/SSL is enabled, fill in the TLS/SSL form fields. |
| 91 | + |
| 92 | + Access the TLS/SSL form fields by clicking :guilabel:`Details >>`, |
| 93 | + then the :guilabel:`SSL` tab. The following parameters are available |
| 94 | + and may be required, depending on your |
| 95 | + :ref:`TLS/SSL <msqld-mongodb-tls-options>` configuration: |
| 96 | + |
| 97 | + .. list-table:: |
| 98 | + :header-rows: 1 |
| 99 | + :widths: 30 70 |
| 100 | + |
| 101 | + * - Field Name |
| 102 | + - Description |
| 103 | + |
| 104 | + * - :guilabel:`SSL Key` |
| 105 | + - The location of the client/server key file. |
| 106 | + |
| 107 | + * - :guilabel:`SSL Cert` |
| 108 | + - The location of the client/server certificate file. |
| 109 | + |
| 110 | + * - :guilabel:`SSL CA File` |
| 111 | + - The location of the file containing a list of trusted |
| 112 | + certificate authorities. |
| 113 | + |
| 114 | + * - :guilabel:`SSL Cipher` |
| 115 | + - The location of the file containing a list of permitted |
| 116 | + ciphers. |
| 117 | + |
| 118 | + * - :guilabel:`SSL Mode` |
| 119 | + - Set to ``REQUIRED`` to require an encrypted channel. If an |
| 120 | + encyrpted channel is not provided, the connection fails. |
| 121 | + |
| 122 | + * - :guilabel:`RSA Public Key` |
| 123 | + - The location of the PEM file that contains the RSA public key. |
| 124 | + |
| 125 | + .. include:: /includes/fact-ssl-atlas-bic.rst |
| 126 | + |
| 127 | +#. Click the ``Test`` button to test the ODBC connection. |
| 128 | + |
| 129 | + If the connection is successful, click :guilabel:`OK` to add the |
| 130 | + :abbr:`DSN (Data Source Name)`. If the connection fails, |
| 131 | + check to make sure your MongoDB user is correctly authenticated for |
| 132 | + the database named in the connection. |
0 commit comments