5.5 他システムとの連携
外部サービスと、Cloud Campusの機能の連携が可能です。
※本機能はご契約のプランによって利用できない場合がございます。
| Point | お客様によるプログラム開発は不要で、画面上の操作により簡単に連携が可能です。 |
|---|
| 補足 | 類似の機能として「外部API」機能も存在しますが、「外部API」の場合はお客様によるプログラム開発が必要です。 |
|---|
| 注意 | シングルサインオン(外部認証)との併用は不可です。 |
|---|
本機能をご利用の場合、検証環境をご用意しております。
既にCloud Campusの運用を開始している場合は、本番環境へ設定を行う前に検証環境で動作確認を行うことを推奨しております。
| 補足 | 検証環境をご利用の場合は、以下URLからアクセスしてください。 https://api.ccampus.org/ |
|---|
| 注意 | ・Cloud Campusの検証環境は、月曜から金曜9:00-19:00に稼働、その他時間帯・土日はご利用いただけません。 ・検証環境は、以下の目的のみでご利用が可能です。その他を目的としたご利用はご遠慮ください。 外部認証機能(SSO:シングルサインオン) 外部API 外部サービスの連携利用(カオナビ連携) 上記3点を確認するために必要な操作 例:SSOやカオナビ連携用のユーザ作成、APIのためにコース作成や受講登録&受講操作(履歴取得API用)など また、検証環境は「動画」「ビデオスライド」マテリアルをチャプターに紐づける(コンテンツ登録申請)ことはできません。 |
|---|
利用手順
5.5.1 連携対象のカオナビメンバーを指定する
まず初めに、Cloud Campusへ連携するカオナビメンバーを設定します。
本機能により、指定したカオナビメンバーのみCloud Campusへ連携することが可能です。
| 注意 | Cloud Campusへ連携するカオナビメンバーを絞り込まない場合にも、本設定は必ず必要です。 |
|---|
本機能を利用するには、カオナビ側で、連携判定用の「シート」および「項目」を以下のルールに従って作成し、
連携したいメンバーにチェックを入れる必要があります。
| 補足 | 各画像は、最新の画面とは異なる可能性がございます。あらかじめご了承ください。 |
|---|
シート・選択項目の作成
連携判定用の「シート」および「項目」を作成します。
| 1. |
カオナビの管理者画面にて、弊社指定の名称・設定でシートを作成します。 管理者機能トップ画面から、[レイアウト設定]をクリックします。 →レイアウト設定画面が表示されます。 |
||
|---|---|---|---|
| 2. |
[シート]タブをクリックします。シートを追加したいカテゴリに対して、[シートの追加]をクリックします。 (カテゴリは必要に応じて追加してください。) →シートの追加画面が表示されます。 |
||
| 3. |
シートの追加画面にて、以下を入力、選択します。 ・シート名:Cloud Campus連携 ・レコードの数:単一 ・ラベルの位置:左(横型)、または、上(縦型) ※名称は「完全一致」する必要があります。スペースの有無や大文字小文字も含め、正確に入力してください。 上記を入力後、[追加]をクリックします。 |
||
| 4. |
|
||
| 5. |
項目のラベル、選択項目などを設定します。 ・ラベル名:Cloud Campusユーザとの連携 ・選択項目:連携する ・ラベルの表示:表示する ・必須入力:必須にしない ※名称は「完全一致」する必要があります。スペースの有無や大文字小文字も含め、正確に入力してください。 上記を入力後、[変更を反映]をクリックします。 →レイアウトに反映されます。 |
||
| 6. |
画面右上の[保存]をクリックします。 →「設定を保存しました。」と表示され、[閉じる]をクリックします。 |
連携対象のメンバーへ設定
Cloud Campusユーザとして連携させたいカオナビメンバーに対して、上記手順にて作成したシート、項目の「連携する」にチェックを入れます。以下、画面からの操作にて説明します。
| 1. |
プロファイルブック画面にて、Cloud Campusへ連携させたいメンバーをクリックします。 →[メンバー詳細]画面が表示されます。 |
||
|---|---|---|---|
| 2. |
[Cloud Campus連携]をクリックし、表示します。 |
||
| 3. |
|
||
| 4. |
|
公開API v2の許可設定
Cloud Campusからのデータ取得を許可するため、シートに対するAPI実行を許可します。
| 1. |
管理者機能トップ画面から、[公開API v2 情報]をクリックします。 →公開API v2 情報画面が表示されます。 |
|---|---|
| 2. |
[操作対象の管理]タブをクリックし、シート名「Cloud Campus連携」を表示します。 [取得]にチェックを入れて、[設定保存]をクリックします。 |
| 3. |
確認画面が表示され、[保存]をクリックします。 →「保存しました」と表示されたら[閉じる]をクリックします。 |
5.5.2 外部サービスの連携設定を行う
| 1. |
サイトメニューの下のアイコンが[ →サイト情報管理画面が表示されます。 [サイト設定]をクリックします。 |
||
|---|---|---|---|
| 2. |
サイト情報画面が表示されます [オプション]をクリックします。 |
||
| 3. |
|
||
| 4. |
以降の手順につきましては、連携先の各サービス別の案内をご確認ください。 |
5.5.3 連携設定方法(カオナビ)
お客様によるプログラム開発は必要なく、画面設定により、
カオナビのメンバー情報をCloud Campusのユーザとして連携することが可能です。
連携開始前のご確認事項
連携を開始する前に、必ず以下をご確認ください。
・カオナビのメンバーとCloud Campusのユーザは、以下項目により照合されます。
| カオナビのメンバー | Cloud Campusのユーザ |
|---|---|
| 社員番号 | ユーザID |
・カオナビからCloud Campusへ連携可能な項目は以下の通りです。
| カオナビのメンバー | Cloud Campusのユーザ |
|---|---|
| 社員番号 | ユーザID |
| 氏名 | ユーザ名 |
| メール | メールアドレス |
上記項目の他、Cloud Campusユーザの項目「アカウント状況(有効・停止)」については、
「外部サービスの連携」にて更新される可能性があります。
| カオナビのメンバー | Cloud Campusのユーザ |
|---|---|
| 退職日 | アカウント状況(有効・停止) ※判定条件は後述 |
| 「Cloud Campusユーザとの連携」の値 ( |
連携対象判定 / アカウント状況(有効・停止) ※判定条件は後述 |
・アカウント状況(有効・停止)の更新ルールについて
「外部サービスの連携」で、カオナビメンバーに対応するCloud Campusユーザが既に存在する場合、以下の条件に基づいてCloud Campusユーザの「アカウント状況」が更新されます。
1.連携対象の絞り込みによる判定
カオナビ側の指定シート(参照:5.5.1 連携対象のカオナビメンバーを指定する)で「連携する」にチェックがない、または未設定のメンバーは、連携対象外となります。
既存ユーザの場合は「停止」に変更されます。
2.退職日による判定
カオナビの基本情報「退職日」が連携処理日より過去の日付の場合、アカウント状況は「停止」になります。
退職日が「未設定・当日・未来の日付」の場合は、「有効」として扱われます(※「連携する」にチェックがある場合のみ)。
※一度「停止」になったユーザでも、カオナビ側で退職日を削除または未来の日付に更新し、「連携する」にチェックを入れることで、次回の連携時に「有効」に戻ります。
3.カオナビメンバーの削除
メンバーをカオナビ側で削除した後に「外部サービスの連携」が実行された場合、アカウント状況は「停止」になります。
4.カオナビメンバーの社員番号の更新
メンバーの社員番号を更新した後に「外部サービスの連携」が実行された場合、アカウント状況は「停止」になります。
なお、新しい社員番号のメンバーは、Cloud Campusの新規ユーザとして扱われ、Cloud Campusへ追加されます。
| 注意 | ・カオナビメンバーの社員番号に対応するCloud CampusユーザIDが存在する状態で、一度でも「外部サービスの連携」が行われた後に、Cloud Campusユーザが削除された場合、それ以降、「外部サービスの連携」が行われても、該当の社員番号のメンバー(Cloud CampusのユーザID)は作成されません。ただし、Cloud Campus側で手動でユーザ削除後に、カオナビのカスタムフィールド(連携する)のチェックを外して連携処理、その後に再度チェックを入れて連携処理が行われた場合は、該当の社員番号のメンバー(Cloud CampusのユーザID)は作成されます。 |
|---|
| 注意 | カオナビ側で指定のシート(シート名:Cloud Campus連携)が作成されていない場合、または指定の項目(項目名:Cloud Campusユーザとの連携)が存在しない場合、連携処理全体がエラーとなります。 |
|---|
| 注意 | カオナビ側の指定シート( |
|---|
連携設定方法
| 1. |
5.5.2 外部サービスの連携設定を行うの手順3[連携設定]から、 連携サービス名「カオナビ」の「編集」ボタンを押下します。 |
||||
|---|---|---|---|---|---|
| 2. |
Consumer key、Consumer secretを入力します。 (カオナビの管理者機能トップ>公開API v2 情報>認証情報タブから取得可能です) |
||||
| 3. |
|
5.5.4 連携処理結果を確認する
| 1. |
サイトメニューの下のアイコンが[ →サイト情報管理画面が表示されます。 [サイト設定]をクリックします。 |
|---|---|
| 2. |
サイト情報画面が表示されます。 [オプション]をクリックします。 |
| 3. |
[連携ログ確認]から、過去の連携処理についての成功、失敗、その詳細の確認が可能です。 |
連携ログの確認画面
| エリア名・項目名 | 内容 | |
|---|---|---|
| Ⓐ | 連携サービス名(検索条件) | 表示したい外部サービス名を指定します。 |
| Ⓑ | 連携期間 | 表示したい連携ログの連携日時を指定します。 |
| Ⓒ | 検索ボタン | 指定された条件で連携ログを表示します。 |
| Ⓓ | 結果 | 連携処理の成功または失敗が表示されます。 |
| Ⓔ | 連携日時 | 連携処理が実行された日時が表示されます。 |
| Ⓕ | 連携サービス名(ログ) | 連携処理が実行されたサービス名が表示されます。 |
| Ⓖ | メッセージ | 連携ログの結果詳細が表示されます。 |
連携ログのエラーメッセージ
カオナビとの連携におけるエラーメッセージは以下の通りです。
・成功の場合
| メッセージ |
|---|
| メンバーの連携に成功しました。: 登録:1件、更新:2件、停止:3件 |
Cloud Campusユーザの新規登録、更新、アカウント状況が停止となった件数が表示されます。
3種類とも対象件数が0件の場合も、外部サービスの連携処理が行われた場合、0件としてログが記録されます。
・失敗の場合
| メッセージ | 原因 |
|---|---|
| メンバーの連携に失敗しました。: アクセストークンの取得に失敗しました。連携設定をご確認ください。 |
「連携設定」のconsumer_key、consumer_secretをご確認ください。 |
| メンバーの連携に失敗しました。: メンバー情報一括取得APIの呼び出しに失敗しました。 |
カオナビ側のシステム障害等により、APIの実行ができませんでした。Cloud Campusサポート窓口までお問い合わせください。 |
| メンバーの連携に失敗しました。: メンバー情報の解析中に不正な形式エラーが発生しました。 |
取得したデータ形式が想定と異なったため、連携処理が正しく行われませんでした。 Cloud Campusサポート窓口までお問い合わせください。 |
| メンバーの連携に失敗しました。: システムエラーが発生しました。 |
連携処理中が正しく行われませんでした。 Cloud Campusサポート窓口までお問い合わせください。 |
| メンバーの連携に失敗しました。: シート情報レイアウト設定一括取得APIの呼び出しに失敗しました。 |
カオナビ側のシステム障害等により、APIの実行ができませんでした。Cloud Campusサポート窓口までお問い合わせください。 |
| メンバーの連携に失敗しました。: シート情報取得APIの呼び出しに失敗しました。 |
カオナビ側のシステム障害等により、APIの実行ができませんでした。Cloud Campusサポート窓口までお問い合わせください。 |
| メンバーの連携に失敗しました。:シート情報の取得に失敗しました。連携用シートが存在しないか、APIによるデータ取得が許可されていません。 | カオナビ側に規定の名称のシートを取得できませんでした。完全一致する名称のシートが存在しないか、APIでの取得許可がされていません。詳細は以下をご確認ください。 |
| メンバーの連携に失敗しました。: シート情報の取得に失敗しました。連携用シートの名前が重複しています。 |
カオナビ側に規定の名称のシートが複数存在していました。1件のみとなるよう、重複している不要なシートを削除してください。詳細は以下をご確認ください。 |
| メンバーの連携に失敗しました。:シート情報の取得に失敗しました。カスタムフィールドが取得できません。 | カオナビ側に規定の名称のシートは存在していますが、その中に、既定の項目名が存在しませんでした。なお、「チェックボックス」のみ利用可能です。詳細は以下をご確認ください。 |
| メンバーの連携に失敗しました。:カスタムフィールド名が重複しているためシートIDを取得できません。 | カオナビ側に規定の名称のシートは存在していますが、その中に、既定の項目名が複数存在していました。1件のみとなるよう、重複している不要な項目を削除してください。詳細は以下をご確認ください。 |
| 補足 | ・「外部サービスの連携」によって作成・更新されたCloud Campusユーザを確認する方法として、「ユーザ管理」画面から「ユーザ一覧」をCSV形式でダウンロードいただき、insert_date(登録日時)、update_date(最終更新日時)列をご活用ください。ただし、それぞれの項目は「外部サービスの連携」だけではなく、画面やCSVからの登録更新等の場合にも更新されます。 ・カオナビ連携による更新(登録・更新・停止)は、カオナビメンバーの連携可能な項目または「Cloud Campusユーザとの連携」情報が更新され、前回連携時から差分が発生したユーザが対象となります。ただし、例外として、「カオナビメンバーに設定されている退職日が、連携処理時点で過去日付となったカオナビメンバー(Cloud Campusユーザ)」についても、処理対象となります。これらは全て、「連携ログ」への件数表示や、「ユーザ一覧」CSVのupdate_date(最終更新日時)も更新されます。 |
|---|
5.5.5 対象ユーザにCloud Campusの利用開始方法を案内する
Cloud Campusユーザにメールアドレス(または個人メールアドレス)が登録されている場合、Cloud CampusからID 通知・パスワード設定・秘密の質問設定の一括メール(アカウント通知メール)を配信することが可能です。
手順や注意事項につきましては、以下をご参照ください。参照:3.1 ユーザ自身にパスワードと秘密の質問を設定させる
| 補足 | Cloud Campusユーザにメールアドレス(または個人メールアドレス)が登録されていない場合には、管理者にて初期パスワードを設定し、「次回サインイン時パスワード変更」を有効とし、Cloud Campus外で利用者へご連絡ください。 |
|---|
コメント
記事コメントは受け付けていません。