CreateWorkingCopyWithFileComponents

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > Servizi Core > Jamio Document >

CreateWorkingCopyWithFileComponents

Crea un documento bozza con componenti di tipo file, individuati tramite collegamenti ad allegati di risorsa o di processo.

 

Metodo

Jamio Document/CreateWorkingCopyWithFileComponents

 

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 allegato, un Componente File, un allegato di processo, un Documento o un'altra risorsa contenente allegati. Se la risorsa è di tipo Documento 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;

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.

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

Y

ownerReference

Collegamento all’identità CurrentOwner.

Reference

 

name

Testo che valorizza la proprietà Name della bozza. Se non specificato, il nome sarà "Draft _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 la destinazione del documento.

Dataset

Y

Output

Name

Description

Type

Optional

returnValue

Collegamento alla bozza del documento creato.

Reference

 

 

 

Commenti

I parametri PrimaryComponent e OtherComponents non sono obbligatori, ma almeno uno di essi deve essere presente. Se non è valorizzato il parametro PrimaryComponent, ma si utilizza la lista degli OtherComponents viene impostato come componente principale il primo della lista.

 

Il metodo si comporta come segue:

Restituisce

Condizione

Errore

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

La creazione della bozza 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.

 

Esempio1

Si vuole creare una bozza di documento, BozzaC, a partire da due risorse di tipo documento esistenti: DocumentoA e DocumentoB.

Documento A contiene un solo componente file, impostato come componente principale.

Documento B contiene tre componenti file, di cui uno è impostato come componente principale.

Utilizzando il metodo CreateDocumentWithFileComponents riportando in input:

- il campo Component del dato strutturato primaryComponent valorizzato con il collegamento a DocumentoA;

- il campo Component del dato strutturato otherComponents valorizzato con il collegamento a DocumentoB.

Si ottiene BozzaC che ha i seguenti due componenti:

- componente principale: una copia del componente principale di DocumentoA;

- componente file: una copia del componente principale di DocumentoB.

 

Esempio2

Si vuole creare una bozza di documento, BozzaC, a partire da due risorse di tipo documento esistenti: DocumentoA e DocumentoB.

Documento A contiene un solo componente file, impostato come componente principale.

Documento B contiene tre componenti file, di cui nessuno è impostato come componente principale.

Utilizzando il metodo CreateDocumentWithFileComponents riportando in input:

- il campo Component del dato strutturato primaryComponent valorizzato con il collegamento a DocumentoA;

- il campo Component del dato strutturato otherComponents valorizzato con il collegamento a DocumentoB.

Si ottiene errore, poiché il DocumentoB contiene più componenti file utilizzabili come componente.