このトピックでは、DataWorks の Function Compute ノードを使用して Function Compute を呼び出し、OSS 内の増分 PDF ファイルに定期的にウォーターマークを追加する方法について説明します。
背景情報
DataWorks は Function Compute ノードを使用して Function Compute を呼び出します。これにより、DataWorks ワークフローの一部としてカスタムロジックを実行できます。
前提条件
Function Compute が有効化されていること。詳細については、「関数をすばやく作成する」をご参照ください。
OSS が有効化されていること。詳細については、「OSS の有効化」をご参照ください。バケットを作成し、ウォーターマークを追加する PDF ファイルをアップロードします。この例では、バケット
bucket-test222に 2023-08-15 という名前のディレクトリを作成し、example.pdf をこのディレクトリにアップロードします。
制限事項
-
機能の制限
DataWorks はイベント関数の呼び出しのみをサポートしており、HTTP 関数はサポートしていません。したがって、定期的にスケジューリングしたいタスクにはイベント関数を使用する必要があります。関数の種類についての詳細は、「関数の種類」をご参照ください。
-
リージョンの制限
Function Compute 機能は、中国 (杭州)、中国 (上海)、中国 (北京)、中国 (深セン)、中国 (成都)、中国 (香港)、シンガポール、マレーシア (クアラルンプール)、インドネシア (ジャカルタ)、ドイツ (フランクフルト)、イギリス (ロンドン)、米国 (シリコンバレー)、および米国 (バージニア) の各リージョンにあるワークスペースでのみ利用可能です。
ステップ 1:Function Compute アプリケーションの作成
Function Compute コンソールにログインします。左側のナビゲーションペインで、アプリケーション をクリックします。
[アプリケーション] ページで、[アプリケーションの作成] をクリックし、[テンプレートを使用してアプリケーションを作成] を選択します。検索ボックスで、「add watermark to PDF files」 を検索します。テンプレートリストで、pdf-watermark テンプレートを見つけ、そのカードにポインターを合わせてから、今すぐ作成 をクリックします。
説明pdf-watermark アプリケーションのソースコードは GitHub で入手できます。このアプリケーションは、OSS 内の PDF ファイルに指定されたウォーターマークを追加し、ウォーターマークが追加されたファイルを同じ OSS の場所に新しいファイルとして保存します。
[アプリケーションの作成] のパラメータを設定します。
パラメータ
説明
デプロイタイプ
[直接デプロイ] を選択します。
[アプリケーション名]
規則に準拠した名前が自動的に生成されます。ビジネス要件に基づいて変更できます。
[ロール名]
デフォルトでは、AliyunFCServerlessDevsRole が選択されています。必要に応じて、このロールのポリシーを設定できます。
Serverless App Center を介してアプリケーションをデプロイする場合、他のクラウドサービスにアクセスする必要がある場合があります。たとえば、Function Compute サービスおよび関数リソースをデプロイしたり、VPC、NAS、SLS リソースを作成または更新したりする必要がある場合があります。このような場合、Function Compute に必要なアクセス許可を付与する必要があります。まず、RAM サービスロールをアプリケーションまたは環境に関連付け、次に信頼できるサービスとしてFunction Computeを設定します。Serverless App Center は AssumeRole を使用してクラウドサービスにアクセスします。
認証を簡素化するために、Serverless App Center は AliyunFCServerlessDevsRole という名前のデフォルトのシステムロールを提供します。このロールには、Serverless App Center が一部のクラウドリソースにアクセスするために必要な権限が含まれています。RAM ロール管理コンソールにログインして、AliyunFCServerlessDevsRole ロールの権限を表示できます。
[リージョン]
アプリケーションが作成されるリージョン。[OSS バケット名] を選択する場合、このリージョン内の OSS バケットのみを選択できます。
[関数名]
規則に準拠した名前が自動的に生成されます。ビジネス要件に基づいて変更できます。
[タイムゾーン]
現在のリージョンのタイムゾーンが自動的に選択されます。ビジネス要件に基づいて変更できます。
OSS バケット名
アプリケーションと同じリージョンにあるバケットのみを選択できます。
RAM ロール ARN
デフォルトでは、AliyunFcDefaultRole が選択されています。必要に応じて変更できます。
認証を簡素化するために、Function Compute は AliyunFcDefaultRole という名前のデフォルトのサービスロールを提供します。このロールには、Function Compute が一部のクラウドリソースにアクセスするために必要な権限が含まれています。デフォルトロール AliyunFcDefaultRole の作成とバインド方法については、「ステップ 1:Function Compute の有効化」をご参照ください。
説明作成中に、選択したアプリケーションで追加の権限が必要になった場合は、権限付与へ をクリックします。
[デフォルト環境を作成してデプロイ] をクリックします。詳細ページに [デプロイ済み] と表示されたら、デプロイは完了です。
アプリケーションページで、アプリケーション名をクリックしてアプリケーション詳細ページに移動します。
[デフォルト環境] セクションで、[環境詳細] タブをクリックし、次に 関数 名をクリックして 関数 詳細ページに移動します。
関数名は、ページ下部の [リソース情報] エリアの [関数リソース] セクションにあります (例:
pdf_add_watermark_t36b)。テスト をクリックしてパラメーターを入力し、機能をテストします。
[イベント名]:イベント名を入力します。
[イベント内容]:JSON 形式で内容を入力します。この例では、次の内容を使用します。
重要次の JSON の例をコピーする場合は、
//で始まるコメントを削除する必要があります。削除しないと、JSON の検証に失敗します。// 次の設定では、20 ポイントの Helvetica フォントを使用して、PDF ファイル 2023-08-15/example.pdf にウォーターマークテキスト「DataWorks」を追加します。各パラメーターの意味については、以降のコメントを参照してください。 { "pdf_file": "2023-08-15/example.pdf", // OSS バケット内の PDF ファイルのパス。 "mark_text": "DataWorks", // ウォーターマークテキスト。PDF ファイルにウォーターマークを追加する場合、このパラメータは必須です。 "pagesize": [595.275590551181, 841.8897637795275], // オプション。デフォルトのページサイズは A4 (21 cm × 29.7 cm) で、1 cm は 28.346456692913385 に相当します。 "font": "Helvetica", // オプション。デフォルトのフォントは Helvetica です。中国語テキストの場合、zenhei または microhei を使用できます。 "font_size": 20, // オプション。デフォルトのフォントサイズは 30 です。 "font_color": [0, 0, 0], // RGB 形式のフォントカラー。デフォルトの色は黒です。 "rotate": 30, // オプション。デフォルトの回転角度は 0 です。 "opacity": 0.1, // オプション。デフォルトの不透明度は 0.1 です。値 1 は、テキストが不透明であることを示します。 "density": [198.4251968503937, 283.46456692913387] // ウォーターマークの密度。デフォルト値は [141.73228346456693, 141.73228346456693] で、(7 cm、10 cm) に相当します。これは、ウォーターマーク間の間隔が x 軸で 7 cm、y 軸で 10 cm であることを意味します。 }
[関数のテスト] をクリックします。実行が成功すると、ソースファイルと同じ OSS ディレクトリにウォーターマークが追加された PDF ファイルが作成されます。この例では、出力ファイルは
example-out.pdfです。OSS でファイルを確認します。
OSS バケットのファイルリストには、ソースファイル
example.pdfと生成されたウォーターマーク付きファイルexample-out.pdfが含まれています。
ステップ 2:Function Compute ノードの設定
DataWorks コンソールにログインします。
上部メニューで、「ステップ 1:Function Compute アプリケーションの作成」で指定したリージョンに切り替えます。
左側のナビゲーションペインで、[データ開発とO&M] > データ開発 を選択します。ワークスペースを選択して、データ開発ページに移動します。
対象の ビジネスフロー の名前をクリックします。展開された 汎用 ノードを右クリックし、Function Compute を選択します。表示されたダイアログボックスにノード名を入力し、OK をクリックして Function Compute ノードを作成します。
Function Compute ノードのパラメータを設定します。
パラメータ
説明
[関数の選択]
「ステップ 1」で作成した関数を選択します。新しい関数を作成するには、「関数の管理」をご参照ください。
説明DataWorks はイベント関数の呼び出しのみをサポートしており、HTTP 関数はサポートしていません。したがって、定期的にスケジューリングしたいタスクにはイベント関数を使用する必要があります。関数の種類についての詳細は、「関数の種類」をご参照ください。
[バージョンまたはエイリアスの選択]
関数を呼び出す際に使用するサービスバージョンまたはエイリアスを選択します。デフォルトのバージョンは LATEST です。この例では、デフォルトバージョン を選択します。
-
サービスバージョン
Function Compute は、サービスレベルのバージョン管理機能を提供し、サービスの 1 つ以上のバージョンを公開できます。バージョンを公開すると、Function Compute は、その設定、関数コード、および関数設定を含むサービスのスナップショットを作成します。トリガーは含まれません。その後、Function Compute は将来の使用のためにスナップショットにバージョン番号を自動的に割り当てます。詳細については、「バージョンの公開」をご参照ください。
-
バージョンエイリアス
Function Compute では、サービスバージョンにエイリアスを作成できます。エイリアスは特定のバージョンを指し、公開、ロールバック、カナリアリリースなどの操作を容易にします。エイリアスは、サービスやバージョンから独立して存在することはできません。エイリアスを使用してサービスや関数にアクセスすると、Function Compute はエイリアスが指すバージョンに解決します。呼び出し元は特定のバージョンを知る必要はありません。詳細については、「エイリアスの作成」をご参照ください。
[呼び出し方式]
この例では、同期 を選択します。詳細については、「同期呼び出し」と「非同期呼び出し」をご参照ください。
-
同期呼び出し:イベントが直接関数をトリガーします。Function Compute は関数を実行し、応答を待ちます。関数が呼び出された後、Function Compute は実行結果を返します。
-
非同期呼び出し:Function Compute はイベントリクエストをキューに入れ、リクエストが完了するのを待たずにすぐにレスポンスを返します。
-
関数が時間のかかる、リソースを大量に消費する、またはエラーが発生しやすいロジックを含む場合、非同期呼び出しを使用して応答速度を向上させ、トラフィックスパイクを確実に処理できます。
-
1 時間以上実行される Function Compute タスクには、非同期呼び出しを使用します。
-
[変数]
これらは関数を呼び出すためのパラメータです。この例では、「イベント内容」セクションの JSON を変更して、OSS 内の新しい PDF ファイルに毎日ウォーターマークを追加します。
// 次の設定では、${current_date}/example.pdf にある PDF ファイルにウォーターマークを追加します。 { "pdf_file": "${current_date}/example.pdf", // OSS バケット内の PDF ファイルのパス。 "mark_text": "DataWorks", // ウォーターマークテキスト。PDF ファイルにウォーターマークを追加する場合、このパラメータは必須です。 "pagesize": [595.275590551181, 841.8897637795275], // オプション。デフォルトのページサイズは A4 (21 cm × 29.7 cm) で、1 cm は 28.346456692913385 に相当します。 "font": "Helvetica", // オプション。デフォルトのフォントは Helvetica です。中国語テキストの場合、zenhei または microhei を使用できます。 "font_size": 20, // オプション。デフォルトのフォントサイズは 30 です。 "font_color": [0, 0, 0], // RGB 形式のフォントカラー。デフォルトの色は黒です。 "rotate": 30, // オプション。デフォルトの回転角度は 0 です。 "opacity": 0.1, // オプション。デフォルトの不透明度は 0.1 です。値 1 は、テキストが不透明であることを示します。 "density": [198.4251968503937, 283.46456692913387] // ウォーターマークの密度。デフォルト値は [141.73228346456693, 141.73228346456693] で、(7 cm、10 cm) に相当します。これは、ウォーターマーク間の間隔が x 軸で 7 cm、y 軸で 10 cm であることを意味します。 }説明pdf_fileの値である${current_date}/example.pdfでは、${current_date}はcurrent_dateという名前の変数を表します。DataWorks がタスクをスケジュールすると、
${current_date}を実際の値に置き換えます。この変数は、スケジューリングパラメータで設定できます。たとえば、2023 年 8 月 15 日にタスクを実行すると、pdf_fileは2023-08-15/example.pdfになり、2023 年 8 月 16 日にタスクを実行すると、pdf_fileは2023-08-16/example.pdfになります。お使いのビジネスシステムでは、スケジュールされたタスクが実行される前に、対応するパスに PDF ファイルを生成するだけで済みます。これにより、新しい PDF ファイルに毎日動的にウォーターマークを追加できます。
タスクを実行する前に、パス
${current_date}/example.pdfに一致する PDF ファイルを OSS にアップロードする必要があります。たとえば、2023-08-15/example.pdfです。
-
オプション:Function Compute ノードをデバッグします。 ノードを設定した後、
アイコンをクリックし、タスクのリソースグループを指定し、デバッグ用にコード変数に定数を割り当てます。これにより、ノードのコードロジックが正しいかどうかをテストできます。たとえば、current_date=2023-08-15を設定すると、Function Compute は OSS 内の2023-08-15/example.pdfファイルにウォーターマークを追加します。ノードの定期スケジューリングプロパティを設定します。DataWorks は、スケジューリングシナリオで動的なパラメーターの受け渡しを可能にするスケジューリングパラメーターを提供します。右側の スケジューリング設定 ペインを開き、パラメーター セクションでパラメーターを設定します。この例では、タスク実行時の現在の年、月、日を表す
$[yyyy-mm-dd]を値とする、current_dateという名前のパラメーターを追加します。スケジューリングパラメーターの詳細については、「スケジューリングパラメーターでサポートされている形式」をご参照ください。スケジューリングプロパティの詳細については、「タスクスケジューリングプロパティの概要」をご参照ください。
手順 3:ノードのコミットとデプロイ
Function Compute ノードを自動スケジュールで実行するには、まず本番環境にコミットしてデプロイする必要があります。
-
ノードを保存してコミットします。
ツールバーの
アイコンと
アイコンをクリックして、ノードを保存してコミットします。コミットダイアログボックスで、変更内容の説明を入力し、必要に応じてコードレビューとスモークテストのオプションを選択します。 -
任意。 ノードをデプロイします。
標準モードのワークスペースを使用している場合、ノードをコミットした後、右上隅にある 発行 をクリックしてノードをデプロイする必要があります。 詳細については、「標準モードのワークスペース」および「タスクのデプロイ」をご参照ください。
次のステップ
-
タスクがコミットされデプロイされると、オペレーションセンターによってスケジュールされます。その後、DataWorks オペレーションセンターでタスクを管理および監視できます。詳細については、「オペレーションセンター」をご参照ください。
-
Function Compute ノードの作成と使用の基本的な手順を習得したら、ベストプラクティスを探求してノードをより深く理解できます。詳細については、「DataWorks の Function Compute ノードを使用して PDF に動的にウォーターマークを追加する」をご参照ください。