FS 291985 EPOD Job Groups - Revision history

Milesl at 15:51, 26 September 2011

2011-09-26T15:51:29Z

← Older revision		Revision as of 17:51, 26 September 2011
Line 37:		Line 37:
	The Work Report will use the Job Group Format, Logo and Description in preference to the Site values, if there is a Job Group.		The Work Report will use the Job Group Format, Logo and Description in preference to the Site values, if there is a Job Group.

			An additional table User Access Groups will be added which will allow users to be limited to specific job groups. Note that these changes will affect the administrative interface only, at this point.

	== Scope ==		== Scope ==
Line 79:		Line 80:
	==New Procedures==		==New Procedures==
	New procedures must be added to the database as per the DAL interface, to Create, Find, Edit and Delete Job Groups		New procedures must be added to the database as per the DAL interface, to Create, Find, Edit and Delete Job Groups

			==New Table EPL_USER_ACCESS_GROUPS==
			A new table must be added to validate user access against job groups.

			The table will be created as follows:
			<table border="1">
			<tr bgcolor="lightgrey">
			<td>Element</td><td>Type</td><td>Description</td>
			</tr>
			<tr>
			<td>(PK) EPL_SITE_ID</td><td>NCHAR (10)</td><td>Site or Warehouse code.</td>
			</tr>
			<tr>
			<td>(PK) EPL_JOB_GROUP</td><td>NCHAR (5)</td><td>Job Group.</td>
			</tr>
			<tr>
			<td>(PK) EPL_USER_ID</td><td>NCHAR(10)</td><td>User to be granted access to this group</td>
			</tr>
			</table>
			Note: There will be a 1:* relationship between users and access groups to allow for a user to have more than one access group.

			==New Procedures==
			New procedures must be added to the database as per the DAL interface, to Create, Find, Edit and Delete User Access Groups

	=Server Changes=		=Server Changes=
	==~~Data Access Layer~~ (DAL)==		==JOB GROUP (DAL)==
	A new DAL object must be added for the Job Groups table, as per the standard processing. This must allow:		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		*Finding Job Groups for a specific Site
Line 94:		Line 118:

	{{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.		{{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.

			==USER ACCESS GROUPS (DAL)==
			A new DAL object must be added for the User Access Group table, as per the standard processing. This must allow:
			*Finding User Access Group for a specific Site and User
			*Editing a User Access Group
			*Creating a new User Access Group
			*Deleting an existing User Access Group

			==Other Changes==
			The existing DAL’s will need to be modified to allow for a set of user access groups to be passed through and will return this set of data, this will need to be changed for both the Stored Procedures and the DAL’s for the following objects:
			*Jobs
			*Services
			*Service_Job

	=Client-Server Communications=		=Client-Server Communications=
Line 106:		Line 143:
	=Admin Changes=		=Admin Changes=
	==Services Maintenance==		==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 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 profile within User Access Groups.
			When finding Services, the Job Group filter should be a DDL of the available Job Groups for that user access profile, with an optional blank entry. Note that search should produce results for all jobs groups that the user has access to.
	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 profile.
			The Job Group DDL should show the Description of the Job Group, sequenced by Job Group.
	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~~.		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.

	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==		==Service Details==

	==Jobs Maintenance==		==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 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 access profile.
			When finding Jobs, the Job Group filter should be a DDL of the available Job Groups for that user access profile, with an optional blank entry. Note that search should produce results for all jobs groups that the user has access to.
	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 access profile.
			The Job Group DDL should show the Description of the Job Group, sequenced by Job Group.
	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~~.		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.

	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~~.		==Load Maintenance==
			No Changes, for the time being. This is so that all Job Groups can be planned onto any load.

	==Isotrak Service Upload==		==Isotrak Service Upload==
Line 236:		Line 268:
	==POD Production==		==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.		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.

			==USER ACCESS MAINTENANCE==
			This page will only be available to admin users.
			===Admin Functions:===
			Users will be able to search for users or job groups and will be displayed all data for that user or job group. The two fields are User and Job Group.
			Users can add or delete job groups.
			When adding data, admin users will have a dropdown list of all users, and a dropdown list of their current Job Groups. By default admin users will have access to all job groups.
			When deleting data users will be prompted for confirmation. If there is only one user assigned to a job group and there are still jobs associated to that group this will not allow deletion.


	=PDA=		=PDA=

Anw: v1.0 - Issued after review by Steve McCartney and Matt Turner

2011-09-14T08:18:41Z

v1.0 - Issued after review by Steve McCartney and Matt Turner

← Older revision		Revision as of 10:18, 14 September 2011
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.2}}		{{#vardefine:Version\|1.0}}
	{{#vardefine:Date\|~~13th~~ September 2011}}		{{#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]]

Anw: Slight format change

2011-09-13T14:09:57Z

Slight format change

← Older revision		Revision as of 16:09, 13 September 2011
Line 74:		Line 74:
	<tr><td>EPL_SERVICE_POSTWORK</td><td>NVARCHAR(1)</td><td>Whether this tab is required when processing Service jobs</td></tr>		<tr><td>EPL_SERVICE_POSTWORK</td><td>NVARCHAR(1)</td><td>Whether this tab is required when processing Service jobs</td></tr>
	<tr><td>EPL_LAST_CHANGED_DATE</td><td>INTEGER</td><td>Last time the record was modified</td></tr>		<tr><td>EPL_LAST_CHANGED_DATE</td><td>INTEGER</td><td>Last time the record was modified</td></tr>
	<tr><td>EPL_LAST_CHANGED_TIME</td><td>INTEGER</td></tr>		<tr><td>EPL_LAST_CHANGED_TIME</td><td>INTEGER</td><td></td></tr>
	</table>		</table>

Anw: v0.2 Added cost template

2011-09-13T13:30:24Z

v0.2 Added cost template

← Older revision		Revision as of 15:30, 13 September 2011
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.1}}		{{#vardefine:Version\|0.2}}
	{{#vardefine:Date\|13th September 2011}}		{{#vardefine:Date\|13th September 2011}}
	{{#vardefine:Reference\|291985}}		{{#vardefine:Reference\|291985}}
Line 254:		Line 254:
	{{Doc_Appendix		{{Doc_Appendix
	\|Appendix=A		\|Appendix=A
	\|Estimate=N		\|Estimate=Y
	\|Glossary=EPOD		\|Glossary=EPOD
	\|Ref1=		\|Ref1=
Line 261:		Line 261:
	\|REQ=0		\|REQ=0
	\|EST=0		\|EST=0
	\|FS=0		\|FS=0.5
	\|TS=0		\|TS=0
	\|DEV=0		\|DEV=8
	\|ST=0		\|ST=2
	\|IMP=0		\|IMP=0
	\|Client={{#var:Client}}		\|Client={{#var:Client}}
	\|Year=		\|Year=2011
	\|FSEST=N		\|FSEST=Y
	\|Rev1=Tony Walker		\|Rev1=Tony Walker
	\|Rev1Title=OBS Consultant		\|Rev1Title=OBS Consultant
	\|Rev2=~~Luke Miles~~		\|Rev2=Steve McCartney
	\|Rev2Title=OBS ~~Developer~~		\|Rev2Title=OBS Manager
	}}</div>		}}</div>
	[[Category:~~{{#var:Client}}~~ FS]]		[[Category:SM Fleet FS]]

Anw: v0.1 - Initial version for review

2011-09-13T11:57:14Z

v0.1 - Initial version for review

New page

<div class="noprint">
{{#vardefine:Client|PROD}}
{{#vardefine:ClientName|SM Fleet}}
{{#vardefine:System|''CALIDUS'' EPOD}}
{{#vardefine:Doc_Title|Job Groups}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|13th September 2011}}
{{#vardefine:Reference|291985}}
</div>
{{Doc_Title
|Client={{#var:ClientName}}
|System={{#var:System}}
|Title={{#var:Doc_Title}}
|Reference=FS {{#var:Reference}}
|Version={{#var:Version}}
|Date={{#var:Date}}
}}


<div class="noprint">
= 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:
<table width="100%" border="1">
<tr bgcolor="lightgrey"><td>Element</td><td>Type</td><td>Description</td></tr>
<tr><td>(PK) EPL_SITE_ID</td><td>NCHAR (10)</td><td>Site or Warehouse code.</td></tr>
<tr><td>(PK) EPL_JOB_GROUP</td><td>NCHAR (5)</td><td>Job Group.</td></tr>
<tr><td>EPL_DESCRIPTION</td><td>NCHAR(40)</td><td>Description of the Job Group</td></tr>
<tr><td>EPL_LOGO</td><td>NVARCHAR(MAX)</td><td>Logo for POD production</td></tr>
<tr><td>EPL_SERVICE_POD_FORMAT</td><td>NCHAR(10)</td><td>POD format</td></tr>
<tr><td>EPL_DELIVERY_POD_FORMAT</td><td>NCHAR(10)</td><td>POD format</td></tr>
<tr><td>EPL_COLLECTION_POD_FORMAT</td><td>NCHAR(10)</td><td>POD format</td></tr>
<tr><td>EPL_SERVICE_ACTIVITIES</td><td>NVARCHAR(1)</td><td>Whether this tab is required when processing Service jobs</td></tr>
<tr><td>EPL_SERVICE_PREWORK</td><td>NVARCHAR(1)</td><td>Whether this tab is required when processing Service jobs</td></tr>
<tr><td>EPL_SERVICE_INFO</td><td>NVARCHAR(1)</td><td>Whether this tab is required when processing Service jobs</td></tr>
<tr><td>EPL_SERVICE_PRODUCTS</td><td>NVARCHAR(1)</td><td>Whether this tab is required when processing Service jobs</td></tr>
<tr><td>EPL_SERVICE_MC_REF</td><td>NVARCHAR(1)</td><td>Whether this tab is required when processing Service jobs</td></tr>
<tr><td>EPL_SERVICE_DIAGNOSIS</td><td>NVARCHAR(1)</td><td>Whether this tab is required when processing Service jobs</td></tr>
<tr><td>EPL_SERVICE_POSTWORK</td><td>NVARCHAR(1)</td><td>Whether this tab is required when processing Service jobs</td></tr>
<tr><td>EPL_LAST_CHANGED_DATE</td><td>INTEGER</td><td>Last time the record was modified</td></tr>
<tr><td>EPL_LAST_CHANGED_TIME</td><td>INTEGER</td></tr>
</table>

==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.


{{Doc_Appendix
|Appendix=A
|Estimate=N
|Glossary=EPOD
|Ref1=
|RefV1=
|RefDate1=
|REQ=0
|EST=0
|FS=0
|TS=0
|DEV=0
|ST=0
|IMP=0
|Client={{#var:Client}}
|Year=
|FSEST=N
|Rev1=Tony Walker
|Rev1Title=OBS Consultant
|Rev2=Luke Miles
|Rev2Title=OBS Developer
}}</div>
[[Category:{{#var:Client}} FS]]