Anw: v0.1 - Initial Creation

2013-12-03T14:22:22Z

v0.1 - Initial Creation

New page

<div class="noprint">
{{#vardefine:Client|BAG}}
{{#vardefine:ClientName|BIU Group}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|BIU POC Report Format}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|2nd December 2013}}
{{#vardefine:Reference|313969 312018-8}}
{{#vardefine:Year|2013}}
</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}}
}}


<div class="noprint">
= Functional Overview =

== Client Requirement ==
'''Log in:'''

Username as standard

Password will be 4 digit Numeric

'''Job Type 2 - Planned Collection then enter weighbridge ticket information from on-board weigh system'''
* As above, job type 1, but at the end of collection before signature, the user must enter weighbridge ticket no and weight.
* Driver and Customer signatures are required
* Proof of Collection paperwork created for these deliveries.
Example load - 20 Collections or a mixed load with Job type 1

== Solution Overview ==
The device client will be modified to allow a new customer style, which will ensure that the password entered is numeric only, as this is required by the customer.

When collections are completed, some job types will require a POC document be provided to the customers.

This format will be configurable against the Job Group for the individual job types. It is not necessary (but is recommended) that a POC and POD format is set against all Job types, even if they are not to be automatically emailed to the customers on completion of the job. Other job types and the deliveries can use a standard format.

{{Note}} The POC document format is being redesigned by the customer and will be provided at a later date. It has been confirmed that the redesign will not add any further entry fields to the process.

It has since been confirmed that the following elements are required:
* Collection No - A depot code, followed by the Job ID, delimited by forward slash (/).
* Date - Actual End Date
* BIU Vehicle Reg. No - Driver's Vehicle Registration
* Site - Customer's Name and Address
* No. of banks serviced - As entered
* Bags/Sacks/Boxes - As entered
* Weight - as entered
* Weighbridge ticket no. - as entered
* Authorisation
** BIU Group Signature - Driver Signature
** Name - Driver Name
** Signed on behalf of Site - Customer Signature
** Name - Signatory
{{Note}} Best efforts will be made to match the produced format to the sample provided, but differences in production and presentation (i.e. Browser, Email, etc) may result in some small differences. Specifically, the signatures will require more space than allowed in the current sample.

== Scope ==
* These changes will be made in the latest version of the {{#var:System}} product only.
* The changes are dependent on a specific job group being configured to use the BIU POC format. This is dependent on the Job Group passed to the system on the job.
* The Depot portion of the Collection No is dependant on this data being passed to {{#var:System}} in the field EPL_EXTERNAL_REF.
* {{Warning}} The design below is heavily on the Job Details UDF change, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. It is also somewhat dependent on the configuration of the assumes UDF fields, in that the users will enter a weight and weighbridge number for each job before signature. If it is necessary to instead capture this information when returning to base (i.e. through a Load Metric), then this report will have to be modified to account for this.


= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==


= Functional Description =
== 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 the new BIU Service report, by adding this as an option to the DDLs in the editing pop-up forms. Additionally, the grid will be modified to display this correctly if selected.

== POC Report Format ==
A new POC report format will be created, based on some of the techniques in the existing report Lanemark.aspx, specifically the use of UDF fields. The report will be called BIU.aspx.

It has been confirmed that the following elements are required. They will be mapped as follows:
* Collection No - A depot code, followed by the Job ID, delimited by forward slash (/). EPL_EXT_REF and EPL_JOB_ID (generated)
* Date - Actual End Date - EPL_END_ACTUAL_DATE
* BIU Vehicle Reg. No - Driver's Vehicle Registration - EPOD_VEHICLE.EPL_VEHICLE_REG
* Site - Customer's Name and Address - From EPOD_JOB_ADDRESS if exists, otherwise EPOD_CUSTOMER:
** EPL_CUSTOMER_CODE
** EPL_CUSTOMER_NAME
** EPL_ADDRESS_1
** EPL_ADDRESS_2
** EPL_ADDRESS_3
** EPL_POSTCODE
* No. of banks serviced - EPL_UDF_JOB.NUM_BANKS
* Bags/Sacks/Boxes - EPL_UDF_JOB.BANK_QTY
* Weight - EPL_UDF_JOB.WEIGHBRIDGE_WEIGHT
* Weighbridge ticket no. - EPL_UDF_JOB.WEIGHBRIDGE_TICKET
* Authorisation
** BIU Group Signature - Driver Signature - EPL_ENG_SIGNATURE
** Name - Driver Name - EPOD_USER.EPL_USER_NAME
** Signed on behalf of Site - Customer Signature - EPL_JOB_SIGNATURE
** Name - Signatory - EPL_CUST_SIGNATORY
{{Note}} Best efforts will be made to match the produced format to the sample provided, but differences in production and presentation (i.e. Browser, Email, etc) may result in some small differences. Specifically, the signatures will require more space than allowed in the current sample.

The Logo should be populated from the Site Logo.

The page footing should be populated from the Site Customer record (i.e. an EPOD_CUSTOMER record with EPOD_CUSTOMER_CODE = EPL_SITE_ID) as follows:
* "Bag It Up Ltd" - EPL_CUSTOMER_NAME
* "Calder Street" - EPL_ADDRESS_1
* "West Vale" - EPL_ADDRESS_2
* "Greetland" - EPL_ADDRESS_3
* "Halifax" - EPL_ADDRESS_4
* "HX4 8AQ" - EPL_POST_CODE
* "01422 418618" - EPL_TELEPHONE
* "info@bagitup.org.uk" - EPL_EMAIL
* "www.biugroup.co.uk" - EPL_CONTACT
All other elements shall be fixed text at this time.

In the Service Details section, 1 row will be added to the table per FIELD tag in the FORM tag in the Job Details UDF field EPL_UDF_JOB. The format of the fields will be as follows:
* Each row will be 100% width, with a solid border.
* Each DDL, Boolean, Numeric or Text FIELD will result in the LABEL being displayed (with a trailing colon, if one is not already in the text) in the first cell, followed by the user-entered data (VALUE) in a second cell.
* Each Option will result in the tale row being populated with the the LABEL being displayed (with a trailing colon, if one is not already in the text) in the first cell, followed by a table of each ITEM, up to a maximum of three columns, displayed vertically, in the second cell.


{{Note}} This whole table should not be displayed if there is no Job UDF data.

The Job Details UDF configuration for jobs of this type is expected to be as follows:
<FORM NAME="Job Details" REQUIRED="Y">
<FIELD ID="NUM_BANKS">
<TEXT>No. of Banks:</TEXT>
<FORMAT>N</FORMAT>
<REQUIRED>Y</REQUIRED>
</FIELD>
<FIELD ID="BANK_QTY">
<TEXT>Bags/Sacks/Boxes:</TEXT>
<FORMAT>N</FORMAT>
<REQUIRED>Y</REQUIRED>
</FIELD>
<FIELD ID="WEIGHBRIDGE_WEIGHT">
<TEXT>Weight</TEXT>
<FORMAT>N</FORMAT>
<REQUIRED>N</REQUIRED>
</FIELD>
<FIELD ID="WEIGHBRIDGE_TICKET">
<TEXT>Weighbridge Number</TEXT>
<FORMAT>T</FORMAT>
<REQUIRED>N</REQUIRED>
</FIELD>
</FORM>

{{Note}} The ID of the fields in these configurations are intended to make it easier for the host systems to extract data when the data is exported. Given that, it is likely that the customer will request for the ID of these fields to be changed slightly to aid in this.


The following is the sample report sent to the client for confirmation:

[[File:FS_313969_POC.PNG|border|600px]]<br />
BIU POC Report<br />

This prototype is available to be used as a basis for the development shown above.

== PDA ==
The PDA Preferences will be modified to allow the user to select a new style "BIU", labelled as "Bag It Up".

This style will be added to the bespoke style configuration in style.js (Ti.App.style.configItems) as object BIU. This will define the logo to be the BIU logo provided, and to ensure that the keyboard used for the password prompt is numeric only, and only 4 characters are allowed as the maximum length.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=To show that the POC Report is in the correct format.
|MenuAccess=None
|Prerequisites=Job Details UDF configuration, as per change 313974, referenced in [[#Appendix B: Quote & Document References|Appendix B]].
|Objective=To test that: The format is correct and; the format modifies based on the data on the job.
}}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin - Configuration
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=In the Site maintenance screen, edit the site and set the POC to BIU. Save.
|Result=The value is available in the drop-down list for the POC. The value is saved and displayed in the grid.
|Remarks=|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=In the Job Group maintenance screen, edit a Job Group and set the POC to BIU. Save.
|Result=The value is available in the drop-down list for the POC. The value is saved and displayed in the grid.
|Remarks=|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add a new Job Group and set the POC to BIU. Save.
|Result=The value is available in the drop-down list for the POC. The value is saved and displayed in the grid.
|Remarks=|PassFail=
}} {{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin - Report Format
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Find a completed collection with no Job UDF information. Run the report.
|Result=The report should be in the correct format. The Service Details section should not be visible.
|Remarks=|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Find a completed Type 2 collection with Job UDF information. Run the report.
|Result=The report should be in the correct format. The Service Details section be populated with Weight and Weighbridge information only.
|Remarks=|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Find a completed Type 4 collection with Job UDF information. Run the report.
|Result=The report should be in the correct format. The Service Details section be fully populated.
|Remarks=|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[http://172.198.45.54/calidus-assist/OBS/index.php/UG_291094_EPOD_Admin_User_Guide UG 291094 EPOD Admin User Guide]
|RefV1=2.0
|RefDate1=4/4/2012
|Ref2=[http://172.198.45.54/calidus-assist/OBS/index.php/UG_291097_EPOD_Client_User_Guide UG 291097 EPOD Client User Guide
|RefV2=3.0
|RefDate2=23/4/2013
|Ref3=[[REQ 312018 Bag It Up EPOD Requirements]]
|RefV3=0.3
|RefDate3=01/10/2013
|Ref4=[[FS 313974 Job Details UDF]]
|RefV4=0.1
|RefDate4=03/12/2013
|REQ=0
|EST=0
|FS=0.5
|TS=0
|DEV=2.5
|ST=0.25
|IMP=0
|FOC=Y
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=N
|Rev1=Barry Preece
|Rev1Title=OBS Project Manager
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 313969 BIU POC Report Format - Revision history

Anw: v0.1 - Initial Creation