Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-11553

BI Connector docs inconsistencies

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major - P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: BI Connector
    • Labels:
      None
    • # Replies:
      2
    • Last comment by Customer:
      true
    • Story Points:
      0.25
    • Sprint:
      KANBAN BUCKET

      Description

      Working through an issue the other day, I encountered three inconsistencies in the BI connector docs.

      First, under https://docs.mongodb.com/bi-connector/master/launch/#mongosqld-as-a-system-service for Windows, the systemLog path is using linux syntax instead of a drive letter and backslashes, just like in the green NOTE box under it which is correct.

      Second, in the example immediately following the above, we have the steps to install and run the mongosqld service:

      "C:\Program Files\MongoDB\Connector for BI\2.4\bin\mongosqld.exe" install --config <pathToConfigFile>\mongosqld.conf
      net start mongosql
      

      This has proven confusing for at least one customer and it looked like one single command wrapping to the next line (novice mistake, but still). Preferably, it should read like this:

      mongosqld.exe install --config "<pathToConfigFile>\mongosqld.conf"
      net start mongosql
      

      Note how I also wrapped the config path in quotes, since the path may contain spaces and will result in errors for the customer if those spaces are not escaped. Alternatively, we could simply provide another green NOTE box explaining the issue with spaces so they can adjust as needed.

      Finally, the --mongo-sslPEMKeyFile explanation here https://docs.mongodb.com/bi-connector/master/reference/mongosqld/#cmdoption-mongosqld-mongo-sslpemkeyfile seems pasted over from a similar flag used in the mongod docs, hence the lingering reference in he description to mongodb. I believe this should read something like:

      Specifies the .pem file containing both the TLS/SSL certificate and key for the Mongosqld instance. Specify the file name of the .pem file using relative or absolute paths.
      

      Thanks!

        Attachments

          Activity

            People

            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:
                Days since reply:
                2 years, 1 day ago
                Date of 1st Reply: