Dataiku DSSInstall

Overview

This node interacts with the Dataiku DSS API to perform various operations on managed folders within a project. Specifically, for the "Managed Folder" resource and the "Get Managed Folder Settings" operation, it retrieves the settings of a specified managed folder in a given project. This is useful when you want to programmatically access configuration details of managed folders, such as their metadata or permissions, without manually navigating the Dataiku DSS interface.

Common scenarios include:

• Automating audits or reports on managed folder configurations.
• Integrating managed folder settings retrieval into larger workflows that depend on folder metadata.
• Monitoring or validating folder settings as part of a data pipeline.

Example: You have a project with multiple managed folders and want to fetch the settings of a particular folder by its ID to verify its configuration before running downstream processes.

Properties

Output

The node outputs JSON data representing the managed folder's settings object as returned by the Dataiku DSS API. This typically includes metadata about the folder such as its name, description, creation date, permissions, and other configuration details.

If the operation involves downloading files (not applicable here), the node can output binary data representing the file content.

Dependencies

• Requires an active connection to a Dataiku DSS instance.
• Needs an API authentication token credential for 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 are required.

Troubleshooting

• Missing Credentials Error: If the node throws an error about missing API credentials, ensure that the Dataiku DSS API credentials are properly set up in n8n with the correct server URL and API key.
• Required Parameter Errors: The node validates required parameters like Project Key and Folder ID. If these are missing or incorrect, errors will indicate which parameter is required.
• API Request Failures: Network issues, incorrect URLs, or insufficient permissions in Dataiku DSS may cause API request failures. Check connectivity and user permissions.
• JSON Parsing Errors: If the response from the API is not valid JSON, the node attempts to handle it gracefully but may throw errors if unexpected formats are received.

Links and References

• Dataiku DSS API Documentation
• Dataiku DSS Managed Folders API Reference
• n8n Documentation - Creating Custom Nodes