From 67f27620c7de9b3211485a4cc1944a9861736f55 Mon Sep 17 00:00:00 2001 From: Rob Rudin Date: Mon, 27 Oct 2025 16:01:10 -0400 Subject: [PATCH] MLE-24893 Better docs for connecting to PDC --- docs/configuring-the-connector.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/docs/configuring-the-connector.md b/docs/configuring-the-connector.md index 7ea9dfc..efbb9d0 100644 --- a/docs/configuring-the-connector.md +++ b/docs/configuring-the-connector.md @@ -59,14 +59,25 @@ Both digest and basic authentication require the following properties to be conf ### Configuring Progress Data Cloud authentication -Cloud authentication requires the following properties to be configured: +Authenticating with Progress Data Cloud (PDC) requires the following properties to be configured: +- `ml.connection.host` = your PDC host name - e.g. `myservice.data.progress.cloud` - `ml.connection.securityContextType=CLOUD` -- `ml.connection.basePath` = the base path in your Progress Data Cloud instance that points to the REST API server you - wish to connect to -- `ml.connection.cloudApiKey` = the API key for authenticating with your Progress Data Cloud instance +- `ml.connection.port=443` +- `ml.connection.basePath` = the base path in your PDC instance that points to the REST API server you wish to connect to +- `ml.connection.cloudApiKey` = the API key for authenticating with your PDC instance + +For the `ml.connection.basePath` property - this should equal an "integration endpoint" that you have configured in your PDC instance. +The value will be similar to e.g. `/ml/ml12/default/your-chosen-name`. +Please see the +[PDC documentation](https://docs.progress.com/bundle/progress-data-cloud-use/page/topics/access-your-services/marklogic/expose-an-app-server.html) for more information. + +In addition, because the connector depends on a [MarkLogic REST API server](https://docs.progress.com/bundle/marklogic-server-develop-rest-api-12/page/topics/intro.html), +you may wish to use [the ml-gradle Gradle plugin](https://github.com/marklogic/ml-gradle/wiki/Getting-started) to define and deploy +an application to your PDC tenancy consisting of a REST API app server. If you do, consult the +[ml-gradle docs](https://github.com/marklogic/ml-gradle/wiki/Progress-Data-Cloud-support) on configuring your project to deploy +to a PDC tenancy. -You should also set `ml.connection.port` to 443 for connecting to Progress Data Cloud. ### Configuring certificate authentication