IBM FTP Adapter manual

HP NonS t op D at a Tr an sf or m ati on En gin e FT P A dapter Ref erenc e Guide A bstract This m anual provides inform ation about us ing the HP NonStop ™ Data Tra nsform ation Engine (N onStop D TE) FTP adapt er on the N onStop serve r. Prod uct Ve rsio n NonStop D ata Transf orm ation Engine 6.7.1 Ver sion U pdates (RV Us) N/A Part Number Pub[...]

FTP Adapter Refer ence Guide 2 Document History Part Number Prod uct Ve rsio n Publ ishe d 5282 64-0 01 NonS top D ata T r ansfor mati on Engin e 6.7. 1 Ju ne 20 04[...]

FTP Adapter Refer ence Guide 3 Contents Abo ut Thi s Do cum ent Relat ed Refere nces........................................................................................... 5 Ch apter 1 - FT P Adap te r Ove rv iew ....................................................................................................... 6 Sys t em Re qu i r eme nt s[...]

Contents FTP Adapter Refer ence Guide 4 Ch apt er 5 - T roubl esh ootin g Adapt e r Audi t Lo g ........................................................................................... 34 Adapt e r Tra ce F i le........................................................................................... 35 Appe ndi x A - R etu rn Cod es and Error [...]

FTP Adapter Refer ence Guide 5 About This Document This do cu men t c ont ain s d eta iled info r ma tio n a b ou t us ing the FT P Ad a pt er . For ge ner a l info r ma tio n r eg ar din g usin g an y o f the Me rc a tor R eso urc e a dap te rs, see the Resource Adapters Reference Guide . This document assumes that the rea der knows the W i ndows [...]

FTP Adapter Refer ence Guide 6 Chapter 1 - FTP Adapter This chapter introd uces the Fi le Tra nsfer Pr otocol (FTP) a dapter. You can use this adapt er wi th a Co mman d Se rve r, Eve nt S e rve r, Platf orm API , o r m ap i n a map rul e. Overview Use the FTP adap ter to transport data. When source data a rrives at it s target, it often must b e t[...]

Chap ter 1 - FT P A dapter Acces s t o Int ernat ion al VANs FTP Adapter Refer ence Guide 7 Abou t Socke ts Wi ndows (NT) or BSD (UNI X) Sockets must be i nstalle d on the client computer. ♦ The S ockets installation must support TCP/I P. ♦ The clie nt computer must b e able to access an appr opriate se rve r. Test thi s as fo llow s : ! telnet[...]

FTP Adapter Refer ence Guide 8 Cha p t er 2 - Co mm and Alias Spe ci f y adapte r co mman ds by usi ng a com mand st ri ng on t he c o mm and l i n e or by creat in g a c omman d fi l e that cont ai ns adapt e r comm ands . The comman d syn tax is: -IA [ alia s ] ca rd _num -OA [ alia s ] ca rd _num I n th e command synt ax, -IA is the I nput S our[...]

FTP Adapter Refer ence Guide 9 Chapter 3 - FTP Com mands This chapter describes the functi ons and use of the FTP commands and thei r options. List of C omma nds The foll owi ng tab le li sts valid commands for the FTP adapter, the comman d syn tax, an d whe the r the comm an d is s uppo rte d ( √ ) for use wi th dat a sour ces, targ ets, or both[...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 10 Nam e Syntax Sou rce Targ et Keep Server -KS √ √ Lis t Opt ion -LS sort_type √ √ Ma ke Directo ry -MKD √ √ Passive Mode -PASV √ √ Port Mo de -PORT √ √ Priv ate Ke y -PKEY filename Note O nly a va ila ble if Secu rit y Op tio n is ins ta lled. √ √ P[...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 11 Ac coun t (-A C or -ACC T ) I f required for logo n, use the Account adapt e r com mand ( -AC or -ACCT ) to speci fy the account for connecting to an FTP server . If the account is required for logon, accou nt _id must be specifie d. -ACCT acco un t_ id Option Description[...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 12 Certifica te A uthority ( -CA) Use t he C erti fi cate Au t hori ty adapt e r co mman d ( -CA ) to spec ify t he f ile fr om wh ich to loa d tr us ted CA c er tif ica tes . -CA filena me Option Description filename Speci fy the file from w hich to load the trusted CA cer [...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 13 Code P ag e Loc al (-CPL ) Use t he C ode Page Loc al ad apter c omm and ( -CPL ) to s pe cif y th e code page of th e data on the local system (the syste m on w h i ch Merca tor is running). Use this command in conjunction with the TYPE=ASCII fe ature of the –URL comm [...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 14 Fire wall Con n ecti on Me th od U RL (-FW o r -F IREWA LL ) I f required for connection, use the Firewall Connection Method URL ( -FW or - FIREWALL ) co mma nd t o specify t he UR L fo r the p ro xy ser ver ( fir ewa ll). One of the foll owi ng connecti on methods must b[...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 15 Option Description SITE USER fw_user, PASS fw_pass, SITE ftp_host, USER ftp_user, PASS ftp_pass TRANS PA RENT USER fw_user, PASS fw_pass, USER ftp_user, PASS ftp_pass USER USER ftp_user@ftp_host, PASS ftp_pass USERF W USER ftp_user@ftp_host fw_user, PASS ftp_pass USERF WP[...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 16 Without a firewall the start of a file tra nsfer begins with: ♦ Establish a Socket connecti on to the remote host. ♦ Issue the USER command over the connecti on. ♦ Issue the PASS command over the connecti on. When a firew a ll is p res ent (u sed ) m or e steps a r [...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 17 USER ftp_ us er @f tp _h os t fw _u ser PASS ftp_ pa ss USER ftp_ us er PASS ftp_ pa ss USERFWPASS ♦ Establish a Socket connecti on to the firewall host ♦ I ssue the following command over the connecti on in this order: USER ftp_ us er@f w_us er@f tp _hos t PASS ftp_ [...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 18 user An optional use r na me. Some sche mes such as FT P al low the sp ecif ica tio n o f a user na m e. password An optional passw ord. I f pr esent, it fo llows the user na me, separa ted by a co l on. T he u ser n ame an d pass word are fol lo we d by an at -sign ( @ )[...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 19 FTP URL (-UR L) The FT P URL adapt e r co mman d ( -URL ) i s required for co nnection to an FTP ser ver. Spec ify the f ile na me( s) to b e ret rieved (a dap ter sourc e) or creat e d/ appe n ded (a da pte r targe t). -URL [ FTP: [ // ]] [ ft p_us er [: ftp_ pa ss ] @ ][...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 20 Option Description Note When sending an FTP req uest to the AS /4 0 0, the file must first be c rea ted on the AS/ 400 in or der for the len parame te r t o pad t he re co rd co rrectl y. I I mage ( bi nary ) L8 Lo ca l 8- b it ty pes (u su ally equ iva lent t o I) D Di r[...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 21 Ignor e (- I or -IGNO RE ) The I gnore comman d ( -I or -I GNOR E ) a llows sp ecif ied FT P er r or co d es t o b e ign ored by the adapt e r. -IGNO RE erro r_ co de [ : erro r_ co de …] Option Description error _code S pec i fy the FT P e rror code s to be ign ore d b[...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 22 List Option (-LS ) Use the List Option ada pter command (- LS ) t o all ow fi les to be ret ri ev ed base d on a u ser supp lied s or ting p refer enc e. This command is used in conjunction with the exi st ing FTP URL ( -URL ) ad apt er command and sup port s a sub set of[...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 23 Make D i recto r y (-MK D ) Us e the M ake Dir ecto ry a d apt er co mma nd (- MKD ) to create a d irecto ry. For exa mp le, if a file sp ecif ied in a PUT op er at ion belo ng s in a dir ec tor y t ha t d oes no t exist, the –MKD command creates the new di rectory. If [...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 24 By default, the ad apter first tries to connect using passive mode; see the Passive Mode a dapte r com man d ( -PV ). If the adapter is unsuccessful , it uses p ort mo de. During a por t mode connecti on, the adapter l istens for the connecti on a nd dictates wher e th e [...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 25 Option Description numbe r The n umber o f fi le s to be ret rie ve d by th e adapte r. Note If you want th e maxi mum nu mbe r of fi les re tri eve d in burst mode to be i n fi n it e , then you must set the –QTY command o pti on number to ' S ' and s pecify [...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 26 SS L Enc ry ption S tre ngth (-ST R) The SSL E ncr yp tion Str eng th ( -S TR ) command can be ei the r WEAK (only use weak algor ithms) or ST RON G (only use strong algor ithms) . I f not specified, any av aila b le alg or ith m is used ( if STRO NG is no t a va ila b le[...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 27 During an upload, the FTP server genera tes a uniquely-named temporary file. When the tra nsfer has completed successfull y, the original file is deleted and the temporary fil e is renamed. For this process to succe e d you must have access rights a ssociated with your us[...]

Chapte r 3 - FTP Comm ands List of Comm a nds FTP Adapter Refer ence Guide 28 Trace ( -T o r -TRACE) Use t he T race ad apte r co mm and ( -T or -T RA CE ) to p roduce a di ag nostics fi l e with the default name m4ftp .mtr in the m ap d irecto r y w her e the a d ap ter is ins ta lled . The fi le r eco r ds tr a ce inf or ma t ion d et ailin g t h[...]

FTP Adapter Refer ence Guide 29 Chapter 4 - Syntax Summary Thi s chapter discusses the F TP syntax summary and how i t i s used. Data Sources The follow ing is the comma nd synta x of the FTP ad ap te r commands used for data sources: -URL [FTP: [ // ]] [ ftp_user [ : ftp_pass ] @ ][ ftp_host [ : ftp_port ]] [ / [ / ]] [ dir /[ dir / … ]] [ filen[...]

Ch apter 4 - S ynt ax Sum mary Dat a Tar gets FTP Adapter Refer ence Guide 30 Data Target s The follow ing is the comma nd synta x of the FTP ad ap te r commands used for data targ ets: -URL [FTP: [ // ]] [ ftp_user [ : ftp_pass ] @ ][ ftp_host [ : ftp_port ]] [ / [ / ]] [ dir /[ dir / … ]] [ filename ][ ;ty pe= xfer_type [ + ]] [ -ACCT account_i[...]

Chapte r 4 - Syntax Su mmary Using FTP Adapter Comm a nds FTP Adapter Refer ence Guide 31 Using F TP Ad ap te r Command s Use t he ada pte r com man ds fro m th e Map D es i gne r or I nte grati on F low De si gn er as the d ata source of an inp ut map card and a s the da ta target for a n output map card . You c an al so us e th e adapte r on th e[...]

Ch apter 4 - S ynt ax Sum mary UR L Synt ax FTP Adapter Refer ence Guide 32 an at s ign ( @ ) . Wit hin th e user a nd p a ssword field , an y : , @ , or / characters must be encoded. See URL Enco ding . The url_path of a n FTP URL ha s the following syntax: cwd1/ cwd2/. ../cwd N/name ;type= xf er _t yp e wh ere cwd1 thr ough cwdN and name ar e (p [...]

Chapte r 4 - Syntax Su mmary URL Encodi ng FTP Adapter Refer ence Guide 33 URL En co ding The UR L d oes not need to be co mpletely ‘UR L- enco ded ’. Yo u only n eed to use escape chara cters for tokens sp ecificall y used in an FTP U RL, a s shown in the following table. Any F TP UR L that co ntains spaces must be enclosed in quotes; fo r exa[...]

FTP Adapter Refer ence Guide 34 Chap ter 5 - Tro ublesh oot ing Fo r i nf o rmat ion abou t erro r codes an d mess ages re turn ed by th e adapt ers, s e e Appe ndi x A - Re turn C odes an d Erro r Messa ges . Various troubleshooti ng tools are avai l able in case of proble ms using the FT P adapter for dat a sources o r targets for a map. For exam[...]

Chapte r 5 - Troubleshooting Adapte r Trace File FTP Adapter Refer ence Guide 35 Adapter Trace File Th e adapte r trac e fi l e cont ain s detai led i nf o rmat ion provi ded by th e ada pter an d records the actions taking place such as conn e ctions established and statements executed . The tr ac e file is p r od uced during the ad a pter execu t[...]

Chapte r 5 - Troubleshooting Adapte r Trace File FTP Adapter Refer ence Guide 36 (1 87 71 4 by te s re ce iv ed ) Socke t Closed . Conne ction cl osed. >226 Transf er Com plete. (S) <QUIT >221 Go odbye. (S) Socke t Closed . Conne ction cl osed. Wi ns oc k Cl ie nt ID 1 di sa bl ed . Read 18 7714 byt es from /d : /rollb ack.gi f. Data in E:[...]

FTP Adapter Refer ence Guide 37 Appendix A - Return Codes and Erro r Messages Return codes and messa ges ar e returne d when the particul ar activi ty compl e tes. Return codes and messa ges may al so be re corded as sp ecif i ed in the audit logs, tr ac e files, exec ut io n su mm a ry f iles, etc . Messag es Th e foll owi ng is a list in g o f al[...]

App e n di x A - R e tu rn Code s a nd Er ro r Me ssa g es M essa g e s FTP Adapter Refer ence Guide 38 Ret urn C ode M essage -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 transl[...]

FTP Adapter Refer ence Guide 39 Index . .log f i le, 34 .mtr, 3 4 A Account ( -AC or -AC C T ) ad ap te r c omma nd , 11 adapt e r tr ac e f i le, 35 alia s, 8 Audit ( -A or -A UD I T ) ad ap te r co mm a nd , 1 1 audit l o g, 3 4 C Ce rtifica te Au thority ( -CA ) adap ter com ma nd , 12 Clie nt Cer tific ate ( -C ER T ) ad apter c om man d, 1 2 C[...]

Index S FTP Adapter Refer ence Guide 40 S Site ( -S IT E ) a dap t e r co mm and, 2 5 Soc ket infor mation, 7 SSL En cry ption Str ength ( -S TR ) adap ter command , 26 SSL Protocol ( -S PROTO ) ad apter com mand , 2 6 Stage ( -STG or -STAGE ) a d apt er c omman d, 2 6 synt ax s ummary , 29 Syst em ( -SYS ) ad ap te r c om ma nd, 2 7 syst em req ui[...]