Documentos
En la página de documentos puedes crear plantillas de documentos, para generar documentos automáticamente en tus flujos a través de Business Logic. Aquí puedes crear los documentos para Firma Digital. En Kosmos existen dos tipos de plantillas de documento que puedes crear:
PDF
EXCEL
Parámetros de entrada
Los parámetros de entrada tienen la función de completar automáticamente tu plantilla de documento con datos capturados o generados en un flujo.
Ejemplo de uso
Imagina que tienes un plantilla en PDF de contratación de personal de la siguiente manera:
[De una parte,
___________, mayor de edad, con domicilio ubicado en _________, con CURP ________, y en su propio nombre y representación.]
En esta plantilla, agregaste tus parámetros de entrada según los datos que se van a completar. Para asociar estos parámetros con las variables del flujo utilizaste el nodo “Documento” de Business Logic.
[De una parte,
#Nombre #Apellido, mayor de edad, con domicilio ubicado en #Ciudad, con CURP #Curp, y en su propio nombre y representación.]
Una vez que se ejecuta el Business Logic mientras el flujo está en ejecución, el contrato se genera automáticamente de la siguiente manera.
[De una parte,
Juan Ramírez, mayor de edad, con domicilio ubicado en Monterrey, con CURP RASJ801217HNLMNN04, y en su propio nombre y representación.]
Componentes para configurar parámetros de una plantilla de documento
Para agregar los parámetros en el cuerpo de tu plantilla, y que los datos ocupen su lugar correctamente en el documento, tienes los componentes para configurar parámetros. Estos componentes están disponibles en las plantillas de tipo PDF.
Con estos componentes puedes agregar datos del flujo a tu plantilla con el “nodo Documento”, o incluir firmas digitales, videos y estampas de tiempo con el nodo “Firma Digital”.
Los componentes son:
Texto: Para parámetros de tipo Cadena de caracteres, Número entero, Número decimal y Fecha. Usa este componente para completar con datos del flujo.
Firma: Este componente registra una firma digital en conjunto con el Nodo Firma Digital.
Imagen: Para parámetros de tipo Imagen. Usa este componente para agregar imágenes del flujo al documento.
CheckBox: Este componente agrega un signo de Check “✓” al documento si se cumple la condición que configuras. Esta condición se configura entre un valor que determinas en el parámetro del componente, y su relación con un valor que asocias en el flujo para este parámetro.
Estampa: Agrega una estampa de tiempo a las firmas o videos de tu documento en conjunto con el Nodo Firma Digital.
Videos: Para capturar un video del usuario final aceptando términos y condiciones, o video mientras realiza la firma, en conjunto con el Nodo Firma Digital.
¿Cómo crear una plantilla de documento PDF?
Haz clic en la opción “Documentos” del menú de módulos.
Haz clic en “Agregar documento”.
En “Tipo de documento” selecciona “PDF”.
Haz clic en “Ver más” en la sección de “Detalles”.
Escribe el nombre de tu plantilla en “Nombre del documento”.
Describe tu plantilla en “Descripción del documento”.
(Opcional)Haz clic en “Ver más” en la sección “Parámetros de entrada”. Sólo en caso de que tu documento tenga que completarse con variables de flujo.
Haz clic en “+Agregar nuevo parámetro”.
Escribe el nombre del parámetro en “Nombre del parámetro”.
Selecciona el tipo de dato en “Tipo de parámetro”. Es importante que el tipo coincida con el tipo de la variable, de lo contrario, la plataforma notificará un error. Las opciones de tipo son:
Cadena de caracteres
Número entero
Número decimal
Fecha
Imagen
Repite este proceso para todos tus parámetros.
Haz clic en “Ver más” en la sección de “Configuración”.
En “Template del documento” haz clic en “Carga tu documento” y sube tu plantilla PDF desde tu equipo.
Haz clic en “Editar template” para configurar los parámetros de entrada. La plataforma te mostrará la página de edición de documento.
En la sección izquierda de la página están los componentes para configurar los parámetros de entrada.
En la sección central está la plantilla del documento.
En la sección derecha están las páginas que conforman la plantilla. Cuando agregas un componente, en esta sección verás las opciones para configurarlo.
Selecciona los componentes y arrastrarlos hasta su lugar correspondiente en tu plantilla. Repite este paso para todos los componentes que existen
En la sección derecha, configura los componentes de acuerdo a su función en el documento.
Haz clic en “Regresar”.
(Opcional) Haz clic en “Ver más” en la sección de “Anexos” si quieres agregar anexos a tu plantilla.
En “Plantilla de anexo” haz clic en “Carga tu documento” y sube tu plantilla desde tu equipo.
Activa la función “Bitácora de servicios” si quieres que se incluya una bitácora de servicios en el documento.
Activa la función “Bitácora general” si quieres que se incluya una bitácora de servicios en el documento.
Haz clic en “Finalizar” para guardar tu plantilla.
Si quieres editar o eliminar una plantilla haz clic en el ícono correspondiente.
“Eliminar” representado con un ícono de papelera.
“Editar” representado con un ícono de lápiz.
Importante: Si editas o actualizas una plantilla de documento, debes actualizar también el nodo documento o firma digital, de tus flujos donde uses esa plantilla.
Configura un componente de texto en un documento
Ingresa a la edición de tu Template.
Ubícate en la página de la plantilla donde vas a colocar el componente.
Selecciona el componente “Texto” y sin soltar, arrástralo a tu plantilla.
En la barra derecha, modifica los valores de “X” e “Y” para posicionar el componente en el cuerpo del documento.
X para mover de izquierda a derecha.
Y para mover de arriba a abajo.
Modifica los valores de “Alto” y “Ancho” para modificar el tamaño del componente.
Modifica el valor de “Tamaño de letra” para determinar el tamaño de letra con el que se plasmarán los datos del flujo en el documento.
Activa la función “Es un párrafo”, si quieres permitir texto con mayor longitud.
En “Parámetro” despliega la lista y selecciona uno de los parámetros agregados en “Parámetros de entrada”.
Para guardar tu configuración haz clic en el símbolo “<” que se encuentra a un costado de “TIPO ITEM A EDITAR”.
Configura un componente de imagen en un documento
Ingresa a la edición de tu Template.
Ubícate en la página de la plantilla donde vas a colocar el componente.
Selecciona el componente “Imagen” y sin soltar, arrástralo a tu plantilla.
En la barra derecha, modifica los valores de “X” e “Y” para posicionar el componente en el cuerpo del documento.
X para mover de izquierda a derecha.
Y para mover de arriba a abajo.
Modifica los valores de “Alto” y “Ancho” para modificar el tamaño del componente.
En “Parámetro” despliega la lista y selecciona uno de los parámetros agregados en “Parámetros de entrada”. Sólo se mostrarán disponibles los parámetros de tipo Imagen.
Para guardar tu configuración haz clic en el símbolo “<” que se encuentra a un costado de “TIPO ITEM A EDITAR”.
Configura un componente de firma en un documento
Ingresa a la edición de tu Template.
Ubícate en la página de la plantilla donde vas a colocar el componente.
Selecciona el componente “Firma” y sin soltar, arrástralo a tu plantilla.
En la barra derecha, modifica los valores de “X” e “Y” para posicionar el componente en el cuerpo del documento.
X para mover de izquierda a derecha.
Y para mover de arriba a abajo.
Modifica los valores de “Alto” y “Ancho” para modificar el tamaño del componente.
En “Nombre de la Firma” escribe el Nombre que quieres dar a esta firma. Con este nombre podrás identificarla en el nodo “Firma Digital”.
Para guardar tu configuración haz clic en el símbolo “<” que se encuentra a un costado de “TIPO ITEM A EDITAR”.
Configura un componente de checkbox en un documento
Ingresa a la edición de tu Template.
Ubícate en la página de la plantilla donde vas a colocar el componente.
Selecciona el componente “Checkbox” y sin soltar, arrástralo a tu plantilla.
En la barra derecha, modifica los valores de “X” e “Y” para posicionar el componente en el cuerpo del documento.
X para mover de izquierda a derecha.
Y para mover de arriba a abajo.
Modifica los valores de “Alto” y “Ancho” para modificar el tamaño del componente.
En “Parámetro” despliega la lista y selecciona uno de los parámetros agregados en “Parámetros de entrada”.
En “Valor que debe hacer match” elige la condición entre el valor que vas a determinar y un valor del flujo. Las opciones dependen del tipo de parámetro.
Si el tipo de parámetro es “Texto, las opciones son:
Igual a
El checkbox se marcará si el valor del flujo y el valor que determinas en el componente es el mismo.
No igual a
El checkbox se marcará si el valor del flujo y el valor que determinas en el componente no son los mismos.
Contiene
El checkbox se marcará si el valor del flujo contiene el valor que determinas en el componente.
No contiene
El checkbox se marcará si el valor del flujo no contiene el valor que determinas en el componente.
Expresión regular
En el caso de expresión regular, puedes ingresar una expresión regular de Javascript y el checkbox se marcará cuando se cumpla la expresión.
Si el tipo de parámetro es número entero, número decimal o fecha, las opciones son:
Igual a
El checkbox se marcará si el valor del flujo y el valor que determinas en el componente es el mismo.
Mayor que
El checkbox se marcará si el valor del flujo es mayor que el valor que determinas en el componente es el mismo.
Menor que
El checkbox se marcará si el valor del flujo es menor que el valor que determinas en el componente es el mismo.
Mayor que o igual
El checkbox se marcará si el valor del flujo es igual o mayor que el valor que determinas en el componente es el mismo.
Menor que o igual
El checkbox se marcará si el valor del flujo es igual o menor que el valor que determinas en el componente es el mismo.
Si quieres agregar más de una condición, vuelve a desplegar la lista y elige otra relación.
Después de seleccionar tu condición, verás un campo con el nombre de la condición. En este campo escribe el valor con el que vas a hacer la condición. El formato del valor depende del tipo de parámetro.
Si es un parámetro de tipo texto y elegiste, No igual, Contiene o No contiene, puedes agregar más de un valor para la condición. Solo escribe tu valor y presiona “Enter” para agregarlo. Y ahora escribe otro valor. Repite el proceso para todos tus valores.
Para guardar tu configuración haz clic en el símbolo “<” que se encuentra a un costado de “TIPO ITEM A EDITAR”.
Configura un componente de video en un documento
Ingresa a la edición de tu Template.
Ubícate en la página de la plantilla donde vas a colocar el componente.
Selecciona el componente “Video” y sin soltarlo, arrástralo a tu plantilla.
En la barra derecha, modifica los valores de “X” e “Y” para posicionar el componente en el cuerpo del documento.
X para mover de izquierda a derecha.
Y para mover de arriba a abajo.
Modifica los valores de “Alto” y “Ancho” para modificar el tamaño del componente.
En “Tipo de video” despliega la lista y selecciona el tipo de video que se va a capturar en este componente. Las opciones son:
Video de la firma
Video de TyC
Recuerda que tienes que agregar un componente de Video por cada Firma al que quieres configurar el video.
Importante: Este componente agrega el video para las firmas según el orden en el que las agregaste.
Por ejemplo; si agregaste tres componentes de firma, y los nombraste de la siguiente manera:
Firma Arrendatario
Firma Aval
Firma Arrendador.
Y después agregas un componente de Video y en Tipo de video seleccionas “Video de la firma”, en el componente verás “Video de la Firma 1”. Esto quiere decir que este video aplicará a “Firma Arrendatario”.
Si agregas otro componente de Video, y en Tipo de video vuelves a seleccionar “Video de la firma”, en el componente verás “Video de la Firma 2”. Esto quiere decir que este video aplicará a “Firma Aval”.
Si después agregas otro componente de Video, y en Tipo de video seleccionas “Video de TyC”, en el componente verás “Video de TyC 1”. Esto quiere decir que este video aplicará a “Firma Arrendatario”.
Para guardar tu configuración haz clic en el símbolo “<” que se encuentra a un costado de “TIPO ITEM A EDITAR”.
Configura un componente de estampa en un documento
Ingresa a la edición de tu Template.
Selecciona el componente “Estampa” y sin soltar, arrástralo a tu plantilla.
En la barra derecha, modifica los valores de “X” e “Y” para posicionar el componente en el cuerpo del documento.
X para mover de izquierda a derecha.
Y para mover de arriba a abajo.
Modifica los valores de “Alto” y “Ancho” para modificar el tamaño del componente.
En “Tipo de la estampa” despliega la lista y selecciona a qué componente le vas a agregar la estampa de tiempo. Las opciones son:
Estampa de la firma
Estampa del video
Estampa del video de TyC
Recuerda que tienes que agregar un componente de Estampa por cada Firma o Video al que quieres configurar una estampa.
Importante: Este componente agrega la estampa a los componentes según el orden en el que los agregaste.
Por ejemplo; si agregaste tres componentes de firma, y los nombraste de la siguiente manera:
Firma Arrendatario
Firma Aval
Firma Arrendador.
Y después agregas un componente de Estampa y en Tipo de estampa seleccionas “Estampa de firma”, en el componente verás “Estampa de la Firma 1”. Esto quiere decir que esta estampa aplicará a “Firma Arrendatario.
Si agregas otro componente de estampa, y en Tipo de estampa vuelves a seleccionar “Estampa de firma”, en el componente verás “Estampa de la Firma 2”. Esto quiere decir que esta estampa aplicará a “Firma Aval”. Este orden también aplica para los videos.
Para guardar tu configuración haz clic en el símbolo “<” que se encuentra a un costado de “TIPO ITEM A EDITAR”.
Preguntas frecuentes
¿Qué función cumple el componente de Checkbox en las plantillas de documento de Kosmos?
El componente de Checkbox agrega un signo de Check "✓" al documento si se cumple la condición que se configura. Esta condición se establece entre un valor que determinas en el parámetro del componente y su relación con un valor que asocias en el flujo para ese parámetro.
¿Qué tipo de datos se pueden utilizar con el componente de Checkbox?
El componente de Checkbox se puede utilizar con datos booleanos, es decir, valores verdaderos o falsos. También se pueden utilizar valores numéricos que representan el estado verdadero o falso, por ejemplo, 1 para verdadero y 0 para falso
¿Qué pasa si actualizo una plantilla de documentos?
Puedes editar tus plantillas de documentos siempre que lo necesites, sin embargo, es importante recordar que debes actualizar todos los nodos de business Logic en tus flujos donde utilices esa plantilla.
¿Cómo crear una plantilla de Excel?
Haz clic en la opción “Documentos” del menú de módulos.
Haz clic en “Agregar documento”.
En “Tipo de documento” selecciona “Excel”.
Haz clic en “Ver más” en la sección de “Detalles”.
Escribe el nombre de tu plantilla en “Nombre del documento”.
Describe tu plantilla en “Descripción del documento”.
Haz clic en “Ver más” en la sección “Parámetros de entrada”. Aquí vas a ingresar los parámetros de los datos que se van a incluir en la hoja de cálculo.
Haz clic en “+Agregar nuevo parámetro”.
Escribe el nombre del parámetro en “Nombre del parámetro”.
Selecciona el tipo de dato en “Tipo de parámetro”. Es importante que el tipo coincida con el tipo de la variable, de lo contrario, la plataforma notificará un error. Las opciones de tipo son:
Cadena de caracteres
Número entero
Número decimal
Fecha
Imagen
Repite este proceso para todos tus parámetros.
Recuerda que cada parámetro corresponde al valor de una celda en un documento de Excel. Asegúrate de colocar todos los parámetros necesarios.
También puedes crear un parámetro, para cada columna, y completar las celdas de esa columna con un arreglo, o lista, generado en el flujo con un nodo de Código.
Haz clic en “Ver más” en la sección de “Configuración”. Aquí vas a construir tu documento con filas y columnas.
Haz clic en “+Añadir columna” para agregar más columnas a tu documento Excel. Repite el proceso hasta tener el número de columnas que necesites.
Haz clic en “+Añadir fila” para agregar más filas a tu documento Excel. Repite el proceso hasta tener el número de filas que necesites.
Para cambiar el nombre de una columna haz clic en “Nombre de la columna” y escribe el nombre de tu columna.
Los nombres de las columnas son el texto que aparece en las celdas de la primera fila en el documento de Excel.
Para configurar las celdas haz clic en “Editar” representado con el ícono de cada celda.
En “Tipo de contenido”, despliega la lista y selecciona el tipo de parámetro. Las opciones son “Texto” o “Imagen”
En “Parámetro”, despliega la lista y selecciona un parámetro. Las opciones dependen de los parámetros agregados en la sección de “Parámetros”.
Haz clic en “Guardar”.
Repite este proceso para todas tus celdas.
Si quieres intercambiar el lugar de dos celdas, haz clic en el signo de la cruz que está en la esquina de la celda que quieres mover, y sin soltar, arrástrala al lugar de la celda con la que va a intercambiar lugar.
Haz clic en “Finalizar” para guardar tu plantilla.
Si quieres editar o eliminar una plantilla haz clic en el ícono correspondiente.
“Eliminar” representado con un ícono de papelera.
“Editar” representado con un ícono de lápiz.
Configura un componente de imagen en un documento
Ingresa a la edición de tu Template.
Ubícate en la página de la plantilla donde vas a colocar el componente.
Selecciona el componente “Imagen” y sin soltar, arrástralo a tu plantilla.
En la barra derecha, modifica los valores de “X” e “Y” para posicionar el componente en el cuerpo del documento.
X para mover de izquierda a derecha.
Y para mover de arriba a abajo.
Modifica los valores de “Alto” y “Ancho” para modificar el tamaño del componente.
En “Parámetro” despliega la lista y selecciona uno de los parámetros agregados en “Parámetros de entrada”. Sólo se mostrarán disponibles los parámetros de tipo Imagen.
Para guardar tu configuración haz clic en el símbolo “<” que se encuentra a un costado de “TIPO ITEM A EDITAR”.