Vtiger CRM

Overview

This node integrates with the Vtiger CRM (an open-source customer relationship management system) via its webservice API. It allows users to perform various operations such as creating, updating, deleting records, querying data, retrieving metadata descriptions, and managing sessions.

Common scenarios where this node is beneficial include:

• Automating CRM record creation or updates based on external triggers.
• Querying CRM data for reporting or synchronization with other systems.
• Managing user sessions programmatically.
• Retrieving metadata about CRM modules to dynamically build workflows.

For example, a user could automate lead creation in Vtiger when a new contact form is submitted on their website, or query related records to enrich customer profiles.

Properties

Note: The provided input properties JSON only includes "Session Name" relevant outside the login operation. The node also supports other properties depending on the operation, such as:

• Operation: The action to perform (e.g., create, delete, describe, login, query).
• Element: JSON object representing the record data for create/update operations.
• Element Type: The type of CRM module/entity (e.g., Contacts, Leads) for create/describe operations.
• Webservice ID: The unique identifier of a record for retrieve/delete/query_related operations.
• Query: A string containing the query statement for query/query_related operations.
• Related Label: The label identifying related records in query_related operations.

Output

The node outputs a JSON array containing the response from the Vtiger CRM API corresponding to the requested operation. The structure of the output depends on the operation performed but generally includes:

• Success status and result data for operations like login, create, update.
• Metadata descriptions for describe operations.
• Query results for query and query_related operations.
• Error messages if the operation fails.

No binary data output is produced by this node.

Dependencies

• Requires an API authentication credential for Vtiger CRM, including host URL, username, and access key.
• Uses the crypto-js library internally to generate MD5 hashes during the login operation.
• The node makes HTTP requests to the Vtiger webservice endpoint /webservice.php.

Troubleshooting

• Unimplemented Operations: Some operations like "extend_session", "logout", and "sync" are not implemented and will throw errors if used.
• Login Failures: If the login challenge request fails, the node throws an error with the message and code returned by the API. Ensure credentials are correct and the Vtiger instance is accessible.
• Session Issues: Most operations require a valid session name obtained from a successful login. Using an invalid or expired session name will likely cause API errors.
• Incorrect Parameters: Missing or incorrect parameters (e.g., elementType, webservice ID) for specific operations will cause failures. Verify all required fields are correctly set.
• API Endpoint Access: Network issues or incorrect host URLs can prevent communication with the Vtiger API.

Links and References

• Vtiger CRM Official Website
• Vtiger Webservice API Documentation
• crypto-js Library (used internally for hashing during login)