Input

Name

Description

Type

Optional

serverAddress

Indirizzo del server per domini esterni (o "" per il dominio corrente).

String

Y

token

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

String

Y

tenantId

Tenant id (se nullo o vuoto, viene utilizzato quello della sessione corrente).

String

Y

primaryComponent

Dato strutturato contenente le informazioni del componente principale.

Deve essere costruito con la seguente struttura:

•chiave Component, il cui valore è un collegamento 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 File.

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

•chiave ModelReference, il cui valore è il collegamento al modello del componente di tipo file. Se non presente nel dato strutturato, viene utilizzato il componente di tipo file built-in;

•chiave Metadata, il cui valore è un dato strutturato che contiene i metadati da associare al componente. Viene ignorata se non è indicato il campo ModelReference.

•chiave FileName, testo che riporta eventuale nome del file. Il nome del file viene verificato, se non è valido viene modificato in accordo con i seguenti criteri:

- Se è nullo, vuoto o contenente solo spazi, viene impostato a "No_Name";

- Se contiene caratteri non validi, questi vengono rimpiazzati con il carattere "_";

- Se il nome (senza l'estensione) è un nome riservato ("NUL", "PRN", "COM1", etc.), il carattere "_" viene allegato al nome;

- Se l'estensione del nome è più lunga di 253 caratteri, viene automaticamente troncata a 253 caratteri;;

- Se la lunghezza totale del nome (estensione inclusa) è più lunga di 255 caratteri, il nome viene troncato, mentre l'estensione resta invariata (255 - lunghezza massima del nome compresi punto ed estensione).

Se vi sono campi del dato strutturato non utilizzati, vengono ignorati.

Dataset

Y

otherComponents

Lista di dati strutturati costruiti con la stessa struttura del parametro primaryComponent.

List of Dataset

Y

parentAggregationReference

Collegamento al fascicolo in cui deve essere pubblicato il documento creato.

Reference

freeze

Impostazione che indica se disabilitare il documento dopo la pubblicazione. Il valore di default è false.

Boolean

Y

name

Testo che valorizza la proprietà Name del documento. Se non specificato, il nome sarà "Doc__data e orario_".

String

Y

description

Testo che valorizza la proprietà Description del documento. Non è previsto un valore di default.

String

Y

modelReference

Collegamento al modello di documento da creare, se non valorizzato, viene creato un documento con il modello built-in.

Reference

Y

metadata

Dato strutturato con i metadati da associare al documento, la chiave indica il nome del campo presente nel modello specificato dal parametro modelReference.

Dataset

Y

majorVersion

Rappresenta il numero della versione principale del documento come specificato. Il valore di default è zero.

Se si vuole impostare un numero di versione personalizzato da assegnare alla prima versione del documento, deve essere maggiore o uguale a 1.

Integer

Y

minorVersion

Rappresenta il numero della versione minore del documento. Il valore di default è zero.

Integer

Y

versionLabel

Testo che specifica il nome da assegnare alla versione del documento.

String

Y

versionDescription

Testo che specifica la descrizione da assegnare alla versione del documento.

String

Y

Output

Name

Description

Type

Optional

returnValue

Collegamento alla versione corrente del documento creato.

Reference

Restituisce

Condizione

Errore

Se uno dei passaggi di creazione del documento non si completa.

La creazione del documento viene abortita e il sistema tenta un annullamento della transazione.

Errore

Se primaryComponent o otherComponents contengono un dato strutturato che nel campo Component riporta un collegamento con URL vuota o un collegamento pari a null.

Errore

Se primaryComponent o otherComponents contengono un dato strutturato che nel campo Component riporta un collegamento ad una risorsa che contiene più di un file utilizzabile come componente.