Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API
Join our community

Actions364

Overview

This node integrates with the Dataiku DSS API, enabling users to perform a wide range of operations on Dataiku DSS resources directly from n8n workflows. Specifically, for the Flow Documentation resource and the operation Generate Flow Documentation From Custom Template, it allows generating flow documentation in a Dataiku project using a custom template file uploaded by the user.

Common scenarios where this node is beneficial include:

  • Automating the generation of project flow documentation based on customized templates.
  • Integrating Dataiku DSS documentation generation into broader automation pipelines.
  • Generating consistent and repeatable documentation outputs for Dataiku projects without manual intervention.

Practical example:

  • A data engineer wants to generate updated flow documentation for a Dataiku project every time a workflow completes successfully. They can use this node to trigger documentation generation using their own custom Word or HTML template, ensuring that the documentation reflects the latest project state.

Properties

Name Meaning
Project Key The unique key identifying the Dataiku project for which the flow documentation will be generated.
File The custom template file content (binary) to upload and use for generating the flow documentation.
Request Body JSON object containing additional parameters or configuration for the API request (optional).

Output

The node outputs the response from the Dataiku DSS API after requesting flow documentation generation. The output structure depends on the API response but generally includes:

  • For successful generation requests, a JSON object confirming the initiation of the documentation generation process or providing metadata about the generated documentation.
  • If the operation involves downloading generated documentation (not this specific operation), binary data representing the document file would be returned.

Since this operation triggers generation using a custom template, the output is typically JSON confirming the request status.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key/token) for authenticating with the Dataiku DSS API.
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.
  • The custom template file must be provided as binary data attached to the node input.

Troubleshooting

  • Missing Credentials Error: If the node throws "Missing Dataiku DSS API Credentials," ensure that the API key credential is properly set up in n8n.
  • Required Parameter Errors: The node validates required parameters such as Project Key and template file presence. Missing these will cause errors like "Project Key is required" or "File is required."
  • API Request Failures: Network issues, incorrect server URLs, or invalid API keys may cause request failures. Check connectivity and credential validity.
  • Invalid Template File: Uploading an unsupported or corrupted template file may cause the API to reject the request. Verify the template format and integrity.
  • Unexpected Response Parsing: If the API returns non-JSON responses unexpectedly, the node attempts to handle them gracefully, but malformed responses may cause errors.

Links and References

Note: This summary focuses exclusively on the Flow Documentation resource and the Generate Flow Documentation From Custom Template operation as requested.

Discussion