DocumentazioneAEM as a Cloud ServiceGuida utente

Modelli per frammenti di contenuto content-fragment-models

Last update: Fri Aug 23 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Creato per:

  • Utente
  • Amministratore
  • Sviluppatore

I modelli per frammenti di contenuto in AEM definiscono la struttura del contenuto per i frammenti di contenuto che fungono da base per i contenuti headless.

Per utilizzare i modelli di frammento di contenuto:

  1. Abilita la funzionalità modello Frammento di contenuto per un’istanza
  2. Crea e configura i modelli per frammenti di contenuto
  3. Abilitare i modelli di frammenti di contenuto da utilizzare per la creazione di frammenti di contenuto
  4. Consenti modelli di frammento di contenuto nelle cartelle Risorse richieste configurando i Criteri.

Creazione di un modello di frammento di contenuto creating-a-content-fragment-model

  1. Passa a Strumenti, Generale, quindi apri Modelli per frammenti di contenuto.

  2. Passa alla cartella appropriata per la configurazione o configurazione secondaria.

  3. Utilizza Crea per aprire la procedura guidata.

    note caution
    CAUTION
    Se l’utilizzo di modelli per frammenti di contenuto non è stato abilitato, l’opzione Crea non sarà disponibile.

  4. Specifica il titolo modello.
    Puoi anche definire varie proprietà; ad esempio, aggiungi Tag, Descrizione e seleziona Abilita modello per abilitare il modello, se necessario.

    note note
    NOTE
    Per informazioni dettagliate sul Pattern URL di anteprima predefinito vedi Modello per frammenti di contenuto - Proprietà.

    titolo e descrizione

  5. Utilizza Crea per salvare il modello vuoto. Un messaggio indica il successo dell’azione: puoi selezionare Apri per modificare immediatamente il modello, oppure Fine per tornare alla console.

Definizione del modello per frammenti di contenuto defining-your-content-fragment-model

Il modello per frammenti di contenuto definisce efficacemente la struttura dei frammenti di contenuto risultanti utilizzando una selezione di Tipi di dati. Utilizzando l’editor modelli è possibile aggiungere istanze dei tipi di dati, quindi configurarle per creare i campi richiesti:

CAUTION
La modifica di un modello per frammento di contenuto esistente può avere un impatto sui frammenti dipendenti.

  1. Passa a Strumenti, Generale, quindi apri Modelli per frammenti di contenuto.

  2. Passa alla cartella contenente il modello per frammenti di contenuto.

  3. Apri il modello che desideri modificare utilizzando l’azione rapida oppure selezionando il modello e quindi l’azione dalla barra degli strumenti.

    Una volta aperto, l’editor modelli mostra:

    • a sinistra: campi già definiti
    • a destra: Tipi di dati disponibili per la creazione di campi, oltre alle Proprietà da utilizzare dopo la creazione
    note note
    NOTE
    Quando un campo è obbligatorio, l’Etichetta indicata nel riquadro a sinistra è contrassegnata da un asterisco (*).

proprietà

  1. Per aggiungere un campo

    • Trascina un tipo di dati obbligatorio nella posizione desiderata per un campo:

      tipo di dati per il campo

    • Una volta aggiunto un campo al modello, il pannello di destra visualizza le Proprietà che possono essere definite per quel particolare tipo di dati. Qui puoi definire ciò che è necessario per quel campo.

      • Molte proprietà sono auto-esplicative, per ulteriori dettagli vedi Proprietà.

      • La digitazione di un’Etichetta campo completerà automaticamente il Nome proprietà. Se vuoto, può essere aggiornato manualmente in seguito.

        note caution
        CAUTION
        Quando aggiorni manualmente la proprietà Nome proprietà per un tipo di dati, tieni presente che i nomi devono contenere solo caratteri A-Z, a-z, 0-9 e il carattere speciale di sottolineatura “_”.
        Se i modelli creati in versioni precedenti di AEM contengono caratteri non validi, rimuovi o aggiorna tali caratteri.

      Esempio:

      proprietà del campo

  2. Per rimuovere un campo

    Seleziona il campo richiesto, quindi seleziona l’icona del cestino. Viene richiesto di confermare l’azione.

    rimuovere

  3. Aggiungi tutti i campi obbligatori e definisci le relative proprietà in base alle esigenze. Esempio:

    salva

  4. Seleziona Salva per mantenere la definizione.

Tipi di dati data-types

Per definire il modello è disponibile una selezione di tipi di dati:

  • Testo su riga singola

    • Aggiungi uno o più campi di una singola riga di testo; la lunghezza massima può essere definita

  • Testo su più righe

    • L’area di testo può essere RTF, Testo normale o Markdown

  • Numero

    • Aggiungi uno o più campi numerici

  • Booleano

    • Aggiungi una casella di controllo booleana

  • Data e ora

    • Aggiungi una data e/o un’ora

  • Enumerazione

    • Aggiungere un set di campi casella di controllo, pulsanti di scelta o elenco a discesa

  • Tag

    • Consente agli autori di frammenti di accedere alle aree dei tag e di selezionarle

  • Riferimento contenuto

    • I riferimenti ad altri contenuti di qualsiasi tipo possono essere utilizzati per creare contenuto nidificato
    • Se si fa riferimento a un’immagine, è possibile scegliere di mostrare una miniatura

  • Riferimento frammento

    • I riferimenti ad altri frammenti di contenuto possono essere utilizzati per creare contenuto nidificato

    • Il tipo di dati può essere configurato in modo da consentire agli autori di frammenti di:

      • Modificare direttamente il frammento a cui si fa riferimento.
      • Creare un nuovo frammento di contenuto basato sul modello appropriato

  • Oggetto JSON

    • Consente all’autore del frammento di contenuto di immettere la sintassi JSON negli elementi corrispondenti di un frammento.

      • Questo fa sì che AEM possa memorizzare direttamente JSON con copia e incolla da un altro servizio.
      • Il codice JSON viene trasmesso e riprodotto come codice JSON in GraphQL.
      • Include l’evidenziazione della sintassi JSON, il completamento automatico e l’evidenziazione degli errori nell’editor dei frammenti di contenuto.

  • Segnaposto scheda

    • Consente l’introduzione di schede da utilizzare per la modifica del contenuto dei frammenti di contenuto.
      Nell’editor modelli viene mostrato come divisore che separa le sezioni dell’elenco dei tipi di dati di contenuto. Ogni istanza rappresenta l’inizio di una nuova scheda.
      Nell’editor frammenti ogni istanza viene visualizzata come una scheda.

      note note
      NOTE
      Questo tipo di dati viene utilizzato esclusivamente per la formattazione e viene ignorato dallo schema GraphQL AEM.

Proprietà properties

Molte proprietà sono auto-esplicative, qui sotto ulteriori dettagli per alcune proprietà:

  • Nome proprietà

    Quando aggiorni manualmente questa proprietà per un tipo di dati, tieni presente che i nomi devono contenere solo caratteri A-Z, a-z, 0-9 e il carattere speciale di sottolineatura “_“.

    note caution
    CAUTION
    Se i modelli creati in versioni precedenti di AEM contengono caratteri non validi, rimuovi o aggiorna tali caratteri.

  • Rendering come
    Sono disponibili varie opzioni per realizzare o riprodurre il campo in un frammento. Spesso questa proprietà ti consente di definire se l’autore vede una singola istanza del campo o se può creare più istanze. Quando si utilizza Campo multiplo è possibile definire il numero minimo e massimo di elementi. Per ulteriori dettagli, vedere Convalida.

  • Etichetta campo
    L'immissione di un Etichetta campo genererà automaticamente un Nome proprietà, che può quindi essere aggiornato manualmente, se necessario.

  • Convalida
    La convalida di base è disponibile tramite meccanismi quali la proprietà Obbligatorio. Alcuni tipi di dati dispongono di campi di convalida aggiuntivi. Vedi Convalida per ulteriori dettagli.

  • Per il tipo di dati Testo su più righe è possibile definire il Tipo predefinito come:

    • Formato RTF
    • Markdown
    • Testo normale

    Se non viene specificato diversamente, per questo campo viene utilizzato il valore predefinito Rich Text.

    La modifica del Tipo predefinito in un modello per frammenti di contenuto avrà effetto solo su un frammento esistente correlato, una volta che il frammento è stato aperto nell’editor e successivamente salvato.

  • Univoco
    Il contenuto (per il campo specifico) deve essere univoco in tutti i frammenti di contenuto creati dal modello corrente.

    Questo viene utilizzato per impedire agli autori di contenuti di ripetere contenuti già aggiunti in un altro frammento dello stesso modello.

    Ad esempio, un campo Testo a riga singola denominato Country nel modello per frammenti di contenuto non può avere il valore Japan in due frammenti di contenuto dipendenti. Viene visualizzato un avviso quando si tenta di eseguire la seconda istanza.

    note note
    NOTE
    L’unicità è assicurata da directory principale lingua.
    note note
    NOTE
    Le varianti possono avere lo stesso valore unico come varianti dello stesso frammento, ma non lo stesso valore utilizzato in qualsiasi variante di altri frammenti.
    note caution
    CAUTION
    Se desideri utilizzare MSM (che crea copie dei frammenti di contenuto), tutti i vincoli Unique devono essere rimossi da qualsiasi tipo di dati utilizzato nei rispettivi modelli per frammenti di contenuto.

  • Vedi Riferimento contenuto per ulteriori dettagli su quel tipo di dati specifico e sulle relative proprietà.

  • Vedi Riferimento frammento (frammenti nidificati) per ulteriori dettagli su quel tipo di dati specifico e sulle relative proprietà.

  • Traducibile

    Selezionando la casella di controllo Traducibile in un campo dell’editor modelli di frammenti di contenuto:

    • Fa sì che il nome della proprietà del campo sia aggiunto alla configurazione di traduzione, al contesto /content/dam/<sites-configuration>, se non già presente.
    • Per GraphQL: impostare una proprietà <translatable> nel campo Frammento di contenuto su yes, per consentire al filtro query GraphQL di restituire output JSON con solo contenuto traducibile.

Convalida validation

Diversi tipi di dati includono ora la possibilità di definire requisiti di convalida per l’immissione di contenuto nel frammento risultante:

  • Testo su riga singola

    • Confronta con un regex predefinito.

  • Numero

    • Verifica la presenza di valori specifici.

  • Riferimento contenuto

    • Controlla tipi specifici di contenuto.
    • È possibile fare riferimento solo alle risorse di dimensioni file specificate o inferiori.
    • È possibile fare riferimento solo alle immagini entro un intervallo di larghezza e/o altezza predefinito (in pixel).

  • Riferimento frammento

    • Verifica un modello di frammento di contenuto specifico.

  • Numero minimo di elementi / Numero massimo di elementi

    I campi definiti come Campo multiplo (impostati con Rendering come) dispongono delle opzioni seguenti:

    • Numero minimo di elementi
    • Numero massimo di elementi

    Questi vengono convalidati:

Utilizzo di riferimenti per creare contenuti nidificati using-references-to-form-nested-content

I frammenti di contenuto possono formare contenuto nidificato utilizzando uno dei seguenti tipi di dati:

NOTE
AEM ha una protezione periodica per:

  • Riferimenti contenuto
    Questo impedisce all’utente di aggiungere un riferimento al frammento corrente. Inoltre la finestra di dialogo selettore del riferimento frammento può risultare vuota.

  • Riferimenti frammento in GraphQL
    Se crei una query approfondita che restituisce più frammenti di contenuto a cui si fa riferimento l’un l’altro, alla prima occorrenza restituirà null.

Riferimento contenuto content-reference

Il Riferimento contenuto consente di eseguire il rendering del contenuto da un’altra origine, ad esempio un frammento di immagine o di contenuto.

Oltre alle proprietà standard puoi specificare:

  • Il Percorso directory principale per qualsiasi contenuto a cui si fa riferimento

  • I tipi di contenuto a cui è possibile fare riferimento

  • Le limitazioni per le dimensioni dei file

  • Se si fa riferimento a un’immagine:

    • Mostra miniatura
    • Limiti di altezza e larghezza dell’immagine

Riferimento contenuto

Riferimento frammento (frammenti nidificati) fragment-reference-nested-fragments

Il Riferimento frammento fa riferimento a uno o più frammenti di contenuto. Questa funzione è particolarmente interessante per il recupero dei contenuti da utilizzare nell’app, in quanto consente di recuperare dati strutturati con più livelli.

Esempio:

  • Un modello che definisce i dettagli di un dipendente, tra cui:
    • Un riferimento al modello che definisce il datore di lavoro (azienda)
type EmployeeModel {
    name: String
    firstName: String
    company: CompanyModel
}

type CompanyModel {
    name: String
    street: String
    city: String
}
NOTE
Ciò è di particolare interesse in combinazione con Distribuzione di contenuti headless tramite frammenti di contenuto con GraphQL.

Oltre alle proprietà standard puoi definire:

  • Rendering come:

    • multifield: l’autore del frammento può creare più riferimenti individuali

    • fragmentreference: consente all’autore del frammento di selezionare un singolo riferimento a un frammento

  • Tipo di modello
    È possibile selezionare più modelli. Durante l’authoring del frammento di contenuto, tutti i frammenti a cui si fa riferimento devono essere stati creati utilizzando questi modelli.

  • Percorso radice

Specifica un percorso radice per tutti i frammenti a cui si fa riferimento.

  • Consenti creazione di frammenti

    Questo consente all’autore del frammento di creare un frammento basato sul modello appropriato.

    • fragmentreferencecomposite: consente all’autore del frammento di creare un elemento composito selezionando più frammenti

    Riferimento frammento

NOTE
È presente un meccanismo di protezione per evitare le ricorrenze. Non consente all’utente di selezionare il frammento di contenuto corrente nel riferimento frammento. Inoltre la finestra di dialogo selettore del riferimento frammento può risultare vuota.
In GraphQL è inoltre disponibile una protezione di ricorrenza per i riferimenti di frammenti. Se crei una query approfondita tra due frammenti di contenuto con riferimento l’uno all’altro, verrà restituito null.

Modello per frammenti di contenuto - Proprietà content-fragment-model-properties

Puoi modificare le Proprietà di un modello per frammenti di contenuto:

  • Base

    • Titolo modello

    • Tag

    • Descrizione

    • Carica immagine

    • Pattern URL anteprima predefinito

      note note
      NOTE
      Utilizzato solo dall'new Editor frammento di contenuto. Per ulteriori informazioni, vedere Modelli per frammenti di contenuto.

Abilitazione o disabilitazione di un modello per frammenti di contenuto enabling-disabling-a-content-fragment-model

I modelli per frammenti di contenuto dispongono di uno stato che puoi impostare per avere il controllo completo del loro utilizzo.

Abilitazione di un modello per frammenti di contenuto enabling-a-content-fragment-model

Quando viene creato un modello, questo deve essere abilitato in modo che:

  • Può essere selezionato quando si crea un frammento di contenuto.
  • Possibilità di utilizzarlo come riferimento all’interno di un modello per frammento di contenuto
  • Possibilità di utilizzarlo in GraphQL, affinché venga generato lo schema

Per abilitare un modello contrassegnato come:

  • Bozza: nuovo (mai abilitato)
  • Disabilitato: che è stato specificamente disabilitato

puoi utilizzare l’opzione Abilita dalle seguenti aree:

  • Dalla barra degli strumenti superiore, quando è selezionato il modello richiesto.
  • Con l’azione rapida corrispondente (passando il mouse sul modello richiesto).

Abilitare un modello in stato Bozza o Disabilitato

Disabilitazione di un modello per frammenti di contenuto disabling-a-content-fragment-model

Un modello può anche essere disabilitato, con i seguenti risultati:

  • Il modello non sarà più disponibile come base per la creazione di nuovi frammenti di contenuto.

  • Tuttavia:

    • Lo schema GraphQL continua a essere generato ed è ancora interrogabile (per evitare di influenzare l’API JSON).
    • È comunque possibile eseguire query su qualsiasi frammento di contenuto basato sul modello e restituirlo dall’endpoint GraphQL.

  • Non è più possibile fare riferimento al modello, ma i riferimenti esistenti vengono mantenuti intatti e possono ancora essere interrogati e restituiti dall’endpoint GraphQL.

Per disattivare un modello contrassegnato come Abilitato si utilizza l’opzione Disattiva selezionabile:

  • Dalla barra degli strumenti superiore, quando è selezionato il modello richiesto.
  • Con l’azione rapida corrispondente (passando il mouse sul modello richiesto).

Disattivare un modello abilitato

Consentire modelli per frammenti di contenuto nella cartella delle risorse allowing-content-fragment-models-assets-folder

Per implementare la governance dei contenuti, puoi configurare dei Criteri nella cartella Risorse per controllare quali modelli per frammenti di contenuto sono consentiti per la creazione di frammenti in tale cartella.

NOTE
Il meccanismo è simile a consentire modelli di pagina per una pagina e i relativi elementi secondari, nelle proprietà avanzate di una pagina.

Per configurare i Criteri dei Modelli per frammenti di contenuto consentiti:

  1. Naviga e apri Proprietà per la cartella Risorse desiderata.

  2. Apri la scheda Criteri, dove puoi configurare:

    • Ereditato da<folder>

      I criteri vengono ereditati automaticamente durante la creazione di nuove cartelle secondarie; il criterio può essere riconfigurato (interrompendo l’ereditarietà) se le sottocartelle devono consentire modelli diversi dalla cartella principale.

    • Modelli per frammenti di contenuto consentiti per percorso

      Possono essere consentiti più modelli.

    • Modelli per frammenti di contenuto consentiti per tag

      Possono essere consentiti più modelli.

    Criterio del modello per frammento di contenuto

  3. Salva eventuali modifiche.

I modelli per frammenti di contenuto consentiti per una cartella vengono risolti come segue:

  • I Criteri dei Modelli per frammenti di contenuto consentiti.
  • Se vuoto, prova a determinare il criterio utilizzando le regole di ereditarietà.
  • Se la catena di ereditarietà non fornisce un risultato, consulta la sezione Configurazione di Servizi cloud per quella cartella (anche prima direttamente e poi tramite ereditarietà).
  • Se nessuno dei risultati di cui sopra fornisce risultati, allora non ci sono modelli consentiti per quella cartella.

Eliminazione di un modello per frammenti di contenuto deleting-a-content-fragment-model

CAUTION
L’eliminazione di un modello per frammenti di contenuto può avere un impatto sui frammenti dipendenti.

Per eliminare un modello per frammenti di contenuto:

  1. Passa a Strumenti, Generale, quindi apri Modelli per frammenti di contenuto.

  2. Passa alla cartella contenente il modello per frammenti di contenuto.

  3. Seleziona il modello e poi Elimina dalla barra degli strumenti.

    note note
    NOTE
    Se ci sono riferimenti al modello, viene visualizzata un’avvertenza. Agisci di conseguenza.

Pubblicazione di un modello per frammenti di contenuto publishing-a-content-fragment-model

I modelli per frammenti di contenuto devono essere pubblicati quando/prima che vengano pubblicati eventuali frammenti di contenuto dipendenti.

Per pubblicare un modello per frammenti di contenuto:

  1. Passa a Strumenti, Generale, quindi apri Modelli per frammenti di contenuto.

  2. Passa alla cartella contenente il modello per frammenti di contenuto.

  3. Seleziona il modello e poi Pubblica dalla barra degli strumenti.
    Lo stato di pubblicazione viene indicato nella console.

    note note
    NOTE
    Se pubblichi un frammento di contenuto per il quale il modello non è ancora stato pubblicato, questo viene segnalato in un elenco di selezione e il modello viene pubblicato con il frammento.

Annullamento della pubblicazione di un modello per frammenti di contenuto unpublishing-a-content-fragment-model

Si può annullare la pubblicazione di modelli per frammenti di contenuto che non sono referenziati da alcun frammento.

Per annullare la pubblicazione di un modello per frammenti di contenuto:

  1. Passa a Strumenti, Generale, quindi apri Modelli per frammenti di contenuto.

  2. Passa alla cartella contenente il modello per frammenti di contenuto.

  3. Seleziona il modello e poi Annulla pubblicazione dalla barra degli strumenti.
    Lo stato di pubblicazione viene indicato nella console.

Se tenti di annullare la pubblicazione di un modello attualmente utilizzato da uno o più frammenti, un avviso di errore segnala quanto segue:

Messaggio di errore di modello per frammenti di contenuto quando si annulla la pubblicazione di un modello in uso

Il messaggio suggerirà di controllare il pannello Riferimenti per approfondire l’analisi:

Modello per frammenti di contenuto nei riferimenti

Modelli per frammenti di contenuto bloccati (pubblicati) locked-published-content-fragment-models

Questa funzione garantisce la governance dei modelli per frammenti di contenuto pubblicati.

La sfida the-challenge

  • I modelli per frammenti di contenuto determinano lo schema per le query GraphQL in AEM.

    • Gli schemi GraphQL AEM vengono creati non appena viene creato un modello per frammenti di contenuto e possono esistere sia nell’ambiente di creazione che in quello di pubblicazione.

    • Gli schemi in fase di pubblicazione sono i più critici in quanto forniscono le basi per la consegna live di contenuti di frammenti di contenuto in formato JSON.

  • Possono verificarsi problemi quando i modelli per frammenti di contenuto vengono modificati o in altre parole modificate. Ciò significa che lo schema cambia, e questo può di conseguenza influenzare le query GraphQL esistenti.

  • L’aggiunta di nuovi campi a un modello per frammenti di contenuto non dovrebbe avere effetti negativi, in genere. Tuttavia, la modifica dei campi dati esistenti (ad esempio il nome) o l’eliminazione delle definizioni dei campi interromperà le query GraphQL esistenti quando richiedono questi campi.

Requisiti the-requirements

  • Per sensibilizzare gli utenti sui rischi derivanti dalla modifica di modelli già utilizzati per la distribuzione di contenuti live, in altre parole, di modelli pubblicati.

  • Inoltre, per evitare modifiche non desiderate.

Una di queste potrebbe interrompere le query se i modelli modificati vengono ripubblicati.

Soluzione the-solution

Per risolvere questi problemi, i modelli di frammento di contenuto sono bloccati in modalità di SOLA LETTURA su autore, non appena sono stati pubblicati. Questo stato è indicato con Bloccato:

Scheda del modello per frammenti di contenuto bloccato

Quando il modello è Bloccato (in modalità di SOLA LETTURA), è possibile visualizzare il contenuto e la struttura dei modelli, ma non è possibile modificarli.

Puoi gestire i modelli Bloccati dalla console o dall’editor modelli:

  • Console

    Dalla console, è possibile gestire la modalità SOLA LETTURA con le azioni Sblocca e Blocca nella barra degli strumenti:

    Barra degli strumenti del modello per frammenti di contenuto bloccato

    • È possibile Sbloccare un modello per abilitare le modifiche.

      Se selezioni Sblocca viene mostrata un’avvertenza in cui ti si chiede di confermare l’azione Sblocca:
      Messaggio relativo allo sblocco del modello per frammenti di contenuto

      Puoi quindi aprire il modello per la modifica.

    • Puoi anche Bloccare successivamente il modello.

    • La ripubblicazione del modello lo rimette immediatamente in modalità Bloccato (SOLA LETTURA).

  • Editor modelli

    • Quando apri un modello bloccato, viene visualizzato un avviso con tre possibili azioni: Annulla, Visualizza sola lettura, Modifica:

      Messaggio relativo alla visualizzazione di un modello per frammenti di contenuto bloccato

    • Se selezioni Visualizza sola lettura puoi visualizzare il contenuto e la struttura del modello:

      Visualizza solo lettura: modello per frammenti di contenuto bloccato

    • Se selezioni Modifica puoi modificare e salvare gli aggiornamenti:

      Modifica: modello per frammenti di contenuto bloccato

      note note
      NOTE
      Potrebbe ancora essere presente un avviso nella parte superiore, ma si verifica quando il modello è già utilizzato da frammenti di contenuto esistenti.

    • Annulla ti riporterà alla console.

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab