Configurazione delle notifiche

Specificare il nome del mittente e l'indirizzo email da utilizzare per le notifiche email. Se necessario, è possibile visualizzare in anteprima i modelli e personalizzare il testo. È anche possibile impostare lo stile delle notifiche in modo che corrispondano al tema aziendale.

Informazioni su questa attività

Le email API Manager vengono inviate automaticamente quando si verificano determinati eventi di sistema. Lo scopo determina l'organizzazione dei modelli di e-mail, come spiegato nella Tabella 1.
Tabella 1. Ambiti di notifica
Ambito Eventi che attivano la notifica
catalogo Attività relative ai cataloghi, come eventi del ciclo di vita dell'applicazione, inviti ai cataloghi, approvazioni di prodotti e approvazioni di abbonamenti.
consumatore Attività alle applicazioni consumer e richieste di abbonamento nel Portale sviluppatori, inviti alle organizzazioni consumer e richieste di reimpostazione della password per gli account del Portale sviluppatori.
fornitore Inviti.
Spazio Inviti.

Le notifiche email contengono un indirizzo e un nome del mittente basato su una ricerca gerarchica dei dettagli del mittente configurato in API Connect. A seconda del modello email inviato, la ricerca può iniziare a livello di spazio e quindi passare attraverso i livelli Catalogo, Organizzazione provider e Gestore cloud. I dati del mittente utilizzati sono il primo gruppo di dati configurati trovati durante la ricerca gerarchica. Per visualizzare il percorso di ricerca utilizzato da API Connect quando si cercano i dettagli del mittente per ciascun template di notifica, consultare Configurazione dei dettagli del mittente per notifiche email.

Uno dei seguenti ruoli è richiesto per configurare le notifiche email:

  • Amministratore
  • Proprietario
  • Un ruolo personalizzato con l'autorizzazione Settings:Manage
Nota: puoi personalizzare le notifiche anche utilizzando la CLI developer toolkit o utilizzando le API REST API Connect . Per ulteriori informazioni, vedere Comandi di sviluppo e gestione delle API o API Connect REST API.

Procedura

  1. In API Manager, fare clic su Impostazioni Impostazioni.
  2. Nell'elenco di navigazione Impostazioni , fai clic su Notifiche, quindi su Modifica.
  3. Specificare un mittente immettendo un Nome e un indirizzo email, quindi fare clic su Salva
    Per configurare i dettagli del mittente ai livelli Spazio o Catalogo, devi utilizzare la CLI developer toolkit . Per ulteriori informazioni, consultare Configurazione dei dettagli del mittente per le notifiche email.
  4. Facoltativo: per abilitare la personalizzazione del modello, spostare il dispositivo di scorrimento Personalizza modelli di notifica nella posizione Su .
    Nota: È possibile ricaricare tutte le notifiche predefinite, come configurate dall'amministratore del cloud, disattivando e riattivando la personalizzazione dei modelli. Tuttavia, questa operazione sovrascrive tutte le personalizzazioni effettuate.
  5. Per visualizzare in anteprima il testo di un modello, selezionare Anteprima dal menu delle opzioni Icona menu Opzioni accanto al nome del modello.
  6. Per modificare il testo del modello, fare clic sul nome del modello o selezionare Modifica nel menu opzioni accanto al nome del modello.

    Quando un modello viene aperto, viene effettuato un tentativo di ottenere la lingua dall'impostazione del browser, ma se ciò non è possibile, il modello viene impostato per default sull'inglese.

    Il testo include variabili; ad esempio, {{catalog}}. Il testo della notifica si basa sulla sintassi del manubrio. La maggior parte delle variabili sono racchiuse tra doppi parentesi graffe {{ }}, ma possono essere racchiuse tra parentesi graffe triple {{{ }}} per disabilitare l'escape HTML, quando la variabile è un link URL per esempio. Per ulteriori informazioni sui manubri, vedere https://handlebarsjs.com/.

    Per ottenere l'elenco completo delle variabili disponibili per un particolare template di notifiche, completare la seguente procedura:
    1. Accedere al server di gestione dalla riga di comando come membro di un'organizzazione di provider. Per ulteriori informazioni, vedere Accesso a un server di gestione. È possibile utilizzare lo stesso server di gestione URL, nome utente e password nel comando di accesso che si usa per accedere all'interfaccia utente di API Manager.
    2. Immetti il seguente comando:
      apic notification-templates:get template_name --server mgmt_endpoint_url --scope org --org provider_organization --subcollection template_scope --fields variables --output -
      dove:
      • template_name è il nome del template di notifica richiesto, come visualizzato nella colonna Template nell'interfaccia utente.
      • template_scope è il nome dell'ambito visualizzato nella colonna Ambito accanto al modello.
      • provider_organization è il valore del campo name per l'organizzazione provider.
      Ad esempio:
      apic notification-templates:get member-invitation --server https://myserver.com --scope org --org myorg --subcollection catalog --fields variables --output -
      Vengono visualizzate le variabili disponibili per il modello, ad esempio:
      variables:
        - org
        - catalog
        - activationLink
        - expiresAt
        - originator
        - originatorFirstName
        - originatorLastName
        - originatorEmail
        - username
        - email
        - firstName
        - lastName

      Il parametro --output - fa sì che l'output del comando venga scritto sulla riga comandi. È possibile specificare --output filepath in modo che l'output sia scritto in un file .yaml nell'ubicazione specificata oppure omettere del tutto un file scritto nella cartella corrente.

  7. Per visualizzare e modificare il template di notifica in una lingua diversa, selezionare una delle seguenti lingue supportate dall'elenco a discesa Visualizza template in :
    • Cinese (semplificato)
    • Cinese (tradizionale)
    • Ceco
    • Olandese
    • Inglese (Inglese USA)
    • Francese
    • Tedesco
    • Italiano
    • Giapponese
    • Coreano
    • Polacco
    • Portoghese
    • Russo
    • Spagnolo
    • Turco
  8. Modificare l' Oggetto come richiesto.
  9. Seleziona il Tipo di contenuto che desideri utilizzare per il modello, da HTML , Testo semplice , O Entrambi . Il tipo di contenuto predefinito èPlainText .
    Viene visualizzata una finestra di modifica per il tipo di contenuto selezionato, oppure vengono visualizzate entrambe le finestre di modifica se è selezionata l'opzione Entrambi .
  10. Modificare il corpo del modello come richiesto.
    Per il contenuto HTML, sono consentiti solo i tag e i loro attributi mostrati nella seguente tabella.
    Tabella 2. Tag e attributi HTML consentiti
    Tag HTML Attributo
    <a> "class", "href", "hreflang", "style"
    <em> "class", "style"
    <strong> "class", "style"
    <cite> "class", "style"
    <blockquote> "class", "cite", "style"
    <code> "class", "style"
    <ul> "class", "type", "style"
    <ol> "class", "start", "type", "style"
    <li> "class", "style"
    <dl> "class", "style"
    <dt> "class", "style"
    <dd> "class", "style"
    <h1> "class", "id", "style"
    <h2> "class", "id", "style"
    <h3> "class", "id", "style"
    <h4> "class", "id", "style"
    <h5> "class", "id", "style"
    <h6> "class", "id", "style"
    <p> "class", "style"
    <div> "class", "style"
    <br> "class", "style"
    <span> "class", "style"
    <img> "class", "src", "alt", "data-entity-type", "data-entity-uuid", "data-align", "data-caption", "width", "height", "style"
    <table> "class", "id", "style"
    <tr> "class", "id", "style"
    <td> "class", "id", "style"
    Se un tag HTML non consentito viene utilizzato in una notifica, il tag e il relativo contenuto vengono visualizzati nell'email come testo semplice.

    Le immagini possono essere utilizzate aggiungendo una tag <img src="https://path/to/image.png"/> nel modello. L'attributo " src " per l'immagine deve essere un " URL " web completo e deve essere accessibile esternamente in modo che i destinatari dell'e-mail possano accedere all'immagine. Non è possibile fare riferimento alle immagini locali. Devono essere URL completamente qualificati. Non è inoltre possibile incorporare o allegare immagini o altri file nelle email.

  11. Fare clic su Salva una volta terminato.
    Nota: le modifiche apportate a un template vengono salvate solo per la specifica versione della lingua modificata.