Ejemplo de Deployment por Línea de Comandos

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Automation Server > Administración del sistema Bizagi > Deployment de procesos y nuevas versiones > Deployment por Línea de Comandos >

Ejemplo de Deployment por Línea de Comandos

Introducción

Bizagi provee el deployment por Línea de Comandos como alternativa al Deployment en un clic en Bizagi Studio, para realizar Deployments de Procesos en escenarios específicos que tienen requerimientos sofisticados.

Para más información acerca del Deployment en un clic, que guía este proceso, refiérase a Deployment de procesos.

Para más información acerca de su descripción e interfaz de usuario, refiérase a Deplotment Avanzado.

 

En esta sección se ilustra un ejemplo del Deployment por Línea de Comandos usado para desplegar sus Procesos de Bizagi a un ambiente de producción.

El ejemplo hará el deployment del Proceso Help Desk, disponible en nuestro Process Xchange, usando una base de datos SQL Server.

 

Configuración del Deployment por Línea de Comandos

Para configurar el Deployment, note que provee 3 diferentes archivos (uno se usa en el ambiente de desarrollo y los otros dos en una máquina con acceso a la base de datos del ambiente objetivo).

 

Para hacerlo siga estos pasos:

 

1. Asegúrese de localizar los ejecutables de Deployment.

Estos archivos se encuentran en el directorio del Management Console (en la ubicación por defecto de la instalación de Bizagi, por lo general es: C:\Program Files\Bizagi\Bizagi Studio\MC).

 

2. Asegúrese de copiar el directorio y todo su contenido en la máquina con acceso a la base de datos del ambiente objetivo (máquina en la que se hará el deployment).

No se requieren mas pasos de instalación.

Note que esto significa que creará un duplicado del directorio en otra máquina que tiene acceso a la base de datos de producción.

 

3. Configure el archivo CreateDatabase.exe para su deployment inicial.

 

note_pin

Sólo en caso de que realice su primer deployment a ambiente de pruebas o producción (en ese caso la base de datos objetivo no existe), entonces necesitará correr un archivo ejecutable en este directorio llamado CreateDatabase.exe.

Para hacerlo, configure el archivo CreateDatabase.exe.config con los detalles de la conexión a la base de datos que va a crear.

Esta base de datos será creada como un proyecto en blanco de Bizagi, y se establecerá como base de datos de pruebas o producción.

 

Recuerde que:

Si la nueva base de datos es en SQL Server, su instancia debe tener un puerto TCP/IP explícito definido.

Para más información de los requerimientos de SQL Server y su configuración, refiérase a Configuración de SQL Server.

Si la nueva base de datos es en Oracle, necesita haber creado previamente el usuario BizagiAdmon y considerar que la contraseña que le va a asignar a su nueva base de datos debe ser la misma que la del usuario BizagiAdmon.

Para más información sobre los requerimientos y preconfiguraciones de Oracle, refiérase a Crear un proyecto usando Oracle.

 

Preparación para el Deployment por Línea de Comandos

Crear el archivo de exportación (.bex) es siempre el primer paso para realizar el Deployment por Línea de Comandos, pues este archivo contendrá los cambios que se desean realizar desde el ambiente de desarrollo al ambiente objetivo.

 

Por lo tanto, antes de empezar con la exportación de sus Procesos y Objetos, asegúrese de que las siguientes condiciones se cumplen para que el archivo contenga la información adecuada:

 

1. Todos los cambios en el ambiente de desarrollo deben estar guardados. En este punto, debe saber que Procesos y Sub-Procesos quiere desplegar, y cualquier miembro del equipo trabajando con Bizagi Studio debe asegurarse de haber realizado check-in a estos Procesos.

 

2. Los datos y confifuración administrados directamente en el ambiente de producción se deben tener en cuenta.

Para los datos, es muy importante encargarse de los valores de las entidades paramétricas, de tal manera que pueda revisar e identificar los valores que se deben actualizar en el ambiente objetivo.

Además de esto y en general, es altamente recomendable estar completamente seguro de lo que desea incluir en el deployment (incluyendo configuraciones de seguridad, interfaces y configuraciones de sistemas externos, parámetros del ambiente, etc).

 

Para más información de estos temas, refiérase a Consideraciones previas a un Deployment.

 

Usando el Deployment por Línea de Comandos

El uso del Deployment por Línea de Comandos se divide en dos tareas principales: Primero correr la utilidad de Exportación para generar el paquete con la información a desplegar, y luego usar las demás utilidades en el ambiente objetivo (pruebas, producción u otro) para aplicar el paquete de deployment.

 

Cómo se explicó en Deployment por Línea de Comandos, para enviar parámetros a los archivos ejecutables, puede escoger hacerlo mediante un archivo de configuración o especificarlos en la línea de comandos. Para este ejemplo, se utilizará la configuración mediante archivos para el procedimiento de Exportación y envíos por parámetros para el de Importación. Independientemente de la opción utilizada, se pueden usar archivos .bat para automatizar el procedimiento. Para más información de los archivos .bat, refiérase a Exportar templates de configuración.

 

Realizar la Exportación en el ambiente de Desarrollo

1. Configure el archivo Export.exe.config con los detalles de conexión de la base de datos de su ambiente de desarrollo, localice los parámetros DSNDB y PROVIDERTYPE como se describe en Deployment Avanzado.

 

2. Ejecute Export.exe.

Aparecerá una ventana con las siguientes opciones:

 

 

Export01

 

Opción (marcadas en la imagen anterior)

Descripción

1

Muestra el nombre de la base de datos del proyecto y su servidor de bases de datos. Debe hacer referencia a su ambiente de desarrollo.

2

Lista de aplicaciones del proyecto.

3

Lista de Procesos (y Subprocesos) por aplicación que se pueden seleccionar.

4

Muestra las versiones del Proceso que se pueden seleccionar para exportar. Al dar clic derecho en la versión, aparece una opción para incluir manualmente las dependencias.

5

Configura el proyecto para usar las herramientas del Deployment Avanzado únicamente. Por favor tenga cuidado al usar esta opción, no se puede deshacer.

6

Permite configurar las opciones de exportación.

7

Crea el archivo de exportación (.bex).

8

Permite relacionar objetos de Experiencia, por ejemplo Búsquedas, opciones relevantes, acciones, triggers y contextos definidos para cualquier entidad.

9

Muestra un resumen de la información contenida en el archivo de exportación.

10

Cargar archivo .bex

Muestra el contenido de un archivo .bex previamente creado.

Guardar paquete editado

Guarda los cambios en un archivo .bex previamente creado.

11

Guardar

Exporta la información configurada en un archivo JSON. Esta opción facilita la creación del archivo de configuración para el procedimiento de Exportación.

Cargar

Importa la información configurada en un archivo JSON.

 

2. Marque los Procesos, Subprocesos y componentes de experiencia que desea incluir en el deployment.

Note que existe una opción especial al hacer clic derecho en la versión, si desea incluir entidades parámetro, maestras, formas de consulta y reglas de negocio; para forzar algunos objetos en el paquete de Exportación.

Para mayor información acerca del funcionamiento de esta opción, refiérase a Relacionar objetos.

 

Export02

 

Si definió componentes de experiencia, seleccione la pestaña Experiencia y asegúrese de que todos los componentes estén relacionados.

En este caso, considere que solo se desea desplegar todos los componentes de experiencia para el Stakeholder llamado Call Center Agent, y las acciones asociadas a la entidad Ticket Activities del proceso de Help Desk.

 

experience_components6

 

Cada elemento listado requerirá los siguientes componentes para hacer su deployment:

Elementos relevantes para mí: Update Customer information y Register New Ticket.

 

advanced_components_3

 

Los Elementos Relevantes para mí son vías cortas a procesos. Por lo tanto, el proceso que inicia tiene que estar relacionado individualmente al hacer el deployment.

 

experience_components2

 

experience_components7

 

Como la vía corta depende de un contexto, asegúrese de que esté seleccionado para el deployment.

 

experience_components8

 

Busque: Cases

 

experience_components9

 

Ésta es una Búsqueda, por lo que se necesita tener en cuenta la entidad de Stakeholder para la que la Búsqueda estará disponible, la entidad a realizar la búsqueda y el contexto en el que va a estar disponible.

 

experience_components10

 

oLa forma de búsqueda se despliega automáticamente junto con la entidad de búsqueda.

oLa forma del Stakeholder del que la búsqueda está disponible se considera automáticamente al seleccionar la búsqueda.

oEl contexto relacionado ya había sido seleccionado.

 

experience_components11

 

Acciones: Register Activity / Solve ticket y Escalate Ticket

 

experience_components12

 

Dependiendo del tipo de acción, se relacionan diferentes componentes y objeto, en este caso Register Activity / Solve ticket y Escalate Ticket son acciones de formas. Por lo que los objetos relacionados son:

 

oLa entidad donde la acción es definida, ésto también incluirá en el deployment la forma relacionada. Debido a que la acción está seleccionada, ésto automáticamente incluye la entidad asociada.

 

experience_components13

 

oTodos los contextos relacionados. En este caso, la acción Register Activity / Solve ticket siempre está disponible para el Stakeholder "Help Desk Agent", y solo está disponible bajo el contexto de Not Last Service Level del mismo Stakeholder.

 

experience_components14

 

oLos procesos desde los que se puede lanzar la acción.

 

experience_components15

 

De esta manera, todos los componentes del Call Center Agent ya están listos para el deployment. Para más información acerca del relacionamiento de objetos y componentes de experiencia, por favor revise el artículo Relacionar objetos.

 

Una vez seleccionado, haga clic en Establecer Importación Avanzada - Exportar para especificar que el proyecto ahora sólo se puede desplegar mediante deployment avanzado. Un aviso aparecerá avisándole que esta acción no se puede deshacer.

 

Export04

 

3. Exporte las opciones de configuración haciendo clic en Guardar en el menú de Configuraciones.

 

experience_components16

 

4. Seleccione la ruta donde desea guardar el archivo JSON; para este ejemplo el archivo se guardará en el directorio del Management Console.

 

experience_components17

 

5. Edite el archivo de configuración usando el editor de texto de su elección y añada los detalles de conexión de la base de datos del ambiente de desarrollo, al inicio del archivo como se explicó en Deployment por Línea de Comandos.

 

CLD_config

 

6. Abra una línea de comandos y navegue hasta la ruta de la instalación de bizagi, que por defecto se encuentra en C:\Program Files\Bizagi\Bizagi Studio\MC.

 

7. Como se mencionó previamente, el archivo de configuración fue guardado en dicha carpeta bajo el nombre ExportSettings.json. Ejecute el archivo Export.exe usando el siguiente comando:

 

Export.exe --Outputfile "Export1.bex" --Config "ExportSettings.json" --Log "log.txt" --ErrorLogger "Errors.txt"

 

Deployment12_ExportCL

 

8. Cuando el archivo de trazas muestre que el archivo fue exportado, cierre la ventana de la línea de comandos.

 

Deployment13_ExportCL

 

note_pin

Puede añadir el comando explicado aquí a un archivo .bat para permitir la ejecución al correr dicho archivo. Esto le permitirá ejecutar el proceso de Exportación más fácilmente. Revise el ejemplo en Exportar templates de configuración.

Se recomienda cifrar la contraseña de la base de datos usando la funcionalidad de cifrado del Work Portal o de Más información del Deployment.

Si ocurre algún error, deberá ajustarlo en su ambiente fuente (desarrollo) y repetir el proceso de exportación hasta que sea exitoso.

 

Importar el paquete en el ambiente objetivo

Antes de ejecutar las funciones de importación, asegúrese de que la base de datos objetivo existe.

Si este es un deployment por primera vez al ambiente de pruebas o producción, use CreateDatabase.exe para crear una base de datos nueva y vacía de Bizagi para ese ambiente.

Una vez haya realizado esto, recuerde hacer respaldos de su ambiente objetivo, y proceda con estos pasos:

 

Como se mencionó antes, se ejecutará el CreateImport.exe enviando parámetros por línea de comandos.

 

1. Abra una línea de comandos y navegue al directorio de instalación de Bizagi, por defecto se encuentra en C:\Program Files\Bizagi\Bizagi Studio\MC.

 

2. Como se mencionó previamente, este ejemplo hará el deployment del proceso de Help Desk usando una base de datos SQL Server. Ejecute el comando como sigue:

 

CreateImport.exe --DSNDB "Persist Security Info=True;User ID=[DBUser];Password=sa;Data Source=[DBServer];Initial Catalog=[DBName];" --Provider MSSqlClient --FilePath Export1.bex --Log logImport.txt --ErrorLogger ErrorImport.txt

 

Deployment14_ImportCL

 

3. Cuando en el archivo de trazas muestre que el archivo fue importado, cierre la ventana de la línea de comandos.

 

Deployment15_ImportCL

 

note_pin

Si usa una base de datos Oracle, haga los cambios correspondientes.

Se puede hacer un .bat con el comando ejecutado para permitir la ejecución de dicho archivo. Esto le facilitará la ejecución del proceso de importación. Revise el ejemplo en Exportar plantillas de Configuración.

Se recomienda cifrado la contraseña de la base de datos usando la funcionalidad de Cifrado de Contraseñas del Portal de Trabajo o de Más información de Deployment.

Si se muestra algún error, deberá ajustarlo en su ambiente fuente (desarrollo) y repetir la importación hasta que sea realizada con éxito.

 

¿Qué sigue?

Después de haber desplegado sus Procesos a un ambiente de pruebas o producción, asegúrese de recargar los cambios en Bizagi.

Cuando tenga proyectos corriendo en un ambiente .NET, esto significa reiniciar sus servicios IIS para que el Portal de trabajo se recargue de los cambios.