Conceptos Clave
Conceptos Clave
A continuación describiremos los conceptos que más se utilizan en Araí-Documentos. Se refiere a aquellos conceptos, modelos y fundamentos sobre los cuales se construye esta API y que permite abordar la comunicación entre los distintos participantes que interactuan en un proceso:
Documento
Es la entidad principal de esta API. Todas las acciones se realizan en base a un documento. Un documento en si, es un binario de un documento, un titulo, tipo de documento, usuario de creacion y demas metadatos asociados al mismo.
A cada documento dentro de Araí Documentos le corresponde un identificador único mediante el cual puede ser consultado y manipulado
Metadata
Son todos aquellos datos asociados a un binario, es información obligatorio para la creación del documento como el tipo y el usuario de creación, asi como información adicional que puede guardar la aplicación que genera el documento.
Adicionalmente se debe guardar un objeto que identifique al documento y permita realizar búsquedas o clasificaciones de los mismos, como el tipo de documento, numeración y año de creación.
Tipo de Documento
Existen una serie de tipos de documentos que deben ser identificados tanto por la aplicacion que origina el documento, la API de documentos y el sistema de expedientes (Sudocu) en caso de que este último este implementado.
Usuario
Corresponde a un usuario de la persona que ejecutará acciones sobre los documentos. Estos datos viven en el sistema de usuarios correspondiente (Normalmente Araí-Usuarios).
El Usuario ademas de ser la entidad que crea un documento, será también a quien se envíe un documento para que lo autorice.
Autorización
Es la forma en que se registra dentro del Sistema el acto de autorizar un documento por parte de un Usuario. Existen dos tipos de autorización dentro de Araí-Documentos, uno corresponde a la Firma Digital y el otro a una autorización basica, este último no posee facultades legales.
Proceso de Autorización
Es el proceso en el que incurre un documento para ser considerado autorizado. Pueden ser multiples casos, el más simple es que una única persona autorice un documento, pero existen tambien procesos de autorización en el que más de un usuario deba autorizar el documento, pudiendo requerirse que se realicen las autorizaciones en un orden determinado.
Solicitud de Autorización
Es el requerimiento de Autorización a un Usuario. Es decir es la petición que se hace a un Usuario para que autorice un documento.
Mediante la Solicitud de Autorización, el usuario podria ingresar a una aplicación y consultar los pedidos de Autorización que tiene pendientes.
Nivel de Autorización
Es el tipo de autorización requerido para cada Solicitud de Autorizacion. El nivel de autorización requerido se enviará por cada solicitud a un usuario. Los niveles de autorización disponible son:
- "firma": Se indica para requerir que el usuario autorice el documento mediante firma digital
- "basica": Se indica para requerir que el usuario autorice el documento mediante un check simple, que no produce modificaciones en el documento.
De esta forma, por cada usuario del cual se requiere autorización se indicará si esta debe ser Firma Digital o Autorización Básica
Autorización Básica
Es un mecanismo mediante el cual el Usuario visualiza una Solicitud de Autorización, realizando una revision del Documento que le fue enviado a Autorizar, y simplemente realiza chequeo simple presionando un botón en el cual indica que Autoriza un Documento sin producir cambios en el mismo. Es decir que la Autorizacion Básica, no realiza cambios en el binario del documento (como en el caso de Firma Digital) sino que simplemente se le avisa a Arai-Documentos que el Usuario aprueba el Documento.
Firma Digital
Es un mecanismo que permite incorporar al documento un hash cifrado indicando que el documento ha sido firmado por una persona. Para mas información sobre firma digital le recomendamos el siguiente manual http://www.jus.gob.ar/media/3175414/manual_de_firma_digital_actualizado.pdf.
Proceso de Firma Digital
Debido a que existe una amplia gama de aplicaciones que permiten firmar un documento digitalmente, Araí-Documentos describe un mecanismo mediante el cual se puede interactuar para descargar el documento a partír de una Solicitud de Autorización y subir el Documento firmado digitalmente.
Expediente
Para Araí-Documentos un expediente es simplemente un identificador al cual se va a asociar un documento luego de completar un proceso de autorización. Para ello Arai-Documentos interactua con un sistema de expedientes, encargándose de aislar a la aplicación de origen de que sistema de expedientes se utiliza y llamando directamente a los servicios expuestos por el sistema de expedientes (Sudocu)
Casos de Uso Básicos
La idea de esta sección es explicar brevemento funcionalidades que se pueden ejecutar sobre un documento, como asociar un documento a sudocu, ciclo de vida de un proceso de autorización, tipos de documentos y validaciones básicas
Almacenar Documento
Cuando se requiere unicamente utilizar Araí-Documentos para almacenar documentos en el CMS, únicamente se va a utilizar un servicio basico donde se creará el documento con sus metadatos correspondientes.
Se realiza un Post a la API para crear un documento, indicando algunos metadatos del documento como el tipo de documento, el usuario que lo creo, título y descripción del documento, ademas del propio documento.
Proceso de Autorización
En algunos procesos propios de los sistemas, estos requieren que por algun motivo un documento sea analizado y autorizado por alguna persona dentro de la organización. Con este motivo el documento se introduce en un proceso de autorización en el cual una o muchas personas podran aprobar el documento (quizás firmar digitalmente) .
Para ello Arai-Documentos provee una serie de servicios donde se le indicara quienes seran las personas involucradas en la autorización de un documento y el nivel de autorización que requieren las mismas (firma digital o autorización básica), para que mediante un sitio web o aplicación las personas puedan ver las solicitudes que deben autorizar, y realizar la autorización correspondiente. Una vez finalizado este proceso se puede notificar a la aplicación que creo el documento, para que la misma sepa que el documento ya fue autorizado (o no).
En el medio de un proceso de autorización pueden intervenir otras aplicaciones como un programa que interactúe con un token de firma digital para autorizar un documento o la bandeja donde la persona podra ver las solicitudes que tiene pendientes de autorizar (implementado en bundle de huarpe)
Modelos de Autorización
Todos los Procesos de Autorización funcionan en el marco de un modelo de autorización predefinido, donde se le indica como deben realizarse las autorizaciones que se envían a firmar y cuando finaliza un proceso de autorizaciones. Actualmente Arai-Documentos soporta algunos Modelos de Autorizacion:
"Simple" Autorizante único
Se envia el documento a autorizar a una sola persona, cuando esta firma se da por autorizado el documento
"Simple" multiples Autorizantes
Se envia el documento a autorizar a mas de una persona, cuando todas firman se da por autorizado el documento
"Cadena" multiples Autorizantes
Se envia un documento a autorizar por mas de una persona, se debe respetar el orden de Autorización de cada Autorizante. Una vez que todos autorizan el documento en orden se da por autorizado el documento.
"Algunos" (No disponible)
Se envía el documento a mas de una persona y solo algunos deben realizar la autorización. Aun no se encuentra disponible, y esta pendiente la definición de las reglas de como se realizara la peticion
"Alguno" (No disponible)
Se envía el documento a mas de una persona, y solo una debe autorizar para que el documento quede en estado autorizado. Aun no se encuentra disponible, y esta pendiente la definición de las reglas de como se realizara la peticion
Asociar Documento a Expediente
Indicando únicamente el identificador del tramite asociado al documento que se crea en Araí-Documentos, el mismo se encargara de asociar el documento al expediente correspondiente dentro del sistema de expedientes una vez que este documento sea actualizado.
Notificar Aplicaciones
Esta funcionalidad permite recibir notificaciones cuando existan cambios sobre un documento. Es decir la aplicación que genera el documento puede indicar la direccion de un servicio web propio para ser notificada cuando se generen acciones sobre el documento que envió.