クラウドワークフロー「X-point Cloud」と連携するフローテンプレートの使い方を紹介します。
このテンプレートでは、X-point Cloudのマスターデータ「ユーザ情報」「ユーザグループ情報」「役職情報」を作成・取得・削除する処理を、手軽に作成することができます。フローに変更を加えれば、すでにご利用中の基幹システムや各種データベース、kintoneなどのクラウドサービスとX-point Cloudとの連携を自動化することもできます。また、X-point CloudとのAPIでの連携設定を変更すれば、マスター以外のワークフローデータを読み書きする処理に発展させることも可能です。
テンプレート利用の流れ
ここでは、ユーザ情報作成のテンプレートを例に、テンプレート利用方法の流れをご紹介します。
準備編
- テンプレートファイル「X-pointCloud.zip」をダウンロードします。
- この記事の一番下にダウンロードボタンが配置されています。
- テンプレートファイルをフローデザイナーにインポートします。
- フローデザイナーにて、「ファイル」メニューの「テンプレートのインポート」をクリックします。
- 手順1でダウンロードしたテンプレートファイル「X-pointCloud.zip」を選択して「開く」をクリックします。
- フローデザイナーにて、「ファイル」メニューの「テンプレートのインポート」をクリックします。
- X-point Cloudへの接続のために必要な「アクセストークン」「ホスト名」「ドメインコード」を確認します。
-
- アクセストークン:X-point Cloud管理サイトにて、ドメイン管理→認証情報の「アクセストークンを生成する」から入手可能です。管理者権限のあるユーザで生成したアクセストークンが必要です。
- ホスト名:X-point Cloudにアクセスする際のURLのサブドメイン部分です。
- 例)https://asteriasample.atledcloud.jp/*** の場合、asteriasample がホスト名となります。
- ドメインコード:X-point Cloud管理サイトのドメイン管理→ドメイン基本→ドメインコード に記載されている値です。
- アクセストークン:X-point Cloud管理サイトにて、ドメイン管理→認証情報の「アクセストークンを生成する」から入手可能です。管理者権限のあるユーザで生成したアクセストークンが必要です。
※アクセストークンの取得方法や、ホスト名、ドメインコードが不明な場合は、X-point Cloudの提供元である株式会社エイトレッドへお問い合わせください。
これで準備は完了です。
フロー作成編
ここでは「X-pointCloudユーザ作成」のテンプレートを例に説明します。(他のテンプレートでも同様の手順でフローを作成できます)
- ASTERIA Warpの新規処理作成画面からテンプレートを選択して「OK」をクリックします。
- ナビゲーション画面に沿って必要な情報を入力します。
- 最初に、先に確認しておいたアクセストークン、ホスト名、ドメインコードを入力します。
- すべて入力したら「次へ」をクリックします。
- 次に、登録するユーザ情報が記載されたCSVファイルのファイルパスを入力します。
- フロー作成後に変更できますので、ここでは仮のファイル名を入れておいても構いません。
- ファイルパスを相対パスで記入する場合は、デフォルトではこのフローを作成するフォルダからの相対パスとなります。
- 入力したら、「完了」をクリックします。
- 処理が自動生成されました!
これで、X-point Cloudのユーザ情報を登録するフローが作成できました。
📝メモ
アクセストークン、ホスト名、ドメインコードの値は、同名の「フロー変数」の初期値として書き込まれます。
CSVファイルパスはFileGetコンポーネント(またはFilePutコンポーネント)の「ファイルパス」プロパティに書き込まれます。
これらの内容は、後から編集することも可能です。
アクセストークンが直接フローに書き込まれますので、作成後のフローの取り扱いにはご注意ください。
必要に応じて、別のファイルからアクセストークンを読み込むような形へのフロー変更もご検討ください。
CSVファイルのフォーマットについて
データを作成・更新・削除するタイプのテンプレートは、CSVファイルの内容を元にして処理をするように作られています。一方、取得するタイプのテンプレートは、フローを実行すると自動的にCSVファイルが作成されます。
データ作成・更新用のCSVファイルについてはサンプルをご用意しました。詳細は「X-pointCloudサンプルファイル.zip」の内容をご確認ください。「X-pointCloudサンプルファイル.zip」は、このページの一番下からダウンロードできます。
CSVファイルの1行目は項目名となっており、基本的にはAPI呼び出し時に用いるJSONデータの項目名と一致または関連性のある命名となっています。
2行目以降はデータです。
⚠️ご注意
サンプルファイルの内容はあくまでサンプルです。
各種 ID やコード類については、お客様の環境とは整合性が取れていません。
必ず、お客様の環境にあわせてデータを適切に書き換えてからお使いください。
データ削除用のCSVファイルについては、「id」1項目だけが必要です。こちらも1行目は項目名を入れ、2行目から削除対象データのidを列挙してください。
※誤って必要なデータを削除してしまうことを防ぐため、削除用CSVファイルのサンプルは掲載しておりません。
具体的には、以下のようになります。
テンプレート名 | サンプルファイル名 |
X-pointCloudユーザ作成 | CreateUsers.csv |
X-pointCloudユーザ更新 | UpdateUsers.csv |
X-pointCloudユーザ取得 | (取得フローのためサンプルなし) |
X-pointCloudユーザ削除 | (削除フローのためサンプルなし) |
X-pointCloudユーザグループ作成(ユーザグループのみ) | CreateGroups.csv |
X-pointCloudユーザグループ作成(所属ユーザ含む) | CreateGroupsWithUsers.csv |
X-pointCloudユーザグループ取得 | (取得フローのためサンプルなし) |
X-pointCloudユーザグループ削除 | (削除フローのためサンプルなし) |
X-pointCloud役職作成 | CreateParts.csv |
X-pointCloud役職取得 | (取得フローのためサンプルなし) |
X-pointCloud役職削除 | (削除フローのためサンプルなし) |
テンプレートからの発展
作成したフローは自由に変更することができますので、連携先を変更したり、項目を追加したりすることも可能です。呼び出すAPIを変更すれば、ワークフローデータを読み書きするフローに発展させることもできます。
連携先を変更する場合は、CSVファイルを読み書きしている箇所をデータベースやExcel、各種クラウドサービスとの接続アダプターに入れ替え、それにあわせてマッピングを変更してください。
マスターの項目を追加する場合や、ワークフローデータの読み書きをできるようにする場合は、X-point CloudのAPIリファレンスを参照しながら、RESTコンポーネントのURLやHTTPメソッド、JSONストリームの項目、CSVファイルの項目を見直してください。APIの詳細は、株式会社エイトレッドから提供されているX-point Cloudのサポートサイトにてご確認ください。
以上、X-point Cloudのマスターデータを読み書きするフローテンプレートをご紹介しました。
ぜひご活用ください。
作成日:2023/10/16
ASTERIA Warpバージョン:2306
※フローテンプレートをご利用の際は、動作環境や実現したい処理に応じてお客様自身でフローを調整いただく必要がございます。あらかじめご了承ください。