Dataiku DSSInstall

Overview

This node integrates with the Dataiku DSS API, enabling users to interact programmatically with various Dataiku DSS resources and operations. Specifically, for the Flow Documentation resource with the Download Flow Documentation operation, it allows downloading generated flow documentation files from a specified project.

Common scenarios where this node is beneficial include:

• Automating retrieval of flow documentation for projects in Dataiku DSS.
• Integrating flow documentation downloads into larger workflows or pipelines.
• Archiving or processing flow documentation files automatically after generation.

For example, a user can configure this node to download the latest flow documentation export by specifying the project key and the export ID, then use the downloaded document in subsequent workflow steps such as sending via email or storing in a document management system.

Properties

Output

The output contains the downloaded flow documentation file in binary form under the binary.data field. The file is typically a .docx document representing the flow documentation exported from the Dataiku DSS project.

Example output structure (simplified):

{
  "binary": {
    "data": {
      "data": "<base64-encoded content>",
      "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "fileName": "flow_documentation.docx"
    }
  }
}

Dependencies

• Requires an active connection to a Dataiku DSS instance.
• Requires valid API credentials (an API key) for authentication with the Dataiku DSS API.
• The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.
• No additional external dependencies beyond the n8n environment and the Dataiku DSS API.

Troubleshooting

• Missing Credentials Error: If the node throws an error about missing credentials, ensure that the Dataiku DSS API credentials are properly set up in n8n.
• Required Parameters Missing: Errors like "Project Key is required" or "Export ID is required" indicate that these mandatory input properties were not provided. Make sure to fill these fields.
• API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify connectivity and credential validity.
• Unexpected Response Format: If the response cannot be parsed as JSON or binary, check if the export ID corresponds to a valid flow documentation export.

Links and References

• Dataiku DSS API Documentation
• Dataiku DSS Flow Documentation
• n8n Documentation on Creating Custom Nodes

This summary focuses on the Flow Documentation resource and the Download Flow Documentation operation as requested, based on static analysis of the provided source code and property definitions.