View source for 286649

{{Doc_Title|System=FUNCTIONAL SPECIFICATION|Title=Integration EFX|Reference=FS 286649 PM-8ELN2W |Version=2.0|Date=|Sysver=10.6|Client=DHL MTS}}


== Client Requirement ==

'''Change Request Summary:'''

Integration EFX.


'''Change Request Details:'''

Replacement of current integration between EFX and Ethos in Openfield with integration between C-TMS and EFX. Includes new naming conventions to take account of a single instance of C-TMS with multiple accounts.


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

Continuation of current Openfield capabilities during transition to C-TMS.

== Solution ==

The existing process to send a file between C-TMS and EFX will be used by Openfield.

The process has been implemented in a different database and will be implemented in the INDTST and INDPRD databases for use by Openfield.

New directories specific to the customer group will need to be created to enable the outbound and inbound files to be processed.

The EFX files for Openfield may be distinguished by EFX from the files for any other client; the customer group will be used for the filename format of the EFX files for use in the creation of the outbound files in the different databases; the existing system parameter ‘EFX_IDENTIFIER’ may be used to identify files to be uploaded into C-TMS.

'''N.B. The development required by EFX/ESI is not included in this estimate.'''


== Scope ==
This change will be applied to system version 10.6. 

= Set-up =

== Pre-requisites ==

A new column will be added to the ‘ORG_CUSTOMER’ table for the ESI interfaces for EFX.

== Menu Structure ==
‘Unchanged’

== Data ==
A new tick box will indicate which customer groups will be included in the new EFX extract.

= Functional Description =

== Customer Groups ==

A new column called ‘EFX_GROUP’ will be added to the ‘ORG_CUSTOMER_GROUP’ table.

A tick box called ‘EFX Group’ will be added to the ‘Customer Group’ tab page of the ‘Customers’ screen in the ‘CUST_COST’ form to indicate if the customer group will be included in the EFX extract:


[[Image:286649_1.png]]


If the box is ticked then the column will be stored as ‘Y’ and if it is not ticked then the column will be stored as ‘N’.

See Appendix A for the creation of the new column.


== Files from C-TMS to EFX ==

The content of the files generated for transfer between C-TMS and EFX will not be changed, nor will the mechanism to generate the files.

The filename of the files will be changed to include the customer group so that the files for Openfield may be identified and processed differently by ESI and EFX. The customer group may be identified by the ‘EFX Group’ tick box for the customers with orders on the trips.


The filename formats for customer groups (e.g. ‘DHLOPE’ for Openfield) will become:

* ‘EFX_TRIP_DETAIL_{CUSTOMER_GROUP}_{SEQUENCE_NUMBER}.csv’
* ‘EFX_SUB_DETAIL_{CUSTOMER_GROUP}_{SEQUENCE_NUMBER}.csv’
* ‘CTMS_EFX_CANC_{CUSTOMER_GROUP}_{ DATE_TIME_STAMP}.csv’

The filename formats for the existing flows will remain as:


* ‘EFX_TRIP_DETAIL_{SEQUENCE_NUMBER}.csv’
* ‘EFX_SUB_DETAIL_{SEQUENCE_NUMBER}.csv’
* ‘MTS_EFX_CANC_{DATE_TIME_STAMP}.csv’

The customer group may be found for a customer with an order on the trip as it may be assumed that the trip will contain orders for a single customer group.

A new sequence number for Openfield files will be introduced with the name ‘SEQ_OPE_TRIP_DTL_MSG’.

The filenames ‘EFX_TRIP_DETAIL’ and ‘EFX_SUB_DETAIL’ are set in the procedure ‘INT_MSG.PROCESS_EFX_TRIP_DTL_MSG’ and the filename ‘CTMS_EFX_CANC’ is set in the procedure ‘INT_MSG.PROCESS_EFC_CANC’ and these procedures will be changed to set the required filename format described above depending on the customer group found.

The existing process to transfer files to EFX via ESI will be operative for all of the files produced.


== Files from EFX to C-TMS ==

The content of the files generated for transfer between EFX and C-TMS will not be changed, nor will the mechanism to generate the files.

The filename of the files will be changed to include the customer group so that the files for Openfield may be identified and processed differently by ESI and EFX. The customer group may be identified by the ‘EFX Group’ tick box for the customers with orders on the trips.

All of the files will be processed by the database job that runs procedure ‘INT_MSG.FILE_HANDLING’ if the files are placed in the existing directories with the filename formats identified by system parameter ‘EFX_IDENTIFIER’.

System parameter ‘EFX_IDENTIFIER’ may be ‘EFX_*’ and the format of the filenames received from EFX is expected to start with ‘EFX_’ and contain the customer group, if required, later in the filename.


For example:


‘EFX_TRIP_DETAILS_{CUSTOMER_GROUP}_{SEQUENCE_NUMBER}_{TIME_STAMP}.csv’


'''Table Updates Required'''

The new tick box may be created by the following script:


ALTER ORG_CUSTOMER_GROUP ADD EFX_GROUP VARCHAR2(1);
/



'''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-286649 PM-8ELN2W Integration EFX v1.0.doc
| 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>18/03/11</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>24/03/11</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>PDR</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>28/03/11</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;"| <center>1.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/03/11</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;"| Added new sequence number for Openfield files to EFX.
| style="border:0.018cm solid #000000;padding-top:0cm;padding-bottom:0cm;padding-left:0.191cm;padding-right:0.191cm;"| <center>PDR</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>2.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>14/04/11</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>Re-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;"| Re-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 
| 

|}