Zoho CRM

Pipeline Concepts

Before setting up the pipeline, learn about pipeline concepts here

Step by Step Guide

STEP-1: Configure Connection

To learn about Connection, refer here

Log into the Sprinkle application
Navigate to Ingest -> Connections Tab -> Setup connections ->
Select Zoho CRM
Provide all the mandatory details
- Name: Name to identify this connection
- Advance Settings: Refer here
Connect to Zoho
Test Connection
Create

STEP-2: Configure Pipeline

To learn about pipeline, refer here

Navigate to Ingest -> Pipelines Tab -> Setup sources ->
Select Zoho CRM
Provide the name -> Create
Connection Tab:
- From the drop-down, select the name of the connection created in STEP-2
- Update

STEP-3: Create a Dataset

Datasets Tab: To learn about Dataset, refer here. Add a Dataset for each report/dataset that you want to integrate, providing the following details

Report Type (Required): Type of report
- Fields
  - Module Name: Select from Contacts, Accounts, Deals, Activities, Campaigns, Tasks, Events, Notes, Calls
- Layouts
  - Module Name: Select from Leads, Contacts, Accounts, Deals, Activities, Campaigns, Tasks, Events, Notes, Calls
- Modules
  - Module Name: Select from Leads, Contacts, Deals, Activities, Campaigns, Tasks, Events, Notes, Calls
- Profiles
- Records (Records will be fetched incrementally on the Modified_Time column)
  - Module Name: Select from Leads, Contacts, Accounts, Deals, Activities, Campaigns, Tasks, Events, Notes, Calls
- Roles
- Users
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_<datasourcename>_<tablename>
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 on how to use this field.
Create

STEP-4: Run and schedule Ingestion

In the Ingestion Jobs tab:

Trigger the Job, using the Run button
To schedule, enable Auto-Run. Change the frequency if needed

Advanced Connection Settings

API Read Timeout (In seconds): If reading the data takes more time than (n) seconds it will automatically timeout.
API Connection Timeout (In seconds): API will wait for the server to respond for (n) seconds, if the server does not respond it timeouts.
Retry Limit: If the API fails due to the API usage limit exceeded it will retry (n) more times.
Retry Sleep Time (In milliseconds): Before retrying it will wait for (n) milliseconds.
Version: Enter the required version.
Max Records Per Job: Each job will fetch maximum of (n) records for a particular dataset.

Dataset Fields

Fields

system_mandatory
webhook
json_type
field_label
created_source
field_read_only
display_label
ui_type
read_only
businesscard_supported
currency
id
custom_field
lookup
visible
length
view_type_view
view_type_edit
view_type_quick_create
view_type_create
api_name
unique
history_tracking
data_type
formula
mass_update
multiselectlookup
pick_list_values
auto_number
blueprint_supported
pick_list_values
quick_sequence_number
lookup_display_label
lookup_api_name
lookup_module
lookup_id
sub_module_api_name
sub_module_id
currency_rounding_option
currency_precision
decimal_place

Layouts

display_label
visible
name
profiles
id
sections
status

Modules

global_search_supported
kanban_view
field_states
deletable
creatable
filter_status
inventory_template_supported
plural_label
presence_sub_menu
triggers_supported
id
isblueprintsupported
related_list_properties_fields
per_page
properties
visibility
convertable
editable
emailtemplate_support profiles
filter_supported
display_field
search_layout_fields
kanban_view_supported
show_as_tab
sequence_number
singular_label
viewable
api_supported
api_name
quick_create
generated_type
feeds_required
scoring_supported
webform_supported
arguments
module_name
business_card_field_limit
custom_view_display_value
custom_view_shared_type
custom_view_system_name
custom_view_offline
custom_view_default
custom_view_system_defined
custom_view_name
custom_view_id
custom_view_category
custom_view_fields
parent_module

Profiles

display_label
name
description
id
category

Records

owner_name
owner_id
owner_email
ownership
description
_currency_symbol
account_type
_review_process_approve
_review_process_reject
_review_process_resubmit
website
employees
last_activity_time
industry
record_image
modified_by_name
modified_by_id
modified_by_email
_state
_process_flow
phone
billing_country
account_name
id
account_number
_approved
_approval_delegate
_approval_approve
_approval_reject
_approval_resubmit
modified_time
billing_street
created_time
_editable
billing_code
billing_city
_in_merge
billing_state
created_by_name
created_by_id
created_by_email
annual_revenue
_approval_state

Roles

display_label
share_with_peers
name
description
id
admin_user
reporting_to_name
reporting_to_id

Users

country
role_name
role_id
customize_info_show_home
customize_info_show_detail_view
name_format
language
locale
microsoft
personal_account
isonline
default_tab_group
modified_by_name
modified_by_id
theme_normal_tab_font_color
theme_normal_tab_background
theme_selected_tab_font_color
theme_selected_tab_background
theme_background
theme_screen theme_type
id
state
country_locale
sandboxdeveloper
first_name
email
decimal_separator
created_time
modified_time
time_format
offset
profile_name
profile_id
time_zone
created_by_name
created_by_id
zuid
confirm
full_name
territories
date_format
status