2023-04-25 16:58:47 +02:00
---
title: workflow
slug: /main-concepts/metadata-standard/schemas/metadataingestion/workflow
---
# MetadataWorkflow
*OpenMetadata Ingestion Framework definition.*
## Properties
- **`id` **: Unique identifier that identifies this pipeline. Refer to *../type/basic.json#/definitions/uuid* .
- **`name` **: Name that identifies this pipeline instance uniquely. Refer to *../type/basic.json#/definitions/entityName* .
- **`openMetadataWorkflowConfig` ** *(object)* : OpenMetadata Ingestion Workflow Config. Cannot contain additional properties.
- **`source` **: Refer to *#/definitions/source* .
- **`processor` **: Refer to *#/definitions/processor* .
- **`sink` **: Refer to *#/definitions/sink* .
- **`stage` **: Refer to *#/definitions/stage* .
- **`bulkSink` **: Refer to *#/definitions/bulkSink* .
- **`workflowConfig` **: Refer to *#/definitions/workflowConfig* .
2023-08-27 10:55:55 +02:00
- **`ingestionPipelineFQN` ** *(string)* : Fully qualified name of ingestion pipeline, used to identify the current ingestion pipeline.
- **`pipelineRunId` **: Unique identifier of pipeline run, used to identify the current pipeline run. Refer to *../type/basic.json#/definitions/uuid* .
2023-04-25 16:58:47 +02:00
## Definitions
- **`sourceConfig` ** *(object)* : Additional connection configuration. Cannot contain additional properties.
- **`config` **
- **`source` ** *(object)* : Configuration for Source component in OpenMetadata Ingestion Framework. Cannot contain additional properties.
- **`type` ** *(string)* : Type of the source connector ex: mysql, snowflake, tableau etc..
- **`serviceName` ** *(string)* : Type of the source connector ex: mysql, snowflake, tableau etc..
- **`serviceConnection` **: Connection configuration for the source. ex: mysql , tableau connection. Refer to *../entity/services/connections/serviceConnection.json#/definitions/serviceConnection* .
- **`sourceConfig` **: Refer to *#/definitions/sourceConfig* .
- **`processor` ** *(object)* : Configuration for Processor Component in the OpenMetadata Ingestion Framework. Cannot contain additional properties.
- **`type` ** *(string)* : Type of processor component ex: pii-processor.
2023-08-27 10:55:55 +02:00
- **`config` **: Refer to *../type/basic.json#/definitions/componentConfig* .
2023-04-25 16:58:47 +02:00
- **`stage` ** *(object)* : Configuration for Stage Component in the OpenMetadata Ingestion Framework. Cannot contain additional properties.
- **`type` ** *(string)* : Type of stage component ex: table-usage.
2023-08-27 10:55:55 +02:00
- **`config` **: Refer to *../type/basic.json#/definitions/componentConfig* .
2023-04-25 16:58:47 +02:00
- **`sink` ** *(object)* : Configuration for Sink Component in the OpenMetadata Ingestion Framework. Cannot contain additional properties.
- **`type` ** *(string)* : Type of sink component ex: metadata.
2023-08-27 10:55:55 +02:00
- **`config` **: Refer to *../type/basic.json#/definitions/componentConfig* .
2023-04-25 16:58:47 +02:00
- **`bulkSink` ** *(object)* : Configuration for BulkSink Component in the OpenMetadata Ingestion Framework. Cannot contain additional properties.
- **`type` ** *(string)* : Type of BulkSink component ex: metadata-usage.
2023-08-27 10:55:55 +02:00
- **`config` **: Refer to *../type/basic.json#/definitions/componentConfig* .
2023-04-25 16:58:47 +02:00
- **`logLevels` ** *(string)* : Supported logging levels. Must be one of: `['DEBUG', 'INFO', 'WARN', 'ERROR']` . Default: `INFO` .
- **`workflowConfig` ** *(object)* : Configuration for the entire Ingestion Workflow. Cannot contain additional properties.
- **`loggerLevel` **: Refer to *#/definitions/logLevels* . Default: `INFO` .
- **`openMetadataServerConfig` **: Refer to *../entity/services/connections/metadata/openMetadataConnection.json* .
2023-08-27 10:55:55 +02:00
- **`config` **: Refer to *../type/basic.json#/definitions/componentConfig* .
2023-04-25 16:58:47 +02:00
2023-10-28 00:07:31 +05:30
Documentation file automatically generated at 2023-10-27 13:55:46.343512.