UI の変更

Edge UI に小さな変更を加えると、デベロッパー コミュニティのエクスペリエンスが向上します。たとえば、次のように変更できます。

  • サポートの連絡先: 内部 UI エラーの受信者。
  • 同意バナー: ユーザーが Edge UI に初めてアクセスしたときに表示されるテキスト。同意バナーには、HTML 形式のテキストと、ユーザーが選択してログイン画面に進むボタンが表示されます。

これらの設定を変更すると、デベロッパーのエクスペリエンスがより統合され、問題を適切な場所に確実に転送できるようになります。

これらの変更を行うには、Code with config（CwC）手法を使用してプロパティ ファイルを編集します。

サポートの連絡先を変更する

UI で特定のエラーが発生すると（たとえば、組織が関連付けられていないユーザーとしてログインした場合など）、デベロッパーに次のようなエラーが表示されることがあります。

「サポートチーム」連絡先のデフォルト値は、デベロッパーにタイムリーなサポートを提供できる組織内のアクティブなリソースを指すように変更する必要があります。

サポートの連絡先を変更するには:

  1. エディタで /opt/apigee/customer/application/ui.properties ファイルを開きます。ファイルが存在しない場合は作成します。
  2. ファイルを作成したら、次の例のように、オーナーを「apigee:apigee」に変更します。 
    chown apigee:apigee /opt/apigee/customer/application/ui.properties
  3. conf_apigee_apigee.branding.contactemailsupport プロパティの値を内部サポートの連絡先に設定します。次に例を示します。 
    conf_apigee_apigee.branding.contactemailsupport="api-support@mycompany.com"
  4. 変更を保存します。
  5. Edge UI サービスを再起動します。 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

次回デベロッパーで内部エラーが発生した場合は、[チームへのお問い合わせ] リンクから、組織の内部サポート組織にメールが送信されます。

同意バナーは、ユーザーが初めて Edge UI にアクセスすると表示されます。例:

同意モードのバナーを追加するには:

  1. エディタで /opt/apigee/customer/application/ui.properties ファイルを開きます。ファイルが存在しない場合は作成します。
  2. ファイルを作成したら、次の例のように、オーナーを「apigee:apigee」に変更します。 
    chown apigee:apigee /opt/apigee/customer/application/ui.properties
  3. 次のプロパティを設定します。 
    # Enable the consent banner:
conf_apigee-base_apigee.feature.enableconsentbanner="true"
# Set the button text:
conf_apigee-base_apigee.consentbanner.buttoncaption="I Agree"
# Set the HTML text:
conf_apigee-base_apigee.consentbanner.body="<h1>Notice and Consent Banner</h1>
<div><p>Enter your consent text here.</p></div>"
  4. 変更を保存します。
  5. Edge UI サービスを再起動します。 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

デベロッパーが次回ブラウザで Edge UI を開くときは、事前に同意書に同意する必要があります。