API di piattaforma > JamioPlug > JamioPlug Digitalitaly > Conservazione a norma

Invia in conservazione un documento informatico o un documento amministrativo informatico (secondo le definizioni AGID), prelevando informazioni dalle risorse di Jamio o in altre risorse ad esse collegate.

Metodo

JamioPlug Digitalitaly/SendResourceToRetention

Input
Nome	Descrizione	Tipo	Opzionale
token	Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).	String	Y
configurationReference	Collegamento alla risorsa di tipo configurazione del Plug Digitalitaly da utilizzare. E' possibile specificare un collegamento con valorizzata solo la proprietà Name pari al Nickname di una Configurazione esistente.	Reference
resourceReference	Collegamento alla risorsa di tipo Dati, Documento o al TrackingMessage di una spedizione da inviare in conservazione.	Reference
otherResources	Dato strutturato contenente ulteriori informazioni utili per la conservazione. La chiave identifica la risorsa, il valore è un Dato Strutturato o il collegamento a una risorsa di Jamio contenente le informazioni da inviare in conservazione. Non è possibile utilizzare le seguenti stringhe come chiavi: resource, owner, configuration, previousVersion, sourceDocument.	Dataset	Y
customMetadata	Dato strutturato contenente dati aggiuntivi utili a valorizzare i metadati. Non può contenere dati annidati o liste.	Dataset	Y
registerField	Testo che indica il nome del campo che contiene una serie numerica opportunamente calcolata a partire dall'identificativo del registro.	String	Y
testMode	True se è richiesta l'esecuzione del metodo in modalità test. Il valore di Default è false.	Boolean
Output
Nome	Descrizione	Tipo
returnValue	Dato strutturato contenente le seguenti informazioni: •AgidMetadata, testo che riporta il file .xml dei metadati, nel formato previsto dalla normativa AgID per lo specifico profilo di archiviazione; •ResultDescription, testo che riporta informazioni riguardanti il risultato, compresi eventuali messaggi di avviso. Il campo può non essere sempre valorizzato. La presenza di un messaggio di avviso non impedisce che la risorsa venga conservata, nel messaggio è sempre indicato se è andata a buon fine la conservazione. In modalità test il metodo non completa la conservazione, ma il parametro riporta i metadati prodotti.	Dataset

Commenti

E' possibile inviare in conservazione un Documento Informatico, così come definito dalle linee guida AgID, tramite una risorsa di tipo Documento, con almeno un componente di tipo file, o di tipo Dati, con almeno un allegato di tipo file o tramite TrackingMessage.

E' possibile inviare in conservazione un Documento Amministrativo Informatico, così come definito dalle linee guida AgID, tramite una risorsa di tipo Documento, con almeno un componente di tipo file, o di tipo Dati, con almeno un allegato di tipo file.

Per la corrispondenza tra metadati della risorsa Jamio e quelli definiti dalla normativa, si rimanda alla tabella esplicativa dei valori di mapping per la definizione dei metadati AgiD.

La definizione della numerazione del registro è lasciata a gestione del progettista, per poter differenziare, eventualmente, stesse numerazioni di risorse afferenti a modelli diversi.

Se resourceReference fa riferimento ad una risorsa di tipo Dati o Document e il parametro registerField viene valorizzato con una stringa, il campo da utilizzare per costruire l'identificativo del registro sarà ricercato nei campi della risorsa referenziata. Quando, invece, il valore da assegnare al parametro registerFields è contenuto in uno dei seguenti elementi, è possibile specificare un'espressione utilizzando delle chiavi riservate:

•la risorsa principale, utilizzando nell'espressione la chiave riservata #resource, ad esempio #resource.Fields["nome campo"];

•la configurazione, utilizzando nell'espressione la chiave riservata #configuration;

•risorsa già inviata in conservazione in una versione precedente, utilizzando nell'espressione la chiave riservata #previousVersion;

•la risorsa che contiene il documento principale, utilizzando nell'espressione la chiave riservata #sourceDocument;

•una risorsa che contiene un TrackingMessage, utilizzando nell'espressione la chiave riservata #owner.

In particolare, nel caso in cui il parametro registerField non è valorizzato e si invia in conservazione una risorsa che contiene un TrackingMessage, esso verrà valorizzato col testo 'PEC' nel file XML prodotto, se la risorsa attiene allo specifico caso di una spedizione Pec, diversamente sarà valorizzato col testo 'Tracking'.

Il metodo costruisce, per il profilo del documento indicato in configurazione (Documento Informatico o Documento Amministrativo Informatico), il file XML contenente i metadati da inviare al sistema di conservazione, insieme ai file idonei.

L'obbligatorietà dei campi dipende dalla tipologia di documento secondo direttive AgID. In generale, per ciascun metadato:

•se è obbligatorio, esso deve essere valorizzato e riportato nel file xml;

•se non è obbligatorio e non è valorizzato, non è riportato nel file xml;

•se non è obbligatorio ed è valorizzato, è riportato nel file xml;

•se è un metadato aggiuntivo, non previsto dalle direttive AgID, ed è valorizzato, non è riportato nel file xml.

Se il parametro testmode assume il valore true, la funzione non effettua la chiamata al sistema di conservazione, ma restituisce comunque la stringa che contiene solo la descrizione xml dei metadati prodottti, senza eventuali messaggi di avviso (warning).

Il metodo si comporta come segue:

Restituisce	Condizione
Errore	Se la risorsa mandata in conservazione non contiene componenti di tipo file.
Errore	Se la risorsa mandata in conservazione contiene un componente principale (se è una risorsa di tipo Documento) o un collegamento ad un documento principale (se è una risorsa di tipo Dati) non di tipo file.
Errore	Se la risorsa mandata in conservazione non è numerata.
Errore PLUG_AlreadyRetainedResource	Se la risorsa mandata in conservazione risulta già inviata in conservazione.
Errore PLUG_AlreadyRetainedIdentifier	Se l'identificativo della risorsa mandata in conservazione coincide con quello di un'altra risorsa già inviata in conservazione.
Errore	Se uno dei metadati obbligatori previsti da AgiD non è definibile con le informazioni presenti nella risorsa Jamio.