dev.kanngard.net make sure you visit my new blog at: johankanngard.net

What is the $fields in design documents?

by Johan Känngård / [Notes] / 2002-10-12 / #18


Updated 2003-01-08 with information from Donna Dixon. Thanks!

FieldPossible valuesUsed byDescription
$ACTIONS???
$AssistAction-Agent, Script LibraryThe source of a LotusScript agent. Lines are terminated by a chr(10). In a Java library, contains the names of the JARs.
$AssistAction_Ex-AgentThe compiled code of a LotusScript agent.
$AssistDocCount?Agent?
$AssistFlagsEAgent??
sAgent??
$AssistInfo?Agent?
$AssistLastRun?Agent?
$AssistQuery?Agent?
$AssistRunInfo?Agent?
$AssistTrigger1AgentScheduled on more than once a day
4AgentManual agent
5AgentNew or modified docs
$AssistType?Agent?
$AssistVersion?Agent?
$Body-Subform, Form, Shared field?
$Class-AllContains the template database name that the design element inherits from
$Collation-View?
$Collection-View?
$Comment-AllThe comment of a design note, entered in the property box.
$DefaultLanguage-Icon?
$DefaultWebLaunchPage-IconThe page to launch on web when visiting this database.
$DesignerVersion?AllThe version of the client that created the note
$Fields?Form, Subform?
$File-Agent, Script libraryIn Java agents and libraries, the source code is put in a $File and the file name "%%source%%.jar", and the compiled code in a $File and the file name "%%object%%.jar".
$Flags!All?Indicates this design element supports the "Notes Global Designer" multilingual addin?
@Form ?, AppletShared Java resource?
#FramesetFrameset note
1Icon?
2Icon?
3AllWill be hidden from V3 clients
4AllWill be hidden from V4 clients
5Filter "Q5"= hide from V4.5 search list, ALL OTHER: notes stamped with this flag will be hidden from V5 client
6AllWill be hidden from V6 clients?
7AllWill be hidden from V7 clients?
8AllWill be hidden from V8 clients?
9AllWill be hidden from V9 clients?
0AllALL: notes stamped with this flag will be hidden from the client usage is for different language versions of the design list to be hidden completely?
aViewAntifolder view (?)
ASubForm?Add?
B?Background?
cIcon, View?Calendar style view?
CFormIf set, does not show up in the Create menu.
fAgent, Icon?
dViewDefault view
DFormNot used in query by form?
eViewPublic antifolder view?
EIconEmail?
fAgent?V4 agent?
FViewV4 folder view
GNavigatorNavigator/ViewMap/GraphicView?
HFormThe form is placed in the "Other..." dialog
iImage resuorce?
IAgent"If document has been pasted"-agent
jAgentJava agent with source code
JAgent, Script LibraryJava resource
LAgentLotusScript agent
lViewDeleted documents view?
mFilter?, OutlineSite map?
MFilter?Stored full text query and macro?
nFormIf set, hidden from Notes users.
NFormSubform is listed when making a new form?
OFilter?V4 search bar query object?
oViewPersonal on first use, store in desktop file
pViewPrivate copy of a "Private on first use" view
PAll, except: Icon, About and Using documentIf set, "Prohibit design refresh or replace to modifiy" is set.
QFilter?, FramesetFull text query only, no filter macro?
qFilter?Search part of this agent should be shown in search?
RIcon, About and Using documentIf set, "Prohibit design refresh or replace to modifiy" is UNSET.
rAllIf set, "Propagate this prohibitation of design change" is set.
sScript LibraryGlobal script library
SAgentScheduled background V4 agent
tDatabase ScriptA databas script note
TViewCategorized on the "Categories" field
uAgentAgents that are "Run as web user"
UFormSubform note
VAllPrivate design element stored in the database
wPageIf set, hidden from Web users.
WPage, FormWebpage?
xSubform: indicates whether we should render a subform in the parent form
XFilter?V4 agent data note?
y?Shared actions note
YAllIndicates that the design element should be hidden from menu?
zIcon?
ZAll?Used to indicate design element was hidden before the "Notes Global Designer" modified it. (used with the "!" flag)?
$FlagsExt?Agent?
$FlagsNoRefresh?Icon?
$Fonts?Page ??
$FormFormulaThe form formulaView?
$Formula?View?
$FormulaTVTime values exists in view - @Today or @Now is used.View?
$FormulaClass?View?
$HTMLHeadTag-FormThe contents of the "HTML Head Content".
$HTMLBodyTag-Form?
$HTMLCode-Form?
$IconBitmap-Icon?
$ImageData-Image resource?
$ImageNames-Image resourceThe file name of the image resource
$ImagesColorize-Image resource?
$ImagesHigh-Image resource?
$ImagesWide-Image resource?
$Info-Form?
$Index-View"/P=" + the number of hours until discarding of the view index.
"/T" Discard view index after each use.
"/M" Manual refresh.
"/O" Automatic refresh.
"/R=" + the number of seconds between automatically refresh of view.
$Links-Doc links??
$MachineName-AgentScheduled agents, the server name that the agent should run on.
$PublicAccess1AllEntries in the ACL with "Public Access" can read these notes.
0Entries in the ACL with "Public Access" can not read these notes.
$Readers-AllThe users / groups that are allowed to read this note.
$RevisionsLimit-Icon?
$$ScriptName-Subform?
$ScriptLib-Script libraryThe LotusScript source in Script Libraries.
$ScriptLib_O-Script libraryThe LotusScript executable.
$Signature-AllFrom the user that signed the note.
$SubForms-FormThe names of all subforms in a form.
$Title-AllThe name of the design note, including aliases.
$UpdatedBy-AllThe name of the user that last updated the note.
$UpdatedByLimit-Icon?
$V5ACTIONS-Shared actions?
$ViewFormat-View?
$WebFlagsHPage, FormDesign element is "Treat content as HTML"
$WindowTitle-Form, PageThe "Window Title" formula.

Some information in this table is from the DbDesign script library found at LDD Sandbox, created by Damien Katz, damien_katz AT iris DOT com.

Another table with $-fields, written by Justin Freeman

Justin Freeman has a list of "Special $$Fields, Reserved Fields and Special $Design Elements".

Document referrers