33
FTP PUSH/MAILBOX USER GUIDE FCA US INFORMATION & COMMUNICATION TECHNOLOGY MANAGEMENT

MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

  • Upload
    others

  • View
    11

  • Download
    0

Embed Size (px)

Citation preview

Page 1: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FTP PUSH/MAILBOX USER GUIDE

FCA US INFORMATION & COMMUNICATION TECHNOLOGY MANAGEMENT

Page 2: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 1 FCA US

EBMX Abstract The Electronic Business Message eXchange (EBMX) is built to be the premier automotive business-to-business message exchange. The EBMX allows FCA and its partners to exchange electronic business documents using standard Internet protocols. Message exchange is enabled from individual desktops or via highly integrated machine-to-machine communication. EBMX puts FCA and its trading partners in an optimum position to embrace new and developing systems, increase transaction speed, and promote 'just-in-time' processing. EBMX gains are realized through the entire supply chain! More information on EBMX can be found at our EBMX/EDI Homepage: https://ps.nafta.extra.fcagroup.com/sites/itb-ebus/Pages/Home.aspx [FCA direct link]

Page 3: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 2 FCA US

1. Overview

This document provides the trading partner with detailed information on how to utilize FCA’s Electronic Business Message eXchange (EBMX) FTP server and EBMX’s proprietary mailbox facility for sending and receiving messages to/from the EBMX system. The transport mechanism used for this communication is FTP over TCP/IP. Note that the EBMX FTP Server & Mailbox protocols are supported over any FCA supported network. FCA’s preference in using FTP is to implement it as PUSH-PUSH. Alternatively, the EBMX FTP Mailbox protocol may be used as a primary protocol (refer to section 1.2 Requirements and 1.4 Mailboxing).

This document is not intended to be a technical resource for FTP and/or the FTP servers and clients as implemented by FCA’s EBMX, nor its trading partners, nor is it intended to be a comprehensive error diagnostic resource.

1.1. Purpose

This document provides information for a Trading Partner to send and receive data to and from the Electronic Business Message eXchange (EBMX), using the TCP/IP protocol FTP. Outlined in detail are the requirements and steps for the Trading Partner to receive files from the EBMX in either a PUSH scenario – EBMX pushes data to your FTP server, or a PULL scenario – the trading partner pulls data from our mailbox. Regardless of PUSH/PULL for receiving data, all data sent to the EBMX is done the same way – PUT of files to the FTP server and a subsequent submit of the files to the EBMX system (refer to section 4 – Submitting Files via FTP).

1.2. Requirements

The requirements assume the Trading Partner already has the necessary software and/or services to create and send/receive EDI to/from EBMX.

The Trading Partner must provide FCA with the following: a. Access to a computer system connected to any FCA supported network. This also includes

sufficient settings/permissions to proxies or firewalls that would preclude FCA from placing a file on the Trading Partner's system.

b. User ID and password to above system c. List of personnel that can be contacted with problems or concerns that arise at any time. d. Support of multiple simultaneous logons by EBMX onto the Trading Partner FTP server. e. If the above requirements cannot/will not be met, then you must use FTP Mailboxing

(assuming you want to use FTP as a protocol) � refer to section: 1.4 Mailboxing – below.

1.3. Restrictions

For security reasons, the EBMX system will only send or receive data to a Trading Partner using FTP over FCA supported networks for such purposes. FCA can support only one (1) logon/password to connect to your systems. There cannot be a two-logon approach to gain access to system (ex: accessing a proxy server that requires a logon, then passing through to an FTP server that requires another logon.)

Page 4: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 3 FCA US

1.4. Mailboxing

The FTP mailbox facility for EBMX was developed to aid trading partners having difficulty with their FTP server software and/or firewall configurations. It can also be used as a means to retrieve failed messages that have expired retry processing in a PUSH scenario. Typically, for FTP, FCA prefers to “push” documents from the EBMX to the trading partner’s host via their FTP server. However, some trading partners have experienced technical difficulties and/or a lack of technical support in this regard. The FTP mailbox facility will allow trading partners to “pull” documents from FCA’s FTP server using their own FTP client. Again, if the FTP mailbox facility is used as a means to retrieve failed messages that have expired retry processing, we expect the trading partner to continue to use whatever protocol is currently in use to send messages to EBMX.

1.5. EBMX Support – E-Business Desk & FCA Service Desk

For initial support, please refer to: https://ps.nafta.extra.fcagroup.com/sites/itb-ebus/Pages/Home.aspx This is the main site for EBMX and EDI support documentation. More in-depth support can be requested via a ticket opened with FCA’s Service Desk. FCA’s Service Desk can be reached at: 1-800-332-9978 Please provide: • Your name • Your supplier code of inquiry/supplier code affected by issue • Your phone number – primary & alternate • Your email address • Short description of nature of the problem/issue Please inform the Service Desk that the ticket be routed to the EBMX ticket group. The trading partner is also encouraged to provide updates/changes in contact information in this way creating a ticket and routing it to: EBMX Finally, questions/requests for updates can be forward via email to: [email protected] Please note that priority is given to tickets over email-only requests.

Page 5: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 4 FCA US

2. Receiving via FTP (FTP PUSH)

2.1. System Access

2.1.1. Firewall Considerations

If your system is connected to a firewall, you are required to allow FCA access through the firewall. As all firewall software configurations are different, the trading partner must contact their firewall support staff to determine the proper configuration. The FTP client on EBMX will use ports 21 for control and 20 for data on both send and receive.

2.2. File Placement

2.2.1. File Placement for the FCA Group EDI Documents

FCA needs to logon to the trading partner’s system in order for EBMX to send data via FTP. FCA will require a user ID and password for the trading partner’s system to do this. When creating this logon ID, specify a home directory or file set with full read/write capability for EBMX to place files to. All EDI files created on the trading partner's system will be of the form: <DCXaaa>.Annnnn Or <CHRaaa>.Annnnn Where: ‘DCXaaa’/ ‘CHRaaa’ defines the transaction type contained in the file. (Please see the: “Application Identification Codes” document on the EDI website for a list of all EDI application codes). A = the letter A nnnnn = the number 00001 through 99999 Note: the qualifier, (Annnnn) derives the numeric portion from an EBMX internal file name and is not guaranteed to be unique. Over a several day period, a high volume-trading partner might see a recurrence of the qualifier. For this reason, any trading partner maintaining logs, audit trails, or file copies should take appropriate steps to ensure that confusion does not occur. A suggestion might be to rename the file using the date and time the file arrived as a part of the new name. In addition, the sequence number is not assigned by trading partner. The numbers are assigned across the entire EBMX system, and, therefore, an individual trading partner will see gaps in the sequence number portion of the file name. The trading partner should not expect to see consecutive sequence numbers on a consistent basis.

2.2.2. File Placement for Proprietary Files

For naming of proprietary files, the trading partner should contact the appropriate application. EBMX works with the application group and the trading partner to accommodate remote file naming for proprietary files – this is typically not determined solely by EBMX.

Page 6: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 5 FCA US

3. Mailboxing via FTP (FTP PULL)

This section is intended to introduce the trading partner to the fundamentals of the mailbox facility as implemented for the EBMX. The trading partner is introduced to the mailbox facility: from a brief overview, through the command structure required to use the system. Demonstrations of some typical document retrieval scenarios are covered in Appendix D. Some rudimentary trouble shooting scenarios are covered in Appendix E.

3.1. Overview

The FTP mailbox facility is implemented in two parts:

a mailbox repository of files that the EBMX has processed destined for a trading partner a mailbox subdirectory, residing under the trading partner’s home FTP directory, which

stores files created from the repository FCA has provided site-specific extensions to the FTP server to view the mailbox repository and access the mailbox repository to create mail in the mailbox subdirectory, which can then be transferred using the standard FTP (M)GET or RECV commands.

3.1.1. Mailbox Repository

This facility is provided to query the repository, which allows the trading partner to provide criteria, which determines which documents are listed. This list displays the document particulars of the documents satisfying the provided criteria. These particulars include:

the sender of the data, with respect to the FCA application of origin the document type the date and time it was created the size of the file the number of times the particular document has been mailboxed (i.e. copied from

repository to the subdirectory) the date and the time at which it was last mailboxed (i.e. copied from repository to

the subdirectory) This allows the trading partner to see what documents will get mailboxed if the same criteria is provided to the mail creation facility. The criteria provided and results can be iterated until the trading partner is satisfied with the resulting set of documents.

3.1.2. Mailbox Subdirectory

The second facility actually creates the mail to be transferred. Using the same criteria from the list facility, or different criteria, this facility creates the data in a MAILBOX sub-directory within the trading partner’s home FTP directory. The repository is also updated with respect to number of times the document was mailboxed and the last date and time of mailboxing. Using FTP standard (M)GETs or RECVs, the files can be FTPd to the trading partner’s site. The files can then be deleted from the mailbox sub-directory. Note that FCA is responsible for maintenance of the mailbox repository.

Page 7: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 6 FCA US

3.2. Commands

This section describes the various commands that are part of the mailbox implementation. These commands are: dcxsite, dcxmboxlist and dcxmboxcreate. The dcxmboxlist and dcxmboxcreate commands correspond to sections 3.1.1 and 3.1.2 above, respectively. The dcxsite command is provided to compensate for any FTP client issues with the FTP QUOTE command.

3.2.1. Mailbox Command: dcxsite

This command is provided for compatibility with various FTP client and firewall configurations. Some configurations/clients prevent/do not support the use of the FTP QUOTE and/or SITE command. This command serves as a ‘proxy’ command to be able to execute dcxmboxlist and dcxmboxcreate. Use of this command is described fully below in section 4 – Submitting Files via FTP.

3.2.2. Mailbox Command: dcxmboxlist

This command lists the contents of available messages that can be mailboxed. This command used without arguments will list all available messages that have never been mailboxed. The listing returned in the session will show the Tracking ID, sender, document type, creation date/time, number of times mailboxed, the last date/time of mailboxing and the size of the file in bytes. If a selected file for the listing has been purged from EBMX, the words DELETED will be displayed in the file size column. The documents to be displayed can be controlled through the use of arguments as follows:

-all This argument is provided to allow the trading partner to select all documents

available for mailboxing. In the absence of this parameter, only those that have never been mailboxed will be selected. This parameter, unlike the following, has no value associated with it.

-ti This argument is provided to allow the trading partner to specify one or more tracking IDs to select. Tracking IDs are specified as a sequence of the –ti parameter followed by a value. Multiple iterations of the ti argument may be used to select multiple tracking IDs. The Tracking ID is a unique number used by the EBMX. It is provided as a unique identifier to select documents by. An example of this parameter’s use is: dcxmboxlist –ti 123 –ti 456 –ti 789 This example would select three documents, having tracking IDs 123, 456, and 789 if they exist as available messages. If they do not exist, they will not cause an error.

-se This argument is provided to allow the trading partner to specify one or more senders – or, applications of origin – such as STARS, EDI, LOOPTEST, etc. These values are pre-defined by FCA in EBMX. Senders are specified as a sequence of the –se parameter followed by a value, potentially followed again by –se followed by a value etc. It is provided as a convenient method to select documents for trading partners who do business with FCA across different functional areas. An example of this parameter’s use is: dcxmboxlist –se STARS –se EDI This example would select all documents originating in STARS or EDI if they exist as available messages. If they do not exist, they will not cause an error.

Page 8: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 7 FCA US

-ft This argument is provided to allow the trading partner to specify one or more file

types – also referred to as document types or application types. These values are predefined by FCA in EBMX. File types are specified as a sequence of the –ft parameter followed by a value, potentially followed again by –ft followed by a value etc. It is provided as a convenient method to select specific documents. An example of this parameter’s use is: dcxmboxlist –ft DCX46 –ft DCX997 This example would select all documents of type DCX46 or DCX997 if they exist as available messages. If they do not exist, they will not cause an error.

-df This argument is provided to allow the trading partner to specify a start date/time to use to select against the creation date of available documents. A maximum of one from date may be specified. The date MUST be in the form: YYYY-MM-DD:HH:MI:SS, where HH is expressed in 24 hour format. If more than one from date is specified, or, if specified in the wrong format, it will be treated as an error. It is provided as a convenient method to select specific documents processed by EBMX within a certain time frame. An example of this parameter’s use is: dcxmboxlist –df YYYY-MM-DD:HH:MI:SS This example would select all documents created on or after the specified valid date/time.

-dt This argument is provided to allow the trading partner to specify an end date/time to use to select against the creation date of available documents. Rules for use for the –dt argument: - If the –dt argument is specified, the -df argument must also be specified. - A maximum of one (1) to date may be specified. - If the –df argument is specified without –dt, this will be treated as valid. A –dt argument with a value of the current date/time will be assumed. - The date MUST be in the form: YYYY-MM-DD:HH:MI:SS, where HH is expressed in 24 hour format. - If more than one from date is specified, or, if specified in the wrong format, it will be treated as an error. It is provided as a convenient method to select specific documents processed by EBMX within a certain time frame. An example of this parameter’s use is: dcxmboxlist –df YYYY-MM-DD:HH:MI:SS –dt yyyy-mm-dd:hh:mi:ss This example would select all documents created on or after YYYY-MM-DD:HH:MI:SS up to and including those documents created on or before yyyy-mm-dd:hh:mi:ss.

Page 9: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 8 FCA US

Note: The above arguments can be combined to create selection criteria that selects all documents – both those that have and have not been mailboxed – for a list of tracking IDs and a list of senders and a list of document types and a date range, or any combination thereof. The following example would result in the selection of all documents that have/have not been mailboxed, originating from STARS or EDI that are also of document type DCX01 or DCX02 that were created between YYYY-MM-DD:HH:MI:SS and yyyy-mm-dd:hh:mi:ss inclusive. dcxmboxlist –all –se STARS –se EDI –ft DCX01 –ft DCX02 –df YYYY-MM-DD:HH:MI:SS –dt yyyy-mm-dd:hh:mi:ss

3.2.3. Mailbox Command: dcxmboxcreate

This command creates the mail from the repository in the mailbox subdirectory. The command, used without arguments, will create mail for all available messages that have never been mailboxed. The listing returned in the session will show the Tracking ID and the filename of the files created in the trading partner’s mailbox subdirectory. The mailbox subdirectory is the MAILBOX directory residing under the home FTP directory. See the Retrieving Documents section for further details. The dcxmboxcreate command utilizes the same argument structure as dcxmboxlist – please refer to the above chart for examples. If a selected file for mailboxing has been purged from EBMX – and, therefore, purged from the mailbox repository, the word DELETED will appear in the file name column. If an error was encountered in creating a particular piece of mail, the word ERROR will appear in the file name column. If one of these ERRORs occurs, please contact the E-business desk per the above section.

Page 10: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 9 FCA US

4. Submitting files via FTP (Either PUSH or PULL)

The EBMX processes inbound data to FCA in a two-step process: 1. A traditional FTP PUT of the data to the EBMX FTP server 2. A registration process of the file – a submit – that identifies the sender, receiver and type of

data as well as the file name of the data PUT This approach differs from other ‘file sweeper’ approaches that infer sender, receiver and type of data from file naming characteristics or directory hierarchy of where the file was PUT. This section is intended to familiarize the reader with the submit command – the process used to register data with EBMX. The following subsections cover the submit command in a general case, followed by specific examples for the LOOPTEST – used to test connectivity to FCA/EBMX, Real-Time EDI submissions for ASN (856) and STARS (214), and Batch EDI (typically, all ‘other’ EDI transactions). Specific cases not addressed here should be brought up to EBMX support (see section 5) and/or the responsible application area. NOTE: In the below examples, <remote-host> is used as a ‘place holder’ for the actual IP/DNS of the EBMX FTP server as identified in your network. Since the IP/DNS vary by network and are subject to further network manipulation by your network/security support staff, please refer to your support staff for the correct host name address to use. Due to a few issues regarding the various FTP client/firewall configurations utilized by FCA’s trading partners, we have also provided a default SITE command – DCXSITE. The most typical configuration will allow the trading partner to enter the FTP QUOTE command to do a dcxsubmit. This same mechanism will be used for the mailbox commands: dcxmboxlist and dcxmboxcreate describe above in section 3 – Mailboxing via FTP. If there is difficulty using QUOTE DCXSUBMIT, and the SITE or QUOTE SITE commands are being used in order for the submits to work, the following paragraphs are also applicable. Certain FTP client/firewall configurations will not allow quoted commands, forcing the client to issue a SITE command. Other configurations do not recognize SITE as a valid command for the FTP client, forcing the use of QUOTE SITE. In order to issue submits that work for these trading partners, the current default SITE command is DCXSUBMIT. Typical submits done in this fashion appear as: SITE –se <sender> -pw <password> -re <receiver> -ft <file type> -fn <file name> Or QUOTE SITE –se <sender> -pw <password> -re <receiver> -ft <file type> -fn <file name>

Page 11: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 10 FCA US

While the DCXSITE command is run indirectly when trading partners issue a SITE or QUOTE SITE command, the trading partner needs to be aware of its existence. Note that submits will continue to work in the fashion described above. However, for the new FTP Mailbox commands, trading partners will have to utilize the following: SITE DCXMBOXLIST And SITE DCXMBOXCREATE Which are the companions to: SITE –se <sender> -pw <password> -re <receiver> -ft <file type> -fn <file name> Or, QUOTE SITE DCXMBOXLIST And QUOTE SITE DCXMBOXCREATE Which are the companions to: QUOTE SITE –se <sender> -pw <password> -re <receiver> -ft <file type> -fn <file name> FCA prefers the following syntax for submits, as it is more ‘obvious’ and more supportable for any future change: SITE DCXSUBMIT –se <sender> -pw <password> -re <receiver> -ft <file type> -fn <file name> Or QUOTE SITE DCXSUBMIT –se <sender> -pw <password> -re <receiver> -ft <file type> -fn <file name>

Page 12: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 11 FCA US

4.1. Submitting Files via FTP Example

This section covers the general case of the submit command. The parameters used will correspond to the data you are sending to FCA/EBMX and the eventual receiving application.

4.1.1. Parameter Description

All parameters are required: Parameter Name Parameter Description -se Sender ID, -pw Password of Sender ID. -re Receiver ID -fn Name of file placed “PUT” on system. -ft File type.

Please note that parameters are case sensitive.

4.1.2. Example Session 1. Start an FTP session. 2. open <remote-host> 3. Logon using trading partner ID and password 4. The following commands must be done in the FTP session: a. put <filename> b. quote dcxsubmit -se <sender> -pw <password> -re <receive> -fn <filename> -ft <file-type> * If a Trading Partner’s firewall does not accept ‘quote dcxsubmit’, see section 3.1.4:Other Command Syntax for additional syntax. * For how to properly name files, please see Appendix C – File Name Requirements The following output will be received if the submit was successful:

200-Executing site command handler..... Done. File Submitted to ECXpert File Registered with ECXpert as Tracking ID nnn. 200 * * * * * * * * *

4.1.3. Expected Results

If the ‘dcxsubmit’ was successful; a Tracking ID number will be issued to use as a reference and confirmation of receipt by the EBMX. The submitted file is deleted from the directory. The absence of a Tracking ID means the file was not successfully processed. In this case the file is not deleted from the directory and needs to be resubmitted. See Appendix A, Sample FTP session, for additional information.

Page 13: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 12 FCA US

4.1.4. Other Command Syntax

If the trading partner’s firewall does not accept the ‘quote dcxsubmit’ command above, the following syntax has been shown to work:

quote site -se <sender> -pw <password> -re <receive> -fn <filename> -ft <file-type>

quote dcxsubmit <sender> -pw <password> -re <receive> -fn <filename> -ft <file-type>

site -se <sender> -pw <password> -re <receive> -fn <filename> -ft <file-type>

site dcxsubmit -se <sender> -pw <password> -re <receive> -fn <filename> -ft <file-type>

Page 14: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 13 FCA US

4.2. Submitting Initial Loop-Back Test

This section covers the LOOPBACK initial test. It will be completed by the trading partner to test network configuration and access. The trading partner will submit a file that is immediately sent back to test access through firewalls and ability for data to be delivered through EBMX.

4.2.1. Parameter Description

All parameters are required: Parameter Name Parameter Description -se Sender ID, -pw Password of Sender ID. -re LOOPTEST -fn Name of file placed “PUT” on system. -ft LOOPBACK

Please note that parameters are case sensitive.

4.2.2. Example Session

1. Start an FTP session. 2. open <remote-host> 3. Logon using trading partner ID and password 4. The following commands must be done in the FTP session: a. put <filename> b. quote dcxsubmit -se <sender> -pw <password> -re LOOPTEST -fn <filename> -ft LOOPBACK * If a Trading Partner’s firewall does not accept ‘quote dcxsubmit’, see section 3.1.4:Other Command Syntax for additional syntax. * For how to properly name files, please see Appendix C – File Name Requirements The following output will be received if the submit was successful:

200-Executing site command handler..... Done. File Submitted to ECXpert File Registered with ECXpert as Tracking ID nnn. 200 * * * * * * * * *

4.2.3. Expected Results

If the ‘dcxsubmit’ was successful, a Tracking ID number will be issued to use as a reference and confirmation of receipt by the EBMX. The submitted file is deleted from the directory. The absence of a Tracking ID means that the file was not successfully processed. In this case, the file is not deleted from the directory and needs to be resubmitted. See Appendix A, Sample FTP session, for additional information. The Trading Partner will also receive a file named: 'LOOPTEST.Annnnn' (see section 2.2 File Placement for explanation of ‘Annnnn’).

Page 15: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 14 FCA US

4.3. Real Time Data Submission via FTP

EBMX will recognize two types of EDI transactions – Real Time and Batch. Real Time transactions include ASN/ASC (856) and STARS 214. All other EDI and VICS/VISTA transactions are Batch processed.

4.3.1. Submitting ASN/ASC (856) via FTP

EBMX will not process ASN/ASC transactions larger than 300k. If ASN/ASC’s are larger than this they will need to be separated into multiple submissions smaller than 300k. The following error message will be returned within the FTP session if file size exceeds 300k: “FILE NOT PROCESSED. MAX FILE SIZE 300K LIMIT EXCEEDED” Note: for Freight Consolidators sending in ASCs element ISA08 should be 04000FC. This instructs the CHASE system to process the 856 as an ASC rather than as an ASN. This is required for Freight Consolidators using the EBMX directly or other VAN). A detailed session for Real Time ASN/ASC transactions is contained in following section:

4.3.1.1. ASN/ASC (856) Parameter Description

All parameters are required: Parameter Name Parameter Description -se Sender ID, -pw Password of Sender ID. -re CHASE -fn Name of file placed “PUT” on system. -ft EDIX12

Please note that parameters are case sensitive.

4.3.2. Submitting STARS 214 Transaction via FTP

A detailed session for Real Time STARS 214 transactions is contained in following section: DO NOT USE THIS FEATURE UNTIL DIRECTED TO DO SO BY FCA!

4.3.2.1. STARS Parameter Description

All parameters are required: Parameter Name Parameter Description -se Sender ID, -pw Password of Sender ID. -re STARS -fn Name of file placed “PUT” on system. -ft EDIX12

Please note that parameters are case sensitive.

Page 16: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 15 FCA US

4.4. Batch Data Submission via FTP

EBMX will recognize two types of EDI transactions – real time and batch. Real time transactions include ASN/ASC (856) and STARS (214). Batch transmissions include EDI other than 856/214 and VICS/VISTA.

4.4.1. Submitting Batch Transactions

NOTE: In the below examples, <remote-host> is used as a ‘place holder’ for the actual IP/DNS of the EBMX FTP server as identified in your network. Since the IP/DNS vary by network and are subject further network manipulation by your network/security support staff, please refer to them for the correct host name address to use.

4.4.1.1. EBMX Submit Parameter Requirements

The following parameters are required and are case sensitive:

Sender (-se) Password (-pw) Receiver (-re) Filename (-fn) Filetype (-ft)

The values of following parameters apply to all applications:

Sender (-se) Password (-pw) Filename (-fn)

The following table shows the required Receiver (-re) and Filetype (-ft) for the respective application:

Application Receiver (-re) Filetype (-ft)

EDI (other than 856/214) EDI EDI EDIX12

VICS/VISTA – PRODUCTION VICS/VISTA Production (510, 520, 530, 540, 550, & 630)

VISTA EDIX12

VISTA 127 – Carrier Baying Order VISTA PHOLD VICS 824, 926, 928, & 997 VICS EDIX12

VICS/VISTA – TESTING VICS/VISTA – Test (Test VISTA 510, 520, 530, 540, 550, & 630)

VISTT EDIX12

Test VISTA 127 – Carrier Baying Order VISTT PHOLD Test VICS 824, 926, 928, & 997 TVICS EDIX12

Modular Provider

Modular Provider - Tier 1 to Modular Provider Tier 2

Receiver ID, prefixed with ‘MS2’

MSEDIX12

Modular Provider - Tier 2 to Modular Provider Tier 1

Receiver ID, prefixed with ‘MS1’

MSEDIX12

Page 17: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 16 FCA US

4.4.1.2. Example Session

The following is an example session using the Receiver (-re) value of ‘EDI’ and Filetype (-ft) value of ‘EDIX12’:

1. Start an FTP session. 2. open <remote-host> 3. Logon using trading partner ID and password 4. The following commands must be done in the FTP session:

a. put <filename> b. quote dcxsubmit -se <sender> -pw <password> -re <receiver> -fn <filename> -ft <filetype>

Note: the appropriate values for receiver and filetype should be from the table in the previous section. * If a Trading Partner’s firewall does not accept ‘quote dcxsubmit’, see section 3.1.4:Other Command Syntax for additional syntax. * For how to properly name files, please see Appendix C – File Name Requirements The following output will be received if the submit was successful:

200-Executing site command handler..... Done. File Submitted to ECXpert File Registered with ECXpert as Tracking ID nnn. 200 * * * * * * * * *

4.4.1.2.1. Expected Results

If the ‘dcxsubmit’ was successful, a Tracking ID number will be issued to use as a reference and confirmation of receipt by the EBMX. The submitted file is deleted from the directory. The absence of a Tracking ID means that the file was not successfully processed. In this case, the file is not deleted from the directory and needs to be resubmitted. See Appendix A, Sample FTP session, for additional information.

Page 18: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 17 FCA US

5. Retry Handling - Undeliverable Messages (FCA to Trading Partner)

The EBMX will attempt to send (PUSH) any EDI or proprietary formatted message to a trading partner using FTP PUSH as soon as the EBMX receives the messages from the source application. The PUSH mode assumes that the trading partner’s FTP server will be up and running on a 7 x 24 x 365 basis. Recognizing that this cannot always be the case, EBMX has implemented a series of message retry strategies. These strategies operate in such a way that whenever EBMX tries to deliver a message to a trading partner and is unsuccessful, EBMX will wait a configured period of time and try again at the end of that time period. It will try repeatedly until a certain number of retry attempts have been made. When the specified number of retry attempts have been made, the message will be logically copied to a directory on EBMX. The message can then be accessed directly by the trading partner. Simultaneously, an email message will be generated and sent to the trading partner in addition to all concerned parties at FCA. The email message is sent to the address that the trading partner specified in the EBMX subscription submission. This address can be a distribution list if the trading partner so desires. EBMX requests that the notification email be a generalized address for the trading partner’s company rather than an individual. The trading partner can change the current email address by submitting a request to the Help Desk and request that the ticket be routed to the EBMX. The Help Desk can be reached at: 1-800-332-9978. When communicating with the Help Desk, please provide the supplier code being referenced and the email address to be used in the future. Failure to provide this information may result in a change not being made because the trading partner’s membership record cannot be found. The retry strategy used for each message will depend on the FCA priority of the message content. An example table is provided below:

Priority Attempts Interval

(Minutes) Example 10 [high] 12 5 ASR (response to an ASN)

20 [medium] 24 15 862 SDS; ASN copies/ASCs [EDI 856]

40 [low] 24 30 846 Pay as Built; 830 Release; 850 Purchase Order

80 [special] 2 1 LOOPTEST file

Page 19: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 18 FCA US

An example of the email that will be sent is as follows: NOTE: <doc-type>, <sender>, <receiver>, <YYYY-MM-DD:HH24:MI:SS.FF>, <trkID>, Annnnn are ‘place-holders’ for the real data in the below example. These are all as explained above. The <YYYY-MM-DD:HH24:MI:SS.FF> field is a timestamp, in 24H clock – ET – of when the file was accepted by EBMX from the originating system for processing.

Subject: EBMX Delivery Failure Notice (<doc-type>) An EBMX message destined for your server has expired a set of retry attempts and has been stored in a subdirectory. Here is some relevant information regarding the failed transmission: Sender: <sender> Receiver: <receiver> Doctype: <doc-type> Date/time: <YYYY-MM-DD:HH24:MI:SS.FF> Tracking ID: <trkID> A copy of this file has been retained for you on our system in the following location accessible via the EBMX FTP server: ./FTP_ERROR/<doc-type>.Annnnn Please perform an FTP GET session to pick up your message using the relative path (to your login home directory) and filename above. Please delete the file after a successful GET. Help can be found in the EBMX FTP User guide under the section: Retry Handling. The EBMX FTP Mailbox protocol can also be used for this purpose, if desired, and is also documented in this guide. The EBMX HTTPS Mailbox protocol may also be used for this purpose. Please refer to the following URL for info: https://ps.nafta.extra.fcagroup.com/sites/itb-ebus/Pages/Home.aspx Messages are retained in the subdirectory for only a few days, so you should get (retrieve) the message right away. Afterwards, you should review your system and network to check for reasons why the message could not be delivered. Further questions or issues should be addressed to the FCA LLC Help Desk at 1-800-332-9978. Please have the trouble ticket routed to EBMX. Thank you

Upon receipt of the email above, the trading partner is must retrieve the file and subsequently delete the file. EBMX support personnel will make no further attempt to ensure that the message is delivered to the trading partner. It is the responsibility of the trading partner to ensure that this message is delivered.

Page 20: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 19 FCA US

An example session to get the file follows: NOTE: in the below example, <remote-host> is as explained above. The <remote-port> refers to the data port opened on the EBMX server. The <user-id> represents the logged on user of the FTP client. The <tpid> represents the trading partner code/receiver of the document – this is your EBMX log in with <password>. The <doc-type>.Annnnn is per above email. >ftp <remote-host> Connected to <remote-host>. 220 <remote-host> ECXFTP server (Version 1.0) ready. Name (<remote-host>:<user-id>): <tpid> 331 Password required for <password>. Password: 230 User <tpid> logged in. ftp> cd FTP_ERROR 250 CWD command successful. ftp> get <doc-type>.Annnnn 200 PORT command successful. 150 Open ASCII mode data connection for <doc-type>.Annnnn (<remote-host>,<remote-port>). 226 transfer complete. local: <doc-type>.Annnnn remote: <doc-type>.Annnnn 38 bytes received in 0.065 seconds (0.57 Kbytes/s) ftp> del <doc-type>.Annnnn 250 DELE command successful. ftp> quit 221 Goodbye. The trading partner should expect to have received the file with the filename described in the email notification and should have deleted the file from the FTP_ERROR directory.

Page 21: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 20 FCA US

Appendix A – Sample FTP session NOTE: in the below examples, <remote-host> is as explained above. The <remote-port> refers to the data port opened on the EBMX server. The <user-id> represents the logged on user of the FTP client. The <tpid> represents the trading partner code/receiver of the document – this is your EBMX log in with <password>. Appendix A.1 Successful Text in bold is user supplied commands/responses. ftp <remote-host> Connected to <remote-host>. 220 <remote-host> ECXFTP server (Version 1.0) ready. Name (<remote-host>:<user-id>): <tpid> 331 Password required for <tpid>. Password: <password> 230 User <tpid> logged in. ftp> put testfile 200 PORT command successful. 150 Open ASCII mode data connection for testfile (<remote-host>,<remote-port>). 226 transfer complete. local: testfile remote: testfile 208989 bytes sent in 0.27 seconds (755.89 Kbytes/s) ftp> quote dcxsubmit -se testid -pw <password> -re EDI -fn testfile -ft EDIX12 200-Executing site command handler..... Done. File Submitted to ECXpert File Registered with ECXpert as Tracking ID <trkID>. 200 * * * * * * * * *

Page 22: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 21 FCA US

Appendix A.2 Errors ftp <remote-host> Connected to <remote-host>. 220 <remote-host> ECXFTP server (Version 1.0) ready. Name (<remote-host>:<user-id>): <tpid> 331 Password required for <tpid>. Password: <password> 230 User <tpid> logged in. ftp> put testfile 200 PORT command successful. 150 Open ASCII mode data connection for testfile (<remote-host>,<remote-port>). 226 transfer complete. local: testfile remote: testfile 208989 bytes sent in 0.26 seconds (784.96 Kbytes/s) ftp> quote dcxsubmit -se testid -pw <password> -er EDI -fn testfile -ft EDIX12 200-Executing site command handler..... Done. One of the required tags is missing. The tags -se, -re, -ft, -fn are required. Usage : quote dcxsubmit -lg -se xxx -pw xxx -re xxx -ft xxx -fn xxx -sd Optional Parameters are : -lg, -pw and -sd * * * * * * * * * 200 An error occurred preventing submission of file to ECXpert. ftp <remote-host> Connected to <remote-host>. 220 <remote-host> ECXFTP server (Version 1.0) ready. Name (<remote-host>:<user-id>): <tpid> 331 Password required for <tpid>. Password: <password> 230 User <tpid> logged in. ftp> put testfile 200 PORT command successful. 150 Open ASCII mode data connection for testfile (<remote-host>,<remote-port>). 226 transfer complete. local: testfile remote: testfile 208989 bytes sent in 0.27 seconds (755.89 Kbytes/s) ftp> quote dcxsubmit -se invalid -pw <password> -re EDI -fn testfile -ft EDIX12 200-Executing site command handler..... Done. 200 Submission Failed. Note: When the dcxsubmit command fails, the file being submitted is not deleted. The dcxsubmit command must be corrected and reissued before putting with the same file name. If a "put" with the same file name is attempted an error will occur on the put due to the file being duplicate. It is the trading partners responsibility to ensure that a Tracking Id is issued. This confirms that the dcxsubmit was successful.

Note: parameter in error

Note: parameter in error

Page 23: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 22 FCA US

Appendix B – EBMX Supported FTP commands The following chart contains the FTP commands supported by the EBMX FTP server.

FTP Command

FTP Client Equivalent

Purpose

USER user User name PASS — Password transparent to the user PORT — Port number to connect to transparent to the user STOR put Upload files to the remote machine QUIT quit End ftp session TYPE type/binary/ascii Set file transfer type PWD pwd Get current working directory NLST ls Directory listing (only file names) LIST dir Complete directory listing RETR get Download files from remote machine SITE quote Run a site command, such as “submit” NOOP — No operation transparent to the user HELP remotehelp List of commands supported by the FTP server

NOTE: other commands are NOT supported and may or may not return an error when executed (i.e., they are either ignored or return an error indicating they are not supported).

Page 24: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 23 FCA US

Appendix C – File Name Requirements The following rules should be adhered to when creating file names:

Valid file names should consist of upper and lower case alphabetic characters, numbers, underscores and periods.

Embedded spaces are not allowed. Special characters are not allowed. Typically, we expect the trading partner to name each file distinctively (i.e., include a

sequence number and/or a timestamp) – we discourage the use of the same name for different files to minimize the occurrence of overlaying files or submitting the wrong file to the wrong trading relationship.

File name length should be no more than 100 characters.

Page 25: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 24 FCA US

Appendix D – Mailbox: Retrieving Documents The following sections show an example of logging on to the FTP server, checking the home directory, and checking the mail repository. The examples continue with a SUBMIT of a LOOPTEST file and retrieving it back out of the repository and downloading it. An artificial trading partner – FTPmailbox – is used for illustration purposes in these examples. It is to be replaced with the trading partner’s assigned code and password in actual use of the mailbox facility. Also in the below examples, it is assumed that you are already connected to the EBMX FTP server. For details on this, refer to: “EBMX FTP User Guide”. <remote-host> is used as a ‘place holder’ for the actual IP/DNS of the EBMX FTP server as identified in your network. Since the IP/DNS vary by network and are subject further network manipulation by your network/security support staff, please refer to them for the correct host name address to use. APPENDIX D.1 - Logging on Log on as per normal to the EBMX FTP server. If assistance is required with this process, please refer to the FTP User’s Guide. Name: FTPmailbox 331 Password required for FTPmailbox. Password: 230 User FTPmailbox logged in. ftp> APPENDIX D.2 – Contents of the Home Directory After logging on to the EBMX FTP server, the home directory will be the current directory. Each trading partner will have their own home directory, named after their trading partner ID. For security reasons, the directory cannot change up beyond this point. If this is the first time logging in, there is no mail and/or files in the directory and the following will be displayed: ftp> dir 200 PORT command successful. 150 Open ASCII mode data connection for LIST (129,9,201,23,176,33). Type Size Time Stamp File/Directory Name ----------------------------------------------------------------------- 226 transfer complete. 139 bytes received in 0.0098 seconds (13.89 Kbytes/s) ftp>

Page 26: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 25 FCA US

APPENDIX D.3 – Check for Mail in the Mailbox Repository The mailbox repository should be checked for any mail. The FTP QUOTE dcxmboxlist command should be used without arguments. The following should be displayed: The following shows the result of the dcxmboxlist of any mail that has not been retrieved: ftp> quote dcxmboxlist 200-Executing site command handler..... Done. Command being processed by DCXMBOXLIST... Contents of mailbox for FTPmailbox.... TRACKING DOCUMENT DOCUMENT CREATION DATE #Xs LAST MAILBOXED SIZE IN ID SENDER TYPE YYYY-MM-DD:HHMMSS MB YYYY-MM-DD:HHMMSS BYTES --------- -------- -------- ----------------- --- ----------------- -------- 501 LOOPTEST LOOPTEST 2002-05-31:192021 0 31 1 Files listed 200 ftp> The following shows the result of the dcxmboxlist command if there is no mail to be retrieved: ftp> quote dcxmboxlist 200-Executing site command handler..... Done. Command being processed by DCXMBOXLIST... Contents of mailbox for FTPmailbox.... TRACKING DOCUMENT DOCUMENT CREATION DATE #Xs LAST MAILBOXED SIZE IN ID SENDER TYPE YYYY-MM-DD:HHMMSS MB YYYY-MM-DD:HHMMSS BYTES --------- -------- -------- ----------------- --- ----------------- -------- MAILBOX IS EMPTY! 200 ftp>

Page 27: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 26 FCA US

APPENDIX D.4 - Submit a LOOPTEST To get the mailbox repository populated, submit a LOOPTEST. This is part of the normal trading partner rollout process. For this example, FCA will put a file called LOOPTEST.txt to the FTP home directory and then submit it. Note that this is also documented in the FTP User’s Guide, but repeated here for convenience. ftp> put /tmp/LOOPTEST.txt LOOPTEST.txt 200 PORT command successful. 150 Open ASCII mode data connection for LOOPTEST.txt (129,9,201,23,170,169). 226 transfer complete. local: /tmp/ LOOPTEST.txt remote: LOOPTEST.txt 38 bytes sent in 0.00035 seconds (105.13 Kbytes/s) After FCA has PUT the file, the DIR command should be issued to confirm directory contents and see the LOOPTEST.txt file. ftp> dir 200 PORT command successful. 150 Open ASCII mode data connection for LIST (129,9,201,23,252,76). Type Size Time Stamp File/Directory Name ----------------------------------------------------------------------- File 31 May 31 16:09:33 2002 LOOPTEST.txt 226 transfer complete. 195 bytes received in 0.0061 seconds (31.14 Kbytes/s) FCA will then issue the submit command. The FTP quote command is used to submit the file. ftp> quote dcxsubmit -se FTPmailbox -pw ******** -re LOOPTEST -ft LOOPBACK -fn LOOPTEST.txt 200-Executing site command handler..... Done. File Submitted to ECXpert File Registered with ECXpert as Tracking ID 1570. 200 * * * * * * * * * As the submit of the file was successful, the DIR command should be issued again to check directory contents. This will show that the submitted file has been deleted by EBMX. ftp> dir 200 PORT command successful. 150 Open ASCII mode data connection for LIST (129,9,201,23,139,35). Type Size Time Stamp File/Directory Name ----------------------------------------------------------------------- 226 transfer complete. 139 bytes received in 0.012 seconds (10.97 Kbytes/s) As is the case with the submitted file, the returned LOOPTEST document will not be shown either.

Page 28: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 27 FCA US

APPENDIX D.5 - Create Mail in the MAILBOX Subdirectory To create a mail file in the mailbox subdirectory (i.e. MAILBOX under the home directory), the dcxmboxcreate command should be used. The FTP QUOTE dcxmboxcreate command should be used with no arguments. The following should be displayed: ftp> quote dcxmboxcreate 200-Executing site command handler..... Done. Command being processed by DCXMBOXCREATE... The following mail was created for FTPmailbox in your MAILBOX subdirectory: TRKID FILENAME --------- ---------------------------------------------------------------- 501 LOOPTEST.A196 1 Files mailboxed 200 ftp> The QUOTE dcxmboxlist command should be run again. ftp> quote dcxmboxlist 200-Executing site command handler..... Done. Command being processed by DCXMBOXLIST... Contents of mailbox for FTPmailbox.... TRACKING DOCUMENT DOCUMENT CREATION DATE #Xs LAST MAILBOXED SIZE IN ID SENDER TYPE YYYY-MM-DD:HHMMSS MB YYYY-MM-DD:HHMMSS BYTES --------- -------- -------- ----------------- --- ----------------- -------- MAILBOX IS EMPTY! 200 ftp> Note that there is no undelivered mail in the mailbox repository. Since the mail created above in the mailbox subdirectory with the dcxmboxcreate command, there is no undelivered mail in the repository. If the dcxmboxlist command is run with the –all argument, the mail created in the mailbox subdirectory will be displayed.. ftp> quote dcxmboxlist -all 200-Executing site command handler..... Done. Command being processed by DCXMBOXLIST... Contents of mailbox for FTPmailbox.... TRACKING DOCUMENT DOCUMENT CREATION DATE #Xs LAST MAILBOXED SIZE IN ID SENDER TYPE YYYY-MM-DD:HHMMSS MB YYYY-MM-DD:HHMMSS BYTES --------- -------- -------- ----------------- --- ----------------- -------- 501 LOOPTEST LOOPTEST 2002-05-31:192021 1 2002-05-31:192040 31 1 Files listed 200 ftp> Note that the latest date and time of mailboxing and the number of times mailboxed have been updated. Again, mailboxing refers to copying mail from the repository to the subdirectory.

Page 29: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 28 FCA US

APPENDIX D.6 - FTP the Mail from the MAILBOX – mailbox subdirectory. The FTP GET command should be used to obtain the mail. The FTP MGET command should be used for multiple files. To delete the mail, the FTP DELETE or MDELETE should be used.

It is the responsibility of the trading partner to keep the mailbox subdirectory – MAILBOX - clean!

The FTP DIR comment should be issued to verify the current directory. ftp> dir 200 PORT command successful. 150 Open ASCII mode data connection for LIST (129,9,201,23,168,204). Type Size Time Stamp File/Directory Name ----------------------------------------------------------------------- Dir 512 May 31 19:20:41 2002 MAILBOX 226 transfer complete. 193 bytes received in 0.012 seconds (15.53 Kbytes/s) ftp> Notice that there is now a MAILBOX directory. This was created during execution of the dcxmboxcreate if there was no directory previously. This is the directory that stores all mail created via the dcxmboxcreate command. To get mail, the FTP CD command with the MAILBOX argument should be used to change the directory to the MAILBOX subdirectory. Use the DIR command to see the file: ftp> cd MAILBOX 250 CWD command successful. ftp> dir 200 PORT command successful. 150 Open ASCII mode data connection for LIST (129,9,201,23,234,237). Type Size Time Stamp File/Directory Name ----------------------------------------------------------------------- File 31 May 31 19:20:40 2002 LOOPTEST.A196 226 transfer complete. 199 bytes received in 0.0079 seconds (24.54 Kbytes/s) ftp> The MGET should be used to get files and the MDELETE to delete them. Ensure that interactive prompting for multiple file operations has been disabled for the FTP client session, or there will be prompts on each file for each get and delete. Consult the FTP client documentation on how to disable interactive prompting. To specify the files to get and delete, use the ‘*’ to wild-card for all files in the mailbox subdirectory: ftp> mget * 200 PORT command successful. 150 Open ASCII mode data connection for LOOPTEST.A196 (129,9,201,23,239,77). 226 transfer complete. local: LOOPTEST.A196 remote: LOOPTEST.A196 38 bytes received in 0.015 seconds (2.44 Kbytes/s) ftp> mdelete * 250 DELE command successful. ftp>

Page 30: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 29 FCA US

The FTP DIR should be used again to verify that the deletes in the mailbox subdirectory have been successful. To change up one directory, use the FTP CDUP command. The DIR should be used again to verify that return to the home directory: ftp> dir 200 PORT command successful. 150 Open ASCII mode data connection for LIST (129,9,201,23,239,115). Type Size Time Stamp File/Directory Name ----------------------------------------------------------------------- 226 transfer complete. 139 bytes received in 0.0074 seconds (18.34 Kbytes/s) ftp> cdup 250 CWD command successful. ftp> dir 200 PORT command successful. 150 Open ASCII mode data connection for LIST (129,9,201,23,239,123). Type Size Time Stamp File/Directory Name ----------------------------------------------------------------------- Dir 512 Jun 13 12:01:15 2002 MAILBOX 226 transfer complete. 193 bytes received in 0.011 seconds (17.49 Kbytes/s) ftp> Notice that even though the mailbox subdirectory MAILBOX is empty, the subdirectory remains.

Page 31: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 30 FCA US

APPENDIX E - Common Troubleshooting The following sections go through some common areas of mistakes and/or oversights that may appear to be errors or malfunctions in the EBMX FTP Mailbox facility. This is not intended to be a comprehensive troubleshooting guide.

APPENDIX E.1 - Problems Logging In Remember that the log in for the FTP Mailbox is the same as for any other EBMX FTP session. Double check the log in ID and password. If connection to the server is refused, there may be a network problem. Please investigate with your own network support. If no issue is found internally, please contact the E-business Desk.

APPENDIX E.2 – Prompts Issued for Each File to GET/DELETE Using MGET/MDELETE

The interactive prompting for multiple file operations has not been disabled. Consult the FTP client documentation to determine how to turn this off. This is controlled by the FTP client software, and is in no way controlled by FCA or the FTP server software we are running. APPENDIX E.3 - Error Displayed When Attempting to CDUP to Home Directory For security reasons, the CDUP command cannot be used to go beyond the home directory. The following error will be displayed: ftp> cdup 550 ..: No such directory or permission denied. Use the PWD command to display the Present Working Directory (PWD): ftp> pwd 257 /clocal/ecx/ecx35/data/tmp/FTPmailbox is current directory. ftp> Note that the whole path may change at the discretion of FCA, but the key part is the lowest directory level – FTPmailbox. This should correspond to the trading partner code, and will indicate that it is the highest directory level possible.

Page 32: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 31 FCA US

APPENDIX E.4 – Mail Not Displayed in the Mailbox Subdirectory All mail files reside in the MAILBOX subdirectory. From the home directory, the following results should be displayed when the DIR command is issued: ftp> dir 200 PORT command successful. 150 Open ASCII mode data connection for LIST (129,9,201,23,240,43). Type Size Time Stamp File/Directory Name ----------------------------------------------------------------------- Dir 512 Jun 13 12:01:15 2002 MAILBOX 226 transfer complete. 193 bytes received in 0.0088 seconds (21.52 Kbytes/s) ftp> If the MAILBOX subdirectory is not shown, mail has probably never been created or the directory may have been cleaned up as part of file system maintenance performed by FCA. If the MAILBOX subdirectory is not found, there is no mail created from the repository. If the subdirectory is displayed, use the CD command to change to the MAILBOX subdirectory followed by the DIR command to see any mail: ftp> cd MAILBOX 250 CWD command successful. ftp> dir 200 PORT command successful. 150 Open ASCII mode data connection for LIST (129,9,201,23,240,59). Type Size Time Stamp File/Directory Name ----------------------------------------------------------------------- 226 transfer complete. 139 bytes received in 0.012 seconds (11.64 Kbytes/s) ftp> In this case, the mailbox subdirectory is empty. There is no mail to be downloaded.

Page 33: MAILBOX USER GUIDE - FCA Group Documents... · a mailbox subdirectory, residing under the trading partner’s home FTP directory, which stores files created from the repository FCA

FCA US – FTP Push/Mailbox User Guide 

07/23/2018 32 FCA US

APPENDIX E.5 - The Mailbox Repository Appears Empty There may not be any mail in the repository. If mail is expected, the DCXMBOXLIST command used without arguments will only display mail not created with the DCXMBOXCREATE command. The following example appears to show no mail with this use of the DCXMBOXLIST command without arguments. ftp> quote dcxmboxlist 200-Executing site command handler..... Done. Command being processed by DCXMBOXLIST... Contents of mailbox for FTPmailbox.... TRACKING DOCUMENT DOCUMENT CREATION DATE #Xs LAST MAILBOXED SIZE IN ID SENDER TYPE YYYY-MM-DD:HHMMSS MB YYYY-MM-DD:HHMMSS BYTES --------- -------- -------- ----------------- --- ----------------- -------- MAILBOX IS EMPTY! 200 The use of the DCXMBOXLIST command with the –all option shows the ‘missing’ mail. The DCXMBOXLIST command with the -all argument displays both all mail that has either previously been created or has not been created via DCXMBOXLIST: ftp> quote dcxmboxlist –all 200-Executing site command handler..... Done. Command being processed by DCXMBOXLIST... Contents of mailbox for FTPmailbox.... TRACKING DOCUMENT DOCUMENT CREATION DATE #Xs LAST MAILBOXED SIZE IN ID SENDER TYPE YYYY-MM-DD:HHMMSS MB YYYY-MM-DD:HHMMSS BYTES --------- -------- -------- ----------------- --- ----------------- -------- 501 LOOPTEST LOOPTEST 2002-05-31:192021 1 2002-05-31:192040 31 1 Files listed 200 ftp>