View source for FS 356080 Add Parameters for Additional Data

<div class="noprint">
{{#vardefine:Client|RJH}}
{{#vardefine:ClientName|Rory J Holbrook}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|Add Parameters for Additional Data}}
{{#vardefine:Version|0.4}}
{{#vardefine:Date|7th March 2019}}
{{#vardefine:Reference|356080}}
{{#vardefine:Year|2019}}
{{ #vardefine: Figure | 0 }}{{ #vardefine: Example | 0 }}
<!--
Sample Xref:
{{Xref
|Type=Figure
|Num={{ #vardefineecho: Figure| {{ #expr: {{ #var: Figure}} + 1 }} }}
|Text=Data Upload - Import screen.}}
-->
</div>
{{Doc_TitleNew
|Client={{#var:ClientName}}
|System={{#var:System}}
|Title={{#var:Doc_Title}}
|Reference=FS {{#var:Reference}}
|Version={{#var:Version}}
|Date={{#var:Date}}
|Year={{#var:Year}}
}} 

<!-- TOC --> 
<div class="noprint">
= FUNCTIONAL OVERVIEW  =
== Client Requirement  ==
It has been identified that the EPOD database requires the ability to add user-defined parameters against static data, such as customers.


== Solution Overview  ==
Parameter Master Configuration will be added to the ''CALIDUS'' ePOD Admin console. This will allow users to define customer parameters or any ID or type for the site.

The Admin Customer Maintenance screen will allow users to enter parameter values against the configured master parameters.


These will be available for the Configurable POD report to access and use.


== Scope  ==
The changes will be made in the latest versions of ''CALIDUS'' ePOD. The changes will be available only to 4.5 (next version) customers.

Specifically, this is required against customer records at this time, to fulfill associated customer demands. However, the functionality will be written in such a way that it may be used to extend other tables as demanded, for example:
* Jobs
* Vehicles

This initial development will create the basic requirements of parameters and master definitions for customers only - additional developments will be required if this is to be extended to other tables at a later time.

At this time, customer parameters may only be defined through the ''CALIDUS'' ePOD Admin customer screen - they may not be defined through the any interface (CSV, XML, web service or manual customer upload).


== Impact ==
Most of these changes are required before POD reports requiring customer parameters can be created. Specifically, the following is dependent on these changes:
* 355526 Rory Holbrook POD Notes


<!-- NEW PAGE --> 
= CONFIGURATION SET-UP  =
== Pre-requisites  ==
None.


== Menu Structure  ==
A new Administration menu option "Parameter Master" will be added to the Administration menu in ''CALIDUS'' ePOD Admin console.


== Data  ==
New EPOD_DATA_LISTS will be created for the following items:
* ParameterAssociation
* ParameterDisplayType
* ParameterValueType

New EPOD_DATA_LIST_ITEMS will be created for the lists above:
* ParameterAssociation
** Value "EPOD_CUSTOMER", description "Customer".
* ParameterDisplayType
** Value "TextBox", description "TextBox".
* ParameterValueType
** Value "String", description "String".


{{Note}} New EPOD_ADM_PARAMETER_VALUE records will be created as part of the product change for field definitions. This will define EPOD_ADM_PARAMETER_MASTER records matching those already created for EPOD_LIST ListName "ddlUDFDataboundFields".

{| class="wikitable" border="1"
|-bgcolor="silver"
!Description	||Value
|-
|Trailer ID (Load)	||PDALOAD.EPL_TRAILER_ID
|-
|Mileage Start (Load)	||PDALOAD.EPL_MILEAGE_START
|-
|Mileage End (Load)	||PDALOAD.EPL_MILEAGE_END
|-
|Load Information	||PDALOAD.EPL_LOAD_INFORMATION
|-
|Route Code	||PDALOAD.EPL_ROUTE_CODE
|-
|Owner Name	||PDAJOB.EPL_OWNER_NAME
|-
|Contact Name	||PDAJOB.EPL_CONTACT
|-
|Customer Name	||PDAJOB.EPL_CUSTOMER_NAME
|-
|Address Line 1	||PDAJOB.EPL_ADDRESS_1
|-
|Address Line 2	||PDAJOB.EPL_ADDRESS_2
|-
|Address Line 3	||PDAJOB.EPL_ADDRESS_3
|-
|Address Line 4	||PDAJOB.EPL_ADDRESS_4
|-
|Post Code	||PDAJOB.EPL_POSTCODE
|-
|Trailer ID (Job)	||PDAJOB.EPL_TRAILER_ID
|-
|User Notes	||PDAJOB.EPL_USER_NOTES
|-
|Customer Reference (Job)	||PDAJOB.EPL_CUST_REF
|-
|SO Number	||PDAJOB.EPL_SO_NUMBER
|-
|Mileage Start (Job)	||PDAJOB.EPL_ODO_START
|-
|Mileage End (Job)	||PDAJOB.EPL_ODO_END
|-
|Code 1	||PDACONTAINER.EPL_CODE_1
|-
|Code 2	||PDACONTAINER.EPL_CODE_2
|-
|Code 3	||PDACONTAINER.EPL_CODE_3
|-
|Customer Comments (Container)	||PDACONTAINER.EPL_CUST_COMMENTS
|-
|Customer Reference (Product)	||PDAPRODUCT.EPL_CUST_REF
|-
|Customer Comments (Product)	||PDAPRODUCT.EPL_CUST_COMMENTS
|-
|Position	||PDAPRODUCT.EPL_POSITION
|-
|Depot Test	||PDAPRODUCT.EPL_DEPOT_TEST
|-
|Product Weight	||PDAPRODUCT.EPL_PRODUCT_WEIGHT
|-
|Gross Weight	||PDAPRODUCT.EPL_GROSS_WEIGHT
|-
|Device Current Date (DD/MM/YYYY)	||PDADEVICE.CURRENT_DATE_DDMMYYYY
|-
|Device Current Time (HH:MM)	||PDADEVICE.CURRENT_TIME_HHMM
|-
|Device Timezone	||PDADEVICE.TIMEZONE
|-
|Device GPS	||PDADEVICE.GPS
|-
|Device ID	||PDADEVICE.DEVICE_ID
|-
|Device Type	||PDADEVICE.DEVICE_TYPE
|-
|Device Locale	||PDADEVICE.DEVICE_LOCALE
|-
|Device Country	||PDADEVICE.DEVICE_COUNTRY
|-
|Device Language	||PDADEVICE.DEVICE_LANGUAGE
|}


== Implementation Advice ==
None.


<!-- NEW PAGE --> 
= FUNCTIONAL DESCRIPTION =
== Admin Modifications ==
=== Customer Code Maintenance ===
The existing Customer Code Maintenance screen will be modified to allow the users to enter parameters against a customer when creating or editing them, or to edit existing parameters.


When the user creates a new customer or edits an existing customer, the screen shows the add/edit pop-up panel.

This will be modified to have a new ''Parameters'' tab added to it, to the right of any existing tabs.

This will work similarly to the '''Time, Expenses and Charges''' tab on the Job Details pop-up panel.


When the user clicks this tab, the screen will display all parameters associated to that customer.

The tab will display the parameters in a parameter results table, with the following columns:
* ''Parameter'' - the master label.
* ''Description'' - the master description, with pop-up help of the long description.
* ''Value'' - the parameter value.
* ''Actions''.
The ''Actions'' column will be displayed only if the system is displaying action buttons. This will include buttons for the following:
* '''Delete''' - This button will have pop-up help "Delete this record".
* '''Edit''' - This button will have pop-up help "Edit this record".


A row will be present below the table:
* ''Parameter'' - A drop-down list of parameters capable of being added to customers. A default value of "Select a Parameter" will be at the top of the list. No other fields or buttons on this row may be entered until a value is selected in this drop-down list.
* ''Description'' - the master description, populated when the parameter is selected from the drop-down list. The pop-up help text will be populated with the long description.
* ''Value'' - the parameter value, a text box capable of being edited.
* ''Actions'' - consisting of the following buttons:
** '''Add''' - a button to add the new parameter. This button will have pop-up help "Add this record". 

When the user selects a new parameter type from the drop-down list, the panel will enable the Value text box and '''Add''' button.

{{Note}} The parameter list will only show those parameters that have not yet been entered for the customer, or allow multiple values to be specified.

When the user clicks '''Add''', the panel will check that the parameter value is populated if the parameter is required. If not, a pop-out validator will display that it is required and the parameter will not be added.

If the parameter is optional or the user has entered a value, the panel will save the entry and refresh the parameter results table.


To edit an existing parameter, the user will press the '''Edit''' button against that parameter row in the parameter results table.

The panel will then refresh the row, showing a text box for the amendment of the value. The Action column for this row will have additional buttons:
* '''Save''' - This button will have pop-up help "Save changes". 
* '''Discard''' - This button will have pop-up help "Discard changes". 

The user may then edit the value in the row.

If the user clicks the '''Discard''' button, the parameter results table will refresh, with the row no longer being edited.

When the user clicks the '''Save''' button, the panel will check that the parameter value is populated if the parameter is required. If not, a pop-out validator will display that it is required and the parameter will not be saved.

If the parameter is optional or the user has entered a value, the panel will save the entry and refresh the parameter results table with the row no longer being edited.

If the user clicks the '''Delete''' button against an exiting parameter, the screen will display a confirmation dialogue to ask the user if they are sure. If the user confirms, the screen will delete the record and refresh the parameter results table.


=== New Master Parameter Maintenance Screen ===
A new screen will be created for the users to enter master parameter definitions.

The screen will allow the users to find and edit parameter master definitions or create a new parameter master definition.

A header bar will be displayed with the following elements:
* '''Find''' button. This button will have pop-up help "Find records matching the entered criteria".
* '''New''' button. This button will have pop-up help "Create a new record".
* Status text, for showing messages.

The '''New''' button will only be displayed if the logged-on user has full admin authorisation.

The '''Find''' button will show the search criteria panel, which will also be displayed automatically on start-up of the screen.

The criteria that can be entered are:
* ''Parameter Code'' - Text box entry, limited to 20 characters of type alpha, numeric, underscore and dash only. Default value "".
* ''Association'' - A drop-down list of values populated from EPOD_LIST_ITEMS. At this time only "EPOD_CUSTOMER" and "EPOD_UDF_FIELD" are supported. The drop-down list will also have a value "Select an Option", which denotes that no criterion value has been entered and is the default value.
* ''Label'' - Text box entry. Default value "".
* ''Description'' - Text box entry. Default value "".

The panel will also show the following buttons:
* '''Clear''' - reset the search parameters to default values.
* '''Search''' - perform a search with the criteria.

When the user presses '''Search''', the screen will call the appropriate EPOD_ADM_PARAMETER_MASTER search method, passing in the search criteria entered by the user.

The returned values will be loaded to a data results table and displayed in a grid showing the following fields:
* ''Parameter Code''.
* ''Association''.
* ''Label''.
* ''Description''.
* ''Actions''

The ''Actions'' column will be displayed only if the system is displaying action buttons. This will include buttons for the following:
* '''Select''' - pop-up the details of the selected row in a pop-up edit panel.

When clicking the '''New''' button, the screen will display a pop-up entry panel.


The pop-up panel displayed for entering new parameter master definitions or editing existing ones will be the same panel.

When creating or editing a new parameter master, the following fields are displayed on the pop-up panel:
* ''Parameter Code'' - the name of the parameter. Text box entry, limited to 50 characters of type alpha, numeric, underscore, full stop and dash only.
* ''Association'' - the table to which this parameter is associated. A drop-down list of values . At this time only "Customer" and "UDF Field" are supported.
* ''Label'' - the label of the parameter. Text box entry, limited to 30 characters
* ''Description'' - the description for the parameter. Text box entry, limited to 100 characters
* ''Pop-up Help''/''Validation'' - the description for the parameter. Text area entry, limited to 2000 characters
* ''Required'' - Check-box entry, defaulted to checked.
* ''Multiple'' - Check-box entry, defaulted to unchecked. This will be disabled for UDF Fields.
* ''Active'' - Check-box entry, defaulted to checked.
* ''Display Type'' - Drop-down list of values. At this time, only "TextBox" is supported. For UDF Fields, other values will be allowed. 
* ''Value Type'' - Drop-down list of values. At this time, only "String" is supported.
If editing an existing definition, all fields will be disabled. When creating a new definition, all fields will be enabled.

The panel will also have the following buttons:
* '''Edit''' - This button will have pop-up help "Edit this record". This button is displayed if editing an existing definition and the logged-on user has full admin authorisation. On clicking this button, the fields are enabled for entry, this button will be hidden and the '''Save''', '''Exit''' and '''Delete''' buttons will be enabled.
* '''Save''' - This button will have pop-up help "Save and Exit". This button is displayed when the '''Edit''' button is clicked or when creating a new master parameter definition. When clicked, the panel will close and the screen will save the new record or update the existing record. The results table will be refreshed.
* '''Exit''' - This button will have pop-up help "Exit without saving". This button is displayed when the '''Edit''' button is clicked or when creating a new master parameter definition. When clicked, the panel will close. The results table will not refresh.
* '''Delete''' - This button will have pop-up help "Delete". This button is displayed when the '''Edit''' button is clicked. When clicked, the screen will display a confirmation dialogue to ask the user if they are sure. If confirmed, the panel will close and the screen will delete the record.


<!-- NEW PAGE --> 
= TECHNICAL NOTES =
== Modules Changed ==
<!-- List the modules or objects that will be changed by this development -->
{| class="wikitable" border="1" width="100%"
|-bgcolor="#FFFF99"
! width="20%" | Module Name || width="40%" | Module Type || width="40%" | Notes
|-
| 356080_DATA_EPOD_LIST_ITEMS.sql || Database Change Script  || Adding new lists and list items. Naming is dependent on date/time of code completion.
|-
| 356080_DATA_EPOD_ADM_MENU_OPTION.sql || Database Change Script || Adding new menu option. Naming is dependent on date/time of code completion.
|-
| 356080_DATA_EPOD_ADM_PARAMETER_MASTER.sql || Database Change Script || Adding new UDF Field definitions. Naming is dependent on date/time of code completion.
|-
| EPOD_ADM_PARAMETER_MASTER.cs || DAL || Replaced with EPODDatabaseClassLibrary Model/DAL/BAL
|-
| EPOD_ADM_PARAMETER_VALUE.cs || DAL || Replaced with EPODDatabaseClassLibrary Model/DAL/BAL
|-
| EPOD_UTILS.cs || DAL || &nbsp;
|-
| EPOD_CUSTOMER.cs || DAL || &nbsp;
|-
| customer_maint.aspx || ASP Form || &nbsp;
|-
| ParameterMaintenance || MVC Form || &nbsp;
|}


== Table Updates ==
Table EPOD_ADM_PARAMETER_VALUE:

{| class="wikitable" border="1" width="100%"
|-bgcolor="#FFFF99"
! width="20%" | Name || width="10%" | Type || width="10%" | Nullable || width="10%" | Default || width="10%" | Storage || width="40%" | Comments
|-
| APV_ID || Identity || No || Auto-increment || &nbsp; || &nbsp;
|}


Table EPOD_ADM_PARAMETER_MASTER:

{| class="wikitable" border="1" width="100%"
|-bgcolor="#FFFF99"
! width="20%" | Name || width="10%" | Type || width="10%" | Nullable || width="10%" | Default || width="10%" | Storage || width="40%" | Comments
|-
| APM_CODE || varchar2(50) || No || None || &nbsp; || &nbsp;
|}


== Developer Notes ==
== Database/DAL changes ==
The existing table EPOD_ADM_PARAMETER_VALUE will be modified so that the existing column APV_ID is set as an identity column, auto-incrementing the value. This will be the primary index, with any existing primary index relegated to a unique key.


{{Note}} A new static class EPOD_PARAMETER_ASSOCIATIONS will be created in EPOD_UTILS.cs. At this time this will consist solely of the following:
    public static string Customer = "EPOD_CUSTOMER";
This will be used whenever APV_ASSOCIATION value EPOD_CUSTOMER is required.


{{Warning}} The existing EPODServer DAL objects will be discarded. These will be redefined as EPODDatabaseClassLibrary model/DAL/BAL classes. The following text describes what would need to be changed from the existing EPODServer DAL objects.


=== Parameter Master Definitions ===
This DAL object (EPOD_ADM_PARAMETER_MASTER.cs) will be modified for this change.

{{Note}} The existing EPOD_ADM_PARAMETER_MASTER DAL object is incomplete. This will be completed, adding in methods to:
* Select an existing EPOD_ADM_PARAMETER_MASTER record by code and association.
* Delete an existing EPOD_ADM_PARAMETER_MASTER record.
* Update an existing EPOD_ADM_PARAMETER_MASTER record.

A new public method GetParamsByAssociation will be created that will retrieve parameters for a specific site and table.

This method will:
* Create an empty list of parameter masters.
* Retrieve all parameter masters from the database where APM_SITE_ID is set to the passed in Site parameter and APV_ASSOCIATION is set to "EPOD_CUSTOMER".
* If any records are found, create an EPOD_ADM_PARAMETER_MASTER object from the data row and add to the list.
* Return the list.

The field length of the APM_CODE field will be extended to 50 characters.


=== Parameter Values ===
This DAL object (EPOD_ADM_PARAMETER_VALUE.cs) will be modified for this change.

{{Note}} The existing EPOD_ADM_PARAMETER_VALUE DAL object is incomplete. This will be completed, adding in methods to:
* Select an existing EPOD_ADM_PARAMETER_VALUE record by code, association and key.
* Select an existing EPOD_ADM_PARAMETER_VALUE record by id.
* Delete an existing EPOD_ADM_PARAMETER_VALUE record.
* Update an existing EPOD_ADM_PARAMETER_VALUE record.

The constructor for the object (EPOD_ADM_PARAMETER_VALUE) will be modified to populate the ID of the parameter value found. This constructor will also retrieve the parameter master (EPOD_ADM_PARAMETER_MASTER) record into an EPOD_ADM_PARAMETER_MASTER DAL object read-only property for this object. This will be read into the object when creating a new parameter value or selecting an existing parameter value.

A new public method GetParamsForAssoc will be added to retrieve parameters for a specific site, association and key value.

{{Note}} The current process has a method GetParamsForCustomer that can be copied for this.

This method will:
* Create an empty list of parameters.
* Retrieve all parameters from the database where APV_SITE_ID is set to the passed in Site parameter, APV_KEY is set to the passed in Customer parameter and APV_ASSOCIATION is set to "EPOD_CUSTOMER".
* If any records are found, create an EPOD_ADM_PARAMETER_VALUE object from the data row and add to the list.
* Return the list.

A new public method DeleteParamsForAssoc will be added to delete parameters for a specified site, association and key value.

{{Note}} The current process has a method DeleteParamsForCustomer that can be copied for this.

This method will:
* delete all parameters from the database where APV_SITE_ID is set to the passed in Site parameter, APV_KEY is set to the passed in Customer parameter and APV_ASSOCIATION is set to "EPOD_CUSTOMER".


=== Customer ===
This DAL object (EPOD_CUSTOMER.cs) will be modified to add a list of parameters associated to this record.

A new property EPOD_ADM_PARAMETER_VALUES will be added as a list of DAL object EPOD_ADM_PARAMETER_VALUE.

This will be set to an empty list when creating a new instance of this object (in method SetEmptyDefault), or will be populated with the values retrieved for this customer (in method GetCustomer).

Method GetCustomer will set the new property to an empty list if this customer does not exist. If the customer does exist, it will call the method EPOD_ADM_PARAMETER_VALUE.GetParamsForCustomer, passing a connection, the site id and customer code.

The Delete method will be modified to delete any associated EPOD_ADM_PARAMETER_VALUE records associated to this customer, using the EPOD_ADM_PARAMETER_VALUE DAL object method DeleteParamsForCustomer.


== Admin Modifications ==
=== Customer Code Maintenance ===
The existing Customer Code Maintenance screen (customer_maint.aspx) will be modified to allow the users to enter parameters against a customer when creating or editing them, or to edit existing parameters.


When the user creates a new customer or edits an existing customer, the screen shows the add/edit pop-up panel.

This will be modified to have a new ''Parameters'' tab added to it, to the right of any existing tabs.

This will work similarly to the '''Time, Expenses and Charges''' tab on the Job Details pop-up panel.


When the user clicks this tab, the screen will display all parameters associated to that customer, using the EPOD_CUSTOMER property EPOD_ADM_PARAMETER_VALUES as the data source.
The tab will display the parameters in a parameter results table, with the following columns:
* ''Parameter'' - the master label.
* ''Description'' - the master description, with pop-up help set to the long description.
* ''Value'' - the parameter value, a text box capable of being edited.
* ''Actions''.
The ''Actions'' column will be displayed only if the system is displaying action buttons. This will include buttons for the following:
* '''Delete''' - This button will have pop-up help "Delete this record".
* '''Edit''' - This button will have pop-up help "Edit this record".

{{Note}} the property EPOD_ADM_PARAMETER_VALUES is a list of EPOD_ADM_PARAMETER_VALUE DAL objects. The EPOD_ADM_PARAMETER_VALUE DAL object itself contains a property EPOD_ADM_PARAMETER_MASTER, set from the associated EPOD_ADM_PARAMETER_MASTER DAL object. This property can be used to retrieve the parameter master properties required for the display on this table.

A row will be present below the table:
* ''Parameter'' - A drop-down list of parameters capable of being added to customers. This will be populated from the EPOD_ADM_PARAMETER_MASTER table for records associated to the table EPOD_CUSTOMER for this site, only for active parameters (APM_ACTIVE_IND = 1) and only parameters that have not yet been entered for the customer or allow multiple values. The drop-down list will have the APM_CODE as the value and APM_LABEL as the label. A default value of "Select a Parameter" will be at the top of the list. No other fields or buttons on this row may be entered until a value is selected in this drop-down list.
* ''Description'' - the master description (APM_DESCRIPTION), populated when the parameter is selected from the drop-down list. The pop-up help text will be populated with the long description (APM_LONG_DESCRIPTION).
* ''Value'' - the parameter value, a text box capable of being edited.
* ''Actions'' - consisting of the following buttons:
** '''Add''' - a button to add the new parameter. This button will have pop-up help "Add this record". 

When the user selects a new parameter type from the drop-down list, the panel will enable the Value text box and '''Add''' button.

When the user clicks '''Add''', the panel will check that the parameter value is populated if the parameter is required. If not, a pop-out validator will display that it is required and the parameter will not be added.

If the parameter is optional or the user has entered a value, the panel will save the entry and refresh the parameter results table.


To edit an existing parameter, the user will press the '''Edit''' button against that parameter row in the parameter results table.

The panel will then refresh the row, showing a text box for the amendment of the value. The Action column for this row will have additional buttons:
* '''Save''' - This button will have pop-up help "Save changes". 
* '''Discard''' - This button will have pop-up help "Discard changes". 

The user may then edit the value in the row.

If the user clicks the '''Discard''' button, the parameter results table will refresh, with the row no longer being edited.

When the user clicks the '''Save''' button, the panel will check that the parameter value is populated if the parameter is required. If not, a pop-out validator will display that it is required and the parameter will not be saved.

If the parameter is optional or the user has entered a value, the panel will save the entry and refresh the parameter results table with the row no longer being edited.

If the user clicks the '''Delete''' button against an exiting parameter, the screen will display a confirmation dialogue to ask the user if they are sure. If the user confirms, the screen will delete the record and refresh the parameter results table.


=== New Master Parameter Maintenance Screen ===
A new screen will be created for the users to enter master parameter definitions. This will be accessible from the main menu, Administration section and will be added to the menu definitions.

{{Note}} This will be written as an MVC screen.


The screen will allow the users to find and edit parameter master definitions or create a new parameter master definition.

A header bar will be displayed with the following elements:
* '''Find''' button. This button will have pop-up help "Find records matching the entered criteria".
* '''New''' button. This button will have pop-up help "Create a new record".
* Status text, for showing messages.

The '''New''' button will only be displayed if the logged-on user has full admin authorisation.

The '''Find''' button will show the search criteria panel, which will also be displayed automatically on start-up of the screen.

The parameters that can be used are:
* ''Parameter Code'' - Text box entry, limited to 20 characters of type alpha, numeric, underscore and dash only. Default value "".
* ''Association'' - A drop-down list of values populated from EPOD_LIST_ITEMS. At this time only "EPOD_CUSTOMER" and "EPOD_UDF_FIELD" are supported. The drop-down list will also have a null value "Select an Option", which denotes that no criterion value has been entered and is the default value.
* ''Label'' - Text box entry. Default value "".
* ''Description'' - Text box entry. Default value "".

The panel will also show the following buttons:
* '''Clear''' - reset the search parameters to default values.
* '''Search''' - perform a search with the criteria.

When the user presses '''Search''', the screen will call the appropriate EPOD_ADM_PARAMETER_MASTER search method, passing in the search criteria entered by the user.

The returned values will be loaded to a data results table and displayed in a grid showing the following fields:
* ''Parameter Code''.
* ''Association''.
* ''Label''.
* ''Description''.
* ''Actions''

The ''Actions'' column will be displayed only if the system is displaying action buttons. This will include buttons for the following:
* '''Select''' - show the details of the selected row in an edit panel.

When clicking the '''New''' button, the screen will display an entry panel.


The panel displayed for entering new parameter master definitions or editing existing ones will be the same panel.

When creating or editing a new parameter master, the following fields are displayed on the panel:
* ''Parameter Code'' - APM_CODE - the name of the parameter. Text box entry, limited to 20 characters of type alpha, numeric, underscore and dash only. Required entry.
* ''Association'' - APM_ASSOCIATION - the table to which this parameter is associated. A drop-down list of values populated from EPOD_LIST_ITEMS. At this time only "EPOD_CUSTOMER" is supported. Required entry.
* ''Label'' - APM_LABEL - the label of the parameter. Text box entry, limited to 30 characters. Required entry.
* ''Description'' - APM_DESCRIPTION - the description for the parameter. Text box entry, limited to 100 characters. Required entry.
* ''Pop-up Help'' - APM_LONG_DESCRIPTION - the description for the parameter. Text area entry, limited to 2000 characters. {{Note}} this field will be present only when association is not set to "EPOD_UDF_FIELD"
* ''Validation'' - APM_LONG_DESCRIPTION - the validation for the UDF Field. Text area entry, limited to 2000 characters. {{Note}} this field will be present only when association is set to "EPOD_UDF_FIELD".
* ''Required'' - APM_REQUIRED_IND - 0 - not required, 1 - required. Default to 1. Check-box entry (1 is checked).
* ''Multiple'' - APM_MULTIPLE_IND - 0 - single parameter only, 1 - multiples allowed. Default to 0. Check-box entry (1 is checked). This field will be disabled when the association is set to "EPOD_UDF_FIELD"
* ''Active'' - APM_ACTIVE_IND - 1 - Active, 0 - Inactive. Default to 1. Check-box entry (1 is checked).
* ''Display Type'' - APM_DISPLAY_TYPE - Drop-down list of values populated from EPOD_LIST_ITEMS. At this time, only "TextBox" is supported. It is intended that, in the future, this will support values of "TextBox", "CheckBox" and "DropDownList". Required entry. When the association is set to "EPOD_UDF_FIELD", this will be set to the UDF field format values list e.g. T/X/A/X2/B/DDL/L/P/TSC.
* ''Value Type'' - APM_VALUE_TYPE - Drop-down list of values populated from EPOD_LIST_ITEMS. At this time, only "String" is supported.  It is intended that, in the future, this will support values of "Integer", "String" and "DateTime". Required entry.
If editing an existing definition, all fields will be disabled. When creating a new definition, all fields will be enabled.

The panel will also have the following buttons:
* '''Edit''' - This button will have pop-up help "Edit this record". This button is displayed if editing an existing definition and the logged-on user has full admin authorisation. On clicking this button, the fields are enabled for entry, this button will be hidden and the '''Save''', '''Exit''' and '''Delete''' buttons will be enabled.
* '''Save''' - This button will have pop-up help "Save and Exit". This button is displayed when the '''Edit''' button is clicked or when creating a new master parameter definition. When clicked, the panel will close and the screen will save the new record or update the existing record. The results table will be refreshed.
* '''Exit''' - This button will have pop-up help "Exit without saving". This button is displayed when the '''Edit''' button is clicked or when creating a new master parameter definition. When clicked, the panel will close. The results table will not refresh.
* '''Delete''' - This button will have pop-up help "Delete". This button is displayed when the '''Edit''' button is clicked. When clicked, the screen will display a confirmation dialogue to ask the user if they are sure. If confirmed, the panel will close and the screen will delete the record.


When editing a parameter, the parameter code may not be changed.


When creating or editing a parameter master record, the following fields will be updated based on the selections of the user:
* APM_CODE - the name of the parameter. 
* APM_ASSOCIATION - the table to which this parameter is associated.
* APM_LABEL - the label of the parameter.
* APM_DESCRIPTION - the description for the parameter.
* APM_LONG_DESCRIPTION - set to the pop-up help for the parameter if the association is not "EPOD_UDF_FIELD", otherwise the validation parameter.
* APM_REQUIRED_IND - not required, 1 - required.
* APM_MULTIPLE_IND - single parameter only, 1 - multiples allowed.
* APM_ACTIVE_IND - 1 - Active, 0 - Inactive (the default for association "EPOD_UDF_FIELD").
* APM_DISPLAY_TYPE - "TextBox"
* APM_VALUE_TYPE - "String"

The following fields are automatically set when creating a new record or updating an existing record:
* APM_CREATED_BY - Automatically set to user that created the parameter.
* APM_CREATED_DATE - Automatically set when the parameter is created. 
* APM_LAST_UPDATED_BY - Automatically set to user that updated the parameter.
* APM_LAST_UPDATED_DATE - Automatically set when the parameter is updated. 
* APM_UPDATE_COUNTER - automatically incremented when updated.
* APM_SITE_ID - Set to the site ID of the user when creating the parameter. 
* APM_SEQUENCE - an integer counter, set to the next number in sequence for the association.

All other elements are not to be added at this time - they will be used for future development.
* Future use:
** APM_SEQUENCE - facility for the user to enter the sequence.
** APM_REQUIRED - automatically create required parameters when creating the source object and enforce that they are entered.
** APM_VALUES - a comma-delimited list of values for a drop-down list.
** APM_VALUES_DESC - a comma-delimited list of descriptions of the values defined above for a drop-down list.
** APM_VALUE_SOURCE - a SQL statement defining the codes and values for a drop-down list. The first column selected is the code, the second is the value, all others are ignored.
** APM_DATA_TYPE - used for data validation e.g. regexp patterns.
* Not expected to be used:
** APM_ICON
** APM_CATEGORY_CODE
** APM_DISPLAY_IND
** APM_LAST_ACTIVE_CHANGE_BY
** APM_LAST_ACTIVE_CHANGE_DATE
** APM_LAST_PROCESS_ID
** APM_GROUP_CODE


=== UDF Configuration Screen ===
The screen udf_Config.aspx will be modified to:
* Change the label of ddlFormatDBField from "Data-bound Field: " to "Default Field:".
* Populate the list from EPOD_ADM_PARAMETER_MASTER, selecting APM_CODE and APM_LABEL for association "EPOD_UDF_FIELD", using new method EPOD_ADM_PARAMETER_MASTER.GetParamsByAssoc.
* When selected, default the items on the screen as follows:
** ID: APM_CODE
** Type: APM_DISPLAY_TYPE	
** Label: APM_DESCRIPTION
** Group: APM_GROUP_CODE
** Required: APM_REQUIRED_IND
** Validation: APM_LONG_DESCRIPTION
* For X, X2 and DDL formats, items will be created for the field:
** For X and X2 formats, items will be created with the text.
** For DDL formats, items will be created with the code and text.


<!-- MEDIA LANDSCAPE YES --> 
= TEST PLAN  =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing parameters
|MenuAccess=Administration/Parameters Maintenance &amp; Maintenance/Customers
|Prerequisites=&nbsp;
|Objective=To test that parameters can be defined and stored against customers.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Parameters Maintenance
|Notes=&nbsp;
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create a new required customer parameter, required, with description and pop-up help. Save the parameter.
|Result=The drop-down lists contain the correct values. The label and description are required entry. The check-boxes work. The parameter appears in the results table.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create a new non-required customer parameter, required, with description and pop-up help. Save the parameter.
|Result=The parameter appears in the results table.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Find and filter the results.
|Result=The filters work as expected.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Edit an existing parameter.
|Result=All except the parameter code may be changed. The parameter saves changes correctly.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete an existing parameter.
|Result=Confirmation is displayed. When confirmed, the parameter is deleted.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}} 
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Customers Maintenance
|Notes=Ensure that there are several parameters that can be entered, including a multiple entry parameter and an inactive parameter.
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Find a customer with no parameters. Select to edit.
|Result=The parameters tab is displayed. The new line shows no parameter selected. There are no existing parameters. A parameter value may not be entered.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Select a new parameter to enter (required, not multiple).
|Result=The drop-down list shows all parameters that may be entered, excluding the inactive parameters. Once selected, the description is shown. The pop-up help is shown when hovering over the description. The value is enabled to enter.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Save.
|Result=A parameter value must be entered. 
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter the value and save.
|Result=The parameter is saved correctly. The parameter is displayed in the customer parameter table.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Select a new parameter to enter (not required, not multiple).
|Result=The drop-down list shows all parameters that may be entered, excluding the one already entered and any inactive parameters.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Save.
|Result=The parameter is saved correctly. The parameter is displayed in the customer parameter table without a value.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Select a new parameter to enter (multiple).
|Result=The drop-down list shows all parameters that may be entered, excluding the ones already entered and any inactive parameters.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter the value and save.
|Result=The parameter is saved correctly. The parameter is displayed in the customer parameter table.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Select the same multiple parameter to enter.
|Result=The drop-down list shows all parameters that may be entered, excluding the first 2 and inactive parameters, but still including the multiple parameter(s).
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter the value and save.
|Result=The parameter is saved correctly. The parameter is displayed in the customer parameter table.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Edit the parameter with the blank value.
|Result=The screen allows editing.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter a value and save.
|Result=The parameter is saved correctly. The parameter is displayed in the customer parameter table.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the second multiple parameter.
|Result=The parameter is deleted. The customer parameter table is displayed showing that this parameter is no longer present..
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}} 
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=UDF Maintenance
|Notes=&nbsp;
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create a new UDF configuration or edit an existing one. Add a new field or edit an existing field.
|Result=The screen displays "Default Field", with a drop-down of all fields expected.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Select a default field.
|Result=The field is defaulted as expected. For DDL/X/X2 fields, the items area created.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}} 

<!-- MEDIA LANDSCAPE NO --> 
{{Doc_AppendixNew
|Appendix=A
|Estimate=Y
|Glossary=EPOD2
|Ref1=[[FS 355526 Rory Holbrook POD Notes]]
|RefV1=0.2
|RefDate1=05/03/2019
|REQ=0
|EST=0.5
|FS=1.5
|TS=0
|DEV=8.0
|ST=1.25
|IMP=.5
|PM=.5
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Murray Middleton
|Rev1Title=OBS Project Manager
|Rev2=Rev2
|Rev2Title=Customer Representative
}} 
[[Category:{{#var:Client}} FS]]