Información general
Acrobat Sign permite realizar búsquedas complejas para encontrar contenido en los acuerdos del usuario. La barra de búsqueda, que se encuentra en la página Administrar, devuelve todas las transacciones que coinciden con cualquier cadena proporcionada para el origen de contenido seleccionado.
- Si está buscando “Sus acuerdos”, se realiza una búsqueda respecto a su contenido. Si está en una cuenta compartida, buscará el contenido de las cuentas compartidas
El contenido de los campos siguientes se indexa al crear o actualizar una transacción:
- Título: título del acuerdo.
- Nota: una nota de acuerdo privado tomada por el participante que no es visible para nadie más.
- Mensaje: una lista de mensajes visibles para este participante (incluye tanto mensajes públicos como privados).
- Nombre de archivo original: nombre original de un archivo cargado asociado al acuerdo.
- Correo electrónico: dirección de correo electrónico del destinatario (incluidos los CC) o del remitente.
- Nombre completo: nombre y apellidos del destinatario (incluidos los CC) o del remitente.
- Cargo: el cargo del destinatario (incluidos los CC) o del remitente dentro de su compañía.
- Nombre de la compañía: nombre de la compañía o de la organización del destinatario (incluidos los CC) o del remitente.
- Nombre del grupo de destinatarios: nombre del nombre del grupo de acuerdos ad hoc al que pueden pertenecer los destinatarios.
- Contenido de campo de texto: contenido de campo de texto proporcionado por el usuario en el formulario.
- Nombre completo del usuario que comparte: nombre completo del usuario que comparte el acuerdo. En caso de no compartir, este es el nombre del usuario.
- Nombre del grupo de destinatarios del usuario que comparte: nombre del grupo de destinatarios del usuario que comparte el acuerdo. En caso de no compartir, este es el nombre del grupo de destinatarios del usuario.
- ID externo: el ID asignado al acuerdo por el remitente que puede ser de cualquier forma, pero normalmente en forma de "<groupID>:<ID>". El ID externo se transfiere en la llamada a la API de creación del acuerdo.
- ID de grupo externo: el ID de grupo asignado al acuerdo por el remitente que puede ser de cualquier forma, normalmente se utiliza como prefijo para el ID externo. El ID de grupo externo se transfiere en la llamada a la API de creación del acuerdo. Es necesario establecer un ID externo si se establece el parámetro ID de grupo externo.
- ID de transacción: ID asignado al acuerdo por Acrobat Sign al crearlo.
Cómo funciona la búsqueda de texto
Si busca la cadena: “A simple fish”
- Acrobat Sign transforma la cadena en tokens utilizando los espacios como delimitadores. La cadena de ejemplo se divide en tres tokens: A, simple y fish
- Los caracteres de una consulta de cadena pertenecen a uno de los tres tipos diferentes: letra, número o delimitador.
- Los caracteres que se tratan como delimitadores (aparte del espacio) son: ~ ` ! @ # $ % ^ & * ( ) - + = { } [ ] | \ . , : ; " ' < > ? /
- Los puntos, dos puntos y apóstrofos permanecen como parte de un token si los caracteres anteriores y posteriores a ese token son del mismo tipo.
- Las comillas que rodean toda la cadena de consulta no son delimitadores y especifican un valor de cadena literal (frase)
- Las comillas dentro de una cadena de consulta son delimitadores y no especifican un valor de cadena literal.
- Se elimina la distinción entre mayúsculas y minúsculas. Por ejemplo:, a, simple, y fish
- A continuación, la búsqueda intenta hacer coincidir el texto completo de cada token con un valor indexado
- Se produce una tokenización más compleja para el título del acuerdo (véase más adelante)
- Se utiliza una búsqueda inclusiva, lo que significa que todos los acuerdos que coincidan con al menos un token de, como mínimo, un campo en el que se puedan realizar búsquedas se incluyen en el conjunto de datos devuelto
- El conjunto de datos devuelto se ordena por puntuación de relevancia con el resultado de búsqueda más relevante en la parte superior.
CAMPO TÍTULO DEL ACUERDO
Como se ha indicado anteriormente, el campo Título del acuerdo tiene una tokenización más sofisticada debido a un tokenizador adicional “personalizado” que tokeniza principalmente los delimitadores en contexto (en lugar de como caracteres explícitos). Este tokenizador personalizado es diferente del estándar por lo siguiente:
- Se generan tokens de prefijo (hasta diez caracteres): un token de prefijo es la cadena incremental de cualquier token estándar. Por ejemplo, si el token estándar es fish, los tokens incrementales son f, fi, fis y fish
- De este modo, se pueden buscar cadenas parciales si se comienza con el primer carácter del token
- Las coincidencias en la mitad de una cadena se ignoran. Por ejemplo, si se busca rent, no se muestra como coincidencia la palabra apparently
- División de tokens en caracteres no alfanuméricos. Por ejemplo, la cadena Super_Man produce los tokens Super y Man
- Los guiones bajos no son delimitadores en el tokenizador estándar
- División de tokens en transiciones entre mayúsculas y minúsculas. Por ejemplo, la cadena PowerShot produce los tokens Power y Shot
- División de tokens en transiciones entre números y letras. Por ejemplo, la cadena XL500 produce los tokens XL y 500
- Elimina los delimitadores al comienzo y al final de cada token. Por ejemplo, la cadena XL---42+'Autocodificador' produce los tokens XL, 42 y Autocodificador
- Elimina los caracteres del posesivo en inglés ('s) al final de cada token. Por ejemplo, la cadena Dave's produce el token Dave
Tenga en cuenta que la combinación de los tokenizadores estándar y personalizados le permite buscar la cadena completa del token (gracias al tokenizador estándar) y los símbolos de prefijo (gracias al tokenizador personalizado). Aun así, no encontrará coincidencias con un token de prefijo que abarca un delimitador.
Ejemplo: si tiene un acuerdo llamado My_NDA
- El tokenizador estándar produciría un token similar a my_nda
- El tokenizador personalizado produciría una serie de tokens: m, my, n, nd, nda, my_, my_n, my_nd, my_nda
Ejemplo 2: si tiene un acuerdo denominado XL500
- El tokenizador estándar produciría un token similar a xl500
- El tokenizador personalizado produciría una serie de tokens: xl500, x, xl, 5, 50, 500, xl5, xl50
Búsqueda con sintaxis de consulta especial
Como se describe en la sección anterior, la búsqueda de acuerdos realiza una coincidencia aproximada entre todos los campos en los que se puede buscar un acuerdo. El contenido del campo que se puede buscar se convierte a tokens y, a continuación, estos se asignan a la cadena de consulta en el momento de la consulta. La búsqueda de acuerdos también busca los prefijos hasta diez caracteres para esos tokens. Si se encuentra al menos una coincidencia de token en un acuerdo, ese acuerdo aparecerá en los resultados de búsqueda. Los resultados de la búsqueda se ordenan por puntuación de relevancia, con el más relevante en la parte superior.
Sin embargo, las coincidencias de un valor de campo completo, las coincidencias de una frase de un valor de campo, las búsquedas de acuerdos que no contengan un token concreto y las búsquedas de acuerdos que contengan varios tokens al mismo tiempo (no una frase) solo se pueden lograr con una sintaxis especial. El lenguaje de consulta genérico de Sign (SGQL) se desarrolló para satisfacer las necesidades de los clientes en cuanto a estas funciones que requieren una sintaxis especial.
CARACTERES Y PALABRAS RESERVADOS
SGQL tiene siete caracteres reservados:
* ( ) \ " ' : |
---|
Estos caracteres reservados se utilizan como operadores y definen características de idioma en una consulta de búsqueda. Si se utiliza incorrectamente un carácter reservado, se devuelve un error de sintaxis.
Para utilizar caracteres reservados como caracteres normales en una consulta de búsqueda, es necesario escaparlos. Por ejemplo, la consulta de búsqueda
\( \"bea\:u\*ful\"\\ \) |
---|
tiene todos los caracteres reservados escapados y se tratan como caracteres normales.
SGQL también tiene tres palabras reservadas para los operadores:
AND OR NOT |
---|
Los operadores deben ir en mayúscula. Para utilizar operadores como tokens normales en una consulta de búsqueda, deben aparecer comillas dobles. Por ejemplo:
foo "AND" bar |
---|
COINCIDENCIA DE FRASE
Una consulta de coincidencia aproximada regular coincidirá si CUALQUIERA de los tokens aparece en un campo (pero no necesariamente todos). El orden de los tokens es irrelevante, ya que no necesitan aparecer juntos.
Se debe utilizar una consulta de coincidencia de frase cuando se requiera una búsqueda de frase exacta sin distinción de mayúsculas y minúsculas entre uno o más campos en los que se puede buscar. Nos permite hacer concordar dónde aparecen varios tokens en el mismo campo, y estos aparecen en el orden especificado entre comillas.
Formato de sintaxis de consulta de coincidencia de frase:
"<phrase_match_query>" |
---|
o
'<phrase_match_query>' |
---|
Si la sintaxis de la consulta no sigue las reglas de una sintaxis de consulta de coincidencia de frase, la búsqueda realizará una consulta de coincidencia aproximada regular entre todos los campos en los que se puede buscar.
Por ejemplo, la consulta
“Grupo de estudio” |
---|
coincidirá con los acuerdos que contengan la frase “grupo de estudio” en cualquiera de los campos en los que se puede buscar. Tenga en cuenta que la frase “estudio - grupo” no se encontrará en esta consulta, ya que no es una frase exacta que no distingue mayúsculas de minúsculas cuando se compara con “Grupo de estudio”.
Una coincidencia de frase puede aparecer en cualquier lugar dentro de una consulta de búsqueda. Por ejemplo,
título: (matemáticas AND “materiales del curso” AND “grupo de estudio”) |
---|
coincidirá con el título “Materiales del curso para el grupo de estudio MATH 101”, ya que este título contiene la palabra clave “MATH” y las frases “Materiales del curso” y “Grupo de estudio”.
PREFIJO DE NOMBRE DE CAMPO
Se debe utilizar una consulta de prefijo de nombre de campo al buscar un solo campo concreto de los acuerdos del usuario.
La consulta de prefijo de nombre de campo debe contener un prefijo de nombre de campo seguido de una consulta de búsqueda. Formato de sintaxis de consulta de prefijo de nombre de campo:
<field_name>:<query> |
---|
El prefijo del nombre de campo puede aparecer delante de un token o delante de una parte entre paréntesis de una consulta. Por ejemplo, en la consulta de búsqueda
título: ( Hola AND "Bello Mundo" AND "Mi Mundo" ) |
---|
todos los tokens se comparan con el campo título del acuerdo.
En la siguiente consulta de búsqueda
título: Hola AND "Bello Mundo" AND "Mi Mundo" |
---|
solo la palabra "Hola" tiene un prefijo de nombre de campo y esta palabra solo se compara con el campo de título del acuerdo. El resto de las palabras y frases se comparan con todos los campos en los que se puede buscar.
Si no se especifica <field_name>, se consultarán todos los campos compatibles con la coincidencia de frase. De lo contrario, solo se consulta el campo <field_name>.
Si la sintaxis de la consulta no sigue las reglas de la sintaxis de la consulta de prefijo de nombre de campo, la búsqueda de acuerdos utiliza toda la consulta como consulta de búsqueda y realiza una búsqueda entre todos los campos en los que se puede buscar.
Por ejemplo, la consulta de prefijo de nombre de campo:
título: ( Hello World ) |
---|
realiza una búsqueda solo en el campo que contiene el título del acuerdo.
A continuación, se muestra una lista de prefijos admitidos para la consulta de prefijo del nombre del campo. Los prefijos de nombre de campo no tienen distinción de mayúsculas y minúsculas.
CONTENIDO DE CAMPO |
PREFIJO DE NOMBRE DE CAMPO DE CONSULTA DE CADENA |
DESCRIPCIÓN DEL CONTENIDO DEL CAMPO |
Título |
title* |
Título del acuerdo. |
Nota |
nota |
Una nota de acuerdo privado tomada por el participante que no es visible para nadie más. |
Mensaje |
mensaje |
Una lista de mensajes visibles para este participante (incluye tanto mensajes públicos como privados). |
Nombre de archivo original |
originalFileName |
Nombre original de un archivo cargado asociado al acuerdo. |
Correo electrónico |
email** |
Dirección de correo electrónico del destinatario (incluidos los CC) o del remitente. |
Nombre completo |
fullName*** |
Nombre y apellidos del destinatario (incluidos los CC) o del remitente. |
Cargo |
jobTitle |
Cargo del destinatario (incluidos los CC) o del remitente dentro de su compañía. |
Nombre de la compañía |
companyName |
Nombre de la compañía u organización del destinatario (incluidos los CC) o del remitente. |
Nombre del grupo de destinatarios | recipientGroupName |
Nombre del grupo de acuerdos ad hoc al que pueden pertenecer los destinatarios. |
Contenido del campo de texto | textFieldContent |
Contenido del campo de texto proporcionado por el usuario en el formulario. |
Nombre completo del usuario que comparte | sharerFullName | Nombre completo del usuario que comparte el acuerdo. En caso de no compartir, este es el nombre del usuario. |
Nombre del grupo de destinatarios del usuario que comparte | sharerRecipientGroupName | Nombre del grupo de destinatarios del usuario que comparte el acuerdo. En caso de no compartir, este es el nombre del grupo de destinatarios del usuario. |
ID externo | externalId |
El remitente asignó un ID al acuerdo que puede ser de cualquier forma, pero normalmente en forma de "<groupID>:<ID>". El ID externo se transfiere en la llamada a la API de creación del acuerdo. |
ID de grupo externo | externalGroupId |
El remitente asignó al acuerdo un ID de grupo que puede ser de cualquier forma, que normalmente se utiliza como prefijo para el ID externo. El ID de grupo externo se transfiere en la llamada a la API de creación del acuerdo. Es necesario establecer un ID externo si se establece el parámetro ID de grupo externo. |
ID transacción | agreementId | El ID es asignado al acuerdo por Acrobat Sign cuando se crea el acuerdo. |
Para la compatibilidad con versiones anteriores, algunos de los prefijos de nombre de campo tienen alias cuya funcionalidad es equivalente a los prefijos de nombre de campo originales. Estos alias ya no se utilizan y, en algún momento, se eliminarán:
* Se puede usar el prefijo de nombre de campo 'name' en lugar de 'title'.
** Se puede usar el prefijo de nombre de campo 'participantEmail' en lugar de 'email'.
*** Se puede utilizar el prefijo de nombre de campo 'participantName' en lugar de 'fullName'.
COMODINES
Se puede utilizar un comodín ( asterisco * ) para hacer una coincidencia de prefijo seguido de un número ilimitado de caracteres en un token. La expansión de comodines es una operación costosa que se produce en tiempo de ejecución, por lo que deben seguirse las siguientes reglas de sintaxis para poder utilizar esta función:
- No se permiten comodines iniciales.
- No se permiten comodines en medio de un token.
- Se requiere un prefijo de nombre de campo para un token que tiene un operador de expansión de comodín.
- Un operador de comodín no se puede utilizar más de una vez en una consulta.
- Las consultas que contienen una expansión de comodín devuelven un error de tiempo de espera si el tiempo de ejecución supera los cinco segundos.
Por ejemplo, la consulta
title:myh* |
---|
coincide con los tokens de campo de título
myhost |
---|
y
La expansión de comodín es una operación costosa. Si se usa de manera poco inteligente, consume muchos recursos del sistema y es posible que deba esperar mucho tiempo para obtener los resultados de búsqueda. Para evitar estos problemas, SGQL tiene restricciones en el uso de comodines, lo que elimina los casos de uso más costosos y que consumen más recursos. Cuanto más específicos sean sus tokens, más eficaz será su búsqueda. La búsqueda de una palabra o frase específica es siempre más eficaz que una búsqueda que utilice un comodín.
EXPRESIONES BOOLEANAS
SGQL admite los operadores booleanos: AND, OR y NOT, así como la agrupación de estos mediante paréntesis. Los operadores deben ir en mayúscula.
El operador OR siempre está implícito entre tokens. Por ejemplo,
foo bar |
---|
es lo mismo que
foo OR bar |
---|
A menos que desee incluir el operador OR por motivos de claridad, no hace falta que lo especifique.
El operador NOT solo se aplica al token que aparece inmediatamente después de NOT. Para aplicar el operador NOT a varios tokens, debe incluir estos entre paréntesis.
En la siguiente tabla se describe el orden en el que se evalúan las expresiones booleanas.
Orden |
Comando de búsqueda |
---|---|
1 | Expresiones entre paréntesis |
2 | Cláusulas NOT |
3 | Cláusulas OR |
4 | Cláusulas AND |
En la tabla siguiente puede encontrar ejemplos de consultas semánticamente equivalentes que explican la prioridad de los operadores en caso de que no se proporcionen operadores de agrupación (paréntesis).
Consulta de búsqueda | Consulta de búsqueda reescrita equivalente | Comentarios |
---|---|---|
foo AND bar baz | foo AND ( bar OR baz ) | El operador OR está implícito y no debe utilizarse a menos que desee añadirlo por motivos de claridad. |
foo NOT bar baz | foo OR ( NOT bar ) OR baz | El operador NOT se aplica al siguiente token o a la parte entre paréntesis de una consulta. |
foo NOT bar baz AND xyz | ( foo OR ( NOT bar ) OR baz ) AND xyz | |
title: ( Hello AND "Beautiful World" "My World" ) | title:Hello AND ( title:"Beautiful World" OR title:"My World" ) | El prefijo de nombre de campo se aplica al siguiente token o a la parte entre paréntesis de una consulta. |
title: Hello AND note: "Beautiful World" "My World" | title:Hello AND ( note:"Beautiful World" OR "My World" ) | La frase "My World" se comparará con todos los campos en los que se pueda buscar. |