電子メールの送信の追加および構成

電子メールの送信ステップでは、ステップが実行されると、1 人または複数の受信者に電子メール通知が送信されます。 このステップ タイプを使用すると、ステップやジョブが完了した場合や、ステップが正常に完了しなかった場合に、通知を送信することができます。

電子メールの送信ステップを使用して電子メール通知を送信する前に、必要に応じて、ArcGIS Workflow Manager の電子メール通知設定を構成することができます。 カスタム SMTP サーバー設定を使用すると、添付ファイルを含めたり、ユーザー名やグループ ID の代わりに電子メール アドレスを使用したり、[CC] および [BCC] テキスト ボックスを有効化することができます。

注意:

ArcGIS Arcade 式を使用して組織メンバーの電子メール アドレスを取得するには、必要に応じてカスタム ロールを変更する必要があります。

ステップの構成

ステップを構成するには、次の手順に従います。

1. ワークフロー ダイアグラムを作成または編集し、[ステップ ライブラリ] パネルにアクセスします。
2. [電子メールの送信] を [ステップのライブラリ] パネルからワークフロー キャンバス上のステップの接続矢印にドラッグします。

   ワークフロー ダイアグラムにステップを追加する方法の詳細

   [ステップの詳細] パネルが表示されます。

3. [ステップ名] テキスト ボックスにステップの名前を入力します。
4. 必要に応じて、[カスタム SMTP サーバーの有効化] 切り替えボタンをクリックして、SMTP サーバーを使用して電子メールを送信します。
5. カスタム SMTP サーバーがない場合は、以下の [受信者タイプ] オプションのいずれかを選択し、[To] テキスト ボックスに受信者を入力します。
   • [ユーザー名] - セミコロンで区切ったユーザー名のリストを入力するか、受信者の動的なリストを作成する Arcade 式を使用します。 Arcade 式は二重引用符で囲む必要があります。
   • [グループ ID] - 1 つのグループ ID を入力するか、グループ ID を取得する Arcade 式を使用します。 Arcade 式は二重引用符で囲む必要があります。

   少なくとも 1 つの有効なユーザー名、グループ ID、Arcade 式を、[To] テキスト ボックスに入力する必要があります。

   注意:

   カスタム SMTP サーバーがない場合、受信者の最大数は 50 です。Arcade 式では、受信者リストが最大サイズ制限を超える可能性があります。

   1 つのユーザー名	JDoe
   1 つのグループ ID	7dr6de56442840ccbf49b3f869f49b27
   複数のユーザー名	JDoe;KSmith;MFields
   1 つの Arcade 式	"GetUser($CurrentPortal, jobOwner($job))['username']"
   複数の Arcade 式	"GetUser($CurrentPortal, jobOwner($job))['username']";"jobCreator($job)";"lastRunner($job, '8b107614-c6dc-20b3-c232-e03bf7c007bc')"
   ユーザー名と Arcade 式	JDoe;"GetUser($CurrentPortal, jobOwner($job))['username']";KSmith;"lastRunner($job, '8b107614-c6dc-20b3-c232-e03bf7c007bc')"

   ヒント:

   [この入力は Arcade 式をサポートします] をクリックし、ArcGIS Arcade 式を選択して関連するテキスト ボックスに追加します。

6. カスタム SMTP サーバーがある場合は、必要に応じて [To]、[CC]、[BCC] テキスト ボックスにセミコロンで区切った電子メール アドレスを入力するか、受信者の動的なリストを作成する ArcGIS Arcade 式を使用します。 Arcade 式は二重引用符で囲む必要があります。

   少なくとも 1 つの有効な電子メール アドレスまたは Arcade 式を、[To]、[CC]、[BCC] テキスト ボックスに入力する必要があります。

   1 つの電子メール アドレス	[e-mail]
   複数の電子メール アドレス	[e-mail];[e-mail];[e-mail];[e-mail]
   1 つの Arcade 式	"GetUser($CurrentPortal, JobOwner($Job))['Email']"
   複数の Arcade 式	"GetUser($CurrentPortal, JobOwner($Job))['Email']";"GetUser($CurrentPortal)['Email']";"GetUser($CurrentPortal, LastRunner($Job, 'f50d740d-cc04-9296-4ce3-181e82604465'))['Email']"
   電子メール アドレスと Arcade 式	[e-mail];"GetUser($CurrentPortal, JobOwner($Job))['Email']";[e-mail];"GetUser($CurrentPortal)['Email']"

   ヒント:

   [この入力は Arcade 式をサポートします] をクリックし、ArcGIS Arcade 式を選択して関連するテキスト ボックスに追加します。

7. 電子メール通知の件名を [件名] テキスト ボックスに入力します。

   件名を入力する必要があります。 [件名] テキスト ボックスは、空白のままにすることができません。

   Arcade 式を使用して、件名の動的な値を入力することもできます。 件名にプレーン テキストと Arcade 式が含まれている場合は、テキストを次のように書式設定します。

   JobName($Job) + 'is ready'

8. 電子メール通知のメッセージ テキストを [本文] テキスト ボックスに入力します。

   本文にメッセージを入力する必要があります。 [本文] テキスト ボックスは、空白のままにすることができません。

   Arcade 式を使用して、本文の動的な値を入力することもできます。

   本文にプレーン テキストと Arcade 式が含まれている場合は、テキストを次のように書式設定します。

   '<b>' + JobName($Job) + '</b>, created by <b>' + JobCreator($Job) + '</b>, was started on <b>' + Text(Date(JobStartDate($Job)), 'dddd, MMMM D, Y') + '</b>.'

   注意:

   カスタム SMTP サーバーがない場合、電子メール本文のサイズは 100 KB に制限されます。 Arcade 式では、本文が最大サイズ制限を超える可能性があります。

9. カスタム SMTP サーバーがある場合、[添付ファイルを含める] の下にある次のオプションを使用して、電子メール通知にその添付ファイルを含めることができます。
   • [なし] - 電子メール通知にジョブの添付ファイルを含めません。
   • [すべて] - 電子メール通知にすべてのジョブの添付ファイル フォルダーを含めます。
   • [フォルダー別] - [フォルダー別] テキスト ボックスにジョブの添付ファイル フォルダー名のカンマ区切りリストを入力して、電子メール通知に含めるジョブの添付ファイル フォルダーを指定します。

     注意:

     ジョブの添付ファイル フォルダーは、ワークフロー アイテムに含まれるため、ファイル システム パスではありません。

   注意:

   ジョブに複数の添付ファイルが含まれている場合、1 つの .zip ファイルとして送信され、ジョブの添付ファイル フォルダー構造は維持されます。

10. 必要に応じて、[電子メールのプレビュー] をクリックし、電子メールをプレビューします。

    注意:

    電子メールにジョブ固有の Arcade 式が含まれている場合は、Arcade 式をプレビューする前に、[電子メールのプレビュー] テキスト ボックスに有効なジョブ ID を入力する必要があります。 電子メールにステップの出力値の Arcade 式が含まれている場合は、出力値をプレビューする前にステップが完了している必要があります。

    [電子メールのプレビュー] ウィンドウが開き、受信者のリストおよび件名と本文のプレビューが表示されます。

11. [オプション] タブをクリックします。
12. 必要に応じて、[ステップ オプション] を構成します。
    • [手動] - 手動でステップを実行します。
      • [オプション] - ステップを実行しないで終了できるようにします。
    • [自動] - アクティブになり次第、ステップを実行します。

      注意:

      ワークフロー ダイアグラムがジオプロセシング サービスの実行ステップを含む一連のステップを自動的に実行するように構成されている場合、ユーザー トークンの有効期限が切れた後に実行を試みるステップは、自動的に実行されません。 手動操作なしで、追加の自動ステップを続行するには、ArcGIS Workflow Manager Advanced 組織エクステンションが必要です。

    • [スケジュールに沿って実行] - 設定したスケジュールに従ってステップを実行します。

      スケジュール オプションの詳細

13. 必要に応じて、次のオプションのいずれかを選択して、ステップでヘルプを構成します。
    • [なし] - ステップ ヘルプなしでステップを構成します。
    • [テキスト] - [テキスト] テキストボックスで、ステップのヘルプ テキストを構成します。

      ArcGIS Arcade 式を使用して、ステップ ヘルプの動的な値を入力できます。 ステップ ヘルプにプレーン テキストと Arcade 式が含まれている場合は、テキストを次のように書式設定します。

      
      'For further assistance, please contact' + JobCreator($Job) + '.'

    • [URL] - [URL] テキストボックスで、ステップにヘルプ リソースへのリンクを構成します。

      注意:

      Web アプリで実行されるステップでは、HTTP、HTTPS URL 形式のみがサポートされます。 ArcGIS Pro で実行されるステップでは、HTTP、HTTPS、ファイル形式がサポートされます。

      Arcade 式を使用して動的な値を入力することもできます。 URL にプレーン テキストと Arcade 式が含まれている場合は、テキストを次のように書式設定します。

      
      'https://pro.arcgis.com/en/pro-app/latest/tool-reference/' + JobExtendedProperty($Job, 'tools', 'toolbox') + '/' + jobExtendedProperty($job, 'tools', 'alias') + '.htm'

      [Arcade の結果を自動的にエンコード] チェックボックスを次のように構成します。

      • URL に変換するときにエスケープする必要がある特殊文字 (スペースやフォワード スラッシュなど) を Arcade 式が返す場合、[Arcade の結果を自動的にエンコード] チェックボックスを必ずオンにしてください。
      • ベース URL を構成するために Arcade 式が使用される場合、[Arcade の結果を自動的にエンコード] チェックボックスをオフにします。

14. 必要に応じて、[スタイル] タブをクリックし、ステップの形状と色を変更します。
15. 必要に応じて、[情報] タブをクリックし、[ステップの説明] テキストボックスにステップの説明を入力します。

    ヒント:

    [情報] タブには、ステップの出力を取得するために動的なジョブ プロパティで使用できるステップ ID も含まれています。 ステップ ID をクリップボードにコピーするには、[ステップ ID をコピー] をクリックします。

戻り値

ステップが完了すると、その戻り値が格納され、ステップの結果を示します。 パスを使用して戻り値をすぐに評価し、ワークフロー内の次のステップを決定できます。 ArcGIS Arcade 式を使用して、ワークフロー全体を通じて完了したステップの戻り値を取得することもできます。 次の表は、ステップの戻り値を示しています。

戻り値	説明
S000001	ステップが正常に完了しました。
F000001	ステップを正常に完了できませんでした。