Dataiku DSSInstall

Overview

This node integrates with the Dataiku DSS API to perform various operations on Dataiku DSS resources. Specifically, for the Dashboard resource and the Update Dashboard operation, it allows users to update an existing dashboard within a specified project in Dataiku DSS by sending the updated dashboard data.

Common scenarios where this node is beneficial include:

• Automating updates to dashboards as part of a CI/CD pipeline.
• Programmatically modifying dashboard configurations based on external triggers or workflows.
• Integrating dashboard updates into larger data processing or monitoring workflows.

For example, you might use this node to update the layout or widgets of a dashboard after new data has been processed, ensuring that stakeholders always see the latest visualizations without manual intervention.

Properties

Output

The node outputs the response from the Dataiku DSS API after attempting to update the dashboard. The output is structured as JSON and typically contains the updated dashboard object or confirmation details returned by the API.

If the update operation returns binary data (not typical for update operations), it would be provided as binary output, but for updating dashboards, the output is JSON.

Example output structure (simplified):

{
  "id": "dashboard_id",
  "name": "Updated Dashboard Name",
  "description": "Updated description",
  "widgets": [...],
  ...
}

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 Dataiku DSS API and n8n's HTTP request capabilities.

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 "Dashboard ID is required" indicate that mandatory input parameters were not provided. Verify that these fields are correctly filled.
• API Errors: If the API returns errors (e.g., 404 Not Found, 403 Forbidden), check that the project key and dashboard ID exist and that the API key has sufficient permissions.
• Invalid JSON in Request Body: Ensure that the JSON provided in the Request Body property is well-formed and matches the expected schema for a dashboard update.
• Network Issues: Connectivity problems to the Dataiku DSS server will cause request failures; verify network access and server availability.

Links and References

• Dataiku DSS API Documentation - Dashboards
• Dataiku DSS Official Website
• n8n Documentation - Creating Custom Nodes