UI の変更

デベロッパー コミュニティのエクスペリエンスを改善するため、Edge UI に若干の変更を加えることができます。たとえば、次のものを変更できます。

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

これらの設定を変更すると、デベロッパーのエクスペリエンスがより統合的なものになり、発生した問題が適切な場所に確実に送られます。

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

サポート連絡先の変更

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

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

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

  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

次回デベロッパーが内部エラーに遭遇したとき、「contact team」リンクを使用して社内サポート部門にメールを送信できます。

同意バナーの変更

同意バナーは、ユーザーが初めて 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 を開いたとき、デベロッパーはログインする前に使用条件に同意する必要があります。