Dataiku DSSInstall

Overview

This node integrates with the Dataiku DSS API, allowing users to interact programmatically with various Dataiku DSS resources and operations. Specifically for the Scenario resource and the Get Details for Run operation, the node retrieves detailed information about a specific run of a scenario within a project.

Typical use cases include:

• Monitoring the execution details of a scenario run in an automated workflow.
• Fetching run metadata for logging or auditing purposes.
• Integrating scenario run details into broader data pipelines or dashboards.

For example, you might use this node to fetch the status and output details of a scenario run after triggering it, enabling conditional logic based on the run's success or failure.

Properties

Output

The node outputs JSON data representing the detailed information of the specified scenario run. This typically includes metadata such as run status, timestamps, logs, step results, and other relevant execution details provided by the Dataiku DSS API.

If the API returns binary data (not typical for this operation), the node would prepare it accordingly, but for "Get Details for Run" the output is JSON.

Example output structure (simplified):

{
  "runId": "string",
  "status": "string",
  "startTime": "timestamp",
  "endTime": "timestamp",
  "steps": [
    {
      "stepId": "string",
      "status": "string",
      "logs": "string"
    }
  ],
  "logs": "string",
  ...
}

Dependencies

• Requires a valid connection to a Dataiku DSS instance.
• Needs an API key credential 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.
• Network access to the Dataiku DSS API endpoint must be available.

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.
• Required Parameter Errors: The node validates required parameters like Project Key, Scenario ID, and Run ID. Missing any of these will cause an error. Double-check that all required fields are filled.
• API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify connectivity and credentials.
• Unexpected Response Format: If the API response cannot be parsed as JSON, check if the API endpoint has changed or if there are permission issues.

Links and References

• Dataiku DSS API Documentation
• Dataiku Scenarios API Reference
• n8n Documentation - Creating Custom Nodes