Data Source Designer

Are you facing issues connecting your Vtiger CRM instance to different third-party apps? Would you like to address data integration challenges?

We have a solution!

Introducing Data Source Designer and Virtual Module - Vtiger’s newest features that address data integration challenges.

The Data Source Designer lets you connect with other applications and integrate data into Vtiger. This tool enables the creation of connectors for various actions in Vtiger using standard REST APIs. It provides a rich user interface for configuring URLs, parameters, and authentication details.

Currently, it supports Basic and Bearer-based Authentication. We have plans to add more standard connectors, such as:

  • Snowflake
  • Google BigData
  • Amazon Redshift
  • OAuth-based authentication

The Data Source Designer is based on the concept of Zero-Copy Integration. So, what is Zero-Copy Integration?

Zero-Copy Integration

Zero-copy integration eliminates data duplication and ensures real-time access to data. It is gaining traction for mitigating risks and enabling seamless data usage across applications.

It fosters better data quality, improves operational efficiency, reduces storage overhead, and empowers sales teams with a more holistic view of the customer.

Use Cases

  • Real-Time Inventory Visibility
  • Financial Data Integration
  • Enriched Customer Profiles
  • Fraud Detection and Risk Management
  • Social Media Listening

Connector Functions in the Data Source Connector

Each function in the Data Source Connector performs specific actions in the CRM, such as:

  • Get Records: Lists application data in a record list.
  • Get Record: Displays a specific record.
  • Create Record: Allows the creation of information in your application from Vtiger.
  • Update Record: Enables users to update information within Vtiger.
  • Delete Record: Deletes data from your application.
  • Related Records: Connects Vtiger information with application data, e.g., linking contact phone numbers with call logs.
  • Search: Searches application data.
  • Navigation: Facilitates moving through data lists in Vtiger.

Configuration

Each action requires configuring URLs, headers, query, and body parameters, typical in any HTTP API call. Once connected, the data appears to reside within Vtiger.

Configure Fields

Configuring fields is crucial. Each field has a display label and an internal name that maps to API data. You can use field names in the UI to create or update information. For instance, an email field can be accessed using $input.email$ in API calls.

Code Editor

You can use a code editor to write scripts in JavaScript to handle complex data. This helps transform data before it is displayed in Vtiger. The editor supports HTTP calls to external applications and in fetching Vtiger data. For more details, read our document on Server-side Scripting, an approach we follow at Vtiger.

After configuration, you can test the connection using the Test button next to the Code Editor. You can:

  • Use the Response tab to view the API call response
  • Use the Log tab for debugging

Virtual Modules

Creation

Once you have built and published the connector, you can define a Virtual Module in Vtiger to map the data exposed by the connector. Virtual Modules have no data of their own but possess a schematic structure of the data.

Configuration

When creating a Virtual Module, provide:

  • Module Name: Name of the new module.
  • App Name: App name where your module will reside.
  • Data Source: Select one of the published data sources.

Test the connection after supplying authentication details. If successful, fields are automatically mapped, with options to create a Record Identifier and enable editable properties for data points.

Connection and Field Mapping

After selecting the Data Connector, test the connection by providing the relevant authentication details. If the connection is successful, fields where the data needs to reside are automatically mapped. 

During this mapping process, the system will auto-select the appropriate field types and offer the following options:

  • Record Identifier: Create a non-editable identifier for the application data.
  • Editable Property: Enable the editable property for data points that you want users to be able to edit.

Connecting data to Vtiger enhances its power. This ability to relate data to existing modules uses the Related Records function to extract information.

Click here to learn more about the Data Source Designer. We also have examples.

 
 

Sign up to receive the latest updates!