Ingerir dados do Workiva

info

Beta

Esse recurso está em Beta. Os administradores do workspace podem controlar o acesso a esse recurso na página Pré-visualizações . Consulte Gerenciar prévias do Databricks.

Esta página mostra como criar um pipeline de ingestão gerenciado do Workiva usando o Lakeflow Connect.

Requisitos

• Para criar um pipeline de ingestão, primeiro atenda aos seguintes requisitos:

  • Seu workspace deve estar habilitado para o Unity Catalog.

  • O compute serverless deve estar habilitado para seu workspace. Consulte Requisitos de compute serverless.

  • Para criar uma nova conexão, você deve ter privilégios CREATE CONNECTION no metastore. Consulte Gerenciar privilégios no Unity Catalog.

    Se o conector for compatível com a criação de pipeline baseada na interface do usuário, um administrador poderá criar a conexão e o pipeline ao mesmo tempo, concluindo os passos nesta página. No entanto, se os usuários que criam pipelines usarem a criação de pipeline baseada em API ou forem usuários não administradores, um administrador deverá primeiro criar a conexão no Catalog Explorer. Consulte Conectar-se a fontes de ingestão gerenciadas.

  • Para usar uma conexão existente, você deve ter privilégios USE CONNECTION ou ALL PRIVILEGES no objeto de conexão.

  • Você deve ter privilégios USE CATALOG no catálogo de destino.

  • Você deve ter os privilégios USE SCHEMA e CREATE TABLE em um esquema existente ou privilégios CREATE SCHEMA no catálogo de destino.

• Para ingerir do Workiva, primeiro configure a autenticação do Databricks e crie uma conexão. Consulte Configure authentication to Workiva e Create a Workiva connection.

Criar um pipeline de ingestão

O conector Workiva disponibiliza três tabelas de origem — activities, users e roles — sob o esquema de origem default. Para detalhes, consulte Tabelas de origem suportadas.

Databricks UI

1. Na barra lateral do workspace do Databricks, clique em Ingestão de dados .
2. Na página Adicionar dados , em Conectores Databricks , clique em Workiva .
3. Na página Conexão do assistente de ingestão, selecione a conexão que armazena suas credenciais Workiva. Se você tiver o privilégio CREATE CONNECTION no metastore, clique em Create connection para criar uma conexão com as credenciais de Configure authentication to Workiva.
4. Clique em Avançar .
5. Na página Ingestion setup , insira um nome para o pipeline.
6. Selecione um catálogo e um esquema para gravar logs de eventos. Se você tiver os privilégios USE CATALOG e CREATE SCHEMA no catálogo, clique em Criar esquema no menu suspenso para criar um esquema.
7. Clique em Criar pipeline e continuar .
8. Na página Source , selecione as tabelas para ingestão: activities, users e roles.
9. Clique em Salvar e continuar .
10. Na página Destination , selecione um catálogo e um esquema para carregar os dados. Se você tiver os privilégios USE CATALOG e CREATE SCHEMA no catálogo, clique em Create schema no menu suspenso para criar um esquema.
11. Clique em Salvar e continuar .
12. (Opcional) Na página Cronogramas e notificações , clique em Crie um agendamento . Defina a frequência para refresh das tabelas de destino.
13. (Opcional) Clique em Adicionar notificação para definir notificações por email para o sucesso ou falha da operação de pipeline.
14. Clique em Save and run pipeline .

Declarative Automation Bundles

Use os Pacotes de Automação Declarativa para gerenciar pipelines do Workiva como código. Os pacotes podem conter definições YAML de Jobs e tarefas, são gerenciados usando a CLI do Databricks e podem ser compartilhados e ter execução em diferentes workspaces de destino (como desenvolvimento, staging e produção). Para obter mais informações, consulte O que são os Pacotes de Automação Declarativa?.

1. Crie um pacote usando a CLI do Databricks:

   Bash

   databricks bundle init

2. Adicione dois novos arquivos de recurso ao pacote:

   • Um arquivo de definição de pipeline (por exemplo, resources/workiva_pipeline.yml). Consulte pipeline.ingestion_definition e Exemplos.
   • Um arquivo de definição de job que controla a frequência da ingestão de dados (por exemplo, resources/workiva_job.yml).

3. Implantar o pipeline usando a CLI do Databricks:

   Bash

   databricks bundle deploy

Databricks notebook

1. Importe o seguinte notebook para o seu workspace do Databricks:

Criar um pipeline de ingestão do Workiva

Abrir notebook em uma nova abaOpen in Databricks

2. Deixe as células um e dois como estão. Não modifique.

3. Modifique a célula três com os detalhes de configuração do seu pipeline. Veja pipeline.ingestion_definition e Exemplos.

4. Opcionalmente, configure as definições avançadas do pipeline. Consulte Padrões comuns para pipelines de ingestão gerenciados.

5. Clique em Executar tudo .

Exemplos

O conector Workiva disponibiliza as tabelas activities, users e roles no esquema de origem default. Para detalhes, consulte Tabelas de origem suportadas.

Ingerir as tabelas Workiva

Declarative Automation Bundles

O seguinte arquivo de definição de pipeline ingere todas as três tabelas do 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

A especificação de pipeline a seguir ingere todas as três tabelas 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)

Ingerir atividades a partir de uma data e hora de início específica

A tabela activities aceita a opção de conector opcional start_datetime, um Timestamp UTC ISO-8601 que define o início da janela de backfill da primeira sincronização. Omita-o para realizar o backfill dos últimos 365 dias. Apenas a tabela activities aceita esta opção. Para obter detalhes, consulte Opções de conector.

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)

Arquivo de definição de job dos Pacotes de Automação Declarativa

O exemplo a seguir é um arquivo de definição de Job para uso com Pacotes de Automação Declarativa. O Job é executado diariamente.

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}

Padrões comuns

Para configurações avançadas de pipeline, consulte Padrões comuns para pipelines de ingestão gerenciados.

Passos seguintes

Comece, programe e defina alertas em seu pipeline. Consulte Tarefas comuns de manutenção de pipeline.

Outros recursos

• Perguntas frequentes sobre o conector Workiva
• Limitações do conector Workiva
• Referência do conector Workiva
• Solucionar problemas do conector do Workiva