マイクロアプリ

Blackboard Learnの統合

Blackboard Learn統合を展開して、新しいコースに登録して学生としてコースとそれに関連する詳細を表示したり、インストラクターとしてコースのお知らせを作成してコースのメンバーや成績を表示したりできます。

注:

ご意見・ご要望をお待ちしています。この統合テンプレートに関するフィードバックをお送りください。また、問題についてはサポートチームが専用フォーラムを毎日確認いたします。

追加設定不要のBlackboard Learn用のマイクロアプリについて包括的な詳細は、「Blackboard Learnマイクロアプリの使用」 を参照してください。

必須条件の確認

Citrix Workspaceマイクロアプリに統合を追加するには、次のアーティファクトが必要です:

  • ベースURLhttps://{host_name}.com
  • 認証URLhttps://{host_name}.com/learn/api/public/v1/oauth2/authorizationcode
  • トークンURLhttps://{host_name}.com/learn/api/public/v1/oauth2/token
  • クライアントID:クライアントIDは、承認サーバーに固有のクライアント登録情報を表す文字列です。OAuthサーバーを構成したときに、アプリケーションキーとしてこれを収集します。
  • シークレット:クライアントシークレットは、ターゲットアプリケーション統合のセットアップ時に発行される一意の文字列です。OAuthクライアントを構成するときに、シークレットとしてこれを収集します。

注:

利用可能な場合は、サービス認証方法として常にOAuth 2.0を使用することをお勧めします。OAuth 2.0は、統合が、構成済みのマイクロアプリとの最大限のセキュリティコンプライアンスを満たすことを保証します。

Citrix Gatewayでシングルサインオンがサポートされるよう構成して、ユーザーが一度ログインすれば、再度資格情報を入力しなくても自動的に再ログインできるようにします。SSOの構成について詳しくは、「Citrix Gatewayサービスhttps://docs.citrix.com/en-us/citrix-gateway-service/」を参照してください。

ユーザーアカウントの作成

統合には、Blackboardインスタンスへの定期的なアクセスが必要です。専用のユーザーアカウント「Blackboard Partnerアカウント https://docs.blackboard.com/partners/become-a-partner」を作成することをお勧めします。

次の権限が必要です:完全な管理者特権。

APIアクセス

Blackboard APIはデフォルトで有効になっています。APIにアクセスするには、Blackboard Developer AMIまたはBlackboard Partnerアカウントのいずれかが必要です。特定のリソースに対して実行できるAPI要求の数は限られているため、次の情報を確認することをお勧めします:https://docs.blackboard.com/learn/rest/admin/groups-quotas-rates

重要

ページネーション制限は100に設定されています。管理者は、APIに基づいてこの制限を最大200まで拡張できます。

Blackboard Learn開発者サーバーでは、最大10000のAPI呼び出し/サイト/24時間のサポートを提供します。

Blackboard Learn本番環境サーバーでは、最大75000のAPI呼び出し/サイト/24時間のサポートを提供します。

API呼び出しの制限があるため、増分同期は、コースメンバーシップコース連絡事項のみを保持するように設定されています。残りのエンドポイントは、完全同期の一部としてトリガーされます。

OAuthサーバーの構成

Blackboard Learn統合を介してデータを読み取るようにOAuthサーバーを構成します。

  1. https://developer.blackboard.com/にサインインします。
  2. [My Apps] を選択し、[Create a New App]の+アイコンを選択します。または、https://developer.blackboard.com/portal/applications/createに移動します。
  3. 必須フィールドに入力し、[Register application and generate API key]を選択します。
  4. 画面に表示されているアプリケーションIDアプリケーションキーシークレットをコピーして保存します。統合を構成するときに、これらの詳細をサービス認証に使用します。
  5. 管理者としてBlackboard Learnアプリケーションにログインします。
  6. [System Admin] に移動します。
  7. [Integrations] テーブルの [REST API Integrations] を選択します。
  8. [Create Integration] を選択します。
  9. 以下の必須フィールドに入力します:

    1. 上記の手順4で選択したアプリケーションIDを貼り付けます。
    2. [Learn User] フィールドに管理者ユーザー名を入力します。
    3. [End User Access] および [Authorized To Act As User][Yes] を選択します。

OAuthクライアントの構成

Blackboard Learn統合を通じてデータをライトバックするようにOAuthクライアントを構成します。

  1. https://developer.blackboard.com/にサインインします。
  2. [My Apps] を選択し、[Create a New App]の+アイコンを選択します。または、https://developer.blackboard.com/portal/applications/createに移動します。
  3. 必須フィールドに入力し、[Register application and generate API key]を選択します。
  4. 画面に表示されているアプリケーションIDアプリケーションキーシークレットをコピーして保存します。統合を構成するときに、これらの詳細をサービスアクション認証に使用します。
  5. 管理者としてBlackboard Learnアプリケーションにログインします。
  6. [System Admin] に移動します。
  7. [Integrations] テーブルの [REST API Integrations] を選択します。
  8. [Create Integration] を選択します。
  9. 以下の必須フィールドに入力します:

    1. 上記の手順4で選択したアプリケーションIDを貼り付けます。
    2. [Learn User] フィールドに管理者ユーザー名を入力します。
    3. [End User Access] および [Authorized To Act As User][Yes] を選択します。

Citrix Workspaceマイクロアプリへの統合の追加

Blackboard Learn統合をCitrix Workspaceマイクロアプリに追加して、アプリケーションに接続します。認証オプションは事前に選択されています。プロセスの完了時に、これらのオプションが選択されていることを確認してください。これにより、通知とアクションが設定済みとなっている追加設定不要のマイクロアプリを、Workspace内で使用できるようになります。

次の手順を実行します:

  1. [マイクロアプリ統合] ページで [新しい統合を追加] および [Citrix提供のテンプレートから新しい統合を追加する] を選択します。
  2. Blackboard Learnタイルを選択します。
  3. 統合の [統合名] を入力します。
  4. コネクタのパラメーターを入力します。
    • インスタンスの [ベースURL] を入力します:
    • アイコンライブラリから統合のアイコンを選択するか、デフォルトのアイコンのままにしておきます。
  5. [サービス認証][認証方法] メニューから [OAuth 2.0] を選択して認証の詳細を完了します。認証オプションは事前に選択されています。プロセスの完了時に、これらのオプションが選択されていることを確認してください。OAuth 2.0セキュリティプロトコルを使用して、委任されたアクセスの要求/承認トークンを生成します。利用可能な場合は、サービス認証方法として常にOAuth 2.0を使用することをお勧めします。OAuth 2.0は、統合が、構成済みのマイクロアプリとの最大限のセキュリティコンプライアンスを満たすことを保証します。

    1. [許可の種類] メニューから [クライアント資格情報] を選択します。
    2. [トークン認証] メニューから [認証ヘッダー] を選択します。
    3. [トークンURL] は事前に入力されています: https://{host_name}.com/learn/api/public/v1/oauth2/token
    4. スコープに次のように入力されていることを確認します:read
    5. [クライアントID] を入力します。クライアントIDは、承認サーバーに固有のクライアント登録情報を表す文字列です。OAuthサーバーを構成したときに、アプリケーションキーとしてこれを収集します。
    6. [クライアントシークレット] を入力します。クライアントシークレットは、ターゲットアプリケーション統合のセットアップ時に発行される一意の文字列です。OAuthサーバーを構成するときに、シークレットとしてこれを収集します。
  6. [サービスアクション認証][[アクション]で個別のユーザー認証を使用する] トグルを有効にします。サービスアクション認証は、サービスアクションレベルで認証します。認証オプションは事前に選択されています。プロセスの完了時に、これらのオプションが選択されていることを確認してください。

    1. [認証方法] メニューから [OAuth 2.0] を選択して認証の詳細を完了します。
    2. [トークン認証] メニューから [認証ヘッダー] を選択します。
    3. [認証URL] は事前に入力されています: https://{host_name}.com/learn/api/public/v1/oauth2/authorizationcode
    4. [トークンURL] は事前に入力されています: https://{host_name}.com/learn/api/public/v1/oauth2/token
    5. スコープに次のように入力されていることを確認します:write
    6. [クライアントID] を入力します。クライアントIDは、承認サーバーに固有のクライアント登録情報を表す文字列です。OAuthクライアントを構成したときに、アプリケーションキーとしてこれを収集します。
    7. [クライアントシークレット] を入力します。クライアントシークレットは、ターゲットアプリケーション統合のセットアップ時に発行される一意の文字列です。OAuthクライアントを構成するときに、シークレットとしてこれを収集します。
  7. [要求レート制限を有効にする] を有効にします。[要求数] は「60」のままにし、[時間間隔][1分] にします。
  8. [要求タイムアウト] は、デフォルトで「120」に設定されています。
  9. (オプション)サポートのために24時間のログを保持するには、[ログ] を有効にします。
  10. [保存] を選択して続行します。

サービスアクションパラメーターの設定

上記のテンプレートを構成した後、サービスアクションを正しく構成する必要があります。[自分の成績]マイクロアプリについて、[自分の成績]ページ[Blackboardで表示] ボタンのhost_nameを更新します。

次の手順を実行します:

  1. [マイクロアプリ統合] ページからBlackboard Learn統合に移動し、[自分の成績] マイクロアプリを選択します。
  2. [ページ][自分の成績]ページの順に選択します。
  3. ページビルダーで [Blackboardで表示] ボタン要素を選択し、右側ペインで [アクション] タブを選択します。
  4. [アクション] で、[移動先URL] を選択します。
  5. [URLテンプレート] フィールドで、host_nameをインスタンスのホスト名に置き換えます。次のフォームが使用されます:https://{host_name}/webapps/bb-social-learning-BBLEARN/execute/mybb?cmd=display&toolId=MyGradesOnMyBb_____MyGradesTool

    終了したら、画面を終了します。変更はビルダー用に自動的に保存されます。

テーブル属性の編集

統合の構成を完了するには、以下にリストされているエンドポイントのデータ型を変更する必要があります。

次の手順を実行します:

  1. [マイクロアプリ統合] ページから、Blackboard Learn統合の横にあるメニューを選択し、[編集] を選択します。[データの読み込み] 画面が開きます。開かない場合は、左側のナビゲーション列から [データの読み込み] を選択します。
  2. 以下の表に示されているエンドポイントごとに、指定の属性のメニューでデータ型を変更する必要があります。

    エンドポイント 属性 データ型の変更
    コース連絡事項 本文 バイナリ
    ユーザーの成績 スコアの表示 Double
    成績スコア 可能なスコア Double
  3. 各エンドポイントについては、エンドポイントの横にあるメニューを選択し、[編集] を選択します。
  4. [データエンドポイントの編集] 画面で、ページの一番下までスクロールします。[データ構造] 下のテーブルで、鉛筆アイコンを選択してテーブルを編集します。
  5. [テーブル属性の編集] 画面で、メニューから新しい値を選択して [データ型] を変更します。各エンドポイントに対して行われた変更ごとに、[保存][適用] の順に選択します。
  6. 他のデータエンドポイントについても繰り返します。

これで、最初のデータ同期を設定して実行する準備ができました。同期ルール、スケジュールを満たさない同期、および拒否ルールの詳細については、「データの同期」を参照してください。

APIエンドポイントとテーブルエンティティについて詳しくは、「Blackboard Learnコネクタの仕様」を参照してください。

メモ

ページネーション制限は100に設定されています。管理者は、APIに基づいてこの制限を最大200まで拡張できます。

API呼び出しの制限があるため、増分同期は、コースメンバーシップコース連絡事項のみを保持するように設定されています。残りのエンドポイントは、完全同期の一部としてトリガーされます。

Blackboard Learnマイクロアプリの使用

既存のアプリケーション統合には、追加設定不要のマイクロアプリが付属しています。これらのマイクロアプリから開始して、ニーズに合わせてカスタマイズします。

[自分の成績]マイクロアプリについて、管理者は [自分の成績]ページ[Blackboardで表示] ボタンの「host_name」を更新する必要があります。完全な手順については、「サービスアクションパラメーターの設定」を参照してください。

コース登録: コースに登録します。

通知またはページ ユースケースワークフロー
新規コース登録通知 学生がコースに登録すると、登録された学生は通知を受け取ります。
コース登録の詳細ページ 登録されたコースの読み取り専用ビューと、コースおよびインストラクターの詳細が表示されます。
コースのリストページ 受講できるコースのリストが表示されます。
コースの詳細ページ コースの詳細やインストラクターの詳細を表示します。[クイック登録] オプションがあります。

コース連絡事項の作成: インストラクターがコースの連絡事項を作成できます。

通知またはページ ユースケースワークフロー
コース連絡事項の作成 コースの連絡事項を作成するためのフォームで次の詳細が表示されます:コース([コース]ドロップダウンメニュー)、タイトル、メッセージ、および公開日。

インストラクタービュー: インストラクターがコースメンバーと成績を表示できます。

通知またはページ ユースケースワークフロー
コースの詳細ページ インストラクターが受講できるコースのリストを表示できます。
メンバーの詳細ページ インストラクターがコースに登録されているメンバーのリストを表示できます。
成績の詳細ページ インストラクターが特定のコースメンバーの成績を表示できます。

自分のコース: コースの連絡事項とコースの添付ファイルを表示します。

通知またはページ ユースケースワークフロー
新しいコース連絡事項の通知 新しい連絡事項があると、コースに登録した学生に通知が届きます。
コース連絡事項の詳細ページ コースの新しい連絡事項の詳細を確認できる読み取り専用ビューが表示されます。
自分のコースページ ユーザーが登録されているコースのリストが表示されます。
コースの詳細ページ コースの連絡事項と添付ファイルのリストが表示されます。
連絡事項の詳細ページ コースの連絡事項とその詳細を表示します。
添付ファイルの詳細ページ 添付ファイルを表示してダウンロードします。

自分の成績: 学生がコースの成績を表示できます。

通知またはページ ユースケースワークフロー
新しい成績の通知 新しい成績が投稿されると、コースに登録した学生に通知が届きます。
自分の成績ページ コースを選択して、学生が成績を表示できるようにします。