Skip to main content
Last updated on

Ingest data from Workiva

Beta

This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.

This page shows how to create a managed Workiva ingestion pipeline using Lakeflow Connect.

Requirements​

  • To create an ingestion pipeline, first meet the following requirements:

    • Your workspace must be enabled for Unity Catalog.

    • Serverless compute must be enabled for your workspace. See Serverless compute requirements.

    • To create a new connection, you must have CREATE CONNECTION privileges on the metastore. See Manage privileges in Unity Catalog.

      If the connector supports UI-based pipeline authoring, an admin can create the connection and the pipeline at the same time by completing the steps on this page. However, if the users who create pipelines use API-based pipeline authoring or are non-admin users, an admin must first create the connection in Catalog Explorer. See Connect to managed ingestion sources.

    • To use an existing connection, you must have USE CONNECTION privileges or ALL PRIVILEGES on the connection object.

    • You must have USE CATALOG privileges on the target catalog.

    • You must have USE SCHEMA and CREATE TABLE privileges on an existing schema or CREATE SCHEMA privileges on the target catalog.

  • To ingest from Workiva, first configure authentication from Databricks and create a connection. See Configure authentication to Workiva and Create a Workiva connection.

Create an ingestion pipeline​

The Workiva connector makes available three source tables — activities, users, and roles — under the default source schema. For details, see Supported source tables.

  1. In the sidebar of the Databricks workspace, click Data Ingestion.
  2. On the Add data page, under Databricks connectors, click Workiva.
  3. On the Connection page of the ingestion wizard, select the connection that stores your Workiva credentials. If you have the CREATE CONNECTION privilege on the metastore, click Plus icon. Create connection to create a connection with the credentials from Configure authentication to Workiva.
  4. Click Next.
  5. On the Ingestion setup page, enter a name for the pipeline.
  6. Select a catalog and a schema to write event logs to. If you have USE CATALOG and CREATE SCHEMA privileges on the catalog, click Plus icon. Create schema in the drop-down menu to create a schema.
  7. Click Create pipeline and continue.
  8. On the Source page, select the tables to ingest: activities, users, and roles.
  9. Click Save and continue.
  10. On the Destination page, select a catalog and a schema to load data into. If you have USE CATALOG and CREATE SCHEMA privileges on the catalog, click Plus icon. Create schema in the drop-down menu to create a schema.
  11. Click Save and continue.
  12. (Optional) On the Schedules and notifications page, click Plus icon. Create schedule. Set the frequency to refresh the destination tables.
  13. (Optional) Click Plus icon. Add notification to set email notifications for pipeline operation success or failure.
  14. Click Save and run pipeline.

Examples​

The Workiva connector makes available the activities, users, and roles tables in the default source schema. For details, see Supported source tables.

Ingest the Workiva tables​

The following pipeline definition file ingests all three Workiva tables:

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'

Ingest activities from a specific start datetime​

The activities table accepts the optional start_datetime connector option, a UTC ISO-8601 timestamp that sets the start of the first-sync backfill window. Omit it to backfill the previous 365 days. Only the activities table accepts this option. For details, see Connector options.

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>'

Declarative Automation Bundles job definition file​

The following is an example job definition file for use with Declarative Automation Bundles. The job runs daily.

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}

Common patterns​

For advanced pipeline configurations, see Common patterns for managed ingestion pipelines.

Next steps​

Start, schedule, and set alerts on your pipeline. See Common pipeline maintenance tasks.

Additional resources​

On this page