Input

Nome

Descrizione

Tipo

Opzionale

token

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

String

Y

configurationReference

Collegamento alla risorsa di tipo configurazione del Plug Elastic Storage da utilizzare. E' possibile specificare un collegamento con valorizzata solo la proprietà Name pari al Nickname di una configurazione esistente.

Reference

inputFile

Collegamento alla risorsa contenente il file con estensione CSV.

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 e contiene un CSV;

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

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

Tra i campi del file CSV è possibile specificare un campo identificativo, secondo le logiche qui riportate.

Le intestazioni del file CSV non devono contenere il carattere "." (punto).

Reference

options

Definisce le opzioni di conversione da applicare ai dati riportati nel file CSV prima del salvataggio nella configurazione del plug Elastic Storage.

Se per una colonna del CSV non viene specificato il ColumnType tramite CsvToListConversionOptions, qualunque contenuto del campo viene interpretato come una stringa, mentre, se specificato, si possono definire nell'indice del Plug Elastic Storage campi numerici, date, booleani o stringhe.

I nomi passati al parametro ColumnHeaders non devono contenere il carattere "." (punto).

CsvToListConversionOptions

Y

idFields

Lista dei nomi dei campi del CSV con cui deve essere calcolato l'identificativo del DataSet che sarà estrapolato dal CSV e salvato nell'indice del plug Elastic Storage.

I nomi devono riferirsi a campi di primo livello.

Il parametro è obbligatorio, ma viene ignorato se tra le intestazioni ne esiste una denominata "_id" o "Id", secondo le logiche qui riportate.

List of String

commonFields

Dato strutturato che riporta un insieme di campi comuni, il cui valore deve essere riportato nei Dataset dell'indice del Plug Elastic Storage.

I campi devono essere di primo livello, non annidati.

Se un campo specificato in commonFields non è presente nel file CSV, esso viene aggiunto ai dati che verranno salvati nell'indice del Plug Elastic Storage con il suo valore riportato in tutti i Dataset della configurazione del Plug Elastic Storage.

Se, invece, è presente nel file CSV, i corrispondenti valori contenuti nel file e il formato, eventualmente definito nel ColumnTypes del parametro options, vengono ignorati.

Ad esempio, se il campo "Importo" presente nel file CSV è definito come intero tramite ColumnTypes, ma in commonFields è definito come stringa, allora verrà riportato nella configurazione di Elastic Storage come stringa.

Dataset

Y

skipErrors

Indica se proseguire o meno nel caso di errori di conversione dei dati contenuti nel file CSV o se

•uno dei campi indicati in idFields è nullo;

•l'identificativo (sia esso il valore del campo _id, il valore del campo Id o quello costruito tramite i campi indicati in idFields) è stringa vuota;

•l'identificativo (sia esso il valore del campo _id, il valore del campo Id o quello costruito tramite i campi indicati in idFields) superi la lunghezza massima.

Se True, le righe vengono scartate e aggiunte allo ScrapReport del returnValue del metodo con i relativi messaggi d'errore.

Se False, il Job viene interrotto.

Boolean

Y

updateOnly

Indica se deve essere eseguito solo l'aggiornamento dei record esistenti, oppure si devono accodare anche i record non esistenti

Boolean

Y

Output

Name

Description

Type

Optional

returnValue

Dato strutturato con i seguenti campi:

•TotalItems: numero di righe da convertire (numero totale di righe meno quelle di intestazione);

•ProcessedItems: numero di righe convertite correttamente;

•ScrappedItems: numero di righe processate con errore e/o non processate per interruzione del Job;

•ScrapReport: file CSV con la stessa struttura del file passato in input, contenente le righe scartate, con i rispettivi errori, e quelle non elaborate in caso di interruzione del Job;

•JobStatus: enumerativo che indica lo stato finale del job (Completed o Canceled).

Dataset

Restituisce

Condizione

Errore

Se la proprietà ColumnTypes delle opzioni di conversione contiene campi non esistenti

Errore

Se nel DataSet estratto dal CSV, dopo l'applicazione delle opzioni di conversione, sono presenti entrambe le colonne di nome "Id" e "_id"

Errore

Se il DataSet estratto dal CSV, dopo l'applicazione delle opzioni di conversione, contiene un campo che si chiama "_id" o "Id" e questo è di tipo diverso da testo breve e numerico intero.

Errore

Se la proprietà IdFields non è valorizzata e il DataSet estratto dal CSV, dopo l'applicazione delle opzioni di conversione, non contiene un campo che si chiama "_id" o "Id"

Errore

Se è valorizzato IdFields con un elemento diverso da testo breve e numerico intero e nelle intestazioni del DataSet estratto dal CSV, dopo l'applicazione delle opzioni di conversione, non è presente una colonna di nome "Id" o "_id”

Errore

Se inputFile contiene una Reference ad una risorsa non contenente alcun file di tipo CSV

Errore

Se inputFile contiene una Reference ad una risorsa contenente più di un file di tipo CSV

Errore

Se configurationReference è una risorsa inesistente

Errore

Se il CSV contiene un numero di colonne differente da riga a riga

Errore

Se il Job è in stato faulted.