Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API
Join our community

Actions364

Overview

This node integrates with the Dataiku DSS API to perform various operations related to bundles automation-side, specifically including the "Import Bundle From Archive File" operation. It allows users to import a bundle into a specified project from an archive file, facilitating automated deployment or update of project components packaged as bundles.

Common scenarios where this node is beneficial include:

  • Automating the deployment of Dataiku DSS project bundles in CI/CD pipelines.
  • Importing pre-built bundles into projects for testing or production use.
  • Managing project lifecycle by programmatically importing and activating bundles.

For example, a user can automate the import of a new version of a project bundle stored as an archive file into a target project, enabling seamless updates without manual intervention.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project where the bundle will be imported.
Query Parameters Optional additional parameters to customize the import request. Includes options such as:
- active (boolean)
- activity (string)
- allUsers (boolean)
- archivePath (string)
- catalogName (string)
- codeEnvName (string)
- columnName (string)
- columns (string)
- connected (boolean)
- connectionName (string)
- containerExecConfigName (string)
- deletionMode (string) (default: KEEP)
- destination (string)
- dropData (boolean)
- exportAnalysisModels (boolean)
- exportManaged (boolean)
- exportSavedModels (boolean)
- exportUploads (boolean)
- filePart (string)
- filter (string)
- folderId (string)
- folderRef (string)
- forceRebuildEnv (boolean)
- foreign (boolean)
- format (string)
- formatParams (string)
- fullClassName (string)
- fullReguess (boolean)
- includeAllPartitions (boolean)
- includeLibs (boolean)
- limit (number)
- maxDatasetCount (number)
- metricLookup (string)
- minTimestamp (number)
- name (string)
- onlyMonitored (boolean)
- page (number)
- partition (string)
- partitions (string)
- path (string)
- peek (boolean)
- predictionType (string)
- projectFolderId (string)
- publishedProjectKey (string)
- publishedServiceId (string)
- purpose (string) (default: GENERIC_COMPLETION)
- remote (string)
- removeIntermediate (boolean)
- reassignTo (string)
- resultsPerPage (number)
- ruleId (string)
- schemaName (string)
- stepId (string)
- sub-Folder Name (string)
- tags (string)
- targetVariable (string)
- timeseriesIdentifiers (string)
- timeVariable (string)
- triggerId (string)
- triggerRunId (string)
- trustForEverybody (boolean)
- type (string)
- versions (string)
- wait (boolean) (default: true)
- withScenarios (boolean)

Note: The above query parameters are generic and may be used to customize the import behavior depending on the API's capabilities.

Output

The node outputs the response from the Dataiku DSS API call in JSON format under the json field. This typically includes details about the imported bundle or the result of the import operation.

If the operation involves downloading files or archives (not applicable here), the node would output binary data representing the downloaded content.

Dependencies

  • Requires an API key credential for authenticating with the Dataiku DSS API.
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.
  • No other external dependencies are required.

Troubleshooting

  • Missing Credentials Error: If the API key credential is not provided or invalid, the node throws an error indicating missing credentials. Ensure that valid API credentials are configured.
  • Required Parameter Missing: The node validates required parameters like Project Key before making the API call. If missing, it throws descriptive errors. Provide all mandatory parameters.
  • API Request Failures: Network issues, incorrect server URL, or insufficient permissions can cause API call failures. Check connectivity, server address, and user permissions.
  • Invalid Query Parameters: Passing unsupported or malformed query parameters may cause API errors. Verify parameter names and values against the Dataiku DSS API documentation.
  • Unexpected Response Format: If the API returns non-JSON or unexpected responses, the node attempts to handle them gracefully but may fail. Check API server logs for issues.

Links and References

This summary focuses on the "Import Bundle From Archive File" operation within the "Bundles Automation-Side" resource, describing its usage, input properties, output, dependencies, and common troubleshooting tips based on static analysis of the node's source code and provided property definitions.

Discussion