API di piattaforma > JamioPlug > JamioPlug Document Automation

Genera un etichetta, sia in formato PDF che immagine, composta da un barcode e da un testo utilizzando una o più risorse ed un template disponibile in una risorsa documento.

Metodo

PlugDocumentAutomation /GenerateLabel

Input
Nome	Descrizione	Tipo	Opzionale
serverAddress	Indirizzo del server per domini esterni (o "" per il dominio corrente)	String	Y
token	Il token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto)	String	Y
resources	Risorse in input utile a generare l'etichetta. Ogni valore del dato strutturato può essere un collegamento ad una risorsa o un Dataset contenente dei campi; ogni chiave corrisponde al nome da utilizzare nel template per riferirsi alla risorsa o al Dataset.	Dataset
templateDocument	Collegamento alla risorsa di tipo documento che contiene il file template con cui costruire l'etichetta. Per maggiori dettagli consultare la sezione Commenti. I formati supportati per il template sono: • doc • dot • docx • dotx • odt • ott • rtf	Reference
barcodeType	Tipo di codice a barre che si vuole ottenere ad esempio Datamatrix, QRCode, Code128, etc.	BarcodeType
codeText	Testo che si vuole convertire in codice a barre.	String
settings	Impostazioni per la generazione del barcode. Se la tipologia di barcode è QR Code l'altezza dell'immagine viene proporzionata rispetto alla larghezza impostata al fine di garantire la forma quadrata del QR Code quando generato il codice. I valori predefiniti sono i seguenti: • ImageHeight: 40 mm • ImageWidth:40 mm • Rotation: 0 (between -359 , 359) • BarColor: #000000 (Black) • BorderType: Solid • BorderWidth: 0 mm • BorderColor: #000000 (Black) • PaddingLeft: 0 mm • PaddingRight: 0 mm • PaddingTop: 0 mm • PaddingBottom: 0 mm • CodeTextLocation: None • CodeTextAlignment: Center • TextColor: #000000 (Black) • TextSpace: 0 mm • Resolution: 96dpi	BarcodeSettings	Y
outputFormat	Formato del file che rappresenta l'etichetta che si vuole ottenere in output. I formati supportati sono: pdf, jpg, png. Se non specificato, il valore predefinito è pdf.	String	Y
Output
Name	Description	Type	Optional
returnValue	Collegamento all'allegato di processo che contiene l'etichetta.	Reference

Commenti

•Il parametro templateDocument deve riportare un collegamento ad una risorsa di tipo documento. Nel documento deve essere presente un componente file del formato utile a generare l'etichetta. Se la risorsa di tipo documento contiene più componenti file del formato utile a generare un'etichetta viene utilizzato il componente principale; in assenza di componente principale, deve esserci un solo componente di tipo File che contiene un file del formato utile a generare un'etichetta. Il file template, costruito con la sintassi LINQ, deve contenere una forma (ad esempio un rettangolo) nella quale sarà riportato il codice barcode generato. La forma è utile per indicare la posizione in alto a sinistra e la larghezza che dovrà avere il codice barcode nell'etichetta generata. Le altre impostazioni della forma come ad esempio altezza, bordi, ombre, etc.sono ignorate. Se nel template templateDocument sono presenti più forme, nell'etichetta ottenuta in output il barcode viene riportato nella prima forma utile; le altre forme vengono ignorate.

•Se il formato del file in output è un'immagine (jpg o png), l'immagine ottenuta sarà la prima pagina disponibile nel documento alla risoluzione specificata nel parametro settings. Se la risoluzione è pari a 0, viene impostata di default a 96dpi.

Il metodo si comporta come segue:

Restituisce	Condizione
Errore	Se templateDocument è il collegamento ad un documento con componente file di formato non supportato.
Errore	Se templateDocument è il collegamento ad un documento con componenti file di formato utile a generare l'etichetta, ma nessuno di essi è il componente principale.