FS 311577 Additional Diagnosis Check Fields: Difference between revisions

From Calidus HUB
VisualWikitext
mNo edit summary
(v0.1 - Initial Creation)
Line 6: Line 6:
{{#vardefine:Version|0.1}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|29th August 2013}}
{{#vardefine:Date|29th August 2013}}
{{#vardefine:Reference|311574 309371-11}}
{{#vardefine:Reference|311577 309371-11}}
{{#vardefine:Year|2013}}
{{#vardefine:Year|2013}}
</div>
</div>
Line 27: Line 27:


== Solution Overview  ==
== Solution Overview  ==
New fields will be added to the application to store some generic check-box information. These will be labelled in the product as required by the customer, and available on the "Diagnosis" tab.
* "Revisit",
* "Follow Up"
* "Burner safe for use"


== Scope  ==
== Scope  ==
Line 46: Line 50:
= Functional Description  =
= Functional Description  =
== Database and DAL  ==
== Database and DAL  ==
The EPOD_SERVICE table will be modified to add the following new fields:
* EPL_CHECKBOX_1, a single character text field.
* EPL_CHECKBOX_2, a single character text field.
* EPL_CHECKBOX_3, a single character text field.
Existing packages will be modified to allow the creating, editing and selecting of the new fields, including but not limited to:
*    EPOD_SERVICE_INSERT
*    EPOD_SERVICE_JOB_SEARCH
*    EPOD_SERVICE_JOB_SELECT
*    EPOD_SERVICE_SELECT
*    EPOD_SERVICE_UPDATE
The existing EPOD_SERVICE/SERVICE_JOB DAL object will be changed to:
*    Export the new fields in XML requests
*    Read the new fields
{{Note}} It is not necessary to add this flag as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.


== Server ==
== Server ==
EPOD_JOB_UPDATE Messages received (through the calidus_epod.asmx web service) must save the contents of the EPL_CHECKBOX_1/2/3 fields back to their respective fields on the database, through the modified DAL objects above.


== Admin ==
== Admin ==
The Job Group and Site screens (job_group.aspx and site_header.aspx respectively) will be modified to allow the system to be configured for:
*    Configuration of customer-specific Diagnosis entry:
**        Allow the values N - Disabled, Y - Enabled (SM Fleet), A - Enabled (ALS), L - Enabled (Lanemark). {{Note}} This can use the new LIST features in Admin for these values or can be hard-coded.
The existing Add and Edit pop-ups will be modified to allow these new fields and values. The grid will be modified to show the new values allowed on the Service Report format.
{{Note}} As part of other changes for this customer, the following changes will also be made:
*    Configuration of customer-specific Info entry:
**        Allow the values N - Disabled, Y - Enabled (SM Fleet), A - Enabled (ALS), L - Enabled (Lanemark). {{Note}} This can use the new LIST features in Admin for these values or can be hard-coded.
The Service Details screen (service_detail.aspx) will be modified to:
*    Change labels and remove unwanted items from the Diagnosis section:
**        The Diagnosis field (EPL_DIAGNOSIS_NARRATIVE) is always displayed. However, the label should change to "Comments", SITE/JOB_GROUP EPL_SERVICE_DIAGNOSIS flag is set to L.
**        If the SITE/JOB_GROUP EPL_SERVICE_DIAGNOSIS flag is set to L, the three new check-boxes will be displayed with the labels as follows:
*** EPL_CHECKBOX_1 - "Revisit",
*** EPL_CHECKBOX_2 - "Follow Up"
*** EPL_CHECKBOX_3 - "Burner safe for use"
**        If the SITE/JOB_GROUP EPL_SERVICE_DIAGNOSIS flag is set to L, no other fields will be displayed here.


== Android Client ==
== Android Client ==
New language tags should be added to any strings.xml files in the i18n (multi-lingual) folder, as follows:
* <string name="Revisit">Revisit</string>
* <string name="FollowUp">Follow Up</string>
* <string name="BurnerSafe">Burner safe for use</string>
These should be added to all languages' xml files found under the i18n folder.


The Services screen, Diagnosis tab will be modified to add the three check-boxes as required for the customer. This will be done by adding them after checkboxes for SM Fleet (where vars.PDAJOBGROUP.EPL_SERVICE_DIAGNOSIS=="Y"), and in a similar fashion - they will be added only if vars.PDAJOBGROUP.EPL_SERVICE_DIAGNOSIS=="L".


The checkboxes will be added in the same was as in the code now for CustDamCB.
The labels for these items should be set as a generic text where the variable is created, for example, CheckBox1, Checkbox2, etc. They should also have a unique ID following the standard convention in the rest of the screen, for example "Service_CheckBox1LB".
The style object should have the LANE section modified to set the text against the new checkboxes specifically for the customer, as follows:
* Service_CheckBox1LB/Service_CheckBox1LB_land - property "text" should be set to Ti.App.style.getLabel("Revisit")
* Service_CheckBox2LB/Service_CheckBox1LB_land - property "text" should be set to Ti.App.style.getLabel("FollowUp")
* Service_CheckBox3LB/Service_CheckBox1LB_land - property "text" should be set to Ti.App.style.getLabel("BurnerSafe")
{{Note}} This 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.
Additionally, further functions will be modified to check for the same condition (vars.PDAJOBGROUP.EPL_SERVICE_DIAGNOSIS=="L"), as follows:
* saveService - modified to populate Lanemark-specific fields
* validateService - modified to check for Lanemark-specific fields
{{Note}} The existing code for vars.CustDamCB) must now be made conditional on vars.PDAJOBGROUP.EPL_SERVICE_DIAGNOSIS=="Y" or "A".


<!-- MEDIA LANDSCAPE YES -->  
<!-- MEDIA LANDSCAPE YES -->  
Line 62: Line 123:
|Title={{#var:Doc_Title}}
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Log={{#var:Reference}}
|Description=To test restrictions on vehicle stock
|Description=To test the entry and visibility of the additional check box fields in {{#var:System}}
|MenuAccess=Services
|MenuAccess=Services
|Prerequisites=None
|Prerequisites=None
|Objective=To test that: Service Products are received onto the device with identified Vehicle Stock; Product selections in Services processing are restricted to Vehicle Stock only.
|Objective=To test that: Services configured for Lanemark allow entry of additional checkboxes, labelled as required; existing Services functionality remains unaffected.
}}  
}}  
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin
|Notes=
}} <!--INSERT TESTS HERE --> {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Check Site and Job Group screens, that the Lanemark option can be chosen against 'Diagnosis', saved and edited.
|Result=The value can be selected, EPL_SERVICE_DIAGNOSIS is saved correctly and is editable.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}
{{TestPlan_CycleHeader
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=PDA Services
|Title=PDA Services
|Notes=Ensure that the EPOD_JOB_GROUP flag EPL_SERVICE_DIAGNOSIS is set to "L". Create a service job and assign to a PDA user.
}} <!--INSERT TESTS HERE --> {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Logon to the PDA start a service and move to the Diagnosis tab.
|Result=The only fields available for entry are the three new fields and Diagnosis Narrative. The three new checkboxes are labelled as required.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Set or unset the checkboxes and complete the service.
|Result=The values are saved as Y or N in the EPOD database.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin (post)
|Notes=
|Notes=
}} <!--INSERT TESTS HERE --> {{TestPlan_Test
}} <!--INSERT TESTS HERE --> {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Logon to the PDA with 1 vehicle and check the Service Products sent through.
|Action=Check the Job in Admin Services and Jobs screen, showing the details.
|Result=All Service Products have a Vehicle Qty, and those that are on the vehicle chosen are populated correctly.
|Result=The job should be completed. The details should show only the fields required by the set-up (i.e. the Diagnosis Narrative and the new Check Boxes). They should be labelled correctly.
|Remarks=
|Remarks=
|PassFail=
|PassFail=
}} {{TestPlan_Test
}} {{TestPlan_CycleFooter}}
 
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Regression tests
|Notes=
}} <!--INSERT TESTS HERE --> {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Check the products available on the Products picker in the Services job.
|Action=Set the value of the EPOD_JOB_GROUP flag EPL_SERVICE_DIAGNOSIS is set to other values ("A", "N", "Y"). Repeat the tests above to ensure that the system operated as it should under the other configurations.
|Result=Only those available on the Vehicle are displayed.
|Result=As required by the other configurations.
|Remarks=
|Remarks=
|PassFail=
|PassFail=
Line 103: Line 200:
|FS=0.25
|FS=0.25
|TS=0
|TS=0
|DEV=1.50
|DEV=1.25
|ST=0.25
|ST=0.25
|IMP=0
|IMP=0

Revision as of 16:56, 29 August 2013





Aptean Logo.png







Lanemark

Additional Diagnosis Check Fields

CALIDUS eSERV

29th August 2013 - 0.1
Reference: FS 311577 309371-11











































Functional Overview

Client Requirement

Additional check-boxes will be added for "Revisit", "Follow Up" and "Burner safe for use". These will be prompted for if configured this way from the Admin system.

Solution Overview

New fields will be added to the application to store some generic check-box information. These will be labelled in the product as required by the customer, and available on the "Diagnosis" tab.

  • "Revisit",
  • "Follow Up"
  • "Burner safe for use"

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.


Set-up

Pre-requisites

Menu Structure

Data

Functional Description

Database and DAL

The EPOD_SERVICE table will be modified to add the following new fields:

  • EPL_CHECKBOX_1, a single character text field.
  • EPL_CHECKBOX_2, a single character text field.
  • EPL_CHECKBOX_3, a single character text field.

Existing packages will be modified to allow the creating, editing and selecting of the new fields, including but not limited to:

  • EPOD_SERVICE_INSERT
  • EPOD_SERVICE_JOB_SEARCH
  • EPOD_SERVICE_JOB_SELECT
  • EPOD_SERVICE_SELECT
  • EPOD_SERVICE_UPDATE

The existing EPOD_SERVICE/SERVICE_JOB DAL object will be changed to:

  • Export the new fields in XML requests
  • Read the new fields

Note Note: It is not necessary to add this flag as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

Server

EPOD_JOB_UPDATE Messages received (through the calidus_epod.asmx web service) must save the contents of the EPL_CHECKBOX_1/2/3 fields back to their respective fields on the database, through the modified DAL objects above.

Admin

The Job Group and Site screens (job_group.aspx and site_header.aspx respectively) will be modified to allow the system to be configured for:

  • Configuration of customer-specific Diagnosis entry:
    • Allow the values N - Disabled, Y - Enabled (SM Fleet), A - Enabled (ALS), L - Enabled (Lanemark). Note Note: This can use the new LIST features in Admin for these values or can be hard-coded.

The existing Add and Edit pop-ups will be modified to allow these new fields and values. The grid will be modified to show the new values allowed on the Service Report format.

Note Note: As part of other changes for this customer, the following changes will also be made:

  • Configuration of customer-specific Info entry:
    • Allow the values N - Disabled, Y - Enabled (SM Fleet), A - Enabled (ALS), L - Enabled (Lanemark). Note Note: This can use the new LIST features in Admin for these values or can be hard-coded.

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

  • Change labels and remove unwanted items from the Diagnosis section:
    • The Diagnosis field (EPL_DIAGNOSIS_NARRATIVE) is always displayed. However, the label should change to "Comments", SITE/JOB_GROUP EPL_SERVICE_DIAGNOSIS flag is set to L.
    • If the SITE/JOB_GROUP EPL_SERVICE_DIAGNOSIS flag is set to L, the three new check-boxes will be displayed with the labels as follows:
      • EPL_CHECKBOX_1 - "Revisit",
      • EPL_CHECKBOX_2 - "Follow Up"
      • EPL_CHECKBOX_3 - "Burner safe for use"
    • If the SITE/JOB_GROUP EPL_SERVICE_DIAGNOSIS flag is set to L, no other fields will be displayed here.

Android Client

New language tags should be added to any strings.xml files in the i18n (multi-lingual) folder, as follows:

  • <string name="Revisit">Revisit</string>
  • <string name="FollowUp">Follow Up</string>
  • <string name="BurnerSafe">Burner safe for use</string>

These should be added to all languages' xml files found under the i18n folder.

The Services screen, Diagnosis tab will be modified to add the three check-boxes as required for the customer. This will be done by adding them after checkboxes for SM Fleet (where vars.PDAJOBGROUP.EPL_SERVICE_DIAGNOSIS=="Y"), and in a similar fashion - they will be added only if vars.PDAJOBGROUP.EPL_SERVICE_DIAGNOSIS=="L".

The checkboxes will be added in the same was as in the code now for CustDamCB.

The labels for these items should be set as a generic text where the variable is created, for example, CheckBox1, Checkbox2, etc. They should also have a unique ID following the standard convention in the rest of the screen, for example "Service_CheckBox1LB".

The style object should have the LANE section modified to set the text against the new checkboxes specifically for the customer, as follows:

  • Service_CheckBox1LB/Service_CheckBox1LB_land - property "text" should be set to Ti.App.style.getLabel("Revisit")
  • Service_CheckBox2LB/Service_CheckBox1LB_land - property "text" should be set to Ti.App.style.getLabel("FollowUp")
  • Service_CheckBox3LB/Service_CheckBox1LB_land - property "text" should be set to Ti.App.style.getLabel("BurnerSafe")

Note Note: This 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.

Additionally, further functions will be modified to check for the same condition (vars.PDAJOBGROUP.EPL_SERVICE_DIAGNOSIS=="L"), as follows:

  • saveService - modified to populate Lanemark-specific fields
  • validateService - modified to check for Lanemark-specific fields

Note Note: The existing code for vars.CustDamCB) must now be made conditional on vars.PDAJOBGROUP.EPL_SERVICE_DIAGNOSIS=="Y" or "A".


Appendix A: TEST PLAN

Test Script / Scenario ReferenceAdditional Diagnosis Check FieldsCall Number(s): 311577 309371-11
Test Script / Scenario DescriptionTo test the entry and visibility of the additional check box fields in CALIDUS eSERVPASS / ISSUES / FAIL
Menu AccessServices 
Pre-requisitesNoneTested By:
 
Test ObjectiveTo test that: Services configured for Lanemark allow entry of additional checkboxes, labelled as required; existing Services functionality remains unaffected.Date:
 


Step Action Result Remarks P/F
1 Admin      
       
1.01 Check Site and Job Group screens, that the Lanemark option can be chosen against 'Diagnosis', saved and edited. The value can be selected, EPL_SERVICE_DIAGNOSIS is saved correctly and is editable.    


Step Action Result Remarks P/F
2 PDA Services      
  Ensure that the EPOD_JOB_GROUP flag EPL_SERVICE_DIAGNOSIS is set to "L". Create a service job and assign to a PDA user.      
2.01 Logon to the PDA start a service and move to the Diagnosis tab. The only fields available for entry are the three new fields and Diagnosis Narrative. The three new checkboxes are labelled as required.    
2.02 Set or unset the checkboxes and complete the service. The values are saved as Y or N in the EPOD database.    


Step Action Result Remarks P/F
3 Admin (post)      
       
3.01 Check the Job in Admin Services and Jobs screen, showing the details. The job should be completed. The details should show only the fields required by the set-up (i.e. the Diagnosis Narrative and the new Check Boxes). They should be labelled correctly.    


Step Action Result Remarks P/F
4 Regression tests      
       
4.01 Set the value of the EPOD_JOB_GROUP flag EPL_SERVICE_DIAGNOSIS is set to other values ("A", "N", "Y"). Repeat the tests above to ensure that the system operated as it should under the other configurations. As required by the other configurations.    


Appendix B: 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.25 0 £0.00
Technical Specification 0.00 0 £0.00
Development 1.25 0 £0.00
Testing and Release 0.25 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.

B.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


B.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.


B.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_311577_Additional_Diagnosis_Check_Fields&oldid=1178’