Interfaces de usuario en detalle

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Automation Server > Automation Server - configuración y administración > Configuración del proyecto inicial > Deployment de procesos y nuevas versiones > Deployment Avanzado >

Interfaces de usuario en detalle

Introducción

Este artículo explica el conjunto de archivos ejecutables o utilidades que son necesarias para realizar un Deployment Avanzado utilizando la interfaz gráfica dedicada.

A grandes rasgos, los pasos para hacerlo son:

1.Usar el CreateDatabase para crear una base de datos vacía en el ambiente objetivo.

2.Crear un archivo .bex con la herramienta de Exportación.

3.Importar el archivo .bex generado en el ambiente objetivo usando el CreateImport.

4.Si desea llevar data a su ambiente objetivo, use los procedimiento para Exportar e importar data desde el Management Console. Dicho procedimiento se conoce como Sincronización de datos.

 

Opcionalmente, si necesita actualizar elementos específicos en sus procesos, utilice la herramienta Microdeployment. Para más información, consulte Microdeployment.

 

Archivos ejecutables del Deployment Avanzado

El Deployment Avanzado consiste de una herramienta de Exportación que le ayuda a crear un Paquete de Despliegue, y también incluye dos archivos ejecutables con sus respectivas configuraciones, los cuales deben ejecutarse en el ambiente objetivo.

Estos archivos ejecutables vienen instalados por defecto en la ruta del Management Console (en C:\Program Files\Bizagi\Bizagi Studio\MC).

 

ExecutableFiles2

El propósito de cada ejecutable y dónde debe utilizarse se describe en la tabla a continuación (este archivo se ubica bajo el nombre que listamos, con la extensión .exe).

 

Ejecutable

Propósito

¿Dónde debe utilizarse?

CreateDatabase.exe

Crea una base de datos en blanco con el modelo de Bizagi, justo como lo realiza Bizagi Studio o el Management Console cuando se crea un proyecto nuevo.

Se requiere especialmente porque a través del Advanced Deployment no se crea una base de datos sino que se parte de una base de datos existente a donde se van a aplicar los objetos de su implementación (entidades, formas, reglas, etc).

En una máquina que tenga acceso al servidor de base de datos de Producción.

CreateImport.exe

Crea un paquete de importación .bim donde tendrá los objetos finales que llevará a su ambiente de Producción. Se realiza después del análisis al archivo .bex para considerar si debe haber un manejo especial en la información de los 2 ambientes  (p.e hacer merge).

En una máquina que tenga acceso al servidor de base de datos de Producción.

Export.exe

Crea un archivo de exportación .bex donde tendrá el paquete de objetos de su ambiente de Desarrollo.

En una máquina que tenga acceso al servidor de base de datos del ambiente de Desarrollo.

Se puede acceder directamente desde el séptimo paso del Asistente de Procesos de Studio.

MicroDeployment.exe

Crea un archivo de exportación .bex donde tendrá el paquete de objetos actualizados en su ambiente de Desarrollo. Para más información, consulte Microdeployment.

 

Archivos de configuración

La configuración de los ejecutables mencionados anteriormente se realiza a través de sus archivos con extensión .config.

Estos archivos de configuración contienen formato XML y corresponden de la siguiente manera:

CreateDatabase.exe.config para CreateDatabase.exe

CreateImport.exe config para CreateImport.exe

Export.exe config para Export.exe

MicroDeployment.exe config para MicroDeployment.exe

 

Todos los archivos de configuración contienen la siguiente estructura, donde requieren configuración de 3 llaves dentro del elemento <appSettings>:

ProofConcept_Utility: Contiene el nombre del utilitario, al archivo ejecutable que referencia.

DSNDB: Contiene el string de conexión a la base de datos al cuál el ejecutable se conecta. En el caso del CreateDatabase.exe, la conexión representa la base de datos que aún no ha sido creada.

PROVIDERTYPE: Especifica el proveedor de datos para esa conexión (SQL Server o Oracle).

 

ConfigFiles

 

Para configurar un ejecutable, deberá incluir el detalle de la conexión a la base de datos y del proveedor.

 

Al utilizar SQL Server:

<add key="DSNDB" value="Persist Security Info=True;User ID=[SQL_Login];Password=[Login_password];Data Source=[DB_Server]\[Named_instance];Initial Catalog=[Database];" />

<add key="PROVIDERTYPE" value="MSSqlClient" />

Considere:

[SQL_Login]: La cuenta de login que se utiliza para conectarse a una instancia SQL Server.

[Login_password]: La contraseña cifrada de la cuenta de login de la conexión. Se recomienda cifrar la contraseña utilizando la funcionalidad de Cifrado de Clave.

[DB_Server]: Nombre o dirección IP del servidor de base de datos. Utilice \[nombre_instancia] si aplica (si no es la instancia sin nombre por defecto).

[Database]: El nombre de la base de datos del ambiente de su proyecto. Recuerde que para el CreateDatabase particularmente, esta base de datos es la que aún no ha sido creada.

 

note_pin

Al configurar los archivos ejecutables, el login de SQL Server requerirá de permisos de sysadmin.

 

Al utilizar Oracle:

<add key="DSNDB" value="Data Source=[DB_Server]:[Port_number]/[Service];User ID=[User_schema];Password=[User_schema_password];Unicode=True;" />

<add key="PROVIDERTYPE" value="Oracle" />

Considere:

[DB_Server]: Nombre o dirección IP del servidor de base de datos.

[Port_number]: El número de puerto utilizado para la conexión a ese servicio.

[Service]: El identificador de servicio usado para su base de datos Oracle.

[User_schema]: El nombre de la base de datos del ambiente de su proyecto (esquema de usuario). Recuerde que para el CreateDatabase particularmente, esta base de datos es la que aún no ha sido creada.

[User_schema_password]: La contraseña cifrada para ese esquema de usuario.

 

Como se mencionó antes, la contraseña de la base de datos debe estar cifrada para protegerla en caso de acceso no autorizado a los archivos de configuración. Siga este procedimiento para cifrar la contraseña:

 

1. En el Portal de Trabajo de su ambiente de desarrollo, dé clic en Admin y después Cifrado de Clave.

 

PasswordEnc_01

 

Esto mostrará una ventana con la que se puede cifrar cualquier texto que necesite.

 

2. Ingrese la cadena a cifrar en el campo Texto a Cifrar y confírmelo en el siguiente campo. Esto asegurará que el texto ingresado por primera vez es correcto. Si el valor de ambos campos no es igual, la contraseña no será cifrada.

Finalmente, dé clic en Encriptar,

 

PasswordEnc_02

 

3. El campo Texto Cifrado mostrará la contraseña cifrada. Copie esta cadena de caracteres y péguela donde sea requerido.

 

CrytpPass

 

CreateDatabase.exe

Deberá crear una base de datos en blanco del modelo de Bizagi únicamente la primera vez para que el Deployment Avanzado aplique scripts sobre una base de datos existente.

Significa que para Deployments siguientes (incrementales), no necesita utilizar este ejecutable.

 

Recuerde que para los proyectos que se ejecutan sobre una plataforma de .NET, podrá considerar el uso del Deployment-en-un-clic para el primer Deployment.

De ser así, entonces no necesitará del CreateDatabase.exe.

 

note_pin

Tenga en cuenta:

Si usted crea una Base de datos SQL Server, deberá asegurarse que la instancia tenga un puerto TCP/IP explícito.

Para mayor información sobre los requisitos y configuración de SQL Server, consulte Prerrequisitos de SQL Server.

Si usted crea una Base de datos Oracle, deberá asegurarse de haber creado previamente el usuario BizagiAdmon.

La nueva Base de datos quedará con la misma contraseña del usuario BizagiAdmon, de manera que deberá especificar la contraseña de BizagiAdmon para la nueva configuración.

Para mayor información sobre los requisitos y configuración de Oracle, consulte Prerrequisitos de Oracle.

 

Para utilizar CreateDatabase.exe, previamente asegúrese de haber copiado la carpeta completa del MC en una ruta local de una máquina con acceso a la base de datos de producción (la carpeta MC contiene los archivos ejecutables y las dlls necesarias).

Seguidamente:

1. Edite el archivo CreateDatabase.exe.config para especificar el detalle de la conexión a la base de datos que desea crear.

2. Ejecute el CreateDatabase.exe.

La interfaz de usuario le presentará lo siguiente:

Target (destino): Enseña la base de datos y el servidor de base de datos configurado, al cuál se está conectado.

 

CreateDatabase

 

note_pin

Tenga en cuenta que las configuraciones unicode de su base de datos de desarrollo serán copiadas a su entorno de producción.

 

3. Cree la base de datos.

Para ello, utilice una de las 2 opciones:

Create Bizagi Test database (Crear la base de datos para ambiente de pruebas):  Haga clic en este enlace para comenzar la creación de la base de datos en blanco, que quedará inicialmente marcada como ambiente de pruebas.

Create Bizagi Production database (Crear la base de datos para ambiente de producción): Haga clic en este enlace para comenzar la creación de la base de datos en blanco, que quedará inicialmente marcada como ambiente de producción.

 

CreateDatabase_confirm

 

Una vez que confirme la acción, el progreso de la creación de base de datos se enseña:

 

CreateDatabase_progress

 

Tan pronto finaliza exitosamente, podrá cerrar el ejecutable.

 

CreateDatabase_finished

 

 

Export.exe

Utilice esta herramienta para generar el paquete inicial de objetos que se extraen desde el ambiente de desarrollo.

Este paso del Deployment Avanzado se configura en el ambiente de desarrollo.

 

¿Qué necesita hacer?

Asegúrese de que sus procesos están listos y que no necesitan cambios adicionales para ser desplegados.

Para utilizar Export.exe, edite el archivo Export.exe.config para especificar los detalles de la conexión a la base de datos de su ambiente de desarrollo.

Este paso también se puede encontrar en el séptimo paso del Asistente de Procesos, haciendo clic en la opción Exportar Proceso.

 

ExportWizard

 

También se puede seleccionar la opción Avanzado ubicada en la sección Deployment del menú Exportar/Importar.

 

Export05

 

Aparece una ventana con el asistente para exportar procesos.

 

Export1_patchA

 

La interfaz de usuario le presentará lo siguiente:

Base de datos (Database): Enseña la base de datos y el servidor de base de datos configurado, al cuál se está conectado.

Pestaña Procesos (Processes): Lista todos los procesos y sus versiones. Asegúrese de marcar la casilla de los cuales desea incluir.

Nótese que podrá hacer clic derecho sobre la versión de proceso para utilizar la opción Define additional dependencies para definir dependencias adicionales y forzar la inclusión de ciertos objetos independientes en el deployment. Tenga en cuenta que los procesos que no sean explícitamente seleccionados no se incluirán en el deployment aún cuando estén relacionados en otra parte.

Para definir objetos adicionales, podrá marcar registros específicos de las tablas de Bizagi. Si la entidad marcada no tiene atributos, no será incluida en el deployment.

Realice esto adicionando la tabla desde la lista desplegable y marcando las casillas de esos registros:

 

Dependencies

 

Pestaña de Experiencia (Experience): Seleccione los componentes de la experiencia que desea agregar al paquete de exportación. Tenga en cuenta todas las consideraciones previas, teniendo en cuenta componentes de experiencia ya que algunos de éstos pueden ser incluidos en deployment sin alguna relación necesaria o componente para trabajar correctamente. Para más información refiérase al artículo Relacionar objetos.

 

advanced_components

 

Pestaña Opciones avanzadas (Advanced): Ofrecen las posibilidades para excluir o incluir objetos del sistema, administrados por Bizagi. Entre estos objetos puede seleccionar los temas que construyó con el Theme Builder, parámetros de ambiente, opciones de autenticación y propiedades de usuario.

 

AdvancedOptions2

 

note_pin

Cuando se incluyen parámetros de ambiente asegúrese de que dichos valores de parámetros, tales como el servidor SMTP o las URL de las interfaces, correspondan correctamente a su ambiente. Cuando se importa el paquete con estos ajustes, los parámetros del ambiente destino serán sobrescritos.

Si marca las opciones de autenticación, se reemplazará la autenticación configurada en el ambiente destino. No use esta opción a menos que esté seguro de cambiar las opciones de autenticación con la configuración de su ambiente de origen.

 

Pestaña descripción (Description): Agregue información relevante sobre el paquete. Por ejemplo: los procesos incluidos, sus versiones, las entidades incluidas y otros cambios importantes.

 

ExportDescription

 

Dé clic sobre el botón Export.

Esta acción generará el paquete con los objetos seleccionados de sus versiones de proceso y lo almacenará como un archivo .bex.

En este punto ya el Export se ha utilizado pero puede usar las opciones presentadas para "después del export" para revisar qué contiene exactamente su paquete y evaluar si requiere volver a crear uno.

Podrá ver de qué tablas se tienen objetos completamente o parcialmente.

 

AfterExport

 

Usted puede verificar el contenido del paquete de exportación con el botón View Package.

 

ExportPackage

 

note_pin

Cuando se considera una entidad paramétrica administrada en producción en el paquete de despliegue, todos sus atributos y relaciones son incluidos, incluso aquellos que no se utilizan.

 

CreateImport.exe

Utilice este ejecutable para analizar el paquete que creó previamente a través de Export.

El análisis que se lleva a cabo en este punto considera cómo se manejaría la aplicación de este paquete sobre el ambiente de producción (manejo de conflictos, merge) sin hacer cambios algunos aún.

Al finalizar el análisis usted podrá aplicar el paquete seleccionado, el cual es el paquete final para su ambiente de producción.

 

Para utilizar CreateImport.exe, previamente asegúrese de haber copiado la carpeta MC en una máquina que tenga acceso a la base de datos del ambiente de producción (esta carpeta contiene los 3 ejecutables y las dlls que se utilizan).

Edite el archivo de configuración CreateImport.exe.config de manera que especifique la cadena de conexión a su base de datos del ambiente de producción.

Ejecute CreateImport.exe.

 

Import1

 

note_pin

Le recomendamos siempre seleccionar la opción Enable metadata validation. Esta opción detecta dos de los errores más comunes en el deployment:

References to objects that don't exist in the catalog: Este error se genera cuando un objeto del deployment hace referencia a un elemento que no existe en el paquete o en la base de datos objetivo.

Processes without an associated version: Este error se genera cuando objetos como reglas y elementos de Experiencia no tienen una versión del proceso asociada. Si esto sucede revise la configuración de su deployment y asegúrese de seleccionar una versión del proceso para estos objetos.

Estas validaciones son muy importantes pues reducen los errores que se pueden presentar en el ambiente de Producción.

 

La interfaz de usuario le presentará lo siguiente:

Base de datos destino (Target databse): Enseña la base de datos y el servidor de base de datos configurado, al cuál se está conectado.

Snapshot de base de datos (Backup Database): Cree un snapshot de su base de datos destino.

Examinar (Browse): Utilice esta opción para iniciar con el uso de CreateImport. Deberá cargar el paquete .bex que se creó previamente a través del Export.exe

Información del Paquete (Package information): Esta sección muestra el autor (usuario), proyecto, base de datos de origen y la fecha de creación del paquete a importar.

Podrá utilizar las opciones Ver objetos de proceso a importar (View process objects to import) o Ver opciones avanzadas de exportación (View export advanced options) para revisar la información que se incluye en el paquete tal como se presentan dichas opciones desde el Export.

oView process objects to import: ver todos los objetos que contienen información del proceso que será publicado en el ambiente destino.

oView export advanced options: ver todas las opciones avanzadas que serán publicadas y actualizadas en el ambiente destino.

oView description: ver el resumen de la exportación escrita por la persona que generó el archivo.

 

Import04

 

Revise los objetos a incluir en el deployment por medio de las opciones Ver los objetos de proceso (View process objects to import), Ver opciones avanzadas de exportación (View export advanced options) y Ver descripción (View description) para ver los objetos que serán incluidos en el deployment:

 

ExportPackage

 

ViewEditObjects

 

note_pin

Si marca las opciones de autenticación, se reemplazará la autenticación configurada en el ambiente destino. No use esta opción a menos que esté seguro de cambiar las opciones de autenticación con la configuración de su ambiente de origen.

 

Haga clic en Aplicar a la base de datos (Apply package).

Esta opción da inicio al procedimiento de aplicar el paquete, correrá procedimientos en la base de datos de destino (por ejemplo su ambiente de producción), y por lo tanto es importante que tome las medidas necesarias en este punto.

 

Import03

 

Esto podrá tardar un par de minutos y recuerde que en este punto se ejecutarán scripts a nivel de base de datos.

Una vez haya finalizado, se notificará el éxito de la operación:

 

ImportAnalysis

 

note_pin

Este proceso genera un log en la carpeta donde se ejecutó el CreateImport.exe. Este log le permite identificar rápidamente la causa de un error durante la ejecución del proceso. Tiene como nombre logImport[Estampa de Tiempo].txt donde la estampa de tiempo tiene el siguiente formato AAAAMMDD hh_mm_ss

 

Si el proceso fue exitoso el log se verá así:

3/01/2019 3:06:43 PM: Workspace is valid!
3/01/2019 3:07:11 PM: Adapter execution
3/01/2019 3:08:35 PM: Import catalog end

De lo contrario el log será similar a este:

2/21/2019 11:05:04 AM: Exception on Import: Package version is not supported by this version of bizagi: 11.1.0
2/21/2019 11:05:08 AM: [{"type":"IncompatibleVersion","Message":"Package version is not supported by this version of bizagi: 11.1.0"}]

 

Los logs no tienen localización por lo cual se muestran en Ingles. La primera línea muestra el tipo de error que se presentó durante la ejecución. Mientras que la segunda línea muestra información más detallada sobre el error en formato JSON. Dependiendo del error el log puede verse diferente sin embargo siempre tienen esta estructura básica.

 

Snapshot de Base de Datos

En el deployment avanzado usted puede importar el BEX usando el ejecutable createImort.exe. Bizagi ofrece la oportunidad de generar un snapshot de la base de datos destino, la cual puede reversar fácilmente en caso de que exista un problema externo afectando el procedimiento de deployment, y quiera volver a su estado inicial antes del deployment. Reversar un snapshot es más fácil que restaurar un backup, lo cual hace el deployment más eficiente.

 

Cuando  usted abre el createImport.exe, usted puede hacer clic en Backup database. Esto genera automáticamente el snapshot de la base de datos.

 

DBSnapshot

 

El nombre del snapshot es el nombre de la base de datos con un sello de tiempo: [Nombre_Base_de_Datos]_yyyyMMMdd_HHmmss.

 

DBSnapshot2

 

El snapshot siempre es creado en la misma instancia que la base de datos, y es un archivo de solo lectura:

 

DBSnapshot3

 

El snapshot de base de datos está disponible para las siguiente versiones de instancias SQL:

 

Versión Instancia SQL

Enterprise

Standard

Web

Express

SQL 2017

SQL 2016 SP1

SQL 2016

-

-

-

SQL 2014

-

-

-

SQL 2012

-

-

-

SQL 2008 R2

-

-

-

 

Consideraciones con Snapshots

Considere las siguientes recomendaciones relacionadas con snahpshots:

Si un snapshot existe, usted no puede borrar o restaurar su base de datos mientras en snapshot exista, tiene que borrarse primero.

No deje snapshots permanentemente. Estos deben ser usados para reversar la base de datos a su estado original en caso de ser necesario. Pero es recomendable borrar todos los snapshots luego de ser usados.

Un snapshot no reemplaza un backup. Mantenga sus esquemas de backups.

 

note_pin

Le recomendamos ver las siguientes consideraciones asociadas a snapshots en este link

 

MicroDeployment.exe

Utilice esta herramienta para generar el paquete de objetos específicos que se extraen desde el ambiente de desarrollo.

Este paso del Deployment Avanzado se configura en el ambiente de desarrollo.

 

¿Qué necesita hacer?

Para utilizar MicroDeployment.exe, edite el archivo MicroDeployment.exe.config para especificar los detalles de la conexión a la base de datos de su ambiente de desarrollo.

Este paso también se puede encontrar en el séptimo paso del Asistente de Procesos, haciendo clic en la opción Microdeployment.

 

ExporMD1

 

También se puede seleccionar la opción Avanzado ubicada en la sección Deployment del menú Exportar/Importar.

 

MicroDep

 

Aparece una ventana con el asistente de Microdeployment.

 

Microdeployment06

 

Para más información, consulte Microdeployment.

 

Pasos posteriores

Una vez se haya completado el deployment de procesos a través del Deployment avanzado, recomendamos que se limpie la caché del servidor en producción antes de anunciar la finalización del deployment.

 

Cuando se ejecutan los procesos sobre un IIS (plataforma de .NET), después de realizar un deployment avanzado deberá limpiar la memoria caché del Portal de trabajo y de la base de datos.

Para realizar esto, invoque los siguientes servicios web de Bizagi disponibles en cada proyecto:

Caché de formas de la base de datos: http://[su_servidor][su_proyecto]/webservices/cache.asmx?op=CleanRenderCache

Caché de aplicación: http://[su_servidor][su_proyecto]/webservices/cache.asmx?op=CleanUpCache

 

Note que seguidamente deberá reiniciar los servicios del IIS.

 

El procedimiento de despliegue solo considera metadata, esto significa que si desea preservar los datos de los usuarios y valores de las entidades paramétricas administradas en producción de su ambiente de desarrollo en el ambiente objetivo, debe realizar una Sincronización de datos.