Mi piace pensare al web service come a un vassoio: vi posso disporre tè e caffè, frutta, pane, marmellate e miele, biscotti, ecc., ma sarà poi il “destinatario” a prendere liberamente ciò che desidera per colazione.
La funzione del web service è analoga: l’aziende vi espone contenuti validati, ma è il destinatario autorizzato (es. il web service, l’applicazione web o la app dell’azienda importatrice, distributrice o utilizzatrice) che prende i contenuti di cui li necessità, elaborandoli per proprio conto e mettendoli a disposizione dei propri utenti in base alle modalità previste.
Il web service è uno strumento prezioso, poiché permette di automatizzare lo scambio di dati (nel nostro caso sono tipicamente contenuti tecnici e product data) e metadati, garantendo la distribuzione coerente di informazioni validate dall’azienda e aggiornate.
I web services possono alimentare sia le applicazioni di proprietà dell’azienda (es. la knowledge base tecnica, l’e-shop, il chatbot del servizio clienti, la app che dà accesso ai manuali di istruzioni, ecc.), sia le applicazioni di parti terze autorizzate (es. l’e-shop di importatori/distributori, gli ERP anche di utilizzatori finali, le knowledge base di formatori tecnici, ecc.).
Argo CCMS, il sistema di gestione di contenuti tecnici e product data di KEA, ha come possibile output anche il proprio web service con le funzioni sopra citate.
Il web service di Argo CCMS si compone di due parti.
Il Plugin Argo-to-WebService dedicato all’esportazione dei contenuti da Argo CCMS per il web service
Il Plugin permette di:
- Selezionare un numero non predefinito di documenti/revisioni di cui esportare i contenuti in tutte le lingue attive
- Avviare a mano la procedura di esportazione oppure schedularla (es. esportazione automatica 1x ogni notte).
- Ogni record del file XML esportato dal plugin comprende, oltre al contenuto, i seguenti metadati:
- il Tipo di Modulo (es. testo, immagine, tabella, warning, ecc.)
- il Nome dello Stile del modulo (es. il modulo di testo può avere stili atti a marcare i diversi livelli dei titoli [Titolo 1 a 6], il testo corrente, gli elenchi puntati e numerati, ecc.)
- la Classificazione del contenuto
- le Proprietà (es. codici di gruppi o componenti, nomi di famiglie di prodotto, mercati, norme, ecc. Queste caratteristiche definiscono il campo di utilizzo di un contenuto o di un insieme omogeneo di contenuti [topic] e possono essere usate per configurare in modo dinamico la documentazione in base a una o più dimensioni)
- i Destinatari (es. installatore, formatore, operatore, manutentore, ecc. Questa caratteristica definisce il profilo/i profili a cui si rivolge un contenuto o un insieme omogeneo di contenuti [topic] e può essere usata per personalizzare il contenuto in base alprofilo dell’utente)
- i Bookmark (indicano lo stato del contenuto e possono essere usati, per esempio, per escludere contenuti “non validati”)
- i Flag di traduzione (indicano lo stato di traduzione di un contenuto e e possono essere usati, per esempio, per escludere contenuti “non tradotti”).
Il Web Service
Il Plugin invia al web service gli insiemi di file XML esportati (1 file per ogni documento/revisione di Argo CCMS e per ogni lingua).
Il web service di Argo CCMS espone i file XML al web service o all’applicazione di destinazione.
Il web service o l’applicazione di destinazione prendono in carico, elaborano e visualizzano in tutto o in parte i contenuti presenti all’interno dei file XML esportati da Argo CCMS. Il modo con cui l’utente visualizzerà e interagirà con i contenuti (es. navigazione, ricerca, filtri, interrogazione in linguaggio naturale) è tipico dell’applicazione di destinazione.