Zoho Books policy
A Zoho Books policy contains the connection details that are used by a Zoho Books Input or Zoho Books Request node when you connect to the Zoho Books application.
Use a Zoho Books Input node in a message flow to accept input from Zoho Books. You can use the node to monitor Zoho Books for new or updated objects, such as new customers. Use a Zoho Books Request node to connect to Zoho Books and issue requests to create, retrieve, update or delete objects such as chart of accounts, customers, expenses, invoices, items and quotes. The Zoho Books policy controls, at run time, access to the Zoho Books application.
The Zoho Books policy is created when you configure a
connection between a Zoho Books Input or Zoho Books Request node and Zoho Books 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 Zoho Books policy. The policy is created with
a type of Zoho Books, 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 Zoho Books 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 Zoho Books policy, all message flows that are using the policy will be stopped and restarted.
For more information about using Zoho Books, see Using Zoho Books with IBM App Connect Enterprise.
| Property | Property name in .policyxml file | Description of properties |
|---|---|---|
| Zoho Books Application Type | applicationType | This property is reserved for future use and must be set to the value
online. |
| Zoho Books Application Version | applicationVersion | This property is reserved for future use and must be set to the value
v1. |
| Zoho Books Authentication method | authenticationMethod | This property specifies the type of authentication that is used for the
connection between IBM App Connect Enterprise and Zoho Books. This value is reserved for future use and must be
set to BASIC_OAUTH. |
| Server URL | apiUrl | Specify the URL for the API server that makes runtime calls. |
| Token base URL | tokenURL | The token URL value relative to the server URL. Select a server URL to use as the base for the token URL. |
| Organization ID | domainName | Specify your organization ID. In Zoho Books, your business is termed as an organization. You can obtain the organization ID from the Manage Organizations page in the admin console. |
| 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 Zoho Books
account. For example, ZohoBooksPolicy_ZohoBooks1 |