Skip to content

Commit 67f2762

Browse files
committed
MLE-24893 Better docs for connecting to PDC
1 parent e2b1f16 commit 67f2762

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

docs/configuring-the-connector.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,25 @@ Both digest and basic authentication require the following properties to be conf
5959

6060
### Configuring Progress Data Cloud authentication
6161

62-
Cloud authentication requires the following properties to be configured:
62+
Authenticating with Progress Data Cloud (PDC) requires the following properties to be configured:
6363

64+
- `ml.connection.host` = your PDC host name - e.g. `myservice.data.progress.cloud`
6465
- `ml.connection.securityContextType=CLOUD`
65-
- `ml.connection.basePath` = the base path in your Progress Data Cloud instance that points to the REST API server you
66-
wish to connect to
67-
- `ml.connection.cloudApiKey` = the API key for authenticating with your Progress Data Cloud instance
66+
- `ml.connection.port=443`
67+
- `ml.connection.basePath` = the base path in your PDC instance that points to the REST API server you wish to connect to
68+
- `ml.connection.cloudApiKey` = the API key for authenticating with your PDC instance
69+
70+
For the `ml.connection.basePath` property - this should equal an "integration endpoint" that you have configured in your PDC instance.
71+
The value will be similar to e.g. `/ml/ml12/default/your-chosen-name`.
72+
Please see the
73+
[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.
74+
75+
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),
76+
you may wish to use [the ml-gradle Gradle plugin](https://github.com/marklogic/ml-gradle/wiki/Getting-started) to define and deploy
77+
an application to your PDC tenancy consisting of a REST API app server. If you do, consult the
78+
[ml-gradle docs](https://github.com/marklogic/ml-gradle/wiki/Progress-Data-Cloud-support) on configuring your project to deploy
79+
to a PDC tenancy.
6880

69-
You should also set `ml.connection.port` to 443 for connecting to Progress Data Cloud.
7081

7182
### Configuring certificate authentication
7283

0 commit comments

Comments
 (0)