今回は共通ユーザー機能が有効の場合に、Platioの勤怠連絡テンプレートを利用してASTERIA WarpのPlatioユーザー管理用コンポーネントの動作について説明します。
※ユーザー管理を行うPlatio管理APIは、Enterpriseプランのみでご利用いただけます。
※共通ユーザー機能は組織全体での適用になります。初期設定では共通ユーザーモードは無効になっており、共通ユーザーを使うには共通ユーザー機能を有効にします。一度、共通ユーザー機能を有効にすると、無効には戻せません。
目次
- 共通ユーザー機能とは
- 事前準備
- PlatioCreateUserコンポーネントの動作
- PlatioSearchUserコンポーネントの動作
- PlatioUpdateUserコンポーネントの動作
- PlatioDeleteUserコンポーネントの動作
共通ユーザー機能とは
Platioで作成したミニアプリを利用する場合、ミニアプリごとにアプリ利用者となるユーザーを登録します。アプリ利用者が複数のミニアプリを利用するときは、ミニアプリごとにユーザーを登録する必要があります。また編集・削除する場合は、それぞれのミニアプリでユーザー情報を編集・削除します。
共通ユーザーを使うと、アプリ利用者をミニアプリごとではなく、契約の組織全体でのユーザーを登録します。そのため、必要な複数のミニアプリでユーザーを設定して共通で利用できます。
※共通ユーザー機能の詳細な概要はこちらをご参照ください。
事前準備
ここからは共通ユーザー機能が有効な状態を前提としています。
共通ユーザーを使うにはPlatio Studioから共通ユーザー機能を有効にします。一度、共通ユーザー機能を有効にすると、無効には戻せませんのでご注意ください。
新規の共通ユーザーを作成する
今回は下記の共通ユーザーを作成して、ミニアプリに登録します。
・User1
・User4（管理者）
Platio Studioの「共通ユーザーを管理」ボタンをクリックして、「追加」からUser1、User4のユーザーを追加します。このとき、追加した共通ユーザーを確認すると、以下のようにミニアプリの設定欄は空の状態になっています。
ミニアプリを作成
今回は例として勤怠連絡テンプレートのミニアプリを作成します。
テンプレートからミニアプリを作成するウィザードを進めると、以下のようにユーザーの設定について説明があります。ここでは、共通ユーザーが無効の状態のときのようにユーザーは追加されません。
ASTERIA Warpのコネクション定義に使うユーザーを設定
ASTERIA WarpからPlatioへ接続して処理を行うフローでは、Platio接続用の「コネクション」を作成する必要があります。今回はPlatioのユーザー管理用のコンポーネントを使用するために、共通ユーザーの「User4」を用いてコネクション定義を行います。
操作としては、勤怠連絡ミニアプリの管理メニュー「ユーザー」から、User4の「設定する」ボタンをクリックして、勤怠連絡ミニアプリにユーザー（User4）を設定します。このときユーザーの編集画面が開くので「APIでのレコードや添付ファイルへのアクセスを許可」と「APIでのユーザーの管理を許可」にチェックを入れて保存します。
ASTERIA WarpでPlatioコネクションを作成
[ASTERIA Warp]Platioコンポーネントでのデータ連携：概要と事前準備の手順をご参照いただき、以下の操作を行ってください。
- データビューアーにUser4でログインし、開発者向け情報からAPIトークンを取得する
- ASTERIA WarpでPlatioコネクションを作成する
※コネクションに定義されたミニアプリ内にてPlatio APIを使用できます。
PlatioCreateUserコンポーネントの動作
共通ユーザー機能が有効の場合、作成したミニアプリでユーザーを使うため、共通ユーザーを設定します。共通ユーザーはPlatio Studioの管理メニュー「ユーザー」から確認、編集が可能です。
ASTERIA WarpのPlatioCreateUserコンポーネントを使用することにより、コンポーネントのプロパティで指定した共通ユーザーをミニアプリに設定して、ユーザーとして使用できます。
使用場面
- 新入社員の入社に伴い、指定のミニアプリに一括で新入社員のPlatioユーザーを設定するとき。
フローを作成する
ここからはフローデザイナーへログインし、PlatioCreateUserコンポーネントを配置したフローを作成します。基本プロパティの「名前」に存在する共通ユーザーの名前を指定します。今回は先ほど共通ユーザーに追加したUser1を指定します。
※前提としてプロジェクト、Platioコネクションは作成済みです。
フローを実行
フローを実行した後、Platio Studioの勤怠連絡ミニアプリの「ユーザー」を確認すると、User1のユーザーが設定されていることが確認できます。
補足：Platio Studioの共通ユーザーからUser1を確認すると、ミニアプリに勤怠連絡ミニアプリが設定されていることが確認できます。
PlatioSearchUserコンポーネントの動作
ミニアプリに設定した共通ユーザーを検索します。共通ユーザー機能が有効の場合、検索できるユーザーの範囲は、ASTERIA Warpのコネクションで設定したミニアプリ（今回の場合、勤怠連絡ミニアプリ）のユーザーになります。
使用場面
- 指定のミニアプリに登録された共通ユーザーを取得して一覧を作成するとき。
- 指定のミニアプリのユーザーIDを確認するとき。
ミニアプリに設定した共通ユーザーの状態
現在、勤怠連絡ミニアプリのユーザーにUser1, User4の共通ユーザーが設定されています。
フローを作成する
ここからはフローデザイナーへログインし、PlatioSearchUserコンポーネントを配置したフローを作成します。今回は検索に指定はないため、基本プロパティの「コネクション名」のみを設定してフローを実行します。
※前提としてプロジェクト、Platioコネクションは作成済みです。
フローの実行
フローを実行すると、ミニアプリに設定したユーザーを取得することができました。検索結果はフィールドを持つレコード形式で出力されます。詳細はPlatioSearchUserコンポーネントのコンポーネントリファレンスの■ストリーム情報の「出力」をご参照ください。
PlatioUpdateUserコンポーネントの動作
Platioに登録されたユーザーのうち、指定したユーザーIDのユーザー情報を更新します。
使用場面
- 部署移動に伴い、指定したユーザーのプロファイルを更新するとき。
- 担当業務の変更に伴い、管理者権限やAPIアクセス権の権限を更新するとき。
- メールアドレスやパスワードの変更に伴い、まとめて変更するとき。
今回の処理としては、User1は管理者権限が有効になっているため、PlatioUpdateUserコンポーネントを使用して、この権限を無効に設定します。
ユーザーIDを確認する
このコンポーネントではユーザーIDの指定が必須になります。ユーザーIDは、以下のいずれかの方法で確認することが可能です。
- データビューアーの「開発者」メニューからログインユーザーのユーザーIDを確認する。
- PlatioSearchUserコンポーネントで検索して、ユーザーID（フィールド:id）を取得する。
フローを作成する
ここからはフローデザイナーへログインし、PlatioUpdateUserコンポーネントを配置したフローを作成します。今回はUser1のユーザーIDの「u6ab1cff」をユーザーIDプロパティに指定します。また、管理者プロパティを「いいえ」に設定します。
※前提としてプロジェクト、Platioコネクションは作成済みです。
フローの実行
フローを実行すると、User1の管理者権限が外されていることが確認できます。
PlatioDeleteUserコンポーネントの動作
PlatioDeleteUserコンポーネントは、ミニアプリのユーザーを削除するコンポーネントです。共通ユーザー機能が有効な場合、ミニアプリからユーザーを削除することはできないため、コンポーネントは利用できません。
共通ユーザーを削除する場合は、Platio Studioからの操作で削除してください。
このコンポーネントを使用してミニアプリのユーザーを削除しようとした場合には、以下のエラーが出力されます。
エラー(PlatioDeleteUser1) : Platio API がエラーを返しました [使用されたHTTPメソッドは許可されていません]