Calling us.link

Use the following parameters to call the us.link application:

Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Note Fill and fill.recurse use different parameter names for the same fields.

Parameter Name	Description	Default
record	Source Record (required)	None
name	Field name to find from/link to	Current field
string1	Format Name	Current format
second.record	Link Record (optional)	None
prompt	Action (“find” or “fill”)	“find”
boolean1	Background flag	False
all.null	Exit when closing the current thread	None
index	Cursor line	None
cond.input	Skip Exact Find Note This parameter is used only for reference fields (that is, fields that have a referenced table defined in the data policy). By default, the Find function of a reference field performs an exact match search instead of using the query defined in the link record. If you want to use the query defined in the link record for a reference field, pass this parameter as true when calling the us.link application.	False

Parameter Name

Description

Default

record

Source Record (required)

None

name

Field name to find from/link to

Current field

string1

Format Name

Current format

second.record

Link Record (optional)

None

prompt

Action (“find” or “fill”)

“find”

boolean1

Background flag

False

all.null

Exit when closing the current thread

None

index

Cursor line

None

cond.input

Skip Exact Find

Note This parameter is used only for reference fields (that is, fields that have a referenced table defined in the data policy). By default, the Find function of a reference field performs an exact match search instead of using the query defined in the link record. If you want to use the query defined in the link record for a reference field, pass this parameter as true when calling the us.link application.

False

Note The only required parameter for us.link is the source record.

Related concepts