Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API to perform a wide range of operations related to Dataiku projects and resources. Specifically, for the Flow Documentation resource with the operation Generate Flow Documentation From File Template, it allows users to generate flow documentation by using a template file stored in a managed folder within a Dataiku project.

Common scenarios where this node is beneficial include:

  • Automating the generation of project flow documentation based on predefined templates.
  • Integrating flow documentation generation into larger automation workflows.
  • Using custom or default templates stored in managed folders to standardize documentation output.

Practical example:

  • A user wants to generate updated flow documentation for a Dataiku project automatically whenever the project changes. They can configure this node to use a specific template file from a managed folder and trigger the documentation generation process via the API.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku project where the flow documentation will be generated.
Query Parameters Optional additional query parameters to customize the API request (e.g., filters, flags).

The Query Parameters collection supports many optional fields such as active, archivePath, folderId, format, limit, page, wait, and others that can influence the behavior of the API call. For this operation, these parameters are appended as URL query parameters.

Name Meaning
data The content of the template file to upload (used in some operations but not specifically here).

Note: For the "Generate Flow Documentation From File Template" operation, the key required property is the Project Key and optionally query parameters like folderId to specify the managed folder containing the template file.

Output

The node outputs JSON data representing the response from the Dataiku DSS API after requesting flow documentation generation. The structure depends on the API response but typically includes metadata about the generated documentation or status information.

If the operation involves downloading files (not this one specifically), the node can output binary data representing documents or archives.

For this operation, the output is JSON indicating the result of the documentation generation request, such as success confirmation or error details.

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.
  • The managed folder containing the template file must exist and be accessible in the specified project.

Troubleshooting

  • Missing Credentials Error: If the API key credential is not provided or invalid, the node throws an error indicating missing credentials.
  • Missing Required Parameters: The node validates required parameters like Project Key and Folder ID; if missing, it throws descriptive errors.
  • API Request Failures: Network issues, incorrect URLs, or permission problems may cause API request failures. Check the Dataiku DSS server accessibility and user permissions.
  • Invalid Template File: If the template file in the managed folder is missing or corrupted, the documentation generation may fail.
  • Timeouts or Long Processing: Generating documentation might take time; ensure the wait parameter is set appropriately if supported.

Links and References

This summary focuses on the Flow Documentation resource and the Generate Flow Documentation From File Template operation, describing its purpose, inputs, outputs, dependencies, and common troubleshooting points based on static analysis of the node's source code and provided property definitions.

Discussion