API di piattaforma > JamioPlug > JamioPlug Elastic Storage

Esporta, in un file CSV, una lista di Dataset contenuti in un indice di Elastic Storage secondo i parametri di ricerca forniti.

Metodo

PlugElasticStorage/Export

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
parameters	Criteri di filtro da applicare per esportare dell'indice. I parametri PageSize e PageNumber previsti dal tipo SearchParameters vengono ignorati. Se parameters non è specificato viene restituito tutto il contenuto dell'indice del Plug Elastic Storage.	SearchParameters	Y
includeFields	Lista di campi da includere nel risultato: •se non indicato, vengono inseriti tutti quelli presenti nell'indice tranne i campi l'identificativo; •se viene indicata una lista, nei Dataset sono inseriti esattamente i campi indicati, anche se non presenti nel Dataset dell'indice (in questo caso assumono valore Null); •se si include un campo "", vengono inseriti tutti quelli presenti nell'indice (indipendentemente dagli altri elementi nella lista); •se si include un campo di nome "_id", questo viene valorizzato con l'identificativo del Dataset. •se si include un campo "" e uno "_id" viene esportato tutto l'indice incluso l'identificativo.	List of String	Y
uncompressed	Indica se deve essere restituito un file compresso o un file con estensione CSV. Il valore false, determina la restituzione di un file compresso.	Boolean	Y
options	Definisce le opzioni di conversione da applicare ai Dataset contenuti nell'indice prima dell'esportazione in CSV. Se non specificate vengono utilizzate le impostazioni di default per il formato CSV.	CsvExportOptions	Y
Output
Nome	Descrizione	Tipo	Opzionale
returnValue	Collegamento all'allegato di processo che contiene il file richiesto.	Reference

Commenti

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

Il metodo si comporta come segue:

Restituisce	Condizione
Errore	Se options contiene opzioni non coerenti con il formato CSV.

Autorizzazioni

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

Esempio 1

Dato un indice che contiene il campo Località di tipo testo, si vogliono esportare i primi 20 Dataset in cui valore del campo Località è uguale a Bari, senza specificare un ordinamento. Per definire questi criteri di filtro da applicare si utilizza la funzioni OEL SearchParameters e CatalogFilter come di seguito:

SearchParameters(1,20, CatalogFilter('Localita','EqualsTo',false,'bari'), '', List())

Esempio 2

Dato un indice che contiene il campo Contatto di tipo testo, si vogliono esportare i primi 20 Dataset in cui valore del campo Località è uguale a Bari, senza specificare un ordinamento. Per definire questi criteri di filtro da applicare si utilizza la funzioni OEL SearchParameters e CatalogFilter come di seguito:

SearchParameters(1,20, CatalogFilter('Localita','EqualsTo',false,'bari'), '', List())