Joseph Manuel Wilson

Low Level Design Module 16 IPB16_1e REVISION HISTORY Version 1.00 Date 24/11/2015 Particulars Document Creation Author Syalu 2.0 30/11/2015 Incorporated the changes mentioned Syalu Version 100 Review Date- - Reviewed By Wilson Comments Corrections In Section 2.1.2.2 & 2.2.2.1 Highlighted In Yellow Wilson Approved Page 1 of 12 Low Level Design Module 16 IPB16_1e Req.ID Requirement 16.1e Sr.No-. Sr no The end user should be able to edit the defined CTC 1 Component (Fixed or Variable). The CTC Component can be Fixed Pay and Variable Pay (also known as Performance Bonus) Sub-Menu Option Names Define Fixed & Variable CTC Component Define CTC Percentage of Fixed & Variable Pay. Define Variable Pay Components. Compute Employee’s Fixed and Variable Pay of CTC Compute Employee’s Percentage Variable Pay Components Amount Define Percentage of Variable Pay for the weightage/rating Define Organization Performance Bonus Qualifying Percentage against targets. 8. Input the Employee Performance Evaluation Rating 9. Compute Employee’s, Individual Performance Variable Pay Component Amount. 10. Compute Employee’s, Organization Performance Variable Pay Component Amount. 11. Compute Employees total payable Variable pay Req. ID-. Path Definition PARTICULARS Global Front End Functions Global Back End Functions Version 100 PATH HRMS/library/js/ HRMS/library/php/ Page 2 of 12 Low Level Design Module 16 IPB16_1e 1. INTRODUCTION The end user should be able to edit the defined CTC Component (Fixed or Variable). The CTC Component can be Fixed Pay and Variable Pay (also known as Performance Bonus) 2. TASKS 2.1 Front End Tasks 2.1.1 Menu Layouts and Navigational Flow 2.1.1.1 Menu Layout Version 100 Page 3 of 12 Low Level Design Module 16 IPB16_1e 2.1.1.2 Navigation Layout 2.1.2 Screen Layouts 2.1.2.1 Header Section Screen Layout Version 100 Page 4 of 12 Low Level Design Module 16 IPB16_1e 2.1.2.2 Header Section Screen Definition ITEM NAME (Label/Name) ITEM TYPE Drop down box ID CLASS EVENT/FUNCTION NAME (OPTIONA Function L) Select box After opening the “” tag Call the following function GB_ dynamicscript ($I,NI) On Mouse out Functions:GF_checkEmpty(this) Description Version 100 Text Field Textbox Call the following function inside value attribute of the field. GB_ dynamicscript ($I,NI) EDITABLE (Y/N) Parameters Integration Y $I=”GB_showDropdown ($GB_tablename,$GB_ColArray,$GB_ RetriveCondition,$GB_Value,$GB_dis playName); Non Integration $NI=same as above NIL Integration Y $I=”GB_showTextValue($GB_tablena me,$GB_ColArray,$GB_RetriveCondit ion,$GB_displayValue); Non Integration $NI='same as integration’ Page 5 of 12 Low Level Design Module 16 IPB16_1e CTC Component Code Update Cancel Radio button Radio button On Mouse out Functions:GF_checkEmpty(this) Call the following function inside value attribute of the field. GB_ dynamicscript ($I,NI) NIL NIL Nil Enabled Nil Enabled Button Nil On Mouse out Functions:GF_checkEmpty(this) Nil Button Nil Nil Integration $I=”GB_showRadio($GB_tablename, $GB_ColArray,$GB_RetriveCondition $GB_fieldName); Non Integration $NI='same as integration’ Y 2.1.2.3 Detail Section Screen Layout NIL 2.1.2.4 Detail Section Screen Definition NIL 2.2 Back End Tasks 2.2.1 Error codes 2.2.1.1 Generic Error Codes (Link to error code document) 2.2.1.2 List of Generic error codes used Error_Id 2.2.1.3 Define New Error Codes Error Description 10002 Version 100 Please Enter a value Purpose Used for displaying when the text Page 6 of 12 Low Level Design Module 16 IPB16_1e field is empty 10003 Please select a value 10004 Unknown error. Used for displaying, when the dropdown field is not selected Used for displaying when an exceptional error occurs 2.2.2 Data Item Definition & Data Process Section 2.2.2.1 Screen Item Definition ITEM NAME (Label/Name) ID Parameters defined before field name $GB_tablename = "1601_CTCComponent" $GB_ColArray =" 1601_ID" $GB_RetriveCondition = "" $GB_Value = "1601_ID" $GB_displayName = "1601_ID" Version 100 ITEM DESC (OPTIONAL ) Event VALIDATION Function Invocation Order Action DATABASE TABLE On Pageload Check if the Field is selected Event: On Pageload Function invoked : GB_ dynamicscript ($I,NI) Purpose: To populate all the CTC Component ID’s from database Event: On Mouse out Function invoked : GF_checkempty () Purpose: If the field is empty throw the corresponding error code. R 1601_CTCC omponent Page 7 of 12 DATABASE DATA COLUMN TYPE 1601_ID N Low Level Design Module 16 IPB16_1e Description $GB_tablename = "1601_CTCComponent" $GB_ColArray =" 1601_ID, 1601_desc" $GB_RetriveCondition = "1601_ID =xxx" // value of xxx is obtained from ID (CTC Component ID) // $GB_Value=”1601_desc” $GB_displayName = "1601_desc" CTC Component Code $GB_tablename = "1601_CTCComponent" $GB_ColArray =" 1601_CTCComponentCode" $GB_RetriveCondition = "1601_ID =xxx" // value of xxx is obtained from ID (CTC Component ID) // $GB_Value=”1601_CTCComponent Code” $GB_fieldName= "1601_CTCComponentCode" If the field 1601_CTCC omponentC ode is F, then it is fixed pay If the field 1601_CTCC omponentC ode is V, then it is Variable pay On Pageload Check if the field is not empty On Pageload Check if the field is selected Event: Onpageload Function invoked : R,U GB_ dynamicscript ($I,NI) Purpose: Used to retrieve data from table to populate the text box Event: OnMouseout Function invoked : GF_checkempty () Purpose: If the field is empty throw the corresponding error code Event: Onpageload Function invoked : R,U GB_ dynamicscript ($I,NI) Purpose: Used to retrieve data from table to populate the drop down box Event: OnMouseout Function invoked : GF_checkempty () Purpose: If the field is empty throw the corresponding error code 1601_CTCC omponent 1601_desc 1601_CTCC omponent 1601_CTCC C omponentC ode 2.2.2.2 Data Processing Section (used in 2.2.3 Form submission “2.2.3.1 Processing Section”) NIL 2.2.3 Form Submission Version 100 Page 8 of 12 C Low Level Design Module 16 IPB16_1e Form name Purpose Triggered by Tables accessed Controller file name Processing : Edit_IBP16_1e : Process and update Edit_IBP16_1e form data into the DB. : Update Button : 1601_CTCComponent (Retrieval and Updation) : Edit_IBP16_1e _controller.php : If the Update button is Clicked, Update data into 1601_CTCComponent. 2.2.3.1 Processing Section NIL 2.2.3.2 Display Section NIL 2.2.4 Functions Invoked 2.2.4.1 System Functions Version 100 Function Description Input parameter(s) Output parameter(s) Called by Mysql_conn ect_db (Back end) Connects to the database Server DB login informations [Hostname(string), username(string),P assword(string)] Start up Mysql_selec t_db (Back end) Selects the required database Database name (string) Boolean value. i.e if the system connects the database successfully then the DB server will return true. (Boolean) Boolean value. i.e if the system could select the database successfully then the DB server will return true. (Boolean) Start up Page 9 of 12 Low Level Design Module 16 IPB16_1e Field 2.2.4.2 Library Functions NIL 2.2.4.3 Define New Function NIL 2.2.4.4 Exception error handling Associated Function(s) Error Handling GB_showDropdown() GF_checkEmpty() Any unknown error Description GB_showTextValue() GF_checkEmpty() Any unknown error CTC Component Code GF_showRadio() GF_checkEmpty() Any unknown error Show the error description for exceptional errors. GB_getErrors(‘10004’); Show the error description for exceptional errors. GB_getErrors(‘10004’); Show the error description for exceptional errors. GB_getErrors(‘10004’); ID 2.2.5 Global Data Structure Usage This section shows the global data structure being used in this requirement Global Data Structures Description Used by Name:$GB_errorArray Type:Array (string) Structure:[‘error_ID’,’errorDescription’] The $errorArray Array stores all the error descriptions in it as the return ofGB_getErrors() function.so it is not necessary to access the database each time to retrieve the errors. GB_getErrors() 2.2.6 Detailed Data Design Schema of the Database used for this requirement CREATE TABLE 1601_CTCComponent ( Version 100 Page 10 of 12 Low Level Design Module 16 IPB16_1e 1601_ID int(5) NOT NULL AUTO_INCREMENT, 1601_desc varchar(255), 1601_CTCComponentCode int(10), PRIMARY KEY (1601_ID)) type=InnoDB; 2.2.7 Database Usage This section describes the database usage in term of the table/column usage whether it is being created, retrieved, updated, deleted or archived. This can be displayed in the form of table below. This table should be updated after the coding of the software is complete. Table Columns 1601_CTCComponent 1601_ID 1601_desc 1601_CTCCom ponentCode Operation R R, U R, U 2.2.8 Relationship Among various Structural Components It should include the relationship among the various structural components of the system. Structural components can be sub modules or programs or procedures/functions. NIL 2.2.9 Mandatory & Non Mandatory UI fields Module Screen name Field name Performance Bonus Version 100 Edit_IBP16_1e ID Mandatory (Y/N) Y Page 11 of 12 Low Level Design Module 16 IPB16_1e CTC Component Code CTC Component Description 3 4 5 Y Y Appendix NIL References NIL Terminologies NIL Version 100 Page 12 of 12