15.3. Template e-Service PDND¶
La PDND fornisce uno strumento specializzato che migliora i processi di co-progettazione delle API ottimizzando la pubblicazione e il riutilizzo dei servizi elettronici. Questa funzionalità è definita e regolamentata nel presente documento.
"Linee Guida sull'infrastruttura tecnologica della Piattaforma Digitale Nazionale Dati per l'interoperabilità dei sistemi informativi e delle basi di dati" (PDND).
Il template del servizio elettronico serve come modello standardizzato contenente tutti i metadati tecnici e descrittivi necessari per un servizio elettronico. I Gestori delle API, che possono essere sia Fornitori che Consumatori all'interno dell'ecosistema PDND, POSSONO creare e mantenere questi template.
Una volta che un e-service template è pubblicato, è accessibile attraverso il Catalogo Template PDND che è un repository centralizzato che facilita il riutilizzo. Questo catalogo consente a qualsiasi Partecipante PDND autorizzato di sfogliare i template disponibili e istanziare nuovi servizi elettronici basati su progetti esistenti.
15.3.1. Definizione e linee guida dell'e-service template PDND¶
L'infrastruttura PDND supporta la gestione del ciclo di vita dei Servizi Elettronici Template, simile a quella dei servizi elettronici tradizionali. Gli stati del ciclo di vita includono: Draft, Active, Supsended e Deprecated. Come per i servizi elettronici tradizionali, PDND applica il controllo degli accessi basato sui ruoli per governare le transizioni di stato.
15.3.1.1. Gestione dei Servizi Elettronici Template¶
15.3.1.1.1. Creazione del Servizio Elettronico Template¶
I Partecipanti sono abilitati a creare Servizi Elettronici Template tramite una procedura guidata accessibile attraverso l'interfaccia web PDND (le API saranno disponibili in futuro). Il flusso di lavoro di creazione rispecchia da vicino quello della creazione standard di servizi elettronici, con le seguenti distinzioni:
Un campo aggiuntivo identifica il destinatario previsto del template.
Il campo "Audience" è omesso.
Le soglie sono opzionali e servono come raccomandazioni per i Partecipanti che implementano il template.
Ai Partecipanti è vietato creare più template con lo stesso nome: i nomi dei template DEVONO essere unici per partecipante. Alla creazione, un template è inizialmente impostato sullo stato Draft. I template possono quindi essere pubblicati nel Catalogo Template, rendendoli così accessibili a tutti i Partecipanti.
15.3.1.1.2. Modifica del Servizio Elettronico Template¶
I Partecipanti che hanno creato un template possono modificarlo. La portata dei campi modificabili dipende dallo stato del ciclo di vita del template:
Se il template è in stato Draft, tutti i campi sono modificabili.
Per i template in altri stati, solo un sottoinsieme limitato di campi può essere modificato direttamente.
I campi che non possono essere modificati nei template pubblicati richiedono la creazione di una nuova versione del template per applicare le modifiche.
Il versionamento dei template funziona in modo simile a quello dei servizi elettronici, dato che le modifiche al modello possono impattare i servizi istanziati e quindi i Partecipanti che consumano quell'istanza.
I seguenti campi possono essere modificati senza attivare una nuova versione del template:
Name
Intended Recipient
Description
Voucher Time Limit
Documentation (escludendo la specifica OpenAPI)
Attributes
15.3.1.1.3. Sospensione del e-service Template¶
I template, come i servizi elettronici, possono essere Sospesi. Quando sospesi:
Il template viene rimosso dal catalogo pubblico dei template.
L'istanziazione di nuove istanze dal template sospeso è disabilitata.
Le istanze precedentemente istanziate rimangono inalterate.
I template possono essere riattivati in qualsiasi momento.
I template non possono essere eliminati.
15.3.1.1.4. Istanziazione del e-service Template¶
I Partecipanti possono istanziare un Servizio Elettronico Template sfogliando il Catalogo Template e selezionando un template. Questo processo genera un nuovo servizio elettronico.
I vincoli di istanziazione includono:
Solo i template in stato Attivo sono idonei per l'istanziazione.
L'istanziazione è facilitata attraverso una procedura guidata nell'interfaccia web PDND.
A causa dell'obiettivo di standardizzazione dei template, la maggior parte dei campi è pre-compilata e immutabile durante l'istanziazione.
Le seguenti informazioni non possono essere modificate durante l'istanziazione:
Caricamento della documentazione
Tempo di scadenza del token
Nome, descrizione e attributi
Invece, i seguenti campi devono essere specificati durante l'istanziazione:
Audience
Thresholds
Automatic/Manual Approval Policy
Inoltre, sebbene la specifica OpenAPI sia fissa, i seguenti campi di metadati possono essere forniti in modo che PDND possa aggiornare automaticamente la specifica YAML:
Contatti (nome, email, URL, URL Termini e Condizioni)
URL del server
Ogni servizio elettronico istanziato mantiene un ciclo di vita indipendente analogo ai servizi elettronici standard.
15.3.1.2. Gestione delle Versioni¶
Il versioning dei template segue un processo controllato:
La pubblicazione di una nuova versione del template la imposta su Active.
La versione precedentemente Active viene automaticamente trasferita a Deprecated.
È consentita solo una versione Active per template in qualsiasi momento.
I template possono anche avere una singola versione Draft che coesiste con la versione Active.
Le istanze derivate dai template mantengono un versioning indipendente poiché i Partecipanti possono aggiornare i campi specifici dell'istanza (ad esempio, URL del server) più volte, mentre l'istanza rimane collegata alla versione del template di origine.
Di conseguenza, le versioni dei template e le versioni delle istanze sono indipendenti e non direttamente correlate.
I Partecipanti che istanziano un template possono quindi aggiornare sia l'istanza specifica o, se disponibile, aggiornare a una versione più recente del template.