Skip to content
This repository has been archived by the owner on Dec 6, 2023. It is now read-only.

Latest commit

 

History

History
121 lines (68 loc) · 6.35 KB

utente.md

File metadata and controls

121 lines (68 loc) · 6.35 KB

Manuale dell'utilizzatore di IO-SDK

In questa pagina descriviamo l'uso dell'IO-SDK per inviare messaggi alla app IO.

Dopo aver effettuato l'installazione come descritto nel manuale dell'amministratore verrà lanciato il vostro browser predefinito che aprirà una pagina principale come quella che vedete di seguito:

Main Menu

Le opzioni disponibili sono:

  • Import URL
  • Custom Import
  • Send Messages
  • Single Message
  • Debugging
  • Development
  • About

Import URL

Se è la prima volta che cliccate su questa funzione vedrete una pagina simile a questa:

Import URL

Da schermata è possibile inviare un singolo messaggio.

che vi invita a definire un connettore usando un file di esempio. Potete copiare dunque l'indirizzo proposto e premere il pulsante Import per caricare un esempio e proseguire nell'esplorazione delle funzionalità dell'IO-SDK.

Import JSON Esempio

Send Messages

Il codice fiscale deve essere quello di un soggetto abilitato alla ricezione e dipende dalla API Key in uso. Consultate il manuale amministratore per maggiori informazioni.

A questo punto è possibile inviare il messaggio al destinatario selezionado come "endpoint" Production, oppure Development. In quest'ultimo caso, il messaggio sarà visibile per l'ispezione in "Debugging", con il nome "sent:XXXX" dove XXXX è il codice fiscale del destinatario. Altrimenti, se il destinatario è abilitato, verrà ricevuto come email oppure nell'app.

Send Message

Se avete già importato almeno un messaggio, la schermata invece potrebbe essere simile a questa:

Send Message After Import

Trovate l'indicativo del messaggio o dei messaggi importati con alla sinistra di ciascun messaggio una casella di spunta che permette di indicare la selezione specifica del messaggio. Dopo avere selezionato almeno un messaggio potete scegliere l'endpoint di riferimento tra i valori proposti nella casella di scelta ad elenco e premere il pulsante Send Selected Messages per inviare il messaggio

Send Selected Message

Il corretto invio verrà indicato da un messaggio di conferma come quello evidenziato nell'immagine sottostante:

Send Selected Message OK

Single Message

Send Single Message

Selezionando l'invio di un singolo messaggio occorre specificare:

  • Fiscal Code: il codice fiscale del destinatario;
  • Subject: il soggetto del messaggio;
  • Message: il testo del messaggio;
  • Amout: l'importo;
  • Notice Number: il numero dell'avviso.

Specificate anche in questo caso il tipo di Endpoint e premete sul pulsante Send per inviare. Qualora sceglieste "Production" come Endpoint, se il destinatario è abilitato correttamente, verrà spedito un messaggio e-mail nell'App IO.

NOTE

a) Per scrivere il testo del messaggio potete usare una sintassi del testo chiamata "Markdown", ovvero una codifica progettata in modo che possa essere convertita in HTML

b) Il codice fiscale deve essere quello di un soggetto abilitato alla ricezione ed è correlato alla API Key in uso. Consultate il manuale dell'amministratore per maggiori informazioni.

Debugging

Da questa sezione dell'applicazione è possibile effettuare i riscontri sul corretto funzionamento ed ottenere maggiori dettagli su eventuali anomalie. Nell'immagine qui sotto riportata vedete ad esempio il messaggio spedito prima come esempio.

Debugging

I pulsanti nella parte superiore permettono, nell'ordine, di mostrare tutte le informazioni di debug, visualizzare i messaggi importati, mostrare solo i messaggi inviati, cercare tra le informazioni. In particolare, per la ricerca potete sfruttare i pattern facendo riferimento a questo formato.

Cliccando sulla chiave corrispondente ad un certo messaggio visualizzerete il dettaglio (in formato JSON), come nell'esempio seguente:

Debugging Details

Il pulsante Clean Current Keys permette di pulire la cache.

Development

Da questa funzione si accede all'ambiente di sviluppo integrato (IDE) Eclipse Theia, potete trovare maggiori informazioni nella documentazione specifica di VSCode in quanto viene usata la stessa interfaccia utente.

Development

Usando questo ambiente è possibile installare e modificare diversi connettori, come anticipato nel manuale dell'amministratore per completare l'installazione del connettore scelto, bisogna aprire un terminale dei comandi partendo dal menu Terminal e successivamente cliccare su New Terminal

Dev New Terminal

quindi scrivere il comando seguente (premendo invio alla fine):

./build.sh

Dev Build OK

Ulteriori dettagli sui connettori li trovate nel manuale dello sviluppatore.

Custom Import

Abbiamo tenuto per ultima la descrizione della funzionalità di Custom Import perché, se avete seguito l'esempio nel manuale dell'amministratore e poi i passaggi descritti in questa pagina, a questo punto dovreste aver completato la configurazione per caricare un file in formato Excel.

Custom Import

Un "connettore" è un programma (che può essere scritto in linguaggi di programmazione diversi secondo la necessità) che consente di collegarsi a varie fonti di dati: dai file in formato Excel, appunto, ai servizi REST.

Il file da caricare nel nostro caso di esempio deve trovarsi nella directory specificata dove è stato installato il connettore e potrebbe essere ad esempio:

test/data.xlsx

L'ambiente IDE è molto evoluto si rimanda a documentazione specifica di VSCode in quanto l'editor usa la stessa interfaccia utente. Notare che nell'IDE fornito sono installati alcuni plugin specifici per i vari linguaggi di programmazione.

Import Excel Sample