DuttonT: /* Functional Description */

2012-03-30T09:25:05Z

Functional Description

@@ Line 85: / Line 85: @@
 The report name will then be based on a concatenation of the Carrier id, the schedule name and the last whole numbers of the C-TMS trip_id:
 Filenames cannot contain any spaces or special characters (eg &). Therefore any spaces within the carrier id will be replaced with the underscore character (‘_’). Any ampersands (‘&’) will be replaced with the word ‘and’ any other special characters will be removed.
@@ Line 216: / Line 204: @@
 |}
 =AUTHORISED BY=

DuttonT: New page: {{Doc_Title|System=FUNCTIONAL SPECIFICATION|Title=Change the name of the e-mail file|Reference=FS 291489- AL-8L2D2E|Version=1.0|Date=02/09/2011|Sysver=10.7|Client=DHL C-TMS}} = Function...

2012-03-30T09:23:46Z

New page: {{Doc_Title|System=FUNCTIONAL SPECIFICATION|Title=Change the name of the e-mail file|Reference=FS 291489- AL-8L2D2E|Version=1.0|Date=02/09/2011|Sysver=10.7|Client=DHL C-TMS}} = Function...

New page

{{Doc_Title|System=FUNCTIONAL SPECIFICATION|Title=Change the name of the e-mail file|Reference=FS 291489- AL-8L2D2E|Version=1.0|Date=02/09/2011|Sysver=10.7|Client=DHL C-TMS}}

= Functional Overview =
== Client Requirement ==
'''Change Request Summary:'''

There is the requirement to change the name of the e-mail file sent out for the ‘Driver Manifest’ to display the manifest number.

'''Change Request Details:'''

This request is to change the naming convention of the ‘Driver Manifest’ report currently being used on the Openfield contract. Currently the reports are being produced on the e-mails with a name of ‘TaLive.pdf’ it has been requested that this be changed to ‘CARRIER_NAME-MANIFEST_NUMBER.PDF’ (where ‘CARRIER_NAME’ is the FULL name of the carrier requested to do the work and ‘MANIFEST_NUMBER’ is the number from the top of the manifest).

'''Benefits identified as a result of the change:'''

This will enable the carriers to identify the correct load when they are requested for information from the planning operation.

== Solution ==

The file name can be a maximum of 31 characters and cannot contain spaces.

The carrier name is too long and may contain spaces so the carrier ID will be used to identify the carrier of the trip.

The Manifest Number is determined within the report program and consists of the schedule name, trip ID and a subtotal calculated exclusively within the report and this generated manifest number is not held within C-TMS (for example. ‘110711-4714/ 01’)

To duplicate the code in the MSG_PROCESSING package to match the code in the OPENFIELD_DRVR_MAN report in order to generate the same manifest number would be cost prohibitive. Therefore, the following format will be used for the filename:

Carrier ID (with any spaces replaced with underscores and any special characters removed)

Separator (‘-‘)

Schedule Name

Separator (‘-‘)

Last 8 digits of the Trip ID sequence number with any leading zeroes removed

For example, ‘DAVEPOLLARDT-110711-4714.pdf’.

This will provide a unique value that should be sufficient to identify the correct e-mail easily.

'''NB Spaces and special characters such as & will be removed from the carrier ID prior to being used.'''

== Scope ==
This change will be applied to system version 10.7.0

= Set-up =
== Pre-requisites ==
None

== Menu Structure ==
Unchanged

== Data ==
No additional data

== Implementation Advice ==
A system super user should set the system parameter ‘TA_FILE_NAME’ to the value FORMAT1 in the system parameter maintenance screen.

[[Image:291489_1.png]]

= Functional Description =
Currently, when a message is processed, triggered by a trip being set to ACCEPTED status, the manifest report is attached and sent with the name TaLive.pdf. This name is assigned based on the value of the system parameter TA_FILE_NAME.

[[Image:291489_2.png]]

The system parameter will be set to the value ‘FORMAT1’ this will then be used by the Message Processing program to identify that the new format below should be used, this will allow future formats to be coded quickly.

The report name will then be based on a concatenation of the Carrier id, the schedule name and the last whole numbers of the C-TMS trip_id:

''<nowiki>**Developer Notes**</nowiki>''

''The format will be set as displayed below''

''CARRIER_ID||’-‘||SCHED_NAME||’-‘|| TRIM(LEADING 0 FROM SUBSTR(TRIP_ID,5,8))''

''LTRIM and REPLACE functions will be used to format the Carrier id and trip id to the required formats.''

Filenames cannot contain any spaces or special characters (eg &). Therefore any spaces within the carrier id will be replaced with the underscore character (‘_’). Any ampersands (‘&’) will be replaced with the word ‘and’ any other special characters will be removed.

Finally the last 8 digits of the trip id will be selected and any leading zeros will be removed. The formatted trip id will be combined with the formatted carrier id and schedule name to form the new file name.

In sample trip below the report would be named:CHRIS_LODGE-110719-4418.rdf

[[Image:291489_3.png]]

'''Table Updates Required'''

No table changes are required for this development

'''References'''

{| style="border-spacing:0;"
| style="background-color:#c0c0c0;border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>'''Ref No'''</center>
| style="background-color:#c0c0c0;border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>'''Document Title & ID'''</center>
| style="background-color:#c0c0c0;border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>'''Version'''</center>
| style="background-color:#c0c0c0;border:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>'''Date'''</center>

|-
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>1</center>
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| EST-291489 AL-8L2D2E Driver Manifest Email Change v1.0
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>1.0</center>
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>31/08/2011</center>

|-
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|

|-
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|

|}

'''Glossary'''

{| style="border-spacing:0;"
| style="background-color:#c0c0c0;border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>'''Term or Acronym'''</center>
| style="background-color:#c0c0c0;border:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>'''Meaning'''</center>

|-
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| C-TMS
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| Calidus TMS

|-
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|

|-
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|
| style="border-top:none;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|

|}

'''Document History '''

{| style="border-spacing:0;"
| style="background-color:#c0c0c0;border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>'''Version'''</center>
| style="background-color:#c0c0c0;border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>'''Date'''</center>
| style="background-color:#c0c0c0;border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>'''Status'''</center>
| style="background-color:#c0c0c0;border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>'''Reason'''</center>
| style="background-color:#c0c0c0;border:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>'''Initials'''</center>

|-
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>0.1</center>
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>31/08/2011</center>
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>Draft</center>
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| Initial version
| style="border:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>SEW</center>

|-
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>0.2</center>
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>01/09/2011</center>
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>Draft</center>
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| Reviewed
| style="border:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>MJC</center>

|-
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>0.3</center>
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>02/09/2011</center>
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>Draft</center>
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| Revised
| style="border:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>SEW</center>

|-
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>1.0</center>
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>02/09/2011</center>
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>Issue</center>
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| Reviewed and Issued
| style="border:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>MJC</center>

|-
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|
| style="border-top:0.018cm solid #000000;border-bottom:0.018cm solid #000000;border-left:0.018cm solid #000000;border-right:none;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|
| style="border:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"|

|}

=AUTHORISED BY=
{| Border="1"
| '''''Matt Crisford'''''
| Development Manager
|
|-
| '''''Peter Greer'''''
| TMSCC MTS Product Manager
|
|}

291489 - Revision history

DuttonT: /* Functional Description */

DuttonT: New page: {{Doc_Title|System=FUNCTIONAL SPECIFICATION|Title=Change the name of the e-mail file|Reference=FS 291489- AL-8L2D2E|Version=1.0|Date=02/09/2011|Sysver=10.7|Client=DHL C-TMS}} = Function...