Zoho Recruit policy

A Zoho Recruit policy contains the connection details that are used by a Zoho Recruit Input or Zoho Recruit Request node when you connect to the Zoho Recruit application.

Use a Zoho Recruit Input node in a message flow to accept input from Zoho Recruit. You can use the node to monitor Zoho Recruit for new or updated objects, such as new applications. Use a Zoho Recruit Request node to connect to Zoho Recruit and issue requests to create, retrieve or update objects such as applications, candidates, departments, job openings and users. The Zoho Recruit policy controls, at run time, access to the Zoho Recruit application.

The Zoho Recruit policy is created when you configure a connection between a Zoho Recruit Input or Zoho Recruit Request node and Zoho Recruit 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 Recruit policy. The policy is created with a type of Zoho Recruit, 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 Recruit 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 New > Discovery Connector policies and credentials.

You must deploy this policy before message flows that use the policy are started. If you redeploy a Zoho Recruit policy, all message flows that are using the policy will be stopped and restarted.

For more information about using Zoho Recruit, see Using Zoho Recruit with IBM App Connect Enterprise.

Table 1. Properties of the Zoho Recruit policy
Property Property name in .policyxml file Description of properties
Zoho Recruit Application Type applicationType This property is reserved for future use and must be set to the value online.
Zoho Recruit Application Version applicationVersion This property is reserved for future use and must be set to the value v1.
Zoho Recruit Authentication method authenticationMethod This property specifies the type of authentication that is used for the connection between IBM App Connect Enterprise and Zoho Recruit. 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.
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 Recruit account. For example, ZohoRecruitpolicy_ZohoRecruit1