DaimlerChrysler EBMX HTTP/s Quick Start Guide

EBMX HTTP/s Quick Start Guide

Document Version 2.1, August 28, 2003

Copyright 2003 Cleo Communications

In this document… Process Map Overview Configuration

Activate the DaimlerChrysler HTTP/s pre-configured host Host Mailbox <looptest> Action <send+receive> Actions Command Reference

Process Map

If just getting started with LexiCom, refer to the General Process Map of the LexiCom User’s Guide. Then follow these steps to setup a connection to the DaimlerChrysler EBMX HTTP/s host:

If necessary, apply for an EBMX HTTP/s username and password at

http://extranet.daimlerchrysler.com/cgi-bin/admin/ebmx/https_user_config.cgi

.

(Page 1).

Activate the DaimlerChrysler host (page 3) and configure the Mailbox (page 4) with your username and password.

Run the <looptest> Action. (Page 5)

Depending on your production needs, configure the appropriate production

<send+receive> Actions. (Page 6)

Overview

DaimlerChrysler’s Electronic Business Message eXchange (EBMX) allows

standard protocols, including FTP and HTTP. For more information on EBMX, go to

http://extranet.daimlerchrysler.com/general/ebmx.

Files submitted to EBMX HTTP/s do not retain their original filenames. Upon submission, a pair of tracking IDs is assigned to the file. The 1st tracking ID is reported back to the sender as confirmation of receipt by EBMX. The 2nd tracking ID is used by the receiver to retrieve the file. Unless otherwise specified in the GET command, files retrieved from the EBMX HTTP/s server using LexiCom are named with the 2nd _{tracking ID.}

Of the action commands allowed by LexiCom, the EBMX HTTP/s server supports the following:

Command Purpose Supported by EBMX HTTP/s Host

commands

CONNECT

Connect (login) to the host

PUT

Send one or more files to the host

GET

Receive one or more files from the host

DIR

Get a directory listing of available files from the host

CONFIRM

Confirm, on the host, the receipt of one or more files

DELETE

Delete one or more files on the host

NOTE: EBMX eventually self purges downloaded

(confirmed) files Local

commands

SET

Change an action property value

-

SYSTEM

Execute a local system command

_-

WAIT

Pause

_-

LCOPY

Copy one or more local files

_-

LDELETE

Delete one or more local files

_-

The DIR and CONFIRM host commands by themselves have little use. However, the –DIR and –CON options within the GET command are very convenient and are very necessary.

NOTE 1: The LexiCom trading partner branch is only applicable if you are trading through DaimerChrysler with another supplier. In this case, the ReceiverId parameter on the PUT command is your trading partner’s supplier code and the value of the parameter can optionally be specified via a trading partner. Refer to Trading

Partner Configuration in the Generic HTTP and HTTP/s Host section of the LexiCom User’s Guide for more information.

Configuration

If you do not already have an EBMX HTTP/s username and password, go to

http://extranet.daimlerchrysler.com/cgi-bin/admin/ebmx/https_user_config.cgi. The form requires a DaimlerChrysler supplier ID.

Activate the DaimlerChrysler HTTP/s pre-configured host

1. Click the Preconfigured tab in the tree pane.

2. Right-click the DaimlerChrysler host.

3. Select ‘Clone and Activate’. The entire pre-configured host branch will be copied and made active, the Active tab will be automatically selected in the

tree pane, and the new active host will be automatically selected in the tree. The new active host alias may be appended with a number, if necessary to make it unique. The original configured host will remain in the pre-configured tree.

4. If desired, type a new host alias in the content pane panel and click [Apply]. Configure the production host as follows:

Host

If necessary, modify the connection type, proxy firewall, and phonebook entry (refer to Configure System Options, Configure for a Proxy Firewall, and/or Setup a LexiCom Dial-up Connection in the LexiCom Basics section of the LexiCom User’s Guide).

Modify the default local directories, if necessary (refer to Configure System Options in the LexiCom Basics section of the LexiCom User’s Guide).

Mailbox

Select myMailbox under DaimlerChrysler. If desired, rename the alias – maybe to your company name.

In the HTTP tab:

For PUT, if you only need to send to one trading partner (either one of the Chrysler receivers or another Chrysler supplier), then fill in the ReceiverId here; otherwise specify it in individual action PUT commands. Similarly, if you only need to send one file type (either Chrysler EDIX12 or one of the specialized application IDs), then fill in the FileType here; otherwise specify it in individual action PUT commands.

Also for PUT, if you are sending relatively large files (> 1Mb), you may want to consider sending zipped files. To do this, set the optional [Content-Type] to

application/x-zip-compressed either at the mailbox level or for individual action PUT commands. LexiCom will first create a temporary zip file (if the file being sent isn't already a zip file), and then send the compressed content.

For GET, if you want your local filenames to include the EBMX document types, then set the filenameformat to p.

For DIR, leave the doctype empty. If you need to receive different EDI application documents (perhaps to place into different directories), the doctype should be specified in individual action GET commands.

<looptest> Action

Select looptest under myMailbox. In the Commands tab:

1. Place one or more test files in the outbox\ directory. A file sent via the ‘LOOPBACK’ type need not be an EDI document. Any file content is accepted because a ReceiverID of ‘LOOPTEST’ will automatically route the file back to the sender.

2. The looptest action will login, send the file(s) from outbox\ to ourselves, wait a few minutes, and then try to receive any available, new files into inbox\ - hopefully the file(s) just sent.

3. Clear the inbox\ directory.

4. Run the action. If successful, you should see messages similar to the test site above.

5. Verify the inbox\ files match the outbox\ files.

<send+receive> Actions

If the looptest action is successful, you should be ready to send and/or receive production EDI documents. Three sample actions (send, receive, and send+receive) are included which might require little to no modification for use.

If you need to send to different trading partners or different application documents, duplicate the PUT command as needed and specify a different ReceiverId and/or FileType value with each.

If you need to receive different application documents separately, duplicate the GET command as needed and specify a different doctype value with each.

Clear the outbox\ and inbox\ directories of any test files.

NOTE: If an invalid ‘FileType’ is specified on a PUT command, EBMX will reject the file and put it in your mailbox with the following header added:

Your submit command on date/time, for Tracking ID nnnnn,

contained an invalid file type: username(-se), ReceiverId(-re),

xxxxx(-ft). For that reason, the following file was not

processed:

where xxxxx = the invalid file type.

The next time you receive files from your mailbox, this file will be included. LexiCom recognizes that the file is a previously rejected file, and places it in your rejectbox/ (refer to Configure System Options in the LexiCom Basics section of the LexiCom User’s Guide).

Command Reference

CONNECT

CONNECT username=,*password,…

CONNECT - Connect (login) to the host

username= value - Your EBMX user ID (assigned by DCX)

*password= value - Your EBMX password (assigned by DCX)

PUT

PUT -DEL “source” ReceiverId=value,FileType=value

PUT - Send one or more files to the host -DEL - If put successful, delete local file

“source”1 _{- Local source path}

• path can be to a filename or to a directory • * and ? supported in filename

• if relative or no path, then uses default outbox ReceiverId= LOOPTEST - initial loop-back test

EDI - batch EDI transaction

CHASE - real time ASN/ASC (856) EDI transaction STARS - real time STARS 214 EDI transaction

tradingpartner - trading partner supplier code

FileType= LOOPBACK - initial loop-back test (used when ReceiverId =LOOPTEST)

EDIX12 - EDI transaction (used when ReceiverId=EDI or CHASE or STARS)

DCX*** - Refer to Appendix B – EDI Application IDs of the “EBMX FTP User Guide” for a complete list of valid document types (used when ReceiverId=tradingpartner)

GET

GET -DIR -CON -UNI –APE “destination” filelist=value

GET - Receive one or more files from the host -DIR - Get file(s) using directory listing from the host -CON - If get successful, confirm on host that file received -UNI or –APE - Ensure local filename unique OR

- If local filename exists, append to file

“destination”1 - Local destination path

• path can be to a filename (unless–DIRoption) or to a directory

• one * supported with canned prefix and/or suffix in filename • if relative or no path, then uses default inbox

1

_{If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed}

with double quotes (“…”).

filenameformat= p - local filenames will include the EBMX document type filelist= - List of one or more EBMX tracking IDs, separated by commas

(,)

• if the–DIRoption is used, then thefilelist=parameter is replaced by the DIRcommand parameters

DIR

DIR “destination” [newdocsonly]=value,[doctype]=value, [begindate]=value,[enddate]=value

DIR - Get a directory listing of available files from the host

“destination”1 - Local destination path

• path must be to a filename

• if relative path, then uses default inbox

• if no path, then messages generated rather than file [newdocsonly]= true - exclude documents downloaded (confirmed) before

false - include documents downloaded (confirmed) before • default is false

[doctype]= LOOPTEST - initial loop-back test

DCX*** - Refer to “APPENDIX F – APPLICATION IDENTIFICATION CODES” for a complete list of valid document types

• default is all document types

[begindate]= mm/dd/yyyy - list documents created on or after this date • default is no begin date

[enddate]= mm/dd/yyyy - list documents created before this date • default is no end date

The directory listing returned is an HTML document with one header line. An example follows:

CONFIRM

CONFIRM -DIR filelist=value

CONFIRM - Confirm, on the host, the receipt of one or more files -DIR - Confirm file(s) received using directory listing from the host filelist= - List of one or more EBMX tracking IDs, separated by commas

(,)

• if the –DIR option is used, then the filelist= parameter is replaced by the DIR command parameters

SET

SET

property

=

value

property

=

value

- Action property=value

• value specified remains in effect until property set again or end of action

• to reset property back to default value,

SET

property

or

SET

property

=

Available properties include:

Property Description Possible Values Default Value CommandRetries Indicates the number of times

a command should be retried if it returns an error.

count 0 ConnectionTimeout Number of seconds to wait for

a connection to or a response from the host before timing out.

seconds 60

ExecuteOnFail Specifies a local system command that should be run if a command returns an error.

Local command path with arguments (refer to SYSTEM command) empty

TerminateOnFail Indicates whether the action should stop or go onto the next command if a command returns an error.

‘True’ or ‘False’ True

SYSTEM

SYSTEM “path”

SYSTEM - Execute a local system command “path” - Local command path with arguments

• if relative or no path, then uses LexiCom home directory

WAIT

WAIT seconds

WAIT - Pause

Seconds - Number of seconds

LCOPY

LCOPY -DEL -UNI –APE “

source

” “

destination

”

LCOPY

- Copy one or more files locally

-DEL

- If copy successful, delete local file

-UNI or -APE

- Ensure copied filename unique OR - If local filename exists, append to file

“

source

”

1 - Source path

• path can be to a filename or to a directory • * and ? supported in filename

“

destination

”

1

- Destination path

• path can be to a filename or to a directory • if relative or no path, then uses default outbox

LDELETE

LDELETE “

source

”

LDELETE

- Delete one or more files locally

“

source

”

1 - Source path

• path can be to a filename or to a directory • * and ? supported in filename

• if relative or no path, then uses default inbox

Comment