FinalizeRegistration

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > JamioPlug > JamioPlug Digitalitaly > Registrazione di protocollo e interoperabilità >

FinalizeRegistration

Finalizza una registrazione di protocollo digitale.

 

Metodo

PlugDigitalitaly/FinalizeRegistration

 

Input

Nome

Descrizione

Tipo

Opzionale

serverAddress

Indirizzo server da un Dominio esterno (per il Dominio della sessione corrente, utilizzare nullo o vuoto).

String

Y

token

Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).

String

Y

registerNicknameField

Testo che indica il nome del campo della configurazione del registro di protocollo che contiene il Nickname del registro.

String

 

resourceReference

Collegamento alla risorsa che rappresenta la registrazione di protocollo.

Reference

 

body

Testo che contiene un eventuale messaggio di cortesia.

String

Y

applySignature

Specifica se applicare la firma prevista nella casella.

Boolean

 

inputDataset

Placeholder e corrispondenti valori utili a valorizzare il testo contenuto nel parametro body. Il nome dei campi del dato strutturato corrisponde al placeholder (senza ##) mentre il valore raprpesenta il contenuto da riportare nel body del template.

I placeholder devono essere riportati nel body con la forma ##Nome Campo## e vengono sostituiti nel messaggio inviato con i rispettivi valori riportati in InputDataSet.

Dataset

Y

resourceFieldValues

Valori da assegnare ai campi della risorsa, personalizzato con il tipo Dati, da utilizzare per creare la risorsa con cui tracciare la spedizione del singolo messaggio.

La chiave del campo del dato strutturato corrisponde al nome del campo disponibile nel modello della risorsa. Il valore del campo corrisponde al valore che si vuole assegnare nel campo della risorsa che traccia la spedizione del messaggio. Se il valore del campo è di un tipo diverso da quello definito nel modello, sarà eseguita una conversione. Se la conversione del valore nel nuovo tipo non è attuabile, sarà restituito errore. Inoltre se in resourceFieldValues viene specificato un campo che corrisponde ad un campo 'notevole' (per es. "Subject" o "Oggetto", se così rimappato), prevale il valore specificato in resourceFieldValues rispetto ai valori specificati nei parametri specifici (per es. subject o body.)

Dataset

Y

 

Commenti

La registrazione può interessare un protocollo in entrata, in uscita o una registrazione interna. Il metodo sfrutta le funzionalità di tracciamento di spedizione per presentare informazioni utili al tracciamento dello stato del protocollo.

A partire dai campi definiti nella configurazione del registro, attribuisce una numerazione alla registrazione, costruisce ed allega il file di segnatura e:

•se si tratta di una registrazione di protocollo in ingresso, avvia una spedizione, impostando il TargetSendingStatus al valore Processed, aggiunge un trackingMessage con tracking status pari a DeliveredToRecipient.

Se al registro è associata una configurazione di una casella PEC, tramite la valorizzazione del parametro MailBox nella configurazione, e il trackingMessage di ricezione è caratterizzato da un trasporto di tipo email o PEC, la funzione, utilizzando il metodo SendPECAdvanced, invia un messaggio PEC ai destinatari indicati nei parametri di configurazione CorrispondentListField e CCCorrispondentListField aggiunge un TrackingMessage con tracking status pari a ProcessedByRecipient e invia una ricevuta di conferma al mittente;

•se si tratta di una registrazione di protocollo in uscita, invia un messaggio PEC, utilizzando il metodo SendPEC e impostando per ciascun corrispondente i trackingMessage e i targetSendingStatus in funzione di come sono valorizzati i parametri correspondentField, addressField, transportField e trackProcessingField del metodo SendPEC a partire dalla configurazione del registro;

•se si tratta di una registrazione di protocollo interna, avvia una spedizione, impostando il TargetSendingStatus al valore Delivered, aggiunge un trackingMessage con tracking status pari a DeliveredToRecipient. Se per il registro è configurata una casella email/PEC e il trackingMessage di ricezione è caratterizzato da un trasporto di tipo email o PEC, aggiunge un TrackingMessage con tracking status pari a Delivered e invia una ricevuta di conferma al mittente.

 

La modalità operativa del metodo dipende dalla configurazione: se il parametro testMode è true, il metodo opera in modalità test.

 

Il metodo si comporta come segue:

Restituisce

Condizione

Errore

Se alcuni parametri di configurazione del registro non sono valorizzati