Bandeja Enviados Por Mi
Bandeja Enviados Por Mi
Resumen
La bandeja enviados por mi tiene las siguientes secciones donde se encuentran distintos recursos que podrán ser utilizados.
- Pendientes de autorización: en esta sección se pueden ver y editar documentos que fueron generados por el usuario y están pendientes a autorizar.
- Autorizados a revisar: en esta sección se pueden ver e interactuar con los documentos que han sido autorizados pero que por alguna razón no han completado los eventos siguientes al circuito de autorización.
Requisitos
- Araí-Usuarios: para indicar aquel o aquellos usuarios que deben autorizar
- Repositorio: para obtener los datos del estado actual del documento (Nuxeo, S3)
- Configuraciones dentro de Araí-Documentos de credenciales requeridas para Araí-Usuarios y Repositorio
- Identificador del usuario que va a consultar documentos
- Frontend para visualizar solicitudes pendientes de autorización y visualizar aquellos documentos que fueron autorizados pero no han completado los eventos subsiguientes (por ej. Huarpe SIUDocumentosBundle).
Pendientes a autorización
Descripción
La sección de Pendientes de autorización muestra de forma organizada todos los documentos que se han enviado para autorizar pero que aun no han pasado por el proceso de autorización, dentro de esta solapa se puede interactuar con los mismos.
Servicios comunes para trabajar con Documentos Esperando autorización
Presenta los siguientes servicios para su utilización. Estos son:
- Listado.
- Editar solicitudes de autorización.
- Cancelar procesos de autorización.
Listado
GET /backend/autorizacion/proceso-autorizacion?id_usuario_sso={id_usuario_sso}
Método: get_list
Parámetros:
id_usuario_sso (obligatorio, en URL)
skip_sudocu
Respuesta:
- 200 retorna JSON con una estructura definida.
- 400 Parámetros incorrectos
- 401 No autorizado
- 404 Parametros incorrectos o no encontrados
RESPONSE
{
"listado": [
{
"proceso": string,
"modelo": string,
"estado": int,
"documento": {
"uid": string,
"tipo": string,
"titulo": string,
"descripcion": string,
"referencia_interna": {
"uuid_interno": string
},
"identificador": {
"nro": string,
"anio": int,
"tipo": string,
"version": string,
"organismo": string,
"unidad_administrativa": int
}
},
"solicitudes": [
{
"solicitud": string,
"rol": string,
"situacion": int,
"situacion_descripcion": string,
"acciones": string,
"secuencia": int,
"usuario": {
"id_usuario_sso": string,
"nombre": string,
"email": string
}
}
]
}
]
}
Editar solicitudes de autorización
PUT /backend/autorizacion/proceso-autorizacion/{uid_proceso_autorizacion}/autorizantes
Método: put_autorizantes_list
Parámetros:
uid_proceso_autorizacion (en la URL)
Cuerpo de la Solicitud: JSON que contiene datos de autorizantes.
- @responses 200 Éxito
- @responses 400 Formato de proceso incorrecto
- @responses 401 Usuario no autorizado
- @responses 404 No se pudo obtener el proceso de autorizacion
- @responses 409 Conflicto con el estado del proceso de autorizacion
RESPONSE
{
"operacion": string,
"resultado": bool,
"descripcion": string
}
Cancelar procesos de autorización
DELETE /backend/autorizacion/proceso-autorizacion/{uid_proceso_autorizacion}
Método: delete
Parámetros:
uid_proceso_autorizacion (en la URL)
- @responses 200 Éxito
- @responses 400 Formato de proceso incorrecto
- @responses 401 Usuario no autorizado
- @responses 404 No se pudo obtener el proceso de autorizacion
- @responses 409 Conflicto con el estado del proceso de autorizacion
Autorizados a revisar
Descripción
Herramientas que permiten visualizar documentos que fueron autorizados pero no finalizaron los eventos complementarios (asociación/notificación) y da la posibilidad de continuar el flujo del mismo (reenviar) sin necesidad que los usuarios vuelvan a autorizar el documento. También permite anular el documento en caso que no se desee avanzar con el flujo de trabajo del mismo.
Servicios comunes para trabajar con Documentos Autorizados a Revisar
- Listado de los documentos: Lista de proceso de autorización con fallos.
- Reenviar: Reenviar la notificacion o asociacion/notificacion de un documento que fue autorizado pero no pudo completar el proceso.
- Anular: Anular documento autorizado.
Listado de documentos
GET /backend/autorizacion/fallos
Método: get
- @responses 200 Lista de procesos de autorización finalizados con errores
- @responses 400 Parámetros incorrectos
- @responses 401 No autorizado
- @responses 404 Parametros incorrectos o no encontrados
REQUEST
| Nombre | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| id_usuario_sso | string | Identificador del usuario que consulta procesos | Sí |
| titulo | string | contiene, no_contiene, comienza_con, termina_con, es_igual_a o es_distinto_de | No |
| descripcion | string | contiene, no_contiene, comienza_con, termina_con, es_igual_a o es_distinto_de | No |
| contexto | string | contiene, no_contiene, comienza_con, termina_con, es_igual_a o es_distinto_de | No |
| fecha_desde | string | es_menor_que, es_menor_igual_que, es_igual_a, es_distinto_de, es_mayor_igual_que, es_mayor_que o entre | No |
| fecha_hasta | string | es_menor_que, es_menor_igual_que, es_igual_a, es_distinto_de, es_mayor_igual_que, es_mayor_que o entre | No |
| busqueda | string | Sobre Título o descripción (mínimo 3 caracteres). No requiere condición, solo utiliza criterio "contiene". No se puede usar con otros filtros opcionales. | No |
| limit | int | Cantidad de registros (entero mayor a cero) | No |
| page | int | Número de página a traer (entero mayor a cero) | No |
| order | string | Ordenamiento de solicitudes. Campos separados por coma. Se define como order=+campo donde "+-" es ASC o DESC respectivamente. | No |
RESPONSE
{
"listado": [
{
"proceso": string,
"modelo": string,
"estado": int,
"contexto": string,
"documento": {
"uid": string,
"tipo": string,
"titulo": string,
"descripcion": string,
"tramite_expediente": string,
"fecha_creacion": string,
"referencia_interna": {
"uuid_interno": string
},
"identificador": {
"nro": string,
"anio": int,
"tipo": string,
"version": string,
"organismo": string,
"unidad_administrativa": int
}
},
"solicitudes": [
{
"solicitud": string,
"rol": string,
"situacion": int,
"situacion_descripcion": string,
"acciones": string,
"secuencia": int,
"usuario": {
"id_usuario_sso": string,
"nombre": string,
"email": string
}
},
],
"fallos": {
"estado_codigo": int,
"estado_descripcion": string,
"fecha": string,
"error_id": string,
"error_descripcion": string,
"cantidad_intentos": int
},
},
]
}
Reenviar
Arai-docs provee un sistema de reintentos automáticos, al cumplirse todos los reintentos recién en ese momento se mostraría el documento en la solapa de reenvío de documentos que han fallado. Los reintentos se realizan de forma exponencial en el tiempo, es decir que cada reintento tardara mas que el anterior en lanzarse.
Para cambiar la configuración de reintentos deben editar el archivo arai-docs.env, allí se encontrarán 2 variables:
RH_BACKOFF_BASE=4Esta variable indica la base exponencial de reintentos.ARAI_DOCS_RESTHOOK_MAXRETRIES=5Esta variable indica la cantidad de reintentos (partiendo de base '0') esto seria el exponente de los reintentos.
se recomienda no cambiar esta configuración, salvo necesidades particulares.
POST /backend/autorizacion/fallos/{uid_proceso_autorizacion}/reintentar
Método: post
Parámetros:
uid_proceso_autorizacion (en la URL)
- @responses 201 Reintento exitoso
- @responses 400 Reintento fallido (la notificacion no tuvo respuesta)
- @responses 404 No se pudo obtener el documento
- @responses 409 Conflicto con el estado del documentoautorizacion
RESPONSE
{
"operacion": "reintento_fallo",
"tipo_fallo": -80,
"resultado": true,
"descripcion": "Se ha reintentado el fallo con el documento: 50"
}
Anular
DELETE /backend/documentos/{uid_documento}
Método: delete
Parámetros:
uid_documento (en la URL)
- @responses 204 Éxito
- @responses 400 Error anulando documento
- @responses 401 Usuario no autorizado
- @responses 404 No existe el documento o el proceso
- @responses 409 Conflicto con el estado del proceso de autorizacion