Modules

Modules in business applications are distinct, functional components or sections designed to handle specific aspects of a business process. Each module typically focuses on a particular area of business operations. The Modules section allows you to customize the api settings, such as the data fetch period to be followed for each module. This also allows you to use the configurations mentioned in the Global section.

  • Specify the Display Name of the module to be shown in the user interface.
  • Provide a Description to clearly explain the details of the module.

     

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.

Inherit Global Configurations

The Inherit Global Configurations option allows modules to automatically apply the API settings defined in the Global section. This ensures consistency across modules without requiring additional configuration.

By default, the Inherit Global Configuration option is enabled. To customize API settings for this module, uncheck this option.

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.

Fields

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 Field Name as in the source application
  2. Provide the Path or end point for the field.
  3. Specify the Display Name that should be shown to the users.
  4. Choose the Data Type of the specific field.
  5. Choose the Property Type of the field. The following are the available options:
    • Mark as Primary: Primary fields are the unique identifiers for individual records in a module. These fields are used for looking up or linking records across modules for analysis and matching records with the source application during data synchronization. When a field is marked primary, it denotes the values in these fields are unique.
    • Mark as Mandatory: Mandatory fields are fields that have the important records essential for analysis. A field marked as mandatory must contain valid entries for importing records for analysis.
    • Mark as Default: Fields marked as default are selected automatically for import. The user can choose to modify these settings as needed.
  6. Click the + icon to include more fields and follow the steps mentioned above.