CreateFromCsv

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > JamioPlug > JamioPlug Elastic Storage >

CreateFromCsv

Salva i dati presenti in un file CSV, in un indice del plug ElasticStorage.

Le righe del CSV che non possono essere salvate vengono restituite opzionalmente in un file CSV di scarto.
Le righe del CSV devono essere tutte compatibili con l'intestazione, ovvero devono contenere tutte lo stesso numero di campi.

 

Metodo

PlugElasticStorage/CreateFromCsv

 

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.

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 specificando il ColumnType si hanno nella configurazione del Plug Elastic Storage campi numerici, date, booleani o stringhe, secondo quanto richiesto.

CsvToListConversionOptions

Y

idFields

Lista dei nomi dei campi del CSV con cui deve essere calcolato l'identificativo del DataSet da creare nella configurazione del plug ElasticStorage. Il parametro viene ignorato se tra i campi è presente un campo denominato "_id" o "Id", secondo le logiche qui riportate.

List of String

Y

commonFields

Dato strutturato che riporta un insieme di campi comuni, il cui valore deve essere riportato nelle righe del CSV. Se il campo specificato in CommonFields non è presente nelle righe del CSV, esso viene accodato, altrimenti viene sovrascritto. Se il campo specificato in CommonFields è presente nelle righe del CSV ed ha un formato diverso da quello specificato nel ColumnTypes, viene sovrascritto sia nel valore che nel formato. Ad esempio, se il campo "Importo" nel ColumnTypes è definito come intero, 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 in cui una riga del CSV presenti degli errori di conversione dei campi o riporta un numero di campi diverso da quello previsto.

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

ScrappedItems: numero di righe scartate

ScrapReport: file con la struttura CSV che contiene le righe scartate e le righe di intestazione del file iniziale.

Dataset

 

 

Commenti

Tra le opzioni di conversione elencate in CsvToListConversionOptions, vengono gestite nella configurazione del Plug Elastic Storage solo le seguenti:

Delimiter

QuotedFields

ListOfDataset (è sempre assunto pari a true)

HeaderRow

ColumnHeader

ColumnTypes

ColumnFormats

CultureInfo

mentre vengono ignorate:

IgnoreLineBreaks

ListOfDataset se valorizzato come false

E' opportuno specificare sempre nelle opzioni di conversione del CSV il parametro cultureInfo, per evitare errori di conversione dovuti ad una diversa interpretazione del formato di numeri e date per una regione o paese.

 

Le righe del CSV vengono convertite in istruzioni per l'inserimento della configurazione del Plug Elastic Storage. Durante la conversione se:

skipErrors è uguale a false, al primo controllo fallito la procedura deve essere interrotta e deve essere restituita un'eccezione.

skipErrors è uguale a true, le righe che non si è riusciti a convertire vengono accodate allo ScrapReport. Alle righe dello ScrapReport viene aggiunta una cella contente informazioni relative all'errore.

 

Il metodo si comporta come segue:

Restituisce

Condizione

Errore

Se inputFile contiene un campo che si chiama "_id" e un campo che si chiama "Id"

Errore

Se inputFile contiene un campo che si chiama "_id" o "Id" e questo è di tipo diverso da testo breve e numerico intero.

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 in presenza di campi di tipo data nel CSV non è impostato CultureInfo nelle opzioni di conversione

 

Autorizzazioni

Per eseguire il metodo è necessario possedere il permesso di Utilizzo sull'indice del Plug Elastic Storage.