Do It The jAPS Way
Copyright © 2010 Tzente s.r.l.
Legal Notice
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the Appendix entitled "GNU Free Documentation License".
2011-02-14
| Diario delle Revisioni | ||
|---|---|---|
| Revisione 1.3 | 2011-02-14 | MEM |
|
Revisione per il rilascio di jAPS 2.0 entando 2.2.0 | ||
| Revisione 1.2 | 2010-02-22 | MEM |
|
Revisione per il rilascio di jAPS 2.0.10 | ||
| Revisione 1.1 | 2009-10-20 | MEM |
|
Revisione per il rilascio di jAPS jAPS 2.0.8 | ||
| Revisione 1.0 | 2009-05-22 | WG |
|
La revisione di questo documento sarà ultimata quando il documento Pattern Integrazione Servizi sarà completamente tradotto e referenziato | ||
Estratto
Lo scopo di questo documento è quello di fornire una descrizione completa della struttura del Plugin Rss.
Sommario
Lista delle Tabelle
Lista degli Esempi
Lo scopo di questo documento è quello di fornire una descrizione completa della struttura del Plugin jprss.
Questo documento è destinato a chi intende conoscere le funzionalità del jAPSPlugin jprss,
e sta prendendo in considerazione la eventuale integrazione in un Ambiente di Produzione già funzionante
o nel proprio Ambiente di Sviluppo (Progetto in IDE Eclipse).
Il documento è indirizzato sia a Sistemisti (responsabili di installazioni di Applicazioni su base jAPS2 2.0 entando) che a Java Developers (con una conoscenza base del Framework jAPS 2.0 entando).
Per poter utilizzare efficacemente le informazioni contenute in questo documento, occorre un po' di esperienza su alcune tecnologie del web base: la piattaforma Java, gli strumenti di sviluppo Eclipse, il servlet engine Apache Tomcat, il database PostgreSQL, e del Framework jAPS2.
Ulteriori informazioni possono essere richieste attraverso la mailing list ufficiale Google Group "japs-platform".
Per mandare un messaggio ai membri della lista, invia una mail a <japs-platform@googlegroups.com>.
È inoltre possibile consultare la documentazione presente in:
Il Plugin jprss consente di erogare i contenuti del portale in formato RSS.
Tabella 2.1. Riassunto delle caratteristiche
| Codice | Nome | Tipo | Versione del Plugin | Versione di jAPS 2.0 entando |
|---|---|---|---|---|
| jprss | RSS | PurePlugin | 1.2 | 2.2.0 - |
| jprss | RSS | PurePlugin | 1.1 | 2.0.8 - 2.0.10 |
| jprss | RSS | PurePlugin | 1.0 | 2.0.6 |
Questo modulo richiede la presenza del seguente plugin:
jacms version 2.2.0
Dalla versione jAPS 2.0.8 jacms è fornito in bundle con jAPS2 stesso, non richiedendo alcuna installazione aggiuntiva da parte dell'utente finale.
Il modulo presenta:
Una interfaccia del Back-End tramite il quale l'amministratore può creare e gestire i canali di erogazione dei contenuti in formato RSS. Tale interfaccia aderisce perfettamente alla grafica ed impostazione del Back-End ed è accessibile attraverso una voce del menù Plugin.
Una showlet tramite la quale fornire dal Front-End l'elenco dei canali attivi, con il relativo link.
Sul Front-End i canali RSS vengono resi disponibili tramite link cosi configurati:
http://indirizzoSito:8080/mioportale/do/jprss/Rss/Feed/show.action?id=id del canale RSS
dove 'indirizzoSito' è l'ip del portale 'mioportale' e 'id' è l'ID del contenuto servito
Sommario
Il Plugin jprss consente di erogare i contenuti del portale in formato RSS.
Il plugin ha la caratteristica di PurePlugin, la sua installazione non modifica nessuna funzionalità presente nel sistema.
Il pacchetto del Plugin contiene l'insieme delle cartelle (cartelle doc ed src più il file Readme)
definite nel documento di descrizione generale del jAPSPlugin Pattern.
In particolare, la directory src è strutturata come di seguito descritto:
Directory
java. Contiene le sorgenti java complete e i test jUnit del Plugin.Directory
sql. Contiene gli script da eseguire nei dbporteservprincipali e di test.Directory
webapp. La directory contiene tutti i file necessari alla webapp. In particolare, la directory contiene i file (jsp) relativi alla interfacce utente ed i file di configurazione delle stesse, i file di definizione dei bean a servizio (sia del layer di Business del Modello di jAPS 2.0 entando, che nelle action di Struts 2 relative al Layer di Presentation), le librerie (compresa la libreria ricavata dalle sorgenti java date in dotazione), le risorse statiche necessarie (css, immagini, e js).
Per definizione, chiameremo l'applicazione sulla quale si deve installare il plugin con il nome di miawebapp.
Per eseguire l'installazione in una applicazione Web in produzione basata sulla versione di jAPS 2.0 entando dichiarata compatibile con il Plugin, i passi da eseguire sono i seguenti:
Interrompere l'esecuzione del servlet container
Copiare il contenuto della directory
src/webapp/WEB-INF/libdel pacchetto dato in dotazione, all'interno della directorymiawebapp/WEB-INF/lib/in produzione.Assicurarsi che la cartella
miawebapp/webapp/WEB-INF/pluginsesista, creandola se necessario. Copiare il contenuto della directorysrc/webapp/WEB-INF/pluginsdel pacchetto dato in dotazione, all'interno della directorymiawebapp/WEB-INF/plugins/in produzione.Copiare il contenuto della directory
src/webapp/resources/pluginsdel pacchetto dato in dotazione, all'interno della directorymiawebapp/resources/plugins/in produzione.Eseguire i task contenuti nel file
portScript.sql(contenuto nella directorysrc/sqldel pacchetto dato in dotazione) nel dbportin produzione. Lo script è strutturato ipotizzando il parametro version impostato aproduction(variare se il version dell'ambiente di produzione è diverso). Modificare la query inserendo le opportune modifiche per i seguenti valori:CONTENT_TYPE,ATTRIBUTE_NAMEeMAX_ITEMS.Lo script è strutturato ipotizzando il version
production(variare se il version dell'ambiente di produzione è diverso). Modificare la struttura del modello del profilo secondo le necessità.Eseguire i task contenuti nel file
servScript.sql(contenuto nella directorysrc/sqldel pacchetto dato in dotazione) nel dbservin produzione.
Per definizione, chiameremo il progetto sul quale si deve installare il plugin con il nome di mioprogetto.
Per eseguire l'installazione in un progetto Eclipse basato sulla versione di jAPS 2.0 entando dichiarata compatibile con il Plugin, i passi da eseguire sono i seguenti:
Copiare il contenuto della directory
src/webapp/WEB-INF/libdel pacchetto dato in dotazione, all'interno della directorymioprogetto/WebContent/WEB-INF/lib/, con l'esclusione del filejAPSPlugin-jprss-1.1.jar.Assicurarsi che la cartella
mioprogetto/WebContent/WEB-INF/plugins/esista, creandola se necessario. Copiare il contenuto della directorysrc/webapp/WEB-INF/pluginsdel pacchetto dato in dotazione, all'interno della directorymioprogetto/WebContent/WEB-INF/plugins/.Copiare il contenuto della directory
src/webapp/resources/pluginsdel pacchetto dato in dotazione, all'interno della directorymioprogetto/WebContent/resources/plugins/.Eseguire i task contenuti nel file
portScript.sql(contenuto nella directorysrc/sqldel pacchetto dato in dotazione) nel proprio dbport. Lo script è strutturato ipotizzando il parametro version impostato aproduction(variare se il version dell'ambiente di produzione è diverso). Modificare la query inserendo le opportune modifiche per i seguenti valori:CONTENT_TYPE,ATTRIBUTE_NAMEeMAX_ITEMS.Eseguire i task contenuti nel file
servScript.sql(contenuto nella directorysrc/sqldel pacchetto dato in dotazione) nel proprio dbserv.Eseguire i task contenuti nel file
portTestScript.sql(contenuto nella directorysrc/sqldel pacchetto dato in dotazione) nel proprio dbportdi test.Eseguire i task contenuti nel file
servTestScript.sql(contenuto nella directorysrc/sqldel pacchetto dato in dotazione) nel proprio dbservdi test.Copiare il contenuto della directory
src/java/main/comnella directorymioprogetto/src/comdel proprio progetto.Copiare il contenuto della directory
src/java/test/testnella directorymioprogetto/src/testdel proprio progetto.Copiare il file
src/java/main/jprss_japs-struts-plugin.xmlinmioprogetto/src/. Nel caso in cui nella directorysrcdel progetto Eclipse sia già presente un file di nomejaps-struts-plugin.xml, copiare il contenuto del tag <struts> del filejprss_japs-struts-plugin.xmlall'interno del filejaps-struts-plugin.xmlesistente e cancellare il filejprss_japs-struts-plugin.xml. Nel caso in cui nella directorysrcdel progetto Eclipse non sia presente un file di nomejaps-struts-plugin.xml, rinominare il filejprss_japs-struts-plugin.xmlinjaps-struts-plugin.xml.Eliminare o commentare (attraverso un commento java) il metodo
getSpringConfigFilePaths()della classeJpRssConfigTestUtils.javanel packagetest.com.agiletec.plugins.jprss.Eliminare o commentare (attraverso un commento java) il metodo
setInitParameters()della classeJpRssApsAdminBaseTestCase.javanel packagetest.com.agiletec.plugins.jprss.apsadmin.
Una volta eseguiti i passi sopra descritti, far partire il progetto da Eclipse e verificare la presenza della voce specifica di menù nell'area di amministrazione del progetto.
Sommario
Nota: le immagini sottostanti potrebbero differire da quelle attuali del backend, in ogni caso la logica di funzionamento è rimasta per lo più invariata rispetto alle versioni precedenti. Di seguito un breve paragravo che sottolinea l'unico cambiomento che semplifica il processo di installazione e di configurazione.
Il plugin RSS si avvantaggia di una delle nuove funzionalità di jAPS 2.0 entando, ovvero il ruolo attributo. A dimostrazione di ciò, l'item di configurazione "jprss_config" nella tabella "sysconfig" è stato rimosso.
Prima di configurare i canali RSS bisogna decidere quali tipo di contenuti devono essere pubblicati. Adesso che l'item di configurazione non esiste più è il ruolo a decidere quale attributo diverrà, ad esempio, il titolo del feed rss.
A tal fine bisogna editare il tipo di contenuto che si vuole pubblicare in formato rss: nella lista degli attributi editare un attributo di vostra scelta che diverrà, per esempio, il titolo. A questo punto nella select "Ruoli" bisogna scegliere uno dei ruoli inseriti nel sistema dal plugin:
jprss:title - attributo che contiene il titolo del feed
jprss:description - attributo che contiene la descrizione del feed.
Confermare premendo "Aggiungi", e quindi continuare la configurazione dell'attributo premento il bottone "salva" alla fine. Una volta assegnati ad due attributi del tipo di contenuto i due ruoli di cui sopra è possibile entrare nell'area di amimnistrazione del plugin.
Per accedere all'interfaccia di amministrazione seguire i seguenti passi:
Accedere all'area di amministrazione del portale
Plugin
RSS
Appare la finestra di benvenuto con due icone:
 |
Lista dei Canali RSS presenti nel portale
Cliccando sul link Nuovo Canale appare la seguente finestra:
 |
Scelta tipo contenuto che verrà usato per la creazione del canale RSS
Una volta selezionato il tipo di contenuto ci verrà chiesto di perfezionare la creazione del nuovo canale RSS inserendo i campi di cui in figura:
 |
Dati del nuovo canale RSS
Inserire le informazioni relative a :
Titolo del canale RSS
Descrizione del canale RSS
Canale RSS attivo o meno
Definizione del tipo di RSS
Definizione della Categoria del Canale RSS
Definizione degli eventuali Filtri (Vedere paragrafo successivo per la gestione dei filtri)
una volta confermati i dati il canale RSS è disponibile per essere inserito in front-end.
Definizione dei Filtri: Se fosse necessario gestire dei filtri per il canale RSS selezionare Aggiungi nel box filtri della figura precedente appare dunque la seguente finestra:
 |
Gestione Filtri per Canale RSS
I filtri sono configurabili a seconda dei Tipi di Attributo di Contenuto presenti nel Tipo di Contenuto che viene utilizzato per il canale RSS.
Risultato atteso se si applicano i due esempi precedenti ad un canale RSS
 |
Risultato configurazione Canale RSS
