Table of Contents
Advertisement
Quick Links
HP NonStop Data Transformation 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
528264-001
Published
June 2004
Advertisement
Table of Contents
Related Manuals for HP HP NonStop Data Transformation Engine FTP Adapter
Summary of Contents for HP HP NonStop Data Transformation Engine FTP Adapter
- Page 1 HP NonStop Data Transformation 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) Part Number Published 528264-001...
- Page 2 Document History Part Product Version Number 528264-001 NonStop Data Transformation Engine 6.7.1 F T P A d a p t e r R e f e r e n c e G u i d e Published June 2004...
-
Page 3: Table Of Contents
Contents About This Document Related References... 5 Chapter 1 - FTP Adapter Overview ... 6 System Requirements ... 6 About Sockets ... 7 Access to International VANs ... 7 Chapter 2 - Command Alias Chapter 3 - FTP Commands List of Commands... 9 Account (-AC or -ACCT)... - Page 4 Contents Chapter 5 - Troubleshooting Adapter Audit Log ... 34 Adapter Trace File... 35 Appendix A - Return Codes and Error Messages Messages... 37 Index F T P A d a p t e r R e f e r e n c e G u i d e...
-
Page 5: About This Document
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 Windows environment, has used the Mercator Design Studio, and understands words such as mapping, type trees, and other basic Mercator terminology. -
Page 6: Chapter 1 - Ftp Adapter
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. -
Page 7: About Sockets
Chapter 1 - FTP Adapter 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 this as follows: telnet target-ip 25 telnet target-ip 110... -
Page 8: Chapter 2 - Command Alias
Chapter 2 - Command Alias Specify adapter commands by using a command string on the command line or by creating a command file that contains adapter commands. The command syntax [alias]card_num [alias]card_num In the command syntax, is the Output Target Override execution command, alias is the adapter alias, and card_num is the number of the map card. -
Page 9: Chapter 3 - Ftp Commands
Chapter 3 - FTP Commands This chapter describes the functions and use of the FTP commands and their options. List of Commands The following table lists valid commands for the FTP adapter, the command syntax, and whether the command is supported ( ) for use with data sources, targets, or both. - Page 10 Chapter 3 - FTP Commands Name Keep Server List Option Make Directory Passive Mode Port Mode Private Key Private Key Password Quantity Site SSL Encryption Strength SSL Protocol Stage System Trace Syntax -LS sort_type -MKD -PASV -PORT -PKEY filename Note Only available if Security Option is installed.
-
Page 11: Account (-Ac Or -Acct)
Chapter 3 - FTP Commands Account (-AC or -ACCT) If required for logon, use the Account adapter command ( the account for connecting to an FTP server. If the account is required for logon, account_id must be specified. -ACCT account_id Option account_id Audit (-A or -AUDIT) -
Page 12: Certificate Authority (-Ca)
Chapter 3 - FTP Commands Certificate Authority (-CA) Use the Certificate Authority adapter command ( which to load trusted CA certificates. -CA filename Option Description Specify the file from which to load the trusted CA filename certificates. Client Certificate (-CERT) Use the Client Certificate adapter command ( the client certificate (if used). -
Page 13: Code Page Local (-Cpl)
This command is only valid on OS/390 and z/OS systems. The default value is the default EBCDIC code page for your system. -CPL code_page_name Option code_page_name See IBM publication "OS/390: C/C++ Run-Time Library Reference" (SC28-1663) function __atoe_l bin/bookmgr_OS390/BOOKS/EDCLB130/3.50?SHELF=CBCBS130&DT=200206201 75922 for more information. -
Page 14: Firewall Connection Method Url (-Fw Or -Firewall)
Chapter 3 - FTP Commands Firewall Connection Method URL (-FW or -FIREWALL) If required for connection, use the Firewall Connection Method URL ( ) command to specify the URL for the proxy server (firewall). One of the FIREWALL following connection methods must be specified: OPEN SITE TRANSPARENT... - Page 15 Chapter 3 - FTP Commands Option Description SITE TRANSPARENT USER USERFW USERFWPASS USERLOGON or USER USERLOGONFW or USERFW Note is the only method that directly connects to the FTP server; all TRANSPARENT other methods connect to the firewall. See the for more information on the FTP variables shown in the column.
-
Page 16: Adapter Behavior When -Firewall Command Present
Chapter 3 - FTP Commands Without a firewall the start of a file transfer begins with: Establish a Socket connection to the remote host. Issue the command over the connection. USER Issue the command over the connection. PASS When a firewall is present (used) more steps are performed in the beginning of the transfer of the files. -
Page 17: Url Syntax
Chapter 3 - FTP Commands USER ftp_user@ftp_host fw_user PASS ftp_pass USER ftp_user PASS ftp_pass USERFWPASS Establish a Socket connection to the firewall host Issue the following command over the connection in this order: USER ftp_user@fw_user@ftp_host PASS ftp_pass@fw_pass USERLOGON USER Establish a Socket connection to the firewall host Issue the following command over the connection in this order: USER fw_user PASS fw_pass... - Page 18 Chapter 3 - FTP Commands An optional user name. Some schemes such as FTP allow the user specification of a user name. An optional password. If present, it follows the user name, separated password by a colon. The user name and password are followed by an at-sign Within the user and password field, any must be encoded.
-
Page 19: Ftp Url (-Url)
Chapter 3 - FTP Commands FTP URL (-URL) The FTP URL adapter command ( server. Specify the file name(s) to be retrieved (adapter source) or created/appended (adapter target). -URL [FTP:[//]][ftp_user[:ftp_pass]@][ftp_host[:ftp_port]] [/[/]][dir/[dir/…]] [filename][;type=xfer_type[+]] Option FTP: ftp_user :ftp_pass ftp_host :ftp_port dir/… filename ;type=xfer_type is required for connection to an FTP -URL) - Page 20 Chapter 3 - FTP Commands Option Note An additional forward slash (/) is required to separate the user and host parameters from file and transfer type, if specified. Example The following is an example of the input card command in the Map Designer: -T –URL FTP://sales@host/c:/forms/myfile.txt The command causes the myfile.txt file to be retrieved from a remote host named...
-
Page 21: Ignore (-I Or -Ignore)
Chapter 3 - FTP Commands Ignore (-I or -IGNORE) The Ignore command (-I or -IGNORE) allows specified FTP error codes to be ignored by the adapter. -IGNORE error_code[:error_code…] Option error_code For example, if you specified the command: -I 450:550 the adapter ignores errors of type 450 (file busy) and errors of type 550 (file not available) and returns a zero-length file to the map. -
Page 22: List Option (-Ls)
Chapter 3 - FTP Commands List Option (-LS) Use the List Option adapter command (- a user supplied sorting preference. This command is used in conjunction with the existing FTP URL ( command and supports a subset of FTP options that control the order in which the files are transferred This is an optional command. -
Page 23: Make Directory (-Mkd)
Chapter 3 - FTP Commands Make Directory (-MKD) Use the Make Directory adapter command (- example, if a file specified in a exist, the command creates the new directory. –MKD If the command is not specified and the file specified on a –MKD points to a directory that does not exist, the adapter will fail. -
Page 24: Private Key (-Pkey)
Chapter 3 - FTP Commands By default, the adapter first tries to connect using passive mode; see the Passive Mode adapter command ( During a port mode connection, the adapter listens for the connection and dictates where the server is to connect. -PORT Private Key (-PKEY) The Private Key adapter command (... -
Page 25: Site (-Site)
Chapter 3 - FTP Commands Option number Note If you want the maximum number of files retrieved in burst mode to be infinite, then you must set the on the command line. The must be used in conjunction with the Site (-SITE) Use the Site adapter command ( command to the FTP server software. -
Page 26: Ssl Encryption Strength (-Str)
Chapter 3 - FTP Commands SSL Encryption Strength (-STR) The SSL Encryption Strength (-STR) command can be either WEAK (only use weak algorithms) or STRONG (only use strong algorithms). If not specified, any available algorithm is used (if STRONG is not available then WEAK is used). If the export version of the libraries is used, only weak algorithms are available and this command is ignored. -
Page 27: System (-Sys)
Chapter 3 - FTP Commands During an upload, the FTP server generates a uniquely-named temporary file. When the transfer has completed successfully, the original file is deleted and the temporary file is renamed. For this process to succeed you must have access rights associated with your user ID to delete and rename files, and if the optional file name ( file_name... -
Page 28: Trace (-T Or -Trace)
Chapter 3 - FTP Commands Trace (-T or -TRACE) Use the Trace adapter command (-T or -TRACE) to produce a diagnostics file with the default name m4ftp.mtr in the map directory where the adapter is installed. The file records trace information detailing the FTP adapter activity. -TRACE[+][S|V] [full_path] Option full_path... -
Page 29: Chapter 4 - Syntax Summary
Chapter 4 - Syntax Summary This chapter discusses the FTP syntax summary and how it is used. Data Sources The following is the command syntax of the FTP adapter commands used for data sources: -URL [FTP:[//]][ftp_user[:ftp_pass]@][ftp_host[:ftp_port]] [/[/]][dir/[dir/…]] [filename][;type=xfer_type[+]] [-ACCT account_id] [-AUDIT[+][S] [full_path]] [-CERT filename] [-CPASS password]... -
Page 30: Data Targets
Chapter 4 - Syntax Summary Data Targets The following is the command syntax of the FTP adapter commands used for data targets: -URL [FTP:[//]][ftp_user[:ftp_pass]@][ftp_host[:ftp_port]] [/[/]][dir/[dir/…]] [filename][;type=xfer_type[+]] [-ACCT account_id] [-AUDIT[+][S] [full_path] [-CA filename] [-CERT filename] [-CPASS password] [-CPL code_page_name] [-CPR code_page_name] [-FIREWALL FTP://[fw_user[:fw_pass]@][fw_host[:fw_port]]/method] [-IGNORE error_code{:error_code…}]... -
Page 31: Using Ftp Adapter Commands
Chapter 4 - Syntax Summary Using FTP Adapter Commands Use the adapter commands from the Map Designer or Integration Flow Designer as the data source of an input map card and as the data target for an output map card. You can also use the adapter on the command line or in a map rule using the functions The FTP adapter requires the GET >... - Page 32 Chapter 4 - Syntax Summary an at sign ( characters must be encoded. See of an FTP URL has the following syntax: url_path cwd1/cwd2/.../cwdN/name;type= xfer_type where through cwd1 xfer_type is one of the characters omitted. The cwdx omitted, including the , and host port...
-
Page 33: Url Encoding
Chapter 4 - Syntax Summary URL Encoding The URL does not need to be completely ‘URL-encoded’. You only need to use escape characters for tokens specifically used in an FTP URL, as shown in the following table. Any FTP URL that contains spaces must be enclosed in quotes; for example: -URL “FTP://Home Machine/FTP Files”... -
Page 34: Chapter 5 - Troubleshooting
Chapter 5 - Troubleshooting For information about error codes and messages returned by the adapters, see Appendix A - Return Codes and Error Various troubleshooting tools are available in case of problems using the FTP adapter for data sources or targets for a map. For example, if you attempt to run a map that uses the FTP adapter and encounter problems or do not receive the expected results, use the following adapter troubleshooting tools: adapter audit log (.log) -
Page 35: Adapter Trace File
Chapter 5 - Troubleshooting Adapter Trace File The adapter trace file contains detailed information provided by the adapter and records the actions taking place such as connections established and statements executed. The trace file is produced during the adapter execution and can be used as a debugging aid. - Page 36 Chapter 5 - Troubleshooting Adapter Trace File (187714 bytes received) Socket Closed. Connection closed. >226 Transfer Complete. (S) <QUIT >221 Goodbye. (S) Socket Closed. Connection closed. Winsock Client ID 1 disabled. Read 187714 bytes from /d: /rollback.gif. Data in E: \167.tmp kept. Run Completed at 08: 49: 39.742 on 03/28/00.
-
Page 37: Appendix A - Return Codes And Error Messages
Appendix A - Return Codes and Error Messages Return codes and messages are returned when the particular activity completes. Return codes and messages may also be recorded as specified in the audit logs, trace files, execution summary files, etc. Messages The following is a listing of all the codes and messages that can be returned as a result of using the FTP adapter for sources or targets. - Page 38 Appendix A - Return Codes and Error Messages Return Code Message -102 Invalid SSL protocol -103 Invalid SSL algorithm strength -104 Code page values invalid for this system -105 Unable to initialize code page descripton -106 Specify both –CPR and –CPL or neither -107 Code page translation results in unequal character counts...
-
Page 39: Index
Index .log file, 34 .mtr, 34 Account (-AC or -ACCT) adapter command, 11 adapter trace file, 35 alias, 8 Audit (-A or -AUDIT) adapter command, 11 audit log, 34 Certificate Authority (-CA) adapter command, 12 Client Certificate (-CERT) adapter command, 12 Client Certificate Password (-CPASS) adapter command, 12 Code Page Local (-CPL) adapter command, 13... - Page 40 Index Site (-SITE) adapter command, 25 Socket information, 7 SSL Encryption Strength (-STR) adapter command, 26 SSL Protocol (-SPROTO) adapter command, 26 Stage (-STG or -STAGE) adapter command, 26 syntax summary, 29 System (-SYS) adapter command, 27 system requirements, 6 Trace (-T) adapter command, 28 trace file, 35 troubleshooting, 34...