Introduktion till projektet Gothia Forum Actors

Nedan f�ljer en beskrivning av projektet Gothia Actor som har utf�rts av VGR IT �t Gothia Forum.

Projektet Gothia Forum Actors �r det projekt som utvecklat mjukvaran bakom siten http://www.gothiaforum.com.

Systemet �r byggt enligt �ppna Programs Referensarkitekturens, f�r mer om den se Introduktion till Referensarkitektur

Inneh�ll

• Introduktion till projektet Gothia Forum Actors
• Inneh�ll
• Detta �r Gothia Forum
• Vad �r en akt�r?
• Portlettar
• Actors Search
• Actors Search thin client
• Actors Search Result
• Actors Form
• Skapa ny presentation
• Show Similar Actors
• Settings
• Arkitektur av Gothia Actors
• S�ktj�nsten och Workflow
• Solr
• Kaleo
• En akt�rs uppbyggnad
• Artiklar, strukturer och mallar i Liferay
• Instruktioner f�r att s�tta upp Gothia Actros
• S�tta upp Liferay med Tomcat
• Bygga Gothia Actors
• Produktionss�tta Portlets
• �vrigt

Detta �r Gothia Forum

Gothia Forum har kommit till f�r att underl�tta och driva det kliniska forskningssamarbetet mellan sjukv�rd, akademi och forskningsf�retag i V�stra G�taland. Vi vill i och med denna tj�nst bygga upp en virtuell m�tesplats och resurs f�r alla som arbetar med klinisk forskning.

Gothia Forum �r en m�tesplats och en frivillig resurs f�r alla som arbetar med klinisk forskning i regionen. Forskare inom V�stra G�talandsregionen samt svenska och utl�ndska forskningsf�retag kan v�nda sig till oss. Ett centralt begrepp i Gothia Forum �r akt�rer. Se f�rklaring nedan ang�ende vad som menas med en akt�r.

Vi ger service inom fyra omr�den:

• Information

En viktig del av Gothia Forums verksamhet �r att samla och sprida information om p�g�ende klinisk forskning inom VGR. Vi vill ocks� sprida kunskap om utbudet av resurser f�r den kliniska forskningen som finns inom regionen och inom v�ra samarbetsorganisationer och f�retag.

• Kvalitetsst�d

Gothia Forum vill verka f�r god kvalitet inom en kliniska forskningen och d�rf�r arbetar vi f�r att samordna resurser f�r kvalitetskontroll. Dessutom erbjuder Gothia Forum i samarbete med l�kemedelsindustrin utbildningar inom GCP och deltar i utvecklingen av nya utbildningar.

• Projektst�d

Genom Gothia Forum kan du f� kontakter som kan hj�lpa till med formaliteterna kring din forskning. Det kan handla om att uppr�tta forskningskontrakt och ans�kningar av olika slag. Vi kan ocks� erbjuda hj�lp att hitta pr�vare inom olika discipliner och patienter via olika databaser inom VGR.

• Strategisk utveckling

Den kliniska forskningen i V�stra G�talandsregionen �r beroende av att det sker en kontinuerlig utveckling av de resurser som beh�vs f�r forskningen. F�r att Sverige och VGR skall kunna h�lla en fortsatt internationell h�g standard �r den utvecklingen sker i samarbete med alla inblandade akt�rer. Gothia Forum har m�jlighet att identifiera, besluta och genomf�ra strategiska utvecklingsinsatser.

Vad �r en akt�r?

En akt�r �r organisation eller ett f�retag som vill synas p� Gothia Forums n�tverk av akt�rer. En akt�r kan skapa en profil p� Gothia Forums webbportal d�r de kan beskriva sina tj�nster och sin verksamhet. Med hj�lp av s�ktj�nsten som �r kopplat till presentationerna i n�tverket skall det bli enklare att hitta olika akt�rer som �r verksamma inom klinisk forskning/pr�vning. Bes�kare skall f� en �verblick �ver vilka resurser som finns tillg�ngliga och snabbt hitta kontaktuppgifter till en akt�r.

Portlettar

Gothia Actors best�r totalt av sex portletar. S�ktj�nst f�r Gothia Forum som best�r av tre portletar. Ut�ver de finns en f�r att skapa upp akt�rer, en f�r att ge en rikare upplevelse av akt�rs presentationen och en i kontrollpanelen f�r att konfigurera vilka artiklar (texter) som skall visas i portletarna och i temat.

Actors Search

Denna portlet kalas f�r Actors Search. Denna portlet har funktionen autocomplete p� de taggar som finns p� akt�rs presentationerna. Den visar upp tr�ffra av s�kningen som ett litet "kort" av presentationen. Detta kort �r en artikel i Liferay med en speciell mall, mer om detta senare.

Actors Search thin client

Det finns en portlet som ligger p� f�rstasidan den har ingen egen funktionalitet f�rutom att att autocompleta p� taggar och skickar vidare s�kningen till Actors Search portleten. Denna portlet kallas f�r Actors Search thin client.

Actors Search Result

Den sista portleten va s�ktj�nsten �r Actors Search Result det den g�r �r att den visar presentationen av en akt�r. Den visar upp presentationen som �r en artikel i Liferay med en speciell mall mer om detta senare. P� presentationen visas de taggar som �r satt p� akt�ren dessa g�r att klicka p�. D� g�rs en ny s�kning p� denna tagg och tr�ffaran av s�kningen presenteras. Det finns �ven kontakt uppgifter till den person som �r ansvarig f�r akt�ren p� presentationen.

Actors Form

Ut�ver sj�lva s�k-tj�nsten finns det �ven en portlet f�r att mata in akt�rer i ett formul�r. Denna portlet �r den st�rsta och mest komplicerade av de sex. Den visas bara n�r man �r inloggad som en anv�ndare p� en g�md sida som heter V�r Sida med URL:en var-sida. Om man g�r till url f�r v�r sida och inte �r inloggad skall den vara konfigurerad s� att den inte visas. Om anv�ndaren inte har skapat n�gon presentation uppmanas den till att antingen skapa en eller att ansluta till en befintlig akt�r.

Skapa ny presentation

Om en anv�ndare v�ljer att skapa en presentation s� kommer denne till ett formul�r d�r den f�r fylla i dess uppgifter. Formul�ret har validering som kontrollerar att de obligatoriska f�lt �r ifyllda och att telefonnummer �r giltiga osv. Det finns en Liferay komponent kallad liferay-ui:asset-tags-selector. D�r g�r det skapa nya helt egna taggar. Den autocompletear p� de taggar som redan finns i portalen och det g�r �ven v�lja bland de som finns in en lista.

N�r anv�ndaren har klickat vidare s� kommer denne till n�sta steg. Att ladda upp en logotyp till presentationen. Efter det s� visas en f�rhandsgranskning av presentationen. Det g�r att redigera den igen om det �r n�got om skall �ndras. Eller s� g�r det att skicka iv�g den f�r godk�nnande. N�r den skickas iv�g s� startar ett workflow. Detta inneb�r att den eller de som �r administrat�rer p� Gothia Forum f�r ett mail om att ett nytt workflow-�rende har kommit. D� kan administrat�ren g� in och granska presentationen som �r en artikel. Om administrat�ren tycker inneh�llet ser okej ut kan han godk�nna den. Annars kan han avsl� artikeln. Han har �ven m�jlighet att redigera artikeln och sen godk�nna den. N�r en artikel har blivit godk�nd s� g�r det att hitta och se den i s�ktj�nsten. I dagsl�get skickas inget e-post meddelande till �garen av akt�rspresentationen. F�r workflowet anv�nder vi kaleo-web som �r Liferays egna workflow engine. F�r att detta skal fungera m�ste ett wolkflow som heter Singel Approver sl�s p� f�r artiklar i Liferay detta g�rs i kontrollpanelen.

Show Similar Actors

Det finns en portlet f�r att visa liknande akt�rer. Denna portlet skall finnas p� samma sida som Actors Search Result portleten. Det den g�r �r att den visar akt�rer som har en likhet med den akt�r som f�r tillf�llet visas i Actors Search Result portleten. Detta g�r den genom att Actors Search Result portleten skickar taggarna f�r akt�ren men public render parameters. Som l�ses in av Show Similar Actors som g�r en s�kning mot Solr och f�r d�r igenom en akt�rer att visa.

Settings

Denna portlets funktion �r att konfigurera vilka artiklar som ska visas p� olika vyer i portletarna i Gothia Actors projektet. �ven i temat finns det artiklar som g�r att konfigurera p� detta s�tt. Anledning till att det �r byggt s� h�r �r att det ska g� att byta de texter som visas p� ett enkelt s�tt. Genom att byta ID:t till ett annat s� kan texterna enkelt �ndras. Den anv�nder n�got som kallas f�r expando f�lt i Liferay. Expando f�lten �r satta p� gruppen f�r gothiaforum.com. Sen plockas ID:t till artikeln upp genom dessa expando f�lt p� de st�llen d�r artikeln ska visa. Det finns tre s�dana konfigurerbara artiklar i Actors Search en som alltid visas en som bara visas n�r ingen s�kning �r gjord och en n�r s�kningen inte ger n�gra tr�ffar.

Arkitektur av Gothia Actors

S�ktj�nsten och Workflow

Solr

Solr-web �r en integration mellan Solr och Liferay. Gothia Actors anv�nder Solr-web genom Liferay. F�r att g�ra s�kfr�gor mot Solr (f�r mer om Solr se http://lucene.apache.org/solr/ ). F�r att anv�nda solr i Liferay beh�vs war filen f�r Solr-web deployas in och ange adressen till Solr server. D� ers�tts standard s�kmotorn i Liferay mot Solr. F�r att g�ra s�kningar mot solr �r det bara att anv�nda Liferays vanliga api f�r s�kningar. Solr-web ser �ven till att all data som skall vara s�kbar indexeras i Solrs index. War filen f�r Solr-web finns p� Liferays kundzon att h�mta. Detta kan bara de som �r registrerade kunder hos Liferay g�ra.

Kaleo

Kaleo �r Liferays egna workflow engine. Som ocks� denna g�r att finna p� Liferays kundzon som en .war fil. I detta projekt anv�nds den f�r att f� workflow hantering p� artiklar. S� att n�r en artikel har skapats s� g�r den inte direkt att publicera. Den m�ste f�rst godk�nnas genom en arbetsfl�de av en administrat�r. F�rst n�r den har blivit godk�nd s� blir den synlig f�r bes�karna genom s�ktj�nsten.

En akt�rs uppbyggnad

En akt�r best�r av flera av Liferays standard entiteter. En akt�r har en organisation d�r anv�ndaren �r medlem av organisationen. Organisationen kan ha flera medlemmar om det �r fler anv�ndare som har anslutit sig till akt�ren.

Artiklar, strukturer och mallar i Liferay

Efter som att en presentation av en akt�r �r en artikel i Liferay kan den visas p� m�nga olika s�tt p� olika platser i portalen beroende p� vilken mall vi v�ljer att visa den med. Som n�r vi visar s�ktr�ffarna (dom sm� r�da korten) s� anv�nds en mall GF_ACTOR_LIST och n�r vi visar presentationen s� anv�nds en annan mall GF_ACTOR_TEMPLATE. Det finns �ven en mall som heter GF_MORE_LIKE_THIS och den anv�nds n�r liknande akt�rer visas. Strukturer i Liferay �r de f�lt som finns i en artikel. Artiklar och mallar �r kopplade till strukturer. F�r att alla artiklar som anv�nds f�r att presentera en akt�r anv�nds struktur GF_SERVICE.

Instruktioner f�r att s�tta upp Gothia Actros

S�tta upp Liferay med Tomcat

F�r att s�tta upp Liferay f�lj l�nken nedan.

Bygga Gothia Actors

F�r att bygga gothia s� anv�nds maven f�r mer om detta se

Produktionss�tta Portlets

Hela Gothia Forum projektet best�r totalt av 9 stycken war filer inklusive denna f�r Gothia Actors.

• Gothia Actors
• Gothia Theme (CSS markup)
• Solr
• Kaleo
• Custom Velocity Rools RSS Hook
• Googel Maps Portlet
• Gothia Layouts
• Hotell Liferay Hooks
• Web Form Portlet

�vrigt

Kan vara bra att k�nna till https://github.com/Vastra-Gotalandsregionen/oppna-program/wiki/regler_och_riktlinjer