Обновление рабочей книги Tableau с извлечениями после завершения задания

Обновлен

Webhooks

Advanced

Menu

Введение

Это руководство научит вас, как обновить рабочую книгу Tableau, использующую извлечения, когда задание в dbt Cloud успешно завершено и доступны свежие данные. Интеграция будет:

• Получать уведомление вебхука в Zapier
• Запускать обновление рабочей книги Tableau

Предварительные условия

Для настройки интеграции вам необходимо быть знакомым с:

• Вебхуками dbt Cloud
• Zapier
• API Tableau
• Версией REST API Tableau, совместимой с вашим сервером

Получение учетных данных для аутентификации от Tableau

Чтобы аутентифицироваться с помощью API Tableau, получите Персональный токен доступа от вашего экземпляра Tableau Server/Cloud. Кроме того, убедитесь, что ваша рабочая книга Tableau использует источники данных, которые позволяют доступ для обновления, что обычно устанавливается при публикации.

Создание нового Zap в Zapier

Чтобы запустить действие при доставке вебхука в Zapier, вам нужно создать новый Zap с Webhooks by Zapier в качестве Триггера и Catch Raw Hook в качестве События. Однако, если вы решите не проверять подлинность вашего вебхука, что не рекомендуется, вы можете выбрать Catch Hook вместо этого.

Нажмите Continue, затем скопируйте URL вебхука.

Настройка нового вебхука в dbt Cloud

Чтобы настроить подписку на вебхук для dbt Cloud, следуйте инструкциям в Создание подписки на вебхук. Для события выберите Run completed и измените список Jobs, чтобы включить только те задания, которые должны запускать обновление отчета.

Не забудьте сохранить секретный ключ вебхука для последующего использования. Вставьте URL вебхука, полученный из Zapier на шаге 2, в поле Endpoint и протестируйте конечную точку.

После того как вы протестировали конечную точку в dbt Cloud, вернитесь в Zapier и нажмите Test Trigger, что создаст пример тела вебхука на основе тестового события, отправленного dbt Cloud.

Значения в примере тела жестко закодированы и не отражают ваш проект, но они дают Zapier правильно сформированный объект во время разработки.

Хранение секретов

На следующем шаге вам понадобятся секретный ключ вебхука из предыдущего шага и ваши учетные данные для аутентификации Tableau. В частности, вам понадобятся URL вашего сервера/сайта Tableau, имя сервера/сайта, имя PAT и секрет PAT.

Zapier позволяет хранить секреты, что предотвращает отображение ваших ключей в открытом виде в коде Zap. Вы сможете получить к ним доступ через утилиту StoreClient.

Это руководство предполагает, что имена для секретных ключей: DBT_WEBHOOK_KEY, TABLEAU_SITE_URL, TABLEAU_SITE_NAME, TABLEAU_API_TOKEN_NAME и TABLEAU_API_TOKEN_SECRET. Если вы используете другие имена, убедитесь, что вы обновили все ссылки на них в примере кода.

Это руководство использует краткосрочное действие кода для хранения секретов, но вы также можете использовать инструмент, такой как Postman, для взаимодействия с REST API или создать отдельный Zap и вызвать Set Value Action.

a. Создание подключения Storage by Zapier

Создайте новое подключение на https://zapier.com/app/connections/storage, если у вас его еще нет, и запомните сгенерированный секрет UUID для последующего использования.

b. Добавление временного шага кода

Выберите Run Python в качестве События и введите следующий код:

store = StoreClient('abc123') #замените на ваш секрет UUID
store.set('DBT_WEBHOOK_KEY', 'abc123') #замените на ваш ключ вебхука dbt Cloud
store.set('TABLEAU_SITE_URL', 'abc123') #замените на ваш URL сайта Tableau, включая https:// и .com
store.set('TABLEAU_SITE_NAME', 'abc123') #замените на имя вашего сайта/сервера Tableau
store.set('TABLEAU_API_TOKEN_NAME', 'abc123') #замените на имя вашего токена API Tableau
store.set('TABLEAU_API_TOKEN_SECRET', 'abc123') #замените на ваш секрет API Tableau

Протестируйте шаг, чтобы выполнить код. Вы можете удалить это действие, когда тест пройдет успешно. Ключи останутся сохраненными, если к ним будет доступ хотя бы раз в три месяца.

Добавление действия кода

Выберите Code by Zapier в качестве Приложения и Run Python в качестве События.

В области Set up action добавьте два элемента в Input Data: raw_body и auth_header. Свяжите их с полями 1. Raw Body и 1. Headers Http Authorization из шага Catch Raw Hook выше.

В поле Code вставьте следующий код, заменив YOUR_STORAGE_SECRET_HERE в конструкторе StoreClient на секрет UUID, который вы создали при настройке интеграции Storage by Zapier, и заменив переменные workbook_name и api_version на фактические значения.

Следующий код проверяет подлинность запроса и получает ID рабочей книги для указанного имени рабочей книги. Затем код отправит команду обновления рабочей книги в API Tableau для данного ID рабочей книги.

import requests
import hashlib
import json
import hmac

# Доступ к секретным учетным данным
secret_store = StoreClient('YOUR_STORAGE_SECRET_HERE')
hook_secret = secret_store.get('DBT_WEBHOOK_KEY')
server_url = secret_store.get('TABLEAU_SITE_URL')
server_name = secret_store.get('TABLEAU_SITE_NAME')
pat_name = secret_store.get('TABLEAU_API_TOKEN_NAME')
pat_secret = secret_store.get('TABLEAU_API_TOKEN_SECRET')

# Введите имя рабочей книги для обновления
workbook_name = "YOUR_WORKBOOK_NAME"
api_version = "ENTER_COMPATIBLE_VERSION"

# Проверка подлинности вебхука, поступающего из dbt Cloud
auth_header = input_data['auth_header']
raw_body = input_data['raw_body']

signature = hmac.new(hook_secret.encode('utf-8'), raw_body.encode('utf-8'), hashlib.sha256).hexdigest()

if signature != auth_header:
    raise Exception("Calculated signature doesn't match contents of the Authorization header. This webhook may not have been sent from dbt Cloud.")

full_body = json.loads(raw_body)
hook_data = full_body['data'] 

if hook_data['runStatus'] == "Success":

    # Аутентификация с сервером Tableau для получения токена аутентификации
    auth_url = f"{server_url}/api/{api_version}/auth/signin"
    auth_data = {
        "credentials": {
            "personalAccessTokenName": pat_name,
            "personalAccessTokenSecret": pat_secret,
            "site": {
                "contentUrl": server_name
            }
        }
    }
    auth_headers = {
        "Accept": "application/json",
        "Content-Type": "application/json"
    }
    auth_response = requests.post(auth_url, data=json.dumps(auth_data), headers=auth_headers)

    # Извлечение токена для использования в последующих вызовах
    auth_token = auth_response.json()["credentials"]["token"]
    site_id = auth_response.json()["credentials"]["site"]["id"]

    # Извлечение ID рабочей книги
    workbooks_url = f"{server_url}/api/{api_version}/sites/{site_id}/workbooks"
    workbooks_headers = {
        "Accept": "application/json",
        "Content-Type": "application/json",
        "X-Tableau-Auth": auth_token
    }
    workbooks_params = {
        "filter": f"name:eq:{workbook_name}"
    }
    workbooks_response = requests.get(workbooks_url, headers=workbooks_headers, params=workbooks_params)

    # Назначение ID рабочей книги
    workbooks_data = workbooks_response.json()
    workbook_id = workbooks_data["workbooks"]["workbook"][0]["id"]

    # Обновление рабочей книги
    refresh_url = f"{server_url}/api/{api_version}/sites/{site_id}/workbooks/{workbook_id}/refresh"
    refresh_data = {}
    refresh_headers = {
        "Accept": "application/json",
        "Content-Type": "application/json",
        "X-Tableau-Auth": auth_token
    }

    refresh_trigger = requests.post(refresh_url, data=json.dumps(refresh_data), headers=refresh_headers)
    return {"message": "Обновление рабочей книги поставлено в очередь"}

Тестирование и развертывание

Чтобы внести изменения в ваш код, вы можете изменить его и протестировать снова. Когда вы будете довольны результатом, вы можете опубликовать ваш Zap.