Webstar Liferay Newsletter modul

Posted by | No Tags | Liferay-Newsletter | Nincs hozzászólás a(z) Webstar Liferay Newsletter modul bejegyzéshez

A hírlevél működése

A Webstar Newsletter alkalmazás 3 portletből és egy Action Hook-ból áll:

  • Subscription portlet (a weblapon megjelenő, feliratkozást lehetővé tevő elem)
  • Subscription action portlet (a levelekben levő leiratkozás linkek arra az oldalra dobnak, ahol ez a portlet található)
  • Adminisztrációs portlet (ControlPanelen keresztül elérhető, de publikus oldalra is kihelyezhető)


A portlet telepítésekor kialakításra kerül  nyelvenként 1-1 szerkeszthető, törölhető alap hírlevél kategória, illetve gombnyomásra létrehozható a Documents and Media file-tárba egy Webstar Newsletter mappa, benne szintén két nyelven egy megerősítő text/html típusú e-mail template, illetve egy tartalom html template.
A hírlevélre feliratkozni vendég, és belépett (regisztrált) felhasználó is tud, utóbbi a regisztrációkor megadott e-mail címével. Feliratkozni a subscription portletben lehet, ilyenkor a megadott e-mail címre egy megerősítő levelet küld a rendszer. Több kategóriába való feliratkozáskor is csak egy levelet küldünk ki, ilyenkor a linkre kattintva mindegyiket jóváhagyja a felhasználó.

Feliratkozás e-mail sablonja a Beállítások menüpont alatt választható, a telepítéskor a Documents and Media file-tárba létrehozott Webstar Newsletter mappábból.
Leiratkozni kategóriánként, az adott kategóriában küldött hírlevélben található linkre kattintva tud a felhasználó.
Megfelelő jogosultsággal rendelkező személy a Liferay ControlPanel – Webstar Newsletter menüpontján keresztül éri el az Adminisztrációs portletet. Itt van lehetősége a kategóriák meghatározására, hírlevél összeállítására, és a feliratkozottak menedzselésére.
Hírlevél csak az adott nyelven minimum egy létező Kategória esetén küldhető. Különböző nyelveken különböző, egymástól független kategóriák is létezhetnek. Amennyiben adot nyelven több kategória is elérhető, akkor a felhasználó egy többválasztós mezőből tudja kiválasztani, hogy melyikre iratkozik fel. Ezen jelentkezése kapcsán kiküldött megerősítő e-mail (alap séma esetén) tartalmazza a kategória címét, így a beérkező levelei közül egyértelműen meg tudja különböztetni, miket hagy jóvá.
A hírlevelek egy Liferay Általános Webtartalom-ból és egy text/html content template keretből állnak.
Egy alap template a Newsletter modul telepítésekor bekerül a Documents and Media file-tárba létrejött Webstar Newsletter mappába (Telepítést követően mindenképpen ellenőrizzük, hogy a Documents and Media-ban a Webstar Newsletter mappa jogosultság beállításánál a GUEST role megkapja az ACCES jogot!). Ez a template bármikor törölhető, szerkeszthető, és lecserélhető, és szokásos html elemeken túl  ### nyitó és záró elemek közötti wildcardokból épül fel.
Lehetőségünk van a hírlevelet összeállítás után bármilyen e-mail címre, bármennyi alkalommal tesztként kiküldeni. Egy elmentett hírlevelet csak egyszer tudunk publikálni, ám lehetőségünk van ugyanazt a webtartalmat korlátlan alkalommal egyesével összerakni hírlevéllé és kiküldeni. A kiküldendő illetve kiküldött hírlevelek megtekinthetők böngészőben is. Az utólagos visszakereshetőség megkönnyítése érdekében a hírleveleket tag-ekkel láthatjuk el.
A Felhasználók menüpontban van lehetőségünk áttekinteni az eddig feliratkozottak listáját. Nevük mellett megtaláljuk, hogy összesen hány kategóriára iratkoztak föl, és itt láthatjuk, hogy csak regisztrált felhasználói-e az adott témakörnek, vagy már aktiválták magukat a megerősítő e-mailen keresztül. Az aktiválást kategóriánként kell megtenniük, de az Adminisztrátor a felületen manuálisan is módosíthatja a feliratkozások státuszát. Ezt a felhasználónak már nem kell megerősítenie.

A porletek előkészítése

Feliratkozáshoz

A hírlevél modulra történő feliratkozás portletet az Admin sáv +Új / Több- menüpontból nyíló  WEBSTAR.NEWSLETTER -szakaszon belüli WebstarNewsletterSubscription néven találjuk.

01

Amennyiben a felhasználó már regisztrálva van az adott oldalra, akkor belépést követően a Hírlevél modul előre kitölti az e-mail cím részt, ami ezek után nem szerkeszthető. Ahoz, hogy más e-mailre kérje a hírleveleket, ki kell lépnie, és így az üres mezőbe tudja megadni a kívánt címet.
Külső felhasználóknak a hírlevél funkció csak feliratkozás után érhető el. A feliratkozás folyamata jelentkezésből, illetve ezen jelentkezés kapcsán kiküldött megerősítő e-mailen keresztüli visszaigazolásból áll. Ha egy korábban feliratkozott e-mail címmel valaki regisztrál az oldalra, a feliratkozottból regisztrált feliratkozott lesz és a rendszer automatikusan szinkronizálja az új felhasználóhoz a korábbi feliratkozásokat (ha a beállítások menüben ezt kiválasztottuk). A megerősítő e-mail a modulhoz adott, Documents and Media file-tárba létrejött Webstar Newsletter mappában található, szerkeszthető html template-ből áll.

Leiratkozáshoz

A leiratkozás lehetőségét a kiküldött hírleveleink ###portalUrl###/###cancelattionLink### template mezője tartalmazza. Működéséhez azonban a ControlPanel / Site Pages részében létre kell hoznunk egy új oldalt az Oldal Hozzáadása gombbal a Nyilvános oldalak alá. Az új oldal elnevezése legyen subscription, az egyszerű URL legyen /subscription és az egészet tegyük rejtetté.

02
Amint ez elkészült, a webfelületünkön a cím sorba illesszük be a /subscription urlt, és töltsük be az oldalt (pl: http://yourdomain.com/subscription).  A megjelenő üres oldalon kattintsunk az Admin vezérlő sávon a +ÚJ gombra. Itt válasszuk ki a menü alján a “Több…” opciót, kattintsunk a Webstar-Newsletter sor melletti kis + ikonra, és a megjelenő lehetőségek közül húzzuk az oldalra a WebstarNewsletter Subscription-Action elemet.
A fentiek hatására, ha a felhasználó bármelyik template-ben található leiratkozás linkre kattint, az meg fogja hívni a /subscription oldalt, és  megtörténik a leiratkozás. Ha a felhasználó az összes kategóriáról leiratkozott, akkor az e-mail címét is (subscription) töröljük a rendszerből. Ez csak a hírlevél szekciót érinti, regisztrált felhasználó esetén az oldal regisztrációja ettől még nem szűnik meg.

Webstar Newsletter menüpontok

A hírlevél admininsztrációja megfelelő jogosultság esetén a ControlPanel sáv WebstarNewsletter menüponton keresztül érhető el. A felület 4 fülből áll.
Kategóriák
Hírlevelek
Felhasználók
Beállítások

Kategóriák

A hírlevelek címzettjeit közvetlenül nem absztrakt címzett csoportként határozzuk meg, hanem hírlevél kategóriákat hozunk létre, a felhasználók pedig ezen kategóriákra iratkozhatnak fel. Új hírlevél kiküldése előtt így elegendő a hírlevél kategóriáját (akár többet is) kiválasztanunk, akik azokra a kategórákra feliratkoztak, meg fogják kapni a levelet.
A hírlevél kategóriák használatával tudjuk a publikálandó hírleveleinket célzottabban küldeni. Létrehozhatunk pl általános hírlevelek, szakmai hírlevelek, vagy akár témakörönként is kategóriákat, így az olvasóink dönthetik el, miről szeretnének friss híreket olvasni, és mi az, ami kevésbbé érdekli őket.
A hírlevél modul képes több nyelvet megkülönböztetni, de lehetőségünk van kategóriát csak egy adott nyelven létrehozni. Ennek következtében pedig a Weboldalunk bizonyos kategóriáknál csak az adott nyelvű látogatóknak teszi elérhetővé a feliratkozást.
Az admin menü első füle mutatja meg a kategória táblát. Ez a tábla szűrhető és rendezhető, és innen van lehetőségünk kategóriát létrehozni (Új kategória gombra kattintva) vagy törölni akár csoportosan is.

03
Új kategória létrehozásánál meg kell adnunk a kategória nevét, és hogy milyen nyelvű felhasználóknak szánjuk. Az így létrehozott kategóriák jelennek majd meg a Weboldalon elhelyezett hírlevelek portletben. Ha egy adott nyelven csak egyetlen kategóriát hoztunk létre, akkor a feliratkozásnál csak e-mail cím mező és egy OK gomb szerepel,

04
egynél nél több kategória esetén multiple select-el tud a felhasználó feliratkozni:

05
Ha adott nyelven nincs egy kategóra sem, akkor a “Nincsen hírlevél kategória ezen a nyelven!” üzenetet mutatja az oldal.
A gyűjtő tábla sorainak végén található Műveletek gombra nyomva tudjuk Szerkeszteni az adott kategória nevét, és nyelvét. A Felhasználók almenüpontra kattintva egy szűrhető táblában láthatjuk, hogy az adott kategóriára hány felhasználó iratkozott fel (illetve, hogy közülük hányan vannak még függőben, és hányan erősítették már meg a feliratkozást).
Ha egy adott felhasználó arra panaszkodik, hogy nem kap egy adott kategóriáról szóló hírlevelet, itt
van lehetőségünk ellenőrizni, hogy feliratkozott-e és ha igen, meg is erősítette a feliratkozási szándékát, vagy sem.

07

Hírlevelek

Az adminisztrációs rész Hírlevelek fülére kattintva a hírlevelek gyűjtő-listázó tábláját találjuk.

08

A tábla fejlécével bármely oszlop kereshető, szűrhető és rendezhető.
Elemei:
Tárgy/ Címkék -ezen fejlécek tartalmáról a hírlevelek összeállításánál említjük meg
Kiküldés ideje – mikor került kiküldésre az adott tárgyú hírlevél
Címzettek -popup táblázatban láthatjuk a kiküldött hírlevelünk címzetteit (kereshető formában)
Tatralom – meg tudjuk tekinteni a már kiküldött hírlevelünket, template-be ágyazva
Szerkesztés – Már kiküldött hírlevél esetén rákattintva láthatjuk a hírlevél összetételét (kategóriák, feladó, tárgy, logok). Amennyiben egy hírlevelet elkezdtünk összerakni, és elmentettük, de még nem küldtük ki, akkor a Szerkesztés re kattintva folytathatjuk a hírlevelünk összeállítását.
Egy hírlevél publikálása két elkülönült lépésből áll.
Először létre kell hoznunk egy Alapvető Webtartalmat, az ControlPanel sáv Webtartalom menüpontján keresztül.  A webtartalmat elkészítjük és publikáljuk.
Második lépésben visszatérünk az Admin menüsáv Webstar Newsletter menüponthoz, és itt a Hírlevelek fület választjuk, azon belül pedig az Új hírlevél -gombra kattintunk.
Az így megjelenő szerkesztő ablak elemei:

09
Tárgy: ez kerül a kiküldött hírlevél e-mail tárgy mezőjébe
Hírlevél tartalom: itt tudjuk a már létező Webtartalmak közül kiválasztani, hogy mi kerüljön a hírlevél template tartalom részébe. A felugró ablakból a webtartalmak címei alapján tudunk választani, ezért praktikus, ha korábban, a Webtartalom létrehozásánál utalunk a címében arra, hogy Hírlevélről van szó.
Fontos, hogy ez a cím (template tartalomtól függően) megjelenhet a kiküldött e-mailben is.
Feladó e-mail címe: a kiküldött e-mail feladójához ezen cím jelenik meg (érdemes noreply címet, vagy olyan, létező mail címet meghatároznunk, amire az esetlegesen visszaérkező észrevételeket tudjuk fogadni)
Hírlevél séma: itt van lehetőségünk kiválasztani hogy az imént megjelölt tartalom melyik hírlevél template-be ágyazva kerüljön kiküldésre. A tallózó a Document and Media-ba feltöltött text/html mimetype-al rendelkező fileokat listázza.
Kategória nyelve: ez a lenyitható menü határozza meg, hogy az alatta lévő Kategóriák listába mely nyelven létrehozott elemeit lássuk
Kategóriák: amennyiben egy adott nyelven több kategóriát hoztunk létre, itt tudjuk meghatározni, hogy a most összeállítandó levelünk mely kategóriára feliratkozottak számára kerüljön kiküldésre.
A bal oldalon láthatóak az adott nyelven elérhető kategóriák, és a két box között lévő nyilakkal irányíthatjuk kiválasztásukat. Lehetőségünk van az összes kategóriát egy gombnyomással áthelyezni.
Címkék: minél több hírlevelt hozunk létre, és küldünk ki, annál nehezebb dolgunk van, ha később vissza szeretnénk keresi egy publikációnkat. A Liferay címkekezelőjében korábban létrehozott címkék közül van lehetőségünk itt választani, vagy a + Új gombra kattintva újat létrehozni. A meghatározott címkék a Hírlevelek fül hírlevél összesítő táblájában fognak megjelenni.
Mentés: mentés nélkül nem tudunk tovább lépni. Egy már elmentett, de nem kiküldött hírlevelünkhöz bármikor visszatérhetünk, és kiküldhetjük azt.
Piszkozat megtekintése: kiküldés előtt webes felületen megtekinthetjük a template-be csomagolt tartalmunkat
Vissza: visszajuttat a Hírlevelek táblához. Figyelem, bármely eddigi beállításunk elveszik!

Felhasználók

Ezen táblázatban látjuk a a hírlevélre feliratkozottak listáját, és tudunk keresni, és szűrni e-mail cím / név alapján, illetve láthatjuk, hogy adott személy hány kategóriára iratkozott fel.

10
A sorok végén található Szerkesztés gomb megnyomásával jutunk a felületre, ahol láthatjuk a felhasználó nevét/e-mail címét, valamint lehetőségünk van őt manuálisan kategóriához felíratni, vagy leiratni.

11
A feliratkozott táblában zöld pötty mutatja a már megerősített feliratkozásokat. Amennyiben nem látunk zöld ikont a kategória mellett, ez azt jelenti, hogy a felhasználó ugyan feliratkozott, de még nem aktiválta a feliratkozását. A manuális feliratkozást már nem kell külön megerősítenie a felhasználónak.

Beállítások

Frissen telepített modul esetén egy Általános összetevők telepítése gombot is láthatunk. Erre kattintva a modul létrehoz a Documents and Medián belül egy Webstar Newsletter könyvtárat és abba nyelvenként 1-1 confirm.html sablont és 1-1 hírlevél html sablont.

12

Feliratkozás e-mail sablon gombra kattintva tudjuk kiválasztani, hogy a feliratkozóknak milyen megerősítő e-mail sémát küldjön ki a rendszer. A tallózó a Document and Media-ba feltöltött text/html mimetype-al rendelkező fileokat listázza.
User szinkronizálás használata jelölő négyzet használatával pedig megoldható, hogy ha valaki feliratkozott a hírlevélre, majd később regisztrál a weblapra, akkor nem történik duplikáció, hanem a hírlevél feliratkozása megkapja a regisztrálás utáni user ID-ket, így belépését követően aktívan kijelzi az oldal a felitratkozásait is.

Template-ek elemei

A hírlevél modulhoz nyelvenként 2db .html file-ot csatoltunk, melyek az alapvető template elemeket tartalmazzák:
– Confirm_Email.html és
newsletterTemplate.html
Az első a hírlevélre feliratkozói igényt megerősítésének elemeit, míg a második magát a hírlevél keretet és annak elemeit tartalmazza. Ezen file-ok szabadon módosíthatóak, illetve több különböző példányt is létrehozhatunk, mivel később lehetőségünk lesz ezek közül választani.
A fenti két template file (és a többi verziójuk) helye a “Documents and Media” egyik könyvtárába kell, hogy kerüljenek.

E-mail megerősítő template

###categoryName### – Hírlevél kategória elnevezése
###confirmEmail### – Megerősítő link, melyre kattintva véglegesítheti a feliratkozást a felhasználó

Hírlevél template

###newsletterTitle### – Hírlevél Webtartalmának címe
###sendDate### – kiküldés dátuma
###newsletterCategory### – hírlevél kategóriája
###CONTENT### – a teljes, formázott Webtartalom
###portalUrl###/###cancelattionLink### -leiratkozás linkje

Class-ok

Az alábbi osztályokat használhatjuk a kijelző portlet személyre szabásánál:

.subscriptionFormContainer{
}//beviteli mezők formja

.multiWebstarSelect{
}// a többkiválasztásos legördülő menü

.newsletter-button{
}//Ok vagy submit gomb

.newsletter-text{
}// e-mail cím beviteli mező

Legfrissebb verzió letölthető itt: WcsNewsletter-portlet-1.0.0.2

FONTOS MEGJEGYZÉS

Az 1.0.0.2-es verziótól fontos, működésbeli változások történtek, melynek következtében az alábbiakat kell figyelembe venni.
Korábbi verzióval ellentétben a ‘Newsletter Subcription -Action’ portletet már bármely oldalra kitehetjük, azonban figyelnünk kell rá, hogy ezt követően a Webstar Newsletter Admin / Beállítások-füle alatt található Action Layout lenyithatóból kiválasszuk ezt az adott oldalt!
Ez a lenyitható menü határozza meg, hogy a feliratkozáskor kiküldött e-mailben található megerősítő url link a megfelelő oldalra mutasson.

ddhu

Ha ezt elmulasztjuk, vagy beállítása előtt valaki már megpróbált feliratkozni, akkor nem lesz lehetősége megerősíteni a feliratkozását, azt csak az admin tudja megoldani úgy, hogy az adott usert eltávolítja a kategóriából, majd mauálisan visszateszi.


No Comments

Leave a comment