Components | Turró.Org

L'API de convocatòries permet crear convocatòries basades en els participants en entitats de qualsevol mòdul BrightSide.

Com funciona?

Les convocatòries es composen dels següents camps:

Descripció	Nom de la convocatòria. Surt en el calendari i com a subjecte dels correus.
Organitzador	Contacte que convoca. Si el correu es correspon al domini del BaaS, serà l'utilitzat quan s'envií la convocatòria. En cas de no correspondre, s'usaria el correu per defecte.
Data inici i data final	Les dates de l'esdeveniment.
Lloc	Lloc de l'esdeveniment.
En línia	Indica que l'esdeveniment es fa en línia.
URL	L'adreça per poder accedir a l'esdeveniment. Aquesta adreça només es fa pública a les persones convocades, via email, consultant l'àrea d'usuaris o la pàgina web de l'esdeveniment.
Entitat	Entitat BrightSide d'on s'agafen els assistents. La convocatòria pot afegir de l'entitat o fer un afegit profund, usant altres entitats relacionades. Per ex. Dossier i Categoria.
Text	Text explicatiu de l'esdeveniment.
Assistents	Contactes assistents a la convocatòria. Poden afegir-se de l'entitat o directament.

Els camps de la convocatòria estan pensats per ser compatibles amb els que formen l'especificació iCal, exceptuant el text, que admet format en HTML (el wiki es transforma en HTML estàndard). Per tal que el text s'inclogui dins iCal, es genera una versió en text pla, sense imatges ni format.

Organitzador, assistents i calendari

Les convocatòries queden registrades en els calendaris BrightSide de l'organitzador i els assistents. Aquests calendaris es poden importar a diferents plataformes de calendari i dispositius.

Apart del calendari BrightSide, les convocatòries poden enviar-se per correu. Quan es segueix aquest mètode, els correus són de organitzador a assistent, un a un i privat. Dins cada correu s'inclou l'esdeveniment en format iCal. Com el comportament varia segons les plataformes, cal tenir en compte:

L'organitzador no podrà confirmar-se ell mateix, per tant, no tindrà cap entrada en el calendari.
Els assistents si que rebran la convocatòria i podran acceptar-la.

Les convocatòries poden usar-se com a control de registre i assistència per a trobades, cursos o qualsevol altre esdeveniment.

El codi QR no es genera en el cas d'esdeveniments en línia.

Control d'assistència

Els correus enviats als contactes convocats inclouen un codi QR amb un text indicant que servirà per a validar l'assistència.

Guardi aquest codi QR

Aquest codi s'utilitzarà per a validar la seva assistència.

En el registre d'assistents previ a l'acte els contactes registrats i en possessió del codi QR podran ser validats fent una lectura del codi. La lectura de codi la podrà fer un usuari registrat i pertanyent al grup social Auxiliars d'esdeveniments.

Els contactes amb l'assistència validada es veuran dins la fitxa de la convocatòria amb una marca d'assistència.

Sistema d'auto-registre a la convocatòria

Una convocatòria pot admetre que els contactes puguin registrar-se (afegir-se a la convocatòria). Quan s'habiliti el registre a la convocatòria, caldrà tenir en compte:

Els contactes que es registrin rebran immediatament un correu amb el codi QR. Aquest QR serà vàlid fins la data de la convocatòria.
Per controlar quins usuaris poden registrar-se, s'hauran de poder diferenciar per algun dels rols adquirits del seu grup social dins el BaaS. Habitualment el rol concret es defineix dins xproles-site.xml.

En cas de canvi de dates, s'hauran de tenir en compte els dies de validesa del codi QR. Si es passa a una data posterior, els codis no seran vàlids en el moment de validar l'assistència. Després d'un canvi, si s'envia un correu a tots els convocats, el nou codi QR serà bo.

Creant el context de registre

Ens posarem en mode administració web i crearem un context restringit pel rol escollit.

El rol tindrà la forma [entitat]:[permís] quan s'escullin usuaris determinats.
El rol tindrà la forma user:in per admetre qualsevol contacte registrat al BaaS.

La restricció de rol no pot estar en cap cas buida, per evitar que visitants no registrats puguin iniciar una acció de registre fallida, sense contacte valid.

Un cop creat el context, l'editarem afegint la macro {@entity-ctrl:convocation-ctrl:/convocation/[id_convocatòria]}, sent [id_convocatòria] igual al id de la pestanya convocatòria dins el BaaS.

Visualització de la convocatòria dins el context

Un cop gravat el context, es mostrarà la convocatòria seleccionada. El format serà:

Títol de la convocatòria.
Etiquetes amb data inici, data final, localització i entitat relacionada.
Text de la convocatòria, amb les macros de correu traduïdes al context web.
Control d'assistència segons els següents casos:

Si la convocatòria està esgotada, no es mostra res més.
Si la convocatòria és vàlida i l'usuari no està registrat, es mostra un botó de registre.
Si la convocatòria és vàlida i l'usuari està registrat, es mostra el codi QR pel control d'assistència.

La intenció de l'editor wiki és facilitar l'entrada de la Wiki syntax per a pàgines, publicacions i d'altres elements editables.

L'editor és necessari és per la pujada d'imatges i la selecció del repositori correcte. També per la pujada de documents. pel que fa a la resta de les opcions de l'editor, són més de recordatori que realment funcionals. En la majoria dels casos preferirà introduir manualment les seqüencies wiki que cercar les opcions de l'editor.

Flux d'entrada de text

La sintaxi wiki gestiona correctament l'entrada de text normal, creant paràgrafs quan es deixen espais en blanc, o salts simples de línia.

Aplicant estils o agrupant sobre text escrit

Si es selecciona text dins l'editor i s'aplica alguna de les opcions de menú sobre el text, només el text seleccionat es veu afectat. Per exemple, si volem tornar un text a negreta, seleccionant-lo i prement el botó de negreta, l'editor afegirà ** al principi i final de la selecció (negreta en sintaxi wiki).

Seleccionant un text i prement Crear grup d'estils, el grup envoltarà el text seleccionat entre [block][/block].

Botons de la barra de menú

En ordre d'esquerra a dreta:

Botó	Funcionalitat
Capçalera 1	Torna el paràgraf on es troba el cursor a l'estil capçalera 1.
Capçalera 2	Torna el paràgraf on es troba el cursor a l'estil capçalera 1.
Capçalera 3	Torna el paràgraf on es troba el cursor a l'estil capçalera 1.
Capçalera 4	Torna el paràgraf on es troba el cursor a l'estil capçalera 1.
Negreta	Torna el text seleccionat a negreta.
Cursiva	Torna el text seleccionat a cursiva.
Mono-espaiada	Torna el text seleccionat a mono-espaiada.
Alineació esquerra	Alinea el bloc d'estils a l'esquerra.
Alineació centre	Centra el contingut del bloc d'estils.
Alineació dreta	Alinea el bloc d'estils a la dreta.
Text justificat	Justifica el contingut del bloc d'estils.
Flotant esquerra	El bloc d'estils flota a l'esquerra.
Flotant dreta	El bloc d'estils flota a la dreta.
Element de llista	Torna el paràgraf on es troba el cursor en un element d'una llista.
Element de llista ordenada	Torna el paràgraf on es troba el cursor en un element d'una llista ordenada.
Color	Defineix el color de la font i/o del fons del grup d'estils on es troba el cursor.
Taula	Crea elements de taula, com columnes i files diferenciant si són de capçalera.
Agrupacions	Defineix varis elements que funcionen com a grups d'estils. Crear grup d'estils. Crea un grup d'estils [block] amb la selecció. Crear estils en línia. Crea un grup d'estils [span] amb la selecció. Crear nota. Crea un grup d'estils [note] amb la selecció. Afegir columna. Crea una nova columna. Les columnes són grups d'estils que es veuran en columna si l'espai visual ho permet, o apilats si no. Acabar columnes. Si s'han creat columnes i es vol continuar amb tot l'ample visual, aquest element n'indica el tancament. Crear tabulador. Crea el patró pels tabuladors. Crear auto-amagar. Crea el patró per les llistes auto-amagades. Wiki syntax. Inicia o acaba la sintaxi wiki. Java syntax. Inicia o acaba la sintaxi Java. XML syntax. Inicia o acaba la sintaxi XML.
Esborrar estils	Esborra els atributs associats al grup d'estils on es troba el cursor.
Imatge	Permet pujar una imatge al repositori adequat i seleccionar-la.
Enllaç	Permet crear un enllaç, incloent enllaços a arxius. El selector d'arxius permet també pujar-ne.
Protecció	Crea elements wiki a partir d'elements HTML, intentant respectar els atributs.
Vista prèvia	Mostra una vista prèvia de l'HTML generat.
Ajuda	Porta a l'ajuda contextual de l'editor wiki.

L’API d’enquestes permet crear grups de preguntes relacionades amb entitats BrightSide.

La primera versió és plenament funcional per a BS Publicacions i BS Dossiers.

Com defineix l'API una enquesta?

Una enquesta és un grup de preguntes relacionades amb una entitat BrightSide. Com atributs, l'enquesta té títol, una descripció, una data límit per respondre, la possibilitat d'adjuntar documentació usant el mòdul d'adjunts i atributs de comportament que veurem més endavant amb més detall.

Al mostrar-se, l'enquesta deixa al participant navegar entre l'entitat relacionada i la pròpia enquesta, tal i com es mostra en els següents exemples.

Enquesta a l'àrea d'usuari

Enquesta en l'entitat relacionada

Els atributs que modifiquen com es mostra l'enquesta

Attribut	Explicació
Permetre negatius	Quan es permeten negatius, els valors que es guarden per a cadascuna de les opcions de l'enquesta són -1, 0 i 1. La transcripció serà En contra, Abstenció i A favor. La opció de vot a la web es mostrarà com vermell, groc o verd, remarcant la opció escollida. Quan no es permeten negatius, només es guarden las votacions positives. Depenent de si es mostren o no participants, la opció de vot es mostrarà com un OK blau o un Checkmark verd.
Mostrar participants	Quan es mostren participants, es crea una taula on els participants es mostren en l'eix Y i les opcions en l'eix X. Dels participants es veurà el nom i el sentit vot. Quan no es mostren participants, l'usuari que vota només veu les opcions.
Mostrar vots	Quan es mostren vots, el nombre total de vots es veu per a cada opció. Quan també es mostren participants, la suma dels vots es veu a peu de taula. Quan no es mostren vots, l'usuari no sap en cap moment el resultat de la votació.
Permetre insercions	Permetre insercions activa la possibilitat que els usuaris puguin afegir opcions a votar. Aquesta opció no està implementada.
Màxim per opció	Màxim per opció controla la quantitat de vots admesos per opció. Aquest punt té sentit quan s'està fent un tipus d'enquesta on les opcions admeten un nombre de votants determinat. Quan el màxim per opció és zero, tots els participants poden votar totes les opcions.
Màxim d'opcions votades	Màxim d'opcions votades controla la quantitat de vots emesos per un participant. L'explicació seria es pot votar un màxim de 3 del total de 5, sent 3 i 5 part de l'exemple. Quan el màxim d'opcions és zero, el participant pot votar totes les opcions.
Tipus	L'atribut tipus afecta al títol de les opcions. El tipus String es el que admet més varietat i pot ser usat per defecte. La intenció d'aquest atribut és poder controlar màxims i mínims quan s'hagi marcat la opció Permetre insercions.

Exemples de la mateixa enquesta variant els atributs

No permet negatius, no mostra participants

Permet negatius, no mostra participants

No permet negatius, mostra participants

Permet negatius, mostra participants

Enviar l'enquesta

Les enquestes poden ser enviades per correu. Els recipients seran els participants de l'entitat relacionada. Veiem un exemple usant dos entitats diferents:

Entitat relacionada dossier	Els participants de l'enquesta seran els participants al dossier i a les categories d'on penja el dossier.
Entitat relacionada publicació	Els participants de l'enquesta seran els subscriptors de la categoria de la publicació.

El correu mostra el títol de l'enquesta, l'entitat relacionada, la descripció i les opcions a votar, incloent el sentit del vot en cas d'ésser votada.