This document contains information on special words (system use only) for possible use in an URL space. You cannot use these words to name any other objects on your system, for example, folders, documents, and forms, if you want to access these objects from the web. An example of a reserved word is "Permissions".
Each reserved word has a position, method, and function and is presented in this manner:
Word
• position
• method
• function
In the word descriptions, the "current object" means the object specified by any URL elements preceding the one in question. Similarly, "current user" means the currently logged in user, unless the path element in question is preceded by an "Open-User" element.
~
• beginning or immediately after the "Login" element
• GET
• any URL beginning with '~' is treated as a user name and Internet Services attempts to open the home page of that user.
Attach
• end
• POST only
• runs the form mail processor in a mode optimized for attaching or uploading file(s) to the current object.
CGI-Bin
• beginning or immediately after 'Login' element
• any
• tells Internet Services to look for the specified path under the external CGI-BIN folder.
CGI-Win
• beginning or immediately after 'Login' element
• any
• tells Internet Services to look for the specified path under the external CGI-WIN folder.
Calendar
• immediately after the user name in an 'Open-User' URL
• any
• opens the calendar for the specified user.
Create
• end
• GET
• initiates a folder or conference action.
Directory
• beginning or immediately after 'Login' element
• GET
• opens Directory search.
EditResume
• immediately after 'Login' element
• any
• opens the resume in edit mode (in templates 5.5 and earlier)
In templates 6.0 and later use 'resume/formedit' like any other form.
ExtMailbox
• immediately after 'Login' element or the user name in an 'Open-User' URL
• GET
• Opens the Mail Import form for the current user.
FileOp
• end
• POST
• initiates a multi-file operation.
FormEdit
• end
• any
• puts the current form in edit mode (if allowed).
This URL element may only be followed by FormSave.
FormNew
• end
• GET
• creates an object of type oDocument or oFormDoc depending on current location and URL parameters).
The C enumerations for object types are all prefixed with 'o' (to indicate that they are object types).
FormSave
• end
• POST
• saves the current object.
Forward
• end
• GET
• forwards the current object.
History
• end
• GET
• opens the history for the current object.
Icons
• beginning
• GET
• access an icon resource from icons.rez.
Login
• beginning
• any
• opens the login form, if standing alone.
If it has a hexadecimal suffix, specifies the current authenticated session for the user.
Logout
• end
• GET
• logs out the current session.
Lookup
• end
• GET
• initiates a Directory search relative to the current object.
MemForm
• end
• any
• opens a system form.
Any URL containing this element must have a 'FormID' URL parameter.
This URL element may only be followed by 'FormSave'.
Open-Item
• immediately after the 'Login' element
• any
• initiate a typed folder open.
Open-Item must be followed by one of the following:
• 'Mailbox', 'AddressBook', 'Calendar', 'VoiceGreetings', 'Bookmarks', 'HomePage', or 'Memos'. If any of these items do not exist, they are created (if user has correct permissions).
Open-User
• beginning or immediately after the 'Login' element
• any
• accesses user information
The element immediately following 'Open-User' will be interpreted as the user's name. The element immediately following supports these special keywords:
• UIF, User-Info, Resume, Calendar, VoiceGreetings, Preferences, and ExtMailbox. Any other element (or no element) will treat everything after the user name as a path to something off that user's Desktop.
OpenIndex
• anywhere
• any
• does an indexed open.
Warning
The only place this is useful in a template set is in a few system forms and admin forms (permissions, user-info, and the group forms mainly). As an administrator you will almost never create your own new system forms, and we discourage you from doing so unless you have extensive coding and template knowledge.
Permissions
• anywhere
• any
• opens the permissions form for the current object.
Pictures
• beginning
• GET
• used to access a picture resource from pictures.rez.
Preferences
• immediately following the 'Login' element or the 'username' element in an 'Open-User' URL
• any
• opens the Preferences form for the current user.
Reply
• end
• GET
• creates a reply to the current object.
Résumé
• immediately following the 'Login' element or the 'username' element in an 'Open-User' URL
• any
• opens the résumé for the current user.
Search
• end
• any
• if method is GET, opens the Search form.
If method is POST, initiates a search on the current object.
Send
• end
• any
• if method is GET, creates a message and attempts to address it to the current object.
If method is POST, runs the form mail processor and attempts to send the current object.
UIF/User-info
• immediately following the 'Login' element or the 'username' element in an 'Open-User' URL
• any
• opens the User Information Form for the current user.
WhosOnline/Who'sOnline
• immediately following the 'Login' element or the 'username' element in an 'Open-User' URL
• GET
• opens the who's online listing.
|