各製品の資料を入手。
詳細はこちら →
製品をチェック
AWS Glue ジョブからZendesk のデータにJDBC 経由で接続
Amazon S3 でホストされているCData JDBC ドライバーを使用してAWS Glue ジョブからZendesk にデータ連携。
最終更新日：2023-09-07
この記事で実現できるZendesk 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
AWS Glue はAmazon のETL サービスであり、簡単にデータプレパレーションを実行してストレージおよび分析用に読み込むことができます。AWS Glue と一緒にPySpark モジュールを使用すると、JDBC 接続経由でデータを処理するジョブを作成し、そのデータをAWS データストアに直接読み込むことができます。ここでは、CData JDBC Driver for Zendesk をAmazon S3 バケットにアップロードし、Zendesk からデータを抽出してCSV ファイルとしてS3 に保存するためのAWS Glue ジョブを作成・実行する方法について説明します。
CData JDBC Driver for Zendesk をAmazon S3 バケットにアップロード
CData JDBC Driver for Zendesk をAWS Glue から使用するには、ドライバーの.jar ファイル（および必要なライセンスファイル）をAmazon S3 のバケットに配置する必要があります。
- Amazon S3 コンソールを開きます。
- バケットを選択、もしくは作成します。
- ［アップロード］をクリックします。
- JDBC Driver の.jar ファイル(cdata.jdbc.zendesk.jar) をインストールディレクトリのlib フォルダから選択してアップロードします。
Amazon Glue Job を設定
- ［分析］->［AWS Glue］をクリックします。
- AWS Glue コンソールで、［ETL］->［ジョブ］をクリックします。
- ［ジョブの追加］をクリックして新しいGlue ジョブを作成します。
- ジョブのプロパティを設定します:
- 名前: ZendeskGlueJob など任意のジョブ名
- IAM ロール: AWSGlueServiceRole もしくは AmazonS3FullAccessSelect の権限があるIAM ロールを設定（JDBC Driver がAmazon S3 バケットにあるため）。
- Type: ［Spark］を選択。
- Glue version: ドロップダウンからバージョンを選択。
- このジョブ実行: ［ユーザーが作成する新しいスクリプト］を選択。
スクリプトプロパティの設定: - スクリプトファイル名: GlueZendeskJDBC などのスクリプトファイル名。
- スクリプトが保存されているS3 パス: S3 バケットを入力もしくは選択。
- 一時ディレクトリ: S3 バケットを入力もしくは選択
- ETL 言語: ［Python］を選択
- セキュリティ設定、スクリプトライブラリおよびジョブパラメータを展開。依存JARS パスは、JDBC の.jar ファイルをアップロードしたS3 バケットに設定。.jar ファイル名 s3://mybucket/cdata.jdbc.zendesk.jar も含めます。
- ［次へ］をクリックすると、ほかのAWS エンドポイントへの接続オプション追加ができます。Redshift、MySQL などに接続する際にはここで接続を作成できます。
- ［ジョブの保存とスクリプトの編集］をクリックします。
- 開いたエディタで、Python スクリプトを記述します。サンプルは以下です。
サンプルGlue スクリプト
CData JDBC driver でZendesk に接続するには、JDBC URL を作成します。さらにライセンスとしてJDBC URL にRTK プロパティを設定する必要があります。RTK は通常のライセンスと異なりますので、CData まで直接ご連絡をください。
Zendesk 接続プロパティの取得・設定方法
Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL（Zendesk Support URL）を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。
また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。
Zendesk への認証
Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証（レガシー）です。
API トークン認証
API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthScheme をAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。
- Token アクセスを有効にします。
- Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
その他の認証方法についてはヘルプドキュメントを参照してください。
ビルトイン接続文字列デザイナー
JDBC URL の作成をサポートするビルトインの接続文字列デザイナーがあります。ドライバーの.jar ファイルをダブルクリックするか、コマンドラインで.jar ファイルを実行するとデザイナーが開きます。
java -jar cdata.jdbc.zendesk.jar
必要項目を入力すると、デザインs－下部に接続文字列が生成されますのでクリップボードにコピーして使います。
CData JDBC driver をPySpark で使用して、AWS Glue モジュールでZendesk のデータを取得して、S3 にCSV 形式で保存するシンプルなスクリプト例は以下です。
import sys
from awsglue.transforms import *
from awsglue.utils import getResolvedOptions
from pyspark.context import SparkContext
from awsglue.context import GlueContext
from awsglue.dynamicframe import DynamicFrame
from awsglue.job import Job
args = getResolvedOptions(sys.argv, ['JOB_NAME'])
sparkContext = SparkContext()
glueContext = GlueContext(sparkContext)
sparkSession = glueContext.spark_session
##Use the CData JDBC driver to read Zendesk データ from the Tickets table into a DataFrame
##Note the populated JDBC URL and driver class name
source_df = sparkSession.read.format("jdbc").option("url","jdbc:zendesk:RTK=5246...;URL=https://subdomain.zendesk.com;[email protected];Password=test123;").option("dbtable","Tickets").option("driver","cdata.jdbc.zendesk.ZendeskDriver").load()
glueJob = Job(glueContext)
glueJob.init(args['JOB_NAME'], args)
##Convert DataFrames to AWS Glue's DynamicFrames Object
dynamic_dframe = DynamicFrame.fromDF(source_df, glueContext, "dynamic_df")
##Write the DynamicFrame as a file in CSV format to a folder in an S3 bucket.
##It is possible to write to any Amazon data store (SQL Server, Redshift, etc) by using any previously defined connections.
retDatasink4 = glueContext.write_dynamic_frame.from_options(frame = dynamic_dframe, connection_type = "s3", connection_options = {"path": "s3://mybucket/outfiles"}, format = "csv", transformation_ctx = "datasink4")
glueJob.commit()
Glueジョブを実行する
スクリプト記述後、Glue ジョブを実行します。実行した取得/ロードのジョブが完了するとAWS Glue コンソールのジョブページでステータスが確認できます。成功するとS3 バケットにZendesk のデータのCSV ファイルが生成されています。
このようにCData JDBC Driver for Zendesk をAWS Glue で使用することで、Zendesk のデータをAWS Glue で自在に扱うことができます。Glue の外部データへの接続性を拡張するJDBC Driver を是非お試しください。
関連コンテンツ
