TaskCentre v4.5 File Transfer (FTP) Tool White Paper

Transcription

1 TaskCentre v4.5 File Transfer (FTP) Tl White Paper Dcument Number: PD _0-WP Orbis Sftware Limited 2010

2 Table f Cntents COPYRIGHT 1 TRADEMARKS 1 INTRODUCTION 2 Overview 2 FEATURES 2 GLOBAL CONFIGURATION 3 New Cnnectin dialg 4 Update Cnnectin dialg 4 TECHNICAL SUMMARY 5 Wrking with ther Steps 5 Dependencies 5 Objects Cnsumed 6 Objects Expsed 6 CONFIGURATION 6 General 7 Main 8 File Item Add dialg 8 i

3 Cpyright & Trademarks Cpyright The cpyright in this dcument is wned by Orbis Sftware All rights reserved. This publicatin may nt, in whle r part, be reprduced, transmitted, transcribed, stred in a retrieval system r translated int any language in any frm r by any means withut the prir written cnsent f Orbis Sftware Limited. Head Office: Orbis Sftware Limited (UK) 2 Nuffield Rad Nuffield Industrial Estate Ple, Drset BH17 0RB United Kingdm Tel: +44 (0) Fax: +44 (0) [email protected] Trademarks Orbis Sftware Ltd wns the registered Trademark TaskCentre. All ther Trademarks used within this dcumentatin are acknwledged as the prperty f their respective wners. The infrmatin prvided in this publicatin may cntain errrs, missins, r typgraphical errrs r may be ut f date. Orbis Sftware may change, delete, r update any published infrmatin at any time and withut prir ntice. The infrmatin published in this dcument is prvided fr infrmatinal purpses nly and is nt binding n Orbis Sftware in any way except t the extent that it is specifically indicated t be s. 1

4 File Transfer (FTP) Tl Intrductin Overview The File Transfer (FTP) is an Output Tl which is used t create a Task Step that uplads r dwnlads ne r mre files t and frm ne r mre FTP Servers. This is a pwerful Tl which can be used, fr example, in the autmated publishing f key infrmatin t Intranet/Internet sites. When uplading, the files in questin may be created by TaskCentre Steps r may already exist within an accessible file system. Fr example, dcuments prduced by the Frmat type Steps can be prduced dynamically and upladed t an FTP site in a single Task. Multiple FTP servers and their authenticatin details can be defined glbally and their use is then transparent in the rest f the prduct. A list f files r flders t be transferred by the Step is defined in the Main tab f the File Transfer (FTP) dialg. Within each file transfer definitin, it is pssible t specify ptins cntrlling uplad r dwnlad, static r dynamic FTP Server t use and static r dynamic files. Features 2

5 File Transfer (FTP) Tl Glbal Cnfiguratin Fr the File Transfer Step t wrk, a cnnectin t an FTP Server must be cnfigured either thrugh the Glbal Cnfiguratin dialg (Ref: Figure 1) fr the File Transfer (FTP) Tl. Alternatively, an FTP Server may be selected dynamically at Task Run time thrugh the Server tab f the File Item Add dialg. Any number f cnnectins can be made and access t each ne may be cntrlled thrugh a user name and passwrd if required. Figure 1. File Transfer (FTP) Glbal Cnfiguratin dialg. The dialg is used t manage cnnectins t FTP Servers and cntains the fllwing: Cnnectin Name - A name given t the cnnectin name when it was added. FTP Server - The name f the FTP Server. 3

6 File Transfer (FTP) Tl New Cnnectin dialg The New Cnnectin dialg (Ref: Figure 2) is used t create a new cnnectin t an FTP server and cntains the fllwing: Update Cnnectin dialg Figure 2. New Cnnectin dialg. The Update Cnnectin dialg cntains the same items as the New Cnnectin dialg. It allws the details fr an existing cnnectin that has been selected in the list t be displayed and edited as required. 4

7 File Transfer (FTP) Tl Technical Summary Wrking with ther Steps The ther Steps that the File Transfer (FTP) Step will interact directly with, whether by expsing infrmatin t it r cnsuming infrmatin frm it are listed belw. Step Icn Name Step Type Schedule Event Step MS SQL Server Trigger Oracle Trigger SMTP Wrkflw Jb Submissin Database Query (ODBC) Event Step Event Step Event Step Event Step Input Step Database Query (OLEDB) Input Step Call Prcedure (OLEDB) Input Step Frmat As Text Frmat Step Frmat As HTML Run Crystal Reprt Merge MS Wrd Dcument XML t Recrdset Frmat Step Frmat Step Frmat Step Frmat Step Create Wrkflw Jb Frmat Step Text Parser Decisin Call Prcedure (OLEDB) General Step General Step Output Step Call Prcedure (OLEDB) Execute Step Dependencies The prducts, technlgies, prtcls r systems that are required fr the File Transfer (FTP) Step t wrk are listed belw. 5

8 File Transfer (FTP) Tl Objects Cnsumed Objects that the File Transfer (FTP) Step cnsumes that are expsed by ther Steps are listed belw. Objects Expsed Objects that the File Transfer (FTP) Step expses which can be utilised by ther Steps are listed belw. Cnfiguratin The File Transfer (FTP) Step is cnfigured thrugh the File Transfer (FTP) dialg which is the main interface fr creating a new Step. The dialg is displayed thrugh the methds described belw. T create a new Step: T pen an existing Step: The dialg cntains General and Main tabbed panes described belw thrugh which a File Transfer (FTP) Step may be created and cnfigured. 6

9 File Transfer (FTP) Tl General Figure 3. File Transfer (FTP) General tab. The cntents f the General tab (Ref: Figure 3) are as fllws: 7

10 File Transfer (FTP) Tl Main Figure 4. File Transfer (FTP) Main tab. The Main tab (Ref: Figure 4) allws the selectin f files t be upladed r dwnladed, and the target FTP Servers, thrugh the fllwing: Surce - Shws the static file name, r the data clumn frm which it is being derived. Destinatin - Shws the destinatin path fr the file, r the data clumn frm which it is being derived. Type - Displays Uplad r Dwnlad. Server - Displays the name f the FTP cnnectin r the FTP server being used, depending n whether a static r dynamic server is being used. File Item Add dialg The File Item Add dialg is displayed when the Add buttn is selected in the Main tab f the File Transfer (FTP) dialg. It cnsists f three tabbed panes described belw and is used t cnfigure all settings fr a new file t be added t the Step. Server The Server tab (Ref: Figure 5) is the default tab displayed when the File Item Add dialg is displayed and is used t select either a static server cnnectin r t enter data dynamically fr each server setting where the data is available in a clumn frm the data surce being used. 8

11 File Transfer (FTP) Tl The tab cntains the ptins listed belw. Figure 5. File Item Add Server tab. Cnnectin (drp dwn list) - Displays a list f available cnnectins fr selectin. Server (field) - A server path and name may be manually entered r a database clumn r variable cntaining the path and name dragged and drpped int the field frm the Task Brwser. Prt (field) - The prt number t be used may be manually entered r a database clumn r variable cntaining the prt number dragged and drpped int the field frm the Task Brwser. User (field) - The user name t be used may be manually entered r a database clumn r variable cntaining the user name dragged and drpped int the field frm the Task Brwser. Passwrd (field) - The passwrd t be used fr the selected user name may be manually entered r a database clumn r variable cntaining the passwrd dragged and drpped int the field frm the Task Brwser. Passive (drp dwn list) - This is used t select a passive cnnectivity t the recipient FTP Server. Frm the drp dwn list, ptins f True r False may be selected. Alternatively yu may drag and drp a prperty frm the Task Brwser dialg int the field but this prperty must reslve t either True r False. The Client can then initiate bth parts f the FTP cnnectin (Data & Cmmand) t reduce the risk f firewalls filtering the Data Prt infrmatin. File Transfer The File Transfer tab (Ref: Figure 6) is used t cnfigure all file transfer settings thrugh the fllwing: 9

12 File Transfer (FTP) Tl Full Path and Filename(s) (ptin radi buttn) - The path and name may be manually entered in the field prvided r lcated and selected thrugh a 'Brwse' buttn. Alternatively, a database clumn r variable cntaining the path and name may be dragged and drpped int the field frm the Task Brwser. File frm Data (ptin radi buttn) - This ptin is nly available when the Use a recrdset ptin is selected in the General tab. A database clumn r variable cntaining the file may be dragged and drpped int the field prvided frm the Task Brwser. File frm Dcument (ptin radi buttn) - This ptin is nly available when the Read dcuments frm a surce ptin is selected in the General tab. The surce file is autmatically selected. 10

13 File Transfer (FTP) Tl File(s) in Flder (ptin radi buttn) - A flder path and name cntaining the file(s) may be manually entered in the field prvided r selected thrugh a 'Brwse' buttn. Alternatively, a database clumn r variable cntaining the flder path may be dragged and drpped int the field frm the Task Brwser. Include subflders (ptin check bx) - Includes any subflders fr the selected flder. Path (field) - The destinatin path may be manually entered r lcated and selected thrugh a 'Brwse' buttn. Alternatively, a database clumn r variable cntaining the path may be dragged and drpped int the field frm the Task Brwser. Create destinatin flder if nt fund (ptin check bx) If this ptin is checked, a destinatin flder fr the transferred files is autmatically created if it des nt already exist. Destinatin Filename(s) (field) - The destinatin file name may be manually entered in the field prvided r lcated and selected thrugh a 'Brwse' buttn. Alternatively, a database clumn r variable cntaining the filename may be dragged and drpped int the field frm the Task Brwser. Figure 6. File Item Add File Transfer tab. 11

14 File Transfer (FTP) Tl Optins The Optins tab (Ref: Figure 7) is used t specify the behaviur f the File Transfer (FTP) Step shuld the transfer fail r if the destinatin file already exists. The tab cntains the ptins listed belw. Figure 7. File Item Add Optins tab. Never Overwrite - If the destinatin file name already exists then it will nt be verwritten and the new file data is therefre nt saved. Always Overwrite - If the destinatin file name already exists then it will be verwritten with the new file data is saved. Abrt Step - If an errr ccurs then the Step is abrted and a file is nt created. Cntinue - If an errr ccurs then the Step will cntinue and a file is created. Abrt Task - If the Step is abrted then the Task is abrted and n file will be created. Cntinue - If the Step is abrted then the Task will cntinue nt the next Step in the prcess if ne exists. 12