This program is used to setup and maintain ITS Wizard definitions for the ITS iEnabler.
Name | Value |
---|---|
process_code | <wizard process code> |
menu | <wizard process code> |
page_code | <wizard page code> |
numtype | G |
unum | 1 |
user | Guest |
from_form | Indicates the viewing of the page from the form (gw8app). |
Supported browsers: Which must support the HTML 4.01 DTD
Field | Type & Length |
Description |
---|---|---|
Page Code | A20 | Wizard page code. |
Page Name | A100 | Page name. Utilised as the page heading on each page. |
Navigation Link Short Name | A20 | Page short name. Utilised by the process breadcrumb (quick link navigation bar) display, the link title will display the full page name when the mouse moves over the displayed short name. |
Pickinglist Modify Page | A20 | The page code to be utilised for modification of a picking list's row of data. |
Display Indicator | A1 | Y(es)/N(o). Display the required detail captured via this page on the wizard summary display page. |
|
Field | Type & Length |
Description |
---|---|---|
Code | A10 | Wizard process code. |
Process Code Description | A100 | Process description. |
Start Page Code | A10 | The page which the process starts with. i.e. The first page to be displayed for the process. |
Page Code Description | A100 | Page name. |
XSL Style Sheet | A8 | The XSL style sheet linked to the process. |
XSL Style Sheet Description | A? | The XSL style sheet description. |
ITS Process | A10 | The ITS defined process code (GNRPCD - STGRDC-1) linked to this wizard process. |
ITS Process Description | A10 | The ITS defined process code (GNRPCD - STGRDC-1) linked to this wizard process. |
Apply iEnabler Security | A1 | Apply iEnabler security to the wizard process - for wizards called from within the iEnabler environment. Y - yes OR N (Default NULL = N - no). If a process is to be called via the iEnabler this indicator must be set to Y - yes. |
Add Breadcrumbs | A1 | Y - Yes (Default NULL = N - no) - Adds a quick link navigation bar to the wizard process. This Quick Link navigation bar will then be included on every page, following the first page. This includes a clickable link to the home page (first) and any other page(s) preceding the current page. |
Process Db Procedure | A400 | The database procedure to be executed once wizard data capture has been completed. |
Redirect Process Code | A20 | The wizard start process to be called once wizard data capture has been completed from the final thank-you page. |
Summary Page Heading Tag | A20 | The purpose of this tag is to allow a heading to be created via the tag block for the wizard summary page. This tag is linked here for each of the pages data which is to be displayed via the wizard summary. |
|
Field | Type & Length |
Description |
---|---|---|
Process Code | A20 | Wizard process code. |
Process Code Description | A100 | Process description. |
Object Code | A10 | ITS defined object code. |
Object Description | A? | ITS defined object code description (DAEOBJ - DMAIN-1). |
Process Key | N? | Up to 7 key fields can be defined for a wizard process. These key field object codes form the key to retrieving their associated XML data from the DSR - ITSWIZRD. |
|
Field | Type & Length |
Description |
---|---|---|
Content Type | A2 | Content type code. |
Description | A40 | Content type description. |
Active | A1 | Active indicator. |
|
Field | Type & Length |
Description |
---|---|---|
Process Code | A10 | Wizard process code. |
Page Code | A10 | Wizard page code. |
Tag | A20 | Wizard tag code. |
Sequence | N | Sequence of the tag within the page. |
Summary Display | N | Sequence of the tag within the summary page. |
|
Field | Type & Length |
Description |
---|---|---|
Tag | A20 | Tag code. |
Description | A40 | tag code description. |
Content Type | A2 | Content type code. |
Content Value | A4000 | Content type value. See Content Type Definition Rules below. |
Redirect Type | A2 | Redirect type code. See Redirect Type Definition Rules below. |
Redirect Value | A400 | Redirect value. |
Prompt | A512 | Tag prompt. |
Object Code | A10 | ITS defined object code. |
Institution | N | Institution code. |
|
Content Type |
Rules |
A |
Date tag
|
B |
Button tag
|
C |
Copy tag
|
D |
Database procedure tag
|
E |
Text/Additional HTML tag
|
H |
HTML tag
|
I |
Input text tag
|
J |
Javascript tag
|
L |
LOV (list of value) tag
|
M |
Image tag
|
N |
Hidden tag
|
O |
Option tag
|
P |
Picking list tag
|
R |
Fixed Range tag
|
T |
Textarea Input
|
U |
URL tag
|
W |
Wizard Data
|
X |
External Data
|
Redirect Type |
Rules |
D - Database Procedure |
|
P - Redirect Page |
|
U - URL |
|
Tag | Description |
birthDate | Creates a mandatory input element for date of birth entry. Includes the date selection calendar button. |
charDisplay | Character entry display for textarea tag. Referenced by the javascript included with the default textarea tag - textareaDesc |
citzType | Creates a mandatory select list based on:
Dependant Tags
|
closeWindow | Creates a Close button, when clicked executes javascript which closes the current window. |
cntry | Creates a mandatory LOV for country code selection based on a list of values WAP01_19 created in BATCH-15. |
coreSubject | Creates a mandatory LOV for core subject - subject categories selection based on a list of values WIZSBCRY created in BATCH-15. A Database Procedure (gw1valdata) is included to create the default subject category session variable - ialrow102 |
dateSelectMM dateSelectYYYY |
Creates a mandatory select list tag sequence for month (01-12) and year input (Based on data returned from SQL WIZCCYR in BATCH-15). |
ethnicGroup | Creates a mandatory multiple selection select list based on a list of values WAP01_08 created in BATCH-15. An optional Other - OTHER value is added to the end of the list. |
firstLanguage | Creates a mandatory select list based on a list of values FIRSTLAN created in BATCH-15. A default --- Please select --- value is added to the list. |
finalYearLevel | Creates a select list based on values 1 through 14. A default --- Please select --- value is added to the list. |
firstNames | Creates a mandatory input element for first name entry. |
gender | Creates a mandatory input radio button element for gender entry. Default value is M - male. |
lastName | Creates a mandatory input element for last name/surname entry. |
mainSubject | Creates a mandatory LOV for main subject selection per subject category and enrolment reason (OT) based on a list of values WIZSUBMN created in BATCH-15. |
nsnNumber | Creates an input element for NZ National Student Number entry. |
prefName | Creates an input element for preferred name entry. |
studyYear | Creates a mandatory select list based on a list of values WIZACCYR created in BATCH-15, for the enrolment study year selection. |
studentId | Creates a standard HTML input element with maxlength set to 15 and size 16. |
textareaDesc | Creates a textarea limited to 250 characters (3 rows/66 columns) which references the charDisplay tag to dispaly the number of characters typed into the textarea as the user types. Character entry limit validation is also handled by the javascript included by default with this tag. |
title | Creates a select list based on a list of values WAP01_01 created in BATCH-15. A default --- Please select --- value is added to the list. |
yesNo | Creates a non-mandatory select list with 2 values (Y)es and (N)o. A default --- Please select --- value is added to the list. |
Address fields | |
streetName | Creates a mandatory input element for street number and name entry. |
suburbName | Creates a mandatory input element for residential suburb or rural delivery number. |
town | Creates a mandatory list of values element based on the WIZ01 SQL created in BATCH-15. |
postalCode | Creates a mandatory input element for postal code. |
postalCodeLnk | Creates a residential postal address postal code search URL link - NZ postal code search facility. |
Creates a mandatory input element for email. Includes an email validation AJAX call. | |
phoneNumber | Creates a mandatory input element for a telephone number. |
Field | Type & Length |
Description |
---|---|---|
Tag | A20 | Tag code. |
Attribute Name | A100 | Tag code attribute name. |
Attribute Value | A400 | Tag code attribute value. |
|
Attribute Name | Attribute Value | Meaning |
checkmandatory | Y/N | Attribute for submit button tags. Default value "Y" - can be ommitted. "N" will ensure that pickinglist element input fields are not validated as mandatory or added to GOGWWD when this button is clicked. All other non-pickinglist element input fields will be validated accordingly and added to GOGWWD - this will include the picking list details already added and subsequently displayed via the pickinglist tag. |
dependant | Tag code this tag is dependant on. | Utilised with tags which have a dependancy on other tag values captured/selected previously. Especially useful for tags whose value depends on data captured previously and stored in the session table e.g. Dynamic list of values based on cookie values. |
display_type | code/description/codedesc | Utilised with wizard display tags only (Content type 'W'). Including any of these attribute values for the display of an LOV tag, will display the code only, description only or both the code and description depending on the attribute assigned. The default (i.e. excluding any of these for an LOV tag) will display the description only. |
doback | Y - button attribute | Indicates the button is responsible for backward navigation. Not including this attribute value will create a normal button
which executes the redirect instruction. Backward navigation is controlled via values stored by default within the wizard
data structure (GOGWWD) as follows:
|
dojs | Event/trigger name e.g. onchange | Executes the event in question when the page is loaded. This allows the user to manipulate elements on the screen from previously captured data entered on the page. Having the event execute on load of the page maintains the state of these manipulated elements. |
dosubmit | Y/N - button attribute |
|
dotlevel | Numeric value. |
|
dotnumber | Numeric value. |
|
error_mandatory | Value = Error to be displayed if the mandatory validation fails. | Error text to be displayed when a mandatory field has not been entered and the page is submitted. |
error_validation | User defined error to be displayed if field level validation fails. | Error text which can be programatically retrieved and displayed if field validation is unsuccessful. An HTML division (<div>) is created which can be accessed via Javascript as tag groupname (<tag_code>Grp) appended with ErrVal Eg. tagNameGrpErrVal.innerHTML. Any PL/SQL AJAX validation can access the error from the field GOIVALUE on GOIWTA for the tag and attribute name error_validation. |
fldclass | Value = Full class definition for tag element (<tag name>) div | Adds class definition detail to the tag div (HTML <tag name> div) e.g. text-align: right; width: 170px; |
grpclass | Value = Full class definition for <tag name>Grp div | Adds class definition detail to the tag series group combination (HTML <tag name>Grp div) e.g. text-align: right; width: 170px; |
isnumber | Y | Executes javascript to enforce numeric data entry for the tag. |
mandatory | Y | Sets the mandatory attribute for the tag. This places a red asterisk * behind the tag field as the mandatory indicator and executes javascript to enforce data entry for the tag. |
on() events | Javascript | When hiding and un-hiding groups of fields based on selected data element values, remember to cleanup any data entered into the fields being hidden. This includes any error message details which may be present for these fields being hidden. A default error message div element is included for all input elements as <tag_code>GrpErr. To clear the error message set the error div's innerHTML to an empty string as follows: <tag_code>GrpErr..innerHTML=""; |
pickinglist | x_ | The picking list prefix to be assigned to the associated tag for the name of the input to be saved to wizard data. Default - 'x_' |
pickinglist_page | Page code | Utilised if the picking list is displayed on a different page to the picking list creation page (Content type P). |
position | S | Start of a tag series |
C | Continue the tag series | |
E | End of a tag series | |
promptclass | Value = Full class definition for tag prompt (<tag name>Prompt) div | Adds class definition detail to the tag prompt div (HTML <tag name>Prompt div) e.g. text-align: right; width: 170px; All prompt descriptions include a padding-right: 5px; style. Please do not include a padding-right style for promptclass attributes it WILL be ignored at run-time. |
promptclass and fldclass | CSS float | With CSS float, an element can be pushed to the left or right, allowing other elements to wrap around it. Elements are floated horizontally, this means that an element can only be floated left or right, not up or down. Floating elements left and padding them with a number of pixels will allow them to align accordingly. The tag attribute (Tag Attributes - Block 7) fldclass can be used to add attributes to the float prompt div. Adding a style attribute to the tag will do the same for the tag.By default the Prompt div will float left, any other alignment and width style properties can be added via this attribute. This makes field alignment possible for various groups of fields. Include a float property in the style definition to override the default. Prompt and field elements have a default style included if ommitted from the tag attribute definition: text-align: right; display: inline-block; float: left; This style will default into the attribute value field when the promptclass or fieldclass attributes are first entered or selected. |
radio_align | vertical | Utilised to align radio buttons horizontally/vertically. 'vertical' is the only acceptable value for this attribute. Horizontal alignment is the assumed default. |
radio_label_pos | left | Utilised to position a radio button's label. 'left' is the only acceptable value for this attribute. Label position to the right is the assumed default. |
showlovcode | Y/N | Utilised with LOV tags to display the lov code and description input elements on the page when set to Y (Yes). The default N is assumed. |
sod | SOD code and sub-system code. | The SOD code and sub-system code seperated via a comma delimiter. The buildxml process will replace the SOD code/sub-system combination with the actual SOD value (SMNT-12). |
storelov | LOV wizard data name value pair storage. | Used in conjunction with the LOV content type. Data entry as <tag name>|<tag sequence>. Create wizard data value for the selected LOV data using the attribute value as the name/tag code within GOG. |
clearlov | Enter the link text for the clear LOV field hyperlink. | Used in conjunction with the LOV content type. Clear the code and description field of the LOV entry on the HTML page. Any onchange event on the LOV description (either manually coded or by using the storelov attribute) will be run. 'Clear' is the default if ommitted. |
Attribute Name | Attribute Value | Meaning |
maxlength | Number | Specifies the maximum length (in characters) of an input field (for type="text" or type="password"). |
size | Number | Specifies the width of an input field. |
disabled | disabled | Specifies that an input element should be disabled when the page loads. |
cols | Number | Specifies the visible width of a text-area. |
rows | Number | Specifies the visible number of rows in a text-area. |
href | URL | Specifies the destination of a link. |
target | _blank _parent _self _top |
Specifies where to open the linked document. |
Attribute Name | Attribute Value | Meaning |
onblur | script | Script to be run when an element loses focus. |
onchange | script | Script to be run when element value changes. |
onkeyup | script | Script to be run when a key is released. |
onclick | script | Script to be run on a mouse click. |
onmouseout | script | Script to be run when mouse pointer moves out of an element. |
onmouseover | script | Script to be run when mouse pointer moves over an element. |
Including Bullets in your HTML pages
Field | Type & Length |
Description |
---|---|---|
Tag | A20 | Tag code. |
Description | A200 | Tag value description. |
Value | A200 | Tag code attribute value. |
Default | A1 | Tag value default indicator. |
Sequence | N4 | Tag value display sequence indicator. |
|
Description | Value | Meaning |
LOV | LOV SQL code | LOV SQL code obtained from BATCH-15 LOV value. Utilised for a select list based on an SQL i.s.o. fixed values. |
Block 9 - Wizard navigation rule | ||
---|---|---|
Field | Type & Length |
Description |
Rule Code | A10 | Rule code. |
Description | A200 | Rule code description. |
Process Code | A20 | Process code. |
Page Code | A20 | The page the rule should be applied to when submitted. |
Redirect Type | A1 | Possible redirect Types
|
Redirect Value | A400 | The database procedure, page code or URL link to redirect to. |
Sequence | N4 | Navigation rule sequence indicator. |
Block 10 - Wizard navigation rule detail | ||
Tag Code | A20 | Tag code. |
Page Code | A20 | Page code. |
Value | A400 | Tag value. |
|
ID | Example | Notes |
---|---|---|
Process Code | <div id="<process code>" class="process"> | Defines the current wizard process. Note the class process included from the wizard style sheet (wizard.css), which can be utilised for manipulating the style of the page. |
Progress Bar | <div id="progressBar" style="padding-bottom: 5px; padding-left: 5px; padding-right: 5px; display: inline-block; padding-top: 5px;"> | This div represents the area which contains the wizard progress bar, if included on the page. |
Submit form | <form onsubmit="return changeToNameValuePairs(this);" name="frmOne" method="post"> OR <form name="frmOne" method="post"> |
The HTML form to be submitted. Will always default to frmOne. If a submit button tag is included within the page definition the Javascript changeToNameValuePairs will be included which will convert all named inputs on the page to name/value pair field and value combination which will be stored in the wizard-data data structure (gen.gogwwd). |
Form | <div id="formDiv" style="position: absolute; visibility: hidden; z-index: 1000;"> | This div includes two named hidden input fields: process_code and page_code. These 2 fields are always included on any page and will always be submitted to the wizard-data data structure. |
Tag group | <div id="protoPage1NxtBtnGrp" style="display: inline-block; clear: both;"> | This div represents the area which contains tag group (Tag prompt and tag field definition) defined within the wizard paragraph. Made up of the tag code appended to Grp. Note: A tag group can also contain a series of tags (tag prompt and tag field combinations for multiple tags on one line). |
Tag prompt | <div id="protoPage1NxtBtnPrompt" style="display: inline-block; text-align: right; float: left;"> | This div represents the area which contains the tag prompt defined within the wizard tag group. Made up of the tag code appended to Prompt. |
Tag field | <div id="protoPage1NxtBtnFld" style="display: inline-block; text-align: right; float: left;"> | This div represents the area which contains the tag field defined within the wizard tag group. Made up of the tag code appended to Fld. |
Break | <br style="line-height: 0;"/> <br style="line-height: .5em;"/> |
These breaks exist between tag groups in order to ensure each tag group is placed on a new line. This will eliminate the inclusion of paragraph (p) HTML tags between tag groups. To increase the size of these break gaps, edit the style sheet gw1wiz.xsl OR create a new style sheet and link it to the process on GWEBM-1 block 2. |
Javascript | Description |
---|---|
These Javascript functions can be utilised within your tags for manipulating elements and element data. Be aware these are not the only Javascript functions included within this JS file, but are the usable functions | |
showCalendar | This script is not for general use it will setup and display the HTML calendar from the calendar button created for date elements. |
show | This script can be used to display any hidden HTML object. |
hide | This script can be used to hide any displayed HTML object. |
showHide | This script can be used to show an object if hidden or hide an object if displayed. |
displayWhenValSL (HTML Select list) |
This script will display a hidden object when the selected value of the associated select list is a specified value. |
displayWhenValuesSL (HTML Select list) |
This script will display a hidden object when the selected value of the associated select list is any of the values within an array. |
checkFieldLength (HTML text-area) |
This script will compare the length of an object to the supplied object length, for alerting the user when the number of characters entered is greater than the maximum. |
displayCharNumber (HTML text-area) |
This script will display the number of characters entered into the textarea, within a specified object. Utilise in both onkeyup and onblur triggers of the object |
isNumber | This script will validate whether the object in question has a numeric value. |
showProgressBar | This script will display the wizard progress bar. |
valCheckBox | Enable/Disable field according to check box selection. Supply the checkbox element id and the field to enable/disable id as input parameters. If the checkbox is checked the field will be enabled and vice versa. |
setupDesc | Set the default hidden description field for the selected item within select list elements. |
setupRadio | Set the default hidden description field for checked radio button elements. |
getCheckedValue | Evaluates radio button elements to get the checked button value. |
processIs | Function can be utilised within Javascript to validate the process code. Return True if the name of the process code is the same as the input "processName" else return false |
SOD/Sub-system | System operational definitions for web wizards |
---|---|
Certain system operational definitions are utilised for wizard capture. The wizard sub-system code used is WZ. | |
TCS Wizard enrolments. | |
A1/WZ | Adult enrolment student type. |
A2/WZ | Young adult enrolment student type. |
DC/WZ | Document Category. |
EN/WZ | English Subject Category code. |
MA/WZ | Maths Subject Category code. |
NZ/WZ | New Zealand Country Code. |
ME/BI | Maori ethnicity code. |
Date | System Version | By Whom | Job | Description |
---|---|---|---|---|
12-Apr-2010 | v02.0.0.0 | David Goodrum | t161180 | New option. |
25-Jul-2011 | v02.0.0.1 | David Goodrum | t174454 | Amendments to documentation following Te Kura implementation. |
25-Jul-2011 | v02.0.0.2 | David Goodrum | t176105 | Amendments to documentation following Te Kura implementation. |
01-Jan-2015 | v03.0.0.0 | David Goodrum | 204118 | Amendments to documentation following Integrator 3 upgrade. |