Update subscription

Description

This Task triggers an update of a subscription in Tableau. It uses this endpoint. Orchestra searches for the subscription based on the subscription_name parameter that is part of the Task. If Orchestra cannot find the subscription, the Task will fail.

NOTE: it is possible for multiple subscriptions in Tableau to have the same name as they are not unique. If that is the case, this Task will not work as expected. Please contact us if you think this will cause you a problem. Otherwise, we suggest enforcing unique subscription names.

NOTE: this endpoint only work for Tableau Cloud and not Tableau Server. They are different endpoints as described here.

Use Cases

This Task is useful for changing the schedule of a subscription based on some upstream data in your pipeline. For example, you might only want to trigger an update of a subscription if some previous data test in Snowflake has failed. This has a number of advantages:

  • You can co-ordinate tasks outside of Tableau

  • You can update subscriptions independently of each other and only based on certain conditions

  • Orchestra abstracts the complexity of the REST API, making it easy to use instantly

Parameters

These parameters are required to run the Update subscription Task:

To change the schedule of a subscription in Tableau Cloud, you can use the following JSON object:

{
  "subscription": {},
  "schedule": {
    "frequency": "Daily",
    "frequencyDetails": {
      "start": "15:30:00",
      "end": "15:30:00",
      "intervals": {
        "interval": [
          {
            "hours": "24"
          },
          {
            "weekDay": "Sunday"
          }
        ]
      }
    }
  }
}

This will update the schedule of the subscription to run at 15:30 every Sunday.

Last updated