Aller au contenu principal
Dernière mise à jour le

Ingérer les rapports Workday

Découvrez comment ingérer des rapports Workday dans Databricks à l'aide de Lakeflow Connect.

Exigences​

  • Pour créer un pipeline d'ingestion, vous devez d'abord satisfaire aux exigences suivantes :

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

    • Le compute Serverless doit être activé pour votre Workspace. Consultez 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 pipelines basée sur l'interface utilisateur, un administrateur peut créer la connexion et le pipeline en même temps en suivant les étapes décrites sur cette page. Cependant, si les utilisateurs qui créent des pipelines utilisent la création de pipelines basée sur l'API ou ne sont pas des utilisateurs administrateurs, un administrateur doit d'abord créer la connexion dans l'Explorateur de catalogues. Voir Connexion aux sources d'ingestion gérées.

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

    • Vous devez disposer de 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 à partir de Workday, vous devez d'abord suivre les étapes de Créer une connexion Workday Reports.

Configurer le réseau​

Si vous avez activé le contrôle de sortie serverless, mettez sur liste blanche les host names de vos URL de rapport. Par exemple, l'URL du rapport https://ww1.workday.com/service/ccx/<tenant>/<reportName>?format=json a le host name https://ww1.workday.com. Consultez Gérer les stratégies réseau pour le contrôle de sortie serverless.

Créez un pipeline d'ingestion​

  1. Dans la barre latérale du workspace Databricks, cliquez sur Ingestion de données .
  2. Sur la page **Ajouter des données**, sous **Connecteurs Databricks**, cliquez sur **Rapports Workday**.
  3. Sur la page Connexion de l’assistant d’ingestion, sélectionnez la connexion qui stocke vos identifiants d’accès Workday Reports. Si vous disposez du CREATE CONNECTION privilège sur le metastore, vous pouvez cliquer sur Icône Plus. ** Créer une connexion** pour créer une nouvelle connexion avec les détails d'authentification dans Créer une connexion Workday Reports.
  4. Cliquez sur Suivant .
  5. Sur la page **Configuration de l'ingestion**, saisissez un nom unique pour le pipeline.
  6. Sélectionnez un catalogue et un schéma pour écrire les Logs d'événements. Si vous disposez des privilèges USE CATALOG et CREATE SCHEMA sur le catalogue, vous pouvez cliquer sur Icône Plus. Créer un schéma dans le menu déroulant pour créer un nouveau schéma.
  7. Cliquez sur Créer un pipeline et continuer .
  8. Sur la page Rapport , cliquez sur Icône Plus. Ajouter un rapport et saisissez l'URL du rapport. Répétez pour chaque rapport que vous souhaitez ingérer.
  9. Cliquez sur Enregistrer et continuer .
  10. Sur la page Destination , sélectionnez un catalogue et un schéma dans lesquels charger des données. Si vous disposez des privilèges USE CATALOG et CREATE SCHEMA sur le catalogue, vous pouvez cliquer sur Icône Plus. Créer un schéma dans le menu déroulant pour créer un nouveau schéma.
  11. Cliquez sur Enregistrer et continuer .
  12. (Facultatif) Sur la page **Planifications et notifications**, cliquez Icône Plus. sur ** Créer une planification**. Définissez la fréquence pour refresh les tables de destination.
  13. (Facultatif) Cliquez sur Icône Plus. Ajouter une notification pour définir les notifications par e-mail en cas de succès ou d'échec de l'opération du pipeline, puis cliquez sur Enregistrer et exécuter le pipeline .

Exemples​

Utilisez ces exemples pour configurer votre pipeline.

Ingérer un rapport unique​

Le fichier de définition de pipeline suivant ingère un seul rapport Workday :

YAML
variables:
  dest_catalog:
    default: main
  dest_schema:
    default: ingest_destination_schema

# The main pipeline for workday_dab
resources:
  pipelines:
    pipeline_workday:
      name: workday_pipeline
      catalog: ${var.dest_catalog}
      schema: ${var.dest_schema}
      ingestion_definition:
        connection_name: <workday-connection>
        objects:
          # An array of objects to ingest from Workday. This example ingests a report about all active employees.
          - report:
              source_url: https://wd2-impl-services1.workday.com/ccx/service/customreport2/All_Active_Employees_Data?format=json
              destination_catalog: ${var.dest_catalog}
              destination_schema: ${var.dest_schema}
              destination_table: All_Active_Employees_Data
              table_configuration:
                primary_keys:
                  - Employee_ID

Ingérer plusieurs rapports​

Le fichier de définition de pipeline suivant ingère deux rapports Workday dans des schémas distincts :

remarque

La prise en charge du pipeline multi-destination est disponible uniquement via l'API. Vous ne pouvez pas configurer plusieurs schémas de destination depuis l'interface utilisateur de Databricks.

YAML
resources:
  pipelines:
    pipeline_workday:
      name: workday_pipeline
      catalog: my_catalog_1 # Location of the pipeline event log
      schema: my_schema_1 # Location of the pipeline event log
      ingestion_definition:
        connection_name: <workday-connection>
        objects:
          - report:
              source_url: <report-url-1>
              destination_catalog: my_catalog_1
              destination_schema: my_schema_1
              destination_table: my_table_1
              table_configuration:
                primary_keys:
                  - <primary_key_column>
          - report:
              source_url: <report-url-2>
              destination_catalog: my_catalog_2
              destination_schema: my_schema_2
              destination_table: my_table_2
              table_configuration:
                primary_keys:
                  - <primary_key_column>

Ingérer de manière incrémentielle, à partir d'une date fixe​

info

Bêta

L'ingestion incrémentielle est en Bêta. Pour les limitations, consultez l'ingestion incrémentielle.

L’exemple suivant ingère un rapport de manière incrémentielle à partir de 2025-02-01, avec un décalage d'un jour par rapport à la date actuelle. sequence_by spécifie la colonne du curseur, et workday_report_parameters.parameters mappe les alias XML de vos invites Workday aux expressions de filtre. Le filtre de start utilise coalesce(current_offset(), date(...)) pour reprendre à partir de la dernière valeur de curseur lors des exécutions ultérieures, ou revenir à la date de début lors de la première exécution.

YAML
variables:
  dest_catalog:
    default: main
  dest_schema:
    default: ingest_destination_schema

resources:
  pipelines:
    pipeline_workday:
      name: workday_pipeline
      catalog: ${var.dest_catalog}
      schema: ${var.dest_schema}
      ingestion_definition:
        connection_name: <workday-connection>
        objects:
          - report:
              source_url: https://wd2-impl-services1.workday.com/ccx/service/customreport2/<report-name>?format=json
              destination_catalog: ${var.dest_catalog}
              destination_schema: ${var.dest_schema}
              destination_table: <destination-table>
              table_configuration:
                primary_keys:
                  - <primary_key_column>
                sequence_by:
                  - <cursor_column>
                workday_report_parameters:
                  parameters:
                    <Start_Filter_XML_Alias>: '{coalesce(current_offset(), date("2025-02-01"))}'
                    <End_Filter_XML_Alias>: '{current_date() - INTERVAL 1 DAY}'

Ingérer de manière incrémentielle à l'aide d'une fenêtre glissante​

info

Bêta

L'ingestion incrémentielle est en Bêta. Pour les limitations, consultez l'ingestion incrémentielle.

L'exemple suivant réingère toujours les 30 derniers jours à chaque exécution en définissant les deux filtres par rapport à current_date() sans coalesce.

YAML
variables:
  dest_catalog:
    default: main
  dest_schema:
    default: ingest_destination_schema

resources:
  pipelines:
    pipeline_workday:
      name: workday_pipeline
      catalog: ${var.dest_catalog}
      schema: ${var.dest_schema}
      ingestion_definition:
        connection_name: <workday-connection>
        objects:
          - report:
              source_url: https://wd2-impl-services1.workday.com/ccx/service/customreport2/<report-name>?format=json
              destination_catalog: ${var.dest_catalog}
              destination_schema: ${var.dest_schema}
              destination_table: <destination-table>
              table_configuration:
                primary_keys:
                  - <primary_key_column>
                sequence_by:
                  - <cursor_column>
                workday_report_parameters:
                  parameters:
                    <Start_Filter_XML_Alias>: '{current_date() - INTERVAL 30 DAY}'
                    <End_Filter_XML_Alias>: '{current_date()}'

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 tous les jours, exactement un jour après la dernière exécution.

YAML
resources:
  jobs:
    workday_dab_job:
      name: workday_dab_job

      trigger:
        periodic:
          interval: 1
          unit: DAYS

      email_notifications:
        on_failure:
          - <email-address>

      tasks:
        - task_key: refresh_pipeline
          pipeline_task:
            pipeline_id: ${resources.pipelines.pipeline_workday.id}

Modèles courants​

Pour les 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. Consultez les Tâches de maintenance courantes du pipeline.

Expressions prises en charge pour les paramètres d'invite​

Lors de la configuration de l'ingestion incrémentielle, les valeurs d'invite workday_report_parameters doivent utiliser une syntaxe d'expression prise en charge. Les expressions arbitraires ne sont pas prises en charge.

Primitives prises en charge :

  • current_date() — Date du jour au start du pipeline, au format YYYY-MM-DD.
  • date("YYYY-MM-DD") — Une date fixe. Doit utiliser le format YYYY-MM-DD.
  • current_date() - INTERVAL N DAY ou date("...") - INTERVAL N DAY — Soustrait N jours d'une date. N doit être un entier positif. Seul DAY est pris en charge (pas WEEK, MONTH, etc.). Seule la soustraction (-) est prise en charge.
  • coalesce(current_offset(), <fallback>) — Pour l'ingestion incrémentielle. Lors de la première exécution, utilise l’expression de fallback. Lors des exécutions ultérieures, utilise la dernière valeur de curseur ingérée, suivie automatiquement par le pipeline. Le fallback peut être l'une des autres primitives prises en charge.

Règles :

Règle

Détail

Accolades requises

Chaque valeur de paramètre doit être encapsulée dans { et }

Format de date

Doit être YYYY-MM-DD. Aucun autre format n'est pris en charge.

Seule la soustraction

+ n'est pas pris en charge. Seulement - INTERVAL N DAY.

Seule l'unité de jour

WEEK``MONTH, YEAR et HOUR ne sont pas pris en charge.

Nombres entiers positifs uniquement

INTERVAL -1 DAY est non valide. Utilisez INTERVAL 1 DAY.

Un coalesce par URL

Vous pouvez utiliser au plus une expression coalesce() par URL de rapport. En utiliser plus d'un provoque une erreur.

Aucune fonction imbriquée.

coalesce(current_offset(), coalesce(...)) n'est pas valide.

current_offset() uniquement à l'intérieur coalesce

current_offset() ne peut pas être utilisé de manière autonome ou dans l'arithmétique INTERVAL.

Espaces

Les espaces de début/de fin autour de l'expression sont acceptables. Les espaces à l'intérieur des noms de fonction ne sont pas valides.

Noms des paramètres

Doit correspondre aux noms d'invite exacts configurés dans votre rapport personnalisé Workday.

Règle

Détail

Accolades requises

Chaque valeur de paramètre doit être encapsulée dans { et }

Format de date

Doit être YYYY-MM-DD. Aucun autre format n'est pris en charge.

Seule la soustraction

+ n'est pas pris en charge. Seulement - INTERVAL N DAY.

Seule l'unité de jour

WEEK``MONTH, YEAR et HOUR ne sont pas pris en charge.

Nombres entiers positifs uniquement

INTERVAL -1 DAY est non valide. Utilisez INTERVAL 1 DAY.

Un coalesce par URL

Vous pouvez utiliser au plus une expression coalesce() par URL de rapport. En utiliser plus d'un provoque une erreur.

Aucune fonction imbriquée.

coalesce(current_offset(), coalesce(...)) n'est pas valide.

current_offset() uniquement à l'intérieur coalesce

current_offset() ne peut pas être utilisé de manière autonome ou dans l'arithmétique INTERVAL.

Espaces

Les espaces de début/de fin autour de l'expression sont acceptables. Les espaces à l'intérieur des noms de fonction ne sont pas valides.

Noms des paramètres

Doit correspondre aux noms d'invite exacts configurés dans votre rapport personnalisé Workday.

remarque

Utilisez coalesce(current_offset(), <fallback>) uniquement dans l'invite de start (par exemple, Date_Start), pas dans l'invite de fin. Si vous utilisez coalesce dans l'invite finale, la limite de fin est fixée après la première exécution et le pipeline récupère la même plage de données à chaque mise à jour.

L'invite finale doit toujours être déterministe et évolutive : utilisez current_date(), current_date() - INTERVAL N DAY ou un date("YYYY-MM-DD") fixe.

Ressources supplémentaires​

Sur cette page