IBM Cloudant policy
An IBM Cloudant policy contains the connection details that are used by an IBM Cloudant Request node when connecting to an IBM® Cloudant® application.
You can use an IBM Cloudant Request node in a message flow to connect IBM App Connect Enterprise to IBM Cloudant applications, and issue requests to create, retrieve, update, and delete objects. The IBM Cloudant policy controls, at run time, the access to the IBM Cloudant application.
The IBM Cloudant policy is created when you configure a connection between an IBM Cloudant Request node and IBM
Cloudant by using the Connector Discovery wizard. During
the process of discovery, account credentials are stored in the vault and connection details are
stored in an IBM Cloudant policy. The policy is created with a type of IBM
Cloudant, and the name of the policy is returned to the IBM Cloudant Request node and specified in the Connection tab of
the node, in the format
{policyProjectName}:policyName.
You can also create, update, or delete an IBM Cloudant policy by using the Manage Discovery Connector Policies and Credentials wizard, which you can access by right-clicking the policy project in the IBM App Connect Enterprise Toolkit and then clicking .
You must deploy this policy before message flows that use the policy are started. If you redeploy an IBM Cloudant policy, all message flows that are using the policy will be stopped and restarted.
For more information about using IBM Cloudant policies, see Using IBM Cloudant with IBM App Connect Enterprise.
| Property | Property name in .policyxml file | Description of properties |
|---|---|---|
| Credential Name | credentialName | This property specifies the name of the credential that will be used for the
connection to IBM
Cloudant. The specified credential can be defined during connector discovery and stored in the vault. Alternatively, you can specify an existing credential that was configured by using the mqsicredentials command or the server.conf.yaml file, or loaded through an external credential provider. |
| Cloudant host | hostname | This property specifies the host name of the IBM Cloudant instance. |
| IBM Cloudant Authentication method | authenticationMethod | This property is reserved for future use and must be set to the value
BASIC. |
| IBM Cloudant Application Type | applicationType | This property is reserved for future use and must be set to the value
online. |
| IBM Cloudant Application Version | applicationVersion | This property is reserved for future use and must be set to the value
v1. |