Publicar desde la consola de comandos

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Modeler > Generar documentación > Publicación premium > Publicar a la Web >

Publicar desde la consola de comandos

Introducción

Cuando se genera documentación en formato Web, usted puede utilizar la consola de comandos (consola DOS de Windows) en vez de el asistente gráfico que guía este paso.

La generación de documentación desde la consola de comandos es especialmente útil para:

Reutilizar la configuración ya almacenada de las preferencias de publicación de un archivo .bpm.

De esta manera, usted no necesita llevar a cabo la configuración de los diagramas y elementos a incluir en la documentación, dado que Bizagi utilizará esta configuración previa.

Generar documentación en lote, y de una manera no asistida (modo batch).  

De esta manera, usted puede ejecutar o programar esta generación de documentación Web para cualquier número de archivos .bpm.

Adicionalmente y con una ejecución en lote, Bizagi trata cada archivo de manera separada (de forma que la ejecución continúa para un siguiente archivo en caso de que el anterior arroje un error).

 

Parámetros de la consola

Para realizar una publicación desde la consola de comandos, utilice:

"[RUTA_INSTALACIÓN_MODELER]"\BizagiModeler.exe "[ARCHIVO_BPM]" /webPublish /publishPath:"[RUTA_RESULTADO]"

 

Considere:

[RUTA_INSTALACIÓN_MODELER]: La ruta completa donde el Modeler fue instalado. Dentro de dicha ruta, se deberá tener el archivo ejecutable BizagiModeler.exe.

Por ejemplo: C:\Archivos de programa\Bizagi\Bizagi Modeler\Modeler\.

[ARCHIVO_BPM]: El nombre del archivo .bpm que contiene los diagramas que desea publicar. Asegúrese de incluir la ruta completa a ese archivo .bpm y que Bizagi Modeler tenga permisos de acceso.

Por ejemplo: C:\Mis Descargas\Mesa de Ayuda.bpm

[RUTA_RESULTADO]: La ruta completa donde se desea generar los archivos Web de la documentación (esta ruta debe existir previamente).

Dentro de esta ruta, Bizagi dejará también un archivo log llamado PublishLog.txt con los detalles de la ejecución.

Asegúrese que el usuario que ejecuta la consola tenga los permisos para escribir sobre dicha ruta.

Por ejemplo: C:\Mis Descargas\

 

Nótese que se recomienda asignar todas las rutas mencionadas anteriormente dentro de comillas dobles, dado que es probable que la instalación del Modeler o demás rutas contengan espacios en blanco.

 

Webpublish_command

 

Después de publicar a la Web desde la consola, los detalles quedan en un archivo log en [RUTA_RESULTADO]\PublishLog.txt:

 

Webpublish_log

 

note_pin

Por supuesto de manera alternativa, también se puede ejecutar desde la ruta de instalación del Modeler, la publicación Web desde la consola:

 

cd [RUTA_INSTALACIÓN_MODELER]

BizagiModeler.exe "[ARCHIVO_BPM]" /webPublish /publishPath:"[RUTA_RESULTADO]"

 

Ejemplo de publicación en lote

Nótese que usted puede apoyarse en las opciones de la consola de comandos para crear un archivo .bat que genera la documentación Web para cualquier número de archivos .bpm.

Esto es especialmente útil cuando se trabaja con una gran cantidad de archivos .bpm, dado que este procedimiento podría ser programado y realizado de una manera no asistida con esta posibilidad (Bizagi automáticamente manejará cada archivo por separado, continuando en caso de error en alguno).

El siguiente ejemplo ilustra este uso.

 

Note que para este ejemplo, el Modeler se encuentra instalado en la ruta por defecto que es C:\Program Files\Bizagi\Bizagi Modeler\Modeler\:

 

Webpublish_batch01

 

La documentación Web se generará para estos 4 archivos .bpm dentro de C:\Downloads\ (tal como se descargaron desde Process Xchange):

 

Webpublish_batch02

 

El archivo .bat especifica los siguientes parámetros:

"C:\Program Files\Bizagi\Bizagi Modeler\Modeler"\BizagiModeler.exe "Form 20F Management.bpm" /webPublish /publishPath:"C:\My models"

"C:\Program Files\Bizagi\Bizagi Modeler\Modeler"\BizagiModeler.exe "Onboarding Process.bpm" /webPublish /publishPath:"C:\My models"

"C:\Program Files\Bizagi\Bizagi Modeler\Modeler"\BizagiModeler.exe "Recruitment and Selection.bpm" /webPublish /publishPath:"C:\My models"

"C:\Program Files\Bizagi\Bizagi Modeler\Modeler"\BizagiModeler.exe "Change.bpm" /webPublish /publishPath:"C:\My models"

 

Webpublish_batch03

 

La ejecución de este archivo nombrado como publish.bat culmina exitosamente:

 

Webpublish_batch04

 

note_pin

Para este ejemplo específico y dado que el archivo .bat se ejecuta desde E:\Downloads al igual que los modelos .bpm que están allí en E:\Downloads, la ruta completa de estos archivos .bpm no es necesaria.

 

La ruta de resultado finalmente tendrá la documentación Web generada en distintas subcarpetas, cada una para cada archivo .bpm (además de un log con el detalle de la ejecución):

 

Webpublish_batch05

 

Notas importantes

Al momento de publicar desde la consola de comandos, considere:

1. Todos los parámetros de la consola son obligatorios.

2. Usted deberá cerciorarse de que cualquier archivo .bat que usted cree, sea consistente.

Por ejemplo y para modelos que contengan caracteres especiales o Unicode en su nombre, deberá asegurarse de guardar el archivo .bat soportando esos caracteres.

3. Cuando un modelo no cuenta con preferencias de publicación, Bizagi generará la documentación con todos los diagramas y elementos.