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

organizationalEntity

Collegamento a Organizzazioni o Unità organizzative a cui è associato il Sigillo elettronico. Obbligatorio se si desidera apporre una firma visibile.

Reference

Y

credentialsReference

Collegamento alle Credenziali con scope RemoteQualifiedCertificate da utilizzare per apporre il sigillo elettronico qualificato.

E' possibile specificare un collegamento in cui è valorizzata solo la proprietà Name con il Nickname di una credenziale esistente.

Reference

resourceReference

Collegamento alla risorsa contenente il file da firmare.

Può essere un riferimento ad un Attachment, un FileComponent, un allegato di processo, un Document o un'altra risorsa contenente attachments.

Se la risorsa è di tipo Document e contiene più componenti file viene utilizzato:

•il componente principale, se è di tipo File;

•in assenza di componente principale, deve esserci un solo componente di tipo File.

Se la risorsa contiene una lista di attachments, deve esserci un solo file.

Reference

fieldMapping

Nome dei campi disponibili nella risorsa referenziata da organizationalEntity per valorizzare la denominazione dell'Elemento Organizzativo, il codice fiscale o la partita IVA, l'eventuale elemento grafico. I nomi dei campi, di tipo testo, che è possibile specificare nel dato strutturato sono entityName, entityID, entityEmail, entityPhone, entityLogo. Obbligatorio se si desidera apporre una firma visibile.

Dataset

Y

signatureReason

Testo che indica la motivazione della firma.  Obbligatorio se si desidera apporre una firma visibile.

String

Y

signatureLocation

Testo che indica il luogo di apposizione della firma.  Obbligatorio se si desidera apporre una firma visibile.

String

Y

signatureSettings

Impostazioni per la firma, può essere solo di tipo AdHocSignatureSettings o AutoplaceSignatureSettings. Obbligatorio se si desidera apporre una firma visibile.

SignatureSettings

Y

signatureType

Tipo di firma da applicare: può essere Pades, Cades o Xades.

Se non specificato e il file è in formato PDF viene utilizzato Pades, se è in formato XML Xades, in tutti gli altri casi Cades.

String

Y

testMode

True se è richiesta l'esecuzione del metodo in modalità test. Se non specificato, viene effettuata l'esecuzione del metodo in modalità live.

Boolean

Y

Output

Nome

Descrizione

Tipo

returnValue

Restituisce un dato strutturato che contiene i seguenti campi:

•SignedDocument: collegamento al documento firmato;

•SignedDocumentName: stringa che riporta il nome completo del file firmato.

In modalità test, la firma elettronica non viene applicata al documento e viene restituito in output il medesimo file di input.

Dataset

Restituisce

Condizione

Errore

PLUG_Error

Se signatureType riporta un tipo di firma che non si applica al documento da firmare resourceReference.

Errore

PLUG_Error

Se signatureType è diverso da Pades, Xades o Cades.

Errore

PLUG_Error

Se si vuole apporre una firma elettronica xades ad un file riportato in resourceReference su cui è già apposta una firma xades.

Errore

PLUG_Error

Se il file xml che si vuole firmare non è ben formato e la firma richiesta è di tipo xades.