Ayuda sobre productos BOLD:
Comando sincro
El comando sincro permite invocar otras acciones o subcomandos internos del módulo BOLDXML.
Nota: antes de ejecutar cualquier comando BOLDXML es necesario inicializar el entorno mediante una llamada al script BOLDXMLConfig.bat
Ayuda sobre el comando sincro
Si se ejecuta sincro sin ningún parámetro adicional, nos muestra la lista de comandos disponibles. Entre ellos están los siguientes:
sincro BorrarContratos 1 1 1: genera un documento de importación que borra todos los contratos de las personas empleadas en una lista de entrada. La lista de entrada está en el documento BorrarContratos.txt y consiste en un código de empleado/a por línea.
Nota: estos scripts externos (y sus transformaciones) normalmente están implementados directamente en la carpeta ..\BOLDXML2\scripts\sincroBOLDXML
Comando mutex_off / mutex_on
Este comando crea un semáforo que detiene la ejecución simultánea de dos comandos de sincro sobre la misma configuración de integración. Por ejemplo no se pueden lanzar dos sincros simultáneas en la misma instalación, sino que es necesario o bien separarlas en dos configuraciones (o carpetas de trabajo) separadas o bien ordenarlas mediante estos semáforos.
Cualquier comando sincro lleva implícita la activación del semáforo, pero si el comando sincro se detiene de forma inesperada, es posible que quede bloqueado impidiendo la ejecución de otras tareas. Para desbloquear el semáforo se ejecuta el comando siguiente:
sincro mutex_off
Nota: no es posible ejecutar más de un comando BOLDXML de forma simultánea por este motivo. Sin embargo, si se duplica la configuración, es decir se realiza una configuración con unas carpetas completamente independientes, entonces esto ya es posible (ya que el servidor sí que es multiproceso).
Comando GetBOLDXML
Se utiliza para transformar un fichero de XML en otro aplicando un lenguaje similar al XSLT. La sintaxis puede ser la siguiente:
sincro GetBOLDXML <transformacion> <xml_input> <xml_output>
También es posible invocarlos directamente con
GetBOLDXML <transformacion> <xml_input> <xml_output>
Para más detalles consulta la página Comando sincro GetBOLDXML.
Comando ImportWPXML
Se utiliza para importar un fichero XML dentro del servidor WorkPlanner. La sintaxis es la siguiente:
sincro ImportWPXML <clase> <fichero_xml>
También es posible invocarlos directamente con
ImportWPXML <clase> <fichero_xml>
Para más detalles Comando sincro ImportWPXML
Acciones de gestión del log de tareas de sincro
Los siguientes comandos están relacionados con la lista de tareas sincro ejecutadas.
sincro CollectTasksSummary <id_tarea>
Recoge un resumen con todas las tareas que hayan generado algún error o warning desde la tarea con el <id_tarea> indicado.
El resultado lo anexa (o lo crea si no existe) al contenido del fichero C:\ImportExport\a3_local\BOLDXML\AlertMessages.txt o en la ubicación que corresponda a la configuración de la carpeta cliente actual (../Integration).
Ejemplo:
sincro CollectTasksSummary 248
Opciones:
- si id_tarea=-1, entonces lo que hace es borrar el fichero
- si id_tarea en lugar de un número es un mensaje, entonces anexa dicho mensaje directamente:
call sincro CollectTasksSummary "See BOLDXML complete report at http://%COMPUTERNAME%/boldxml/BOLDXML_history.xml"
sincro MailTasksSummary
Envia por e-mail el contenido del fichero AlertMessages.txt anterior y lo borra. La configuración del servidor de correo se debe encontrar en el fichero BOLDXML.json. Los parámetros por ejemplo serían como los siguientes:
- «mail_user»: «pruebasgps@mydomain.com»,
- «mail_pwd»: «xxxx»,
- «mail_host»: «mail.mydomain.com»,
- «mail_from»: «pruebasgps@mydomain.com»
Ejemplo:
sincro MailTasksSummary destino@mydomain.com Titulo "Texto cabecera"
sincro XMLGetLastTaskID
Extrae el último ID de tarea de la lista de tareas ejecutadas y lo retorna en la variable de entorno std. ERRORLEVEL. Por ejemplo:
call sincro XMLGetLastTaskID echo %ERRORLEVEL%
El último ID de la lista de tareas ejecutadas también se inicializa tras cada llamada al script de inicialización del entorno BOLDXMLConfig.bat
sincro HTTPGet
Retorna la respuesta del comando GET contra la URL indicada. Normalmente será el texto HTML que se vería abriendo un browser contra la dirección indicada.
Ejemplo:
sincro HTTPGet http://www.gps-plan.com
sincro SendMail
Envía un mail. Los parámetros del servidor de correo deben estar pre-configurados en el BOLDXML.json (ver más arriba).
Ejemplo:
sincro SendMail "test@gmail.com,destin2@gmail.com" "titulo mensaje" "texto mensaje o fichero HTML
Ejemplo de configuración que debe existir en el BOLDXML.json para que funcione:
"mail_host": "miservidordemail.miempresa.com",
"mail_user": "miusuario_de_mail",
"mail_pwd": "mi_pwd_de_mail",
"mail_from": "miorigen@miempresa.com"Atención! Es importante que el mail_from sea un email de una cuenta que exista (al menos el dominio) porque normalmente los servidores de mail comprueban que exista. Y sino es posible que no nos de ningún error pero no recibamos los mails en la dirección destino.
sincro PDFShow
Vuelca los campos de tipo formulario que se hayan definido dentro de un fichero de tipo PDF. Este comando se utiliza como parte del módulo de gestión e impresión de formularios PDF ver Gestión de formularios PDF.
Ejemplo:
sincro PDFShow formulario_plantilla.pdf
sincro PDF
Generar un nuevo fichero PDF a partir de una plantilla de formulario PDF rellenando los campos de formulario PDF de entrada según los valores presentes en el archivo de fórmulas en formato json indicado. En el ejemplo siguiente se rellena la plantilla template.pdf según el mapping definido por las fórmulas del fichero json indicado y se genera un nuevo fichero output.pdf.
Ejemplo:
sincro PDF template.pdf output.pdf ContractWorker 30637 DiccionarioPDFTemplates.json
El fichero DiccionarioPDFTemplates.json debe tener un formato similar a este:
{
"clave1": "StartContract",
"clave2": "EncodeDate(2015,1,1)"
....
}
Las expresiones de la derecha serán evaluadas en el servidor en el contexto del objeto indicado y su resultado rellenará el campo del formulario correspondiente.
sincro MailIfLowMem
Envia un mail (según la configuración anterior) cuando la memoria disponible está por debajo del limite de MB fijado.
Ejemplo:
sincro MailIfLowMem 500
Este comando envia un mail de alerta cuando la memoria física disponible (la que sale en el TaskManager como disponible) está por debajo de los 500MB (0,5GB).