ClickSend policy
A ClickSend policy contains the connection details that are used by a ClickSend Input or ClickSend Request node when you connect to the ClickSend application.
Use a ClickSend Input node in a message flow to accept input from ClickSend. You can use the node to monitor ClickSend for new or updated objects, such as new contacts. Use a ClickSend Request node to connect to ClickSend and issue requests to create or retrieve objects such as accounts, allowed emails for SMS communication, contact lists, contacts, SMS, SMS campaigns, and voice messages. The ClickSend policy controls, at run time, access to the ClickSend application.
The ClickSend policy is created when you configure a
connection between a ClickSend Input or ClickSend Request node and ClickSend by using the Connector Discovery wizard. During
the process of discovery, account credentials are stored in the vault and connection details are
stored in a ClickSend policy. The policy is created with
a type of ClickSend, and the name of the policy is returned to the node and
specified in the Connection tab, in the format
{policyProjectName}:policyName.
You can also create, update, or delete a ClickSend 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 a ClickSend policy, all message flows that are using the policy will be stopped and restarted.
For more information about using ClickSend, see Using ClickSend with IBM App Connect Enterprise.
| Property | Property name in .policyxml file | Description of properties |
|---|---|---|
| ClickSend Application Type | applicationType | This property is reserved for future use and must be set to the value
online. |
| ClickSend Application Version | applicationVersion | This property is reserved for future use and must be set to the value
v1. |
| ClickSend Authentication method | authenticationMethod | This property specifies the type of authentication that is used for the
connection between IBM App Connect Enterprise and ClickSend. This value is reserved for future use and must be
set to BASIC. |
| Server URL | apiUrl | Specify the URL for the API server that makes runtime calls. |
| Allow self-signed certificates | isTlsEnabled |
Set to true if you want to be able to accept self-signed certificates that are trusted and used only in a nonproduction environment. The default is false. |
| Override server URL | endpointUrl | Required if you want to connect to an endpoint in a private network by using
the private network client, or if you want to override the server URL. Specify an override value for
the host and port for the connector in the format <http or
https>://<host_name>:<port>. If you are not using the private network client or do
not require an override, leave this field blank. |
| Credential Name | credentialName | The name of your ClickSend
account. For example, clicksendpolicy_ClickSend1 |