This tutorial describes how to connect to Zoho Desk.
To connect to Zoho Desk, you need to have the corresponding account, dotConnect for Zoho Desk installed, and the IDE running. You also have to know the required connection parameters described below.
Note that if you do not use design-time (specifically, if you do not place designer ZohoDeskConnection component from the Toolbox to the form), you have to embed licensing information manually. For more information, see Licensing.
To establish a connection to the server, you have to provide the required connection parameters to dotConnect for Zoho Desk. This information is used by ZohoDeskConnection component to connect to Zoho Desk. The parameters are represented as a connection string. You can compose the connection string manually or have dotConnect for Zoho Desk construct it for you.
The following connection string parameters are required:
Design time creation
The following assumes that you have the IDE running, and you are currently focused on a form designer.
Run time creation
You can also configure a connection at run-time by setting its ConnectionString property (note that you have to add references to Devart.Data.ZohoDesk.dll, Devart.Data.SqlShim.dll, and Devart.Data.dll assemblies):
Using connection string builder
If you decide to set up the connection by assigning values to several properties, consider using ZohoDeskConnectionStringBuilder class. It has all of the possible connection settings exposed as properties, thus allowing you to customize the connection to the full extent.
Notice that in this example we used the ZohoDeskConnection constructor that accepts a connection string as an argument.
For information on the arguments allowed in the connection string, refer to the description of the ZohoDeskConnection.ConnectionString property.
Creating Connection in Server Explorer
To create a Server Explorer connection:
After this, you can browse Zoho Desk objects in Server Explorer.
To open a connection, call the Open method.
The myConnection1 object must have a valid connection string assigned earlier. When you call Open, dotConnect for Zoho Desk tries to find the host and connect to Zoho Desk. If any problem occurs, it raises an exception with a brief explanation of what is wrong. If no problem is encountered, dotConnect for Zoho Desk tries to establish the connection during the ConnectionTimeout interval. Finally, when the connection is established, the Open method returns and the State property is changed to Open.
To connect to the server at design time:
Alternatively, change the State property to Open in the Properties window to establish a connection using the current connection string.
To close a connection, call its Close method, or set its State property to Closed.
The following example summarizes the aforementioned information and shows how to create, set up, open, use, and then close the connection.
The sample code connects to the server, shows its version, and then closes the connection. This is actually a rare usage, because in real applications connections are used by other objects like ZohoDeskCommand, ZohoDeskDataReader and others. For more information on this, see the corresponding tutorials or reference information.
You can modify a connection by changing properties of the ZohoDeskConnection object. Keep in mind that while some of the properties can be altered freely, most of them close the connection when a new value is assigned.