Every command is typed in the Global Search box after a greater-than sign, for example >record 4412. Most commands have a short form, shown in the Also column. A period in place of a record ID means the record that is currently open. Names may be typed in part, and a name that contains a space must be in double quotes. Variables such as [USERNAME] and [TODAY-7] may be used anywhere.


Finding your way around

Command

Also

What it does

help [command]

?

Opens the Command Line panel listing the commands you can use. With a command name it describes that one command. help online opens the online help.

home

h

Goes to the Home screen.

record [id]

r, open

Opens a record. With no ID it opens your last record.

document {id}

d, doc

Opens the record that holds a document, by document ID.

goto {name or /path}

go

Goes to a screen by name (home, search, entry, workflow, assets, reports, personalqueue, formlibrary) or by URL path such as /reports/errorlogs.

form {name}

f, eform

Opens an E-form by name.

workflow [trigger]

wf, queue

Opens your workflow queue, or the queue for one trigger.

new [record type]

n, entry, add

Opens the Entry screen, optionally for one Record Type.

test

t, variables

Opens the Variable Testing panel.

history [clear]


Shows recent commands in the Command Line panel. history clear forgets them.


Searching

Command

Also

What it does

search {text}

s, find

Runs a Global Search for the text. The same Field|Value^Field|Value form that Global Search accepts works here too.

search {record type}

s, find

Opens the search form for that Record Type.

search {record type} Field=Value ...

s, find

Searches for records where each named field has the given value. Several Field=Value pairs may be given.

search Field=Value ...

s, find

The same search across all Record Types.


Working with a record

These commands change data. When sent as a link they wait for the person to press Run. After they finish, the record is opened so the change can be seen.

Command

Also

What it does

set {id or .} Field=Value ...

update

Saves one or more field values on the record. Quote a field name or value that contains a space. The user must have edit rights to the record.

note {id or .} {text}


Adds a record note with the text. Everything after the record ID is the note.

favorite {id or .} [off]

fav, bookmark

Adds the record to your favorites, or removes it with off. This one does not open the record.

run {add-in name}

addin

Runs a toolbar Add-In by name, exactly as if it had been chosen from the toolbar. An Add-In that works on the current record uses the record that is open.


Links

Command

Also

What it does

link {command}[; {command}]

url

Copies a link that runs the command or commands when opened. A period is replaced by the open record's ID. Variables are left as typed so they are filled in for the person who opens the link.


Administrator commands

These are only listed and only run for administrators. Each opens the editor for the named item; with no name it opens the list.

Command

Also

What it does

user {name}


Opens a user in Admin under Users.

team {name}


Opens a team in Admin under Teams.

recordtype {name}

rt

Opens a Record Type in Admin under Record Types.

trigger {name}


Opens a trigger or process in Admin under Workflow.

editform {name}

ef

Opens an E-form in Admin under E-forms.

editaddin {name}

ea

Opens a toolbar Add-In in Admin under Add-Ins.

admin [section]


Opens Admin, or one section by name: main, alerts, users, teams, recordtypes, eforms, workflow, addins, actionsets, events, customvariables, notifications, branding, apitokens, connections, applications, stamps, bookmarklets, netlabels, recycle.


Link form

A command sent as a link has the form https://yourserver/cli?c={command}. Separate several commands with semicolons and encode spaces as %20. The link command above builds this for you. When the Command Line switch is off in Admin, these links go to the Home screen.