Operaciones para interactuar con Viafirma Documents usando un campo de tipo tabla y documentos relacionados

A continuación se describen operaciones que permiten interactuar con ViaFirma Documents para realizar peticiones customizadas, diferentes a las que permite la integración nativa de ambos productos.

Estas operaciones se apoyan en campos de tipo tabla que almacenan la configuración dinámica de las peticiones que se quieren realizar desde Athento para un grupo de documentos.

Realizar las peticiones de firma

Esta operación, permite enviar peticiones de firma usando un campo de tipo tabla donde se indican los firmantes y los documentos que estos deben firmar.

A continuación, se puede ver un ejemplo del campo tipo tabla y su estructura.

La operación a instalar es:

op_viafirma_document_request_table_metadata_v2

Una vez instalada se debe configurar. Las columnas de la tabla, se usarán para configurar los parámetros de la operación.

A continuación se describen los parámetros de la operación. Cuando el parámetro requiera el nombre de una columna de la tabla, se deberá usar el nombre interno de dicha columna, como se muestra en la imagen anterior.

Attachments column identifier: Identificador único de la columna que contendrá el nombre de los formularios que se solicitarán como adjuntos.
Documents column identifier: Identificador único de la columna que contendrá el nombre de los documentos cuya firma se solicitará al usuario. Estos nombres deben corresponderse con los de los documentos adjuntos y deben ser únicos.
Maximum number of reminders: Número máximo de recordatorios que serán enviados.
Notification type: Tipo de notificación que sera enviada al firmante.
Number of reminders: Número de recordatorios enviados por ViaFirma medidos en dias.
OTP type: Campo para indicar si se usa (indicando el tipo) o no se usa.
Phone number column identifier: Identificador único de la columna que contendrá el número de teléfono.
Request description: Descripción de la petición.
Request title: Título de la petición.
Signature column identifier: Identificador único de la columna que contendrá la información del estado de la firma de los documentos por firmante.
Signature order column identifier: Identificador único de la columna que contendrá el orden de firma.
Signer email column identifier: Identificador único de la columna que contendrá el email del firmante.
Signer first name column identifier: Identificador único de la columna que contendrá el nombre del firmante.
Signer second name column identifier: Identificador único de la columna que contendrá el segundo nombre del firmante en caso de que tenga.
Signer first surname column identifier: Identificador único de la columna que contendrá el primer apellido del firmante.
Signer second surname column identifier: Identificador único de la columna que contendrá el segundo apellido del firmante.
Signer identification number column identifier: Identificador único de la columna que tiene los identificadores de usuario.
Table field: Campo que define la tabla.
Template code: Código de la plantilla que se puede usar en el proceso de la petición (Opcional).
Put signature stamp on the document: Marcar Yes si se desea que el documento lleve el estampado con los firmantes.
Stamper type: Seleccionar el tipo de estampado que se desea.
Signature stamper rotation: Ingresar la rotación con la que se quiere ver el estampado en el documento.
Stamper position on the X axis: Ingresar la posición en el eje X en la que se quiere ver el estampado en el documento.
Stamper position on the Y axis: Ingresar la posición en el eje Y en la que se quiere ver el estampado en el documento.
Stamper page on the document: Ingresar la pagina del documento en la que se quiere ver el estampado (poner -1 si se quiere ver en la ultima pagina).
Stamper time zone: Ingresar el formato de la fecha que se quiere ver en el estampado.
Url to redirect the user: Url a la que se redireccionará al usuario cuando acabe su proceso de firma.
OTP notification text: Texto que se mostrará en el mensaje OTP.
Parámetros para customizar mensajes de envio:
- Request SMS body: Texto que será enviado como sms al hacer una petición.
- Request mail body: Texto o HTML que define el "body" del email.
- Callback mail success subject: Texto que define el asunto cuando la petición es finalizada correctamente.
- Callback mail success body: Texto o HTML que define el "body" cuando la petición es finalizada correctamente.
- Callback mail expired subject: Texto que define el asunto cuando la petición a expirado.
- Callback mail expired body: Texto o HTML que define el "body" cuando la petición a expirado.
- Callback mail reminder subject: Texto que define el asunto cuando la petición es reenviada.
- Callback mail reminder body: Texto o HTML que define el "body" cuando la petición es reenviada.

Nota: Los mensajes custom que son HTML, permiten los campos, sent_date, document_list y metadatos propios de ViaFirma.

Orden de firma

Cuando la operación sea ejecutada, se realizada una llamada a ViaFirma Documents con todos los documentos relacionados a firmar. Los documentos serán firmados en el orden impuesto. Hasta que los usuarios con un orden menor no hayan firmado los documentos, no se enviará la notificación de firma a los demás usuarios

En este ejemplo, se enviará el documento "Related 1.pdf" y "Related 2.pdf" al primer usuario. Hasta que este usuario no acabe el proceso de firma, no se enviarán los documentos al siguiente usuario.

Reenviar las peticiones por firmante

La operación permite reenviar un recordatorio a todos los firmantes que no han terminado el proceso de firma, es:

op_viafirma_document_resend_notification_recipient_v1

Parámetros de la operación a configurar:

Notification type: Tipo de notificación que sera enviada al firmante.
Phone number column identifier: Identificador único de la columna que contendrá el número de teléfono.
Signature column identifier: Identificador único de la columna que contendrá la información del estado de la firma por firmante.
Signer email column identifier: Identificador único de la columna que contendrá la información del correo electrónico.
Table field: Campo que define la tabla.
Way to obtain the signers: Forma de obtener los firmantes a los cuales se re-enviará la notificación de firma.
- To all signers whose signature is pending: Se enviará a todos los firmantes cuya firma esté en estado "PENDING".
- Row ID (must be sent in the data of the request): Se enviará al firmante de la fila indicada. Nota: para el uso de este tipo de opción se debe realizar bajo una petición request, en la peticion (envio) de la operación, se debe enviar en el body la fila. Ejemplo de body: {'rowId': 'row1'}
  - Ejemplo de petición: <host>/file/api/file/<document_uuid>/run_operation/?op_uuid=<operation_uuid>&rowId=<row_id> donde:
    - document_uuid: Identificador único del documento donde se lanzará.
    - op_uuid: Identificador único de la operación que se lanzará.
    - row_id: Identificador único de la fila del campo de tipo tabla. Este identificador se puede encontrar en el valor del campo bajo la llave DT_RowId.

Actualizar datos o documentos en Athento u Operaciones "callback"

Las operaciones "callback" son operaciones que no pueden ser ejecutadas manualmente. Se ejecutan cuando ViaFirma llama a la URL generica de callback a nivel de "message". Estas operaciones deben ser instaladas y configuradas antes de realizar cualquier proceso, ya que funcionan tras un callback de Viafirma y en caso de no estar instaladas o configuradas, para ese proceso de firma, se perderá la información/proceso de "callback".

Actualizar las peticiones

op_viafirma_document_message_callback_update_signature_status_table_metadata_v1

Esta operacion permite que se actualizen los estados tras un "callback" de viafirma.

Los parámetros que se deben configurar para su funcionamiento son:

Signature column identifier: Identificador único de la columna que contendrá la información del estado de la firma por firmante.
Table field: Campo que define la tabla.

Descargar el documento firmado

op_viafirma_document_message_callback_download_binary_v1

Esta operación permite que se actualice el contenido (binario) del documento que se ha firmado y así tener el documento firmado en la plataforma Athento.

No es necesario configurar ningún parámetro.

NOTA: Esta operación "callback" solo es ejecutada cuando el proceso de firma es "RESPONSED" (documentación).

Descargar los adjuntos

op_viafirma_document_message_callback_download_attachment_v1

Esta operación permite que se descarguen y se relacionen en Athento los adjuntos subidos por los firmantes en el proceso de firma.