IBM FTP Adapter User Manual

HP NonSt op D at a Tr an sf or m ation Engine

FTP Adapter Reference Guide

Abstract

This manual provides information about using the HP NonStop™ Data Transformation Engine (NonStop DTE) FTP adapter on the NonStop server.

Product Version

NonStop Data Transformation Engine 6.7.1

Version Updates (RVUs)

N/A

Part Number Published

528264-001 June 2004

Document History

Part

Product Version Published

Number

528264-001 NonStop Data Transformation Engine

6.7.1

June 2004

FTP Adapter Reference Guide

About This Document

Related References........................................................................................... 5

Chapter 1 - FTP Adapter

Overview ....................................................................................................... 6

System Requirements........................................................................................ 6

About Socket s ............................................................................................ 7

Access to International VANs ............................................................................... 7

Chapter 2 - Command Alias Chapter 3 - FTP Commands

List of Commands............................................................................................. 9

Account (-AC or -ACCT)................................................................................11

Audit (-A o r -AUDIT).................................................................................... 1 1

Certificate Authority (-CA)............................................................................12

Client Cert if icate (-CERT).............................................................................12

Client Cert if icate Password (-CPAS S) ............................................................... 12

Code Page Loca l (-C PL)................................................................................13

Code Page Remote (-C PR).............................................................................13

Firewall Connection Method URL (-FW or -FIREWA LL) ...........................................14

Adapter Behav io r wh en -F IREWALL Command Present ..........................................16

URL Syntax...............................................................................................17

FTP URL (-URL)..........................................................................................19

Ignore (-I or -IGNORE)..................................................................................21

Keep Server (-K S) .......................................................................................21

List Option (-LS)......................................................................................... 2 2

Make Directory (-MKD).................................................................................23

Passive Mode (-PV or -PASV).......................................................................... 23

Port Mode (-PT or -PORT) .............................................................................23

Private Key (-PKEY) ....................................................................................24

Private Key Password (-KPASS).......................................................................24

Quantity (-QTY ) .........................................................................................24

Site (-SI TE)...............................................................................................25

SSL Encryption Strength (-STR).......................................................................2 6

SSL Protocol (-S PROTO)................................................................................26

Stage (-STG or -STAGE)................................................................................ 26

System (-SY S)............................................................................................ 27

Trace (-T or -TRA CE )...................................................................................28

Chapter 4 - Syntax Summary

Data Source s..................................................................................................29

Data Target s..................................................................................................30

Using FTP Adapt e r Comm a n ds.............................................................................31

Examples .................................................................................................31

URL Syntax....................................................................................................31

URL Encodin g.................................................................................................33

FTP Adapter Reference Guide

Contents

Chapter 5 - Troubleshooting

Appendix A - Return Codes and Error Messages

Index

Adapter Audit Log ...........................................................................................34

Adapter Trace File...........................................................................................35

Messages.......................................................................................................37

FTP Adapter Reference Guide

About This Document

This document contains detailed information about using the FTP Adapter. For general information regarding using any of the Mercator Resource adapters, see the Resource Adapters Reference Guide.

This document assumes that the reader knows the W indows environment, has used the Mercator Design St udio, and understands words such as mapping, type trees, and other basic Mercator terminology.

Related References

For more information about all products or about topics frequently discussed in this document, refer to the Mercator Online Library or the SDK Online Library.

Related Reference Description

Resource Adapters Reference Guide Using resource adapters as map sources

and map targets in general. Specific information for each adapter can be found in their respective reference guide.

FTP Adapter Reference Guide

Chapter 1 - FTP Adapter

This chapter introduces the File Transfer Protocol (FTP) adapter. You can use this adapter with a Command Server, Event Server, Platform API, or map in a map rule.

Overview

Use the FTP adapter to transport data. When source data arrives at its target, it often must be transformed into a different format in order for a receiving application to use it successfully.

If you have the Command Server, Event Server, or Platform API on one platform, you can use the FTP adapter to retrieve or send data to another platform.

Note The adapter can connect to any FTP server that complies with RFC 959. To take

full advantage of the adapter’s capabilities, the server should conform to RFC

1123. Those servers that are noncompliant may generate errors in the adapter.

System Requirements

The minimum system requirements and operating system requirements for the FTP adapt er are detailed in t he release no tes. It is assumed that a Command Server has already been installed on the computer where the adapter is to be installed for run-time purposes.

See the Getting Started book for details about the installation program. In addition, the following are additional requirements for installing and running the

FTP adapter:

♦ The FTP adapter must be installed in the same directory as the Command

Server for your specific platform.

♦ TCP/IP must be installed on the machine where the adapter is installed. ♦ The machine where the FT P adapter is installed must be able to access the

desired FTP servers over a TCP/IP network.

FTP Adapter Reference Guide

Chapter 1 - FTP Adapter Access to International VANs

About Sockets

Windows (NT) or BSD (UNIX) Sockets must be installed on the client computer.

♦ The Sockets installation must support TCP/IP. ♦ The client computer must be able to access an appropriate server. Test thi s as

follows:

telnet target-ip 25 (to test a SMTP e-mail target)

telnet target-ip 110 (to test a POP3 e-mail source)

where welcome message from the server. Shut down the sessi on by typi ng QUIT and

pressing Enter.

Note You might not be able to see what you are typing on the screen.

target-ip is the server IP address. If the test is successful, you receive a

Access to International VANs

Access to international VANs is available when using the FTP adapter. The FTP adapter can be used rather than the VAN adapter when communicating with a Commerce Manager post office. For detailed configuration information, see the

Partner Manager Reference Gui de.

FTP Adapter Reference Guide

Chapter 2 - Command Alias

Speci fy adapter commands by using a command string on the command line or by creatin g a command file that contains adapter commands. The command s yntax is:

-IA[alias]card_num

-OA[alias]card_num

In the command syntax, and

-OA is the Output Target Override execution command, alias is the adapter

alias, and card_num is the nu mber of the map card. The FTP adapter alias and corresponding execution commands are listed below.

Adapter Alias As Input As Output

FTP

FTP -IAFTPcard_num -OAFTPcard_num

-IA is the Input Source Override execution command

FTP Adapter Reference Guide

Chapter 3 - FTP Commands

This chapter describes the functions and use of the FTP commands and their options.

List of Comma nds

The following table lists valid commands for the FTP adapter, the command syntax, an d whether t he command i s supported (√) for use with data sources,

targets, or both.

Name Syntax Source Target

Account Audit Certificate Authority

Client Certificate

Client Certificate Password

Code Page Local

(OS/390, z/OS only)

Code Page Remote

(OS/390, z/OS only)

Firewall Connection Method UR L

-ACCT account_id

-AUDIT[+][S] [full_path]

-CA filename

Note Only available if Security Option is

installed.

-CERT filename

Note Only available if Security Option is

installed.

-CPASS password

Note Only available if Security Option is

installed.

-CPL code_page_name

-CPR code_page_name

-FIREWALL FTP://firewall_URL

√ √ √ √ √ √

√ √

FTP URL Ignore

-URL FTP://ftp_URL

-IGNORE error_code[:error_code…]

FTP Adapter Reference Guide

√ √ √ √

Chapter 3 - FTP Commands List of Commands

Name Syntax Source Target

Keep Server List Option Make Directory Passive Mode Port Mode Private Key

Private Ke y Password

Quantity Site SSL Encryption

Strength

-KS

-LS sort_type

-MKD

-PASV

-PORT

-PKEY filename

Note Only available if Security Option is

installed.

-KPASS password

Note Only available if Security Option is

installed.

-QTY number

-SITE command_text

-STR {WEAK|STRONG|ANY}

Note Only available if Security Option is

installed.

√ √ √ √ √ √ √ √ √ √ √ √

√ √

√ √ √ √ √

SSL Protocol

Stage System Trace

-SPROTO {SSLv2|SSLv3|SSLv23|TLSv1}

Note Only available if Security Option is

installed.

-STAGE [file_name]

-SYS {WIN32|UNIX|UNKNOWN}

-TRACE[+][S|V] [full_path]

FTP Adapter Reference Guide

√ √

√

√ √ √ √

Chapter 3 - FTP Commands List of Commands

Account (-AC or -ACCT)

If required for logon, use the Account adapter command (-AC or -ACCT) to specify the account for connecting to an FTP server. If the account is required for logon,

account_id must be specified.

-ACCT account_id

Option Description

account_id

Specify the account for connecting to an FTP server.

Audit (-A or -AUDIT)

Use the Audit adapter command (-A or -AUDIT) to produce a log file in the map directory where the adapter is installed with the default name m4ftp.log. The log

file records audit information detailing files sent or received from each host, elapsed time, file size, and retry count for each file.

-AUDIT[+][S] [full_path]

Option Description

+ Append audit information to the existing log file. If a

log file does not exist, one is created.

full_path

Summary mode. Record only minimal information in the log file.

Create audit file with the specified name in the specified directory. By default, the directory is where the map is located and the file name is m4ftp.log.

FTP Adapter Reference Guide

Chapter 3 - FTP Commands List of Commands

Certificate Authority (-CA)

Use the Certifi c ate Authorit y adapter command (-CA) to specify the file from which to load trusted CA certificates.

-CA filename

Option Description

filename

Specify the file from which to load the trusted CA certificates.

Client Certificate (-CERT)

Use the Client Certificate adapter comman d (-CERT) to specify the file containing the client certificate (if used).

-CERT filename

Option Description

filename

Specify the file containing the client certificate.

Client Certificate Passw ord (- CPASS)

Use the Client Certificate Password adapter command (-CPASS) to specify the password for the client certificate (if password protected).

-CPASS password

Option Description

password

Specify the password for the client certificate.

FTP Adapter Reference Guide

+ 28 hidden pages