Domo Pipeline
In this section, we provide guides and references to use the Domo-Pipeline connector.
Configure and schedule Domo-Pipeline metadata and profiler workflows from the OpenMetadata UI:
If you don't want to use the OpenMetadata Ingestion container to configure the workflows via the UI, then you can check the following docs to connect using Airflow SDK or with the CLI.
Requirements
OpenMetadata 0.12 or later To deploy OpenMetadata, check the Deployment guides.
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.
Note
For metadata ingestion, kindly make sure add alteast data scopes to the clientId provided.
Question related to scopes, click here.
Metadata Ingestion
1. Visit the Services Page
The first step is ingesting the metadata from your sources. Under Settings, you will find a Services link an external source system to OpenMetadata. Once a service is created, it can be used to configure metadata, usage, and profiler workflows.
To visit the Services page, select Services from the Settings menu.
Find Services under the Settings menu
2. Create a New Service
Click on the Add New Service button to start the Service creation.
Add a new Service from the Services page
3. Select the Service Type
Select DomoPipeline as the service type and click Next.
Select your service from the list
4. Name and Describe your Service
Provide a name and description for your service as illustrated below.
Service Name
OpenMetadata uniquely identifies services by their Service Name. Provide a name that distinguishes your deployment from other services, including the other {connector} services that you might be ingesting metadata from.
Provide a Name and description for your Service
5. Configure the Service Connection
In this step, we will configure the connection settings required for this connector. Please follow the instructions below to ensure that you've configured the connector to read from your domopipeline service as desired.
Configure the service connection by filling the form
Once the credentials have been added, click on Test Connection and Save
the changes.
Test the connection and save the Service
Connection Options
- Client ID: Client Id for DOMO Pipeline.
- Secret Token: Secret Token to Connect to DOMO Pipeline.
- Access Token: Access to Connect to DOMO Pipeline.
- API Host: API Host to Connect to DOMO Pipeline.
- SandBox Domain: Connect to SandBox Domain.
6. Configure Metadata Ingestion
In this step we will configure the metadata ingestion pipeline, Please follow the instructions below
Configure Metadata Ingestion Page
Metadata Ingestion Options
- Name: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.
- Pipeline Filter Pattern (Optional): Use to pipeline filter patterns to control whether or not to include pipeline as part of metadata ingestion.
- Include: Explicitly include pipeline by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all pipeline with names matching one or more of the supplied regular expressions. All other schemas will be excluded.
- Exclude: Explicitly exclude pipeline by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all pipeline with names matching one or more of the supplied regular expressions. All other schemas will be included.
- Include lineage (toggle): Set the Include lineage toggle to control whether or not to include lineage between pipelines and data sources as part of metadata ingestion.
- Enable Debug Log (toggle): Set the Enable Debug Log toggle to set the default log level to debug, these logs can be viewed later in Airflow.
7. Schedule the Ingestion and Deploy
Scheduling can be set up at an hourly, daily, or weekly cadence. The timezone is in UTC. Select a Start Date to schedule for ingestion. It is optional to add an End Date.
Review your configuration settings. If they match what you intended, click Deploy to create the service and schedule metadata ingestion.
If something doesn't look right, click the Back button to return to the appropriate step and change the settings as needed.
Schedule the Ingestion Pipeline and Deploy
After configuring the workflow, you can click on Deploy to create the pipeline.
8. View the Ingestion Pipeline
Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.
View the Ingestion Pipeline from the Service Page
9. Workflow Deployment Error
If there were any errors during the workflow deployment process, the Ingestion Pipeline Entity will still be created, but no workflow will be present in the Ingestion container.
You can then edit the Ingestion Pipeline and Deploy it again.
Edit and Deploy the Ingestion Pipeline
From the Connection tab, you can also Edit the Service if needed.