Guia pas-a-pas per la creació de un formulari específic a partir del formulari genèric

GSIT

Guia pas-a-pas per la creació de un

formulari

específic

a

partir

del

formulari genèric

Tema/Detall: Descripció i detall pas a pas de com crear un formulari específic a partir del formulari genèric

Llista de Distribució:

Nom del Fitxer: GSIT-FormGeneric-CreacioFormulariEspecific

Versió Data Autor Comentaris

V1.0 10/02/2014 Ana Gutiérrez Creació del document

V2.0 02/05/2016 Susana Llano Álvarez Ampliació, millora i actualització del document

V3.0 17/06/2016 Susana Llano Álvarez Actualització del document amb la millora de les _{botoneres i la generació de l’acusament de} rebuda

Aprovació Data Signatura

Preparat Revisat Aprovat Autoritzar

Nom Signatura Data

1 INTRODUCCIÓ... 3

2 CREACIÓ D’UN FORMULARI ESPECÍFIC A PARTIR DEL GEN004 ... 4

3 OBTENCIÓ DEL GEN004 I FW I RUTA ON POSAR ELS ARXIUS ... 5

3.1 OBTENCIÓ DEL CODI FONT DEL GEN004... 5

3.2 ON DESAR EL CODI DEL GEN004 AL FW PER FER L’ESPECÍFIC ... 8

4 CREACIÓ DEL NOU FORMULARI ... 9

4.1 MODIFICACIÓ DE L’ESQUEMA DE DADES ... 9

4.2 MODIFICACIÓ DEL FORMULARI DE SOL·LICITUD ... 10

4.2.1 Creació de nous camps ... 10

4.2.1.1 Afegir camps a una pàgina del GEN004 ... 10

4.2.1.2 Crear una nova pàgina de dades al GEN004 ... 12

4.2.1.3 Creació de la funcionalitat de validació de pàgina dels nous camps ... 13

4.2.2 Creació de nova funcionalitat ... 14

4.2.3 Modificacions a les botoneres de les pàgines ... 15

4.2.3.1 Botoneres de pàgines modificades del GEN004 ... 15

4.2.3.1.1 Anterior i Següent ... 15

4.2.3.1.2 Esborra les dades ... 15

4.2.3.2 Botoneres de pàgines noves del GEN004 ... 16

4.2.3.2.1 Anterior i Següent ... 17

4.2.3.2.2 Esborra les dades ... 17

1 Introducció

Aquest document està dirigit a les factories que vulguin crear un formulari específica a partir del formulari genèric, ja que descriu la manera de fer-ho. Quan s’estén el formulari genèric per crear un formulari específic lo que es pot fer és afegir noves dades particulars al formulari genèric però sense canviar o treure res del que té definit el formulari genèric.

Les noves dades particulars que s’afegeixen seran dades que no han d’afectar a la funcionalitat ja desenvolupada del formulari genèric o a les seves dades, per lo que només es poden afegir dins el node de l’esquema de dades de GSIT Cos->Contingut->DadesParticulars.

Qualsevol modificació del formulari genèric que no sigui afegir noves dades particulars definides dins del node de l’esquema Cos->Contingut->DadesParticulars surt fora de l’abast d’aquest document.

ATENCIÓ: No és pot modificar o treure el codi del formulari genèric ja desenvolupat.

Qualsevol modificació realitzada sobre el formulari genèric no contemplada en aquest document surt fora de la creació d’un formulari específic a partir del formulari genèric i per tant des de la oficina tècnica de GSIT no es donarà suport a cap modificació no contemplada en aquest document.

En cas de dubte a la generació d’un formulari específic a partir del formulari genèric podeu preguntar els vostres dubtes a la Oficina Tècnica de formularis GSIT mitjançant la creació d’un tiquet a la pàgina web de suport: http://suport.gencat.cat

2 Creació d’un formulari específic a partir del GEN004

Lo primer que es necessita per poder fer un formulari específic a partir del formulari genèric és aconseguir tot el codi i la informació necessària del:

 GEN004

 Framework de formularis GSIT

Un cop es té el codi, i tal com s’ha comentat a l’apartat anterior quan s’estén el formulari genèric per crear un formulari específic la única cosa que es pot fer és afegir noves dades particulars però sense canviar o treure res del que té definit el formulari genèric.

Per tal d’afegir noves dades particulars al formulari genèric s’han de realitzar les següents modificacions al formulari genèric:

 Modificacions a l’esquema de dades:

o Afegir els nous camps referents a les noves dades únicament al node de l’esquema: Cos->Contingut->DadesParticulars

 Modificacions al formulari:

o Afegir les noves dades al formulari de sol·licitud i de l’acusament i la funcionalitat requerida per aquestes dades.

o Definir correctament les botoneres de les planes al formulari de sol·licitud.

S’especificarà en detall en els següents apartats del document com realitzar aquestes modificacions.

IMPORTANT: El formulari que es generi serà un formulari específic

Encara que el formulari base sigui el formulari genèric, el nou formulari generat un cop modificat el genèric serà un formulari específic per el que els passos que s’han de seguir per la seva publicació són els mateixos que per qualsevol formulari específic: Publicació a PRE, Validació QA i Publicació a PRO.

3 Obtenció del GEN004 i FW i ruta on posar els arxius

3.1 Obtenció del Codi font del GEN004

Per tal de crear un formulari específic s’ha de disposar de la última versió del codi font del formulari genèric. Es pot obtenir aquest codi font a la GSITPèdia: http://gsitpedia.gencat.cat/

A la GSITPèdia s’ha de clicar al menú lateral “Plataforma de tramitació en línia – Documentació”:

Perquè ens posicioni a la secció del Formulari genèric exprés

I podem clicar a Codi Font per tal de descarregar-lo. Ens descarregarà el fitxer codiFontGEN004.rar Quan es descomprimeix es pot veure que conté els següents fitxers:

Detallant cada component:

 GEN004 scriptObjects: Conté tots els mòduls de codi propis del formulari genèric

 GEN004_CA.rar: Conté els fitxers XDP i PDF del formulari de sol·licitud i els fitxers XDP i PDF del formulari d’acusament de rebuda del formulari genèric en català.

 GEN004_ES.rar: Conté els fitxers XDP i PDF del formulari de sol·licitud i els fitxers XDP i PDF del formulari d’acusament de rebuda del formulari genèric en castellà.

 GEN004_EN.rar: Conté els fitxers XDP i PDF del formulari de sol·licitud i els fitxers XDP i PDF del formulari d’acusament de rebuda del formulari genèric en anglès.

 Fitxers de l’esquema de dades

o OGE.xsd: Fitxer principal de l’esquema de dades i que està vinculat als PDFs.

o OGE_DadesParticulars.xsd: Fitxer de l’esquema de dades que defineix la informació pròpia de dades particulars.

 Fitxers de l’esquema de dades

o GEN004-InfoVersio.pdf: Document que detalla la informació sobre la nova versió del formulari genèric GEN004: Novetats i millores

o GEN004-InfoEsquema.pdf: Document que definiex en detall de les dades particulars de l'esquema de dades del formulari genèric GEN004

IMPORTANT: Cal tenir en compte la versió del FW relacionada amb la versió del GEN004

Cada versió del formulari genèric GEN004 necessita vincular-se a una versió determinada del Framework

de formularis GSIT per tal de funcionar correctament. Per la versió que fem servir del GEN004 hem de

mirar el seu document GEN004-InfoVersio.docx per veure la versió de FW necessària.

El Framework de formularis GSIT es pot obtenir a la GSITPèdia: http://gsitpedia.gencat.cat/ (Recordeu que per accedir a la GSITPèdia, cal disposar d’accés vpn xCat).

De forma equivalent a com s’ha obtingut el codi del GEN004. en el menú lateral a l’apartat “Plataforma de

3.2 On desar el codi del GEN004 al FW per fer l’específic

Un cop tinguem el Framework de formularis GSIT necessari s’ha de crear una nova carpeta amb el nom del nou tràmit dins del seu directori ePanells\formularis\fonts\formularis

Per exemple en aquest cas NOU_TRAMIT

Dins d’aquesta carpeta s’ha de posar tot el codi del formulari GEN004 i extreure els formularis de l’idioma que necessitem: GEN004_CA.rar, GEN004_ES.rar i/o GEN004_EN.rar El directori ha de quedar:

D’aquesta manera els mòduls del GEN004 i del FW de formularis GSIT estaran correctament vinculats. Si es vol es pot modificar el nom dels fitxer XDP i PDF per posar un nom adient al tràmit que s’ha de fer, però són els únics fitxers que es poden modificar.

ATENCIÓ: Els fitxers XSD i els del directori GEN004 scriptObjects NO es poden modificar

4 Creació del nou formulari

4.1 Modificació de l’esquema de dades

Per afegir els nous camps a l’esquema de dades s’ha de modificar l’arxiu OGE_DadesParticulars.xsd.

ATENCIÓ: El fitxer d’esquema OGE.xsd no s’ha de modificar

Aquest fitxer no s’ha de modificar res. Totes les modificacions de l’esquema de dades s’han de realitzar al fitxer OGE_DadesParticulars.xsd

Dins aquest arxiu s’han d’afegir les noves dades particulars, creant en la posició que s’indica a continuació els nous nodes, en aquest cas s’ha creat un nou amb el nom NovesDades:

Un cop creat el nou node, com en aquest cas és de tipus TipusNovesDades es defineix aquest nou tipus, per exemple:

IMPORTANT: Tenir en compte les vinculacions a l’esquema als PDF de sol·licitud i d’acusament

S’ha de tenir en compte que tant en la sol·licitud com a l’acusament de rebuda els nous camps han d’estar correctament relacionats amb l’esquema de dades.

4.2 Modificació del formulari de sol·licitud

4.2.1 Creació de nous camps

Per afegir les noves dades particulars al formulari tenim dues opcions:  Afegir camps a una pàgina del GEN004.

 Crear una nova plana de dades al GEN004.

Per ambdós casos s’ha de tenir en compte si cal afegir una validació pròpia per aquests camps per al moment de validar la pàgina i per la validació final del formulari. Veure 4.2.1.3 Creació de la funcionalitat de validació de pàgina dels nous camps

4.2.1.1

Afegir camps a una pàgina del GEN004

Si s’han de crear noves dades a una pàgina ja existent es col·locaran a la posició corresponent dins d’un nou subformulari que també es crearà. Mai es situaran les noves dades dintre de un subformulari del GEN004.

ATENCIÓ: No fer cap modificació als panells del GEN004

Encara que es creïn nous camps a les pàgines existents del formulari, els seus panells no es poden modificar en cap sentit. No es poden afegir, esborrar, ocultar o modificar els camps que ja té.

Per exemple, si es vol afegir una nova secció amb 3 camps: Descripció, Import sol·licitat i Import

concedit crearem un nou subformulari NOVES_DADES i el situarem dins la pàgina corresponent del

GEN004 a la posició que toca però mai dins d’un subformulari. En aquest cas es crearà a la pàgina de

Aquests camps es vincularan als nodes corresponents de l’esquema de dades que s’hauran creat com s’indica a l’apartat d’aquest document 4.1 Modificació de l’esquema de dades.

El que s’ha de tenir en compte per al nou panell és que si s’ha creat dins la pàgina contacteAvisos, com és el cas de l’exemple que s’ha fet, s’ha de definir al mòdul scoOGEPar el panell amb una nova variable, per exemple: opanellNovesDades.

I posar-la dins de l’array aPanellsPagAvisos tenint en compte que l’ordre dels panells a l’array ha de ser el mateix que el dels panells a la pàgina. En aquest cas com s’ha creat entre la secció de Dades de l’establiment i la de Activitat econòmica posarem opanellNovesDades entre oPanellEstabliment i oPanellActEconomica.

IMPORTANT: No modificar el scoOGEPar si no es canvia la pàgina contacteAvisos

Si els nous camps s’afegeixen a una nova pàgina no s’han de realitzar aquestes modificacions al mòdul scoOGEPar.

S’ha de tenir en compte que les noves seccions poden fer que calgui modificar el codi de les botones de les pàgines modificades. La manera de definir el codi per cascun dels seus s’explicarà en detall com fer-ho a l’apartat d’aquest document: 4.2.3.1 Botoneres de pàgines modificades del GEN004

4.2.1.2

Crear una nova pàgina de dades al GEN004

Si s’ha de crear una nova pàgina de dades pròpies per al formulari, creem la pàgina a la posició corresponent del formulari, per exemple si volem crear la nova pàgina dadesParticulars entre la pàgina

contacteAvisos i validacio es tindrà:

Aquesta nova plana creada ha de tenir les següents propietats:

Dins d’aquesta pàgina es poden crear els subformularis que siguin necessaris. Les noves dades creades han de seguir tots els requeriments marcats pel framework de formularis GSIT, podeu trobar tots els requeriments dintre de la documentació del framework de formularis GSIT.

Els nous camps que es creïn a aquesta pàgina vincularan als nodes corresponents de l’esquema de dades que s’hauran creat com s’indica a l’apartat d’aquest document 4.1 Modificació de l’esquema de dades.

IMPORTANT: S’ha de modificar l’arry arrayPagines de scoGSITPar

Al crear la nova o noves planes, lo que s’ha de modificar és la variable arrayPagines del mòdul

scoGSITPar per incloure la nova plana o planes que s’hagin afegit. S’ha de tenir en compte que l’ordre del

Per exemple per la que hem creat dadesParticulars com està entre la pàgina contacteAvisos i validacio la definirem a l’array:

A les noves planes que es creïn al formulari s’han d’afegir el panell BOTONERA_INTERMEDIA propi del Framework de formularis GSIT al final de cadascuna.

S’ha de tenir en compte que el botó de Netejar plana al formulari s’ha de dir Esborra les dades. La manera de definir el codi per cascun dels seus botons serà com en qualsevol altre formulari GSIT, de totes maneres s’explicarà en detall com fer-ho a l’apartat d’aquest document: 4.2.3.2 Botoneres de pàgines noves del GEN004.

4.2.1.3

Creació de la funcionalitat de validació de pàgina dels nous camps

Una altre cosa a tenir en compte per les noves dades tant si són afegides a una pàgina existent com si es crea una de nova és si cal que es faci alguna validació pròpia per aquestes dades i que s’hagi de realitzar en el moment de validar la pàgina i en el de la validació final del formulari.

Per exemple si les noves dades tenen 3 camps de possible contacte i cal comprovar que s’ha omplert 1 d’ells: telèfon, mòbil o e-mail. En aquest cas s’hauria de crear a un mòdul de codi propi del formulari per exemple scoDadesParticulars la funció que realitzes aquestes validacions pròpies de les noves dades de la pàgina: validaPAGINA_DADES_PATICULARS()

Si és per una pàgina nova que s’ha creat s’hauria de definir a mapaFuncionsValidacio del mòdul

En cas de ser una nova validació per dades que hem afegit a una pàgina ja existent lo que s’haurà de fer és afegir la nova funció a la que té la pàgina. Per exemple si les noves dades s’han creat a la pàgina

contacteAvisos podem veure que aquesta pàgina ja té definida una funció:

Per tant lo que s’ha de fer és afegir la nova funció darrera la que té:

En cas de que les dades s’afegeixin a una pàgina existent del formulari pot ser que aquesta pàgina no tingui una funció de validació definida a nivell de pàgina per lo que no estarà definida a

mapaFuncionsValidacio en aquest cas si volem afegir una funció s’haurà de fer de manera equivalent a si

hem creat la pàgina nova, s’afegirà la pàgina a la posició corresponent que té al formulari i la seva funció.

ATENCIÓ: No s’han de modificar la resta de funcions definides a mapaFuncionsValidacio

Es poden afegir les noves funcions relacionades amb les dades que s’afegeixen al formulari però mai s’han de modificar les que ja té definides el formulari.

4.2.2 Creació de nova funcionalitat

Pot ser necessari afegir nova funcionalitat al formulari relacionada amb els nous camps que s’afegeixen. Per afegir aquest nou codi s’hauran de crear nous mòduls de codi o script object.

Per exemple, es pot crear un nou script object scoDadesParticulars on definir tot el codi propi necessari per aquestes noves dades del formulari:

IMPORTANT: No s’han de modificar mai els mòduls de codi del GEN004 ni del FW GSIT

Si aquestes noves dades requereixen un codi propi per executar funcionalitats s’han de crear sempre nous mòduls (scripts objects). Mai es modificaran els mòduls del GEN004 o del Framework de formularis GSIT.

4.2.3 Modificacions a les botoneres de les pàgines

Una cop s’han creat els nous camps i seccions i si cal les noves planes el que s’ha de fer és comprovar el correcte funcionament de les botoneres de les planes afectades, no solament de les modificades o les noves.

En els següents apartats s’indica com s’ha de procedir segons si s’ha creat una nova plana amb les dades particulars del formulari o bé si s’han creat dins d’una plana del formulari genèric.

4.2.3.1

Botoneres de pàgines modificades del GEN004

4.2.3.1.1 Anterior i Següent

Si mirem el codi que tenen els botons de la pàgina que hem modificat tindrem per cada botó:  Següent: scoSBSBotonera.planaSeguent(this);

 Anterior: scoSBSBotonera.planaAnterior(this);

Aquest codi no s’ha de modificar, ja que aquestes funcions ja busquen els 1º camp visible de la pàgina anterior o següent, segons quin botó sigui, per tal de posicionar-se al camp. Per tant no hem de fer res per aquests botons.

4.2.3.1.2 Esborra les dades

En el cas del botó Esborra les dades sempre s’ha de posar el codi per esborrar aquestes noves dades de la pàgina independentment de la seva situació a la pàgina.

Si mirem el codi que tenen els botons Esborra les dades al formulari veurem que és del tipus: scoOGENeteja.netejaPlanaNOM_PAGINA();

Aquest codi de l’event del botó no s’ha de modificar. Per fer les modificacions adients per definir el correcte funcionament per tal que esborri també aquestes noves dades, s’ha de modificar la funció que esborra la plana. Per això, cal que al script object scoOGENeteja i dins de la funció de neteja de la plana s’ha d’afegir la nova funció per netejar les noves dades que s’haurà creat a un mòdul de codi propi.

Per exemple, si s’ha creat NOVES_DADES a la pàgina contacteAvisos s’ha d’anar a la funció d’aquesta plana: netejaPlanaContacteAvisos de scoOGENeteja i sota el codi que ja té aquesta funció s’ha de definir la crida a la nova funció per esborrar les noves dades.

Per exemple en aquest cas podria ser: scoDadesParticulars.netejaNOVES_DADES();

ATENCIÓ: No s’han de modificar o treure les altres crides de neteja de la funció

Només s’ha d’afegir al final de la funció la crida a la nova funció o funcions de neteja dels nous camps, les crides de neteja dels panells del formulari genèric no s’han de modificar ni treure. Tampoc canviar-les d’ordre ja que pot provocar que el formulari no funcioni correctament.

I al mòdul propi que hem fet scoDadesParticulars crearíem la funció netejaNOVES_DADES() amb la funcionalitat adient per tal d’esborrar aquesta nova secció.

4.2.3.2

Botoneres de pàgines noves del GEN004

A les noves planes que s’hagin creat al formulari amb les noves Dades s’hauran afegit el panell

BOTONERA_INTERMEDIA propi del Framework de formularis GSIT al final de cadascuna.

S’ha de tenir en compte que el botó de Netejar plana al formulari s’ha de dir Esborra les dades per mantenir la coherència amb la resta de botons del formulari genèric.

Una altre opció que podem fer és copiar el panell BOTONERA_INTERMEDIA d’una altre pàgina del formulari genèric per exemple de la pàgina requeridor.

4.2.3.2.1 Anterior i Següent

S’haurà d’afegir el següent codi als botons de la pàgina que hem creat a l’event click tal com estan a la resta de les botoneres del formulari genèric:

 Següent: scoSBSBotonera.planaSeguent(this);  Anterior: scoSBSBotonera.planaAnterior(this);

Aquestes funcions ja busquen els 1º camp visible de la pàgina anterior o següent, segons quin botó sigui, per tal de posicionar-se al camp. Per tant no hem de fer res més per aquests botons.

4.2.3.2.2 Esborra les dades

En el cas del botó Esborra les dades sempre s’ha de posar el codi per esborrar totes les noves dades de la pàgina que s’ha creat. Si mirem el codi que tenen els botons Esborra les dades al formulari al seu event

click veurem que és del tipus:

scoOGENeteja.netejaPlanaNOM_PAGINA();

Per tant, s’ha de crear una nova funció pròpia que esborri totes les dades d’aquesta pàgina a un mòdul de codi propi del formulari i a l’event del botó posarem només la crida a aquesta funció.

Per exemple, si hem creat la pàgina nova dadesParticulars podríem crear el mòdul de codi propi per les dades d’aquesta pàgina: scoDadesParticulars

Llavors a aquest mòdul de codi propi del formulari scoDadesParticulars crearíem la funció que esborres les dades de la pàgina: netejaPAGINA_DADES_PATICULARS();

4.3 Creació de l’acusament de rebuda

Un cop tinguem finalitzat el formulari de sol·licitud crearem el d’acusament de rebuda com tots els formularis GSIT, a partir del XDP de sol·licitud amb les eines de Control de Qualitat dels formularis GSIT (QA), a les que podem accedir a partir del següent enllaç a l’Assistent per a la generació d’acusaments

de rebuda:

http://preproduccio.gsit.intranet.gencat.cat/qafwgsit/AppJava/qafwgsit/generator

Al generar l’acusament de rebuda SEMPRE s’ha de marcar que el formulari ha de tenir carta de pagament, ja que el codi del formulari ja s’encarrega de mostra-la o no depenent de lo que s’hagi definit per al tràmit.

També hem de tenir en compte l’idioma en el que volem generar l’acusament de rebuda. Per defecte ens marcarà Català, però si estem generant l’acusament de rebuda en castellà o angles només haurem de seleccionar l’idioma corresponent i generar el fitxer XDP de l’acusament de rebuda a partir del fitxer XDP del formulari de sol·licitud en el mateix idioma.

ATENCIÓ: No s’ha d’afegir mai el panell de signatura manual

El formulari genèric ja inclou els 2 panells de signatura la digital i la manual al formulari de sol·licitud per lo que no s’ha d’afegir al d’acusament.

Si es vol veure en detall com generar l’acusament de rebuda amb aquesta eina es pot consultar el document del Framework de formularis GSIT: GSIT-FWFormularis-Exemple i concretament l’apartat 5.2

Acusament de rebuda.

Un cop generat el fitxer XDP de l’acusament de rebuda el guardem al mateix directori on tenim el XDP del formulari de sol·licitud del tràmit. A aquest formulari s’han de realitzar una sèrie de petites modificacions que es detallen a continuació.