Template:FS: Difference between revisions

From Calidus HUB
VisualWikitext
No edit summary
m (Minor formatting changes.)
 
(13 intermediate revisions by the same user not shown)
Line 2: Line 2:
{{#vardefine:Client|The Supimix Client Code}}
{{#vardefine:Client|The Supimix Client Code}}
{{#vardefine:ClientName|The Client Name}}
{{#vardefine:ClientName|The Client Name}}
{{#vardefine:System|''CALIDUS'' Mobile/TTM/Vision/etc}}
{{#vardefine:System|''CALIDUS'' Mobile/TTM/Vision/ePOD, etc}}
{{#vardefine:SystemCode|WCS/Portal/TTM/Vision/EPOD/MCS}}
{{#vardefine:Doc_Title|Document Title}}
{{#vardefine:Doc_Title|Document Title}}
{{#vardefine:Version|0.1}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|16th June 2011}}
{{#vardefine:Date|14th May 2020}}
{{#vardefine:Reference|Spimix Ref and Client Ref}}
{{#vardefine:Reference|Supimix Ref and Client Ref}}
{{#vardefine:Year|2019}}
{{#vardefine:Type|FS}}
{{ #vardefine: Figure | 0 }}{{ #vardefine: Example | 0 }}
<!--
Sample Xref:
{{Xref
|Type=Figure
|Num={{ #vardefineecho: Figure| {{ #expr: {{ #var: Figure}} + 1 }} }}
|Text=Data Upload - Import screen.}}
-->
</div>
</div>
{{Doc_Title
{{Doc_TitleNew
|Client={{#var:ClientName}}
|Client={{#var:ClientName}}
|System={{#var:System}}
|System={{#var:System}}
|Title={{#var:Doc_Title}}
|Title={{#var:Doc_Title}}
|Reference=FS {{#var:Reference}}
|Reference={{#var:Type|FS}} {{#var:Reference}}
|Version={{#var:Version}}
|Version={{#var:Version}}
|Date={{#var:Date}}
|Date={{#var:Date}}
|Year={{#var:Year}}
|Type={{#var:Type}}
}}  
}}  


<!-- TOC -->  
<!-- TOC -->  
<div class="noprint">
<div class="noprint">
= Functional Overview =
= FUNCTIONAL OVERVIEW =
== Client Requirement  ==
<!-- Include a statement describing the client’s work request requirement. -->


== Client Requirement  ==


== Solution Overview  ==
== Solution Overview  ==
<!-- Include a summary of the solution explaining how the client’s requirement will be delivered.  This might be as a result of software development or system configuration and implementation. -->


== Scope  ==
== Scope  ==
<!-- This change will be applied to system version (enter the version) on (enter the test database e.g. CONTST) and once approved (enter the production database e.g.: CONPRD).
Describe the scope of work and be clear about what is included and what is excluded. -->


<!-- NEW PAGE -->


= Set-up =
== Impact ==
<!-- Identify the potential consequences of the changes described in this Functional Specification.
 
Relating to the scope of work, document any identified dependencies necessary to maintain consistency of the solution. Highlight those not addressed within this solution specification.
 
Include any considered and related opportunities for improvement not addressed within this solution specification. -->
 


<!-- NEW PAGE -->
= CONFIGURATION SET-UP  =
== Pre-requisites  ==
== Pre-requisites  ==
<!-- Think about dependent functionality or configuration that is required to support this deliverable and describe here. -->


== Menu Structure  ==
== Menu Structure  ==
<!-- Describe how the menu system will change to accommodate this requirement if relevant. -->


== Data  ==
== Data  ==
<!-- Document any configuration data set up necessary to enable or control the solution e.g. the new report will be added to the standing data to allow it to be selected from the standard reports form. The selection criteria for the report will be (insert selection criteria). -->
== Implementation Advice ==
<!-- Include any relevant notes that will help OBSL or Client implementer to successfully enable the solution on delivery. -->


<!-- NEW PAGE -->  
<!-- NEW PAGE -->  
= FUNCTIONAL DESCRIPTION =
== Heading  ==
=== Sub Heading  ===
<!-- Describe functionally how the solution will satisfy the client requirement. Include statements to define all of the new capabilities or changes to be developed.  Include pictures to illustrate and support design.
Note that this section will usually be reviewed and signed off by the client.  Think about the audience and ensure the information documented is easy to read and understand.


= Functional Description  =
Group the functional description into logical areas and use sub-headings where appropriate -->


== Functional Area 1  ==


<!-- MEDIA LANDSCAPE YES -->  
<!-- NEW PAGE -->
= TECHNICAL NOTES =
== Modules Changed ==
<!-- List the modules or objects that will be changed by this development -->
{| class="wikitable" border="1" width="100%"
|-bgcolor="#FFFF99"
! width="20%" | Module Name || width="40%" | Module Type || width="40%" | Notes
|-
| 1 || 2 || 3
|}
 
 
== Table Updates ==
<!-- Detail any changes to the data model including additional tables, columns, indexes etc -->
{| class="wikitable" border="1" width="100%"
|-bgcolor="#FFFF99"
! width="20%" | Name || width="10%" | Type || width="10%" | Nullable || width="10%" | Default || width="10%" | Storage || width="40%" | Comments
|-
| 1 || 2 || 3 || 4 || 5 || 6
|}
 
 
== Developer Notes ==
<!-- Include technical notes and definitions to assist the developer where appropriate -->


= Appendix A: TEST PLAN  =


<!-- MEDIA LANDSCAPE YES -->
= TEST PLAN  =
{{TestPlan_Header
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Title={{#var:Doc_Title}}
Line 61: Line 126:
|Notes=Any notes or prerequisites for the tests following.
|Notes=Any notes or prerequisites for the tests following.
}} <!--INSERT TESTS HERE --> {{TestPlan_Test
}} <!--INSERT TESTS HERE --> {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.1 }} }}
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=The actions to follow
|Action=The actions to follow
|Result=The expected result
|Result=The expected result
Line 67: Line 132:
|PassFail=
|PassFail=
}} {{TestPlan_Test
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.1 }} }}
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=The actions to follow
|Action=The actions to follow
|Result=The expected result
|Result=The expected result
Line 73: Line 138:
|PassFail=
|PassFail=
}} {{TestPlan_Test
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.1 }} }}
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=The actions to follow
|Action=The actions to follow
|Result=The expected result
|Result=The expected result
Line 81: Line 146:


<!-- MEDIA LANDSCAPE NO -->  
<!-- MEDIA LANDSCAPE NO -->  
{{Doc_Appendix
{{Doc_AppendixNew
|Appendix=B
|Appendix=A
|Estimate=Y
|Estimate=Y
|Glossary=WCS
|Glossary=EPOD2
|Ref1=Reference1
|Ref1=Reference1
|RefV1=0.1
|RefV1=0.1
|RefDate1=01/01/2011
|RefDate1=26/02/2019
|REQ=0
|REQ=0
|EST=0
|EST=0
Line 95: Line 160:
|ST=0
|ST=0
|IMP=0
|IMP=0
|PM=0
|Client={{#var:Client}}
|Client={{#var:Client}}
|Year=
|Year={{#var:Year}}
|FSEST=Y
|FSEST=Y
|Rev1=Rev1
|Rev1=Rev1
|Rev1Title=Rev1 Title
|Rev1Title=OBS Project Manager
|Rev2=Rev2
|Rev2Title=Customer Representative
}}</div>  
}}</div>  
[[Category:{{#var:Client}} FS]]
[[Category:{{#var:Client}} {{#var:Type|FS}}]]
[[Category:{{#var:SystemCode}}]]

Latest revision as of 17:35, 14 May 2020






Aptean Logo.png







The Client Name

Document Title

Functional Specification

14th May 2020 - 0.1
Reference: FS Supimix Ref and Client Ref















FUNCTIONAL OVERVIEW

Client Requirement

Solution Overview

Scope

Impact

CONFIGURATION SET-UP

Pre-requisites

Menu Structure

Data

Implementation Advice

FUNCTIONAL DESCRIPTION

Heading

Sub Heading

TECHNICAL NOTES

Modules Changed

Module Name Module Type Notes
1 2 3


Table Updates

Name Type Nullable Default Storage Comments
1 2 3 4 5 6


Developer Notes

TEST PLAN

Test Script / Scenario ReferenceDocument TitleCall Number(s): Supimix Ref and Client Ref
Test Script / Scenario Descriptiondescription of what is to be achievedPASS / ISSUES / FAIL
Menu AccessWhere on the menus the item can be found 
Pre-requisitesThe prerequisites of the testTested By:
 
Test ObjectiveThe details of what each group of tests is to achieveDate:
 



Step Action Result Remarks P/F
1 Area being tested in this cycle      
  Any notes or prerequisites for the tests following.      
1.01 The actions to follow The expected result    
1.02 The actions to follow The expected result    
1.03 The actions to follow The expected result    


APPENDIX A: QUOTE & DOCUMENT HISTORY

Warning Warning: Unknown costs for client/year (The Supimix Client Code/2019)
Cost Details
Activity Estimate
No. of Days		 No. of Days Rate per Day (£) Cost (£ Exc. VAT)
Requirements 0.00 0.00 0 £0.00
Change Request Evaluation 0.00 0.00 0 £0.00
Functional Specification 0.00 0.00 0 £0.00
Technical Specification 0.00 0.00 0 £0.00
Development 0.00 0.00 0 £0.00
Testing and Release 0.00 0.00 0 £0.00
Implementation 0.00 0.00 0 £0.00
Project Management 0.00 0.00 0 £0.00
 
TOTAL 0.00 0.00   £0.00
Estimate excludes training, release to live and go live support.

References

Ref NoDocument Title & IDVersionDate
1Reference10.126/02/2019


Glossary

Term or Acronym Meaning
General Definitions
EPOD Electronic Proof of Delivery. The OBSL EPOD system is CALIDUS ePOD. This also comprises the basis of the Service Completion system CALIDUS eServ.
Server The portion of the CALIDUS ePOD/eServ systems that controls all the data and sends information to and receives updates from the mobile device.
Mobile Device; PDA The device used by the driver to perform the jobs. Typically an Android mobile device or tablet.
Site The site usually defines the depot, business or the transport group (carrier). It can be set to any value required by the customer. All transactions data (for example, loads and jobs) and standing data (for example, vehicles and uses) belong to a site. An EPOD user, on a device or in the Admin screen, can only see data for one site at a time.
Load A single journey for the driver with a set of work attached. A load is identified by a unique load ID. This may also be referred to as a worklist or workload.
Job Also Consignment. A single task for the driver as a specific location. This could be the collection of goods or the delivery of goods. Jobs may also be Services (for example, servicing, installing or de-installing a boiler). A job is identified by a unique job ID but can also have other references held against the job (e.g. job code, SO number, customer reference and external reference).
Job Group Jobs must be tagged with a Job Group. All jobs tagged with a single job group are processed in the same way. The job group has configuration associated to it to control such items as: POD/POC Report settings; Pre-Job actions (such as signing at a gatehouse); Post-Job actions (such as who signs for the item, are photos required); configurable fields required for entry for the jobs; Terms and Conditions displayed and; driver/user process (such as photos required for cancellation, comments/notes allowed). The job group can be used for any or all Sites, and the configuration against the job group can be different in each site. Job Groups can also be restricted from Admin and Remote users, so that certain users only see jobs for certain groups.
Container A generic term for any object that contains the items being collected or delivered. Examples of containers are: Pallet; Package; Carton; Item; Cage. A special container "Loose Products" - see Product below. A container is identified by a container ID which is unique to this physical container.
Product A product is any goods that are being collected or delivered where the product has a 'Product Code' which identifies what the product is but which does not uniquely identify each individual item. A product will also have a quantity associated with it to indicate how many items of this 'Product Code' are being collected or delivered. Products can either be processed within a 'Container' or as 'Loose Products' without a 'Container'.
Owner The owner of the order that created the job. Typically this is the sales team that took the order and will be responsible for dealing with queries from the customer regarding the status.
Operator; Executor The Site (depot or carrier) that is executing the load or loads that are involved in the delivery of the items.
Item Related Definitions
Job Code A reference associated with a job or job(s). This reference is common to connected jobs, for example this would be the same on both the collection of goods and the associated delivery of the same goods. Typically this would be the transport unique reference.
SO Number A reference associated with a job which indicates the "Sales Order Number" this job is associated with.
Customer Reference A reference associated with a job which has been provided by and will be recognised by the customer.
External Reference A reference associated with a job which does not match any of the existing references, usually because it has been provided by an external system.
Pallet An alternative for 'Container'. The term pallet is used when the operation only uses portable platforms as the container for goods.
Package An alternative for 'Container'. The term package is used when the operation only uses boxes or wrapping as containers for goods.
Package Code A code representing the type of 'Container'.
Package Desc A description of the type of 'Container'.
Product Code A code which identifies what a product is.
Item A generic term for any individual item that can be collected or delivered. An item can represent a 'Container' or a 'Product'. This can also be used as an alternative for 'Container' when the operation only treats the goods as individual items, i.e. not as identifiable products.
Service Item An item which will be serviced by a service job. See action 'Service'.
Issue Life The time after which an item is no longer fit for purpose.
Pack Size; Case Quantity A product may consist of a full quantity of items, inside a pack. The Pack Size (or Case Quantity) defines the amount of this product contained in a single pack. For example, if there are 85 items to deliver, with a pack size of 24, the number of full packs is determined to be 3 (24 * 3, or 72), with the remaining (13) being 'loose' quantity. This is displayed as "3/13" on the mobile application.
UOM; Item Type Unit of Measure; The major (case) UOM. This can optionally be displayed on the mobile device when changing product quantities.
Product Type A classification of the product being delivered. For example, a company may deliver 7 different mortar products and 80 different concrete slab products. The Product Types may be set to "MORTAR" and "SLABS". This may be used to attach additional configuration, changing the data required when collecting or delivering these product types.
Status Definitions
Status An indicator of how far through the processing a 'Job', 'Container' or 'Product' has progressed.
Pending A status indicating that the processing has not yet started, but is required to be completed.
In Progress A status indicating that processing has started but not yet finished.
Complete A status indicating that the 'Job', 'Container' or 'Product' has been collected or delivered.
Complete (Amended) A status indicating that the 'Job', 'Container' or 'Product' has been collected or delivered but that some changes or amendments have been made. This means that not everything that was planned to be collected or delivered was collected or delivered, some items may have been cancelled or some products may only have had some of the planned quantities collected or delivered.
Complete (Claused) A status indicating that the processing has been finished but that a 'Clause' condition has been recorded for this item.
Claused See 'Complete (Claused)' and action 'Clause'.
Cancelled A status indicating that the processing of this item or job is no longer required.
Cancelled at Collection A status indicating that the delivery of a container or product is no longer required because the associated collection of this container or product was cancelled.
Submitted An optional status that applies only to a 'Job' and which occurs after the 'Job' has been completed. This indicates that any time and expenses information recorded for the 'Job' has been submitted back to the server and can no longer be altered.
Action Definitions
Start An action associated with a 'Job' meaning the driver is about to start the processing of this job or jobs. This action will mark the job(s) with a status of 'In Progress'.
Arrive A conditional action associated with a 'Job' meaning the driver has arrived at the location the goods should be collected from or delivered to.
Continue An action associated with a 'Job' meaning the driver has previously performed the 'Start' and/or 'Arrive' action and has exited the processing screen but is now going to continue the processing.
Collect An action associated with a specific 'Container' or a 'Product' meaning the driver has collected the 'Container' or 'Product'. This action will mark the 'Container' or 'Product' with a status of 'Complete' or 'Complete (Amended)'.
Collect Claused An action associated with a specific 'Container' or a 'Product' meaning the driver has collected the 'Container' or 'Product' but with a condition under which the collection was accepted. This action will accept the clause condition and then mark the 'Container' or 'Product' with a status of 'Complete (Claused)'.
Deliver An action associated with a specific 'Container' or a 'Product' meaning the driver has delivered the 'Container' or 'Product'. This action will mark the 'Container' or 'Product' with a status of 'Complete' or 'Complete (Amended)'.
Deliver Claused An action associated with a specific 'Container' or a 'Product' meaning the driver has delivered the 'Container' or 'Product' but with a condition under which the delivery was accepted. This action will accept the clause condition and then mark the 'Container' or 'Product' with a status of 'Complete (Claused)'.
Clause An action associated with a specific 'Container' or a 'Product' that has already been collected or delivered meaning the collection or delivery has been accepted with a condition. This action will accept the clause condition and then mark the 'Container' or 'Product' with a status of 'Complete (Claused)'.
Cancel An action associated with a 'Job', 'Container' or 'Product' meaning the collection or delivery will not be performed for this 'Job', 'Container' or 'Product'.
Submit An optional action which can conditionally be carried out after a 'Job' has been collection or delivered meaning that any/all required expense or time recording for this 'Job' has been completed and can be submitted back to the server.
Service A service of a service item or items. Typically, Installation, Deinstallation or Service. The process of a service usually encompasses Pre- and Port-work checks, information gathering and diagnosis and resolution notes. Additional references (MC Refs) may also be captured.
Actioned A general term describing completing a job. So, 'Actioned' may be used instead of 'Collected', 'Serviced', 'Delivered'.
Consolidate The action of taking several jobs and linking them together, so they are actioned at the same time with one start, arrive and signature.
Deconsolidate The action of taking a consolidation of jobs and breaking them down into the component jobs again.
Job Swap The action of selecting an existing load not assigned to the user, and picking jobs to transfer onto the user's load.
Signature Capture Usually the final action of a job, where the customer's name and signature are entered.
Other Definitions
Reason Code A code which represents the reason that a job was cancelled or an item was cancelled or claused.
Vehicle The vehicle used for transporting the goods.
Vehicle Checks Also Defect Checks. A series of questions representing the results of checks intended to ensure the vehicle is in an acceptable condition.
Metrics Entry A series of questions to capture information either at the start or end of a 'Load'.
Driver The person performing the collections or deliveries; the user of the device/application.
Engineer The person performing the services; the user of the device/application.
Customer The person/company the goods are being collected from or delivered to.
Signatory The name of the person providing a signature.
T&Cs Terms and Conditions. The T&Cs are shown when signatures are prompted for. The text of the T&Cs are defined in the system itself.
Transfer Load A load select from which to swap jobs to the user's load.
Base E.g. 'Return to Base'. Typically the depot from which the driver departed.
Unplanned Ad Hoc Collection A collection job that is created by the driver, usually after delivering to a customer.
Ad Hoc Container Entry/Scanning The process of adding containers (items) to a job that have not been pre-advised on the job.
Completion Report POD, POC, Service/Work Report.
Load Assignment The action of assigning a vehicle and/or a driver to a load.
Job Assignment The action of putting jobs onto a load.
Collection/Delivery Windows; Access Windows Periods of time between which it is acceptable to deliver or collect from that customer. This has limited use in the system, mostly for reporting purposes.
Location/Map Terms
Lat-Longs; GPS Co-ordinates, GPS Position Latitude and Longitude co-ordinates, specified together as a single entity, identifying the exact position of a location. There are multiple formats - CALIDUS ePOD uses decimal notation, for example "53.3490818,-2.8521498" identifies the OBS Logistics office building in Liverpool.
GPS Global Positioning System; the satellite system used to obtain a GPS position, for use with navigation and location positioning.
Geocode; Reverse Geocode Geocoding is the process of obtaining lat-longs from an address. Reverse Geocoding is the process obtaining an address from lat-longs.
Geofence; Geofence Break A Geofence is a perimeter around a location. A Geofence Break occurs when a device passes through this perimeter on entry or exit from the location.


Authorised By


Rev1
OBS Project Manager
_____________________________

Rev2
Customer Representative
_____________________________
Retrieved from ‘https://calidusassist.adcservices.apteancloud.com/calidus-assist/OBS/index.php?title=Template:FS&oldid=8834’