¿Cómo previsualizar documentos mediante un filtro en la URL?

Para facilitar las labores de integración, Athento ofrece la capacidad de usar URLs (que pueden enlazarse o embeberse en e-frames) para previsualizar los documentos resultado de un filtro de metadatos.

Previsualizar el resultado de la consulta

Para ello, se usará el siguiente patrón en la URL:

https://app.athento.com/file/preview/_/?filter=<filtro>&page=<pagina>&sort=<columna>&hf=<ocultar>

donde,

• <filtro>, es el el conjunto de campos (con sus valores) que usará Athento para obtener los documentos que contengan esos valores en los campos indicados. Podemos determinar los siguientes filtros: 
  • serie=<nombre_serie>: Indica la serie de la cuál se recogerán los documentos.
  • excluded_serie=<nombre_serie>: Indica la serie de la cuál se excluirán los documentos.
  • type=<nombre_formulario>: Indica el formulario del cuál se recogerán los documentos.
  • excluded_type=<nombre_formulario>: Indica el formulario del cuál se excluirán los documentos.
  • <nombre_campo>=<valor_campo>: Indica el nombre y el valor del campo, para sacar los documentos que cumplan con la condición. 

Si queremos usar varios filtros debemos unirlos con el carácter &, por ejemplo <filtro1>&<filtro2>. Se pueden unir filtros del mismo tipo.

Ej: metadata.mymetadata=123456&metadata.myothermetadata=5678
NOTA: el valor del filtro deberá estar cifrado según la política de Athento.

Otros parámetros de URL opcionales:

• <page>, indica el índice del documento a mostrar según el resultado obtenido.
• <sort>, indica la columna de ordenación para la ejecución del filtro:
  • id, creation_date, filename
  • Puede usarse el símbolo "-" delante de la columna para indicar ordenación descendente.
• <hf>, es usado para ocultar los valores del filtro usado, por defecto, con valor false indicando que el filtro es mostrado.

Ejemplo de una consulta

Si se desea previsualizar los documentos asociados a un cliente específico (001) de una empresa determinada (0056) y esta información existe en los campos de los documentos, Athento puede ofrecer la previsualización de todos los documentos que cumplan con esos dos valores. 

En este caso, el filtro a usar sería:

metadata.customer_ID=001&metadata.customer_company=0056

Para hacer la consulta más segura, esta debe hacerse codificada en base64. 

bWV0YWRhdGEuY3VzdG9tZXJfSUQ9MDAxJm1ldGFkYXRhLmN1c3RvbWVyX2NvbXBhbnk9MDA1Ng==

Así mismo, delante y detrás de la consulta debe incluirse una cadena de texto. 

La URL completa sería la siguiente:

https://app.athento.com/file/preview/_/?filter=12341234bWV0YWRhdGEuY3VzdG9tZXJfSUQ9MDAxJm1ldGFkYXRhLmN1c3RvbWVyX2NvbXBhbnk9MDA1Ng==12341234

Si el usuario que accede a esta página se encuentra autenticado, podrá ver la previsualización de los documentos. En otro caso, la autenticación debe hacerse vía token.