SECF0060 - Maintain System Forms and Zooms

Purpose

To maintain menu display details and define menu bar zoom target forms, jobs or web pages for each System form. To view global variables associated with a System form. To apply Organisational Unit restrictions to the Org. Unit Code field.

SubSystem

Security

Normally Run By Administration specialist
Anticipated Frequency As required
Structure  Blocks System Form
System Block
System Block Global Variable
Button Invokes the Form Zoom block

 

System Form block:

  • System Form
  • Menu Title
  • Short Title
  • Entry Point check box
  • Query Mode Only Valid check box

    Buttons

    • Restrict OU LOV
    • Zoom

System Block:

  • Block
  • Sequence
  • Description

System Block Global Variable block:

  • Block Item
  • System Form Global Variable

Form Zoom overlay block:

  • Menu Seq
  • Zoom Form
  • Zoom Job
  • Zoom Web Page

Organisational Type Restriction overlay block:

  • Organisational Type
  • Description

Member Type Restriction overlay block:

  • Member Type
  • Description

Rules/Notes:

 

The Restrict OU LOV button displays the Organisational Type Restriction overlay block. This block is used to list Organisational Types and/or Member Types that will restrict the List of Values on the Organisational Unit Code field in the context form.

The Restrict OU LOV button is only available if the Restriction indicator (i.e. RSTRCT_OU_IND field) in the System Form table (S_FORM) is enabled (set to 'Y').

The Zoom button displays the Form Zoom overlay block. for more information, see 'Zooms Navigation explanation' below.

 

System Form block explanation

Using this form, the System Administrator can define the menu display name for each form in the standard System menus and control which forms appear under the menu bar zoom option for each form.

The registration of system forms and the update of their description, as well as update of Entry Point and Query Only Mode Valid indicators can be performed only by the Application Owner. The addition of Global Variables can only be done by the Application Owner.

The System Form block displays details of the System form and is used to record the names of the form for display in standard System menus and menu bar zoom lists. Both of these names may differ from the system-defined form name.

Rules/Notes:

As an example, the form 'Maintain Enrolment Method Types' (ENRF01E0) could be labelled 'Enrolment Method Types' in the menus and 'ENR Method Types' in the menu bar zoom.

To record alternative form names to be used in System menus and menu bar zooms using the Maintain System Forms and Zooms form:

  • Execute a query in the System Form field to retrieve the required form details.
  • Enter the name to be used for the form in the System menus, in the Menu Title field.
  • Enter the name to be used for the form in the menu bar zoom facility, in the Short Title field.
  • Save.

Rules/Notes:

The Entry Point check box indicates whether a form can be entered directly (selected) or whether the form must be entered via another form (deselected). This value is pre-set and cannot be altered. Only forms with the check box selected should be placed on menus.

The Query Only Mode Valid check box indicates whether or not it is valid to grant roles or users query only access to the form. Validations in SECF0062 and SECF0063 prevent query only access being granted to forms which do not have this indicator set.

The maximum number of Form Zoom menu items is 20.

To change an alternative form name used in System menus or menu bar zooms using the Maintain System Forms and Zooms form:

  • Ensure that the correct form details are displayed in the System Form block.
  • Change the Menu Title and/or Short Title fields, as required.
  • Save.
 

System Block explanation

The System Block lists blocks that are included in the System Form, that has been selected in the top block. This list is for information purposes only.

Zooms Navigation explanation

The Form Zoom block is accessed via the Zooms navigation button in the System Form block. Within it, forms and jobs are recorded to be displayed when the menu bar zoom option is selected.

Restrict OU LOV explanation

The Organisational Type Restriction overlay block is accessed via the Restrict OU LOV button. You can record Organisational Types and/or Member Types in this block in order to restrict the List of Values on the Organisational Unit code field (for the context form) to only those belonging to the listed Org. Type(s) and/or Member Type(s).

Rules/Notes:

When using the Record Enrolments form (ENRF3000) it could be useful to be able to navigate quickly to the Maintain Person Encumbrance Details form (ENRF6310). By recording ENRF6310 against ENRF3000, in the Form Zoom block, a person using ENRF3000 can select ENRF6310 under the Zoom menu bar option to immediately display the Person Encumbrance form.

Note: Following Release 15.0 Web Page functionality is being phased out and replaced by Web Resource functionality.

When using the Restrict OU LOV functionality, only Organisational Units with the specified restriction will be available for selection from the LOV on the Organisational Unit Code field in the context form. For example, for RESF3250, if you listed an Organisational Type of RESEARCH, then only Organisational Units with an Organisational Type of Research are available for selection from the LOV on the Organisational Unit field in RESF3250.
Note: Organisational Types and Member Types cannot be closed.

To add a target form, web page or job to the Zoom menu for a particular form using the Maintain System Forms and Zooms form:

  • Ensure that the correct form details are displayed in the System Form block. and that the Short Title field contains a meaningful entry.
  • Select the Form Zoom navigation button. The Form Zoom block is then displayed. (To return to the previous block at any stage, select the Back navigation button.)
  • Enter the sequence number within the Zoom menu in which you would like the target form/job name displayed, in the Menu Seq field.
  • Either:
    • Select the target form from the list of values (or key a valid form ID) in the Zoom Form field, or
    • Select the target job from the list of values (or key a valid job ID) in the Zoom Job field.
  • Save.

Rules/Notes:

A single record can only contain a zoom job or a zoom form or a zoom web page.

Only those forms specified for Entry Point (direct from menu) are displayed in the Zoom Form field LOV.

Only those web pages specified for Entry Point (direct from menu) are displayed in the Zoom Web Page field LOV.

A form or web page cannot be set up as a zoom of itself.

To remove a target form/job/web page from the Zoom menu for a particular form using the Maintain System Forms and Zooms form:

  • Ensure that the correct form details are displayed in the System Form block.
  • Select the Form Zoom navigation button.
  • Select the target form or job to be removed.
  • Delete Record.
  • Save.
 

System Block Global Variable explanation

The global variables associated with the context form are displayed here. When a Callista form with global variables defined for it (e.g. ENRF3000) is used, the values of the global variables are set to the values displayed in the form. For example, in ENRF3000, they can be set to the current person ID, course code and course version.

Related forms can be custom built so that they open in the context of these global variables when accessed, via a zoom, from the form with the global variables defined. For example Forms, accessed via Zoom from ENRF3000, could be built to open with the context person details and/or the context course details and/or the context unit details displayed.

Rules/Notes:

A course inquiry form could be built so that when it is opened via zoom from ENRF3000, the context course version (from the student course attempt) is displayed.
  • Global variables only cause context to be carried when the zoom function is used.
  • Global variables are reset to NULL when the 'zoomed to' form is exited.
  • For more information on global variables, refer to the technical information located in the Callista Product Centre (wiki.callista.com.au/display/CPC)..


Last Modified February 27, 2014 2:46 PM

History Information

Release Information Project Change to Document
18.0.0.2 2011 - Calipso 41512 Updated tech info link to CPC wiki site.
17.0 2000 - PC 97 Add new button (Restrict OU LOV) & new overlay block & fields, and related notes.
16.1.0.0.1.0 1917 - UI Consolidation Added note for Web Page Zooms
11.0.0.0.0.0 1416 - Apprentice Management Added references to Web pages