Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The input fields for this Universal Extension are described in the following table.

Field

Input type

Default value

Type

Description

Airflow Base URL

Required

-

Text

The Base URL of the Airflow server.

Airflow Credentials

Required

-

Credentials

The Apache Airflow account credentials.

They are comprised of:

  • Runtime username

  • Runtime password

Action

Required

Trigger DAG Run

Choice

The action performed upon the task execution.

Valid values are:

  • Trigger Dag Run

  • Read DAG Run Information

  • Read Task Instance Information

DAG Id

Required

-

Dynamic Choice

Dynamic Choice field populated by getting a list of active DAG’s from the server.

DAG Run Id

Optional

-

Text

Id of a specific DAG Run. Required for Action "Read DAG Run Information"/"Read Task Instance Information".

Task Id

Optional

-

Text

Dynamic Choice field populated by getting a list of Task Ids for a specific DAG ID.

Required for Action "Read Task Instance Information"

Use Proxy

Required

False

Boolean

Flag to allow Proxy configuration.

Required when connection to Apache Airflow is through Proxy.

Proxy Servers

Optional

-

Text

Proxy server and port. Valid format: http://proxyserver:port or https://proxyserver:port.

Required when Use Proxy is True.

Use SSL

Required

False

Boolean

Specifies if SSL protocol should be used for the communication with the foreign API.

SSL Hostname Check

Optional

True

Boolean

Determines if the host name of the certificate should be verified against the hostname in the URL.

Required when Use SSL is checked.

SSL Certificate Path

Optional

-

Text

Path and file name of the trusted certificate or CA bundle to use in certificate verification.

The file must be in PEM format.

Task Examples

Trigger a new DAG Run

...

The exit codes for this Universal Extension are described in the following table.

Exit Code

Status Classification Code

Status Classification Description

Status Description

0

SUCCESS

Successful Execution

SUCCESS: Successful Task Execution

1

FAIL

Failed Execution

FAIL: <Error Description>

2

AUTHENTICATION_ERROR

Authentication Error

AUTHENTICATION_ERROR: <Error Description>

3

CONNECTION_ERROR

Connection Error

CONNECTION_ERROR: <Error Description>

20

DATA_VALIDATION_ERROR

Input fields Validation Error

DATA_VALIDATION_ERROR: <Error Description>

21

REQUEST_FAILURE

HTTP request error

REQUEST_FAILED: <Error Description>

Extension Output

The Extension Output samples are available on the task examples above.

...

This document references the following documents:

Name

Location

Description

Universal Templates

https://docs.stonebranch.com/confluence/display/

UC71x

UC71/Universal+Templates

User documentation for creating Universal Templates in the Universal Controller user interface.

Universal Tasks

https://docs.stonebranch.com/confluence/display/

UC71x

UC71/Universal+Tasks

User documentation for creating Universal Tasks in the Universal Controller user interface.

Apache Airflow Documentation

Apache Airflow Documentation

User documentation for Apache Airflow.

Apache Airflow API Documentation

Airflow REST API

User Documentation for Airflow REST API.