マイクロアプリ

統合とマイクロアプリのエクスポートとインポート

マイクロアプリサービスでは、統合、マイクロアプリ、Citrix Assistantリゾルバーを簡単にエクスポートおよびインポートするオプションを使用できます。

エクスポートでは、以下が可能です:

  • 統合のみのエクスポート。すべてのまたは選択したマイクロアプリとCitrix Assistantリゾルバーが含まれます。
  • 既存の統合からのマイクロアプリの個別のエクスポート。

インポートでは、以下が可能です:

  • 統合のインポート。すべてのマイクロアプリとCitrix Assistantリゾルバーが含まれます。
  • 現在のマイクロアプリの新しいバージョンに加え、既存のエクスポートファイルからのマイクロアプリの個別のインポート。

長所

統合とマイクロアプリのインポートおよびエクスポートは、次のシナリオで使用できます:

  • 既存の統合とマイクロアプリをバックアップおよび復元する。
  • 統合を含む追加のマイクロアプリの開発にかかる時間を短縮する。
  • 本番環境の統合に影響を与えずに新しい構成のテストを実施する。
  • 提案されたソリューションをテストする安全な方法を開発できるようにして、トラブルシューティングを実行する。
  • 組織内の他のマイクロアプリ開発者、またはより広範なCitrixマイクロアプリプラットフォーム開発者コミュニティと協力する。

エクスポート機能

エクスポート機能では、さまざまな設定と構成が、.mapp拡張子を持つファイルにパッケージ化されます。このファイルはマイクロアプリ管理コンソールにインポートできます。.mappファイルには2種類あります。1つは統合用で、もう1つはマイクロアプリ用です。

ユーザーID、パスワード、OAUTHクライアントID、クライアントシークレットなどの機密データは、このエクスポートファイルには含まれません。

テンプレート統合の.mapp構成ファイルには、以下が含まれています:

  • 同期のスケジュールと構成
  • テーブル
    • スキーマ編集オプション
    • 選択された属性
    • フィルターとフィルタークエリ
  • 関係
  • アクション
  • Citrix Assistantリゾルバー
  • 構成
    • 統合名
    • コネクタのパラメーター
      • サービスURL
    • サービス認証
      • ユーザー名
      • パスワード
    • ユーザー認証方法
    • その他のパラメーター
    • オンプレミス構成
    • ログ

マイクロアプリはエクスポートされますが、以前に構成されたサブスクライバーはエクスポートされません。マイクロアプリをインポートしたら、サブスクライバーを再構成する必要があります。詳しくは、「利用者を割り当てる」を参照してください。

HTTP統合の.mapp構成ファイルには、以下が含まれています:

  • データの読み込み
    • データエンドポイント(チェーン化した子エンドポイントを含む)
  • テーブル
  • 関係
  • Citrix Assistantリゾルバー
  • サービスアクション
  • 構成
    • 統合名
    • コネクタのパラメーター
      • ベースURL
    • アイコン
    • オンプレミスインスタンス
    • サービス認証
      • 認証方法
    • サービスアクション認証
      • アクションでの個別のユーザー認証の使用
      • 認証方法
    • ログ

マイクロアプリの.mapp構成ファイルには、以下が含まれています:

  • プロパティ
    • Name
    • 説明
    • アイコン
    • Action
    • (アクションページ)
  • 通知
    • Name
      • トリガー
    • トグル
    • コンテンツ
      • アクションボタン
    • ターゲットページ
    • 設定
      • 条件
    • 有効期限条件
  • ページ
    • すべてのページのプロパティとアクション
    • すべてのページのフォーマット
    • すべてのページのコンポーネントと設定
    • 呼び出されたすべてのアクション
  • ローカライズ
    • すべてのローカライズ設定
  • メタデータ
    • マイクロアプリの構築に使用された統合の識別。
    • 統合データキャッシュ層へのマイクロアプリコンポーネントのマッピング構造は、新たな統合に適切にマップする必要があります。
    • 利用者の設定はエクスポートされません。

構成のエクスポート

構成ファイルをエクスポートするには、次の手順に従います:

  1. マイクロアプリ管理コンソールを開いて、エクスポートする統合を見つけます。
  2. 統合の省略記号メニューをクリックして、[統合のエクスポート] を選択します。
  3. [ベンダー] および [説明] フィールドにオプションの値を入力します。
  4. エクスポートファイルに含めるマイクロアプリまたはCitrix Assistantリゾルバーを選択または選択解除します。
  5. [エクスポート] を選択します。
  6. 結果の.mappファイルを安全な場所に保存します。 統合の.mapp構成ファイルが、ローカルマシンに.mappファイル形式でエクスポートされます。

マイクロアプリのエクスポート

マイクロアプリファイルをエクスポートするには、次の手順に従います:

  1. マイクロアプリ管理コンソールを開いて、マイクロアプリのエクスポート元の統合を見つけます。
  2. エクスポートするマイクロアプリの省略記号メニューをクリックして、[エクスポート] を選択します。
  3. 結果の.mappファイルを安全な場所に保存します。 統合の.mapp構成ファイルが、ローカルマシンに.mappファイル形式でエクスポートされます。

インポート機能

統合構成とマイクロアプリをインポートする場合、エクスポート/インポートワークフローを開始する前に、以下を考慮してください:

  • インポート後の統合の状態 構成設定
  • エクスポートした統合の種類と構成されている設定に応じて、統合構成を更新する必要があります。
  • 統合ステータスに、「 認証構成が必要です」という警告が表示されます。
  • サービスの資格情報が更新されるまで、同期、キャッシュ、またはアクションはできません。

OAuth

OAuthを使用する統合およびマイクロアプリをエクスポートおよびインポートする場合、エクスポート/インポートワークフローを開始する前に、以下を考慮してください:

  • サービスアカウントまたはサービスアクション用に構成されたOAuthとの統合の場合、統合はクライアントシークレットなしでエクスポートされます。
  • これを行うと、サービス認証スキームとサービスアクション認証スキームを含めることができるOAuthを使用する認証スキームで問題が発生します。
  • サービスの資格情報が更新されるまで、同期やアクションはできません。
  • レコードシステムから更新されたアクセストークンを取得するには、再認証が必要です。

OAUTH資格情報を入力するには、次の手順に従います:

  1. マイクロアプリ管理コンソールから、新しくインポートされた統合を見つけます。
  2. 統合の省略記号メニューをクリックして、[編集]を選択します。
  3. 左側の[プロパティ]をクリックします。
  4. 未入力のパスワードとシークレットを入力し、OAuthを再認証します。

マイクロアプリのインポートの制限

マイクロアプリは統合内で作成されます。マイクロアプリの親である統合は、ソース統合と呼ばれます。マイクロアプリをインポートする場合、同じソース統合、別の統合、またはターゲット統合にインポートできます。 ターゲット統合にマイクロアプリをインポートする際に把握しておく必要がある重要な制限があります。

マイクロアプリのインポートによる既知の影響:

  • 元のマイクロアプリが削除されると、既存の通知(フィードカードとも呼ばれる)は削除されます。
  • 新しいフィードカードとプッシュ通知が生成されると、新しい統合の次の同期(完全または増分)が開始されます。
  • マイクロアプリは、ソース統合と同じ統合の種類の(テンプレート統合またはHTTP統合)ターゲット統合内にのみインポートできます。

基礎となるデータ構造(スキーマとも呼ばれる)がソースおよびターゲットの統合と同じであっても、マイクロアプリのインポート機能で、マイクロアプリのデータ構造と、異なるタイプの統合を一致させることはできません。

ターゲット統合には、ソース統合と一致するデータベース構造があります:

  • スキーマが異なるターゲット統合で、キャッシュされたテーブルが一部欠落している場合は、マイクロアプリは構成ミスとしてインポートされます。
  • 構成ミスを防ぐために、ソース統合とターゲット統合のスキーマが同じになるようにしてください。
  • 統合スキーマを移動して、マイクロアプリで必要なテーブルがスキーマに含まれていることを確認します。

マイクロアプリのテンプレートスキーマ

テンプレート統合のスキーマを表示するには、次の手順に従います:

  1. マイクロアプリ管理コンソールにログオンして、表示する統合を見つけます。
  2. 省略記号メニューをクリックして、[編集]を選択します。
  3. 左側のメニューから[テーブル]を選択し、ボタンをクリックしてスキーマを編集します。
  4. テーブルを確認し、ソーススキーマとターゲットスキーマを比較します。これにより、同一のテーブルとエンティティがマイクロアプリデータキャッシュに同期されます。

インポート後のマイクロアプリのステータス

マイクロアプリがインポートされると、次の状態となります:

  • マイクロアプリには利用者は含まれません。利用者は手動で再作成する必要があります。
  • すべてのサブスクライバーが設定され、次の同期が行われるまで、このマイクロアプリに対して作成される通知はありません。
  • 通知は、通知トリガーの設定に基づいて自動的に生成されます(通常は次の同期の後)。

構成のインポート手順

構成をインポートするには、次の手順に従います:

  1. マイクロアプリ管理コンソールを開き、管理コンソールの上部にある [統合を追加] をクリックします。
  2. 追加する統合の種類を選択します。
  3. 以前に構成された統合をインポートするオプションの横にある [続行] ボタンを選択します。
  4. 統合の.mappファイルをドラッグするか、[参照] を選択して特定の場所からファイルを選択します。
  5. 誤ったファイルを選択した場合、削除リンクをクリックして削除を選択できます。正しいファイルを選択した場合は、[インポート] をクリックします。
  6. 管理コンソールに、統合が他のすべての統合と並んで表示されます。

次の手順

  • 新しい統合に欠落している資格情報を追加します。
  • 新しいマイクロアプリに利用者を追加します。
  • ターゲット環境上の元の統合を削除します。

マイクロアプリを既存の統合にインポートする

マイクロアプリには、マイクロアプリの作成で使用された、統合のデータ構造への参照が含まれています。したがって、マイクロアプリは互換性のあるターゲット統合内にのみインポートする必要があります。

新しいマイクロアプリを既存のターゲット統合にインポートするには:

  1. マイクロアプリ管理コンソールを開いて、ターゲット統合を見つけます。
  2. ターゲット統合の省略記号メニューを選択し、[マイクロアプリのインポート] を選択します。
  3. 統合の.mappファイルをドラッグするか、[参照] を選択して特定の場所からファイルを選択します。
  4. 誤ったファイルを選択した場合、削除リンクをクリックして削除を選択できます。正しいファイルを選択した場合は、[インポート] をクリックします。
  5. マイクロアプリが、統合用の他のすべてのマイクロアプリと並んで表示されます。

次の手順

  • 新しいマイクロアプリに利用者を追加します。

マイクロアプリの新しいバージョンのインポート

マイクロアプリのオプション(省略記号)メニューから、マイクロアプリを新しいバージョンに更新できます。

  1. [マイクロアプリ統合]画面で、目的のマイクロアプリにある [新しいバージョンのインポート] を選択します。
  2. 新しいマイクロアプリをドラッグして、[インポート]を選択します。

    (オプション)古いバージョンのマイクロアプリをシステムから完全に削除する場合は、[既存のフィードカードの削除]を選択します。このオプションを選択しない場合、古いマイクロアプリはシステムに残り、終了(End-of-Life:EOL)フラグが付けられます。新しいバージョンがアクティブなマイクロアプリとして設定されます。作成したフィードカードを正しく機能させるために、古いマイクロアプリを削除しないことをお勧めします。

  3. [インポート] をクリックします。

新しいマイクロアプリがインポートされます。

次の手順

  • 新しいマイクロアプリに利用者を追加します。
  • 製品終了(EOL):マイクロアプリを手動で製品終了に設定できます。マイクロアプリをクリックして編集し、[プロパティ]を選択すると、[EOL]が表示されます。

統合とマイクロアプリのエクスポートとインポート