# Zoho Desk ## Pipeline Concepts Before setting up the pipeline, learn about pipeline concepts [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) ## Step by Step Guide ### STEP-1: Configure Connection To learn about Connection, refer [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) * Log into Sprinkle application * Navigate to Ingest -> Connections Tab -> New Connection -> * Select Zoho Desk * Provide all the mandatory details * *Name*: Name to identify this connection * *Advance Settings:* Refer [here](#advanced-connection-settings) * Connect to Zoho * Test Connection * Create ### STEP-2: Configure pipeline To learn about Pipeline, refer [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) * Navigate to Import -> Connection -> Add -> * Select Zoho Desk * Provide the name -> Create * **Connection Tab**: * From the drop-down, select the name of connection created in STEP-2 * Update ### STEP-3: Create Dataset **Datasets Tab**: To learn about Dataset, refer [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines). Add Dataset for each report/dataset that you want to integrate, providing following details * Organization (Required): Select the Organization whose data you want to access * Report Type (Required): Type of Report * Accounts * Agent\_Availability * Agent\_Availability\_Config * Agents * Articles * Associated\_Tickets * Blueprints * Business\_Hours * Calls * Channels * Community\_Category * Community\_Moderated\_Topics * Community\_Moderated\_Users * Community\_Topics * Contacts * Contracts * Countries * Customer\_Happiness * Data\_Sharing\_Rules * Deleted\_Resources * Departments * Domains * Duplicate\_Accounts * Duplicate\_Contacts * Email\_Failure\_Alerts * Events * Groups * Help\_Centers * Holiday\_Lists * KB\_Category * Labels * Languages * Layouts * Module(Required): The Module acc. to which data will be fetched tickets contacts accounts * accounts * calls * contacts * contracts * events * products * tasks * tickets * timeEntry * Layouts Rules * Module(Required): The Module acc. to which data will be fetched tickets contacts accounts * accounts * calls * contacts * contracts * events * products * tasks * tickets * timeEntry * Layouts\_Validation\_Rules * Module(Required): The Module acc. to which data will be fetched tickets contacts accounts * accounts * calls * contacts * contracts * events * products * tasks * tickets * timeEntry * Mail\_Configurations * Mail\_Reply\_Address * Departments (Required): Selecting All Dept means data will be fetched for all departments and Selecting Multi-Select means data will be fetched for only given departments * All Dept * Multi Select * Modules * Offline\_Agents * Departments (Required): Selecting All Dept means data will be fetched for all departments and Selecting Multi-Select means data will be fetched for only given departments * All Dept * Multi Select * Online\_Agents * Departments (Required): Selecting All Dept means data will be fetched for all departments and Selecting Multi-Select means data will be fetched for only given departments * All Dept * Multi Select * Organization\_Fields * Module(Required): The Module acc. to which data will be fetched tickets contacts accounts * accounts * calls * contacts * contracts * events * products * tasks * tickets * timeEntry * Products * Profiles * Roles * Routing\_Preferences * Departments (Required): Selecting All Dept means data will be fetched for all departments and Selecting Multi-Select means data will be fetched for only given departments * All Dept * Multi Select * Skills * Departments (Required): Selecting All Dept means data will be fetched for all departments and Selecting Multi-Select means data will be fetched for only given departments * All Dept * Multi Select * Skill\_Configuration * Departments (Required): Selecting All Dept means data will be fetched for all departments and Selecting Multi-Select means data will be fetched for only given departments * All Dept * Multi Select * Skill\_Types * Starred\_Views * Module(Required): The Module acc. to which data will be fetched tickets contacts accounts * accounts * calls * contacts * contracts * events * products * tasks * tickets * timeEntry * Support\_Email\_Address * Departments (Required): Selecting All Dept means data will be fetched for all departments and Selecting Multi-Select means data will be fetched for only given departments * All Dept * Multi Select * Tasks * Teams * Tickets * Ticket\_Tags * Ticket\_Templates * TimeZones * Time\_Track\_History * Users * Views * Module(Required): The Module acc. to which data will be fetched tickets contacts accounts * accounts * calls * contacts * contracts * events * products * tasks * tickets * timeEntry * Flatten Level(Required) : Select One Level or Multi Level. In one level, flattening will not be applied on complex type. They will be stored as string. In multi level, flattening will be applied in complex level till they become simple type. * *Destination Schema* (Required) : Data warehouse schema where the table will be ingested into * *Destination Table name* (Required) : It is the table name to be created on the warehouse. If not given, sprinkle will create like ds\_\\_\ * *Destination Create Table Clause*: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. [Learn more](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines/databases/features/destination-create-table-clause) on how to use this field. * Create ### STEP-4: Run and schedule Ingestion In the **Ingestion Jobs** tab**:** * Trigger the Job, using Run button * To schedule, enable Auto-Run. Change the frequency if needed ### Advanced Connection Settings * **API Read Timeout (In seconds) :** Maximum time of inactivity between two data packets when waiting for the server's response. The default value is 30 seconds * **API Connection Timeout (In seconds) :** Time period within which a connection between a client and a server must be established. * **Retry Limit :** Number of retries allowed when an API call fails. For example if an API call fails and retry limit is 5 then it will check 5 times for that API call and if it succeeded then it will stop checking**.** * **Retry Sleep Time (In milliseconds) :** Given time, after which retry should happen in case an API call fails. * **Version :** it gives information about the version of Zoho desk API being used. * **Domain :** Select from dropdown ( .in, .com, .eu, .com.au ) ## Dataset Fields
Accounts * accountname * email * website * phone * createdtime * customerhappiness\_badpercentage * customerhappiness\_okpercentage * customerhappiness\_goodpercentage * weburl * id
Agents * emailid * isconfirmed * status * roleid * profileid * firstname * lastname * phone * mobile * aboutinfo * extn * countrycode * photourl * rolepermissiontype * associatedchatdepartmentids * associateddepartmentids * name * timezone * id * channelexpert * langcode * zuid
Articles * modifierid * commentcount * attachmentcount * creatorid * author\_photourl * author\_name * author\_id * author\_status * author\_zuid summary * translationid authorid * viewcount * likecount * rootcategoryid * latestversionstatus * translationstate * portalurl * dislikecount * category\_name * category\_id * category\_locale * permission * latestversion * modifiedtime * categoryid * weburl * createdtime * title * modifiedby\_photourl * modifiedby\_name * modifiedby\_id * modifiedby\_status * modifiedby\_zuid * permalink * ownerid * createdby\_photourl * createdby\_name * createdby\_id * createdby\_status * createdby\_zuid * feedbackcount * position * status * id * istrashed * latestpublishedversion * sourcelocale * owner\_photourl * owner\_name * owner\_id * owner\_status * owner\_zuid usagecount * availablelocaletranslations * islocked departmentid * locale
Associated_Tickets * id * ticketnumber * layoutid * email * phone * subject * status * statustype * createdtime * channel * duedate * commentcount * threadcount * departmentid * contactid * assigneeid * weburl * source\_type * customerresponsetime * isarchived * isspam
Blueprints * name * description * active * dynamicTransOwnerType * module * departmentId * layoutId * type * fieldId * chartData
Business_Hours * name * status * type * holidayListId * timeZoneId * businessTimes
Calls * id * cf * departmentId * subject * startTime * direction * duration * status * ownerId * priority * description * createdTime * modifiedTime * creatorId * ticketId * contactId * ticket
Channels * code * acceptsreplies * replyconfig\_updaterecords * replyconfig\_acceptsattachments * replyconfig\_contenttypes\_0\_ * replyconfig\_contenttypes\_1\_ * replyconfig\_includequotedmessage * name * type
Contacts * lastname * accountcount * email * phone * createdtime * ownerid * accountid * customerhappiness\_badpercentage * customerhappiness\_okpercentage * customerhappiness\_goodpercentage * weburl * id * isspam * isanonymous * isenduser
Contracts * id * departmentId * contractNumber * notificationAgentIds * notifyBefore * notifyOn * startDate * endDate * ownerId * createdBy * modifiedBy * createdTime * modifiedTime * contractName * description * cf * sla * account * product
Countries * name * id
Customer_Happiness * department * agentid * contactId * accountId * ticketId * startTime * endTime * from * limit * rating * duration * startDate * endDate * sortBy * include
Data_Sharing_Rules * tickets * calls * accounts * contracts * contacts * tasks * events * products
Departments * id * name * description * createdtime * nameincustomerportal * haslogo * creatorid * chatstatus * sanitizedname * isassigntoteamenabled * isenabled * isvisibleincustomerportal * isdefault
Domains * domain * isVerified * isApplied * zdSecurityCode * verifiedTime * appliedTime * verifiedBy * appliedBy * sslStatus * sslRequestStatus * sslRequestedBy * sslRequestedTime
Events * id * cf * departmentId * subject * startTime * duration * status * ownerId * priority * description * createdTime * modifiedTime * creatorId * category * ticketId * contactId * ticket
Groups * name * description * logoId * helpCenterId
Help_Centers * locales * logourl * status * id * ismultilingualenabled * isencodedpermalinkallowed * primarylocale * url * helpcenterlocales * name * departmentids * isdefault
Holiday_Lists * name * holidays * status * associatedBusinessHourIds
KB_Category * translations * articleviewtype * encryptedworkspaceid * workspaceid * modifiedtime * createdtime * visibility * helpcenterid * modifiedby\_photourl * modifiedby\_name * modifiedby\_id * modifiedby\_status * modifiedby\_zuid * createdby\_photourl * createdby\_name * createdby\_id * createdby\_status * createdby\_zuid name * groups * status * order * isreviewenabled * associateddepartmentids * feedbackticketconversionpreference\_status * istrashed * id
Labels * name * logoId * helpCenterId * preferences
Layouts * modifiedtime * isstandardlayout * haslogo * departmentid * module * layoutdisplayname * layoutdesc * isdefaultlayout * layoutname * skipdeptaccessvalidation * layoutprofiles * createdby * createdtime * modifiedby * id * status
Layout_Rules * name * description * fieldName * displayLabel * status * executeInHelpCentre * fieldConditions
Mail_Configurations * privatethreadconfig * agentnameinticketreply * createcontactwithreplyto * createticketfororiginalsender * autocctomailbox
Mail_Reply_Address * displayname * serviceprovidertype * id * departmentid * smtpdetails * isactive * isverified * address
Offline_Agents * agentid * status
Organization_Fields * displaylabel * apiname * iscustomfield * i18nlabel * name * isencryptedfield * id * type * maxlength * ismandatory * allowedvalues
Products * id * departmentIds * ownerId * productName * productCode * productCategory * manufacturer * unitPrice * cf * createdBy * modifiedBy * createdTime * modifiedTime * description
Profiles * default permissions\_crminteg\_crmcontactsactivityevents * permissions\_crminteg\_crmaccountsactivityevents * permissions\_crminteg\_crmaccountsactivitytasks * permissions\_crminteg\_crmaccountsinfo * permissions\_crminteg\_crmcontactsactivitycalls * permissions\_crminteg\_crmaccountsnotes * permissions\_crminteg\_crmaccountsactivitycalls * permissions\_crminteg\_crmcontactsinfo permissions\_crminteg\_crmcontactsnotes * permissions\_crminteg\_crmcontactsactivitytasks * permissions\_crminteg\_crmaccountspotentials * permissions\_crminteg\_crmcontactspotentials permissions\_reports\_view * permissions\_reports\_edit permissions\_reports\_create permissions\_reports\_delete * permissions\_reports\_export * permissions\_tickets\_mergetickets * permissions\_tickets\_changeowner * permissions\_tickets\_import * permissions\_tickets\_handleunassigned * permissions\_tickets\_edit * permissions\_tickets\_closeticket * permissions\_tickets\_mailreview * permissions\_tickets\_delete * permissions\_tickets\_view * permissions\_tickets\_create * permissions\_tickets\_addfollowers * permissions\_tickets\_export * permissions\_tickets\_mailsend * permissions\_tickets\_unassignedchangeowner * permissions\_comments\_edit * permissions\_comments\_delete * permissions\_im\_view * permissions\_im\_edit * permissions\_im\_create * permissions\_im\_delete * permissions\_social\_view * permissions\_contracts\_view * permissions\_contracts\_import * permissions\_contracts\_edit * permissions\_contracts\_create * permissions\_contracts\_delete * permissions\_contracts\_export * permissions\_community\_view * permissions\_community\_edit * permissions\_community\_create * permissions\_community\_delete * permissions\_community\_moderate * permissions\_products\_view * permissions\_products\_import * permissions\_products\_edit * permissions\_products\_create * permissions\_products\_delete * permissions\_products\_export * permissions\_agents\_overview * permissions\_agents\_import * permissions\_agents\_edit * permissions\_agents\_create * permissions\_agents\_delete * permissions\_agents\_viewallfields * permissions\_zia\_view * permissions\_zia\_edit * permissions\_zia\_create * permissions\_zia\_delete * permissions\_kbcategory\_view * permissions\_kbcategory\_editallarticles * permissions\_kbcategory\_import * permissions\_kbcategory\_edit * permissions\_kbcategory\_create * permissions\_kbcategory\_delete * permissions\_kbcategory\_export * permissions\_calls\_view * permissions\_calls\_import * permissions\_calls\_edit * permissions\_calls\_create * permissions\_calls\_delete * permissions\_calls\_export * permissions\_chat\_view * permissions\_setup\_timetracking * permissions\_setup\_exportportalusers * permissions\_setup\_layouts * permissions\_setup\_automation * permissions\_setup\_featureconfig * permissions\_setup\_customerhappiness * permissions\_setup\_department * permissions\_setup\_portal * permissions\_setup\_webform * permissions\_setup\_rebranding * permissions\_setup\_email * permissions\_setup\_tabsandfields * permissions\_setup\_exportusers * permissions\_setup\_teams * permissions\_setup\_im * permissions\_setup\_social * permissions\_setup\_templates * permissions\_setup\_permission * permissions\_setup\_signupapproval * permissions\_setup\_community * permissions\_setup\_importhistory * permissions\_setup\_manageagents * permissions\_setup\_portalusers * permissions\_setup\_gamification * permissions\_setup\_managerdashboard * permissions\_setup\_googleanalytics * permissions\_setup\_webhooks * permissions\_setup\_chat * permissions\_setup\_telephony * permissions\_financeinteg\_sendsalesorder * permissions\_financeinteg\_createsalesorder * permissions\_financeinteg\_sendinvoice permissions\_financeinteg\_viewsubscription * permissions\_financeinteg\_createestimate permissions\_financeinteg\_createcontact * permissions\_financeinteg\_viewinvoice permissions\_financeinteg\_createinvoice * permissions\_financeinteg\_sendestimate permissions\_financeinteg\_viewsalesorder * permissions\_financeinteg\_viewestimate permissions\_accounts\_view * permissions\_accounts\_import permissions\_accounts\_edit * permissions\_accounts\_create permissions\_accounts\_delete permissions\_accounts\_export permissions\_timeentry\_view * permissions\_timeentry\_edit permissions\_timeentry\_create permissions\_timeentry\_delete permissions\_gc\_view * permissions\_gc\_edit permissions\_gc\_create * permissions\_gc\_delete * permissions\_contacts\_view * permissions\_contacts\_import * permissions\_contacts\_edit * permissions\_contacts\_create * permissions\_contacts\_delete * permissions\_contacts\_export * permissions\_tasks\_view permissions\_tasks\_import permissions\_tasks\_edit * permissions\_tasks\_create permissions\_tasks\_delete permissions\_tasks\_export permissions\_events\_view permissions\_events\_import * permissions\_events\_edit * permissions\_events\_create * permissions\_events\_delete permissions\_events\_export * name description * id * isvisible * type
Roles * isdefault * sharedatawithpeers * immediatesubroles * name * description * id * isvisible * reportsto
Routing_Preferences * departmentId * isThresholdEnabled * thresholdLimit * assignBacklog * backLogLimit * assignBacklogsBy * assignToOfflineAgents * freshTicketAssignMode
Skills * name * description * status * skillTypeId * criteria * agentIds
Skill_Configuration * departmentId * attachSkillsOption * autoSkillStamping
Support_Email_Address * id * address * ismailfetching * departmentid * friendlyname
Tasks * id * cf * departmentId * subject * ticketId * dueDate * ownerId * category * status * priority * description * createdTime * modifiedTime * creatorId * ticket * contactId * reminder
Teams * name * description * departmentId * subTeams * roles * rolesWithSubordinates * agents * derivedAgents
Tickets * id * ticketnumber * layoutid * email * phone * subject * status * statustype * createdtime * language * channel * duedate * commentcount * threadcount * departmentid * contactid * assigneeid * weburl * isspam * customerresponsetime * isarchived * source\_type
Ticket_Templates * id * ticketTemplateName * showInCustomerPortal * layoutId * ticketTemplateValues
TimeZones * id * name