Ingérer des données depuis Workiva

info

Bêta

Cette fonctionnalité est en version bêta. Les administrateurs de Workspace peuvent contrôler l’accès à cette fonctionnalité depuis la page Aperçus . Consultez Gérer les aperçus Databricks.

Cette page explique comment créer un pipeline d'ingestion Workiva géré à l'aide de Lakeflow Connect.

Exigences

• Pour créer un pipeline d'ingestion, remplissez d'abord les conditions suivantes :

  • Votre workspace doit être activé pour Unity Catalog.

  • Le compute serverless doit être activé pour votre workspace. Voir les exigences du compute serverless.

  • Pour créer une nouvelle connexion, vous devez disposer des privilèges CREATE CONNECTION sur le métastore. Voir Gérer les privilèges dans Unity Catalog.

    Si le connecteur prend en charge la création de pipeline basée sur l'interface utilisateur, un administrateur peut créer la connexion et le pipeline en même temps en suivant les étapes sur cette page. Cependant, si les utilisateurs qui créent des pipelines utilisent la création de pipeline basée sur API ou ne sont pas des utilisateurs administrateurs, un administrateur doit d'abord créer la connexion dans Catalog Explorer. Voir Se connecter à des sources d'ingestion gérées.

  • Pour utiliser une connexion existante, vous devez disposer des privilèges USE CONNECTION ou ALL PRIVILEGES sur l'objet de connexion.

  • Vous devez disposer des privilèges USE CATALOG sur le catalogue cible.

  • Vous devez disposer des privilèges USE SCHEMA et CREATE TABLE sur un schéma existant ou des privilèges CREATE SCHEMA sur le catalogue cible.

• Pour ingérer des données depuis Workiva, configurez d’abord l’authentification depuis Databricks et créez une connexion. Voir Configurer l’authentification vers Workiva et Créer une connexion Workiva.

Créer un pipeline d'ingestion

Le connecteur Workiva met à disposition trois tables sources — activities, users et roles — sous le schéma source default. Pour plus de détails, consultez Tables sources prises en charge.

Databricks UI

1. Dans la barre latérale du workspace Databricks, cliquez sur Data Ingestion .
2. Sur la page Add data , sous Connecteurs Databricks , cliquez sur Workiva .
3. Sur la page Connection de l’assistant d’ingestion, sélectionnez la connexion qui stocke vos identifiants Workiva. Si vous disposez du privilège CREATE CONNECTION sur le métastore, cliquez sur Create connection pour créer une connexion avec les identifiants provenant de Configure authentication to Workiva.
4. Cliquez sur Suivant .
5. Sur la page Ingestion setup , saisissez un nom pour le pipeline.
6. Sélectionnez un catalogue et un schéma dans lesquels écrire les logs des événements. Si vous disposez des privilèges USE CATALOG et CREATE SCHEMA sur le catalogue, cliquez sur Créer un schéma dans le menu déroulant pour créer un schéma.
7. Cliquez sur Créer un pipeline et continuer .
8. Sur la page Source , sélectionnez les tables à ingérer : activities, users et roles.
9. Cliquez sur Enregistrer et continuer .
10. Sur la page Destination , sélectionnez un catalogue et un schéma dans lesquels charger les données. Si vous disposez des privilèges USE CATALOG et CREATE SCHEMA sur le catalogue, cliquez sur Créer un schéma dans le menu déroulant pour créer un schéma.
11. Cliquez sur Enregistrer et continuer .
12. (Facultatif) Sur la page Calendriers et notifications , cliquez sur Créer un calendrier . Définissez la fréquence de refresh des tables de destination.
13. (Facultatif) Cliquez sur Ajouter une notification pour définir des notifications par e-mail en cas de succès ou d'échec de l'opération du pipeline.
14. Cliquez sur Enregistrer et exécuter le pipeline .

Declarative Automation Bundles

Utilisez les Declarative Automation Bundles pour gérer les pipelines Workiva en tant que code. Les bundles peuvent contenir des définitions YAML de Jobs et de tâches, sont gérés à l'aide de la CLI Databricks et peuvent être partagés et exécutés dans différents Workspace cibles (tels que le développement, la pré-production et la production). Pour plus d'informations, consultez Que sont les Declarative Automation Bundles ?.

1. Créez un bundle à l'aide de la CLI Databricks :

   Bash

   databricks bundle init

2. Ajoutez deux nouveaux fichiers de ressources au bundle :

   • Un fichier de définition de pipeline (par exemple, resources/workiva_pipeline.yml). Voir pipeline.ingestion_definition et Exemples.
   • Un fichier de définition de job qui contrôle la fréquence d’ingestion des données (par exemple, resources/workiva_job.yml).

3. Déployez le pipeline à l’aide de la CLI Databricks :

   Bash

   databricks bundle deploy

Databricks notebook

1. Importez le notebook suivant dans votre Databricks Workspace :

Créer un pipeline d’ingestion Workiva

Ouvrir le notebook dans un nouvel ongletOuvrir dans Databricks

2. Laissez les cellules un et deux telles quelles. Ne pas modifier.

3. Modifiez la troisième cellule avec les détails de configuration de votre pipeline. Voir pipeline.ingestion_definition et Exemples.

4. Configurez éventuellement les paramètres avancés du pipeline. Consultez Modèles courants pour les pipelines d'ingestion gérés.

5. Cliquez sur Tout exécuter .

Exemples

Le connecteur Workiva met à disposition les tables activities, users et roles dans le schéma source default. Pour plus de détails, consultez Tables sources prises en charge.

Ingérer les tables Workiva

Declarative Automation Bundles

Le fichier de définition de pipeline suivant ingère les trois tables Workiva :

YAML

resources:
  pipelines:
    workiva_pipeline:
      name: workiva_pipeline
      catalog: 'main'
      target: 'workiva_data'
      ingestion_definition:
        connection_name: workiva_connection
        objects:
          - table:
              source_schema: 'default'
              source_table: 'activities'
              destination_catalog: 'main'
              destination_schema: 'workiva_data'
              destination_table: 'activities'
          - table:
              source_schema: 'default'
              source_table: 'users'
              destination_catalog: 'main'
              destination_schema: 'workiva_data'
              destination_table: 'users'
          - table:
              source_schema: 'default'
              source_table: 'roles'
              destination_catalog: 'main'
              destination_schema: 'workiva_data'
              destination_table: 'roles'

Databricks notebook

La spécification de pipeline suivante ingère les trois tables Workiva :

Python

pipeline_name = "workiva_pipeline"
connection_name = "<workiva-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "activities",
          "destination_catalog": "main",
          "destination_schema": "workiva_data",
          "destination_table": "activities"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "users",
          "destination_catalog": "main",
          "destination_schema": "workiva_data",
          "destination_table": "users"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "roles",
          "destination_catalog": "main",
          "destination_schema": "workiva_data",
          "destination_table": "roles"
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Ingérer les activités à partir d'une date et heure de start spécifique

La table activities accepte l’option de connecteur facultative start_datetime, un Timestamp UTC ISO-8601 qui définit le start de la fenêtre de remplissage de la première synchronisation. Omettez-le pour effectuer un remplissage des 365 derniers jours. Seule la table activities accepte cette option. Pour plus de détails, voir Options du connecteur.

Declarative Automation Bundles

YAML

resources:
  pipelines:
    workiva_pipeline:
      name: workiva_pipeline
      catalog: 'main'
      target: 'workiva_data'
      ingestion_definition:
        connection_name: workiva_connection
        objects:
          - table:
              source_schema: 'default'
              source_table: 'activities'
              destination_catalog: 'main'
              destination_schema: 'workiva_data'
              destination_table: 'activities'
              connector_options:
                api_source_connector_options:
                  options:
                    start_datetime: '<start-datetime>'

Databricks notebook

Python

pipeline_spec = {
  "name": "workiva_pipeline",
  "ingestion_definition": {
    "connection_name": "<workiva-connection>",
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "activities",
          "destination_catalog": "main",
          "destination_schema": "workiva_data",
          "destination_table": "activities",
          "connector_options": {
            "api_source_connector_options": {
              "options": {
                "start_datetime": "<start-datetime>"
              }
            }
          }
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Fichier de définition de job Declarative Automation Bundles

Voici un exemple de fichier de définition de job à utiliser avec les Declarative Automation Bundles. Le job s'exécute quotidiennement.

YAML

resources:
  jobs:
    workiva_job:
      name: workiva_job
      schedule:
        quartz_cron_expression: '0 0 0 * * ?'
        timezone_id: 'UTC'
      tasks:
        - task_key: workiva_ingestion
          pipeline_task:
            pipeline_id: ${resources.pipelines.workiva_pipeline.id}

Modèles courants

Pour des configurations de pipeline avancées, consultez Modèles courants pour les pipelines d'ingestion gérés.

Étapes suivantes

start, planifiez et configurez des alertes sur votre pipeline. Voir Tâches courantes de maintenance des pipelines.

Ressources supplémentaires

• FAQ du connecteur Workiva
• Limitations du connecteur Workiva
• Référence du connecteur Workiva
• Dépanner le connecteur Workiva