StudioXのアクティビティ

UiPath StudioXのメールアクティビティ【リソース】

2022/01/07

個人であれ会社であれ、今もなお欠かせないのがメールコミュニケーション。

メールを起点として行う作業なんて、本当に山ほどありますよね。

StudioXでは、メールクライアントのOutlookとGmailの自動化処理に対応しています。

なお、Outlook365の接続について、組織アカウントを持たないと操作できないため、調べられませんでした。

しょうがない、しょうがないんです。
おぐし

ただ、個人で使う分については、情報を網羅できているはずです。

この記事では、以下のアクティビティについて解説します。

記事編集時のStudioX - ver2021.10

リソースのアクティビティ

  • Gmailを使用
  • デスクトップ版Outlookアプリを使用
  • Outlook365を使用

Gmailを使用

自動化するGmailアカウントを選択します。(ガイドはこちら)

Gmailに登録されているアカウントを指定し、StudioXで制御できるようにします。

メールを操作する場合は、必ずメールのリソース内にアクティビティを追加する必要があります。

詳しくは、リソースとアクションの組み立てルールを参考にしてみてください。

ここでは、以下の項目について解説します。

  • アカウント
  • 参照名
  • タイムアウト
  • 接続を使用

アカウント

操作するGmailアカウントを指定します。

Gmailアカウントを指定するには、4つの方法が用意されています。

【UiPath内でアカウントを指定】

  • アカウント選択時に指定
  • 連携サービスを利用

【GoogleAPIのクライアントIDを使った指定】

  • OrchestratorにID/シークレットを登録
  • アカウント選択時にID/シークレットを入力

個人でGoogleアカウントを使うのであれば、1つ目の手順(アカウント選択時に指定)を理解していれば問題ないでしょう。

アカウント選択時に指定(UiPath内でアカウントを指定)

ほとんどの人がこの方法で十分で、かつ、最もシンプルな手順です。

アカウントを指定する流れは以下のとおりです。

[アカウント]のプルダウンより
”新しいアカウントを追加"をクリックします。
[OK]をクリックします。
(認証の種類は"既定"のままで。)
Googleアカウントをクリックします。 "アクセスを求めています。"のメッセージが表示されたら、
下へスクロールします。
2つの項目をチェックONにし、[Continue]をクリックします。 エラーの画面が表示されますが、
気にせず右上の[✖]をクリックして、画面を閉じてください。
[アカウント]にメールアドレスが表示されました。

参照名

[参照名]でリソースに名前を付けます。

ここで指定した参照名で、指定したメールアカウントの各情報にアクセスします。

初期値は"Gmail"ですが、必要に応じて分かりやすい参照名に変更するといいでしょう。

タイムアウト

[アカウント]の選択で、Gmailアカウントの認証手続きを指定時間内に完了させる必要があります。

初期値は90秒です。

90秒以内に完了しないと、認証エラーになって中断します。

具体的には、[新しいアカウントを追加]をクリックしてから、Googleの承認手続きが指定した時間を超えると、

以下のようなエラーメッセージが表示され、認証手続きが中断されます。

認証手続きまでの時間が「ちょっと短いな」と思ったら、秒数を大きくするといいですね。

接続を使用

チェックONにすることで、予め連携サービスで登録したアカウントを使用します。

メールアカウントを、Automation Cloudの連携サービスを使って接続するわけですが、ただ残念なことにGmailが連携サービスにありません

今のところ、Gmailの連携サービスは使えません。

Spreadsheetで連携サービスを利用してみる

もし連携サービスにGmailが登場したら、どんな手順になるのでしょうか。

ちょっと気になったので、代わりにGoogleSpreadsheetをサンプルに接続方法を試してみました。

UiPathパッケージの追加(準備)

試すための準備として、GoogleSpreadsheetを使えるようにするため、Gsuiteパッケージをインストールする必要があります。

リボンにある[パッケージを管理]をクリックします。 [すべてのパッケージ]をクリック後、
検索バーに"gsuit"と入力します。
検索結果に表示された"UiPath.GSuite.Activities"をクリックします。
[インストール]をクリックします。
[保存]をクリックします。 [アクティビティ]パネルにG Suiteの
アクティビティが追加されました。
連携サービスを登録

Orchestratorで、連携サービスを登録します。

[リソース]パネルのをクリックし、Orchestratorを開きます。
https://cloud.uipath.com/を開いてもOKです。
[Integration Service]をクリック後、
[Google Sheets]をクリックします。
ちなみに、"Integration Service = 連携サービス"ですね。
[Add Connection]をクリックします。 対象となるGoogleアカウントをクリックします。 [Continue]をクリックします。 登録が完了しました。

これで、StudioXから接続する準備が整いました。

[接続を使用]をチェックON

あとは、[接続を使用]をチェックONにすれば、Spreadsheetと連携できます。

チェックONにすると、[アカウント]が"既定"へ切り替わります。

試しに、[シートを参照]をクリックしてみましょう。

Google Drive上のSheetを参照出来れば、無事成功です。

他ユーザーのアカウントを連携しようとすると、もうちょっと手を加える必要があります。
おぐし

GoogleAPIのクライアントIDを使った指定

アカウントを指定するもうひとつ方法が、GoogleAPIのクライアントIDを使った方法です。

クライアントIDとクライアントシークレットを取得して、それをStudioXに登録します。

これから解説する手順は不完全ですが、それでも全容を掴むことは出来るでしょう。

クライアントIDを使うための準備

クライアントIDを取得するためには、GoogleAPIを有効化する必要があります。

Google Cloud Consoleを開いて、APIを有効化し、クライアントIDするには、以下の手順が必要です。

クライアントID取得までの流れ

  • プロジェクトを作成
  • APIを有効化
  • 同意画面設定
  • クライアントID/シークレットを作成

具体的に見ていきましょう。

1.プロジェクトを作成

まずは、Google Cloud Consoleを開いてください。

タイトルには、"Google Cloud Platform"と表記されています。

最初にすることは、プロジェクトの作成です。

初めてアクセスした場合は、利用規約への同意が必要です。
国=”日本"、利用規約にチェックON、
[同意して続行]をクリックします。
タイトル右側のプロジェクト名をクリックします。
初めての場合は、[プロジェクトの選択]と表示されています。
[新しいプロジェクト]をクリックします。 [プロジェクト名]を入力します。
GoogleConsole上で分かりやすいプロジェクト名で構いません。
名前を入力したら、[作成]をクリックします。
ホーム画面に戻るので、再度[プロジェクト名]をクリックします。 作成したプロジェクトをクリックします。 プロジェクトが切り替わりました。
2.APIを有効化

ライブラリを見ると、100を超える様々なAPIが提供されています。

その中から必要なAPIを有効化するわけですが、今回はGmailとGoogleカレンダーですね。

では、"Gmail API"と"Google Calendar API"を有効化しましょう。

メニューをクリックし、
[APIとサービス]-[ライブラリ]をクリックします。
[Gmail API]をクリックします。 [有効にする]をクリックします。
これでGmail APIが有効化されました。
同様にして、
[Google Calendar API]を有効化します。
3.同意画面設定

続いて、Gmail、Googleカレンダーの権限(制御範囲)を設定しますが、この権限の許可を得るためには、Googleの審査が必要となります。

審査を通過しないと、権限が付与されたクライアントIDとクライアントシークレットを手に入れられません。(権限のないIDは取得可能です。)

中途半端ではあるものの、ここでは審査申請は行わず、「同意画面の構成」までの解説とします。

[OAuth同意画面]をクリックします。
[外部]をクリックし、[作成]をクリックします。
[アプリ名]を入力します。アプリ名は、何でもOKです。
[ユーザーサポートメール]を入力します。
メールアドレスは、Gmailでもそれ以外でも構いません。
下方に移動して、[メールアドレス]を入力します。
[ユーザーサポートメール]と同じメールで構いません。
[保存して次へ]をクリックします。
[スコープを追加または削除]をクリックします。 上記5つをチェックONにします。
[更新]をクリックします。
[保存して次へ]をクリックします。 [保存して次へ]をクリックします。 これで、[OAuth同意画面]の設定が完了です。

これで設定は完了ですが、もうひとつ、公開ステータスを切り替える必要があります。

[OAuth同意画面]をクリックします。 [アプリを公開]をクリックします。 [確認]をクリックします。 公開ステータスが、"本番環境"へ切り替わりました。
4.クライアントID/シークレットを作成

最後に、"クライアントID"と"クライアントシークレット"を作成する必要があります。

このIDとシークレットをStudioXに登録することで、Gmailの制御が可能になります。

作成の手順は、以下のとおり。

[認証情報]をクリックします。
[認証情報を作成]をクリックし、[OAuthクライアントID]を
クリックします。
[アプリケーションの種類]で、"デスクトップアプリ"を
クリックします。
[名前]を入力します。
分かりやすい名前であればOKです。
[クライアントID]と、[クライアントシークレット]が
作成されました。

作成されたクライアントID/シークレットを控えておきましょう。

OrchestratorにID/シークレットを登録

クライアントIDと、クライアントシークレットが作成出来たら、Orchestratorに情報を登録します。

これについては、ガイドのOrchestratorに~(長いので省略)で解説されています。

具体的な登録手順は、以下のとおり。

[リソース]パネルのをクリックし、Orchestratorを開きます。
https://cloud.uipath.com/を開いてもOKです。
[Orchestrator]、[テナント]、[フォルダー]、[新しいフォルダー]
の順にクリックします。
[名前]に"uipath.settings.config”と入力し、
[作成]をクリックします。
作成されたフォルダー[uipath.settings.config"をクリックします。
[アセット]、[アセットを追加]-[新しいアセットを作成]
の順にクリックします。
[アセット名]に"UiPath.Activities.GoogleWorkspaces.ClientId"を
入力します。[Text]に、取得したクライアントIDを入力し、
[作成]をクリックします。
もう一度、[アセットを追加-[新しいアセットを作成]を
クリックします。
[アセット名]に"UiPath.Activities.GoogleWorkspaces.ClientSecret"を
入力します。[Text]に、取得したクライアントシークレットを入力し、
[作成]をクリックします。
2つのアセットが追加されました。

Orchestratorにアセットを登録したら、StudioXに戻ってください。

あとは、アクティビティでOrchestratorのクライアントID/シークレットを自動的に読み込んでくれます。

[アカウント]の[新しいアカウントを追加]を
クリックします。
対象のGoogleアカウントをクリックします。 ※以降は、OAuthの審査が通過していれば表示されないはずです。
[詳細]をクリックします、
[○○(安全ではないページ)に移動]をクリックします。
2つの項目をチェックONにし、[Continue]をクリックします。 エラーのページが表示されますが、そのまま[✖]で
閉じて構いません。
[アカウント]に、メールアドレスが表示されました。
また、[プロパティ]パネルを見ると、Orchestratorのアセット値が
反映されています。

アカウント選択時にID/シークレットを入力

アクティビティに、直接クライアントID/シークレットを入力する方法です。

利用するためには、Google Workspaceに登録し、組織用アカウントを用意する必要があります。

ということで、解説を割愛しました。

デスクトップ版Outlookアプリを使用

自動化するOutlookアカウントを選択します。(ガイドはこちら)

Outlookに登録されているアカウントを指定し、StudioXで制御できるようにします。

メールを操作する場合は、必ずメールのリソース内にアクティビティを追加する必要があります。

詳しくは、リソースとアクションの組み立てルールを参考にしてみてください。

ここでは、[アカウント]と[参照名]について解説します。

アカウント

Outlookに登録されているメールアカウントを指定します。

StudioXが、Outlookに登録されたメールアカウントを読み取り、その中から選択できます。

Outlookに登録しているメールアカウントが1つであれば、[既定のメールアカウント]のままで問題ありません。

Outlookに複数のメールアカウントを設定している場合は、制御したい方を選択するといいでしょう。

なお、[既定のメールアカウント]で利用されるメールアドレスは、[Outlookのアカウント設定]にある、以下の項目で指定されたアカウントになります。

参照名

[参照名]でリソースに名前を付けます。

ここで指定した参照名で、指定したメールアカウントの各情報にアクセスします。

初期値は"Outlook"ですが、必要に応じて分かりやすい参照名に変更するといいでしょう。

Outlook365を使用

自動化するExchange365アカウントを選択します。(ガイドはこちら)

ここでのOutlook365は、組織で利用するメールアカウントに限られます。

なお、Officeソフト「Microsoft365」を購入すれば、個人用のOutlook365が手に入りますが、この場合は[デスクトップ版Outlookアプリを使用]を利用してください。

組織用のメールアカウントを自由に触れる状況になく、確認出来ないので、解説はここまでとします。

まとめ

メールのリソースについて、内容が結構膨れてしまいました。

GoogleAPIについて調べ尽くしきれませんでしたが、ほとんど人にとっては使う機会がないでしょう。

StudioXにしては、随分とハードルが高い設定のような気もします。

まとめます。

まとめ

  • Gmailの設定は、個人であればアカウント選択時に指定の手順で十分。
  • Gmailの[接続を使用]は、現段階では使用不可。
  • Microsoft365のOutlookは、デスクトップ版で接続する。

この記事で、何か1つでも新しい発見が得られたのなら、僕もうれしいです。

-StudioXのアクティビティ

© 2024 おぐしログのRPA入門