FS 311753 New Info Tab Fields

From Calidus HUB
Revision as of 17:18, 5 September 2013 by Anw (talk | contribs) (v0.1 - Initial Creation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)





Aptean Logo.png







Lanemark

New Info Tab Fields

CALIDUS eSERV

5th September 2013 - 0.1
Reference: FS 311753 309371-3











































Functional Overview

Client Requirement

Info will show:

  • Range - Service Group - drop-down list entry of:
    • TX/TRX/MTX
    • DB
    • FD/FDB
    • Non-Lanemark
  • Model - text entry
  • S/No - text entry
  • Lanemark Service Item Number - Service ID. Entered by Admin, displayed here.
  • Application - User-defined Field.
  • Location On Site - User-defined Field.
  • Reason For Site Visit - Service Type

Solution Overview

Configuration within Admin will control what fields are to be entered in the Info tab of the Services process through:

  • A new "Lanemark" configuration against the Info tab
  • A UDF configuration against the Info tab

Both of these will be maintained at Job Group and Site level.

The Admin PDA Services process will be modified to allow entry of these new fields and to validate them.

Scope

  • These changes will be made in the latest version of the CALIDUS eSERV product only.
  • The changes will be made to the Android eSERV client only.
  • Warning Warning: This change requires that the UDF modifications are complete first - see Appendix C for details.


Set-up

Pre-requisites

Menu Structure

Data

Table EPOD_UDF_CONFIG must have new records created for the product groups:

  • EPL_DESCRIPTION = "DB Product Group Info Fields"
  • EPL_DESCRIPTION = "TX/TRX/MTX Product Group Info Fields"
    • EPL_KEY_TYPE = "P"
    • EPL_KEY_VAL = "{EPL_SITE_ID}|TX/TRX/MTX"
    • EPL_CONFIG_TYPE = "INFO"
    • EPL_UDF_FIELDS - see Appendix B: INFO UDF FILE
  • EPL_DESCRIPTION = "FD/FDB Product Group Info Fields"
    • EPL_KEY_TYPE = "P"
    • EPL_KEY_VAL = "{EPL_SITE_ID}|FD/FDB"
    • EPL_CONFIG_TYPE = "INFO"
    • EPL_UDF_FIELDS - see Appendix B: INFO UDF FILE

Note Note: There is a fourth, generic Lanemark setting yet to be confirmed, which will require another UDF configuration record to be set up.

Functional Description

Database and DAL

The table EPOD_SERVICE will be modified as follows:

  • Existing field EPL_VIN_NUMBER will become EPL_CODE_1.
  • Existing field EPL_REG_NUMBER will become EPL_CODE_2 and will extend to 50 characters in length.
  • Existing field EPL_SIM_NUMBER will become EPL_CODE_3.

All references to these EPOD_SERVICE fields in the following projects and areas will be changed for the new field names:

  • All XSDs
  • All .NET projects
  • All database packages.

Server

All XSDs within the Server will be modified to remove any value restriction from EPL_SERVICE_TYPE. These include but are not limited to:

  • EPOD_EXPORT_JOB.XSD
  • EPOD_EXPORT_JOB_RESPONSE.XSD
  • EPOD_EXPORT_LOAD.XSD
  • EPOD_EXPORT_LOAD_RESPONSE.XSD
  • XMLUpload.XSD

Admin

The Info and Diagnosis drop-down lists will be modified to allow the user to choose a new value of "Enabled (Lanemark)", value "L". This will apply to the Job Group (job_group.aspx) and Site (site_header.aspx) maintenance screens.

Note Note: If these drop-down lists have not already been modified to allow configurable data items on the list, this change should be made now.

Note Note: Although it is only necessary to change one of DDLs at this time, the full requirements from the client need both to be changed. These may already have been changed under another change - see Appendix C for details.

The Job and Service Screens will require modification when creating a new job. Those screens affected are:

  • ConfigurableJob.aspx
  • job_details.aspx
  • service_job.aspx

When creating or editing a new Service job, different fields will be prompted for, depending on the new Info configuration (EPL_SERVICE_INFO):

Service Type will be modified to offer a selection of different types, as follows:

  • C-Commissioning
  • S-Service
  • SU-Survey
  • B-Breakdown
  • O-Other

These will be controlled by changing the Service Type DDL to accept data from the configurable data items.

The following fields will also be prompted for, if EPL_SERVICE_INFO = "L":

  • EPL_SERVICE_GROUP - labelled as "Range"
  • EPL_CODE_1 (formerly EPL_VIN_NUMBER) - labelled as "Serial No"
  • EPL_SYSTEM_TYPE - labelled as "Model".

The Services screen (service_job.aspx) will be modified so that the label against VIN number when entering search criteria is "Serial No", if EPL_SERVICE_INFO = "L".

The Service Details screen (service_detail.aspx) will be modified as follows:

  • Service Details:
    • Service Type will be looked up from variable data rather than fixed.
  • Information section:
    • EPL_SERVICE_GROUP - labelled as "Range"
    • EPL_SYSTEM_TYPE - labelled as "Model".
    • EPL_CODE_1 (formerly EPL_VIN_NUMBER) - labelled as "Serial No"
    • A translation of each of the User-defined fields from within EPL_UDF_INFO. The extraction of these fields will be similar to the extraction of T&Cs for reports, whereby the screen will iterate through the contained XML and create fields in this section. See TDLPOD.aspx.cs.generateFooter() for an example. The format of the fields will be similar to those already on this Service Details screen.

Android Client

Note Note: A Lanemark-specific Style change should already have been made under change FS_311581_Diagnosis_Narrative_Extended_Length - if this has not been completed, please check this specification for details.

The table EPOD_SERVICE will be modified as follows:

  • Existing field EPL_VIN_NUMBER will become EPL_CODE_1.
  • Existing field EPL_REG_NUMBER will become EPL_CODE_2 and will extend to 50 characters in length.
  • Existing field EPL_SIM_NUMBER will become EPL_CODE_3.

All code that references these fields in all modules will be globally replaced.

If PDA_JOB_GROUP.EPL_SERVICE_INFO = "L", the following fields will be made available for editing on the Info tab of SM_Service.js:

  • EPL_SERVICE_GROUP - labelled as "Range" for the Lanemark style, and "Group" for others.
  • EPL_SYSTEM_TYPE - Labelled as "Model" for the all (except where other styles apply).
  • EPL_VIN_NUMBER - Labelled as "Serial No" for the Lanemark style, and "VIN Number" for others.
  • EPL_SERVICE_TYPE - Labelled as "Reason for Site Visit" for the Lanemark style, and "Service Type" for others.

Note Note: The existing UDF developments should also create a scrolling view for the user-defined information - see Appendix C for details. Section Appendix B: INFO UDF FILE shows the configurations that must be made at Product Group level for the correct fields to be entered.

SM_Service.validateService() will be modified to check that the above listed fields have been entered and that the entries are valid, if PDA_JOB_GROUP.EPL_SERVICE_INFO = "L".

SM_Service.saveService() will be modified to save the above listed fields to the Services job, if PDA_JOB_GROUP.EPL_SERVICE_INFO = "L".


Appendix A: TEST PLAN

Test Script / Scenario ReferenceNew Info Tab FieldsCall Number(s): 311753 309371-3
Test Script / Scenario DescriptionTo test the entry of new Info fields in the Service process.PASS / ISSUES / FAIL
Menu AccessServices 
Pre-requisitesThe Services module must be configured for Info fields in the Lanemark style, and configurable fields are set up for each of the available product groups.Tested By:
 
Test ObjectiveTo test that: Services can be created and edited with the new fields configured; the Services process requests the correct fields, labelled correctly; the system is updated correctly when a Service is completed and; services can be viewed correctly.Date:
 


Step Action Result Remarks P/F
1 Admin      
       
1.01 Create a new Service Job using the Jobs, Configurable Jobs and Service Jobs screen The screen should prompt for the correct items, validate them correctly, offer the correct options and save correctly.    
1.02 Find a Service Job through the Services screen using Serial No.    
1.03 Edit an existing Service Job using the Jobs, Configurable Jobs and Service Jobs screen The screen should prompt for the correct items, validate them correctly, offer the correct options and save correctly.    
1.04 View the details of a completed service Note Note: Do this after the PDA tests following. The New Key and Configurable fields are displayed on the screen, with the correct labels.    


Step Action Result Remarks P/F
2 PDA      
       
2.01 Start a Service Job and click on the Info tab. The correct Key and Configurable fields are displayed for entry.    
2.02 Change the Range. The screen should refresh to display the correct Configurable fields for the Product Group selected.    
2.03 Do not enter any data - just click Done on the diagnosis screen. Validation errors should be displayed, forcing the user to enter the correct data.    
2.04 Correct any errors, complete any required entry on other tabs and click Done. The unit should prompt for Signature Entry.    
2.05 Complete the Service Job. All data should be updated and passed back to the server, where it should be stored in the correct fields.    


Appendix B: INFO UDF FILES

Note Note: There is a fourth, generic Lanemark setting yet to be confirmed, which will require a different UDF configuration.

DB Range

<FORM NAME="INFO UDF FILE" REQUIRED="Y">
   <FIELD ID="0001">
       <TEXT>Application</TEXT>
       <FORMAT>DDL</FORMAT>
       <SKIPABLE>N</SKIPABLE>
       <ITEMS>
           <ITEM CODE="Spray Booth">Spray Booth</ITEM>
           <ITEM CODE="Low Bake">Low Bake</ITEM>
           <ITEM CODE="Dryer">Dryer</ITEM>
       </ITEMS>
   </FIELD>
   <FIELD ID="0002">
       <TEXT>Location on Site</TEXT>
       <FORMAT>T</FORMAT>
       <SKIPABLE>N</SKIPABLE>
   </FIELD>
</FORM>

==TX/TRX/MTX Ranges==
<FORM NAME="INFO UDF FILE" REQUIRED="Y">
   <FIELD ID="0001">
       <TEXT>Application</TEXT>
       <FORMAT>DDL</FORMAT>
       <SKIPABLE>N</SKIPABLE>
       <ITEMS>
           <ITEM CODE="Tray Washer">Tray Washer</ITEM>
           <ITEM CODE="Micro Brewery">Micro Brewery</ITEM>
           <ITEM CODE="Process Tank">Process Tank</ITEM>
       </ITEMS>
   </FIELD>
   <FIELD ID="0002">
       <TEXT>Location on Site</TEXT>
       <FORMAT>T</FORMAT>
       <SKIPABLE>N</SKIPABLE>
   </FIELD>
</FORM>

FD/FDB Ranges

<FORM NAME="INFO UDF FILE" REQUIRED="Y">
   <FIELD ID="0001">
       <TEXT>Application</TEXT>
       <FORMAT>DDL</FORMAT>
       <SKIPABLE>N</SKIPABLE>
       <ITEMS>
           <ITEM CODE="Drying Oven">Drying Oven</ITEM>
           <ITEM CODE="Curing Oven">Curing Oven</ITEM>
           <ITEM CODE="Rotamoulding">Rotamoulding</ITEM>
       </ITEMS>
   </FIELD>
   <FIELD ID="0002">
       <TEXT>Location on Site</TEXT>
       <FORMAT>T</FORMAT>
       <SKIPABLE>N</SKIPABLE>
   </FIELD>
</FORM>


Appendix C: Quote & Document References

Cost Details
Activity No. of Days Rate per Day (£) Cost (£ Exc. VAT)
Requirements 0.00 0 £0.00
Change Request Evaluation 0.00 0 £0.00
Functional Specification 0.50 0 £0.00
Technical Specification 0.00 0 £0.00
Development 2.75 0 £0.00
Testing and Release 0.50 0 £0.00
Implementation 0.00 0 £0.00
Project Management First argument to "number_format" must be a number. 0 £First argument to "number_format" must be a number.
 
TOTAL First argument to "number_format" must be a number.   £First argument to "number_format" must be a number.
Estimate excludes training, release to live and go live support.

C.1 References

Ref NoDocument Title & IDVersionDate
1UG 291094 EPOD Admin User Guide2.04/4/2012
2UG 291097 EPOD Client User Guide3.023/4/2013
3REQ_309371_Lanemark_eSERV_Requirements0.429/08/2013
4FS_311636_UDF_Modifications0.305/09/2013
5FS_311577_Additional_Diagnosis_Check_Fields0.129/08/2013


C.2 Glossary

Term Definition
EPOD Electronic Proof of Delivery. The OBS EPOD system is CALIDUS ePOD.
CALIDUS eSERV The OBS mobile system to complete Service functionality in the field. This is part of the CALIDUS ePOD system.
PDA The mobile device on which the C-ePOD system will run in the field. This can be a Phone, EDA or industrial PDA, running Android.
DAL Data Access Layer. A mechanism for accessing data by the system that is removed from the application, allowing for simplified access and providing protection to the data, as only approved DAL methods can be used to modify it.
GPS Global Positioning System. A mechanism of retrieving accurate positioning information in the form of Latitude and Longitude (Lat-Long) co-ordinates from a device.
GPRS, 3G, HSDPA, Data Service All terms referring to mobile device network connectivity, and the speed at which the device connects to the internet.


C.3 Authorised By


Julie Taylor
OBS Project Manager		_____________________________

Jeff Foster
Client Representative		_____________________________

Alan Thompson
Client Representative		_____________________________
Retrieved from ‘https://calidusassist.adcservices.apteancloud.com/calidus-assist/OBS/index.php?title=FS_311753_New_Info_Tab_Fields&oldid=1190’