Basic Integration icon

Basic Integration

Basic Integration API node

Actions5

Overview

This node, named "Basic Integration," provides an API interface to perform various operations on different resources. Specifically for the Integrations resource with the Update operation, it allows users to update integration data by sending XML-formatted data and parameters. This is useful in scenarios where you need to synchronize or modify complex structured data in external systems that accept XML payloads, such as ERP systems or legacy applications.

Practical examples include:

  • Updating product or inventory information in an external system using XML data.
  • Modifying configuration or parameter settings remotely via XML.
  • Automating data synchronization workflows where the target system requires XML input.

Properties

Name Meaning
Data XML The main XML string representing the data to be updated. This is required and must be well-formed XML describing the items or entities to update. Example provided in placeholder shows a typical structure with items and units.
Param XML Optional XML string representing additional parameters controlling the update operation. Includes flags like replication mode, checks, campaign application, etc. Defaults to a predefined XML snippet.
Additional Fields A collection of optional fields:
- Logo Tenant: Identifier for the tenant; if not set, uses credential default.
- Logo Firm Number: Firm number identifier; if not set, uses credential default.
- Logo Firm Period: Period identifier; if not set, uses credential default.

Output

The node outputs JSON data representing the response from the integration update operation. Each item processed will produce a corresponding JSON object in the output array. The exact structure depends on the external system's response but typically includes status, confirmation, or error details related to the update request.

No binary data output is indicated or handled by this node.

Dependencies

  • Requires an API key credential (referred generically) to authenticate requests to the external integration service.
  • The node relies on internal helper functions and resource methods (updateIntegration) defined in bundled dependencies.
  • No explicit environment variables are mentioned, but proper credential setup in n8n is necessary.

Troubleshooting

  • Common Issues:

    • Malformed XML in the Data XML or Param XML fields can cause request failures.
    • Missing required fields or incorrect tenant/firm identifiers may lead to authorization or processing errors.
    • Network or authentication issues with the external API can prevent successful updates.

  • Error Messages:

    • Errors thrown during execution will appear in the output JSON under an error field if "Continue On Fail" is enabled.
    • Typical error messages might relate to XML parsing errors, invalid credentials, or API response errors.

  • Resolutions:

    • Validate XML syntax before running the node.
    • Ensure all required credentials and identifiers are correctly configured.
    • Check network connectivity and API endpoint availability.

Links and References

  • No direct external links are provided in the source code.
  • For XML formatting and validation, consider referencing standard XML documentation or tools.
  • Consult your external integration system's API documentation for specific XML schema and parameter meanings.

Discussion