Business Functions {STWEBM-1}

{STWEBM-1} and {STWEBM-2} has been merged on INT4.0. {STWEBM-2} has been discontinued and added as the 'Child Block' of {STWEBM-1}.

This program is used to maintain Business Functions. Business Functions are used in

The iEnabler Modules to set up a hierarchical structure of different Business Functions options to be accessed by the end user. Refer to the Operational Manual for Business Function and Process Manipulation for more information.
Entry Point screens in the back-office system. Refer to the Overview of Entrypoints for more information.
The Business Process Driver

Panel Box 1: Business Functions

Field	Type & Length	Description
System Code	A1	The system code for this Business Function will be defaulted into this field. It is dependant on the menu option it is invoked: (I) Student (from STWEBM-1), (P) Personnel (from PWEBM-1).
Business Function	A10	Business Function Code. Note that for Business Functions, that is not "System Created" (clients), the Business Function Code should start with "N" or "O".
Business Function Description	A30	A description for the Business Function.
Prompt Description	A40	Enter a description at the prompt for this business function. For Business Functions used in the iEnablers, this is the Description that will be displayed in the menu frame on the web system for this business function. For Business Functions used in Entry Points, this is the Description in the left-top frame heading.
Sequence of this Business Function	A30	For the iEnablers, the sequence in which the business function will be displayed within the parent business function supplied, if any. This field does not play a role in Entry Point- and Business Process Driver set-ups
Validate User	A1	For the iEnablers, a "Y"es will to indicate that the end user should also be defined as a User in the User Access Definitions {USERS-5} before being able to use this Business Function. This field does not play a role in Entry Point- and Business Process Driver set-ups
Additional SQL	A2000
Parent Business Function	A10	For the iEnablers, this field is used to indicate if the current business function is linked to a parent function, e.g. Application, Residence Application, Registration, etc., are all linked to S00000-Student Web Systems. This may be used to create the multi-level structure.
System Created	A1	If ‘Y’ or ‘N’, the record is part of the standard ITS Software set-ups, may not be deleted and limited fields may be updated, otherwise the user has full control over the record.
Remarks	A250	Enter any remarks regarding this Business Process
Allow Auto Navigation	A1	For the iEnablers, will Auto Navigation within the Business Process for a particular Business Function be done. This field does not play a role in Entry Point- and Business Process Driver set-ups
EP Query Entity	A30	For Entry Points, the name of the EP Query Entity without the extension. This field does not play a role in iEnabler- and Business Process Driver set-ups
EP Query Directory	A20	For Entry Points, the directory for the EP Query Entity without the slash. This field does not play a role in iEnabler- and Business Process Driver set-ups

Panel Box 2: Business Function Processes

Field	Type & Length	Description
Sequence Nr	N999	Enter or change the display sequence of this business process in the business function. The number is usually incremented by 10 to leave space for later additions.
Menu Code	A7	Enter value for Menu Code, as defined in {USERS-1b1}. This field, together with the Option field, will be used to retrieve the instruction to be executed by this Business Process.
Option	A2	Enter value for the Menu Option, as defined in {USERS-1b2}.
Option Description	A40	The description linked to the supplied menu code and option, as defined in {USERS-1b2}, will be displayed here.
Mandatory Business Process	A1	Is completion of this business process mandatory for the completion of the business Function that it is coupled to?
Active	A1	Is this Business Process active? For iEnablers, if this field is "N"o, the process will not be available. Processes can be set to Active "N" for a period and then re-activated when needed. An example of this is exam results that can be made inactive as a rule and only activated when the institution publishes their results. Note that only non-mandatory Business Processes may be made inactive. To set a mandatory process as inactive, you will first have to change the Business Process to Mandatory "N", before setting the Process Active "N".
Table Name	A4	For Business Function Processes used in the Business Process Driver, the table together with the key field may be used to check whether this process has been completed, provided that the process results in the creation of a record in the database. This is only used when the process is defined as Mandatory ‘Y’.
Key Field	N6	Enter a Value for key Column Number, as defined in {DMAIN-1b8 (columns)}.
System Created	A1	If the system created field = "Y" (for users), then the following fields will not be able to be updated: Menu and Option Table name and key field.
Dependant on Previous Mandatory Process?	A1	Is this process dependant on another Mandatory Process? If a process is dependant on a previous Mandatory Process, the user will not be allowed to start the process before the dependant process is completed. If this field is set to (Y)es, the Dependency Sequence becomes mandatory.
Dependency Sequence	N5	The sequence of the mandatory Business Process that must be completed before this option can be utilised.
Additional SQL	A100	The Additional SQL Field also plays a role in restricting the count that is done to determine whether a mandatory business process was completed, if necessary. An example of adding Additional SQL would be adding Additional SQL to the "Application" Business Process as follows: Table Name would be "IER" (IERAAD), Key Field would be "1" (IAESTNO) and Additional SQL could be "IERCYR >= to_char(sysdate,'YYYY')". The resultant query will be built as : select count(ierstno) from ieraad where ierstno = v_unum and IERCYR >= to_char(sysdate,'YYYY'); The Additional SQL will make sure that the application records counted are only for the current and future years.
Validation Rule	A8	Supply the rule that contains the validation for the step.

Example:

Processing Rules
	No special processing rules.

History of Changes

Date	System Version	By Whom	Job	Description
22-Feb-2007	v01.0.0.0	Amanda Nell	t134844	New manual format.
13-Dec-2007	v01.0.0.0	Melanie Zeelie	t134844	Proofread.
17-Nov-2008	v01.0.0.0	Magda van der Westhuizen	t151713	Update manual: Language Editing: Juliet Gillies.
24-Apr-2009	v01.0.0.1	Frans Pelser	t153594	Add rules for System Created records
24-Jan-2017	v04.0.0.0	Magda van der Westhuizen	t213313	{STWEBM-2} has been discontinued and added as the child block of {STWEBM-1}. Update the manual with the latest changes.
09-Mar-2020	v04.1.0.0	Hellen Kgosi	t242100	Inserted a new image.