Niedermayer.ca
Published on Niedermayer.ca (https://niedermayer.ca)

Home > User Management System (UMS) -- Detailed System Design > Procedure Model > Web Pages

Web Pages

user/index.html

Procedure Model

Type:    (X)Web Page              (  )CGI Script              (  )Shared Library      (  )System API

Name: user/index.html

Assigned to:

Reference:

Description

This pure HTML page contains the descriptions and navigation for users, prospective users and members to interact with the UMS.

Implementation Skills

HTML

Parameter List

None

Called By:

GPFN Main page, other pages on the GPFN web site

Can Call:

 user/join.html
 user/upgrade.html
 user/myacct.html (Phase 2)

Function Description

Page invites viewer to join the GPFN listing the benefits of membership and other service upgrade options.

(Phase 2)A link to the myacct.html page so users can view their account information is also present.

Possible Exit Conditions and Return Values

None required

Sign Off by:

Membership Committee or GPFN Board Designate

 

  • Log in [1] to post comments

user/join.html

Procedure Model

Type:    (X)Web Page              (  )CGI Script              (  )Shared Library      (  )System API

Name: user/join.html

Assigned to:

Reference:

Description

This HTML page contains the descriptions of the membership and user classes of the Great Plains Free-Net for which they wish to apply.

Implementation Skills

HTML

Parameter List

None

Called By:

 user/index.html

Can Call:

 user/agree.html
 user/index.html
/index.html

Function Description

The page describes the three classes of user: Registered User, Individual Member and Institutional Member and the benefits and features of each class.

A Cancel link redirects users to the user/index.html page and a GPFN button takes the viewer back to the main GPFN page.

Possible Exit Conditions and Return Values

None

Sign Off by:

Membership Committee or GPFN Board Designate

 

  • Log in [2] to post comments

user/agree.html

Procedure Model

Type:    (X)Web Page              (  )CGI Script              (  )Shared Library      (  )System API

Name: user/agree.html

Assigned to:

Reference:

Description

This page contains the user agreement, acceptable use policy and other requirements the viewer must agree to before obtaining a GPFN account.

Implementation Skills

HTML, HTML forms, Javascript

Parameter List

None

Called By:

 user/join.html

Can Call:

 user/apply.html
 user/index.html
 /index.html

Function Description

The page contains the text to which a prospective user must agree before an account application is received and processed. The viewer notes acceptance of this agreement by clicking an “Accept” button at the bottom of the page.

The Accept button directs them to the apply.html page with the value “UA_accept” appended to the URL as a Query String parameter. A “Decline” button returns them to the user/join.html page. A “GPFN Home” button returns them to the GPFN main page.

Possible Exit Conditions and Return Values

If the viewer clicks the “Accept” button, they are sent to user/apply.html?UA_accept.

If the viewer clicks the “Decline” button, they are sent to user/join.html

If the viewer clicks the “GPFN Home” button, they are sent to /index.html

Sign Off by:

Membership Committee or GPFN Board Designate

 

  • Log in [3] to post comments

user/apply.html

Procedure Model

Type:    (X)Web Page              (  )CGI Script              (  )Shared Library      (  )System API

Name: user/apply.html

Assigned to:

Reference:

Description

This HTML page contains a form to gather the information required to process an application to the GPFN

Implementation Skills

HTML, HTML Forms, Javascript

Parameter List

Query String must contain value “UA_accept”

Called By:

 user/agree.html

Can Call:

 user/validate.cgi
 user/index.html
 user/join.html
/index.html

Function Description

The URL to which the user arrives must be “user/apply.html?UA_accept”. If the “?UA_accept” portion of the URL is missing, they should be redirected to the user/join.html page.

If the UA_accept parameter is received the page displays an HTML form.

This form must first query the viewer for the type of account they want. A pop-up menu named “Membership_Class” should list “Registered User”, “Individual Member” and “Institutional Member and send values “Registered”, “Individual”, and “Institution” respectively.

The form must also obtain the following data from the user. Items marked with a (*) are required and must be present before the form is processed:

*User_FirstName
*User_LastName
 User_Initial
*User_Salutation (popup one of Mr., Mrs., Ms., Dr., Rev.,)
*User_Organization (only required for an Institutional Membership)
*User_Title (only required for an Institutional Membership)
*User_StreetAddress1
 User_StreetAddress2
*User_City
*User_Province
*User_Country
*User_PostalCode
 User_HomePhone
 User_WorkPhone
*User_Age (If under 18 and needing a parent’s approval for an account)
*User_InitialPassword (entered as a password field of 6-8 characters. Users should be told to only use letters, numbers, and underscores and to NOT use any real word variation of a real word, any variation of their name or username)
 

If the application is for an individual or institutional membership the following fields must also be gathered
Upgrade_UserName (the requested username by the prospective member)
Upgrade_toPPP (check box: True=”1” default: False=’0’)
Upgrade_toDB (check box: True=”1” default: False=’0’)
Upgrade_DBName (textfield—only meaningful if Upgrade_toDB is checked)
Upgrade_toVirtualDomain (check box: True=”1” default: False=’0’)
Upgrade_VirtualDomainName (textfield—only meaningful if Upgrade_ toVirtualDomain is checked)
Upgrade_toSSL (check box: True=”1” default: False=’0’)
Upgrade_toListserver (check box: True=”1” default: False=’0’)
Upgrade_ListserverName (textfield—only meaningful if Upgrade_toListserver is checked)
Upgrade_toAliases (user enters a number default: False=’0’)
Upgrade_AliasExtAddress (textfield—only meaningful if Upgrade_toAlias is checked)
Upgrade_AliasGPFNAddress (textfield—only meaningful if Upgrade_toAlias is checked
Upgrade_Quota1 (check box: True=”5” default: False=’0’)
Upgrade_Quota2 (check box: True=”5” default: False=’0’)
Upgrade_Quota3 (check box: True=”5” default: False=’0’)
All requests for upgrades should list the annual (and possibly with Javascript the pro-rated) amounts of the upgrade.

Possible Exit Conditions and Return Values

  1. If UA_accept parameter is missing, user is redirected back to user/join.html
  2. If any of the required fields listed above are left blank, the submit button should be disabled or the user should be directed to fill in these fields before proceeding.

Sign Off by:

Membership Committee or GPFN Board Designate

 

  • Log in [4] to post comments

user/upgrade.html

Procedure Model

Type:    (X)Web Page              (  )CGI Script              (  )Shared Library      (  )System API

Name: user/upgrade.html

Assigned to:

Reference:

Description

This HTML page contains the terms and conditions related to any upgrade option including prices.

Implementation Skills

HTML

Parameter List

None

Called By:

 user/index.html

Can Call:

 user/login.cgi?upgrade.cgi
 user/index.html
 /index.html

Function Description

The page lists all relevant details for users to be able to decide what options to select in upgrading their account. Users can click to move forward to the login.cgi page before formally request an upgrade, or click a cancel button to go back the user/index.html page or a GPFN home button.

Possible Exit Conditions and Return Values

If the user clicks to apply for an upgrade, control passes to URL: login.cgi?upgrade.cgi. The “upgrade.cgi” string allows the login.cgi script to redirect the user to the correct option page if the login is successful.

Sign Off by:

Membership Committee or GPFN Board Designate

 

  • Log in [5] to post comments

user/myacct.html

Procedure Model

Type:    (X)Web Page              (  )CGI Script              (  )Shared Library      (  )System API

Name: user/myacct.html (Phase 2)

Assigned to: Phase 2

Reference:

Description

This HTML page contains a description of the options available to the account holder in viewing or managing his or her account history and configuration

Implementation Skills

HTML

Parameter List

None

Called By:

 user/index.html

Can Call:

 user/login.cgi?myacct.cgi
 user/index.html
 /index.html

Function Description

Users can click to move forward to the login.cgi page before formally viewing their account history or settings or altering their account configuration, or click a cancel button to go back the user/index.html page or a GPFN home button.

Possible Exit Conditions and Return Values

If the user clicks to view their account, control passes to the login.cgi?myacct.cgi. The “myacct.cgi” string is used to allow the login.cgi script to redirect the user to the correct option page if the login is successful.

Sign Off by:

Membership Committee or GPFN Board Designate

 

  • Log in [6] to post comments

vol/index.html

Procedure Model

Type:    (X)Web Page              (  )CGI Script              (  )Shared Library      (  )System API

Name: vol/index.html

Assigned to:

Reference:

Description

This pure HTML page allows the volunteer to choose between processing applications for accounts and upgrades and processing financial transactions.

Implementation Skills

HTML

Parameter List

None

Called By:

Directly by the user. Page is behind htaccess controls.

Can Call:

 vol/listapps.cgi
 vol/upgrades.cgi
 vol/receipts.cgi

 vol/invoices.html
 vol/acct.html (Phase 3)

Function Description

The volunteer can choose:

  • a link to listapps.cgi to get a list of all new account applications for processing;
  • a link to upgrades.cgi to get a list of all upgrade requests to existing accounts;
  • a link to receipts.cgi to process a receipt to a renewal invoice;
  • a link to invoices.html to select the options before creating a new invoice cycle or sending statements to accounts;
  • a link to acct.html to get a list of available account management options so the volunteer can view or alter the user’s account history or settings (Phase 3)

Possible Exit Conditions and Return Values

None

Sign Off by:

Membership Committee or GPFN Board Designate

 

  • Log in [7] to post comments

vol/invoices.html

Procedure Model

Type:    (X)Web Page              (  )CGI Script              (  )Shared Library      (  )System API

Name: vol/invoices.html

Assigned to:

Reference:

Description

This HTML/Javascript page allows the volunteer to choose the options before generating new invoices or reminder notices. The volunteer can choose to generate an annual invoice cycle for all members, display an invoice for a particular user, generate an annual invoice for a particular user, display statements for all members, or display a statement for a particular user.

As well, the form allows the volunteer to choose to e-mail the statements or invoices to the user, or to print them to the screen, or to print them to a tab delimited file which can be downloaded. The number and identity of the invoices or statements e-mailed or displayed in this way corresponds to the choices made in the preceding paragraph.

Implementation Skills

HTML, Javascript, HTML forms

Parameter List

None

Called By:

vol/index.html

Can Call:

 vol/geninvoice.cgi
 vol/index.html

Function Description

The HTML form gathers the following information before passing the data to the geninvoice.cgi script:

  1. *Invoice_Count (Radio Button set to “1” or “all”)
  2. User_UserName (Textfield matching the data definition entry and must be filled in with the UserName of the User for whom the invoice/statement is to be created only if the Invoice_Count is set to “1”)
  3. *Type_Switch (Radio Button set to “NewInvoice”, “ExistingInvoice” or “Statement”. These values will have English equivalences such as “Generate New User Invoices”, “View an Existing User Invoice”, or “Print User Statements”. Javascript should implement the rule that if Invoice_Count is set to 1, then the NewInvoice option is NOT available.
  4. *Medium_Switch (Radio Button set to “E-Mail” or “Screen”

A Submit button forwards the form data to the geninvoice.cgi. A Cancel button returns the volunteer to the vol/index.cgi page.

Possible Exit Conditions and Return Values

The form and Javascript should correctly handle all data exceptions. Data should be passed to the geninvoice.cgi script. Cancels should return control to index.html

Sign Off by:

Membership Committee or GPFN Board Designate

 

  • Log in [8] to post comments

vol/invoice.tmpl

Procedure Model

Type:    (X)Web Page              (  )CGI Script              (  )Shared Library      (  )System API

Name: vol/invoice.tmpl

Assigned to:

Reference:

Description

This HTML page forms a dynamically generated invoice. The template file is used by the geninvoice.cgi developer to present an attractive and visually consistent invoice to the user.

Implementation Skills

HTML

Parameter List

None

Called By:

vol/geninvoice.cgi

Can Call:

 

Function Description

The template file includes all HTML and graphics to display an invoice on a web browser window. It must be visually equivalent whether displayed in Internet Explorer, Netscape Navigator or Opera.

Spaces should be left for user identification, date of invoice, invoice charges and item descriptions, payment terms and options, instructions to print this page, and GPFN identification and remittance information

Possible Exit Conditions and Return Values

The page is not called directly but will be cut and pasted into cgi scripts.

Sign Off by:

Membership Committee or GPFN Board Designate

 

  • Log in [9] to post comments

vol/stmt.tmpl

Procedure Model

Type:    (X)Web Page              (  )CGI Script              (  )Shared Library      (  )System API

Name: vol/stmt.tmpl

Assigned to:

Reference:

Description

This HTML page forms a dynamically generated statement. The template file is used by the geninvoice.cgi developer to present an attractive and visually consistent statement to the user.

Implementation Skills

HTML

Parameter List

None

Called By:

vol/geninvoice.cgi

Can Call:

 

Function Description

The template file includes all HTML and graphics to display a statement on a web browser window. It must be visually equivalent whether displayed in Internet Explorer, Netscape Navigator or Opera.

Spaces should be left for user identification, dates and amounts of invoices and receipts, payment terms and options, outstanding balance and the aging of the balance and GPFN identification, instructions to print this page, and remittance information

Possible Exit Conditions and Return Values

The page is not called directly but will be cut and pasted into cgi scripts.

Sign Off by:

Membership Committee or GPFN Board Designate

 

  • Log in [10] to post comments

vol/rcpt.tmpl

Procedure Model

Type:    (X)Web Page              (  )CGI Script              (  )Shared Library      (  )System API

Name: vol/rcpt.tmpl

Assigned to:

Reference:

Description

This HTML page forms a dynamically generated receipt. The template file is used by the receipts.cgi developer to present an attractive and visually consistent statement to the user.

Implementation Skills

HTML

Parameter List

None

Called By:

vol/receipts.cgi

Can Call:

 

Function Description

The template file includes all HTML and graphics to display a receipt on a web browser window. It must be visually equivalent whether displayed in Internet Explorer, Netscape Navigator or Opera.

Spaces should be left for user identification, date, instructions to print this page, amount and payment method as well as GPFN identification and a thank-you message.

Possible Exit Conditions and Return Values

The page is not called directly but will be cut and pasted into cgi scripts.

Sign Off by:

Membership Committee or GPFN Board Designate

 

  • Log in [11] to post comments

vol/accept.tmpl

Procedure Model

Type:    (X)Web Page              (  )CGI Script              (  )Shared Library      (  )System API

Name: vol/accept.tmpl

Assigned to:

Reference:

Description

This HTML page forms a dynamically generated statement. The template file is used by the validate.cgi developer to present a user acceptance agreement for signature and mail-in by the new account applicant.

Implementation Skills

HTML

Parameter List

None

Called By:

user/validate.cgi

Can Call:

 

Function Description

The template file includes all HTML and graphics to display a user acceptance agreement on a web browser window. It must be visually equivalent whether displayed in Internet Explorer, Netscape Navigator or Opera.

Spaces should be left for user identification, legal terms and obligations, provisions for under-age applicants, payment terms and options, and GPFN identification, instructions to print this page, and remittance information

Possible Exit Conditions and Return Values

The page is not called directly but will be cut and pasted into cgi scripts.

Sign Off by:

Membership Committee or GPFN Board Designate

 

  • Log in [12] to post comments

vol/acct.html

Procedure Model

Type:    (X)Web Page              (  )CGI Script              (  )Shared Library      (  )System API

Name: vol/acct.html (Phase 3)

Assigned to: Phase 3)

Reference:

Description

This HTML page lists the account management options available to the volunteer and collects the information on which user account to display.

Implementation Skills

HTML, HTML Forms

Parameter List

None

Called By:

vol/index.html

Can Call:

 vol/history.cgi
 vol/quota.cgi
 vol/passwd.cgi
 vol/forward.cgi
 vol/filter.cgi
 vol/expire.cgi
 vol/purge.cgi

Function Description

Not yet fully defined

Possible Exit Conditions and Return Values

Not yet fully defined

Sign Off by:

Membership Committee or GPFN Board Designate

 

  • Log in [13] to post comments

Source URL:https://niedermayer.ca/node/174

Links
[1] https://niedermayer.ca/user/login?destination=node/174%23comment-form [2] https://niedermayer.ca/user/login?destination=node/175%23comment-form [3] https://niedermayer.ca/user/login?destination=node/176%23comment-form [4] https://niedermayer.ca/user/login?destination=node/177%23comment-form [5] https://niedermayer.ca/user/login?destination=node/178%23comment-form [6] https://niedermayer.ca/user/login?destination=node/179%23comment-form [7] https://niedermayer.ca/user/login?destination=node/180%23comment-form [8] https://niedermayer.ca/user/login?destination=node/181%23comment-form [9] https://niedermayer.ca/user/login?destination=node/182%23comment-form [10] https://niedermayer.ca/user/login?destination=node/183%23comment-form [11] https://niedermayer.ca/user/login?destination=node/184%23comment-form [12] https://niedermayer.ca/user/login?destination=node/185%23comment-form [13] https://niedermayer.ca/user/login?destination=node/186%23comment-form