Manual d’usuari Versió 3 · 2014-01-28 · Via Laietana, 14 08003 Barcelona Tel. 93 567 63 30...

Via Laietana, 14 08003 Barcelona Tel. 93 567 63 30

Fax 93 567 63 31 www.gencat.cat

Manual d’usuari Versió 3.1

1 d’Octubre de 2012

Via Laietana, 14 08003 Barcelona Tel. 93 567 63 30 Fax 93 567 63 31 www.gencat.cat

2

Índex de contingut

1. Formularis gencat ................................................................................................ 4

2. Tipus de formularis .............................................................................................. 5

3. Funcionament de l’aplicació................................................................................ 8

4. Tractament de dades personals .......................................................................... 9

4.1 Formularis .................................................................................................... 9

4.2 Enquestes .................................................................................................. 10

5. Autenticació a l’aplicació ................................................................................... 11

6. Recuperació de contrasenya ............................................................................. 12

7. Perfils d’usuari ................................................................................................... 13

8. El menú ............................................................................................................... 14

9. Gestió d’usuaris ................................................................................................. 15

9.1 Edició d’usuari ........................................................................................... 18

9.2 Selecció de privilegis ................................................................................ 20

9.3 Alta d’usuari ............................................................................................... 22

10. Gestió de formularis .......................................................................................... 24

10.1 Alta i edició d’un formulari ........................................................................ 27

10.1.1 Formulari - General ................................................................................ 28

10.1.2 Formulari – Paràmetres ......................................................................... 31

10.1.3 Formulari – Seguretat ............................................................................ 36

10.1.4 Formulari – Sortida ................................................................................ 37

10.1.5 Formulari – Registres ............................................................................. 41

10.1.6 Formulari – Edició .................................................................................. 43

10.1.7 Formulari – Generar HTML .................................................................... 44

10.1.8 Formulari – Generar XML ...................................................................... 45

11. Explotació de dades. Formulari de tipus no enquesta .................................... 46

11.1 Edició de registre ....................................................................................... 50

12. Explotació de dades d’un formulari de tipus enquesta ................................... 52

13. Consulta de resultats de les dades d’una enquesta ........................................ 56

13.1 Consulta de resultats de l’enquesta amb imatges .................................. 57

13.2 Consulta de resultats amb un XML .......................................................... 61

13.2.1 Consulta de resultats amb un XML amb les imatges .............................. 62

13.2.2 Consulta de resultats amb un XML amb les dades ................................ 65

13.3 Consulta de resultats amb un objecte JavaScript ................................... 68

13.4 Consulta de resultats amb un objecte JSON ........................................... 71

14. Canvi de contrasenya ........................................................................................ 76


3

15. Preparació per a l’enviament dels formularis .................................................. 77

15.1 Preparació per a l’enviament de formularis de tipus enquesta .............. 80

15.2 Errors en la validació HTML ...................................................................... 82

15.3 Seguretat mitjançant un test de CAPTCHA ............................................. 83

16. Apèndix A. Sortides XML ................................................................................... 87

16.1 Generar XML .............................................................................................. 87

16.2 Exportar XML ............................................................................................. 92

16.3 Resposta XML del formulari.................................................................... 100

16.4 Consulta XML d’imatges d’una enquesta .............................................. 103

16.5 Consulta XML d’imatges v3 .................................................................... 104

16.6 Consulta XML de dades d’una enquesta ................................................ 105

16.7 Consulta XML de dades d’una enquesta v3 ........................................... 107


4

1. Formularis gencat

Formularis gencat és la solució de recollida de dades de formularis de la Generalitat de Catalunya. L’aplicació fa possible la creació d’un espai de treball comú per a cada departament o organisme sobre una única plataforma. Aquest espai de treball, que anomenarem organisme, els permet mantenir els seus propis formularis i gestionar les dades que recullen de manera centralitzada.

Entre els avantatges de la solució Formularis gencat podem destacar els següents:

• Tractament centralitzat de tots els formularis del departament o organisme en un espai comú.

• Estandardització del funcionament de tots els formularis de gencat.

• Explotació de les dades dels formularis del departament o el subdepartament separada a nivell d’usuari.

• Integració dels formularis en els portals de gencat.

Formularis gencat pretén sobretot simplificar el procés de gestió dels formularis i l’explotació de les dades provinents d’aquests.

Algunes de les funcionalitats de l’aplicació són:

- Organització dels usuaris i els formularis per organismes.

- Administració delegada en un organisme concret (pot crear nous formularis i usuaris amb permisos d’explotació sobre les dades desades d’un o més d’un formulari).

- Possibilitat de modificar el model de dades de formularis ja creats i amb dades desades.

Formularis gencat és, bàsicament, un repositori de dades en què es poden recollir les peticions enviades per qualsevol formulari HTML, independentment de la seva ubicació. Permet definir el model de dades de manera lògica i les validacions que cal aplicar als diferents camps. Amb petits aspectes de configuració al formulari HTML original (com l’action on ha d’anar i l’identificador del formulari a l’aplicació), es poden començar a desar dades al repositori.


2. Tipus de formularis

A la solució Formularis gencatenquesta i els formularis tipus

Formularis tipus no enquesta

En l’explotació de les dades s

ormularis

Formularis gencat hi ha dos tipus de formularis: els formularis tipus tipus no enquesta.

Formularis tipus no enquesta

Permeten recollir dades de contacte, suggeriments dels usuaris, conèixer l’opinió de l’usuari respecte a alguna qüestió, que l’usuari puguiconsultes sobre algun tema, etc. També permetenla majoria de tipus de camps possibles i incorporen per a camps binaris (pendent de la integració amb corporatiu; mentrestant està inhabilitat).

En l’explotació de les dades s’obté la resposta que ha donat cada usuari en concret:

5

ls formularis tipus

Permeten recollir dades de contacte, suggeriments dels usuaris, conèixer l’opinió de

uari respecte a alguna que l’usuari pugui fer

consultes sobre algun tema, També permeten incloure

la majoria de tipus de camps possibles i incorporen suport per a camps binaris (pendent de la integració amb l’antivirus

; mentrestant està

’obté la resposta que ha donat cada usuari en concret:


6

Formularis de tipus enquesta

Són per fer enquestes on les respostes a les qüestions estan definides per endavant i no permeten la retroacció de l’usuari en forma de suggeriments. Per tant, en el formulari no es poden incloure cap camp de text ni cap textarea.

Així doncs, es pot obtenir la retroacció dels usuaris o dels ciutadans respecte a alguna qüestió, i mesurar el seu grau de satisfacció amb algun servei prestat o alguna actuació duta a terme. Tot seguit, mostrem un exemple d’un formulari de tipus enquesta.

En recuperar els resultats de l’enquesta, s’obté el total de respostes a cada qüestió de manera gràfica i numèrica, no s’obté la resposta individual de cada usuari.


7


8

3. Funcionament de l’aplicació

L’aplicació està dividida en dues parts ben diferenciades:

1. Gestió interna per a les bases de dades d’informació:

� Crear, modificar i esborrar usuaris.

� Afegir, modificar i esborrar privilegis d’un usuari.

� Crear, modificar i esborrar formularis.

� Afegir, modificar i esborrar validacions sobre un paràmetre.

2. Servei d’emmagatzematge i/o enviament de dades provinents de formularis web

Un resum de la manera d’utilitzar aquest servei és el següent:

a) Un organisme obre una incidència a Suport gencat o envia un correu electrònic a [email protected] per obtenir un usuari administrador “delegat” per començar a treballar.

b) Amb aquest usuari administrador, dóna d’alta els formularis amb els seus paràmetres, i tria la forma d’explotació d’aquest, emmagatzemant les dades del formulari en una base de dades i/o mitjançant l’enviament de correus electrònics.

c) Si ha seleccionat fer l’explotació mitjançant l’emmagatzematge de dades, donarà privilegis a usuaris lectors perquè puguin consultar les dades rebudes, i a usuaris explotadors de dades perquè les puguin modificar o eliminar.

d) Als portals s’ha de configurar un formulari introduint un camp ocult anomenat “meta_inf” amb tota la informació necessària perquè el gestor de formularis pugui tractar correctament les dades rebudes (identificador del formulari i idioma).

e) Els usuaris del portal han d’emplenar el formulari. Quan es faci el submit, el gestor de formularis rebrà la petició. Si passa totes les validacions configurades (de seguretat i sobre els paràmetres) es desarà un registre a la base de dades i/o s’enviarà un correu a les adreces pertinents segons la configuració d’explotació. L’usuari del portal pot rebre un correu de confirmació.

f) Aquestes dades estaran disponibles a l’aplicació per a la seva explotació.


9

4. Tractament de dades personals

4.1 Formularis

Pel que fa a la recollida de dades de caràcter personal, s’han de tenir en compte les condicions en què es recullen i l’ús que se’n farà, i cal subministrar aquesta informació a l’usuari.

Cada organisme és responsable de la informació de caràcter personal capturada a través dels seus formularis. Si es crea un fitxer automatitzat, l’organisme responsable l’ha de declarar davant l’Agència Catalana de Protecció de Dades, de manera que en quedin recollides les condicions legals (mètode de recaptació, finalitat, organisme responsable, adreça, etc.).

En general, el tractament de les dades de caràcter personal requereix el consentiment inequívoc de l’usuari, i cal complir les premisses següents:

• Les dades que siguin objecte de tractament no es poden utilitzar per a altres finalitats que no siguin aquelles per a les quals han estat sol�licitades.

• S’han d’enregistrar només les dades personals estrictament necessàries: si les dades personals no són imprescindibles, no les demaneu.

• Les dades de caràcter personal han de ser cancel�lades quan hagin deixat de ser necessàries o pertinents per a la finalitat per a la qual van ser registrades.

• Cal informar l’usuari de manera explícita de l’existència d’un fitxer o d’un tractament de dades de caràcter personal, de la finalitat de la recollida de les dades i dels destinataris de la informació.

• L’usuari ha d’estar informat en tot moment de la possibilitat d’exercir els seus drets d’accés, rectificació, cancel�lació i oposició pel que fa a aquestes dades.

Abans del botó per registrar les dades en un formulari, l’usuari ha de trobar un camp per marcar que digui “Accepto les condicions legals”. Aquestes condicions han de constar a la mateixa pàgina o en un enllaç que s’obri en una altra pàgina. El formulari no ha de deixar desar/enviar les dades si l’usuari no ha seleccionat el camp d’acceptació del tractament.

Un exemple de text legal és:

D’acord amb l’article 5 de la Llei orgànica 15/1999, de 13 de desembre, de protecció de dades de caràcter personal, us informem que les vostres dades personals seran recollides, incorporades i tractades en un fitxer automatitzat anomenat “Trameses d’informació i inscripcions del Gencat”, la finalitat del qual és trametre la publicació que el ciutadà ha requerit.


10

L’òrgan responsable del fitxer és la Direcció General d’Atenció Ciutadana i Difusió, i l’adreça on la persona interessada pot exercir els drets d’accés, rectificació, cancel�lació i oposició és Via Laietana, 14, 3r, 08003 Barcelona.

Evidentment, com a òrgan responsable ha de constar el que sigui en cada cas, així com la resta de dades específiques.

Per a més informació, podeu consultar la Llei orgànica 15/1999, de 13 de desembre, de protecció de dades de caràcter personal, a l’adreça http://www.apd.cat/media/673.pdf. Consulteu també l’assessoria jurídica del departament sobre com s’han de declarar els fitxers i adaptar el text de condicions legals a la normativa específica.

4.2 Enquestes

Pel que fa als formularis de tipus enquesta, cal tenir en compte que les enquestes han de ser anònimes i no poden demanar dades personals ni informació sensible, per això s’exclouen de la llei de protecció de dades esmentada en l’apartat anterior.


5. Autenticació a l’aplicació

Per accedir a l’aplicació heu d’anar a

Cal identificar-se amb un nom d’usuariexistents a la base de dades de l’aplicació. Si contrasenya incorrectes, l’aplicació avisarà de l’error.

Per obtenir l’accés a l’aplicació [email protected], on s’encarregaran de i de crear l’usuari administrador d

Si la base de dades ja existeix, cal adreçarens doni accés a les seves dades.

ació a l’aplicació

Per accedir a l’aplicació heu d’anar a l’adreça http://www14.gencat.cat/gencat_forms/

amb un nom d’usuari o un correu electrònic i una a la base de dades de l’aplicació. Si s’introdueix un nom d’usuari o

, l’aplicació avisarà de l’error.

accés a l’aplicació cal obrir una incidència a Suport gencats’encarregaran de crear la base de dades del nostre organisme

l’usuari administrador d’aquesta base de dades en cas que no existeixi

ja existeix, cal adreçar-se a l’administrador de l’organisme perens doni accés a les seves dades.

1. Introduïu el nom d’usuarielectrònic.

2. Introduïu la contrasenya

3. Premeu el botó “Entra”.

Si les dades són errònies missatge d’error.

11

http://www14.gencat.cat/gencat_forms/.

una contrasenya un nom d’usuari o una

Suport gencat o adreçar-se a la base de dades del nostre organisme

en cas que no existeixi.

administrador de l’organisme perquè

el nom d’usuari o el correu

contrasenya.

“Entra”.

Si les dades són errònies sortirà un


12

6. Recuperació de contrasenya

Si heu oblidat la contrasenya us heu de posar en contacte amb l’administrador de l’organisme al qual pertanyeu perquè us restauri la contrasenya. Si no sabeu a qui us heu d’adreçar o si sou l’administrador de l‘organisme, heu d’obrir una incidència a l’aplicació Suport gencat o posar-vos en contacte amb Suport gencat per correu electrònic ([email protected]) o trucant al 638 87 22 22 i detallar-los el problema.


13

7. Perfils d’usuari

Els usuaris de l’aplicació només poden tenir un perfil i, sempre dins de l’àrea reservada al seu organisme, un organisme es pot correspondre a un departament o a una àrea d’un departament.

Si es volen administrar dades de més d’un organisme o accedir-hi calen diversos usuaris de l’aplicació.

A l’aplicació hi ha tres rols/perfils disponibles: administradors, explotadors de dades i lectors. Tots tres rols ho són en l’àmbit d’un sol organisme.

Els administradors tenen opcions per gestionar usuaris i formularis per a l’organisme que administren; els explotadors de dades poden accedir a l’explotació de dades dels formularis sobre els quals tenen privilegis i modificar-ne i eliminar-ne dades, i finalment, els lectors només poden accedir a l’explotació de dades dels formularis sobre els quals tenen privilegis per consultar dades.

En un mateix organisme hi poden haver tants usuaris lectors i explotadors de dades com es vulgui. L’administrador de l’organisme és el responsable de crear i mantenir aquests usuaris i de gestionar a quins formularis tenen accés.

L’administrador de l’organisme té la possibilitat de crear usuaris amb permisos per administrar l’organisme.


8. El menú

Un cop autenticats a l’aplicació, podrem veure els menús situats a l’esquerravariaran segons el tipus d’usuari

Mitjançant aquests menús podrem accedir a totes les opcions disponibles ambclic.

A continuació mostrem una taula amb el significat de cadascuna de les diferents opcions del menú:

Menú d’administrador

6. Explotació de dadesles dades introduïdes pels clients en els formularis.

7. Canvi de contrasenya

Menú de lector o d’explotador de dades

cats a l’aplicació, podrem veure els menús situats a l’esquerrael tipus d’usuari (administrador, lector o explotador de dades

Mitjançant aquests menús podrem accedir a totes les opcions disponibles amb

A continuació mostrem una taula amb el significat de cadascuna de les diferents

1. Gestió d’usuaris. Podrem cercar, eliminar i modificar els usuaris de l’organisme que gestionem.

2. Alta d’usuari. Podrem donar d’alta un usuari a l’aplicació.

3. Gestió de formulariscercar, eliminar i modificar els formularis definits a l’aplicació.

4. Alta de formulari. Podrem crear nous formularis a l’aplicació.

5. Importar formulari. Permet importar un formulari en format XML.

Explotació de dades. Permet consultar, modificar i exportar en diferents formats les dades introduïdes pels clients en els formularis. Canvi de contrasenya. Permet modificar la clau d’accés a l’aplicació.

explotador de dades 1. Explotació de dades

consultar, modificar i exportar en diferents formats les dades introduïdes pels clients en els formularis.

2. Canvi de contrasenyamodificar la clau d’accés a l’aplicació.

14

cats a l’aplicació, podrem veure els menús situats a l’esquerra, que o explotador de dades).

Mitjançant aquests menús podrem accedir a totes les opcions disponibles amb un sol

A continuació mostrem una taula amb el significat de cadascuna de les diferents

. Podrem cercar, eliminar i modificar els usuaris de

. Podrem donar d’alta

. Podrem cercar, eliminar i modificar els formularis

. Podrem crear nous formularis a l’aplicació.

Importar formulari. Permet importar un formulari en format XML.

xportar en diferents formats

. Permet modificar la clau d’accés a l’aplicació.

. Permet consultar, modificar i exportar en diferents formats les dades introduïdes pels clients

Canvi de contrasenya. Permet és a l’aplicació.


15

9. Gestió d’usuaris

Des d’aquesta opció de menú podem cercar, eliminar, consultar i modificar els usuaris registrats a l’organisme que gestionem. Només hi poden accedir els usuaris administradors.

La primera pantalla que surt quan se selecciona l’opció de menú “Gestió d’usuaris” és el localitzador d’usuaris, on es pot cercar pel nom, el correu electrònic i el perfil dels usuaris donats d’alta a l’organisme. Quan es prem el botó “Cercar”, a la part inferior apareix un llistat amb els usuaris que s’han trobat, paginats de deu en deu.

Si no es troben usuaris amb el criteri seleccionat, apareixerà un missatge que ho indica.

Per fer més dinàmiques les cerques, es pot fer servir el caràcter “*” als camps Nom i Correu electrònic. A continuació es mostren alguns exemples de la seva utilització:

- * : fa una cerca de tots els usuaris.

- adm* : fa una cerca de tots els usuaris el nom dels quals comença per adm.

- *adm* : fa una cerca de tots els usuaris el nom dels quals conté adm.

- adm*1: fa una cerca de tots els usuaris el nom dels quals comença per adm i acaba per 1.

Si es posa més d’un criteri cerca, l’aplicació retornarà els usuaris que compleixin amb totes les condicions introduïdes.


Descripció de les diferents parts de la pantalla:

1. Nom: camp per introduir el criteri de la cercade l’usuari.

2. Correu electrònicelectrònic.

3. Perfil: camp per introduir el criteri de cerca per perfdisponibles són

4. Botó “Cercar”: criteris seleccionats.

5. Resultats: llistat amb el resultat de la cerca. Si s’han trobat usuaris, apareixerà un llistat on la primera columna indisegona és el correu electrònic de l’usuari,les accions que


amp per introduir el criteri de la cerca per nom; fa referència

Correu electrònic: camp per introduir el criteri de cerca per

amp per introduir el criteri de cerca per perfil. Les opcions Administrador, Explotador de dades i Lector.

: en prémer aquest botó es fa la cerca d’usuaris amb els criteris seleccionats.

listat amb el resultat de la cerca. Si s’han trobat usuaris, apareixerà un llistat on la primera columna indica el nom de l’usuari, la

correu electrònic de l’usuari, la tercera el seu perfilles accions que es poden fer sobre aquest usuari.

16

fa referència al nom

criteri de cerca per correu

il. Les opcions inistrador, Explotador de dades i Lector.

la cerca d’usuaris amb els

listat amb el resultat de la cerca. Si s’han trobat usuaris, el nom de l’usuari, la el seu perfil i la quarta


17

6. Informació de la cerca: a sobre del llistat apareixeran els criteris de cerca emprats en la cerca, així com el nombre total de resultats trobats.

7. Paginació: permet navegar per les diferents pàgines del llistat d’usuaris. Podem anar directament a una pàgina; per exemple, si premem el número 2, el llistat mostrarà els usuaris de la posició 10 fins a la 20. Per navegar de pàgina en pàgina s’ha de fer clic sobre els enllaços “Següent” (per anar a la pàgina següent) o “Anterior” (per anar a la pàgina anterior).

8. Botó “Modificar”: amb aquest botó s’accedeix a la pantalla de consulta i edició de l’usuari.

9. Botó “Eliminar”: elimina l’usuari seleccionat. Quan es prem aquest botó, apareix una advertència que indica que l’acció seleccionada no es podrà desfer. Si estem segurs que volem eliminar l’usuari, confirmarem aquesta advertència i l’usuari s’eliminarà del sistema; en cas contrari, cancel�larem i no es durà a terme cap acció.

Quan premem el botó “Modificar”, es mostrarà la pantalla d’edició d’usuari, on podrem modificar les dades de l’usuari (nom, correu electrònic, contrasenya, perfil de l’usuari i privilegis).


9.1 Edició d’usuari


1. Identificador: identificador de l’usuari. Camp només de lectura. Un cop s’ha creat un usuari, aquest identificador no es pot canviar.

2. Nom: nom de l’usuari. Cdiferents usuaris.

3. Correu electrònic: correu electrònic de l’usuari. especificar el mateix correu electrònic per

usuari


dentificador de l’usuari. Camp només de lectura. Un cop s’ha creat aquest identificador no es pot canviar.

om de l’usuari. Camp obligatori i únic, no es pot especificar el mateix nom a

orreu electrònic de l’usuari. Camp obligatori i únic, no es pot especificar el mateix correu electrònic per a diferents usuaris.

18

dentificador de l’usuari. Camp només de lectura. Un cop s’ha creat

es pot especificar el mateix nom a

i únic, no es pot


19

4. Contrasenya: camp opcional. Si no s’emplena, la contrasenya de l’usuari no es canviarà. S’ha d’emplenar només si es vol modificar la contrasenya de l’usuari.

5. Confirmar contrasenya: si s’indica una contrasenya, cal confirmar la contrasenya introduïda.

6. Descripció: camp opcional, serveix per especificar una descripció de l’usuari.

7. Perfil: tipus d’usuari; es pot seleccionar entre administrador, explotador de dades i lector.

8. Tauler “Privilegis”: aquest tauler és visible per als usuaris de tipus lector o explotador de dades i conté la llista de tots els formularis en els quals l’usuari té privilegis per explotar o consultar les seves dades.

9. Eliminar: elimina el privilegi seleccionat. El canvi no tindrà efecte fins que no es premi el botó “Desar”.

11. Botó “Eliminar seleccionats”: permet eliminar el privilegis seleccionats (10). El canvi no tindrà efecte fins que no es premi el botó “Desar”.

12. Botó “Nou Privilegi”: obre la pantalla de selecció de formularis per afegir nous formularis a la llista de privilegis.

13. Botó “Desar”: prement aquest botó es desen les dades modificades a la base de dades, sempre que no hi hagi errors en les dades. Si les dades es desen correctament, tornarem a aquesta mateixa pantalla, i a la part superior es mostrarà el missatge Les dades s’han salvat correctament.

14. Botó “Cancel�lar”: prement aquest botó tornarem al llistat d’usuaris sense fer cap canvi en el sistema.

Cal tenir en compte que els camps marcats amb un asterisc són obligatoris. Si els deixem en blanc, l’aplicació donarà un error i informarà de l’obligatorietat d’emplenar els camps. Igualment, si emplenem el camp “Nom” o el camp “Correu electrònic” amb un nom d’usuari o un correu electrònic ja existents, quan fem clic al botó “Desar” apareixerà un error en què s’informa d’aquesta situació. Les dades no es desaran fins que no se solucionin tots els errors.

Un cop creat un usuari lector, es pot canviar el seu perfil a explotador de dades i viceversa sense perdre els privilegis de la llista. Si canviem el perfil a administrador es perdran tots els privilegis de la llista, ja que no li caldran permisos específics per a cada formulari, perquè els tindrà tots.


20

9.2 Selecció de privilegis

Quan fem clic al botó “Nou privilegi” s’obrirà un tauler a sota del llistat de privilegis de selecció de formularis. Des d’aquí podrem cercar els formularis que volem afegir utilitzant el camp de criteri de cerca. El mateix botó “Nou privilegi” permet tancar el tauler.

Aquest formulari cerca pel nom del formulari; es pot fer servir el caràcter comodí “*” per realitzar cerques més dinàmiques.


Descripció de les diferents parts de la pantalla

1. Botó “Nou privilegiselecció de formularis.

2. Camp “Id”: criteri de cerca. Aquest camp ens permet cercar per l’identificador del formulari.

erents parts de la pantalla

Nou privilegi”: aquest botó ens permet tant obrir com tancar el elecció de formularis.

riteri de cerca. Aquest camp ens permet cercar per l’identificador

21

quest botó ens permet tant obrir com tancar el tauler de

riteri de cerca. Aquest camp ens permet cercar per l’identificador


22

3. Camp “Formulari”: criteri de cerca. Mitjançant aquest camp podem cercar formularis a partir del nom del formulari. Accepta el comodí “*” per fer cerques més dinàmiques.

4. Botó “Cercar”: comença la cerca de formularis segons el criteri seleccionat.

5. Llistat amb el resultat: llistat de formularis trobats. Hi apareixen els formularis que compleixen les condicions de cerca i que no estan en el llistat de privilegis ja assignats a l’usuari.

Aquesta taula i la de privilegis es retroalimenten mútuament. És a dir, quan seleccionem un o diversos formularis del resultat de la cerca, aquests desapareixen d’aquest llistat i apareixen automàticament en el llistat de privilegis, i viceversa, quan eliminem algun privilegi aquest apareix en el resultat de la cerca.

6. Botó “Seleccionar”: permet seleccionar el formulari. Quan es fa clic en aquest botó es tanca l’element emergent i apareix el formulari seleccionat a la llista de privilegis de l’usuari.

7. Botó “Afegir seleccionats”: permet afegir al llistat de privilegis tots els formularis seleccionats (8).

9. Paginació: permet navegar per les diferents pàgines que formen la cerca.

9.3 Alta d’usuari

Aquesta pantalla és pràcticament igual a la pantalla d’edició d’usuari, l’única diferència és que la contrasenya és obligatòria. Permet crear nous usuaris a l’organisme que gestionem i només hi tenen accés els usuaris administradors.

Recordeu que els camps marcats amb un asterisc són obligatoris i que no es permeten noms d’usuari ja utilitzats.

Un cop omplertes les dades obligatòries, prement el botó “Desar” es crearà un nou usuari al sistema i es mostrarà la pantalla d’edició amb l’usuari creat seleccionat.

Per a més informació, adreceu-vos a l’apartat d’edició d’usuaris.


23


24

10. Gestió de formularis

Des d’aquesta opció de menú, disponible només per als administradors, podem cercar, eliminar, consultar i modificar els formularis creats a l’organisme que gestionem, o fer-ne una còpia.

Un formulari del sistema representa bàsicament l’estructura que tindrà un formulari en els nostres portals, amb els seus paràmetres i les validacions que cal fer.

A més, també es poden definir altres aspectes, com per exemple:

- Seguretat:

o Definició d’un temps entre peticions, per evitar peticions massives d’un formulari per part d’usuaris malintencionats.

- Explotació:

o Definició d’una llista d’adreces electròniques on volem que arribi la informació dels formularis enviats pels usuaris.

- Resposta:

o Definició de la pàgina de resposta al submit del formulari o de resposta en format XML (per a integracions amb altres sistemes sense que les validacions hagin de passar el control a l’aplicació Formularis gencat).


Descripció de les diferents

1. Camp “Id”: criteri de cerca. Aquest camp ens permet cercar per l’identificador del formulari.

2. Camp “Nom”: criteri de cerca. Mitjançant aquest camp formularis que vulguemcerques més dinàmiques.

3. Botó “Cercar”: en prémercriteri seleccionat.

4. Resultats: llistat amb el run llistat on la primera columna indicaque podem realitzar sobre aquest formulari.

5. Informació de la cercanombre de resultats.

6. Paginació: permet navegar per les diferents pàgines del llistat. Podedirectament a una pàgina;els formularis situats des de


riteri de cerca. Aquest camp ens permet cercar per l’identificador del

riteri de cerca. Mitjançant aquest camp podem cercar els vulguem a partir del nom del formulari. Accepta el comodí “*” per

cerques més dinàmiques.

prémer aquest botó, es realitzarà la cerca de formularis amb el

listat amb el resultat de la cerca. Si s’han trobat formularis, apareixerà t on la primera columna indica el nom del formulari, i la segonaem realitzar sobre aquest formulari.

Informació de la cerca: mostra els criteris emprats en la cerca, a

: permet navegar per les diferents pàgines del llistat. Podedirectament a una pàgina; per exemple, si premem el número 2, el llistat mels formularis situats des de la posició 10 fins a la 20. Per navegar de pàgina en

25

riteri de cerca. Aquest camp ens permet cercar per l’identificador del

podem cercar els a partir del nom del formulari. Accepta el comodí “*” per fer

aquest botó, es realitzarà la cerca de formularis amb el

esultat de la cerca. Si s’han trobat formularis, apareixerà segona les accions

ostra els criteris emprats en la cerca, així com el

: permet navegar per les diferents pàgines del llistat. Podem anar si premem el número 2, el llistat mostrarà

gar de pàgina en


26

pàgina farem clic sobre els enllaços “Següent” (per anar a la pàgina següent) o “Anterior” (per anar a la pàgina anterior). A “Registres totals” hi ha la informació de tots els formularis que s’han trobat.

7. Enllaç “Modificar”: amb aquest enllaç s’accedeix a la pantalla de consulta i edició del formulari, on es poden modificar tots els aspectes del formulari.

8. Enllaç “Clonar”: amb aquest enllaç es fa una còpia exacta del formulari, amb totes les seves configuracions, amb el nom ‘Còpia de [NOM DEL FORMULARI]’. En prémer aquest botó apareix una pantalla de confirmació de l’acció on es pot veure el nom del formulari que es crearà.

9. Enllaç “Exportar XML”: permet descarregar un fitxer XML amb la definició completa del formulari. Aquest fitxer es correspon amb el que es pot utilitzar en l’opció “Importar formulari”.

10. Enllaç “Eliminar”: elimina el formulari seleccionat. Quan fem clic en aquest enllaç apareix una pantalla de confirmació on s’indica que l’acció seleccionada no es podrà desfer. Si estem segurs que volem eliminar el formulari, confirmarem i el formulari seleccionat s’eliminarà del sistema; en cas contrari, cancel�larem i no es realitzarà cap acció.

Avís important: Eliminar un formulari comporta eliminar també tots els registres (dades enviades) associades al formulari. Un cop s’ha confirmat l’eliminació del formulari, no es podran recuperar les dades.


27

Quan premem el botó de modificar, anirem a la pantalla d’edició del formulari, on podrem configurar tots els aspectes del formulari.

10.1 Alta i edició d’un formulari

Algunes de les característiques de l’edició de formularis són les següents:

- Es poden personalitzar els estils de la pàgina de validacions per donar un aspecte i comportament similar al que tenim al nostre web. L’estructura de la pàgina de validacions és fixa. Hi ha una mostra de personalització a http://www.gencat.cat/css/cssTestForms.css.

- Es poden reordenar els paràmetres del formulari, mitjançant la funcionalitat d’arrossegar i deixar anar. El canvi afecta la forma en què es veuen els resultats a l’explotació de dades, tant als llistats de resultats com en els diferents formats de documents en què podem exportar els resultats.

- Possibilitat de definir en quina codificació arriben les dades del formulari per tal que quan arribin a Gencat Forms es desin correctament els accents i altres caràcters especials.

- Es pot escollir una Pàgina d’OK diferent per a cadascun dels idiomes per als quals tenim definit el formulari per poder integrar Gencat Forms amb webs multiidioma.

- L’usuari pot rebre un correu personalitzat a l’adreça de correu electrònic que comuniqui en enviar el formulari. Aquest correu pot ser, per exemple, un missatge de confirmació conforme s’ha rebut la seva petició o algun text que l’informi del pas següent que cal seguir.

- El formulari de tipus enquesta permet definir un seguit de preguntes o qüestions i després explotar les respostes a cada qüestió de manera agrupada. Les respostes es defineixen al formulari HTML i l’usuari només n’ha de poder escollir una per qüestió.

- En els formularis de tipus enquesta no són compatibles els paràmetres de tipus “Document” o “Imatge” .

- És possible restringir els vots a l’enquesta pel que fa a la IP de l’usuari. Cal tenir present que en entorns on els usuaris comparteixin la mateixa IP per navegar per Internet es restringirà el vot a un sol usuari, però si no es filtrés, tots els usuaris podrien votar els cops que volguessin i falsejarien els resultats.

- Es pot indicar el nombre màxim de registres que es permeten per al formulari.


28

L’eina de formulari divideix les diferents propietats d’un formulari en cinc categories diferents, depenent de la seva tipologia:

- General

- Paràmetres

- Seguretat

- Sortida

- Registres

En l’alta del formulari es van emplenant les diferents propietats del formulari pas a pas, mentre que en l’edició totes aquestes categories apareixen separades per pestanyes.

Les propietats per a cadascuna de les diferents categories són idèntiques en ambdós casos.

10.1.1 Formulari - General Aquest apartat ens permet definir les característiques generals del formulari.



1. Nom: camp obligatori i únic. Indica el nom del formulari

2. Descripció: camp opcional. Descripció pe

3. Codificació del formulari:d’origen. De moment accepta UTFforçar en fer el submit

4. Tipus enquesta: permet marcar un formulari com a tipus enquesta. Aquesta opció només és accessible en el moment de la creació del formulari i no té marxa enrere.

5. Idiomes: llistat d’idiomes peparàmetre. En cas que haguem marcat aquest ens apareixerà


amp obligatori i únic. Indica el nom del formulari.

amp opcional. Descripció per al formulari.

el formulari: cal indicar en quina codificació es troba el formulari e moment accepta UTF-8 o ISO-8859-1; aquesta propietat es

submit del formulari.

: permet marcar un formulari com a tipus enquesta. Aquesta pció només és accessible en el moment de la creació del formulari i no té

listat d’idiomes per als quals hem de crear literals per a cada paràmetre. En cas que haguem marcat algun dels idiomes com a obligatori, aquest ens apareixerà com a camp de només lectura i ja seleccionat.

29

en quina codificació es troba el formulari propietat es pot

: permet marcar un formulari com a tipus enquesta. Aquesta pció només és accessible en el moment de la creació del formulari i no té

ls quals hem de crear literals per a cada idiomes com a obligatori,

com a camp de només lectura i ja seleccionat.


30

6. Enllaç “Següent”: quan fem clic en aquest enllaç es validen les dades introduïdes i, si són correctes, es va al pas següent de la creació del formulari (alta). En la resta de passos per a la creació del formulari, el funcionament d’aquest enllaç és exactament el mateix.


31

10.1.2 Formulari – Paràmetres Aquesta pantalla permet definir les característiques de cadascun dels paràmetres que formen el formulari. La pantalla mostra en format taula els diferents paràmetres que formen el formulari. Les opcions de literals i respostes fixes de cada paràmetre s’obren a sota de cadascun d’ells.


32


33


1. Botó “Nou paràmetre”: introdueix una nova línia a la llista de paràmetres.

2. Icona d’arrossegar i deixar anar: permet moure un paràmetre a qualsevol posició del llistat de paràmetres.

3. Nom paràmetre: nom del paràmetre. Aquest camp és obligatori i no accepta duplicats dins del llistat. Aquest nom serà l’utilitzat pels paràmetres dels formularis dels nostres portals, per això es recomana utilitzar noms adients a la informació demanada. Els noms han de ser per força alfanumèrics (de la A a la Z en llengua anglesa, tant en minúscula com en majúscula) i del 0 al 9. També es permet el guió baix “_”.

4. Mida: indica la mida màxima que pot tenir el camp. Si no s’indica el valor o es posa 0, no s’aplica la validació.

5. Obligatori: indica que el paràmetre serà obligatori.

6. Únic: indica que el paràmetre serà únic. Un únic valor per a tots els registres del formulari.

7. Validació: selector del tipus de validació:

a) Qualsevol tipus: camp de text obert.

b) Natural: el paràmetre ha de ser un valor numèric natural (números positius sense decimals).

c) Enter: el paràmetre ha de ser un valor numèric enter (números amb signe sense decimals).

d) Real: el paràmetre ha de ser un valor numèric real (qualsevol número).

e) Correu electrònic: ha de tenir format d’adreça electrònica, o sigui [email protected].

f) URL: ha de tenir un format d'adreça d’Internet.

g) Data: ha de tenir un format de data igual a dd/MM/yyyy, on dd equival a dia amb dos dígits, MM a mes amb dos dígits i yyyy a any amb quatre dígits.

h) Hora: ha de tenir un format d’hora igual a HH:mm, on HH és l’hora amb dos dígits i format de 24 hores, i mm els minuts amb dos dígits.

i) Data+Hora: és una combinació de data i hora separats per un espai en blanc: dd/MM/yyyy HH:mm.


34

j) NIF/CIF/NIE: ha de ser un NIF, NIE o CIF vàlid.

k) Document: pot ser un fitxer de tipus:

• application/pdf (PDF)

• application/msword (Word, .doc)

• application/vnd.oasis.opendocument.text (Word, .docx)

• application/vnd.oasis.opendocument.text (OpenDocument, .odt)

El fitxer no pot ser més gran de 2 MB.

l) Imatge: pot ser un fitxer de tipus:

• image/png

• imatge/gif

• image/jpeg

El fitxer no pot ser més gran de 2 MB.

8. Enllaç “Literals”: aquest enllaç es desplega a sota de la fila del paràmetre del tauler perquè puguem incloure els literals del paràmetre.

9. Tauler “Literals”: per a cadascun dels idiomes que s’hagin definit en l’apartat General hi ha un camp per indicar el literal corresponent.

10. Enllaç “Respostes fixes”: aquest enllaç es desplega a sota de la fila del paràmetre del tauler per poder incloure les respostes fixes. Les respostes fixes només es poden fer servir en els camps sense cap tipus de validació.

11. Tauler “Respostes fixes”: en aquest tauler podem indicar el conjunt de respostes vàlides al paràmetre.

12. Casella de selecció “Conté respostes fixes”: cal marcar aquesta casella de selecció per poder habilitar la validació.

13. Casella de selecció “Resposta única”: permet indicar si s’accepta un únic valor en les respostes fixes o bé un conjunt d’aquestes.

14. Botó “Afegir nou valor”: permet afegir un nou valor (15) al llistat de valors possibles.


35

15. Valor de la resposta fixa: cada possible valor del conjunt de respostes fixes el formen tres elements:

a) Valor: el valor possible de la resposta fixa.

b) Literals: el literal de la resposta per a cadascun dels idiomes que s’hagin definit en l’apartat General.

c) Eliminar: permet esborrar el valor del llistat de possibles respostes fixes.

16. Enllaç “Eliminar” (paràmetre): elimina el paràmetre de la llista. Si s’elimina un paràmetre de la base de dades, per evitar problemes de sincronització de dades, s’esborrarà de la base de dades del sistema el valor que pugui tenir aquell paràmetre en els registres introduïts fins a aquell moment.

17. Enllaç “Anterior”: en fer clic sobre aquest enllaç es validen les dades introduïdes i, si són correctes, es va al pas anterior de creació del formulari (alta). En la resta de passos de creació del formulari el funcionament d’aquest enllaç és exactament el mateix.

18. Enllaços per passos: a mesura que es va avançant en els diferents passos de la creació del formulari es van activant els enllaços dels passos anteriors. Aquests enllaços porten al pas corresponent, i es poden perdre les dades que s’han introduït en el pas actual. Si s’ha fet algun canvi en el pas, quan es fa clic sobre l’enllaç apareix un missatge que indica aquesta situació:

Per anar a passos anteriors s’ha de fer servir l’enllaç anterior fins a arribar al pas que es vulgui.


10.1.3 Formulari – Seguretat Aquest apartat explica com es poden per comprovar que la petició que ens arriba é


1. Llista d’URL referentformulari.

2. Nom: adreça web des de la qu

3. Nova URL: crea una nova fila a la llista

4. Botó “Eliminar”: e

Seguretat

explica com es poden definir les validacions que fa l’eina de formularis que la petició que ens arriba és legítima.


referents: llista d’adreces URL permeses per envia

dreça web des de la qual és permès fer peticions al formulari.

rea una nova fila a la llista d’URL referents.

elimina l’adreça URL de la llista d’URL referent

36

l’eina de formularis

permeses per enviar peticions del

és permès fer peticions al formulari.

ents.


37

5. Temps de seguretat entre peticions: camp opcional. Indica un temps de seguretat en segons per evitar que es realitzin peticions massives sobre el formulari. Per exemple, si indiquem 5 segons, voldrà dir que quan llancem una petició del formulari, no podrem tornar a fer una altra petició fins passats 5 segons. Si fem la petició i encara no ha passat el temps, l’aplicació donarà un error i no deixarà continuar amb l’operació.

Nota: la validació es fa a partir de la IP des d’on arriba la petició. Si tenim previst desplegar el formulari en un entorn corporatiu típic (tots els usuaris fan les peticions des de la mateixa IP), aquesta validació pot ser problemàtica, ja que un usuari que no hagués fet cap petició es podria trobar amb un error de petició incorrecta perquè un altre usuari hagués fet una petició abans de l’expiració del temps de seguretat.

6. No permetre que un usuari voti més d’un cop: només apareix si el formulari és de tipus enquesta. Si està seleccionat, l’aplicació només permetrà que s’emeti un submit del formulari (de l’enquesta) per cada usuari, i farà el control a través de la IP de l’ordinador de l’usuari.

Nota: en cas que tinguem previst que el nostre formulari s’hagi de fer servir en un entorn corporatiu, aquesta opció no s’hauria d’habilitar, ja que en l’enquesta només podria votar un únic usuari.

10.1.4 Formulari – Sortida En aquest apartat es mostra com es configura la resposta que dóna a l’usuari el formulari en rebre una petició de nou registre.


38


39


1. Resposta: tipus de resposta a la petició.

Si posem sortida amb HTML se’ns desplegarà un tauler on podrem configurar diferents opcions del tipus de resposta.

En cas que indiquem resposta amb XML, tant la pàgina dels possibles errors de validació com la pàgina d’inserció de dades correcta ens arribaran en format XML (vegeu l’apartat 16.3 Resposta XML del formulari).

2. Tauler de resposta HTML: se’ns desplegarà en cas que indiquem el tipus de resposta HTML. Podem configurar les pàgines OK així com el full d’estils que s’ha d’aplicar en l’HTML de la pàgina d’errors de validació de l’aplicació.

3. Personalització de la pàgina de validacions: ens permet introduir l’adreça web d’un full d’estils (CSS) per poder personalitzar la pantalla d’errors de validació.

4. Pàgines OK: adreça web de la pàgina on es vol redirigir l’usuari després de registrar les dades del formulari correctament. És obligatori introduir una pàgina d’OK per cadascun dels idiomes en que està configurat el formulari.

5. Enviar un correu als paràmetres de tipus correu electrònic indicats: permet definir si s’enviarà un missatge de correu als paràmetres de tipus correu electrònic. Al formulari hi ha d’haver obligatòriament un camp de tipus correu electrònic. En fer clic sobre aquesta casella de selecció se’ns desplegarà el tauler on podrem introduir el missatge que s’ha d’enviar.

6. Tauler de missatges de correu: se’ns desplegarà en cas que indiquem que volem enviar un correu als paràmetres de tipus correu electrònic indicats. Permet indicar quin és el paràmetre al valor del qual s’enviaran els missatges, així com el contingut dels missatges que s’han d’enviar.

7. Paràmetres als quals s’enviarà el correu: llistat dels paràmetres de tipus correu electrònic als quals s’enviarà un correu electrònic.

8. Missatges de correu que s’han d’enviar a l’usuari: permet definir l’assumpte i el cos del missatge que s’enviaran a l’usuari un cop s’acceptin les dades que l’usuari hagi introduït en el formulari.

Tant en l’assumpte com en el cos del missatge podem incloure els valors que l’usuari hagi introduït en cadascun dels paràmetres del formulari.

Així, per exemple, si el nostre formulari té definits els paràmetres nom i cognom, podríem personalitzar el missatge que enviem a l’usuari afegint aquestes dades en el cos del missatge de la manera següent:


40

En cas que l’usuari no hagi emplenat algun paràmetre inclòs en el missatge, aquest paràmetre es mostrarà en blanc.

Igualment, podem afegir en el missatge l’identificador intern del registre de la seva petició, incloent en el text #N_REG# (per exemple per als textos de tipus La seva petició ha quedat registrada amb el número #N_REG#).

Finalment, afegint el text #DATA# podrem incloure en el missatge la data en què l’usuari ha fet la seva petició en format dd/MM/yyyy HH:mm.


10.1.5 Formulari – Registres Aquest apartat permet gestionar la arriben a través del formulari.

Registres

Aquest apartat permet gestionar la manera en què es tracten les dades que ens a través del formulari.

41

es tracten les dades que ens


42


1. Emmagatzematge: si seleccionem aquest tipus d’explotació, indiquem al sistema que les dades provinents dels formularis es desaran a la base de dades.

2. Notificacions per correu electrònic: seleccionant aquesta opció, indiquem al sistema que volem enviar les dades del formulari a les adreces configurades al tauler “Bústies” (3).

En el correu electrònic que s’envia s’inclouen tots els valors introduïts per l’usuari en el formulari. En el cas dels paràmetres de tipus document o imatges es proporciona un enllaç des d’on poder descarregar el fitxer.

3. Tauler “Bústies”: aquest tauler es desplega quan seleccionem l’opció “Notificacions per correu electrònic”.

4. Camp “Assumpte”: correspon a l’assumpte del correu electrònic. És un camp obligatori si se selecciona l’explotació per correu electrònic.

5. Nova Bústia: introdueix una nova línia al llistat de bústies per poder definir una nova adreça de correu electrònic.

6. Llistat “Bústies”: adreces de correu electrònic on volem que s’enviïn les dades; és un camp obligatori i de tipus correu electrònic ([email protected]).

7. Màxim nombre de registres: permet indicar el nombre màxim de registres que accepta el formulari. Si fem la petició i s’ha superat el límit de registres, l’aplicació donarà un error i no deixarà continuar l’operació. Si emplenem aquest camp se’ns desplegarà un tauler on podrem indicar com s’ha de tractar aquest cas.

8. Quan es superi el nombre registres enviar un correu a: permet indicar una adreça electrònica a la qual s’enviarà un correu en cas que se superi el nombre màxim de registres per a cada idioma definit pel formulari. Camp opcional.

9. Missatges de registres superats: podem indicar el missatge que apareixerà a l’usuari en cas que se superi el nombre màxim de registres, per a cadascun dels idiomes en què tinguem configurat el formulari. El camp és opcional. Per defecte apareix el missatge S’ha excedit el màxim nombre de registres suportat per el formulari (i les seves traduccions corresponents depenent de l’idioma).

10. Botó “Desar”: confirma tots els canvis que hem fet fins al moment. Fins que no es prem aquest botó, els canvis realitzats no es desen al sistema.


11. Botó “Cancel�lar”: de formularis. Atencióprèviament en el formulari.l’alta del formulari.

10.1.6 Formulari – EdicióLa pantalla d’edició del formulari consta dels pestanyes, més dues pantalles més i HTML.

Descripció de les diferents pa

1. Pestanyes d’apartatsper pestanyes. Cada pestanya anteriors. En l’edició apareixen dos nous apartatsi Generar XML (3).

: descarta tots els canvis i torna a la pantalla de de formularis. Atenció perquè si es prem es perdran tots els canvis realitzat

el formulari. Aquest botó és aplicable a la resta de passos de

Edició La pantalla d’edició del formulari consta dels cinc apartats comentats agrupats en

pantalles més que permeten extreure el formulari en format XML


Pestanyes d’apartats: els diferents apartats del formulari apareixen separats Cada pestanya conté la informació ja descrita en els

. En l’edició apareixen dos nous apartats o opcions: Generar HTML (2)

43

escarta tots els canvis i torna a la pantalla de localitzador es perdran tots els canvis realitzats

Aquest botó és aplicable a la resta de passos de

comentats agrupats en cinc extreure el formulari en format XML

ls diferents apartats del formulari apareixen separats a informació ja descrita en els apartats

opcions: Generar HTML (2)


4. Id: identificador del formulari. Camp només de lectura. Un cop s’ha creat un formulari, aquest identificador no es pot canviar.

10.1.7 Formulari – Generar HTMLPermet crear un HTML d’exemple amb tots els camps indicats en el llistat de paràmetres, així com el camp meta_inf que hem d’introduir perquè l’eina de formularis entengui les dades que li arrib Es pot seleccionar l’idioma en qu

El contingut de l’HTML que es mostra es correspon amb el que estem editant en aquest moment, i no amb el que hi ha

dentificador del formulari. Camp només de lectura. Un cop s’ha creat un aquest identificador no es pot canviar.

Generar HTML t crear un HTML d’exemple amb tots els camps indicats en el llistat de

paràmetres, així com el camp meta_inf que hem d’introduir perquè l’eina de formularis entengui les dades que li arriben.

seleccionar l’idioma en què volem veure les dades.

HTML que es mostra es correspon amb el que estem editant en el que hi ha desat realment a la base de dades.

44

dentificador del formulari. Camp només de lectura. Un cop s’ha creat un

t crear un HTML d’exemple amb tots els camps indicats en el llistat de paràmetres, així com el camp meta_inf que hem d’introduir perquè l’eina de formularis

HTML que es mostra es correspon amb el que estem editant en realment a la base de dades.


10.1.8 Formulari – Generar XML

Permet generar un XML amb les dades bàsiques d’un formulari. sobre el format de l’XML, vegeu

El contingut de l’XML que es mostra es correspon amb el que estem editant en aquest moment, i no amb el que hi ha

Generar XML

ermet generar un XML amb les dades bàsiques d’un formulari. Per a més informació egeu el punt 16.1 Generar XML.

XML que es mostra es correspon amb el que estem editant en aquest el que hi ha desat realment a la base de dades.

45

Per a més informació

XML que es mostra es correspon amb el que estem editant en aquest


46

11. Explotació de dades. Formulari de tipus no enquesta

Podem consultar les dades dels formularis omplerts pels usuaris i emmagatzemades al sistema i fer cerques per diversos criteris.

Es pot filtrar pel nom del formulari i per la data de creació del registre. Un cop omplerts els criteris de la cerca, fent clic sobre el botó “Llistar” apareixeran tots els registres coincidents, paginats de deu en deu. Aquesta informació també la podrem exportar al nostre disc dur en fitxers de diferents formats, PDF (fitxer d’Adobe), CSV (fitxer de text net amb les dades separades per punt i coma) o Excel.

En cas que un paràmetre del formulari sigui de tipus “Document” o “Imatge” es mostrarà una icona identificativa per a cada tipus de fitxer, amb l’enllaç per poder descarregar-lo.

Es poden eliminar tots els registres d’un formulari pàgina a pàgina o bé els registres que s’escullin d’una pàgina.


47


48

Descripció de les diferents parts de la pantalla.

1. Camp “Formulari”: camp de només lectura. Indica el nom del formulari seleccionat.

2. Botó de selecció de formularis: s’obre el tauler de selecció de formularis a sota mateix del nom del formulari. Des d’aquí podrem cercar i seleccionar entre els formularis configurats al nostre organisme. Si som administradors els veurem tots. Si tenim el perfil de lector o d’explotador de dades només veurem aquells en què tenim privilegis. El tauler que s’obre és exactament el mateix que el que es descriu en l’apartat Gestió d’usuaris – Selecció de formularis.

3. Data creació Des de: camp per filtrar per la data de creació. Indiquem que volem tots els registres la data de creació dels quals sigui igual o posterior a la data seleccionada. El format del camp és dd/MM/yyyy.

Podem introduir la data directament al camp o bé amb l’ajuda del calendari que es desplega en prémer el botó situat al costat mateix del camp.

4. Data de creació Fins a: camp per filtrar els registres per la data de creació. Indiquem que volem tots els registres amb data de creació anterior o igual a la data seleccionada. El format del camp és dd/MM/yyyy.

Podem introduir la data directament al camp o bé amb l’ajuda del calendari que es desplega en prémer el botó situat al costat mateix del camp.

5. Filtrar resultats: llistat de tots els paràmetres del formulari per poder filtrar els resultats.

En cadascun del camps podem afegir el caràcter comodí “*” per fer cerques més dinàmiques.

6. Mostrar columnes: permet mostrar i ocultar les diferents columnes (paràmetres) del llistat de registres. Podem ocultar qualsevol columna excepte les columnes de l’identificador del registre i la de la data.

7. Botó “Llistar”: fa la cerca de registres.

8. Exportació de registres: permet descarregar les dades dels registres en un fitxer. Els formats de fitxers compatibles són PDF, CSV i Excel.

Amb el selector seleccionarem el format del fitxer i, en prémer el botó d’exportar el formulari del navegador, ens demanarà què volem fer amb el fitxer, desar-lo o obrir-lo directament amb el programa corresponent.

9. Resultats de la cerca: un cop acabada la cerca, apareixerà el llistat de registres trobats, paginats de deu en deu, així com el nombre de registres trobats.


49

10. Paginació.

11. Llistat de registres: per cadascun dels registres trobats, es mostra l’identificador intern, la data d’entrada del registre, així com el valor per a cadascun dels paràmetres del registre.

- Podem ordenar els registres per identificador i data.

- També podem ordenar els registres per qualsevol dels paràmetres de tipus text. És a dir:

o Sense cap tipus de validació especificada

o Correu electrònic

o URL

o NIF/CIF/NIE

Nota: en les diferents ordenacions, els possibles valors buits dels paràmetres apareixen sempre en última posició.

- En cas que el tipus de validació es correspongui amb una imatge o un document, es mostrarà una icona que ho indica. Fent clic sobre la icona podem descarregar el fitxer corresponent.

12. Enllaç “Modificar”: obre la pantalla d’edició de registres, on podrem modificar les dades relacionades amb el registre seleccionat. Aquesta opció només estarà disponible en cas que tinguem el perfil d’administrador o d’explotador de dades.

13. Enllaç “Eliminar”: eliminarà el registre seleccionat del sistema. Aquesta opció només estarà disponible en cas que tinguem el perfil d’administrador o d’explotador de dades.

14. Botó “Eliminar”: elimina tots els registres seleccionats de la pàgina o bé tots els de la pàgina si la casella de selecció de la capçalera està marcada. Aquesta opció només estarà disponible en cas que tinguem el perfil d’administrador o d’explotador de dades.

15. Casella de selecció de registres: es pot escollir quins registres en concret es volen eliminar posteriorment prement el botó “Eliminar” que apareix a la paginació. Aquesta opció només estarà disponible en cas que tinguem el perfil d’administrador o d’explotador de dades.

Si al formulari HTML hi ha camps amb valors múltiples que emmagatzemin les dades en el mateix camp del formulari a Gencat Forms, com pot ser un camp de selecció


múltiple o un grup de caselles de seleccióconjunt de valors introduïts per l’usuari

Si l’usuari pot escollir entre dues caselles de selecció que tenen el mateix “nameseparats per comes:

opcio1,opcio2 si l’usuari en selecciona due

opcio1 si l’usuari en selecciona

11.1 Edició de registre


Camps dinàmics: aquestconfigurats a la taula associada al formulari seleccionatd’un asterisc vermell són camps obligatoris.

1. Camp sense tipus de validacióde validació apareixen representats amb un

2. Camps de tipus imatge: un enllaç amb el nom de la imatge desada. Si

caselles de selecció, en el llistat d’aquest camp es conjunt de valors introduïts per l’usuari separats per comes.

l’usuari pot escollir entre dues caselles de selecció amb valors “opcio1name”, es desarien els valors de les caselles de selecció triades

si l’usuari en selecciona dues.

si l’usuari en selecciona només una.

Edició de registre


aquests camps són dinàmics i corresponen als camps configurats a la taula associada al formulari seleccionat. Els camps acod’un asterisc vermell són camps obligatoris.

Camp sense tipus de validació: els camps que no tenen associató apareixen representats amb un textarea.

Camps de tipus imatge: en el cas dels camps de tipus imatge ens apareixerà un enllaç amb el nom de la imatge desada. Si fem clic a l’enllaç ens permetrà

50

aquest camp es mostrarà el

opcio1” i “opcio2” de les caselles de selecció triades

són dinàmics i corresponen als camps . Els camps acompanyats

ls camps que no tenen associat cap tipus

ls camps de tipus imatge ens apareixerà l’enllaç ens permetrà


51

descarregar la imatge. Així mateix, si passem el cursor per sobre de l’enllaç se’ns mostrarà la imatge en format petit.

3. Camps de tipus document: igual que en els camps de tipus imatge, ens apareixerà un enllaç amb el nom del fitxer desat. Si fem clic a l’enllaç ens permetrà descarregar el document.

4. Enllaç “Modificar”: aquest enllaç ens mostrarà un camp de tipus ‘file’ que ens permetrà pujar el document o la imatge que substitueixi (o creï) la que tenim actualment en el registre.

5. Enllaç “Eliminar”: esborra el document o la imatge associada al camp Registre.

6. Camp amb tipus de validació: per a la resta de camps, el valor se’ns mostrarà en un camp de tipus ‘text’.

7. Botó “Desar”: quan premem aquest botó es validaran les dades segons el tipus de camp i les validacions definides al formulari. Si tot va bé, s’actualitzaran les dades del registre al sistema; en cas contrari, se’ns mostraran els missatges corresponents als errors comesos.

8. Botó “Cancel�lar”: torna a la pantalla d’explotació de dades sense fer cap modificació sobre el registre seleccionat.


52

12. Explotació de dades d’un formulari de tipus enquesta

Des d’aquesta opció podrem consultar les respostes dels usuaris per a un formulari de tipus enquesta emmagatzemades al sistema. El sistema agrupa les respostes dels usuaris a les diferents qüestions del formulari.

Els resultats apareixen en format de taula (valor de la resposta: nombre de respostes) per a cadascun dels paràmetres del formulari. Es mostren també en format de gràfic de barres per a cadascun dels paràmetres del formulari i les seves respostes.

No es mostren les respostes individuals de cada usuari i, per tant, no es poden fer cerques per data sobre les respostes, ni hi ha paginació de les respostes. Per la mateixa raó, no es poden editar els registres. Un cop rebudes les respostes dels usuaris només es mostra la visualització del nombre d’ocurrències de cadascuna de les respostes per a cada paràmetre.

Els diferents valors dels paràmetres de l’enquesta es van creant a mesura que ens arriben via submit. Cal tenir en compte que als resultats de l’enquesta mai no ens apareixerà un número de respostes igual a zero si no hem definit les respostes fixes a l’hora de configurar les diverses preguntes del formulari.

Si en els diferents paràmetres no tenim definides les respostes fixes:

- No queda constància de les opcions a la pregunta que els usuaris no hagin triat.

- Les opcions vàlides com a resposta a la pregunta són infinites. Quan l’usuari fa un submit del formulari, Gencat Forms valida si el valor que ens arriba per a cadascun dels paràmetres existeix al sistema o no. En cas que el valor per al paràmetre ja hagi estat introduït per algun altre usuari, se sumarà 1 al nombre d’ocurrències del valor. En cas que no existeixi, es crearà una nova entrada per al valor al sistema amb un valor de nombre d’ocurrències igual a 1.

- Les opcions múltiples a la pregunta no es desaran com una nova entrada per a cada opció, es desaran com en la resta de formularis: com una nova opció amb els diferents valors separats per comes.

En cas que tinguem definides respostes fixes per als diferents paràmetres del formulari enquesta sí que se’ns permet el següent:

- Veure les opcions de la pregunta que encara no s’han respost. Amb valor 0, és clar.


53

- Les opcions vàlides com a resposta de la pregunta estan limitades a les que definim en les respostes fixes.

- S’accepten respostes múltiples. Per a cadascun dels valors rebuts se sumarà 1 a l’opció corresponent.

Aquesta informació es pot exportar al nostre disc dur en fitxers de format PDF.


54


55


1. Camp “Formulari”: camp de només lectura. Indica el nom del formulari seleccionat.

2. Botó de selecció de formularis: si premem aquest botó, s’obre el tauler de selecció de formularis a sota mateix del nom del formulari. Des d’aquí podrem cercar i seleccionar entre els formularis configurats al nostre organisme. Si som administradors els veurem tots, i si tenim el perfil de lector o d’explotador de dades només veurem aquells en què tinguem privilegis. El tauler que s’obre és exactament el mateix que el que es descriu en l’apartat de Gestió d’usuaris – Selecció de formularis.

3. Botó “Llistar”: fa la cerca de resultats de l’enquesta i fa aparèixer el llistat de resultats.

4. Botó “Exportar”: en prémer aquest botó, comença el procés d’exportació. Quan acabi, s’obrirà un formulari del sistema que demana què volem fer amb el fitxer: desar-lo o obrir-lo directament amb el programa corresponent.

El fitxer descarregat serà sempre PDF.

5. Llistat “Resultats”: un cop acabada la cerca, apareixen els resultats en format taula (valor de la resposta: nombre de respostes), i en format de gràfic de barres per a cadascun dels paràmetres del formulari.

El bloc de resultats el forma el següent:

o Nombre de respostes totals.

o Taula de resultats.

o Gràfica de resultats.

6. Taula de resultats: aquesta taula ens mostra el nombre de respostes per cada paràmetre i cada valor possible.

7. Gràfic de barres del valor: representació gràfica dels resultats de l’enquesta.


56

13. Consulta de resultats de les dades d’una enquesta

Les dades de les enquestes es poden consultar sense necessitat d’entrar a Gencat Forms. Això permet que els resultats de l’enquesta es puguin mostrar en qualsevol web en temps real, o integrar aquests resultats amb altres aplicacions.

Els resultats que s’obtenen en tots els casos són les respostes acumulades per a cadascun dels paràmetres, no es mostren les respostes individuals de cada usuari.

Hi ha cinc maneres de recuperar les dades de l’enquesta: mitjançant un objecte JavaScript, mitjançant una resposta JSON, amb imatges, amb un XML informatiu o amb un XML amb les dades de l’enquesta.

En el cas de les imatges es pot restringir la consulta d’aquestes dades perquè sigui visible únicament als usuaris que ja han contestat l’enquesta.

Totes les consultes per recuperar les dades de l’enquesta es fan amb la mateixa adreça URL i afegint els paràmetres necessaris per a cada cas:

http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do

Per a la versió 3.0 del Gencat Forms s’ha afegit la possibilitat de retornar, a més dels resultats de l’enquesta, la informació dels literals dels diferents paràmetres, així com els literals de les respostes fixes (si aquests estiguessin definits), la qual cosa provoca canvis en els formats de retorn. Per mantenir la compatibilitat amb versions anteriors del Gencat Forms i evitar problemes d’integració amb tercers, per accedir als nous formats de dades s’ha d’afegir a les crides el paràmetre extra v=3. Les crides que es facin tal com es feien en la versió anterior continuen retornant els formats anteriors.

Aquest canvi afecta tots els formats de resposta, excepte la consulta en format imatge.


57

13.1 Consulta de resultats de l’enquesta amb imatges

Aquesta opció permet consultar de manera gràfica els resultats per a cadascuna de les preguntes de l’enquesta. En cas que l’enquesta només tingui una pregunta retorna una imatge en format .png amb el resultat de l’enquesta.

En el cas d’una enquesta amb diverses preguntes cal fer una petició d’una imatge per a cadascuna de les preguntes i especificar el nom del paràmetre que es vol obtenir.

Per afegir les imatges de resultats corresponents a cada paràmetre a la vostra pàgina web cal vincular-les a l’adreça URL amb què heu generat la imatge, en cap cas s’extraurà el fitxer estàtic de la imatge i s’hi apuntarà, ja que no s’actualitzaria amb les votacions dels usuaris següents que votessin a l’enquesta.

Per poder fer una crida cal passar sempre els paràmetres següents a l’URL:

- idFormulari =[identificador del formulari]

- responseFormat=img

En cas que el formulari tingui més d’un paràmetre també cal passar:

- nomParametre=[nom del paràmetre que volem consultar]

Els paràmetres següents són optatius, en cas de no incloure’ls prenen el valor per defecte:

- tipusChart=[ pie | bar | bar3D ]: escollir entre gràfic de pastís, de barres o de barres en tres dimensions (per defecte, bar).

- showIfSubmit=[ true | false ]: mostra la imatge només si la IP des d’on ens arriba la petició ha contestat l’enquesta (per defecte, true).

- style.width= amplada de la imatge en píxels (per defecte, 500).

- style.height= alçada de la imatge en píxels (per defecte, 300).

- style.bgColor= color de fons de la imatge en format hexadecimal; FFFFFF correspon al blanc (per defecte, blanc).

- style.orientation=[v|h]: vertical o horitzontal. Només vàlid per als gràfics de barres (per defecte, vertical).

- style.gradient=[true|false]: afegeix un efecte de degradat en els gràfics de barra en 2D (per defecte, false).


- lang=[xx_XX]valors possiblesdefinides respostes fixes. Si no s’indicadefecte serà el català corresponents

Tot seguit es mostren alguns

Gràfic de barres en 3D

Identificador del formulari: XX

Nom del paràmetre:

Tipus de gràfic: barres 3D

El gràfic el poden veure tots els usuaris =>

La crida quedaria de la manera següent

http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=img&tipusChart=bar3D&nomParametre=satisfaccio_eina&showIfSubmit=false

El resultat seria el següent

lang=[xx_XX]: idioma en què apareixeran les etiquetes dels diferents possibles. Només s’aplica en cas que el paràmetre tingui

definides respostes fixes. Si no s’indica aquest paràmetredefecte serà el català (en cas que estiguin definits els literals corresponents).

Tot seguit es mostren alguns exemples:

3D

Identificador del formulari: XX => idFormulari=XX

Nom del paràmetre: satisfaccio_eina => nomParametre=satisfaccio_eina

Tipus de gràfic: barres 3D => tipusChart=bar3D

l poden veure tots els usuaris => showIfSubmit=false

de la manera següent:

http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=img&tipusChart=bar3D&nomParametre=satisfaccio_eina&sho

seria el següent:

58

apareixeran les etiquetes dels diferents . Només s’aplica en cas que el paràmetre tingui

aquest paràmetre, l’idioma per en cas que estiguin definits els literals

satisfaccio_eina

http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=img&tipusChart=bar3D&nomParametre=satisfaccio_eina&sho


Gràfic de barres amb orientació horitzontal

Identificador del formulari: XX =>

Nom del paràmetre: satisfaccio_eina =>

Tipus de gràfic: barres => valor per defecte d’aquest camp és

Orientació horitzontal =>

El gràfic només el poden veure els usuaris showIfSubmit=true


http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormularesponseFormat=img&tipusChart=bar&nomParametre=satisfaccio_eina&style.orientation=h&showIfSubmit=true

El resultat seria el següent

res amb orientació horitzontal


Nom del paràmetre: satisfaccio_eina => nomParametre=satisfaccio_eina

Tipus de gràfic: barres => tipusChart=bar (podem ometre aquest valor, ja que el valor per defecte d’aquest camp és barres)

Orientació horitzontal => style.orientation=h

poden veure els usuaris que hagin contestat l’enquesta


http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormularesponseFormat=img&tipusChart=bar&nomParametre=satisfaccio_eina&style.orientation=h&showIfSubmit=true

seria el següent (si haguéssim contestat l’enquesta):

59

nomParametre=satisfaccio_eina

m ometre aquest valor, ja que el

l’enquesta =>

http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=img&tipusChart=bar&nomParametre=satisfaccio_eina&style.o


Gràfic de tipus pastís

Identificador del formulari: XX =>

Nom del paràmetre: satisfaccio_eina =>

Tipus de gràfic: pastís =>

Color de fons: #EEEEEE (css) =>

Mides: 300 x 300 (quadra

El gràfic el poden veure tots e


http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=img&tipusChart=pie&nomParametre=satisfaccio_eina&style.width=300&style.height=300&showIfSubmit=false

La resposta seria la següent

Gràfic de tipus pastís


m del paràmetre: satisfaccio_eina => nomParametre=satisfaccio_eina

Tipus de gràfic: pastís => tipusChart=pie

Color de fons: #EEEEEE (css) => style.bgColor=EEEEEE

300 (quadrat) => style.width=300&style.height=300

l poden veure tots els usuaris => showIfSubmit=false


http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=img&tipusChart=pie&nomParametre=satisfaccio_eina&style.width=300&style.height=300&showIfSubmit=false

seria la següent:

60

nomParametre=satisfaccio_eina

style.width=300&style.height=300

http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=img&tipusChart=pie&nomParametre=satisfaccio_eina&style.w


61

13.2 Consulta de resultats amb un XML

Aquesta opció ens permet obtenir un XML amb els noms dels paràmetres de l’enquesta i les respostes acumulades per cadascun dels paràmetres. Per als resultats es pot escollir entre les adreces URL base de les imatges de resultats per a cada paràmetre o bé que ens retorni el nombre les respostes per a cada paràmetre en format XML. Com ja s’ha comentat, en la versió 3.0 s’ha incorporat la possibilitat de recuperar els literals dels diferents paràmetres, així com de les diferents respostes fixes si aquestes estan definides.

En tots dos casos, si en fer la petició de l’XML es produeix algun error, el Gencat Forms retorna un XML amb un missatge de l’error.

Amb l’XML retornat es poden integrar aquestes dades amb altres aplicacions per tal de tractar-les o visualitzar-les com es vulgui.

Als apartats A.3 i A.4 de l’apèndix A apareixen les definicions dels XML generats en cada cas.



- responseFormat=xml

Opcionalment podem escollir entre rebre les adreces de les imatges de resultats (data=false) o bé rebre els resultats de cada paràmetre en format XML (data=true) i amb aquestes dades generar el gràfic, si cal; si no, s’indica el seu valor per defecte i es retornen les adreces de les imatges de resultats.

- data=true|false (per defecte, false)

Si, a més, volem recuperar la informació dels literals, haurem d’afegir el paràmetre v=3:

- v=3

Per a la versió 3 dels resultats podeu afegir també el paràmetre amb l’idioma en què voleu recuperar els literals:

- lang=xx_XX (per defecte ca_ES, català)


62

13.2.1 Consulta de resultats amb un XML amb les imatges

Amb aquesta opció s’obtenen les adreces de les imatges corresponents als resultats de l’enquesta.

En els apartats 16.4 i 16.5 hi ha la definició de l’XML de retorn.

Tot seguit es mostra un exemple de resposta XML per a una enquesta de diverses preguntes on volem saber les adreces URL de les imatges de resultats per a cada paràmetre, on XX seria l’identificador del nostre formulari.

http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=xml

<?xml version="1.0" encoding="utf-8" ?> <resultatsEnquesta> <data>2011-06-10 16:59:55</data> <response>0</response> <haRespost>false</haRespost> <parametres> <paramName>satisfaccio_eina</paramName> <paramName>enfocat_a_departament</paramName> </parametres> <urlsImatges> <url paramName='satisfaccio_eina'> http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&nomParametre=satisfaccio_eina&responseFormat=img</url> <url paramName='enfocat_a_departament'> http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX &nomParametre=enfocat_a_departament&responseFormat=img</url> </urlsImatges> </resultatsEnquesta>


63

La mateixa consulta amb el format per a la versió 3:

http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=xml&v=3

<?xml version="1.0" encoding="utf-8" ?> <resultatsEnquesta> <data>2011-06-10 17:08:00</data> <response>0</response> <haRespost>false</haRespost> <lang>ca_ES</lang> <parametres> <parametre> <paramName>satisfaccio_eina</paramName> <literal>Esteu satisfets amb l'aplicació?</literal> </parametre> <parametre> <paramName>enfocat_a_departament</paramName> <literal>Creíeu que està ben enfocat per a les necessitats del vostre departament?</literal> </parametre> </parametres> <urlsImatges> <url paramName='satisfaccio_eina'> http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&nomParametre=satisfaccio_eina&responseFormat=img</url> <url paramName='enfocat_a_departament'> http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&nomParametre=enfocat_a_departament&responseFormat=img</url> </urlsImatges> </resultatsEnquesta>


64

Tot seguit es mostra un exemple de resposta XML quan es produeix un error perquè el formulari consultat no és de tipus enquesta:

http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=xml

<?xml version="1.0" encoding="utf-8" ?> <resultatsEnquesta> <data>2011-06-10 17:14:05</data> <response>1</response> <error>nosurvey</error> </resultatsEnquesta>


65

13.2.2 Consulta de resultats amb un XML amb les dades

Amb aquesta opció s’obté un XML amb les respostes acumulades per a cada paràmetre de l’enquesta.

A l’apèndix A, dins l’apartat A.4, apareix la definició dels XML que es fan servir.

Tot seguit es mostra un exemple de resposta XML per a una enquesta de diverses preguntes on volem saber les dades dels resultats per a cada paràmetre, on XX seria l’identificador del formulari.

http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=xml&data=true

<?xml version="1.0" encoding="utf-8" ?> <dataEnquesta> <data>2011-06-10 17:17:52</data> <response>0</response> <haRespost>false</haRespost> <parametres> <paramName>satisfaccio_eina</paramName> <paramName>enfocat_a_departament</paramName> </parametres> <grafiques> <data paramName="satisfaccio_eina"> <valor> <label>Molt</label> <valor>5</valor> </valor> <valor> <label>Prou</label> <valor>3</valor> </valor> <valor> <label>Bastant</label> <valor>2</valor> </valor> <valor> <label>Poc</label> <valor>2</valor> </valor> </data> <data paramName="enfocat_a_departament"> <valor> <label>Si</label>


66

<valor>7</valor> </valor> <valor> <label>No</label> <valor>4</valor> </valor> </data> </grafiques> </dataEnquesta>

La mateixa consulta amb el format per a la versió 3:

http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=xml&data=true&v=3

<?xml version="1.0" encoding="utf-8" ?> <dataEnquesta> <data>2011-06-10 17:19:41</data> <response>0</response> <haRespost>false</haRespost> <lang>ca_ES</lang> <parametres> <parametre> <paramName>satisfaccio_eina</paramName> <literal>Esteu satisfets amb l'aplicació</literal> </parametre> <parametre> <paramName>enfocat_a_departament</paramName> <literal>Creíeu que està enfocat per a les necessitats del vostre departament?</literal> </parametre> </parametres> <grafiques> <data paramName="satisfaccio_eina"> <valor> <label>Molt</label> <valor>5</valor> <literal>Molt satisfet</literal> </valor> <valor> <label>Prou</label> <valor>3</valor> <literal>Prou satisfet</literal> </valor>


67

<valor> <label>Bastant</label> <valor>2</valor> <literal>Bastant satisfet</literal> </valor> <valor> <label>Poc</label> <valor>2</valor> <literal>Poc satisfet</literal> </valor> </data> <data paramName="enfocat_a_departament"> <valor> <label>Si</label> <valor>7</valor> <literal>Sí</literal> </valor> <valor> <label>No</label> <valor>4</valor> <literal>No</literal> </valor> </data> </grafiques> </dataEnquesta>

Tot seguit es mostra un exemple de resposta XML quan es produeix un error en consultar les dades dels resultats per a cada paràmetre, on XX és l’identificador del formulari. En aquest cas, perquè el formulari no existeix.

http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=xml&data=true

<?xml version="1.0" encoding="utf-8" ?> <dataEnquesta> <data>2011-06-10 17:22:34</data> <response>1</response> <error>noexist</error> </dataEnquesta>


68

13.3 Consulta de resultats amb un objecte JavaScript

Aquesta opció retorna la crida a una funció JS (que heu de crear) a la qual passem com a paràmetre un objecte JavaScript amb les dades de la resposta.

Permet consultar els resultats de l’enquesta i obtenir com a resposta un objecte JavaScript amb totes les dades.

Heu de crear una funció JavaScript per tractar aquestes dades i visualitzar-les, i podeu fer que les mostri gràficament o mitjançant taules.

El nom d’aquesta funció JavaScript s’ha de passar a la crida perquè, un cop hagi recuperat les dades, en pugui fer el tractament que s’hagi definit a la funció.

Es crearan un conjunt d’objectes amb totes les dades de les respostes i després s’executarà la funció JavaScript que li passem com a paràmetre de la consulta sobre la base d’aquests objectes creats.



- responseFormat=js

- callback: funció JavaScript que cal cridar

Si, a més, volem recuperar la informació dels literals, haurem d’afegir el paràmetre v=3:

- v=3

Per a la versió 3 dels resultats podeu afegir també el paràmetre amb l’idioma en què voleu recuperar els literals:

- lang=xx_XX (per defecte ca_ES, català)

Per tal d’integrar aquestes consultes amb les vostres pàgines HTML cal fer la crida a través d’un objecte script.

Tot seguit es mostra un exemple d’una crida a una enquesta, on XX és l’identificador del formulari i miFuncio és la funció que s’executarà després d’obtenir les dades de l’enquesta.

<script type='text/javascript'

src='http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=js&callback=miFuncio'> </script>


69

El format de l’objecte de resposta serà del tipus:

var enquestesInfo = {response: 0, haRespost: false, grafiques: [ {param: 'satisfaccio_eina', data:[ {label: 'Molt', valor:5 }, {label: 'Prou', valor:3 }, {label: 'Bastant', valor:2 }, {label: 'Poc', valor:2 }] }, {param: 'enfocat_a_departament', data:[ {label: 'si', valor:7}, {label: 'no', valor:4}] } ] };

On:

1. response: indica si la petició ha anat bé o malament (0: bé, 1: malament).

2. haRespost: indica si l'usuari ha respost l’enquesta; accepta els valors true o false, depenent de si l’usuari ha respost l’enquesta o no.

3. grafiques: array d’objectes amb la informació per a cadascuna de les preguntes de l’enquesta.

Cadascun dels objectes de l’array de gràfiques es compon d’un objecte format per:

- param: nom del paràmetre al formulari del Gencat Forms.

- data: array d’objectes amb els diferents valors de l’enquesta. Cadascun dels objectes es compon dels camps “label” i “valor”.


70

Per a la versió 3 (v=3), l’objecte de resposta inclou els literals dels paràmetres així com els de les respostes fixes (si aquestes estan definides). La crida anterior, afegint-hi el paràmetre v=3, quedaria de la manera següent:

var enquestesInfo = {response: 0, haRespost: false, grafiques: [ {param: "satisfaccio_eina", literal: "Esteu satisfets amb l'aplicació?, data:[ {label: 'Molt', valor:5, literal: "Molt satisfet"}, {label: 'Prou', valor:3, literal: "Prou satisfet" }, {label: 'Bastant', valor:2, literal: "Bastant satisfet" }, {label: 'Poc', valor:2, literal: "Poc satisfet"}] }, {param: 'enfocat_a_departament', literal:"Creieu que està enfocat per a les necessitats del vostre departament?", data:[ {label: 'si', valor:7, literal: "Sí"}, {label: 'no', valor:4, literal: "No"}] } ] };

Un cop recuperades totes les dades de l’enquesta, la consulta farà una crida a la funció miFuncio:

miFuncio( enquestesInfo );

El resultat final que quedaria en fer la crida seria el següent:

var enquestesGrafiques = []; //Codi de creació l'objecte ... //Crida a la funció callback miFuncio(enquestesGrafiques);


71

Si es produeix algun error en consultar les dades de l’enquesta, obtindrem un objecte JavaScript amb els detalls de l’error; el format de la resposta és el següent per a tots dos formats:

var enquestesInfo = {response: 1, error: 'nosurvey'}; miFuncio( enquestesInfo );

On:

1. Element response. El seu valor serà sempre 1, ja que s’ha produït un error.

2. Element error. El missatge d’error pot ser 'noexist' o 'nosurvey’, que indiquen respectivament que no existeix el formulari o que el formulari no és de tipus enquesta.

A l’hora de crear la funció de callback cal tenir en compte que en cas d’error també es crida.

13.4 Consulta de resultats amb un objecte JSON

Aquesta opció permet consultar els resultats de l’enquesta i obtenir com a resposta un objecte JSON amb totes les dades de les respostes, els noms i els literals dels paràmetres (per a la versió 3).

En cas que la petició no vagi correctament per alguna raó se’ns retornarà un objecte JSON amb la descripció de l’error.

El format JSON és un llenguatge ideal per a l'intercanvi de dades que permet integrar aquesta resposta amb altres aplicacions, com per exemple amb una aplicació AJAX, i tractar les dades amb JavaScript per mostrar gràficament les dades o mostrar els resultats en taules.

JSON està constituït per dues estructures:

• Una col�lecció de parelles de nom/valor. En diversos llenguatges això es coneix com un objecte, registre, estructura, diccionari, taula hash, llista de claus...

• Una llista ordenada de valors. En la majoria dels llenguatges, això s’implementa com a vectors, llistes o seqüències.

Per a més informació, consulteu http://www.json.org.


72



- responseFormat=json

Així, la crida següent:

http://www14.gencat.cat/gencat_forms/AppJava/enquesta.do?idFormulari=XX&responseFormat=json

retornaria un objecte JSON amb aquest aspecte:

{ "response":0, "haRespost":false, "grafiques":[ { "param":"satisfaccio_eina", "data":[ { "label":"Molt", "valor":5 }, { "label":"Prou", "valor":3 }, { "label":"Bastant", "valor":2 }, { "label":"Poc", "valor":2 } ] }, { "param":"enfocat_a_departament", "data":[ { "label":"Si", "valor":7 }, { "label":"No",


73

"valor":4 } ] } ] }

On:

1. response: indica si la petició ha anat bé o malament (0: bé, 1: malament).

2. haRespost: indica si l’usuari ha respost l’enquesta; accepta els valors true o false, depenent de si l’usuari ha respost l’enquesta o no.

3. grafiques: array d’objectes amb la informació per a cadascuna de les preguntes de l’enquesta.

Cadascun dels objectes de l’array params es compon de:

- param: nom del paràmetre al formulari del Gencat Forms.

- data: array d’objectes amb els diferents valors de l’enquesta. Cadascun dels objectes es compon dels camps “label” i “valor”.

Per a la versió 3 (v=3), l’objecte JSON de resposta inclou els literals dels paràmetres així com els de les respostes fixes (si aquestes estan definides). La crida anterior, afegint el paràmetre v=3, quedaria de la manera següent:

{ "response":0, "haRespost":false, "lang":"ca_ES", "grafiques":[ { "param":"satisfaccio_eina", "literal":"Esteu satisfets amb l'aplicació”, "data":[ { "label":"Molt", "valor":5, "literal":"Molt satisfet" }, {


74

"label":"Prou", "valor":3, "literal":"Prou satisfet" }, { "label":"Bastant", "valor":2, "literal":"Bastant satisfet" }, { "label":"Poc", "valor":2, "literal":"Poc satisfet" } ] }, { "param":"enfocat_a_departament", "literal":"Creieu que està enfocat per a les necessitats del vostre departament?", "data":[ { "label":"Si", "valor":7, "literal":"S:/span> }, { "label":"No", "valor":4, "literal":"No" } ] } ] }

Si es produeix algun error en consultar les dades de l’enquesta, obtindrem un objecte JSON amb els detalls de l’error amb aquest format:

{ "response":1, "error":"noexist" }


75

On:

1. Element response. El seu valor serà sempre 1, ja que s’ha produït un error.

2. Element error. El missatge d’error pot ser 'noexist' o 'nosurvey’, que indiquen respectivament que no existeix el formulari o que el formulari no és de tipus enquesta.

Com en el format JS, podem afegir també el paràmetre callback, que ens permet indicar la funció JavaScript que es cridarà amb el resultat de la consulta.


14. Canvi de contrasenya


1. Contrasenya actualclau d’accés actual.

2. Contrasenya nova:

3. Confirmació: camp obligatori. cas que no coincidnova”, quan desem d’aquesta incidència.

4. Botó “Desar”: en prémer

Canvi de contrasenya

ó de les diferents parts de la pantalla

Contrasenya actual: camp obligatori. En aquest camp hem d’introduir la nostra clau d’accés actual.

: camp obligatori. La nova clau d’accés que volem

amp obligatori. Cal tornar a introduir la nova clau d’accés. En no coincideixi amb la que hem introduït en el camp

quan desem els canvis ens sortirà un missatge d’error que ens adverteix incidència.

prémer aquest botó confirmarem el canvi de contrasenya.

76

t camp hem d’introduir la nostra

que volem.

tornar a introduir la nova clau d’accés. En amp “Contrasenya que ens adverteix

aquest botó confirmarem el canvi de contrasenya.


77

15. Preparació per a l’enviament dels formularis

A l’hora de crear un formulari al nostre portal, hem de definir els noms dels paràmetres amb el mateix nom definit al formulari del gestor de formularis, mantenint les minúscules i les majúscules correctament.

En els formularis que no siguin de tipus enquesta, els camps amb valors múltiples es desaran com un seguit de valors separats per comes.

Per exemple, si l’usuari pot escollir entre tres caselles de selecció amb el mateix name, es desarien els valors de les caselles de selecció triades separats per comes:

- opcio1,opcio2,opcio3 si l’usuari selecciona les tres.

- opcio1,opcio3, per exemple, si l’usuari en selecciona dues.

- opcio2, per exemple, si l’usuari en selecciona una.

Un altre aspecte que cal tenir en compte és la configuració del camp “meta_inf”. Aquest camp ocult és obligatori per a totes les pàgines que vulguin interactuar amb el gestor de formularis. Aquest camp ha de tenir definit l’identificador del formulari i l’idioma de petició amb l’estructura següent, la codificació és opcional: <meta-informacio> <idFormulari>[identificador del formulari]</idFormulari> <idioma>[identificador del idioma]</idioma> <encoding>[codificació que es troba la plana web]</encoding> </meta-informacio>

Els camps que inclou són els següents:

• idFormulari: identificador del formulari.

• idioma: idioma de la pàgina. L’idioma és utilitzat en mostrar els errors de validació a l'usuari.

• encoding: codificació amb què s’envien les dades; s’accepta UTF-8 i ISO-8859-1. Aquest camp és opcional.

Formularis gencat funciona per defecte amb codificació UTF-8, però també accepta el submit de formularis amb codificació ISO-8859-1 si així es declara a la gestió del formulari o al camp “meta_inf”.


78

Amb el paràmetre “encoding” es diu al Gencat Forms que forci aquesta codificació per a les dades que li arriben des del formulari HTML. Preval sobre la codificació definida al formulari i sobre les metaetiquetes de l’HTML, per tant, encara que tinguem una codificació diferent a l’edició del formulari, s’interpretarà que les dades arriben amb la codificació definida al camp “meta_inf”.

Gràcies a aquest paràmetre es pot atacar un mateix formulari del Gencat Forms des de diversos formularis del vostre web que utilitzin codificacions diferents.

Per tal que els valors dels camps es desin correctament i mantinguin accents i altres caràcters “estranys” (ç, ñ, etc.) és convenient assegurar-se que la codificació de la pàgina del formulari HTML és la mateixa que la codificació escollida en el formulari al Gencat Forms. Per garantir la compatibilitat amb tots els navegadors es recomana afegir al head de la pàgina on ubiquem el formulari la metaetiqueta següent amb la codificació pertinent (ISO-8859-1 o UTF-8), segons el cas:

<head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> ... </head>

Encara que poseu aquesta capçalera pot passar que el vostre servidor web us estigui servint la pàgina amb una altra codificació. Si dubteu sobre la codificació en què s’enviaran les dades, consulteu amb el vostre navegador la codificació utilitzada.

Si hi ha algun problema d’accents, cal emplenar el camp “encoding” en el camp ocult “meta_inf” amb la mateixa codificació en què tenim el formulari a la pàgina web.

En l’edició d’un formulari a la pestanya “Generar HTML”, podem generar un exemple de l’HTML que, amb pocs canvis, ja podríem posar al nostre portal.

Per exemple, per al cas d’un formulari amb els paràmetres següents:


79

El botó “Generar HTML” genera el codi següent (només hem afegit enctype='multipart/form-data'):

<form action='http://www14.gencat.cat/gencat_forms/AppJava/submitFormulari.do' method='post' enctype='multipart/form-data'> <p> <label>Nom</label><input name='nom' type='text'/> </p> <p> <label>Descripció</label><input name='descripcio' type='text'/> </p> <p> <label>Enter</label><input name='enter' type='text'/> </p> <p> <label>Imatge</label><input name='imatge' type='file'/> </p> <p> <label>Document</label><input name='document' type='file'/> </p> <input type='submit'/> <textarea name='meta_inf' style='display:none;'> <meta-informacio> <idFormulari>XX</idFormulari> <idioma>ca_ES</idioma> </meta-informacio> </textarea> </form>


80

El text ressaltat en verd correspon als camps del formulari. El fet de tenir camps de tipus fitxer (imatge o document) ens obliga que aquests camps siguin de tipus file; el formulari ha de tenir l’atribut enctype=’multipart/form-data’. Si no fos així, l’aplicació seria incapaç de reconèixer aquests dos camps.

El tipus de camps que genera l’aplicació són orientatius i serveixen només com a guia. Així, per exemple, amb les dades anteriors, el camp “descripció” es pot definir com una textarea, si volem que l’usuari pugui posar un text llarg.

El text ressaltat en groc correspon a la metainformació del formulari necessària perquè l’aplicació reconegui el formulari que ha de tractar.

15.1 Preparació per a l’enviament de formularis de tipus enquesta

Tota la preparació per a l’enviament de formularis establerta en el punt anterior és vàlida tenint en compte les consideracions següents:

1. En els formularis de tipus enquesta no són compatibles els paràmetres de tipus "Document" o "Imatge". Per tant, no es pot enviar cap fitxer en el formulari HTML, així que no existiran inputs de tipus ‘file’.

2. L’HTML resultant dependrà de si hem definit respostes fixes o no.

Per exemple, per a un formulari de tipus enquesta amb els paràmetres següents:


81

En el primer paràmetre hem definit les respostes fixes Poc, Bastant, Prou, Molt i accepta respostes múltiples. En el segon paràmetre no hem definit respostes fixes.

El botó “Generar HTML” genera el codi següent:

<form action='http://www14.gencat.cat/gencat_forms/AppJava/submitFormulari.do' method='post'> <p> <label>Esteu satisfets amb l'aplicació?</label><br /> <input name='satisfaccio_eina' type='checkbox' value='Molt' class='checkBox'/> Molt satisfet<br/> <input name='satisfaccio_eina' type='checkbox' value='Prou' class='checkBox'/> Prou satisfet<br/> <input name='satisfaccio_eina' type='checkbox' value='Bastant' class='checkBox'/> Bastant satisfet<br/> <input name='satisfaccio_eina' type='checkbox' value='Poc' class='checkBox'/> Poc satisfet<br/> </p> <p> <label>Creíeu que està enfocat per a les necessitats del vostre departament?</label><br /> valor1: <input name='enfocat_a_departament' type='radio' value='valor1'/><br /> valor2: <input name='enfocat_a_departament' type='radio' value='valor2'/><br /> ...<br /> valorn: <input name='enfocat_a_departament' type='radio' value='valorn'/><br /> </p> <input type='submit'/> <textarea name='meta_inf' style='display:none;'> <meta-informacio> <idFormulari>XX</idFormulari> <idioma>ca_ES</idioma> </meta-informacio> </textarea> </form>

El text ressaltat en verd correspon al paràmetre on tenim definides les respostes fixes. Atès que no tenim marcat el camp “Resposta única”, el camp utilitzat és de tipus casella de selecció. Si tinguéssim marcat el camp “Resposta única”, ens apareixeria de tipus botó d’opció.

El text ressaltat en turquesa correspon al paràmetre on no tenim definides les respostes fixes. Es mostren una sèrie de valors d’exemple: valor1, valor2 i valorn, així


com els seus corresponents literalsutilitzat és, així mateix, de tipus

El text ressaltat en groc es correspon amb la perquè l’aplicació reconegui el formulari que ha de tractar.

15.2 Errors en la validació HTML

Si tenim configurat el formulari perquèprodueixin errors en la validació produït.

Els estils d’aquesta pàgina es poden configurar full d’estils (CSS) propi.


1. Missatge d’error: eamb l’idioma indicat al camp ‘Document’) i el missatge que es correspon amb l’error de validació que s’ha produït.

2. Enllaç “Tornar”: permetque l’usuari tingui el javascript:history(-retorn s’inclouen tots els paràmetres amb els el camp “meta_inf”camps amb els valors enviats.

com els seus corresponents literals d’exemple valor1, valor2 i valorn. El tipus de camp de tipus botó d’opció, una única resposta al camp.

es correspon amb la metainformació del formulari necessàrial’aplicació reconegui el formulari que ha de tractar.

Errors en la validació HTML

formulari perquè ens doni la resposta en HTML, en cas que es rors en la validació apareixerà una pantalla amb els error

Els estils d’aquesta pàgina es poden configurar des de l’edició del formulari, afegint un


el missatge d’error consta de dues parts: el literal del camp amb l’idioma indicat al camp “meta_inf” (en l’exemple, ‘Nom’, ‘Enter’ i ‘Document’) i el missatge que es correspon amb l’error de validació que s’ha

ermet tornar a la pàgina des d’on s’ha fet la petició. que l’usuari tingui el JavaScript activat, el retorn es fa javascript:history(-1). En cas que l’usuari no tingui el JavaScriptretorn s’inclouen tots els paràmetres amb els quals s’ha fet la petició (excepte

”), per tal que el formulari d’origen pugui reconstruir els camps amb els valors enviats.

82

El tipus de camp , una única resposta al camp.

formulari necessària

, en cas que es una pantalla amb els errors que s’han

l’edició del formulari, afegint un

l missatge d’error consta de dues parts: el literal del camp (en l’exemple, ‘Nom’, ‘Enter’ i

‘Document’) i el missatge que es correspon amb l’error de validació que s’ha

la petició. En cas amb la funció

JavaScript en l’URL de la petició (excepte

origen pugui reconstruir els


83

15.3 Seguretat mitjançant un test de CAPTCHA L’eina de formularis inclou la possibilitat d’afegir un test de CAPTCHA al vostre formulari. Per activar la validació mitjançant un test de CAPTCHA heu de demanar a Suport gencat que us habiliti aquesta possibilitat en el vostre formulari. Consideracions prèvies:

- Cada test de CAPTCHA és d'un sol ús; per tant, en cas que vulgueu implementar les vostres crides al test de CAPTCHA, si hi ha un error en la validació haureu de crear el mecanisme de recàrrega de la imatge. El mode automàtic ja ho fa tot sol.

- Cada test de CAPTCHA té una vida útil de 15 minuts. Un cop exhaurit, el test de CAPTCHA deixa de ser vàlid.

L’adreça base per fer totes les crides és a través del servei: http://www14.gencat.cat/gencat_forms/AppJava/gf-captcha

Integració automàtica: Afegiu en el vostre HTML l’etiqueta <script> amb id gf_captcha_script i amb src de l’adreça base afegint-hi els paràmetres:

- idFormulari=XX, on XX és l’identificador del vostre formulari. <script id="gf_captcha_script" type="text/javascript" src="http://www14.gencat.cat/gencat_forms/AppJava/gf-captcha?idFormulari=XX"></script>

Si desitgeu que la imatge amb el test de CAPTCHA inclogui el botó de refresc, s’ha d’afegir el paràmetre refresc a l’adreça base:

- refresc=true o false, “true” si es vol que aparegui, en cas contrari “false”.

<script id="gf_captcha_script" type="text/javascript" src="http://www14.gencat.cat/gencat_forms/AppJava/gf-captcha?idFormulari=XX&refresc=true"></script>


84

Aquest script crea un HTML amb la imatge amb el test de CAPTCHA i el camp de text perquè l’usuari introdueixi el text del CAPTCHA allà on hagueu ubicat l’etiqueta <script>. <img src="..." /> <br /> <input id="gf-captcha-token" type="hidden" value="..." name="gf-captcha-token"/> <label for="gf-captcha-answer">Introduïu text de la imatge</label> <input id="gf-captcha-answer" type="text" name="gf-captcha-answer"/>

Quan l’usuari faci el submit del formulari, en cas que la resposta al test de CAPTCHA sigui incorrecta apareixerà un missatge a sota de l’HTML generat en què s’informa de l’error, i es regenerarà la imatge del test de CAPTCHA. <img src="..." /> <br /> <input id="gf-captcha-token" type="hidden" value="..." name="gf-captcha-token"/> <label for="gf-captcha-answer">Introduïu text de la imatge</label> <input id="gf-captcha-answer" type="text" name="gf-captcha-answer"/> <div id="gf-captcha-response"> La resposta del captcha és incorrecta. </div>

Per modificar el comportament de l’script podeu afegir el paràmetres següents en la crida:

- blockid=XX: on XX és l’dentificador del bloc HTML on voleu que s’incloguin els elements generats per l’script.

- lang=xx_XX: idioma dels textos. Per defecte, ca_ES (català). - resposta=alert: en cas que la resposta al test de CAPTCHA sigui

incorrecta, apareixerà el missatge de resposta incorrecta en un element emergent de tipus alert javascript.

- resposta=gform: en cas que la resposta al test de CAPTCHA sigui incorrecta, apareixerà el missatge de resposta incorrecta en la pantalla d’errors de validacions de formularis.

- resposta=XX: qualsevol altre valor (XX) indica l’identificador del bloc HTML on voleu que aparegui el missatge de resposta incorrecta al test de CAPTCHA.

Algunes consideracions:

- Aquesta opció només és vàlida amb l’aplicació funcionant amb el JavaScript activat.


85

- Si passeu els valors blockid i/o resposta=XX tingueu en compte que l’script generat neteja completament el contingut d’aquest bloc abans d’afegir el contingut.

- En el cas de resposta=gform, en l’enllaç de la pàgina de validacions ‘Tornar’ no es retorna mai amb JavaScript per evitar problemes en el refresc del test de CAPTCHA.

Integració amb JSON Podeu recuperar les dades del test de CAPTCHA amb format JSON per poder fer la integració del test de CAPTCHA manualment. A la crida base s’han d’afegir els paràmetres següents:

- idFormulari=XX, on XX és l’identificador del vostre formulari. - format=json.

La crida retornarà una resposta JSON amb el següent: { "gf_captcha_token":"[TOKEN]", "gf_captcha_img":"[URL_IMATGE]", "gf_captcha_action":"[URL_ACTION]" }

On:

- [TOKEN]: és el token que s’ha de passar per validar que la resposta de l’usuari es correspon amb la imatge del test de CAPTCHA.

- [URL_IMATGE]: adreça web des d’on podeu accedir a la imatge del test de CAPTCHA.

- [URL_ACTION]: adreça web on s’ha d’enviar la petició de validació del test de CAPTCHA.

Per validar el test de CAPTCHA heu de fer una crida a l’adreça passada en el paràmetre gf_captcha_action amb els paràmetres següents:

- gf-captcha-token: és el token de la petició (el que se us ha passat inicialment).

- gf-captcha-answer: és la resposta de l'usuari. Si feu la petició mitjançant GET heu d’afegir, a més, el paràmetre:

- gf-captcha-validate=true. L’acció de validació retornarà un objecte JSON amb el format següent:


86

- {"res":"ok"}: si la resposta és correcta. - {"res":"ko"}: si la resposta no és correcta.

Si el que es vol es fer la integració amb JSON via JavaScript, podeu afegir a les dues crides (obtenció de token i validació de resposta), el paràmetre callback amb el nom de la funció JavaScript que rebrà com a paràmetre l’objecte JSON corresponent. Així doncs, si per exemple en el JavaScript tenim definides les funcions:

- mostrarCaptcha(jsonData) (per pintar els camps del test de CAPTCHA al formulari)

- resultatCaptcha(jsonData) (per mostrar un missatge de test de CAPTCHA incorrecte si l’usuari no respon correctament el test de CAPTCHA)

a les crides s’haurien d’afegir els paràmetres següents: Obtenció del test de CAPTCHA:

- idFormulari=XX - format=json - callback=mostrarCaptcha

Validació del test de CAPTCHA:

- format=json - gf-captcha-token - gf-captcha-answer - gf-captcha-validate=true (si feu la validació mitjançant GET) - callback=resultatCaptcha


87

16. Apèndix A. Sortides XML

16.1 Generar XML Aquest fitxer és l’utilitzat per a la integració amb els formularis GECO. El format de l’XML resultant és el següent: GForm:


88

GForm -> Parametres:

GForm -> Parametres -> Validacions


89

GForm -> Parametres -> Validacions -> RespostaFixa

Element/@Atribut Descripció Consideracions

GForm Element arrel del document

Id Identificador del formulari

Nom Nom del formulari

Description Descripció del formulari Opcional.

Encoding Codificació per defecte utf-8 | iso-8859-1. Per defecte, UTF-8.

Survey Formulari de tipus enquesta true | false. Per defecte, false.

Captched Formulari amb validació mitjançant test de CAPTCHA

true | false. Per defecte, false.

Idiomes[IDS] Llistat d’idiomes en què estan disponibles els literals del formulari

[IDS]/Idioma Cadascun dels idiomes en què estan disponibles els literals dels formularis

En format xx_XX, on xx és el codi de l’idioma i XX el del país.

Parametres[PS] Llistat de paràmetres del formulari

[PS]/Parametre[P] Cadascun dels paràmetres

[P]/Nom Nom del paràmetre

[P]/Literals[LTS] Llistat de literals del paràmetre

[LTS]/Literal[LT] Cadascun dels literals del paràmetre


90

[LT]/Idioma Idioma del literal En format xx_XX, on xx és el codi de l’idioma i XX el del país.

[LT]/Valor Text del literal

[P]/Validacions[V] Conjunt de validacions que s’apliquen al paràmetre

[V]/Tamany Mida màxima del camp 1 – n. El valor 0 indica que no s’aplica cap tipus de validació.

[V]/Obligatori Indica si el camp és obligatori o no


[V]/Unique Indica si el valor del camp ha de ser únic o no


[V]/TipusValidacio Tipus de paràmetre Valors possibles: String: camp de text (valor per defecte) Natural: nombre natural Enter: nombre enter Real: nombre real Mail: adreça electrònica URL: adreça web Data: data en format dd/MM/yyyy Hora: hora en format HH:mm Data-Hora: data i hora en format: dd/MM/yyyy HH:mm NIF-CIF-NIE: qualsevol dels tres tipus de document Document: camp de tipus fitxer de text (Word, PDF, .docx, .odt) Image: camp de tipus fitxer d’imatge (PNG, GIF o JPG)

[V]/EnviarCorreu Indica si al valor del camp se li envia un correu electrònic de confirmació

true | false. Per defecte, false. Aquesta propietat només té sentit per als camps de tipus correu electrònic.

[V]/RespostaFixa[RF] Llistat de respostes obligatòries al paràmetre

Opcional.

[RF]/RespostaSimple Indica si el paràmetre admet un únic valor o més d’un

true|false.


91

[RF]/Opcions[OPS] Llistat de les opcions

[OPS]/Opcio[O] Cadascuna de les opcions

[O]/Valor Valor de l’opció

[O]/Literals[LTS] Llistat de literals per a l’opció

[LTS]/Literal[LT] Cadascun del literals de l’opció




92

16.2 Exportar XML Aquest format és l’utilitzat per a la importació dels formularis. GForm:


93

GForm -> Resposta

GForm -> AutoResposta


94

GForm -> Parametres

GForm -> Parametres -> RespostaFixa


95

GForm -> GestioRegistres


GForm Element arrel del document

Nom Nom del formulari

Description Descripció del formulari Opcional.

Encoding Codificació per defecte utf-8 | iso-8859-1. Per defecte, UTF-8.

TempsSegureat Temps de seguretat entre peticions

Opcional. 0 o negatiu no s’aplica.

Resposta[R] Definició del tipus de resposta

[R]/Tipus Tipus de sortida HTML | XML.

[R]/PaginesOK[POKS] Llistat de pàgines OK Només s’aplica en cas que la resposta sigui de tipus HTML. Una per a cadascun dels idiomes.

[POKS]/PaginaOK[POK] Cadascuna de les pàgines


96

[POK]/Idioma Idioma de la pàgina En format xx_XX, on xx és el codi de l’idioma i XX el del país.

[POK]/Url URL de la pàgina en l’idioma corresponent

[R]/CssValidacio URL del full d’estils que cal aplicar en la pàgina d’errors de validació

Opcional. Només s’aplica en cas que el tipus de resposta sigui HTML.

EnviarSubmitMail Indica si s’ha d’enviar un correu a l’usuari del nostre formulari


AutoResposta[AR] Llistat dels missatges que cal enviar als usuaris

Opcional. Només s’aplica en el cas que l’opció “EnviarSubmitMail” sigui true.

[AR]Missatge[M] Cadascun dels missatges

Un per a cadascun dels idiomes configurats en el formulari.

[M]/Idioma Idioma del missatge En format xx_XX, on xx és el codi de l’idioma i XX el del país.

[M]/Subject Assumpte del missatge

[M]/Body Cos del missatge

Survey Formulari de tipus enquesta


OneVotePerIP Indica si des d’una mateixa IP només es pot fer una petició al formulari.


Captched Formulari amb validació mitjançant test de CAPTCHA.


Idiomes[IDS] Llistat d’idiomes en què estan disponibles els literals del formulari

[IDS]/Idioma/Id Cadascun dels idiomes en què estan disponibles els literals dels formulari


Referents[R] Llistat d’URL des d’on poden rebre peticions

Opcional.

[R]/Url/Address Cadascuna de les adreces URL

Parametres[PS] Llistat de paràmetres del formulari


97

[PS]/Parametre[P] Cadascun dels paràmetres

[P]/Nom Nom del paràmetre

[P]/Tamany Mida màxima del camp 1 – n. El valor 0 indica que no s’aplica cap tipus de validació.

[P]/Obligatori Indica si el camp és obligatori o no


[P]/Unique Indica si el valor del camp ha de ser únic o no


[P]/TipusValidacio Tipus de paràmetre Valors possibles: String: camp de text (valor per defecte) Natural: nombre natural Enter: nombre enter Real: nombre real Mail: adreça electrònica URL: adreça web Data: data en format dd/MM/yyyy Hora: hora en format HH:mm Data-Hora: data i hora en format: dd/MM/yyyy HH:mm NIF-CIF-NIE: qualsevol dels tres tipus de document Document: camp de tipus fitxer de text (Word, PDF, .docx, .odt) Image: camp de tipus fitxer d’imatge (PNG, GIF o JPG)

[P]/EnviarCorreu Indica si al valor del camp se li envia un correu electrònic de confirmació

true | false. Per defecte, false. Aquesta propietat només s’aplica als camps de tipus correu electrònic.

[P]/RespostaFixa[RF] Llistat de respostes obligatòries al paràmetre

Opcional.

[RF]/RespostaSimple Indica si el paràmetre admet un únic valor o més d’un

true|false.


98

[RF]/Opcions[OPS] Llistat d’opcions

[OPS]/Opcio[O] Cadascuna de les opcions

[O]/Valor Valor de l’opció

[O]/Literals[LTS] Llistat de literals per a l’opció

[LTS]/Literal[LT] Cadascun del literals de l’opció



[P]/Literals[LTS] Llistat de literals del paràmetre

[LTS]/Literal[LT] Cadascun dels literals del paràmetre


GestioRegistres[GR] Element que engloba la forma en què es gestionen els diferents registres que rep un butlletí

[GR]/MaxRegistres Nombre màxim de registres permesos

Opcional.

[GR]/SendIfMaxRegistres Adreça de correu de l’usuari a qui s’enviarà un correu si se supera el màxim de registres

Opcional. Només s’aplica en cas que tinguem un nombre màxim de registres indicat.

[GR]/MissatgesRegistres[MS]

Llistat de missatges en el cas que se superi el nombre màxim de registres

Opcional. Només s’aplica en cas que tinguem un nombre màxim de registres indicat.

[MS]/MissatgeRegistre[MR] Cadascun dels missatges

Un per idioma com a màxim.

[MR]/Idioma Idioma del missatge En format xx_XX, on xx és el codi de l’idioma i XX el del país.

[MR]/Texte Text del missatge

[GR]/Emmagatzematge Indica si els registres són en base de dades o no

true | false.


99

[GR]/NotificacionsCorreu[N] Indica si els registres s’han d’enviar al correu o no

Opcional.

[N]/Subject Assumpte del correu amb les dades del registre

[N]/Busties[BS] Llistat d’adreces electròniques a les quals s’han d’enviar les dades dels registres

[BS]/Bustia Cadascuna de les adreces electròniques a les quals cal enviar el correu


100

16.3 Resposta XML del formulari

En cas que les dades del formulari s’hagin inserit correctament, la resposta serà:

<?xml version="1.0" encoding="UTF-8" ?> <gencatForms> <response>0</response> <idFormulari>XX</idFormulari> </gencatForms>

On:

1. Element response: el seu valor serà sempre 0.

2. Element idFormulari: identificador del formulari sobre el qual acabem d’introduir un nou registre.

En cas que s’hagi produït algun error en la validació en els paràmetres, el format de la resposta serà el següent:

<?xml version="1.0" encoding="UTF-8" ?> <gencatForms> <response>1</response> <idFormulari>XX</idFormulari> <errors> <error> <paramName>nom</paramName> <missatge>Nom és un camp obligatori.</missatge> </error> <error> <paramName>enter</paramName> <missatge>Enter ha de ser un nombre enter.</missatge> </error> <error> <paramName>document</paramName> <missatge>Document és un document invàlid. Per motius de seguretat, només s'accepten fitxers amb extensió *.doc, *.docx, *.pdf o *.odt</missatge> </error> </errors>


101

</gencatForms>

On:

1. Element response: el seu valor serà sempre 1.

2. Element idFormulari: identificador del formulari sobre el qual volem introduir un nou registre.

3. Element errors: llistat dels errors de validació que s’han produït.

4. Elements error: cadascun dels errors de validació que s’han produït. Consta de dos camps:

a) paramName: identificador del camp sobre el qual s’ha produït l’error de validació.

b) missatge: missatge amb l’error de validació que s’ha produït en l’idioma en què s’ha enviat la petició (camp idioma del camp meta_inf).

En cas que l’error sigui del formulari en general:

- Màxim de registres superats.

- Adreces URL referents incorrectes.

- Error en el test de CAPTCHA.

- Temps de seguretat entre peticions.

- Altres errors inesperats.

El format de sortida és similar a l’anterior, però sense incloure la informació dels paràmetres.

<?xml version="1.0" encoding="UTF-8" ?> <gencatForms> <response>1</response> <idFormulari>XX</idFormulari> <errors> <error> S'ha excedit el mษm nombre de registres suportat


102

per el formulari. </error> </errors> </gencatForms>


103

16.4 Consulta XML d’imatges d’una enquesta


resultatsEnquesta Element arrel del document

data Data en què s’ha fet la petició En format: yyyy-mm-dd hh:mi:ss

response Indica si la petició ha anat bé o malament

0: correcte, 1: incorrecte.

haRespost Indica si l'usuari ha respost l’enquesta

true | false.

parametres[PS] Llistat de paràmetres del formulari

[PS]/paramName Nom de cadascun dels paràmetres

urlsImatges[US] Llistat de cadascuna de les adreces URL amb imatges

Una per a cadascun dels paràmetres.

[US]/url URL de cadascuna de les adreces URL

[US]/url@paramName Paràmetre al qual correspon l’adreça URL

error Missatge d'error Entre ells: noexist | nosurvey. Indiquen, respectivament, que el formulari no existeix o que el formulari no és de tipus enquesta.


104

16.5 Consulta XML d’imatges v3


resultatsEnquesta Element arrel del document


response Indica si la petició ha anat bé o malament



true | false.

lang Idioma en què es retornen els literals



[PS]/parametre[P] Cadascun del paràmetres

[P]/paramName Nom del paràmetre

[P]/literal Literal del paràmetre en l’idioma indicat en l’element lang

urlsImatges[US] Llistat de cadascuna de les adreces URL amb imatges



105

[US]/url URL de cadascuna de les adreces URL

[US]/url@paramName Paràmetre al qual correspon l’adreça URL


16.6 Consulta XML de dades d’una enquesta


dadesEnquesta Element arrel del document


response Ens indica si la petició ha anat bé o malament



106


true | false.


[PS]/paramName Nom de cadascun dels paràmetres

grafiques[GS] Llistat dels valors de l’enquesta


[GS]/data[D] Dades per a cadascun dels paràmetres

[GS]/data@paramName

Paràmetre al qual correspon l’adreça URL

[D]/valor[V] Cadascun dels valors per a cada opció

[V]/label Valor de l’opció

[V]/valor Nombre d’ocurrències del valor



107

16.7 Consulta XML de dades d’una enquesta v3 dataEnquesta

dataEnquesta -> grafiques


108


dadesEnquesta Element arrel del document


response Ens indica si la petició ha anat bé o malament



true | false.

lang Idioma en què es retornen els literals



[PS]/parametre[P] Cadascun del paràmetres

[P]/paramName Nom del paràmetre

[P]/literal Literal del paràmetre en l’idioma indicat en l’element lang

grafiques[GS] Llistat dels valors de l’enquesta


[GS]/data[D] Dades per a cadascun dels paràmetres

[GS]/data@paramName

Paràmetre al qual correspon l’adreça URL

[D]/valor[V] Cadascun dels valors per a cada opció

[V]/label Valor de l’opció

[V]/valor Nombre d’ocurrències del valor

[V]/literal Literal (si existeix) de la resposta

Si el literal no existeix, es retorna el mateix valor de l’element label.


Manual d’usuari Versió 3 · 2014-01-28 · Via Laietana, 14 08003 Barcelona Tel. 93 567 63 30...

Documents

Transcript of Manual d’usuari Versió 3 · 2014-01-28 · Via Laietana, 14 08003 Barcelona Tel. 93 567 63 30...