Issue the text forming the module's input
form. CURRENT STATUS: Unused
Issue the html to build instance
$instanceName of form element $elementName called with argument
list $argList across a span of cells $colSpan. CURRENT STATUS: Unused.
Procedure to perform session-related tasks, such
as loading and saving.
Syntax:
session (load|save|delete) [--default] [-vars sessVarList] [-mode modeName] [-name sessionName] moduleName
load: Load a saved session
save: Save the current module input as a session
delete: Remove a session from the list of possible sessions
Additional arguments:
-vars sessVarList: List of variables to save in session file (req. if command=save and form is not auto-generated)
-mode modeName: Specify modename (optional)
-name sessionName: Name of session to save or load (req. if command=save or delete)
--default: Specifies default session for loading
moduleName: Name of the module for the given session (req.)
Procedure to choose the session file to
load when a form is invoked, if any. If no appropriate session
file can be located from the user or system trees, then the
procedure returns a null filename.
Precedence rules for determining session file to load:
1. User session settings
--> Determine preference for "default" or "last"
(i) Default: If unavailable, load system
(ii) Last: If unavailable, load user default
2. System defaults
3. No session information
Procedure to create a user directory for
a specified module, and to set up default values for that
module.
Procedure to load session data into an array
in the forms namespace called SESSION
Procedure to save a named session for a given
module. It is assumed that all session data has already been
placed in the forms array SESSION
Procedure to delete a named session
Procedure to build system default values for a
session from a form metadatabase or from existing system defaults.
Only valid admin users can build system-wide default sessions.
CURRENT STATUS: Unused.
Procedure to return the names of all
session names for a given module
Procedure to return the appropriate directory
name for the given module and user. Present implementation:
Type:
-module: $wsRootDir/user/$wsID/$moduleName
-session: $wsRootDir/user/$wsID/$moduleName/session
-system: $wsRootDir/modules/$moduleName
Procedure to determine whether a module is
auto-generated from a database, or based on a hand-written
CGI script
Store a list of CGI input variables in the session
database. A protected version of the variables is extracted from the
global array element _cgi(input) and stored in the session database.
This routine assumes that a cgi_input has already been performed to
load _cgi(input) with the CGI input data.
Convert session database into a format that can be
submitted with the form as a query string
Procedure to extract data for a given
session from the session database. Data is converted from a
CGI-safe form back into the original form.