Modifications apportées à l'interface utilisateur

Edge for Private Cloud v4.19.01

Vous pouvez apporter des modifications mineures à l'interface utilisateur Edge pour améliorer l'expérience de votre communauté de développeurs. Par exemple, vous pouvez modifier les éléments suivants :

  • Contact d'assistance : destinataire des erreurs d'UI internes.
  • Bannière de consentement : texte qui s'affiche lorsqu'un utilisateur accède pour la première fois à l'interface utilisateur Edge. La bannière de consentement affiche du texte au format HTML et un bouton que l'utilisateur sélectionne pour accéder à l'écran de connexion.

La modification de ces paramètres offrira à vos développeurs une expérience plus cohérente et permettra de s'assurer que les problèmes sont acheminés au bon endroit.

Pour ce faire, vous devez modifier les fichiers de propriétés à l'aide de la technique Code with config (CwC).

Modifier le contact d'assistance

Lorsque l'UI rencontre certaines erreurs (par exemple, lorsqu'un développeur se connecte en tant qu'utilisateur sans organisation associée), un message d'erreur semblable au suivant peut s'afficher :

Vous devez remplacer la valeur par défaut du contact "équipe d'assistance" par une ressource active au sein de votre organisation, qui peut fournir une assistance rapide à vos développeurs.

Pour modifier le contact d'assistance :

  1. Ouvrez le fichier /opt/apigee/customer/application/ui.properties dans un éditeur. Si le fichier n'existe pas, créez-le.
  2. Si vous venez de créer le fichier, remplacez le propriétaire par "apigee:apigee", comme illustré dans l'exemple suivant : 
    chown apigee:apigee /opt/apigee/customer/application/ui.properties
  3. Définissez la valeur de la propriété conf_apigee_apigee.branding.contactemailsupport sur votre contact d'assistance interne. Exemple : 
    conf_apigee_apigee.branding.contactemailsupport="api-support@mycompany.com"
  4. Enregistrez les modifications.
  5. Redémarrez le service de l'interface utilisateur Edge : 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

La prochaine fois que vos développeurs rencontreront une erreur interne, le lien "Contacter l'équipe" enverra un e-mail à votre organisation d'assistance interne.

La bannière de consentement s'affiche lorsqu'un utilisateur accède à l'interface utilisateur Edge pour la première fois. Exemple :

Pour ajouter une bannière de consentement :

  1. Ouvrez le fichier /opt/apigee/customer/application/ui.properties dans un éditeur. Si le fichier n'existe pas, créez-le.
  2. Si vous venez de créer le fichier, remplacez le propriétaire par "apigee:apigee", comme illustré dans l'exemple suivant : 
    chown apigee:apigee /opt/apigee/customer/application/ui.properties
  3. Définissez les propriétés suivantes : 
    # 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. Enregistrez les modifications.
  5. Redémarrez le service de l'interface utilisateur Edge : 
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

La prochaine fois que vos développeurs ouvriront l'interface utilisateur Edge dans un navigateur, ils devront accepter l'accord de consentement avant de pouvoir se connecter.