Översikt
Med Acrobat Sign kan du göra komplexa sökningar av innehåll i användarens avtal. Sökfältet, som finns på sidan Hantera, visar alla transaktioner som matchar någon av de strängar som har angetts för den valda innehållskällan.
- Om du tittar på "dina avtal" söker du i ditt innehåll. Om du tittar på ett delat konto söker du i det delade kontots innehåll
Innehållet i nedanstående fält indexeras när en transaktion skapas/uppdateras:
- Titel – avtalstitel.
- Anteckning – en privat avtalsanteckning gjord av deltagaren som inte är synlig för någon annan.
- Meddelande – en lista över meddelanden som är synliga för den här deltagaren (innehåller både offentliga och privata meddelanden).
- Ursprungligt filnamn – ursprungligt namn på en uppladdad fil som är associerad med avtalet.
- E-post – mottagarens (inklusive kopior) eller avsändarens e-postadress.
- Fullständigt namn – mottagarens (inklusive kopior) eller avsändarens för- och efternamn.
- Befattning – mottagarens (inklusive kopior) eller avsändarens befattning inom företaget.
- Företagsnamn – mottagarens (inklusive kopior) eller avsändarens företags- eller organisationsnamn.
- Mottagarens gruppnamn – namnet på ad hoc-avtalsgruppen som mottagarna kan tillhöra.
- Textfältsinnehåll – innehållet i textfältet som användaren har tillhandahållit i formuläret.
- Fullständigt namn på delare – fullständigt namn på den som delar avtalet. Detta är namnet på användaren i icke-delningsfall.
- Namn på delarens mottagargrupp – namn på mottagargruppen för den som delar avtalet. Detta är användarnamnet på mottagargruppen i icke-delningsfall.
- Externt ID – avsändarens tilldelade ID till avtalet som kan ha vilken form som helst, men vanligtvis i form av ”<groupID>:<ID>”. Externt ID skickas i anropet till API för att skapa avtal.
- Externt grupp-ID – avsändarens tilldelade grupp-ID till avtalet som kan ha vilket format som helst och vanligtvis används som prefix för externt ID. Externt grupp-ID skickas i anropet till API för att skapa avtal. Du måste ange ett externt ID om du anger parameter för externt grupp-ID.
- Transaktions-ID – ID som tilldelas avtalet av Acrobat Sign vid skapande.
Så här fungerar textsökning
Om du sökte efter strängen: ”En enkel fisk”
- Acrobat Sign ”tokeniserar” strängen med blanksteg som avgränsare. Exempelsträngen delas upp i tre token: En, enkel och fisk
- Tecken i strängfrågor består av tre olika typer: bokstav, siffra eller avgränsare.
- Tecken som behandlas som avgränsare (utom blanksteg) är: ~ ` ! @ # $ % ^ & * ( ) - + = { } [ ] | \ . , : ; " ' < > ? /
- Punkter, understreck och apostrofer blir kvar som en del av en variabel om tecken före och efter den symbolen är av samma typ.
- Citattecken som omger hela frågesträngen är inte avgränsare och anger ett bokstavligt strängvärde (fras)
- Citattecken i en frågesträng är avgränsare och anger inte ett bokstavligt strängvärde.
- Skiftlägesskillnaden har tagits bort. t.ex., en, enkel, och fisk
- Sökningen försöker sedan matcha den fullständiga texten hos varje token till ett indexerat värde
- En mer komplex tokenisering sker för Avtalstitel (se nedan)
- En inkluderande sökning används, vilket innebär att alla avtal som matchar minst en token från minst ett sökbart fält inkluderas i den returnerade datauppsättningen
- Den returnerade datauppsättningen sorteras efter relevanspoäng med det mest relevanta sökresultatet överst.
FÄLTET AVTALSTITEL
Som tidigare nämnts har fältet Avtalstitel en mer avancerad tokenisering på grund av en extra ”anpassad” tokeniserare som främst tokeniserar på kontextavgränsare (till skillnad från explicita tecken). Den här anpassade tokeniseraren skiljer sig från standarden på följande sätt:
- Prefixtoken (upp till tecken) genereras – en prefixtoken är den stegvisa strängen för alla standardtoken. Om standardtoken t.ex. är fish, är stegvisa token följande: f, fi, fis och fish
- Det gör att du kan söka efter delsträngar, eftersom du börjar med det första tokentecknet
- Matchningar som finns mitt i andra strängar ignoreras. Att t.ex. söka efter bar kommer inte att matcha ordet uppenbarligen
- Delade tokens vid icke-alfanumeriska tecken. Exempel: Strängen: Super_Duper returnerar token: Super och Duper
- Understreck är inte avgränsare i standardtokeniseraren
- Dela token vid skiftlägesövergångar. Exempel: Strängen PowerShot returnerar token: Power och Shot
- Delning av tokens vid bokstav/nummer-övergångar. Exempel: Strängen XL500 returnerar token: XL och 500
- Tar bort inledande eller avslutande avgränsare från varje token. Exempel: Strängen: XL---42+'Autocoder' returnerar token: XL, 42 och Autocoder
- Tar bort engelska genitivformen ('s) från slutet av varje token. Exempel: Strängen Dave's returnerar token: Dave
Observera att kombinationen av standard- och anpassade tokeniserare gör att du kan söka efter den fullständiga tokensträngen (tack vare standardtoken) och prefix-token (tack vare den anpassade tokeniseraren). Men du matchar inte en prefix-token som sträcker sig över en avgränsare.
Exempel: om du har ett avtal med namnet My_NDA
- Standardtokeniseraren skapar en token som ser ut så här my_nda
- Den anpassade tokeniseraren skapar en serie av tokens: m, my, n, nd, nda, my_, my_n, my_nd, my_nda
Exempel 2: om du har ett avtal med namnet XL500
- Standardtokeniseraren skapar en token som ser ut så här xl500
- Den anpassade tokeniseraren skapar en serie av tokens: xl500, x, xl, 5, 50, 500, xl5, xl50
Sökning med särskild frågesyntax
Enligt beskrivningen i avsnittet ovan utför Avtalssökning en ungefärlig matchning mellan alla sökbara fält i ett avtal. Sökbart fältinnehåll tokeniseras och sedan matchas dessa token mot frågesträngen vid frågetillfället. Avtalssökning utför också en prefixmatchning för upp till 10 tecken för dessa token. Om minst en token-matchning hittas i ett avtal visas avtalet i sökresultaten. Sökresultaten sorteras efter relevanspoäng med det mest relevanta sökresultatet överst.
Matchningar i ett helt fältvärde, matchningar i en fras från ett fältvärde, sökningar efter avtal som inte innehåller en viss token och sökningar efter avtal som innehåller flera token samtidigt (inte en fras) kan endast göras med en speciell syntax. SGQL (Sign Generic Query Language) har utvecklats för att tillgodose kundernas behov av dessa funktioner som kräver särskild syntax.
RESERVERADE TECKEN OCH ORD
SGQL har sju reserverade tecken:
* ( ) \ " ' : |
---|
Dessa reserverade tecken används som operatorer och definierar språkfunktioner i en sökfråga. Om ett reserverat tecken används felaktigt returneras ett syntaxfel.
Om du vill använda reserverade tecken som vanliga tecken i en sökfråga måste de undantas. Till exempel sökfrågan
\( \"bea\:u\*ful\"\\ \) |
---|
har alla reserverade tecken undantagna och de behandlas som vanliga tecken.
SGQL har också tre reserverade ord för operatorer:
AND OR NOT |
---|
Operatörerna måste ha versaler. Om du vill använda operatorer som vanliga token i en sökfråga måste de ges citattecken. Till exempel:
foo "AND" bar |
---|
FRASMATCHNING
En vanlig fråga med ungefärlig matchning matchar om något token visas i ett fält (men inte nödvändigtvis alla) och tokenordningen är irrelevant eftersom token inte behöver visas tillsammans.
En frasmatchningsfråga bör användas när en exakt frassökning som inte är skiftlägeskänslig i ett eller flera sökbara fält krävs. Detta gör det möjligt för oss att matcha när flera token visas i samma fält och dessa token visas efter varandra i den ordning som anges inom citattecknen.
Syntaxformat för frasmatchningsfråga:
"<phrase_match_query>" |
---|
eller
'<phrase_match_query>' |
---|
Om frågesyntaxen inte följer reglerna för syntax för en frasmatchning kommer Sök att utföra en vanlig ungefärlig matchningsfråga bland alla sökbara fält.
Till exempel, fråga
“Studiegrupp” |
---|
matchar avtal som innehåller frasen “studiegrupp” i något av de sökbara fälten. Observera att frasen “studie – grupp” inte kommer att matchas för den här frågan eftersom den inte är en skiftlägeskänslig exakt fras jämfört med “Studiegrupp”.
En frasmatchning kan visas var som helst i en sökfråga. Till exempel,
titel: ( matte AND “kursmaterial” AND “studiegrupp” ) |
---|
kommer att matcha titeln “Kursmaterial för MATTE 101-studiegrupp” eftersom denna titel innehåller nyckelordet “MATTE” och fraserna “Kursmaterial” och “Studiegrupp”.
FÄLTNAMNSPREFIX
En prefixfråga för fältnamn bör användas när du söker efter endast ett specifikt fält i användaravtalet.
Prefixfrågan för fältnamn måste innehålla ett prefix för fältnamn följt av en sökfråga. Syntaxformat för prefixfråga för fältnamn:
<field_name>:<query> |
---|
Prefixet för fältnamnet kan visas framför en token eller framför en del inom parentes i en fråga. Till exempel i sökfrågan
titel: ( Hej AND ”Vacker värld” AND ”Min värld”) |
---|
alla token matchas mot fältet avtalstitel.
I sökfrågan nedan
titel: Hej AND ”Vacker värld” AND ”Min värld” |
---|
Endast ordet 'Hej' har ett fältnamnsprefix och detta ord matchas bara mot fältet för avtalstitel. Resten av ord och fraser matchas mot alla sökbara fält.
Om <field_name> inte anges, kommer alla fält som stöds för frasmatchningen att efterfrågas. Annars efterfrågas bara fältet <field_name>.
Om frågesyntaxen inte följer reglerna för prefixfrågesyntax för fältnamn, använder Avtalssökning hela frågan som en sökfråga och utför en sökning bland alla sökbara fält.
Till exempel, prefixfrågan för fältnamn:
titel: ( Hej värld ) |
---|
ska endast göra en sökning mot fältet som innehåller avtalstiteln.
Nedan finns en lista med prefix som stöds för prefixfrågan för fältnamn. Prefix för fältnamn är skiftlägesokänsliga.
FÄLTINNEHÅLL |
NAMNPREFIX FÖR STRÄNGFRÅGEFÄLT |
BESKRIVNING AV FÄLTINNEHÅLL |
Titel |
title* |
Avtalstitel. |
Anteckning |
note |
En anteckning om ett privat avtal som gjorts av deltagaren och som inte är synlig för någon annan. |
Meddelande |
message |
En lista över meddelanden som är synliga för den här deltagaren (innehåller både offentliga och privata meddelanden). |
Ursprungligt filnamn |
originalFileName |
Det ursprungliga namnet på en uppladdad fil som är associerad med avtalet. |
E-post |
email** |
Mottagarens (inklusive kopior) eller avsändarens e-postadress. |
Fullständigt namn |
fullName*** |
Mottagarens (inklusive kopior) eller avsändarens för- och efternamn. |
Befattning |
jobTitle |
Mottagarens (inklusive kopior) eller avsändarens befattning inom företaget. |
Företagsnamn |
companyName |
Namn på mottagaren eller avsändarens företag eller organisation (inklusive kopior). |
Mottagargruppens namn | recipientGroupName |
Namnet på ad hoc-avtalsgruppen som mottagarna kan tillhöra. |
Textfältsinnehåll | textFieldContent |
Formulärets textfältsinnehåll som tillhandahålls av användaren. |
Delarens fullständiga namn | sharerFullName | Delaren av avtalets fullständiga namn. Detta är namnet på användaren i icke-delningsfall. |
Delarens namn på mottagargruppen | sharerRecipientGroupName | Mottagargruppens namn på den som delar avtalet. Detta är användarnamnet på mottagargruppen i icke-delningsfall. |
Externt ID | externalId |
Avsändare som har tilldelats ett ID till avtalet som kan vara av vilken typ som helst, men vanligtvis i form av ”<grupp-ID>:<ID>”. Externt ID skickas i anropet till API:et för att skapa avtal. |
Externt grupp-ID | externalGroupId |
Avsändarens tilldelade grupp-ID till avtalet som kan ha vilket format som helst, används vanligtvis som prefix för externt ID. Externt grupp-ID skickas i anropet till API:et för att skapa avtal. Du måste ange ett externt ID om du anger parametern för externt grupp-ID. |
Transaktions-ID | agreementId | ID som tilldelas avtalet av Acrobat Sign när avtalet skapas. |
För bakåtkompatibilitet har vissa av fältnamnsprefixen alias som är likvärdiga i funktionalitet med de ursprungliga fältnamnsprefixen. Dessa alias är inaktuella och kommer till slut att tas bort:
* Fältnamnsprefixets ”name” kan användas i stället för ”title”.
** Fältnamnsprefixets ”participantEmail” kan användas i stället för ”email”.
*** Fältnamnsprefixets ”participantName” kan användas i stället för ”fullName”.
JOKERTECKEN
Ett jokertecken ( asterisk * ) kan användas för att göra en prefixmatchning följt av ett obegränsat antal tecken i en token. Utökning med jokertecken är en kostsam åtgärd som utförs under körning, så följande syntaxregler måste följas för att du ska kunna använda den här funktionen:
- Inledande jokertecken tillåts inte.
- Jokertecken i mitten av en token tillåts inte.
- Ett fältnamnsprefix krävs för en token som har en expansionsoperator med jokertecken.
- En jokerteckenoperator kan inte användas mer än en gång i en fråga.
- Frågor som innehåller en expansion med jokertecken returnerar ett timeout-fel om körningstiden överstiger fem sekunder.
Till exempel, fråga
titel: myh* |
---|
matchar token för titelfält
myhost |
---|
och
Att expandera jokertecken är en krävande åtgärd. Om den används på ett oklokt sätt förbrukar den mycket systemresurser och du kan vänta länge på dina sökresultat. För att undvika dessa problem har SGQL begränsningar för användning av jokertecken vilket eliminerar de mest kostsamma och resurskrävande användningsfallen. Ju mer specifika dina token är, desto effektivare blir sökningen. Att söka efter ett visst ord eller en viss fras är alltid effektivare än att söka med jokertecken.
BOOLESKA UTTRYCK
SGQL stöder de booleska operatorerna: AND, OR och NOT samt gruppering av dessa operatorer med parenteser. Operatorerna måste anges med versaler.
Operatorn OR är alltid underförstådd mellan token. Till exempel,
foo bar |
---|
är samma som
foo OR bar |
---|
Om du inte vill inkludera operatorn OR av tydlighetsskäl behöver du inte ange den.
Operatorn NOT gäller bara för token omedelbart efter NOT. Om du vill använda operatorn NOT på flera token måste du omge dessa token med parentes.
I följande tabell beskrivs i vilken ordning booleska uttryck utvärderas.
Ordning |
Sökkommando |
---|---|
1 | Uttryck inom parentes |
2 | NOT-satser |
3 | OR-satser |
4 | AND-satser |
I tabellen nedan hittar du exempel på semantiskt likvärdiga frågor som förklarar operatorns prioritet om grupperingsoperatorer (parenteser) inte tillhandahålls.
Sökfråga | Motsvarande omskriven sökfråga | Kommentarer |
---|---|---|
foo AND bar baz | foo AND ( bar OR baz ) | Operatorn OR är implicit och bör inte användas om du inte vill lägga till den av tydlighetsskäl. |
foo NOT bar baz | foo OR ( NOT bar ) OR baz | Operatorn NOT tillämpas på följande token eller en del inom parentes i en fråga. |
foo NOT bar baz AND xyz | ( foo OR ( NOT bar ) OR baz ) AND xyz | |
titel: ( Hello AND "Beautiful World" "My World" ) | title:Hello AND ( titel: "Beautiful World" OR titel:"My World" ) | Prefix för fältnamn tillämpas på följande token eller del inom parentes i en fråga. |
titel: Hello AND note: "Beautiful World" "My World" | title:Hello AND ( note: "Beautiful World" OR "My World" ) | Frasen "My World" kommer att matchas mot alla sökbara fält. |