マイクロアプリ

Canvas LMSの統合

Canvas LMSの統合を展開することで、コースの表示、コースの連絡事項の作成、コースの登録の管理、および学生の成績の閲覧を行うことができます。

  • 学生は、コースとそれに関連する詳細を表示できます。
  • 教職員は、コースの連絡事項の作成や、コースメンバーの表示と追加、学生の成績の閲覧が可能です。

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

すぐに利用可能なCanvas LMS用のマイクロアプリの包括的な詳細については、「Canvas LMSマイクロアプリの使用 」 を参照してください。

必須条件の確認

Canvas LMSでこの統合をセットアップした後、Citrix Workspaceマイクロアプリに統合を追加するには、以下のアーティファクトが必要になります:

  • ベースURLhttps://{host_name}.com
  • 認証URLhttps://{host_name}.com/login/oauth2/auth
  • トークンURLhttps://{host_name}.com/login/oauth2/token
  • クライアントID:クライアントIDは、承認サーバーに固有のクライアント登録情報を表す文字列です。
  • クライアントシークレット:クライアントシークレットは、ターゲットアプリケーション統合のセットアップ時に発行される一意の文字列です。

注:

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

Citrix GatewayがCanvas LMSのシングルサインオンに対応するように構成して、ユーザーがログインすると、再度資格情報を入力しなくても自動的に再ログインできるようにします。SSOの構成について詳しくは、「Citrix Gatewayサービス」を参照してください。

APIの有効化

Canvas APIはデフォルトで有効になっています。APIにアクセスするには、Canvasのパートナーアカウントが必要です。特定のリソースに対して実行できるAPI要求の数は限られているため、したがって、以下の記事で説明されているように、API制限スロットリングをお勧めします:https://canvas.instructure.com/doc/api/file.throttling.html

新しいサービスアカウントの作成

統合ではCanvas LMSインスタンスへの定期的なアクセスが必要なので、Canvas LMSで専用のユーザーアカウントを作成することをお勧めします。このアカウントには次の権限が必要です:完全な管理者特権。

Canvasのパートナーアカウントを作成することをお勧めします:https://www.instructure.com/canvas/become-partner

OAuthサーバーの構成

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

  1. 管理者としてhttps://{host_name}.com/accountsにサインインします。
  2. 統合するアカウントを選択します。
  3. [Developer Keys] を選択し、[+ Developer Key] を選択します。
  4. [+ API Key] を選択し、[Key Name]、[Owner Email]、[Redirect URIs]などの必須フィールドに入力します。
  5. [Redirect URL]フィールドに、このアプリ用に以下の承認済みリダイレクトURLを入力します:https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
  6. クライアント資格情報オーディエンスをCanvasとして作成し、[Save] をクリックします。
  7. [State]を [ON] にします。
  8. 詳細から [Client ID][Secret] をコピーします。統合を構成するときに、これらの値をサービス認証に使用します。

OAuthクライアントの構成

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

  1. 管理者としてhttps://{host_name}.com/accountsにサインインします。
  2. 統合するアカウントを選択します。
  3. [Developer Keys] を選択し、[+ Developer Key] を選択します。
  4. [+ API Key] を選択し、[Key Name]、[Owner Email]、[Redirect URIs]などの必須フィールドに入力します。
  5. [Redirect URL]フィールドに、このアプリ用に以下の承認済みリダイレクトURLを入力します:https://{yourmicroappserverurl}/admin/api/gwsc/auth/serviceAction/callback
  6. クライアント資格情報オーディエンスをCanvasとして作成し、[Save] をクリックします。
  7. [State]を [ON] にします。
  8. 詳細から [Client ID][Secret] をコピーします。統合を構成するときに、これらの値をサービスアクション認証に使用します。

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

Canvas LMS統合をCitrix Workspaceマイクロアプリに追加して、アプリケーションに接続します。これにより、通知とアクションが設定済みとなっている追加設定不要のマイクロアプリを、Workspace内で使用できるようになります。

次の手順を実行します:

  1. [マイクロアプリ統合] ページで [新しい統合を追加] および [Citrix提供のテンプレートから新しい統合を追加する] を選択します。
  2. Canvas LMSタイルを選択します。
  3. 統合の名前を入力します。
  4. コネクタのパラメーターを入力します:

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

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

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

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

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

次の手順を実行します:

  1. [マイクロアプリ統合]ページからCanvas LMS統合に移動し、[自分の成績] マイクロアプリを選択します。
  2. [ページ][自分の成績] ページの順に選択します。
  3. ページビルダーで [Canvasで表示] ボタンコンポーネントを選択し、右側ペインで [アクション] タブを選択します。
  4. [アクション] で、[移動先URL] を選択します。
  5. [URLテンプレート] フィールドで、host_nameをインスタンスのホスト名に置き換えます。次のフォームが使用されます:https://{host_name}/courses/\{\{id\}\}/grades
  6. 終了したら、画面を終了します。変更はビルダー用に自動的に保存されます。

テーブル属性の編集

統合の構成を完了するには、以下のリストに表示されているエンドポイントのデータ型を変更する必要があります。以下の表に示されているエンドポイントごとに、指定の属性のメニューでデータ型を変更する必要があります。

テーブル データの種類
Assignments points_possible バイナリ
Assignments 説明 バイナリ
Grades current_grade バイナリ

次の手順を実行します:

  1. [マイクロアプリ統合] ページから、Canvas LMS統合の横にあるメニューを選択し、[編集] を選択します。[データの読み込み] 画面が開きます。開かない場合は、左側のナビゲーション列から [データの読み込み] を選択します。
  2. 各エンドポイントについては、エンドポイントの横にあるメニューを選択し、[編集] を選択します。
  3. [データエンドポイントの編集] 画面で、ページの一番下までスクロールします。[データ構造] 下のテーブルで、鉛筆アイコンを選択してテーブルを編集します。
  4. [テーブル属性の編集] 画面で、メニューから新しい値を選択して [データ型] を変更します。各エンドポイントに対して行われた変更ごとに、[保存][適用] の順に選択します。
  5. 他のデータエンドポイントについてもこの手順を繰り返します。

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

注:

[完全同期] の間隔を8時間ごとに設定し、[増分同期] の間隔を1時間ごとに設定することをお勧めします。

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

注:

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

Canvas LMSマイクロアプリの使用

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

コース連絡事項の作成: 教師がコースの連絡事項を作成できます。

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

自分のコース: コースの連絡事項、割り当て、コースのファイルを表示します。

通知またはページ ユースケースワークフロー
コース招待の通知 学生がコースに招待されると、通知が届きます。
新しいコース連絡事項の通知 コースについて新しい連絡事項があると、そのコースに登録した学生に通知が届きます。
新しいコース連絡事項(未来)の通知 公開日が未来のコースについて新しい連絡事項があると、そのコースに登録した学生に通知が届きます。
招待の承諾/拒否ページ コースの招待状を読み取り専用で表示し、[承諾] または [拒否] のオプションを提示します。
コースのリストページ ユーザーが登録済みのコースのリストを表示できます。
コースの詳細ページ ユーザーがコースの連絡事項とファイルのリストを表示できます。
連絡事項の詳細ページ ユーザーがコースの連絡事項とその詳細を表示できます。
割り当ての詳細ページ ユーザーが割り当てとその詳細を表示できます。
ファイルの詳細ページ ユーザーがファイルを表示およびダウンロードできます。

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

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

教師のビュー: 教師はコースメンバーを表示および追加し、学生を表示できます。

通知またはページ ユースケースワークフロー
コースのリストページ 教師が利用可能なコースのリストを表示できます。
メンバーのリストページ [ユーザーの追加] ページに移動する [追加] ボタンから、教師がコースに登録されているメンバーのリストを表示できます。
メンバーの詳細ページ コースのメンバーの成績と関連する詳細を教師が表示できます。
ユーザーの追加ページ 教師が選択したコースに生徒を追加できます。
Canvas LMSの統合