Modules - Global Configuration

The global configuration allows you to define the settings that apply universally to all the modules for retrieving data. Global configurations are often used to maintain consistency, simplify management, and ensure that certain standards or policies are followed system-wide.

Fetch Contracts

A fetch contract in the context of an API defines the structure and rules for retrieving data from a specific endpoint or service. It specifies how data should be requested, including the necessary parameters, headers, authentication methods, and the expected format of the response. Essentially, it outlines the contract between the client and the server, ensuring both sides understand what data is requested and what will be returned.

Initial Fetch

Initial fetch allows you to configure the settings to be followed while fetching the data for the first time. These settings ensure that the data is retrieved and structured according to your specific requirements, providing a foundation for subsequent updates.

Download Type

The Download Type setting lets you specify the data to be imported during the initial fetch.

• Full Fetch: Retrieves all existing records available up to the moment the import is initiated, ensuring a comprehensive data import.
• Relative Period: Imports records from a specific time frame, such as the last three months, six months, or one year, allowing you to focus on recent or relevant data.

Import Type

Import Type allows you to configure how the new data should be imported during the initial fetch.

• Truncate & Add: Deletes all existing records before importing new data, ensuring only the latest records are retained.
• Append: Adds new records to the existing dataset without altering or removing any previously imported data.
• Update & Add: Matches records using a unique identifier to update existing entries if changes are detected and adds any new records.

Sync Fetch

Sync Fetch allows you to define the schema for retrieving data during a scheduled sync. It also enables you to set conditions for data handling, such as filtering or limiting the data being fetched to control the scope and volume of data being fetched.

• Full Fetch: Synchronizes all data from the source during each scheduled sync, ensuring a complete dataset is imported every time.
• Incremental Fetch: Synchronizes only newly added records and updates existing records if changes are detected, based on a unique identifier, optimizing efficiency by fetching only what has changed.

Import Type

Import type allows you to define how new data is handled during each scheduled sync for a seamless integration with the existing records.

• Truncate & Add: Deletes all existing records before importing new data, ensuring only the latest records are retained.
• Append: Adds new records to the existing dataset without altering or removing any previously imported data.
• Update & Add: Matches records using a unique identifier to update existing entries if changes are detected and adds any new records.

Module Details

1. Specify the Module Name to be displayed.
2. Specify the CSV Date format and the Display Date Format.

Data Source 

1. Specify the Data Source Label.
2. Choose the Data Source Name.

Entities

Entities Configuration allows you to define or map the level from which the data should be fetched for the custom module. Please note that this is not a mandatory step.

1. Select the Entity Name from the drop-down menu.
2. Specify the number of records to be fetched in one API call in the Count Per Call field.
3. Choose the Format in which the records should be rendered from the Input Type drop-down menu.

Pagination

Pagination is a process that enables you to break up the number of records that are returned from a retrieve API action into more manageable sizes. It allows you to import data in batches.

Custom Pagination

Custom Pagination allows you to configure the rules and parameters to be used for pagination. It provides greater flexibility and control over the pagination process. Custom pagination can define specific conditions that indicate when to stop fetching data. 

End Condition: 

• Type: Choose the condition based on which the data fetch should be stopped from the drop-down menu.
• Look in: Indicates the location or field in the data where the pagination parameters should be applied.
• End Condition Path: Specify the End Condition Path.
• Comparator: Choose the Comparator value for pagination.
• End Condition Value: Specify the End Condition Value.

Iteration Logic

Iteration Logic allows you to configure how to send the parameters in an HTTPS request. Choose the method in which the request should be sent from the Send As drop-down menu and specify the Parameter Name and Path.

Page Number

You can use this option when your data is stored in multiple pages and you want to import them in the same sequence into Zoho Analytics.

General

• Limit: The Limit specifies how many records should be fetched in one request. For example, if you set a limit of 100, the API will return up to 100 records per request/page.
• End Condition Path: This defines the point at which the pagination should stop. It’s often based on a field in the API response, such as a boolean flag (has_more) or checking if there are no further pages to fetch (next_page is null). This ensures the system knows when to terminate the request cycle.

Iteration Logic

Iteration Logic allows you to configure how to send the parameters in an HTTPS request. Choose the method in which the request should be sent from the Send As drop-down menu and specify the Parameter Name.

Next Page URL

The Next Page URL is used to retrieve or fetch the next set of data when the results are split across multiple pages.

• In the Look In field, specify whether the response can be found in the request's response headers or response body.
• Specify the Path to identify the page's URL.

Offset

Offset pagination fetches the subset of records based on the offset parameters. This works by defining an offset (starting point) and a maximum number of records (limit) to return, facilitating efficient data retrieval across multiple pages.

General 

• In the Limit option, specify the maximum number of records to be fetched in one request.
• Specify the End Condition Path that determines when pagination should stop.

Iteration Logic

Iteration Logic allows you to configure how to send the parameters in an HTTPS request.

• Choose the method in which the request should be sent from the Send As drop-down menu.
• Specify the Parameter Name.

Time Period

Records in the custom module might get frequently updated, and the Time Period section allows you to define the parameter settings to fetch the new and updated records added to the custom module dynamically.

1. Choose the method in which the request should be sent from the Send As drop-down menu.
2. Specify the Parameter Name and Values.
3. Specify the Date Format.
4. Granularity lets you define the time intervals for fetching data, while values specify the exact range, such as retrieving data for the past year or the last month.

Fields Configuration

Fields Configuration enables you to define the settings for seamlessly retrieving data from each module's fields within the source application. This process involves specifying the attributes for each field, determining whether a field should be imported by default, and setting the display names for columns (fields) that will be visible in the user interface.

1. Specify the Name of the field (column).
2. Choose the method in which the request should be sent from the Send As drop-down menu.
3. Choose the format in which the records should be rendered from the Input Type drop - down menu.

Data Type Mapping

Data type mapping allows you to match the data type of each field of the source application with the target application (Zoho Analytics). This helps prevent conversion errors during integration (while importing records).

In the Data Type mapping section,

1. Enter the Name of the fields (columns).
2. Choose the suitable Data Type.