[V1: deprecated] Workflow configuration file

This is the description of the JSON configuration file for a Workflow data operation.

A Workflow data operation is used to specify one or several data operation IDs that need to be successfully executed for one target data operation to be triggered.

👁️‍🗨️ Example

{
  "configuration_type": "workflow",
  "configuration_id": "000099_iowa_liquor_workflow_export_cluster_stores",
  "environment": "DEV",
  "short_description": "Launch Iowa Liquor Tailer Demo Export Cluster Stores Tables",
  "account": "000099",
  "activated": true,
  "archived": false,
  "gcp_project_id": "fd-io-jarvis-demo-dlk",
  "authorized_job_ids": ["gbq-to-gbq|000099-build-iowa-liquor-model_DEV"],
  "target_dag": "table-to-storage",
  "extra_parameters": {
    "firestore_conf_doc_id": "000099_iowa_liquor_export_cluster_stores"
  }
}

⚙️ Parameters

ParameterDescription

configuration_type

type: string

mandatory

Type of configuration file. In this case, the value has to be "workflow".

configuration_id

type: string

mandatory

ID of the workflow.

You can pick any name you want, but is has to be unique for this type of configuration file.

Note that in case of conflict, the newly deployed data operation will overwrite the previous one.

environment

type: string

mandatory

Deployment context.

Values: PROD, PREPROD, STAGING, DEV.

short_description

type: string

optional

Short description of the context of the configuration file.

account

type: string

mandatory

Your account ID is a 6-digit number assigned to you by your Tailer Platform administrator.

gcp_project

type: string

optional

ID of the Google Cloud project containing the BigQuery instance to be triggered.

gcp_project_id

type: string

optional

Enter the same value as gcp_project to avoid the question of project selection during a deployment with tailer deploy configuration command.

activated

type: boolean

optional

Flag used to enable/disable the execution of the workflow.

If not specified, the default value will be "true".

archived

type: boolean

optional

Flag used to enable/disable the visibility of the workflow's configuration and runs in Tailer Studio.

If not specified, the default value will be "false".

authorized_job_ids

type: string array

mandatory

Data operations that need to be executed and successful for the current workflow to be triggered.

target_dag

type: string

mandatory

Data operation to trigger.

For Tables to Tables data operations, you need to specify the data operation configuration_id, concatenated with the environment ("_PROD" or "_DEV").

Example: "000099_load_stores_details_PROD"

For Storage to Storage, Storage to Tables et Table to Storage data operations, you only specify the type of data operation with one of the following values:

  • storage-to-storage

  • storage-to-tables

  • table-to-storage

extra_parameters

type: dict

mandatory

This array contains the list of data operations to trigger.

Leave it empty for Tables to Tables data operations, as the target_dag parameter already contains this information.

For other data operations, list one or several firestore_conf_doc_id parameters.

firestore_conf_doc_id

type: string

optional

List of data operations to trigger.

Specify the configuration_id of the data operations to trigger.

Last updated