Revision as of 12:30, 24 April 2013

Air Link Services

Air Link EPOD Development

CALIDUS eSERV

23rd April 2013 - 0.1
Reference: FS 308231

Functional Overview

Client Requirement

As described in the Requirements document, referenced later.

Solution Overview

All changes required are broken down as follows:

SCR#	System	Area	Description	Estimate (Days)	Notes
1	eSERV	Admin	Add new Configuration Options to Job Group and Site.	N/A
2	eSERV	Admin	Custom style to change labels and hide unwanted elements.	N/A
3	eSERV	Admin	Add new elements to Job Details and Service Details screens.	N/A
5	eSERV	PDA	Add System Type to Info tab.	N/A
6	eSERV	PDA	Add Job Status to Diagnosis tab.	N/A
7	eSERV	PDA	Custom style the client to change labels and hide unwanted elements.	N/A
8	eSERV	PDA	Allow Back-out of Customer signature only in Service jobs.	N/A
9	eSERV	PDA	Allow optional Photo on finishing Job.	N/A
10	eSERV	Server	On Job Suspension, create an unassigned copy of the job.	N/A
11	eSERV	Admin	New Service Report format.	N/A

Scope

The changes will be made in the latest version of the CALIDUS eSERV system.
Although the document describes all changes discussed with the client, subsequent meetings have marked several changes as out of scope. Although these are referred to in several places throughout the document to identify the ideal process, if the initial change is marked out of scope, all references to it are also out of scope.
- SLA display (RAG Colouration)
- Maintenance Jobs
- Linked Product to System Type
- Reports
Images used in this document a representative of the final look and feel, although this may differ in the final delivered application.
Emailing of documents requires that the server has access to the customer's email server - to be provided by the customer is required.

Set-up

Pre-requisites

An installed and connected CALIDUS eSERV system.

Menu Structure

As normal

Data

Warning: Emailing of documents requires that the server has access to the customer's email server - to be provided by the customer if required.

The system will be configured as follows:

EPOD_SITE of ALS:

Service format: ALS.
Logo: with the ALS logo.
Arrival Times (EPL_ARRIVAL = "Y" - Enabled)
Display Job Code on PDA
Document Photo - Optional
Resequencing Options ("Y" - Free to Resequence)
Scan Errors Intrusive
PODs PDF
Service Calls will be configured to display the following tabs:
- Info - Enabled for Air Link
- Products - Enabled
- Job Suspension - Enabled

EPOD_JOB_GROUP of ALS:

Service format: ALS.
Logo: with the ALS logo.
Document Photo - Optional
Service Calls will be configured to display the following tabs:
- Info - Enabled for Air Link
- Products - Enabled
- Job Suspension - Enabled

EPOD_CUSTOMER of ALS:

Set up the customer with this name, with the ALS address and contact information entered against it.

Functional Description

Database and DAL Changes

Table EPOD_SITE

EPL_JOB_STATUS - a flag to control whether EPL_JOB_STATUS will be prompted (initially for Services only). nvarchar(1), NOT NULL DEFAULT 'N', values 'Y' or 'N'.

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

EPOD_SITE_INSERT
EPOD_SITE_SELECT
EPOD_SITE_SELECT_UPDATED_DATA
EPOD_SITE_UPDATE

The existing EPOD_SITE DAL object will be changed to:

Export the new flag in XML requests
Read the new flag

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.

Table EPOD_JOB_GROUP

EPL_JOB_STATUS - a flag to control whether EPL_JOB_STATUS will be prompted (initially for Services only). nvarchar(1), NOT NULL DEFAULT 'N', values 'Y' or 'N'.

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

EPOD_JOB_GROUP_INSERT
EPOD_JOB_GROUP_SEARCH
EPOD_JOB_GROUP_SELECT
EPOD_JOB_GROUP_SELECT_UPDATED_DATA
EPOD_JOB_GROUP_UPDATE

The existing EPOD_JOB_GROUP DAL object will be changed to:

Export the new flag in XML requests
Read the new flag

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.

Existing package EPOD_SETUP will be modified to ensure that the new flags are defaulted appropriately.

Table EPOD_JOB

EPL_JOB_STATUS - Suspended or Complete (initially for Services only). nvarchar(2), NOT NULL DEFAULT ' ', values 'C' or 'S'.

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

EPOD_JOB_INSERT
EPOD_JOB_SEARCH
EPOD_JOB_SELECT
EPOD_JOB_SELECT_DATE_RANGE
EPOD_JOB_UPDATE

The existing EPOD_JOB DAL object will be changed to:

Export the new field in XML requests
Read the new field
Add as a parameter and searchable item

Table EPOD_SERVICE_PRODUCT_MASTER

EPL_MODEL - The model of the system the product (part) is for. nvarchar(30).

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

EPOD_SERVICE_PRODUCT_M_INSERT
EPOD_SERVICE_PRODUCT_M_SEARCH
EPOD_SERVICE_PRODUCT_M_SELECT
EPOD_SERVICE_PRODUCT_M_SELECT_UPDATED_DATA
EPOD_SERVICE_PRODUCT_M_UPDATE

The existing EPOD_SERVICE_PRODUCT_MASTER DAL object will be changed to:

Export the new flag in XML requests
Read the new flag
Add as a parameter and searchable item

Table EPOD_SERVICE

EPL_SERVICE_GROUP - The system type (e.g. Checkout, Cashtube, etc). nvarchar(10).
EPL_SYSTEM_TYPE - The model of the system the product (part) is for. nvarchar(30).

Existing packages will be modified to allow the creating, editing and selecting of the new field, 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 flag in XML requests
Read the new flag
Add as a parameter and searchable item

Warning: ADD HERE

Import/Export Changes

Other than those specified in the DAL changes above, there are no required changes to any generic or bespoke exports at this time.

Admin Changes

The CALIDUS eSERV system is configured and administered through a web Admin system. This is fully documented elsewhere and referenced in this document appendices. Certain elements will be modified as part of these changes to ensure that the system can be configured correctly for the customer's use.

The Job Group and Site screens will be modified to allow the system to be configured for:

Job Suspension
Optional Document Photo
Configuration of new Service Report format
Configuration of customer-specific Info entry.

Warning: ADD HERE

The Job Details screen will be modified to allow the user to:

create Service jobs
specify a Service ID
specify a Service Group (e.g. Checkout, Cash Tube, etc)

Warning: ADD HERE

The Service Details screen will be modified to:

Change labels and remove unwanted items (e.g. VNOS)
Add System Type and Job Status

Warning: ADD HERE

The Service Product Master screen will be modified to:

Add the new Model field when adding new service products (optional).
Add/change the new Model field when editing existing products (optional).
Add the new Model field to the grid.

A new Service Report format will be written for the operation, based on the existing Breakdown Report. The format has been prototyped and available in P:\EPOD\Correspondence\Air Link\AirLinkReport.html and is shown below:

Note: The printing of the report is browser-dependent and can differ in small ways from the sample above.

From top to bottom and left to right, the fields will be mapped as follows:

ALS Logo - EPL_LOGO of EPOD_SITE of EPL_SITE_ID of EPOD_JOB
ALS Address - Taken from the EPOD_CUSTOMER details for EPL_SITE_ID of EPOD_JOB: EPL_CUSTOMER_NAME, EPL_ADDRESS_1/2/3/4, EPL_POSTCODE, EPL_TELEPHONE.
Customer: and Address: - Taken from the EPOD_CUSTOMER details for EPL_CUSTOMER_CODE of EPOD_JOB, or EPOD_JOB_ADDRESS if exists: EPL_CUSTOMER_NAME, EPL_ADDRESS_1/2/3/4, EPL_POSTCODE.
Date: - EPL_START_ACTUAL_DATE of EPOD_JOB
Job No: - EPL_JOB_CODE of EPOD_JOB Note: This will be the same as the Service ID.
System Type: - EPL_SERVICE_GROUP and EPL_SYSTEM_TYPE of EPOD_SERVICE
System Fault - EPL_JOB_INSTRUCTION of EPOD_JOB
Rectification Required - EPL_DIAGNOSIS_NARRATIVE of EPOD_SERVICE
Job Suspended/Job Complete checkboxes - Warning: Set based on value of new field EPL_JOB_STATUS of EPOD_JOB.
Job Chargeable checkbox - set based on whether the existing field EPL_CUSTOMER_DAMAGE = "Y"
Misuse checkbox - set based on whether the existing field EPL_CUSTOMER_DAMAGE = "Y"
Materials Used section:
- Note: The customer agreed that the "NO" label (if no products were used) can be omitted from the design.
- Note: Only records of materials used should be shown on this list i.e. EPL_DIRECTION of EPOD_SERVICE_PRODUCTS = "U"
- Quantity - EPL_QUANTITY of EPOD_SERVICE_PRODUCT
- Description - EPL_DESCRIPTION of EPOD_SERVICE_PRODUCT_MASTER
- Part No. - EPL_PRODUCT_CODE of EPOD_SERVICE_PRODUCT
Time On Site: - EPL_ARRIVAL_TIME of EPOD_JOB
Time Off Site: - EPL_END_ACTUAL_TIME of EPOD_JOB
Customer Signature - EPL_JOB_SIGNATURE of EPOD_JOB (Base64-decoded image)
Print Name - EPL_SIGNATORY of EPOD_JOB
Engineer Name: - EPL_USER_NAME of EPOD_USER (from EPL_USER_ID of EPOD_LOAD)
Engineer Signature - EPL_ENG_SIGNATURE of EPOD_JOB (Base64-decoded image)
Date: - EPL_END_ACTUAL_DATE of EPOD_JOB

Android PDA Changes

Database and DAL Changes

Warning: ADD HERE

Style Changes

Custom style the client to change labels and hide unwanted elements.

Relabel 'Customer Damage' as 'Misuse'.
Remove VNOS flag

Note: The existing functionality in the system to deal with this Imaging is referred to as Document Photo. This will be modified to so that the labels and messages shown on the PDA refer to Job Photo instead, as part of the customer styling. Warning: ADD HERE

Services Info Tab

This tab currently contains the job-level information required for the Service.

This screen will be modified to display a picker for System Type.

The actual values in here are controlled by the system set-up of the Product Groups in the Admin system. It will be required that this is entered. Warning: ADD HERE

Services Diagnosis Tab

This tab allows the user to enter Problem Diagnosis information.

This screen will be modified to:

Add Job Status, a picker with 'Complete' and 'Suspended'. A value must be selected.
Relabel 'Customer Damage' as 'Misuse'.
Remove VNOS flag

A Diagnosis and a Job Status must be entered. Warning: ADD HERE

Service Call Confirmation

Once all the information has been entered and the engineer clicks the Complete button, the PDA will prompt for the customer's signature.

Note: The user will be able to back out of this signature capture to see the details entered against the service, so that the customer can review before signing.

Once entered, the PDA will require the entry of Engineer signature. The user will not be able to back out of this signature.

Warning: ADD HERE Allow Back-out of Customer signature only in Service jobs.

When complete and confirmed, the device will ask the user whether any job photos are required. If so, the device will display the Job Photo prompt, where the user will be able to take an image and associate it to the job.

Warning: ADD HERE Allow optional Photo on finishing Job.

Note: The existing functionality in the system to deal with this Imaging is referred to as Document Photo. This will be modified to so that the labels and messages shown on the PDA refer to Job Photo instead, as part of the customer styling.

Server PDA Message Processing

The completed job will be transferred back to the main system with all the details, signatures and photos.

Already Completed or Cancelled jobs can be shown or hidden by pressing the Menu button on the device and toggling between Show All Jobs and Show Outstanding Jobs.

In the event that a job has been postponed, the system will be modified to create a new copy of the job, with a new ID. All information from the old job will be copied over, minus the Diagnosis and Products information.

Warning: ADD HERE, SHOW ALL FIELDS TO BE COPIED AND WHAT'S NOT TO BE COPIED

Warning: DON'T CLOSE THE LOAD?

Appendix A: TEST PLAN

Test Script / Scenario Reference	Air Link EPOD Development	Call Number(s): 308231
Test Script / Scenario Description	To test all added functionality	PASS / ISSUES / FAIL
Menu Access	Various
Pre-requisites	Set up as per the specification	Tested By:
Test Objective	To test the additions to the services functionality for ALS.	Date:

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 B: Document References

B.1 References

Ref No	Document Title & ID	Version	Date
1	REQ 308231 Airlink Requirements	1.0	17/04/2013
2	UG 291094 EPOD Admin User Guide	2.0	4/04/2012
3	UG 291097 EPOD Client User Guide	3.0	23/04/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

Jamie Foster

OBS Project Manager

_____________________________

@@ Line 126: / Line 126: @@
 == Data  ==
-{{Warning}} Emailing of documents requires that the server has access to the customer's email server - to be provided by the customer is required.
+{{Warning}} Emailing of documents requires that the server has access to the customer's email server - to be provided by the customer if required.
 The system will be configured as follows:
-EPOD_SITE of ALS:
+'''EPOD_SITE of ALS:'''
 * Service format: ALS.
 * Logo: with the ALS logo.
@@ Line 138: / Line 139: @@
 * Scan Errors Intrusive
 * PODs PDF
+* Service Calls will be configured to display the following tabs:
+** ''Info'' - Enabled for Air Link
+** ''Products'' - Enabled
+** Job Suspension - Enabled
+'''EPOD_JOB_GROUP of ALS:'''
+* Service format: ALS.
+* Logo: with the ALS logo.
+* Document Photo - Optional
+* Service Calls will be configured to display the following tabs:
+** ''Info'' - Enabled for Air Link
+** ''Products'' - Enabled
+** Job Suspension - Enabled
+'''
+EPOD_CUSTOMER of ALS:'''
+* Set up the customer with this name, with the ALS address and contact information entered against it.
+<!-- NEW PAGE -->
-EPOD_JOB_GROUP of ALS:
+= Functional Description  =
-*
-*
+== Database and DAL Changes  ==
+===Table EPOD_SITE===
+* EPL_JOB_STATUS - a flag to control whether EPL_JOB_STATUS will be prompted (initially for Services only). nvarchar(1), NOT NULL DEFAULT 'N', values 'Y' or 'N'.
+Existing packages will be modified to allow the creating, editing and selecting of the new flag, including but not limited to:
+*EPOD_SITE_INSERT
+*EPOD_SITE_SELECT
+*EPOD_SITE_SELECT_UPDATED_DATA
+*EPOD_SITE_UPDATE
+The existing EPOD_SITE DAL object will be changed to:
+* Export the new flag in XML requests
+* Read the new flag
+{{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.
-Service Calls will be configured to display the following tabs:
+===Table EPOD_JOB_GROUP===
-* ''Info'' - Enabled for Air Link
+* EPL_JOB_STATUS - a flag to control whether EPL_JOB_STATUS will be prompted (initially for Services only). nvarchar(1), NOT NULL DEFAULT 'N', values 'Y' or 'N'.
-* ''Products'' - Enabled
+Existing packages will be modified to allow the creating, editing and selecting of the new flag, including but not limited to:
-* ''Diagnosis'' - Enabled for Air Link
+*EPOD_JOB_GROUP_INSERT
+*EPOD_JOB_GROUP_SEARCH
+*EPOD_JOB_GROUP_SELECT
+*EPOD_JOB_GROUP_SELECT_UPDATED_DATA
+*EPOD_JOB_GROUP_UPDATE
+The existing EPOD_JOB_GROUP DAL object will be changed to:
+* Export the new flag in XML requests
+* Read the new flag
+{{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.
-<!-- NEW PAGE -->
+Existing package EPOD_SETUP will be modified to ensure that the new flags are defaulted appropriately.
-= Functional Description  =
+===Table EPOD_JOB===
+* EPL_JOB_STATUS - Suspended or Complete (initially for Services only). nvarchar(2), NOT NULL DEFAULT ' ', values 'C' or 'S'.
+Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
+*EPOD_JOB_INSERT
+*EPOD_JOB_SEARCH
+*EPOD_JOB_SELECT
+*EPOD_JOB_SELECT_DATE_RANGE
+*EPOD_JOB_UPDATE
+The existing EPOD_JOB DAL object will be changed to:
+* Export the new field in XML requests
+* Read the new field
+* Add as a parameter and searchable item
-== Database Changes  ==
+===Table EPOD_SERVICE_PRODUCT_MASTER===
-{{Warning}}ADD HERE
+* EPL_MODEL - The model of the system the product (part) is for. nvarchar(30).
+Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
+*EPOD_SERVICE_PRODUCT_M_INSERT
+*EPOD_SERVICE_PRODUCT_M_SEARCH
+*EPOD_SERVICE_PRODUCT_M_SELECT
+*EPOD_SERVICE_PRODUCT_M_SELECT_UPDATED_DATA
+*EPOD_SERVICE_PRODUCT_M_UPDATE
+The existing EPOD_SERVICE_PRODUCT_MASTER DAL object will be changed to:
+* Export the new flag in XML requests
+* Read the new flag
+* Add as a parameter and searchable item
-== DAL Changes ==
+===Table EPOD_SERVICE===
-{{Warning}}ADD HERE
+* EPL_SERVICE_GROUP - The system type (e.g. Checkout, Cashtube, etc). nvarchar(10).
+* EPL_SYSTEM_TYPE - The model of the system the product (part) is for. nvarchar(30).
+Existing packages will be modified to allow the creating, editing and selecting of the new field, 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 flag in XML requests
+* Read the new flag
+* Add as a parameter and searchable item
-== Import Changes ==
 {{Warning}}ADD HERE
-== Export Changes ==
+== Import/Export Changes ==
-{{Warning}}ADD HERE
+Other than those specified in the DAL changes above, there are no required changes to any generic or bespoke exports at this time.
 == Admin Changes ==
@@ Line 169: / Line 237: @@
 The Job Group and Site screens will be modified to allow the system to be configured for:
 * Job Suspension
 * Optional Document Photo
 * Configuration of new Service Report format
-* Configuration of customer-specific Info tab.
+* Configuration of customer-specific Info entry.
 {{Warning}}ADD HERE
@@ Line 185: / Line 253: @@
 * Add System Type and Job Status
 {{Warning}}ADD HERE
+The Service Product Master screen will be modified to:
+* Add the new Model field when adding new service products (optional).
+* Add/change the new Model field when editing existing products (optional).
+* Add the new Model field to the grid.
 A new Service Report format will be written for the operation, based on the existing Breakdown Report. The format has been prototyped and available in ''P:\EPOD\Correspondence\Air Link\AirLinkReport.html'' and is shown below:
@@ Line 192: / Line 265: @@
 {{Note}} The printing of the report is browser-dependent and can differ in small ways from the sample above.
-{{Warning}}ADD FIELDS HERE, mapping to each individual element.
+From top to bottom and left to right, the fields will be mapped as follows:
+* ALS Logo -  EPL_LOGO of EPOD_SITE of EPL_SITE_ID of EPOD_JOB
+* ALS Address - Taken from the EPOD_CUSTOMER details for EPL_SITE_ID of EPOD_JOB: EPL_CUSTOMER_NAME, EPL_ADDRESS_1/2/3/4, EPL_POSTCODE, EPL_TELEPHONE.
+* '''Customer:''' and '''Address:''' - Taken from the EPOD_CUSTOMER details for EPL_CUSTOMER_CODE of EPOD_JOB, or EPOD_JOB_ADDRESS if exists: EPL_CUSTOMER_NAME, EPL_ADDRESS_1/2/3/4, EPL_POSTCODE.
+* '''Date:''' - EPL_START_ACTUAL_DATE of EPOD_JOB
+* '''Job No:''' - EPL_JOB_CODE of EPOD_JOB {{Note}} This will be the same as the Service ID.
+* '''System Type:''' - EPL_SERVICE_GROUP and EPL_SYSTEM_TYPE of EPOD_SERVICE
+* '''System Fault''' - EPL_JOB_INSTRUCTION of EPOD_JOB
+* '''Rectification Required''' - EPL_DIAGNOSIS_NARRATIVE of EPOD_SERVICE
+* Job Suspended/Job Complete checkboxes - {{Warning}} Set based on value of new field EPL_JOB_STATUS of EPOD_JOB.
+* Job Chargeable checkbox - set based on whether the existing field EPL_CUSTOMER_DAMAGE = "Y"
+* Misuse checkbox - set based on whether the existing field EPL_CUSTOMER_DAMAGE = "Y"
+* '''Materials Used''' section:
+** {{Note}} The customer agreed that the "NO" label (if no products were used) can be omitted from the design.
+** {{Note}} Only records of materials used should be shown on this list i.e. EPL_DIRECTION of EPOD_SERVICE_PRODUCTS = "U"
+** '''Quantity''' - EPL_QUANTITY of EPOD_SERVICE_PRODUCT
+** '''Description''' - EPL_DESCRIPTION of EPOD_SERVICE_PRODUCT_MASTER
+** '''Part No.''' - EPL_PRODUCT_CODE of EPOD_SERVICE_PRODUCT
+* '''Time On Site:''' - EPL_ARRIVAL_TIME of EPOD_JOB
+* '''Time Off Site:''' - EPL_END_ACTUAL_TIME of EPOD_JOB
+* '''Customer Signature''' - EPL_JOB_SIGNATURE of EPOD_JOB (Base64-decoded image)
+* '''Print Name''' - EPL_SIGNATORY of EPOD_JOB
+* '''Engineer Name:''' - EPL_USER_NAME of EPOD_USER (from EPL_USER_ID of EPOD_LOAD)
+* Engineer Signature - EPL_ENG_SIGNATURE of EPOD_JOB (Base64-decoded image)
+* '''Date:''' - EPL_END_ACTUAL_DATE of EPOD_JOB
 == Android PDA Changes ==

Anonymous

Search

FS 308231 Air Link EPOD Development: Difference between revisions

Namespaces

More

Page actions

Revision as of 12:30, 24 April 2013

Contents

Functional Overview

Client Requirement

Solution Overview

Scope

Set-up

Pre-requisites

Menu Structure

Data

Functional Description