Skip to main content

Set Properties in Task State

Set one of more properties in State Config for a particular Task.

Category: Other

How it works

Run Databricks Notebook '<<NotebookPath>>' and use the results to set State properties on Task '<<TargetTaskCode>>'

To use this activity within the API, use an ActivityCode of SET-TASK-STATE.

Example JSON​

An example of what the Task Config would look like for a task using this activity. Some of these variables would be set at the group level to avoid duplication between tasks.

{
  "TargetTaskCode": "",
  "NotebookPath": "/Users/fred.nurks@example.com/MyRepo/My Notebook",
  "NotebookParameters": { "Param1": "Value1", "Param2": "Value2" }
}

Variable Reference​

The following variables are supported:

  • AdditionalNotebooks (Optional) - The path to other notebooks, Python files etc., referenced by the main notebook.

  • DatabricksClusterId (Optional) - The Databricks Cluster to use for this task.

  • IsFederated (Optional) - Makes task available to other Insight Factories within this organisation.

  • MaximumNumberOfAttemptsAllowed (Optional) - The total number of times the running of this Task can be attempted.

  • MinutesToWaitBeforeNextAttempt (Optional) - If a Task run fails, the number of minutes to wait before re-attempting the Task.

  • NotebookParameters (Optional) - Parameters for use in the Databricks Notebook. This is JSON format e.g. { "Param1": "Value1", "Param2": "Value2" }.

  • NotebookPath (Required) - The relative path to the Databricks Notebook.

  • TargetTaskCode (Required) - Code of the Task to set the State for. You can add multiple Task Codes here by comma-separating them.