Muestra las diferencias entre dos versiones de la página.
Ambos lados, revisión anterior Revisión previa Próxima revisión | Revisión previa | ||
ada:howto:sicoferp:factory:integrations:cargadearchivos [2021/06/18 17:24] ciro.soto |
ada:howto:sicoferp:factory:integrations:cargadearchivos [2021/10/22 12:08] (actual) administraidor |
||
---|---|---|---|
Línea 1: | Línea 1: | ||
- | ====== Web Service Carga de Archivos ====== | + | ====== Fábrica - Servicios Web - Integraciones - Carga de Archivos ====== |
- | Este servicio tiene la funcionalidad de cargar información de los ticket del otrs para la gestión de los mismos mediante una aplicación de gerencia para realizar estadísticas y análisis internos. | + | Este servicio tiene la funcionalidad de cargar información de los ticket del [[https://otrs.adacsc.co/otrs/index.pl|Otrs]] para la gestión de los mismos mediante una aplicación de gerencia para realizar estadísticas y análisis internos. |
- | Desarrollo del microservicio. | + | ===== Descripción del Servicio ===== |
- | 1.- se crea la tabla de nombre dbo.Tbl_Carga_Archivo en el servidor: | + | ^Nombre^Descripción^Tipo Servicio^Tecnología^Lenguaje^Tipo Desarrollo^Versión Desarrollo^Archivo de Configuración^ |
- | * Nombre de la Instancia:BI escritorio remoto | + | |CargarArchivo|Funcionalidad de carga de informacion de los ticket del otrs para la gestion de los mismos mediante una aplicacion de gerencia para realizar estadisticas y analisis internos.|Rest|SpringBoot 4.4|Java 11.0.315|Nuevo|11.0.1.0|application.properties| |
- | * Ip Escritorio Remoto: 10.1.20.86 | + | ^Tipo Empaquetado^Gestor de Dependencias^Servidor de Despliegue^IDE Proyecto^Tipo Repositorio^Url Desarrollo^Url Calidad^Url Producción^ |
- | * Usuario:Administrator | + | |jar|Maven 3.8.1|Tomcat 6|Eclipse 2021-03|Subversión|[[http://adacsc.co:1443/svn/repository/ADA/WEB_SERVICES/INTEGRACIONES/Otrs/CargaDeArchivos/Fuentes/branches/branches 11.0.1.0|SVN branches]]|[[http://adacsc.co:1443/svn/repository/ADA/WEB_SERVICES/INTEGRACIONES/Otrs/CargaDeArchivos/Fuentes/trunk/trunk 11.0.1.0|SVN trunk]]|[[http://adacsc.co:1443/svn/repository/ADA/WEB_SERVICES/INTEGRACIONES/Otrs/CargaDeArchivos/Fuentes/tags/tags 11.0.1.0|SVN tags]]| |
- | * Contraseña: 4rc4ng3l* | + | ^Dependencias^^^^^^^^ |
+ | ^groupId^artifactId^^version^scope^optional^Descripción^^ | ||
+ | |org.springframework.boot|spring-boot-starter-data-jpa||N/A|N/A|N/A|API de persistencia|| | ||
+ | |org.springframework.boot|spring-boot-starter-thymeleaf||N/A|N/A|N/A|Motor de plantillas|| | ||
+ | |org.springframework.boot|spring-boot-starter-validation||N/A|N/A|N/A|Validador de información|| | ||
+ | |org.springframework.boot|spring-boot-starter-web||N/A|N/A|N/A|Core Servicios Web|| | ||
+ | |org.springframework.boot|spring-boot-devtools||N/A|runtime|true|Recarga de aplicaciones|| | ||
+ | |mysql|mysql-connector-java||N/A|runtime|N/A|Driver DB MySQL|| | ||
+ | |org.projectlombok|lombok||N/A|N/A|true|API de anotaciones para reducción de código|| | ||
+ | |org.springframework.boot|spring-boot-starter-test||N/A|test|N/A|Core Springboot|| | ||
+ | |org.apache.poi|poi||3.15|N/A|N/A|API de lectura de archivos Excel|| | ||
+ | |org.apache.poi|poi-ooxml||3.15|N/A|N/A|API de lectura de archivos Excel XML|| | ||
+ | |org.springframework.boot|spring-boot-starter-data-jdbc||N/A|N/A|N/A|API JDBC para conexión a Base de Datos|| | ||
+ | |com.microsoft.sqlserver|mssql-jdbc||N/A|runtime|N/A|Driver DB SQL Server|| | ||
+ | |org.apache.tomcat.embed|tomcat-embed-jasper||N/A|provided|N/A|Servidor embebido tomcat|| | ||
+ | |org.springframework.boot|spring-boot-starter-tomcat||N/A|provided|N/A|Core Spring|| | ||
+ | |org.apache.maven.plugins|maven-compiler-plugin||3.8.1|N/A|N/A|Gestor de dependnecias|| | ||
+ | |io.springfox|springfox-swagger2||2.9.2|N/A|N/A|Core Documentación Web Services RESTful|| | ||
+ | |io.springfox|springfox-swagger-ui||2.9.2|N/A|N/A|GUI Documentación Web Services RESTful|| | ||
+ | ^Operaciones^^^^^^^^ | ||
+ | ^Tipo Petición Http^Nombre operación^^Descripción^^^Documentación^^ | ||
+ | |POST|cargarArchivo||Se encarga de procesar e insertar la información de un archivo excel en la tabla dbo.Tbl_Carga_Archivo||| documentación del Formulario del servicio y la Plantilla de Carga de Información se debe utilizar la siguiente sección:[[ada:howto:sicoferp:factory:integrations:templateservice|Formulario]].|| | ||
+ | ^Ambientes de Despliegue^^^^^^^^ | ||
+ | ^Tipo^Url^^Observaciones^^^^^ | ||
+ | |Desarrollo:|http://10.1.140.1:2691||Ambiente de desarrollo||||| | ||
+ | |Calidad:|http://10.1.140.1:2691||Ambiente de validación||||| | ||
+ | |Producción:|http://10.1.140.1:2691||Ambiente de producción||||| | ||
- | Usuario de Acceso Integrado con PBI | ||
- | Usuario: Indicadores | ||
- | Clave: 4rc4ng8l | ||
- | 2.- Se creo el Web Service mediante: | + | ===== Información Adicional ===== |
- | * Spring Boot 11 | + | |
- | * dependencias Maven | + | |
- | * se agrega la librería POI, para poder leer la información del archivo excel, | + | |
- | * la dependencia thymeleaf para generar el formulario | + | |
- | * la dependencia para el motor SQL | + | |
- | 3.- Se crea la entidad relaciona con la tabla: dbo.Tbl_Carga_Archivo | + | ===== Accesos ===== |
- | 4.- Método POST: se leen las columnas del archivo excel se setean a las variables que se | + | ^Descripción^Tipo Acceso^IP^Usuario^Contraseña^Notas/Observaciones^ |
- | envían al insert directamente de la tabla. | + | |Maquina utiliza para acceder al ambiente de Datos|Escritorio Remoto|10.1.20.86|Administrator|4rc4ng3l*|Usuario de Acceso Integrado con PBI: Indicadores - Contraseña: 4rc4ng8l| |
- | Método READ: para realizar la consulta de la información insertada. | + | |
- | 5.- Se crea la plantilla del formulario en thymeleaf spring boot | + | ===== Despliegue ===== |
- | 6.- Se despliga el servicio en la direccion: http://10.1.140.1:2690/cargarArchivo | + | ==== Pasos Previos: Generar jar (IDE Eclipse y Spring Tools) ==== |
- | Ambiente: DESARROLLO | + | El proyecto está configurado para generar compilable jar. Siga los siguientes pasos para generarlo((Se asume que el lector tiene conocimeintos previos del uso del lenguaje Java e IDE utilizado)). |
- | IP:10.1.140.1 | + | |
- | Puerto:2690 (puerto fijo de la aplicación, en el archivo application.properties) | + | |
- | contenedor: tomcat06 | + | |
- | 7.- El servicio tiene 2 metodos: | + | * Ubiquese en la reaíz del proyecto, click derecho -> Run as... -> Maven builds... |
- | * http://10.1.140.1:2690/consultar : este metodo consulta la informacion insertada o contenida en la tabla en formato Json(opcional no se utilizara) | + | * En la casilla **Goals** ingrese el comando: **clean package** para generar el jar. Tambien puede utilizar en su lugar la insttrucción **clean package -DskipTests** si no desea ejecutar las pruebas unitarias. |
+ | * Al finalizar el proceso si no hay errores se generará el jar en el directorio target del proyecto. | ||
- | * http://10.1.140.1:2690/cargarArchivo/ : este metodo es el que se encarga de procesar e inserta la información en la tabla | + | === Nota === |
+ | Para ubicar el jar en el directorio del equipo desde el proyecto seleccione el jar con click derecho y vaya a propiedades al visualizar la ventana emergente se verá la ubicación del archivo. | ||
- | 8.- Ruta de la Documentación Swagger: http://localhost:2690/swagger-ui.html#/carga-archivo-controller/readOperationCrudUsingGET | + | ==== Despliegue en el servidor ==== |
+ | Actualmente no hay servidor de desarrollo ni QA por lo tanto el despliegue se realiza directamente en producción. Para generar el despliegue siga los siguientes pasos: | ||
+ | - Acceder al servidor de despliegue por WSCP o SSH: IP: **10.1.140.1**, Usuario:**tomcat07**, Password:**mUp5NbwvfU** | ||
+ | - Identifique el proceso actual en el cual corre la solución con el siguiente comando: **ps -ef | grep WsCargarArchivo2-0.0.1-SNAPSHOT.jar** donde **WsCargarArchivo2-0.0.1-SNAPSHOT.jar** es el nombre del jar generado a la fecha. Se recomienda utilizar SSH. | ||
+ | - Si el despliegue está ejecutandose se devolverá una linea similar a la siguiente: //tomcat07 **14558** 1 0 oct21 ? 00:01:28 java -jar WsCargarArchivo2-0.0.1-SNAPSHOT.jar// De esta linea debe identificar el numero del proceso el cual es el código **14558**((Este es el proceso actual ejecutandose y cambiará siempre que reinicie el servidor o actualice el despliegue)). Se recomienda utilizar SSH. | ||
+ | - Mate el proceso con el comando kill -9 **14558** Se recomienda utilizar SSH. | ||
+ | - Copie el nuevo jar en la ruta **/opt/tomcat07/integraciones** se recomienda utilizar WSCP por su interfaz gráfica. | ||
+ | - Desde la consola((Se recomienda utilizar SSH)) ejecute el comando **nohup java -jar WsCargarArchivo2-0.0.1-SNAPSHOT.jar &** donde el **WsCargarArchivo2-0.0.1-SNAPSHOT.jar** es el nombre del jar previamente generado. | ||
+ | - Por último desde un navegador ingrese la url **http://10.1.140.1:2691/cargarArchivo** y debera visualizar un formulario de carga de archivo. Lo cual indica que el despliegue fué realizado correctamente. | ||
+ | === Notas === | ||
- | [[ada:howto:sicoferp:factory:integrations|←Volver atras]] | + | * Debe contar con VPN |
+ | * El numero del proceso cambiará cada vez que se actualice el despliegue | ||
+ | * Si se reinicia el servidor se debe volver a generar el despliegue ya que actualmente el proceso no está como un servicio sino como ejecutable. | ||
+ | |||
+ | [[ada:howto:sicoferp:factory:integrations|←Volver atrás]] | ||