Anw: v1.0 - Release after review

2019-01-31T13:39:17Z

v1.0 - Release after review

← Older revision		Revision as of 15:39, 31 January 2019
Line 4:		Line 4:
	{{#vardefine:System\|''CALIDUS'' ePOD}}		{{#vardefine:System\|''CALIDUS'' ePOD}}
	{{#vardefine:Doc_Title\|MLP Delvice Changes}}		{{#vardefine:Doc_Title\|MLP Delvice Changes}}
	{{#vardefine:Version\|0.1}}		{{#vardefine:Version\|1.0}}
	{{#vardefine:Date\|18th January 2019}}		{{#vardefine:Date\|18th January 2019}}
	{{#vardefine:Reference\|355160}}		{{#vardefine:Reference\|355160}}

Anw: v0.1 - Initial Draft

2019-01-18T09:08:23Z

v0.1 - Initial Draft

New page

<div class="noprint">
{{#vardefine:Client|MARS}}
{{#vardefine:ClientName|Marshalls Stone}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|MLP Delvice Changes}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|18th January 2019}}
{{#vardefine:Reference|355160}}
{{#vardefine:Year|2019}}
</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 ==
Changes are to the MLP device styling only.
* No pagination on styling of products list.
* Switch Long Description and Description on products list
* Product Quantity entry to split Packs and Loose to separate lines for actual quantity, plus UOM on second line. Planned quantity to remain the same layout.

== Solution Overview ==
The product list defaults to 10 items per page. The style for MLP devices ('MAR-LAND') will be modified so that this has no pages. There will be no pagination buttons and all products will be shown on the list.

{{Note}} This may result in a slight delay when first showing the products tab on a collection or delivery, where that job has many products.

The product list has been styled to show the product description. As this is switching places with the data coming in to ''CALIDUS'' ePOD, the product list itself must be changed to display the log description rather than description of the product.

{{Note}} The mobile device user will still be able to view both descriptions, by long-pressing against the product line and choosing ''Info''.

The Product Quantity entry screen (called when changing product quantity or entering comments) will be modified to split Packs and Loose Items to separate lines for actual quantity, plus UOM on second line.

For example:
Original Quantity: CCCCC /
UUUUU UOM
New Quantity: CCCCC / UUUUU

{{Note}} Planned quantity will not be affected by this change.

To achieve this, the UOM field will be added to the display, hidden by default. The MLP style will be modified to show this field, and also to explicitly move the loose quantity to a new line, pushing all other fields down.

== Scope ==
This change will be made to the latest version of {{#var:System}}.


= Set-up =
== Pre-requisites ==
N/A

== Menu Structure ==
N/A

== Data ==
N/A


== Functional Description ==
=== PDA Style ===
The style for MLP devices ('MAR-LAND') will be modified to achieve the changes required.

Pagination will be removed from the products list.

{{DevNotes|This will be achieved by adding the following to the 'MAR-LAND' PDA Style:
"ColDel_lvProductList": {
"intPageSize": 0
},
}}

Long Description will be used instead of Description on the Products list.

{{DevNotes|This will be achieved by changing the 'MAR-LAND' PDA Style for the product list from:
"ProdList_Items": [
"lblProductID",
"lblPackSize",
"lblProductUnitType",
"lblProductPlannedQty",
"lblProductDesc"
],
to this:
"ProdList_Items": [
"lblProductID",
"lblPackSize",
"lblProductUnitType",
"lblProductPlannedQty",
"lblLongDesc"
],
"ProdList_lblLongDesc": {
"width": "98%",
"left": "1%",
"color": "#000000",
"font": {
"fontSize": "16 * Ti.App.resMod"
}
},
}}

The Product Quantity entry screen (called when changing product quantity or entering comments) will be modified to split Packs and Loose Items to separate lines for actual quantity, plus UOM on second line.

The original layout in the quantity change section is as follows:
Original Quantity CCCCC / UUUUU
New Quantity CCCCC /
UUUUU UOM

{{Note}} Planned quantity fields layout will not be affected by this change.

The new layout for MLP will be as follows:
Original Quantity CCCCC / UUUUU
Packs CCCCC
Loose Items UUUUU UOM

{{Note}} For Change Quantity exceptions, the screen will display following this layout. For Product Comment/Clausing, the layout will move the "Original Quantity" values to the view on the left.

{{DevNotes|To achieve this, the UOM field will be added to the display, hidden by default.

The MLP style will be modified to show this field, and also to explicitly move the loose quantity to a new line, pushing all other fields down.

The separator used ("/") will be changed to be a stylable item, with the slash as a default value.

The MLP style will override this label with the value "Loose". The width of the item will be such that it is moved to the line below.

The "New Quantity" label ("newQty") will be translated to "Packs" for the MLP PDA style.
}}

== Exception Process ==
The Product exception processes above must also be modified to show the product long description rather than the product description, as it does now.
This requires the elements of the view to be configurable through the style.

{{DevNotes|The style for the cancellation info view ("Cancellation_vwInfoScroll") will be modified to have an "options" or "layout" property.
This will be set to an object, with properties of each type of exception. Each exception type will have an array of items that will be displayed on the view panel.

The following shows all the allowed elements in this configuration item:
vwInfoScroll_items {
"JOBS" : ["CancelText", "JobId", "CustName"],
"SERVICE_JOB" : ["CancelText", "JobId", "CustName"],
"SERVICE_ITEM" : ["CancelText"],
"CONTAINER" : ["CancelText", "JobId", "CustName", "LinkedJobs", "ContID", "PackageCode", "ContPackDesc", "ContDescLong", "ContWt", "ContC1", "ContC2", "ContC3"],
"CLAUSE_CONTAINER" : ["CancelText", "JobId", "CustName", "LinkedJobs", "ContID", "PackageCode", "ContPackDesc", "ContDescLong", "ContWt", "ContC1", "ContC2", "ContC3"],
"PRODUCT" : ["CancelText", "JobId", "CustName", "ProdContID", "ProdDesc", "ProdDescLong", "PlanQty", "ProdUOM"],
"CLAUSE_PRODUCT" : ["CancelText", "JobId", "CustName", "ProdContID", "ProdDesc", "ProdDescLong", "PlanQty", "ProdUOM"],
"CHANGE_QTY" : ["CancelText", "JobId", "CustName", "ProdContID", "ProdDesc", "ProdDescLong", "PlanQty", "ProdUOM"]
}

The default values for this object will be stored in the application's system style as follows:
vwInfoScroll_items {
"JOBS" : ["CancelText", "JobId", "CustName"],
"SERVICE_JOB" : ["CancelText", "JobId", "CustName"],
"SERVICE_ITEM" : ["CancelText"],
"CONTAINER" : ["CancelText", "JobId", "CustName", "LinkedJobs", "ContID", "PackageCode", "ContPackDesc", "ContDescLong", "ContWt", "ContC1", "ContC2", "ContC3"],
"CLAUSE_CONTAINER" : ["CancelText", "JobId", "CustName", "LinkedJobs", "ContID", "PackageCode", "ContPackDesc", "ContDescLong", "ContWt", "ContC1", "ContC2", "ContC3"],
"PRODUCT" : ["CancelText", "JobId", "CustName", "ProdDesc"],
"CLAUSE_PRODUCT" : ["CancelText", "JobId", "CustName", "ProdDesc"],
"CHANGE_QTY" : ["CancelText", "JobId", "CustName", "ProdDesc"]
}

The MLP PDA style will style this as follows:
vwInfoScroll_items {
"JOBS" : ["CancelText", "JobId", "CustName"],
"SERVICE_JOB" : ["CancelText", "JobId", "CustName"],
"SERVICE_ITEM" : ["CancelText"],
"CONTAINER" : ["CancelText", "JobId", "CustName", "LinkedJobs", "ContID", "PackageCode", "ContPackDesc", "ContDescLong", "ContWt", "ContC1", "ContC2", "ContC3"],
"CLAUSE_CONTAINER" : ["CancelText", "JobId", "CustName", "LinkedJobs", "ContID", "PackageCode", "ContPackDesc", "ContDescLong", "ContWt", "ContC1", "ContC2", "ContC3"],
"PRODUCT" : ["CancelText", "JobId", "CustName", "ProdDescLong", "PlanQty", "ProdUOM"],
"CLAUSE_PRODUCT" : ["CancelText", "JobId", "CustName", "ProdDescLong", "PlanQty"],
"CHANGE_QTY" : ["CancelText", "JobId", "CustName", "ProdDescLong"]
}

The process building the view panel will check for this configuration element before building it. If it doesn't exist in the custom style, the default system style will be checked and this will be used.

The process will loop through the configuration array elements and only add those listed.
}}
{| class="wikitable" border="1"
|-bgcolor="silver"
! Config Element !! Field to Add || Notes
|-
| "CancelText" || "jobCancelLB" ||  
|-
| "JobId" || "lblJobId" || Only added if the Job DAL object is present.
|-
| "CustName" || "lblCustName" || Only added if the Job DAL object is present.
|-
| "LinkedJobs" || "lblLinkedJobId", "lblLinkedCustName" || Add only if the data object type is "PDA_CONTAINER". Add only for linked containers i.e. consolidated across jobs. Add for each linked job's container. The labels have been renamed here to include the text "Linked".
|-
| "ContID" || "lblContID" || Add only if the data object type is "PDA_CONTAINER".
|-
| "PackageCode" || "lblPackageCode" || Add only if the data object type is "PDA_CONTAINER".
|-
| "ContPackDesc" || "lblContPackageDesc" || Add only if the data object type is "PDA_CONTAINER".
|-
| "ContDescLong" || "lblContDescLong" || This is a new field. Add only if the data object type is "PDA_CONTAINER".
|-
| "ContWt" || "lblContWt" || Add only if the data object type is "PDA_CONTAINER".
|-
| "ContC1" || "lblContC1" || Add only if the data object type is "PDA_CONTAINER".
|-
| "ContC2" || "lblContC2" || Add only if the data object type is "PDA_CONTAINER".
|-
| "ContC3" || "lblContC3" || Add only if the data object type is "PDA_CONTAINER".
|-
| "ProdDesc" || "lblProdDesc" || This is a new field. Add only if the data object type is "PDA_PRODUCT".
|-
| "ProdDescLong" || "lblProdDescLong" || This is a new field. Add only if the data object type is "PDA_PRODUCT".
|-
| "PlanQty" || See below for details. || These are new fields. Add only if the data object type is "PDA_PRODUCT".
|-
| "ProdUOM" || "lblProdUOM" || This is a new field. Add only if the data object type is "PDA_PRODUCT".
|}
{{DevNotes|All fields are ID'd with the screen name on the front, for example, where this document specifies field "jobCancelLB", this is added to the screen as "Cancellation_jobCancelLB".

When adding "PlanQty" to the view panel, the field should be generated in exactly the same way as they are added to the quantity entry view as now, with the same IDs. Further, a variable should be set to show that the planned fields have been added to the Info view. This will be checked when building the quantity entry view and, if set to true, the planned quantity fields will ''not'' be added to the quantity entry view.

Change the function CancellationText for types "PRODUCT", "CLAUSE_PRODUCT" and "CHANGE_QTY" to not include the description in the cancellation text.
}}


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|Glossary=EPOD2
|Ref1= 
|RefV1= 
|RefDate1= 
|REQ=0
|EST=0
|FS=0.75
|TS=0
|DEV=3.0
|ST=0.5
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Murray Middleton
|Rev1Title=OBS Project Manager
|Rev2=Debbie Kitchen
|Rev2Title=Customer Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 355160 MLP Device Changes - Revision history

Anw: v1.0 - Release after review

Anw: v0.1 - Initial Draft