Skip to main content

データ系列接続

Alteryx Oneを使用して、Serverから外部データカタログに系列メタデータを転送します。各ワークスペースは、Serverとカタログ間の1対1の接続に対応しています。

注意

データ系列機能を有効にするには、ServerとAlteryx Oneの間の通信に使用されるサービスプリンシパルに管理者ロールを割り当てる必要があります。管理者ロールをベースにして機能が制限されたカスタムロールは、現在サポートされていません。

その結果、サービスプリンシパルは、一時的に想定よりも幅広い権限を必要とします。この制限は、Alteryx Oneにのみ影響し、ServerまたはServer上で実行されているコードに影響はありません。この問題はすでに認識されており、今後のアップデートで解決する予定です。

始めに

Alteryx OneのIPアドレスがホワイトリストに登録されていることを確認します。これらのIPアドレスは、ドキュメントページの「Alteryx One Platformの使用を開始する」に記載されています。

Alteryx Server実行のデータ系列情報は、パイプラインメタデータをキャプチャするためのオープン標準であるOpenLineage形式で提供されます。これにより、CollibraやAtlanなどのOpenLineageイベントの主要な利用者とのシームレスな連携が可能になり、ガバナンス、ディスカバリー、コラボレーションがサポートされます。CollibraとAtlanは、Alteryxによる設定または管理の対象外であることに注意してください。

サポートされているツールと接続タイプの詳細については、列レベルの系列でサポートされているツールを参照してください。

データ系列のセキュリティ

系列情報は、ServerにもCloudにも保存されません。データは転送中のみ流れ、TLS暗号化を使用して暗号化されます。

Alteryx Serverから系列クラウドサービスに送信されるデータ

Alteryx Serverでワークフローが実行されると、ワークフローレベルでデータ系列情報が収集されます。

ワークフローが実行されると、以下のイベントが発生します。

  • START: ワークフローの実行が開始します。

  • RUNNING: ワークフローが実行状態になります。結果に進むまで、この状態またはループを維持する可能性があります。

  • 結果の状態: 実行後、ワークフローが移行する可能性があるのは以下のいずれかです。

    • COMPLETE: ワークフローが正常に完了します。

    • ABORT: ワークフローが完了前に意図的に停止されます。

    • FAIL: ワークフローでエラーが発生し、失敗します。

イベントごとに、系列クラウドサービスがOpenLineageイベントを作成するために必要な関連メタデータを収集します。

例

実行開始時に送信されるSTARTイベント

{
    "eventTime": "2024-11-22T00:00:00Z",
    "eventType": "START",
    "job": {
        "name": "TestWorkflow"
    },
    "run": {
        "runId": "00000000-0000-0000-0000-000000000000"
    }
}

入出力データセットの確立時に送信されるRUNNINGイベント

{
    "eventTime": "2024-11-22T00:01:00Z",
    "eventType": "RUNNING",
    "run": {
        "runId": "00000000-0000-0000-0000-000000000000"
    },
    "job": {
        "name": "TestWorkflow"
    },
    "inputs": [
        {
            "name": "input_a.csv",
            "namespace": "file"
        }
    ]
}

実行成功時に送信されるCOMPLETEイベント

{
    "eventTime": "2024-11-22T00:04:00Z",
    "eventType": "COMPLETE",
    "run": {
        "runId": "00000000-0000-0000-0000-000000000000"
    },
    "job": {
        "name": "TestWorkflow"
    }
}

実行失敗時に送信されるFAILイベント

{
    "eventTime": "2024-10-21T14:30:00Z",
    "eventType": "FAIL",
    "run": {
        "runId": "00000000-0000-0000-0000-000000000000"
    },
    "job": {
        "name": "TestWorkflow"
    }
}

追加のメタデータ

これらのイベントがトリガーされると、AlteryxServiceは関連するすべてのイベントを集約し、最終的に系列クラウドサービスに送信するために。以下のような追加のメタデータを提供します。

  • job.name: ワークフロー名とサービスアプリIDを含む連結文字列。

    例: GenerateSalesDetail|01JTKMDMZPXDD8NY51XKR5A5F

  • Owner: ワークフロー所有者のユーザーID。

  • Studio: ワークフローのスタジオに関連付けられているサブスクリプションID(手動実行の場合のみ)。

  • Server URL: Server UIのワークフロー詳細ページに誘導するServer URL。

    serviceIdは、appInfos.serviceIdフィールドに対応し、AS_Applications.idフィールド(または、AS_QueueレコードのAS__application_id)にマップされます。

  • ServerJob.id: 固有のジョブ識別子。

系列クラウドサービスから系列利用者に送信されるデータ

系列クラウドサービスは、Alteryx Serverからメタデータを受信すると、関連する整形済みのOpenLineageイベントを系列コンシューマーに送信します。

データセットレベルの系列情報の例

OpenLineageのSTART JSONの例

{
  "eventType": "START",
  "eventTime": "2024-12-20T13:39:37.554Z", 
  "run": {
    "runId": "acde070d-8c4c-4f0d-9d8a-162843c10333" 
  },
  "job": {
    "namespace": "Alteryx-demo",
    "name": "Lineage Connection Workflow|5ea20186a171a51bc4c37155", 
  },
  "producer": "us1.alteryxcloud.com/lineageservice:0.0.1 ",
  "schemaUrl": "https://tools.ietf.org/html/rfc6901"
}

OpenLineageのCOMPLETE JSONの例

{
  "eventType": "COMPLETE",
  "eventTime": "2024-12-20T14:00:37.554Z", 
  "run": {
    "runId": "acde070d-8c4c-4f0d-9d8a-162843c10333" 
  },
  "job": {
    "namespace": "Alteryx-demo", 
    "name": "Lineage Connection Workflow|5ea20186a171a51bc4c37155"
  },
   "inputs": [{
    "namespace": "snowflake://tjb31106",
    "name": "AYX_LINEAGE_DB.ELLENS_DATA.AYX_COLORADO_STORES_SUMMARIZE"
  },
            {
    "namespace": "file",
    "name": "E:/ProgramData/Alteryx/Service/Staging/State Population Output.yxdb"
            }],
  "outputs": [
    {
        "namespace": "file",
        "name": "E:/ProgramData/Alteryx/Service/Staging/State Population Output.yxdb"
      },
    {
    "namespace": "snowflake://tjb31106",
    "name": "AYX_LINEAGE_DB.ELLENS_DATA.LAINE_TABLE"
  }],
  "producer": "us1.alteryxcloud.com/lineageservice:0.0.1 ",
  "schemaUrl": "https://tools.ietf.org/html/rfc6901"
}

OpenLineageのFAIL JSONの例

{
  "eventType": "FAIL",
  "eventTime": "2024-12-20T14:00:37.554Z", 
  "run": {
    "runId": "acde070d-8c4c-4f0d-9d8a-162843c10333" 
  },
  "job": {
    "namespace": "Alteryx-demo",
    "name": "Lineage Connection Workflow|5ea20186a171a51bc4c37155"
  },
   "inputs": [{
    "namespace": "snowflake://tjb31106",
    "name": "AYX_LINEAGE_DB.ELLENS_DATA.AYX_COLORADO_STORES_SUMMARIZE"
  },
            {
    "namespace": "file",
    "name": "E:/ProgramData/Alteryx/Service/Staging/State Population Output.yxdb"
            }],
  "outputs": [ 
    {
        "namespace": "file",
        "name": "E:/ProgramData/Alteryx/Service/Staging/State Population Output.yxdb"
      },
    {
    "namespace": "snowflake://tjb31106",
    "name": "AYX_LINEAGE_DB.ELLENS_DATA.LAINE_TABLE"
  }],
  "producer": "us1.alteryxcloud.com/lineageservice:0.0.1 ",
  "schemaUrl": "https://tools.ietf.org/html/rfc6901"
}

OpenLineageのABORT JSONの例

{
  "eventType": "ABORT",
  "eventTime": "2024-12-20T14:00:37.554Z",
  "run": {
    "runId": "acde070d-8c4c-4f0d-9d8a-162843c10333" 
  },
  "job": {
    "namespace": "Alteryx-demo",
    "name": "Lineage Connection Workflow|5ea20186a171a51bc4c37155"
  },
   "inputs": [{
    "namespace": "snowflake://tjb31106",
    "name": "AYX_LINEAGE_DB.ELLENS_DATA.AYX_COLORADO_STORES_SUMMARIZE"
  },
            {
    "namespace": "file",
    "name": "E:/ProgramData/Alteryx/Service/Staging/State Population Output.csv"
            }],
  "outputs": [
    {
        "namespace": "file",
        "name": "E:/ProgramData/Alteryx/Service/Staging/State Population Output.csv"
      },
    {
    "namespace": "snowflake://tjb31106",
    "name": "AYX_LINEAGE_DB.ELLENS_DATA.LAINE_TABLE"
  }],
  "producer": "us1.alteryxcloud.com/lineageservice:0.0.1 ",
  "schemaUrl": "https://tools.ietf.org/html/rfc6901" 
}

列レベルの系列情報の例

OpenLineageのCOMPLETE JSONの例

{
    "eventType": "COMPLETE",
    "eventTime": "2025-10-06T17:46:27.695Z",
    "run": {
        "runId": "173fc3f9-1501-4749-beae-32b56796596e",
        "facets": {
            "nominalTime": null,
            "parent": null
        }
    },
    "job": {
        "namespace": "AlteryxTest",
        "name": "ProductSales|68c48138430ae827850e8498",
        "facets": {
            "documentation": null,
            "sourceCodeLocation": {
                "_producer": "https://ayx-sandbox.bender.rocks/data-lineage-service/v1/datalineage",
                "_schemaURL": "https://openlineage.io/spec/facets/1-0-1/SourceCodeLocationJobFacet.json",
                "type": "Alteryx Server",
                "url": "http://AYX-LT-5MGCB54/gallery/#/app/app/68c48138430ae827850e8498/?type=service"
            },
            "sql": null,
            "jobType": null,
            "ownership": {
                "owners": [
                    {
                        "name": "68b9acee6065b0e905f38ea3",
                        "type": "USER"
                    },
                    {
                        "name": "68b9acee6065b0e905f38ea0",
                        "type": "SUBSCRIPTION"
                    }
                ],
                "_producer": "https://ayx-sandbox.bender.rocks/data-lineage-service/v1/datalineage",
                "_schemaURL": "https://openlineage.io/spec/facets/1-0-1/OwnershipJobFacet.json"
            },
            "serverJob": {
                "id": "68e40070b8565a17ce0ac2e7",
                "_producer": "https://ayx-sandbox.bender.rocks/data-lineage-service/v1/datalineage",
                "_schemaURL": "https://openlineage.io/spec/2-0-2/OpenLineage.json#/definitions/BaseFacet"
            }
        }
    },
    "inputs": [
        {
            "namespace": "file",
            "name": "C:\\ProgramData\\Alteryx\\Service\\Staging\\45816_d3034dfd34e946a48485299407c307a0\\_externals\\1\\Products.xlsx",
            "facets": {
                "documentation": null,
                "schema": null,
                "dataSource": null,
                "description": null,
                "lifecycleStateChange": null,
                "columnLineage": null,
                "symlinks": null
            },
            "inputFacets": {},
            "outputFacets": null
        },
        {
            "namespace": "file",
            "name": "C:\\ProgramData\\Alteryx\\Service\\Staging\\45816_d3034dfd34e946a48485299407c307a0\\_externals\\1\\OrderDetails.xlsx",
            "facets": {
                "documentation": null,
                "schema": null,
                "dataSource": null,
                "description": null,
                "lifecycleStateChange": null,
                "columnLineage": null,
                "symlinks": null
            },
            "inputFacets": {},
            "outputFacets": null
        }
    ],
    "outputs": [
        {
            "namespace": "file",
            "name": "C:\\ProgramData\\Alteryx\\Service\\Staging\\45816_d3034dfd34e946a48485299407c307a0\\_externals\\1\\TotalSales.csv",
            "facets": {
                "documentation": null,
                "schema": null,
                "dataSource": null,
                "description": null,
                "lifecycleStateChange": null,
                "columnLineage": {
                    "_producer": "https://ayx-sandbox.bender.rocks/data-lineage-service/v1/datalineage",
                    "_schemaURL": "https://openlineage.io/spec/facets/1-2-0/ColumnLineageDatasetFacet.json",
                    "fields": {
                        "OrderID": {
                            "inputFields": [
                                {
                                    "namespace": "file",
                                    "name": "C:\\ProgramData\\Alteryx\\Service\\Staging\\45816_d3034dfd34e946a48485299407c307a0\\_externals\\1\\OrderDetails.xlsx",
                                    "field": "OrderID",
                                    "transformations": [
                                        {
                                            "subtype": "IDENTITY",
                                            "type": "DIRECT"
                                        }
                                    ]
                                }
                            ],
                            "transformationDescription": null,
                            "transformationType": null
                        },
                        "Category": {
                            "inputFields": [
                                {
                                    "namespace": "file",
                                    "name": "C:\\ProgramData\\Alteryx\\Service\\Staging\\45816_d3034dfd34e946a48485299407c307a0\\_externals\\1\\Products.xlsx",
                                    "field": "Category",
                                    "transformations": [
                                        {
                                            "subtype": "IDENTITY",
                                            "type": "DIRECT"
                                        }
                                    ]
                                }
                            ],
                            "transformationDescription": null,
                            "transformationType": null
                        },
                        "NewCount": {
                            "inputFields": [
                                {
                                    "namespace": "file",
                                    "name": "C:\\ProgramData\\Alteryx\\Service\\Staging\\45816_d3034dfd34e946a48485299407c307a0\\_externals\\1\\OrderDetails.xlsx",
                                    "field": "Quantity",
                                    "transformations": [
                                        {
                                            "subtype": "TRANSFORMATION",
                                            "type": "DIRECT"
                                        }
                                    ]
                                }
                            ],
                            "transformationDescription": null,
                            "transformationType": null
                        },
                        "ProductID": {
                            "inputFields": [
                                {
                                    "namespace": "file",
                                    "name": "C:\\ProgramData\\Alteryx\\Service\\Staging\\45816_d3034dfd34e946a48485299407c307a0\\_externals\\1\\Products.xlsx",
                                    "field": "ProductID",
                                    "transformations": [
                                        {
                                            "subtype": "IDENTITY",
                                            "type": "DIRECT"
                                        }
                                    ]
                                }
                            ],
                            "transformationDescription": null,
                            "transformationType": null
                        },
                        "TotalSale": {
                            "inputFields": [
                                {
                                    "namespace": "file",
                                    "name": "C:\\ProgramData\\Alteryx\\Service\\Staging\\45816_d3034dfd34e946a48485299407c307a0\\_externals\\1\\OrderDetails.xlsx",
                                    "field": "Quantity",
                                    "transformations": [
                                        {
                                            "subtype": "TRANSFORMATION",
                                            "type": "DIRECT"
                                        }
                                    ]
                                },
                                {
                                    "namespace": "file",
                                    "name": "C:\\ProgramData\\Alteryx\\Service\\Staging\\45816_d3034dfd34e946a48485299407c307a0\\_externals\\1\\Products.xlsx",
                                    "field": "UnitPrice",
                                    "transformations": [
                                        {
                                            "subtype": "TRANSFORMATION",
                                            "type": "DIRECT"
                                        }
                                    ]
                                }
                            ],
                            "transformationDescription": null,
                            "transformationType": null
                        },
                        "ProductName": {
                            "inputFields": [
                                {
                                    "namespace": "file",
                                    "name": "C:\\ProgramData\\Alteryx\\Service\\Staging\\45816_d3034dfd34e946a48485299407c307a0\\_externals\\1\\Products.xlsx",
                                    "field": "ProductName",
                                    "transformations": [
                                        {
                                            "subtype": "IDENTITY",
                                            "type": "DIRECT"
                                        }
                                    ]
                                }
                            ],
                            "transformationDescription": null,
                            "transformationType": null
                        },
                        "OrderDetailID": {
                            "inputFields": [
                                {
                                    "namespace": "file",
                                    "name": "C:\\ProgramData\\Alteryx\\Service\\Staging\\45816_d3034dfd34e946a48485299407c307a0\\_externals\\1\\OrderDetails.xlsx",
                                    "field": "OrderDetailID",
                                    "transformations": [
                                        {
                                            "subtype": "IDENTITY",
                                            "type": "DIRECT"
                                        }
                                    ]
                                }
                            ],
                            "transformationDescription": null,
                            "transformationType": null
                        }
                    }
                },
                "symlinks": null
            },
            "inputFacets": null,
            "outputFacets": {}
        }
    ],
    "producer": "https://ayx-sandbox.bender.rocks/data-lineage-service/v1/datalineage",
    "schemaURL": "https://openlineage.io/spec/2-0-2/OpenLineage.json#/$defs/RunEvent"
}

系列クラウドサービスに保存されるデータ

系列クラウドサービスと系列コンシューマー間の接続を確立するために使用される設定情報のみを保存します。

データ保持期間: 無期限。

例

Atlanの設定

  • OpenLineageエンドポイント: https://alteryx.atlan.com/v1/lineage

  • OpenLineage名前空間: Alteryx-Atlan

  • 認証方法: Bearerトークン

  • Bearerトークン: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiMTIzNDU2IiwidXNlcm5hbWUiOiJ0ZXN0X3VzZXIiLCJleHAiOjE3MTQ5MDYwMDB9.SflKxwRJS

Collibraの設定

  • エンドポイント: http://localhost:8888/debug.test

  • 名前空間: Alteryx_Collibra

  • 認証方法: なし

データ系列接続の設定

データ系列接続を設定するには、[管理者コンソール] > [データ系列接続]に移動します。

データ利用者: 外部データカタログ

データカタログ接続の設定、編集、または削除。

データカタログ接続の設定

Serverからの系列メタデータの転送を有効にするには、AtlanやCollibraなどのデータカタログを設定します。

  1. メニューで、[管理者コンソール] > [データ系列接続]に移動します。

  2. [データ利用者]で、外部データカタログの[設定]を選択します。

  3. [データカタログの設定]ページが開きます。

  4. データカタログがパブリックインターネットからアクセスできないプライベートネットワーク環境にデプロイされている場合は、[プライベートネットワーク]で、[データカタログはプライベートネットワークにあります]チェックボックスをオンにします。

  5. [OpenLineage Endpoint]に、AlteryxがOpenLineageイベントデータを送る完全なURLを入力します。

  6. [OpenLineage Namespace]に、OpenLineageジョブの名前空間を入力します。名前空間の要件の詳細については、データカタログのドキュメントを参照してください。

  7. [認証方法]で、ドロップダウンから認証方法を選択します。

    [なし]または[Bearerトークン]を選択します。

    • [なし]を選択すると、データカタログに接続するときに認証資格情報が渡されません。このオプションは、カタログに認証が必要ない場合にのみ使用します。カタログに認証が必要な場合に[なし]を選択すると、接続が失敗します。

    • [Bearerトークン]を選択した場合は、データカタログで作成されたトークンを[Bearerトークン]フィールドに入力します。

  8. [データ系列レベル]で、ドロップダウンから[データセット]または[列]を選択します。

    [データ系列レベル]は、系列追跡をどのくらい詳細にするかを定義します。この設定は、新しい実行にのみ適用されます。系列サービスがダウンしている場合、Serverは最後に認識した設定を使用するか、既定でデータセットレベルになります。サービスが復旧すると、新しい実行は選択したレベルに基づいて処理されます

    接続タイプの詳細については、「列レベルの系列でサポートされているツール」の「サポートされている接続タイプ」セクションを参照してください。

    • データセットレベルでのみ系列を定義する場合は、[データセット]を選択します。Alteryxはマッピング情報を送信しません。

      データセットレベルの系列は、データセット全体(テーブル、ファイル、ビューなど)をシステム間でどのように移動して変換するかを示します。データフローの大まかな概要を提供します。

    • 系列を個々の列まで定義する場合は、[列]を選択します。

      列レベルの系列は、データセット内の個々のフィールドまたは属性の変遷を追跡します。各列がどのように生成、変換、集計されたかを正確に説明します。詳細については、「列レベルの系列でサポートされているツール」を参照してください。

  9. この接続をテストするには、[接続テスト]を選択します。

    注記

    ステップ4で[データカタログはプライベートネットワークにあります]チェックボックスをオンにした場合、[接続テスト]ボタンはグレーアウトされます。接続をテストするには、[Alteryxシステム設定] > [コントローラー] > [接続 - Alteryx One]に移動します。詳細については、コントローラーを参照してください。

  10. [保存]を選択します。

これで、データカタログ接続の設定が完了しました。[データ利用者]セクションの下に表示されます。

データカタログ接続の編集または削除

[データ利用者]セクションに移動し、編集または削除するデータ接続を見つけます。次に、[詳細を表示]を選択して、[データカタログ接続の詳細]を表示します。

データカタログ接続を編集するには、[編集]を選択します。

データカタログ接続を削除するには、三点リーダーメニュー(⋮)を選択してから、[削除]を選択します。

データソース: Server

外部データカタログを設定したら、Alteryx OneをServerに接続して、系列メタデータをデータカタログに転送できます。

Server接続の設定

系列メタデータをカタログに送信するには、ServerがAlteryx Oneワークスペースに接続できるようにします。

  1. メニューで、[管理者コンソール] > [データ系列接続]に移動します。

  2. [データソース]で、Serverの[設定]を選択します。

  3. [Serverの設定]ページが開きます。

  4. このワークスペースでServerを識別できるように、[サーバー名]を入力します。

  5. Serverリンクペイロードを生成します。生成するには、[Serverリンクペイロードを作成する]に移動し、[ペイロードの生成]を選択します。それをコピーして[Alteryxシステム設定]に貼り付け、設定を完了します。Serverリンクペイロードを入力する場所やServerでそれをテストする方法の詳細については、コントローラーを参照してください。

    ペイロードには、サービスプリンシパルに関連付けられたクライアントIDとクライアントシークレットが含まれます。

  6. [完了]を選択します。

これでServer接続の設定が完了しました。

Server接続の編集または削除

[データソース]セクションに移動し、編集または削除するServerデータ接続を見つけます。次に、[詳細を表示]を選択して、[Server接続の詳細]を表示します。

データカタログ接続を編集するには、[編集]を選択します。

データカタログ接続を削除するには、三点リーダーメニュー(⋮)を選択してから、[削除]を選択します。

このセクションの内容: