Creación de un procedimiento Trew@ a partir del arquetipo AMAP

Última modificación por Administrator el 2016/06/17 10:42

El Gobierno de Cantabria pone a disposición de los proveedores un repositorio corporativo de Maven. Este repositorio provee de un catálogo de arquetipos entre los que se encuentra el arquetipo básico para la creación de cualquier procedimiento Trew@. Para crear un proyecto nuevo en base a este arquetipo se han de seguir los siguientes pasos:

PASO 1: Incluir el repositorio maven del Gobierno de Cantabria  maven.cantabria.es/artifactory/XXXX en un fichero de settings.xml o bien en el raiz de su repositorio maven (normalmente $HOME\.m2) o bien en el de settings.xml global de la instalación de maven


<?xml version="1.0" encoding="UTF-8"?>

<settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
               http://maven.apache.org/xsd/settings-1.0.0.xsd" 
               xmlns="http://maven.apache.org/SETTINGS/1.0.0"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

 <localRepository>${user.home}/.m2/repository-trewa</localRepository>

 <profiles>
   <profile>
       <id>trewa-profile</id>
       <repositories>
           <repository>
             <id>central</id>
             <name>amap</name>
             <url>http://maven.cantabria.es/artifactory/amap-trewa</url>
           </repository>
           <repository>
             <id>amap</id>
             <name>amap</name>
             <url>http://maven.cantabria.es/artifactory/amap</url>
             <snapshots/>
           </repository>
       </repositories>
       <pluginRepositories>
           <pluginRepository>
             <id>central</id>
             <name>amap</name>
             <url>http://maven.cantabria.es/artifactory/amap</url>
             <snapshots/>
           </pluginRepository>
           <pluginRepository>
             <id>amapPlugins</id>
             <name>amapPlugins</name>
             <url>http://maven.cantabria.es/artifactory/plugins</url>
             <snapshots/>
           </pluginRepository>
       </pluginRepositories>
   </profile>
 </profiles>

 <activeProfiles>
   <activeProfile>trewa-profile</activeProfile>
 </activeProfiles>

</settings>

NOTA 1: Se ha indicado un directorio local diferente al de por defecto denominado repository-trewa para facilitar así el desarrollo; separando las librerías del framework de trewa-amap de las del resto del equipo de desarrollo.

NOTA 2: Como excepción se permitirá incluir el driver ojdbc (groupId:com.oracle, arctifactId:jdbc6 y versión:11.2.0.4.0) únicamente para el ámbito de los tests, ya que es una librería ya incluida en el servidor.

PASO 2: Incluir el arquetipo en el archivo archetype-catalog.xml ubicado en el raiz de su repositorio maven (normalmente $HOME\.m2): 

<?xml version="1.0" encoding="UTF-8"?>
<archetype-catalog xsi:schemaLocation="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-catalog/1.0.0 http://maven.apache.org/xsd/archetype-catalog-1.0.0.xsd"
    xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-catalog/1.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <archetypes>
       <archetype>
            <groupId>es.gobcantabria.arquetipos</groupId>
            <artifactId>amap-trewa-archetype</artifactId>
            <version>1.0.0</version>
            <description>Arquetipo AMAP - trewa</description>
       </archetype>
    </archetypes>
</archetype-catalog>

NOTA 1: Si el fichero indicado NO existiese deberá crearlo con todo este contenido anterior.

NOTA 2: Si el fichero indicado YA existiese deberá editarlo y añadir el contenido de la etiqueta <archetype>.

PASO 3: Invocar el comando mvn archetype:generate de creación de aplicaciones a partir de arquetipos desde el directorio (prompt) donde se quiera crear la aplicación:

$> mvn archetype:generate

Maven mostrará una lista de arquetipos y solicitará al usuario indicar el número del arquetipo para crear un proyecto nuevo en base a dicho arquetipo seleccionado:

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] >>> maven-archetype-plugin:2.2:generate (default-cli) @ standalone-pom >>>
[INFO] 
[INFO] <<< maven-archetype-plugin:2.2:generate (default-cli) @ standalone-pom <<<
[INFO] 
[INFO] --- maven-archetype-plugin:2.2:generate (default-cli) @ standalone-pom ---
[INFO] Generating project in Interactive mode
...
910: remote -> sk.seges.sesam:sesam-annotation-archetype 
911: remote -> tk.skuro:clojure-maven-archetype (A simple Maven archetype for Clojure)
912: remote -> uk.ac.rdg.resc:edal-ncwms-based-webapp 
...
1487: local -> es.gobcantabria.arquetipos:amap-springmvc-archetype-basic (Arquetipo AMAP - Spring MVC)
'XXX': local -> es.gobcantabria.arquetipos:amap-trewa-archetype (Arquetipo AMAP - trewa)
Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): 343:

De todos ellos (si estamos conectados al repositorio corporativo) se debe seleccionar el identificado como amap-trewa-archetype. En este caso, habrá que introducir por consola el número 'XXX', que corresponde con el arquetipo deseado.

'XXX': local -> es.gobcantabria.arquetipos:amap-trewa-archetype (Arquetipo AMAP - trewa)

De modo interactivo, la herramienta nos pedirá una serie de datos necesarios para la creación del nuevo proyecto a partir del arquetipo indicado. Dichos datos-parámetros se deberán cumplimentar siguiendo las normas de codificación Maven

  • sistema: Sistema logico donde se incluirá el procedimiento de Trewa. Recomendable que No sean más de 4 caracteres en mayusculas, pero se puede libremente optar por un identificador de hasta 10 caracteres. . Ejemplo DGOT.
  • artifactId: Identificador del procedimiento Trew@. Ej a001, a002,... Normalmente, siguiendo las siguentes directrices: Nombres en minusculas, preferiblemente de no más de 4 caracteres, pero se puede libremente optar por un identificador de hasta 10 caracteres, como con el sistema, y con cuidado de no usar caracteres especiales, ni espacios en blanco, ni guiones...
  • version: Versión que se le quiera dar al procedimiento. Normalmente será 1.0.0
  • groupId: Grupo donde se incluirá la aplicación (a efectos de Maven). Siempre será es.gobcantabria.trewa.
  • package: Paquete java del que penderán las clases de la aplicación. Normalmente, siguiendo las normas de codificación JEE siempre será es.gobcantabria.trewa.<artifactId>
  • classPrefix: Identificador de clase del procedimiento Trew@. Siempre será el identificador artifactId con la primera letra en mayusculas Axxx (Ej A001, A002,...).
Define value for property 'sistema':: DGOT
Define value for property 'artifactId': : axxx
Define value for property 'version': : 1.0.0
Define value for property 'groupId': : es.gobcantabria.trewa
Define value for property 'package': : es.gobcantabria.trewa.axxx
Define value for property 'classPrefix':: Axxx
Confirm properties configuration:
sistema: DGOT
artifactId: a001
version: 1.0.0
groupId: es.gobcantabria.trewa
package: es.gobcantabria.trewa.a001
classPrefix: A001
 Y: :

Por último el asistente nos pedirá confirmación (Pulsamos la letra "Y" de Yes = SI) y se creará la aplicación-proyecto en el directorio donde nos encontremos, donde tenemos el prompt.

PASO 4: El siguiente paso es abrir el IDE correspondiente e importar la aplicación creada con el arquetipo maven. Se ha de importar como una aplicación-proyecto maven. 

El proyecto generado con maven contendrá los siguientes elementos:

  • modulo del EAR
  • modulo del WAR
  • modulo de la clase de Integracion
  • modulo de la clase de Condiciones,acciones y variables
  • Carpeta de recursos del procedimiento "doc"

En la carpeta "doc" se tendrá una serie de  recursos asociados.auxiliares al procedimiento importantes.
Se ha de revisar dicha carpeta, y se ha de generar-crear manualmente el fichero ZIP de importación de procedimiento para su integración en la plataforma trewa.

Dentro del fichero ZIP de importación de procedimiento de Trewa que se ha de crear y generar manualmente se han de incluir los siguientes ficheros que se encontraran en esta mencionada carpeta "doc":

  • aXXX.xml
  • AXXXDocumentoDescargable.zip
  • aXXXPlantillaAMAPComIni.odt
  • aXXXPlantillaAMAPResol.odt
  • aXXXPlantillaAMAPSol.odt
  • aXXXPlantillaAMAPSolPres.odt
  • aXXXPlantillaAMAPSubs.odt

Pero OJO antes de incluir estos ficheros anteriormente enumerado en el ZIP que llamaremos AXXX.zip se han de abrir todos y cada uno de los ficheros ODT de las diferentes plantillas y cambiar-adaptar el nombre de todas las variables que se incluyen en ellos, donde aparecerán cadenas con el texto XXXX que han de sustituirse por el nombre artifactId, esto es, el identificador del procedimiento que se haya indicado anteriormente en mayúsculas.

Y por último se han seguir los diferentes pasos para el  despliegue de un procedimiento de trewa en la plataforma.

Vease los siguientes enlaces al respecto:

© 2014 GOBIERNO DE CANTABRIA - AVISO LEGAL Y PROTECCIÓN DE DATOS