FS 291985 EPOD Job Groups: Difference between revisions
(Slight format change) |
(v1.0 - Issued after review by Steve McCartney and Matt Turner) |
||
| Line 4: | Line 4: | ||
{{#vardefine:System|''CALIDUS'' EPOD}} | {{#vardefine:System|''CALIDUS'' EPOD}} | ||
{{#vardefine:Doc_Title|Job Groups}} | {{#vardefine:Doc_Title|Job Groups}} | ||
{{#vardefine:Version|0 | {{#vardefine:Version|1.0}} | ||
{{#vardefine:Date| | {{#vardefine:Date|14th September 2011}} | ||
{{#vardefine:Reference|291985}} | {{#vardefine:Reference|291985}} | ||
</div> | </div> | ||
| Line 273: | Line 273: | ||
|Rev2=Steve McCartney | |Rev2=Steve McCartney | ||
|Rev2Title=OBS Manager | |Rev2Title=OBS Manager | ||
|Rev3=Matt Turner | |||
|Rev3Title=OBS Sales | |||
}}</div> | }}</div> | ||
[[Category:SM Fleet FS]] | [[Category:SM Fleet FS]] | ||
Revision as of 10:18, 14 September 2011
SM Fleet
Job Groups
CALIDUS EPOD
14th September 2011 - 1.0
Reference: FS 291985
Contents
Functional Overview
Client Requirement
As per customer feedback, the Site configuration option within the new POD system is not suitable for the customer. Please add a Group Configuration mechanism to the product.
Solution Overview
A Job Group table will be added, maintained through the EPOD Admin system.
The Job Group table will contain similar configuration data to the Site table.
All Jobs will be ensured that they have a Job Group assigned to them.
The EPOD Client will be passed the Job Group configuration from the EPOD Server.
The EPOD Client will use this configuration in preference to the Site configuration when processing services, if a Job Group exists.
The Work Report will use the Job Group Format, Logo and Description in preference to the Site values, if there is a Job Group.
Scope
Set-up
Pre-requisites
Menu Structure
Data
Database Changes
New Table EPL_JOB_GROUPS
A new table must be added to validate Job Groups, and also to allow the configuration of the Job Group.
The table will be created as follows:
| Element | Type | Description |
| (PK) EPL_SITE_ID | NCHAR (10) | Site or Warehouse code. |
| (PK) EPL_JOB_GROUP | NCHAR (5) | Job Group. |
| EPL_DESCRIPTION | NCHAR(40) | Description of the Job Group |
| EPL_LOGO | NVARCHAR(MAX) | Logo for POD production |
| EPL_SERVICE_POD_FORMAT | NCHAR(10) | POD format |
| EPL_DELIVERY_POD_FORMAT | NCHAR(10) | POD format |
| EPL_COLLECTION_POD_FORMAT | NCHAR(10) | POD format |
| EPL_SERVICE_ACTIVITIES | NVARCHAR(1) | Whether this tab is required when processing Service jobs |
| EPL_SERVICE_PREWORK | NVARCHAR(1) | Whether this tab is required when processing Service jobs |
| EPL_SERVICE_INFO | NVARCHAR(1) | Whether this tab is required when processing Service jobs |
| EPL_SERVICE_PRODUCTS | NVARCHAR(1) | Whether this tab is required when processing Service jobs |
| EPL_SERVICE_MC_REF | NVARCHAR(1) | Whether this tab is required when processing Service jobs |
| EPL_SERVICE_DIAGNOSIS | NVARCHAR(1) | Whether this tab is required when processing Service jobs |
| EPL_SERVICE_POSTWORK | NVARCHAR(1) | Whether this tab is required when processing Service jobs |
| EPL_LAST_CHANGED_DATE | INTEGER | Last time the record was modified |
| EPL_LAST_CHANGED_TIME | INTEGER |
New Procedures
New procedures must be added to the database as per the DAL interface, to Create, Find, Edit and Delete Job Groups
Server Changes
Data Access Layer (DAL)
A new DAL object must be added for the Job Groups table, as per the standard processing. This must allow:
- Finding Job Groups for a specific Site
- Editing a Job Group
- Creating a new Job Group
- Deleting an existing Job Group
- Produce a JOB_GROUP_CONFIG XML output file for the PDA device.
The Services DAL Object must be modified to allow the definition of a Job Group for the Service.
Note: The deletion of a Job Group can only occur if there are no jobs assigned to this group.
Note: It must also be possible to edit the Details and Configuration elements of the Job Group table separately, as these will be modified through different screens.
Client-Server Communications
The Login Response will be modified to add a Job Groups XML section.
The existing Site and Service Config sections will be combined into a single Site XML tag.
The new Job Group XML tag will be populated in the same way, but from the Job Groups table. Only data modified since the last data upload on the device will be sent.
The Load Response XML will be modified to return the Job Group in a new tag.
Admin Changes
Services Maintenance
When creating a new Service, the user may enter a Job Group. This should be through a DDL of the available Job Groups for that user's chosen Site, allowing a blank entry.
When finding Services, the Job Group filter should be a DDL of the available Job Groups for that user's chosen Site, with an optional blank entry.
When editing an existing Service, the Job Group should be a DDL of the available Job Groups for that user's chosen Site, allowing a blank entry.
The Job Group DDL should show the Description of the Job Group, sequenced by Job Group, with the blank entry first.
When data is displayed in the Services grid, the Job Group for the specified Job must be translated into the Description of the Job Group from the new table. If there is no job group, this should be displayed as blank space.
Service Details
Jobs Maintenance
When creating a new Job, the user may enter a Job Group. This should be through a DDL of the available Job Groups for that user's chosen Site, allowing a blank entry.
When finding Jobs, the Job Group filter should be a DDL of the available Job Groups for that user's chosen Site, with an optional blank entry.
When editing an existing Job, the Job Group should be a DDL of the available Job Groups for that user's chosen Site, allowing a blank entry.
The Job Group DDL should show the Description of the Job Group, sequenced by Job Group, with a blank entry first.
When data is displayed in the Jobs grid, the Job Group for the specified Job must be translated into the Description of the Job Group from the new table. If there is no job group, this should be displayed as blank space.
Isotrak Service Upload
The Upload screen should be modified to allow the user to select a Job Group when uploading services.
The Job Group entry should be through a DDL, showing the Description of all the Job Groups for the user's default site, with a blank entry first.
This entered Job Group should be saved against each upload job in the upload file.
Job Groups Maintenance
This page should be added to the main menu, on the Admin entry, after Site.
The title of the screen should be 'Job Groups Maintenance'.
When entering the screen, the user will be allowed to filter by Job Group and Description. This will 'fuzzy match' against the data when selecting (i.e. 'Desc' will match 'Job Desc', 'Description 1', 'Job Description', etc). Only Job Groups for the user's default Site ID will be displayed.
When selected, the page will display a grid of all job groups matching the filter criteria.
The Job Group grid will display:
- Site ID
- Job Group
- Description
- Logo
- Service POD Format
- Delivery POD Format
- Collection POD Format
Admin User Functions
The following functions will only be available if the user is an Admin user (i.e. not Enquiry Only).
A New button will be available at the top of the screen to allow the user to create a new Job Group. On clicking this button, the user will be prompted to enter:
- Job Group
- Description
- Logo
- Service POD Format
- Delivery POD Format
- Collection POD Format
Site ID will be defaulted from the user's default Site ID.
A Browse button will be provided to upload a Logo. This will be validated as the Site maintenance screen.
POD formats will validate as the Site maintenance screen.
A Create button will be provided to save the data. On clicking this button, the page will validate the entered data:
- The Job Group entered must not already exist for the Site.
- All fields must be entered or a valid value selected from the available DDLs.
If the entry fails validation, the reasons will be displayed on the screen and the user prompted to correct the issues.
If the entry passes validation, the data will be saved (through the server DAL) and the page will return to the Find filter.
A Cancel button will cancel the new Job Group and return the user to the Find filter.
Each Job Group line will have a Select button against it. When clicked, this will offer a number of editing options to the user:
- Edit
- Delete
- Configure
On clicking Edit, the grid will become editable on the following fields:
- Description
- Logo
- Service POD Format
- Delivery POD Format
- Collection POD Format
The entry of these fields will be as the Create mode above.
Update and Cancel buttons will be provided.
If the user presses the Cancel button, the grid will return to the normal state before Select was clicked on the line.
If the user presses the Update button, the data will be validated as per the Create mode above.
If the entry fails validation, the reasons will be displayed on the screen and the user prompted to correct the issues.
If the entry passes validation, the data will be saved (through the server DAL) and the page will return to the Find filter.
The Delete button will only delete data if the Job Group is not used on any jobs. on clicking this button, this will be checked. If the Job Group is in use, the screen will display the error and return to the Find Filter. If the Job Group is not in use, the Job Group will be deleted, the screen will display a message confirming that the Job Group has been deleted and the user will be returned to the Find filter.
On clicking Configure, the user will be taken to a Job Group Configuration form.
Job Group Configuration
The Job Group Configuration screen will display fields for:
- Info Tab
- Prework Tab
- Activities Tab
- Products Tab
- Postwork Tab
- MC Ref Tab
- Diagnosis Tab
The title of the screen will be 'Configuration of Job Group ', plus the Job Group and Description.
Each configuration field should show the value of the field, converted to either Active or Inactive.
All fields should default to Inactive in no value has been specified.
The values should be shown through a DDL showing only these two values. The user should be able to amend the values through the DDLs.
The page should provide Update and Cancel button.
On clicking the Cancel button, the user should be returned to the Job Groups Maintenance screen, where the screen should be back at the Find filter.
On clicking the Update button, the screen will save the values entered by the user against the specified Job Group. The user should be returned to the Job Groups Maintenance screen, where the screen should be back at the Find filter.
POD Production
This page must be modified to take the Format, Logo and Description from the Job Group record (if there is one), or then from the Site record.
PDA
Database
The PDA database will be modified to store the Job Group data, in the same format as the main EPOD database.
Logon Response Processing
The device will be modified to recognise the XML data tag from Job Groups and store this data onto the device database.
Load Response Processing
The device will be modified to recognise the new Job Group XML tag and store this data jobs assigned to the load.
Service Processing
The device currently checks the configuration of the Service for the Site when a service job is started. This will be modified to check the Job Group (if it exists) first. If it does, the service configuration will come from the Job Group. If this doesn't exist, the configuration will come from the Site.
Appendix A: Quote & Document References
| 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.50 | 0.50 | 0 | £0.00 |
| Technical Specification | 0.00 | 0.00 | 0 | £0.00 |
| Development | 8.00 | 8.00 | 0 | £0.00 |
| Testing and Release | 2.00 | 2.00 | 0 | £0.00 |
| Implementation | 0.00 | 0.00 | 0 | £0.00 |
| Project Management | First argument to "number_format" must be a number. | First argument to "number_format" must be a number. | 0 | £First argument to "number_format" must be a number. |
| TOTAL | First argument to "number_format" must be a number. | First argument to "number_format" must be a number. | £First argument to "number_format" must be a number. | |
| Estimate excludes training, release to live and go live support. |
A.1 References
| Ref No | Document Title & ID | Version | Date |
| 1 |
A.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. |
A.3 Authorised By
Tony Walker | OBS Consultant | _____________________________ |
Steve McCartney | OBS Manager | _____________________________ |
Matt Turner | OBS Sales | _____________________________ |
