View source for FS 315080 AUNZ-027 LFS Vehicle Checks Export

<div class="noprint">
{{#vardefine:Client|LFS}}
{{#vardefine:ClientName|LFS}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|LFS Vehicle Checks Export}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|24th February 2014}}
{{#vardefine:Reference|315080 AUNZ-027}}
{{#vardefine:Year|2014}}
</div>
{{Doc_Title
|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  ==
As part of the PDA’s configuration, drivers can be prompted to enter a number of mandatory and optional vehicle checks. These checks can be set on the frequency that the operation requires; for example, every 24 hours or weekly. It has been determined that the LFS drivers must perform a vehicle check once a day. These questions are fully configurable by system administrators within the EPOD admin system and include a combination of Check Box, Free Text, Boolean (Yes/No) and Number entry answers. 

The driver must not be allowed to postpone the vehicle checks they must be performed

A new export will be created to extract all vehicle check data based on a date range, driver and or vehicle. This will be in csv format.


== Solution Overview ==
As part of the PDA’s configuration, drivers can be prompted to enter a number of mandatory and optional vehicle checks. These checks can be set on the frequency that the operation requires; for example, every 24 hours or weekly. It has been determined that the LFS drivers must perform a vehicle check once a day. These questions are fully configurable by system administrators within the EPOD admin system and include a combination of Check Box, Free Text, Boolean (Yes/No) and Number entry answers.

The existing Vehicle Checks screen (accessible from the {{#var:System}} Admin system through ''Administration/Vehicle Checks Responses'' menu item) allows users to enter search criteria to find completed vehicle checks, as follows:
* Vehicle ID - optionally, the vehicle checked can be selected.
* User ID - optionally, the driver who performed the checks can be selected.
* Date From/To - a date range must always be entered, and will default to a one month period back from the current date. 
Once the criteria has been entered, the user can either:
* '''Cancel''' - Do not perform the search.
* '''Search''' - Perform the search and display the results in a grid below.
* '''Extract to CSV''' - Perform the search and generate a CSV. 

If extracting to CSV, the system will attempt to open the generated file automatically for the user. Depending on general browser type, settings and installed software, the file may open directly in the browser window, or through an external program, typically Microsoft Excel. However the file is opened, it may be saved locally at that time.

The CSV data will include the following and have the following restrictions: 
* Fields included:
**	Date/Time - the date and time the check took place, in YYYYMMDD and HHMM formats respectively
**	Driver - Driver ID and Driver Name
**	Vehicle - Vehicle ID and Vehicle Name
**	Site - Site ID only
**	All the questions and answers that were responded to by the driver will be added to the end of the CSV, in sequence, 2 columns for each (question text, followed by driver's response).
*	All CSV data will be quote-encapsulated.


== Scope ==
* This functionality will be developed in the latest version of {{#var:System}} only.


<!-- NEW PAGE --> 
= Set-up  =

== Pre-requisites  ==
* A working {{#var:System}} system.


== Menu Structure  ==
None


== Data  ==
None


<!-- NEW PAGE --> 
= Functional Description  =
== Admin Changes ==
The existing Vehicle Checks screen Vehicle_check_response.aspx (accessible from the {{#var:System}} Admin system through ''Administration/Vehicle Checks Responses'' menu item) allows users to enter search criteria to find completed vehicle checks. 

[[file:FS_315080_Admin_Vehicle_Checks.PNG|border|600px]]


This criteria entry validation will be modified as follows:
* Vehicle ID - optionally entered
* User ID - optionally entered
* Date From/To - a date range must always be entered, and will default to a one month period back from the current date.

A new button will be added to the Search Criteria section:
* '''Extract to CSV'''
This button will perform the search as per the standard '''Search''' button, but will extract this to a CSV file rather than display the results in the grid. 

The process will retrieve all the data through the standard DAL objects (along with any descriptions required for Vehicles and Users).

When retrieved, the resulting data should be exported directly back to the browser, setting various HTTP headers as follows:
* ContentType = "text/csv"
* Content-Disposition - "attachment;filename=export.csv"

The CSV data will include the following and have the following restrictions: 
* Fields included:
**	Date/Time - EPL_VEHICLE_CHECK_DATE and EPL_VEHICLE_CHECK_TIME
**	Driver - EPL_USER_ID and EPOD_USER.EPL_USER_NAME
**	Vehicle - EPL_VEHICLE_ID and EPOD_VEHICLE.EPL_VEHICLE_REG
**	Site - EPL_SITE_ID
**	All the questions and answers that were responded to by the driver will be added to the end of the CSV, in sequence, 2 columns for each (question text, followed by driver's response). This will be extracted from the XML content of EPL_VEHICLE_CHECK_DATA - examples below.
*	All CSV data will be quote-encapsulated.
{{Note}} All fields are sourced from EPOD_VEHICLE_CHECK, unless otherwise specified.

For example, if the data for a single vehicle check is as follows:
:EPL_SITE_ID:TEST       
:EPL_VEHICLE_ID:ADM      
:EPL_VEHICLE_CHECK_DATE:20130821             
:EPL_VEHICLE_CHECK_TIME:13220000             
:EPL_USER_ID:nhill        
:EPL_VEHICLE_CHECK_DATA: <EPL_SITE_ID>TEST</EPL_SITE_ID>    <EPL_VEHICLE_ID>ADM</EPL_VEHICLE_ID>    <EPL_USER_ID>nhill</EPL_USER_ID>    <DATE_TIME>2013-08-21T13:22:38</DATE_TIME>    <VEHICLE_CHECK>      <QUESTION ID="001">        <TEXT>Please enter your trailer number</TEXT>        <FORMAT>T</FORMAT>        <SKIPABLE>N</SKIPABLE>        <ANSWER>123</ANSWER>      </QUESTION>      <QUESTION ID="002">        <TEXT>Please check the following items:</TEXT>        <FORMAT>X</FORMAT>        <SKIPABLE>N</SKIPABLE>        <ITEMS>          <ITEM ANSWER="Y">Oil Level</ITEM>          <ITEM ANSWER="Y">Tyres</ITEM>          <ITEM ANSWER="Y">Brakes</ITEM>          <ITEM ANSWER="Y">Water</ITEM>          <ITEM ANSWER="Y">Lights</ITEM>        </ITEMS>      </QUESTION>      <QUESTION ID="003">        <TEXT>Please enter any comments</TEXT>        <FORMAT>T</FORMAT>        <SKIPABLE>Y</SKIPABLE>        <ANSWER></ANSWER>      </QUESTION>      <QUESTION ID="004">        <TEXT>What is the current Mileage?</TEXT>        <FORMAT>N</FORMAT>        <SKIPABLE>N</SKIPABLE>        <ANSWER>123</ANSWER>      </QUESTION>    </VEHICLE_CHECK>    <REQUEST_TIME_DATE>2013-08-21T13:22:38</REQUEST_TIME_DATE>

The resulting CSV would look like this:
:"TEST", "ADM", "ADM 12BC", "20130821", "1322", "nhill", "Nick Hill", "Please enter your trailer number", "123", "Oil Level", "Y", "Tyres", "Y", "Brakes", "Y", "Water", "Y", "Lights", "Y", "Please enter any comments", "", "What is the current Mileage?","123"


If extracting to CSV, the system will attempt to open the generated file automatically for the user. Depending on general browser type, settings and installed software, the file may open directly in the browser window, or through an external program, typically Microsoft Excel. However the file is opened, it may be saved locally at that time.


<!--
 MEDIA LANDSCAPE YES
= Appendix A: TEST PLAN  =

{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Test the ...
|MenuAccess=None
|Prerequisites=None
|Objective=To test that: ...
}} 
{{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Test Title
|Notes=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Do something
|Result=Some expected results
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}} 

MEDIA LANDSCAPE NO
--> 
<!-- NEW PAGE --> 
{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=
|RefV1=
|RefDate1=
|REQ=0
|EST=0
|FS=0.5
|TS=0
|DEV=2.5
|ST=0.25
|IMP=0.25
|EREQ=0
|EEST=0
|EFS=0
|ETS=0
|EDEV=0
|ESTT=0
|EIMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=Y
|Rev1=Matt Tipping
|Rev1Title=Project Manager
|Rev2Title=Client Representative
}}</div> 
[[Category:{{#var:Client}} FS]]