Input

Nome

Descrizione

Tipo

Opzionale

token

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

catalogReference

Collegamento al catalogo Jamio contenente i valori da creare nel Dataset di un indice del Plug Elastic Storage.

Una descrizione generale della gestione dei diversi tipi di dati in un indice del plug Elastic Storage è consultabile qui

E' necessario specificare anche il valore del campo identificativo del Dataset da creare. Esso può essere espresso tramite un campo denominato "_id" o "Id" o in alternativa specificando, nel parametro idFields, i valori dei campi utili a calcolare l'identificativo.

Reference

parameters

Parametri di ricerca da applicare al catalogo per individuare quali righe del catalogo utilizzare per creare i Dataset . (Se non specificato, vengono utilizzate tutte).

SearchParameters

Y

idFields

Lista dei nomi delle colonne del catalogo utili a calcolare l'identificativo del Dataset di un indice del Plug Elastic Storage.

I nomi devono riferirsi a campi di primo livello, non annidati.

Il parametro è obbligatorio, ma viene ignorato se tra le colonne del catalogo esiste una denominata "_id" o "Id", secondo le logiche qui riportate. Se idFields è valorizzato con {id} l'identificativo del Dataset dell'indice del Plug Elastic Storage viene valorizzato con l'id della risorsa i-esima del catalogo.

Gli IdFields non hanno alcuna relazione con il parametro includeFields, essi non caratterizzano i campi del Dataset, ma sono di ausilio alla caratterizzazione dell'ID del Dataset in elastic.

List of string

commonFields

Dato strutturato che riporta un insieme di campi che vengono impostati come valore comune su tutti i DataSet da creare.

I campi devono essere di primo livello, non annidati.

Per maggiori dettagli vedi sezione commenti.

Dataset

Y

referenceField

Specifica in quale campo dell'indice del plug Elastic Storage deve essere riportato il collegamento alla risorsa a cui fa riferimento l'elemento i-esimo del catalogo.

Il campo deve essere di primo livello, non annidato.

Se il campo è già presente nell'indice del plug Elastic Storage esso viene aggiornato, altrimenti accodato ai campi esistenti.

String

Y

skipErrors

Indica se proseguire o meno nel caso in cui per un CatalogItem

•uno dei campi indicati in idFields è nullo;

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

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

Se True, tali CatalogItem vengono scartati e aggiunti allo ScrapReport del returnValue del metodo con i relativi messaggi d'errore.

Se False, il Job viene interrotto.

Boolean

Y

includeFields

Lista dei nomi delle colonne del catalogo che devono essere inserite nell'indice del Plug Elastic Storage. Se non specificato, sono riportate nellindice del Plug Elastic Storage tutte le colonne.

I nomi dei campi da includere devono corrispondere a dati di primo livello, non annidati.

List of string

Y

Output

Nome

Descrizione

Tipo

returnValue

Dato strutturato con i seguenti campi:

•TotalItems: numero totale di CatalogItem da processare;

•ProcessedItems: numero di CatalogItem processati correttamente;

•ScrappedItems: numero di CatalogItem processati con errore o non processati per interruzione del Job;

•ScrapReport: file .zip contenente un file .csv che riporta solo i CatalogItem processati con errore.

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

Dataset

Restituisce

Condizione

Errore

Se il Dataset estratto dal catalogo indicato nel parametro catalogReference contiene un campo che si chiama "_id" e un campo che si chiama "Id"

Errore

Se il Dataset estratto dal catalogo indicato nel parametro catalogReference contiene un campo che si chiama "_id" o "Id", ma di tipo diverso da testo breve o numerico intero.

Errore

Se il Dataset estratto dal catalogo indicato nel parametro catalogReference non contiene un campo che si chiama "_id" o "Id" e idFields non è valorizzato.

Errore

Se i campi di idFields non esistono nel Dataset estratto dal catalogo, indicato nel parametro catalogReference.

Errore

Se i campi passati al parametro idFields sono diversi da testo breve e numerico intero o si riferiscono a campi non di primo livello.

Errore

Se i campi del Dataset estratto dal catalogo, indicato nel parametro catalogReference, non sono del tipo ammesso (testo breve, testo lungo, numerico intero, numerico a virgola mobile, numerico decimale, data e data/ora, booleano, collegamento).

Errore

Se un filtro applicato sul catalogo non restituisce alcun Dataset

Errore

Se il nome del campo referenceField è uguale al nome di una colonna del catalogo riportato in catalogReference.

Errore

Se il nome del campo referenceField è uguale al nome di un campo di CommonFields.

Errore

Se includeFields riporta il nome di una colonna non presente nel catalogo riportato in catalogReference.