TIBCO ActiveMatrix BusinessWorks Plug-in for sftp User s Guide

Transcription

1 TIBCO ActiveMatrix BusinessWorks Plug-in for sftp User s Guide Software Release 1.1 January 2015 Two-Second Advantage

2 Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIBCO, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO Rendezvous, TIBCO Administrator, TIBCO Enterprise Message Service, TIBCO InConcert, TIBCO Policy Manager, and TIBCO Hawk are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. Copyright TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

3 iii Contents Preface...vii Changes from the Previous Release of this Guide...viii Related Documentation... ix TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP Documentation... ix Other TIBCO Product Documentation... ix Typographical Conventions... xi Connecting with TIBCO Resources...xiii How to Join TIBCOmmunity...xiii How to Access TIBCO Documentation....xiii How to Contact TIBCO Support...xiii Chapter 1 Introduction....1 TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP Overview...2 SFTP Activities....3 Chapter 2 SFTP Palette...5 SFTP Change Default Directory... 6 Configuration...6 Input...7 Output....8 Error Output...8 SFTP Connection... 9 Configuration...9 Test Connection Button...11 SFTP Close Connection Configuration...12 Input...12 Error Output...13 SFTP Delete File Configuration...14 Input...15 Output Error Output...16 SFTP Dir Configuration...17

4 iv Contents Input Output...19 Error Output...19 SFTP Get...20 Configuration...20 Input Output...24 Error Output...24 SFTP Get Default Directory...26 Configuration...26 Input Output...28 Error Output...28 SFTP Make Remote Directory...29 Configuration...29 Input Output...31 Error Output...31 SFTP Put...32 Configuration...32 Input Output...36 Error Output...36 SFTP Remove Remote Directory...37 Configuration...37 Input Output...39 Error Output...39 SFTP Rename File...40 Configuration...40 Input Output...42 Error Output...42 SFTP Exec Remote Command...43 Configuration...43 Input Output...45 Error Output...45 Chapter 3 Error Codes SFTP Plug-in Error Codes...48

5 Contents v Index...55

6 vi Contents

7 vii Preface This preface gives some information on the TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP documentation set, related documentation, and on conventions used in TIBCO manuals. Topics Changes from the Previous Release of this Guide, page viii Related Documentation, page ix Typographical Conventions, page xi Connecting with TIBCO Resources, page xiii TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP User s Guide

8 viii Changes from the Previous Release of this Guide Changes from the Previous Release of this Guide The following are the changes from the previous release of this guide. A new activity, SFTP Exec Remote Command, has been added. For more information, refer to SFTP Exec Remote Command. SFTP Remove Remote Directory activity: A new check box "Include Sub Directories/Files" is added under the Configuration tab. SFTP Get and SFTP Put: "Persist Timestamp while Copy File" check box added under the Configuration tab. TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP User s Guide

9 Preface ix Related Documentation This section lists documentation resources you may find useful. TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP Documentation The following documents form the TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP documentation set: TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP Installation Read this manual for information on installing one or more components of TIBCO ActiveMatrix BusinessWorks and setting up a TIBCO ActiveMatrix BusinessWorks domain. TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP User s Guide Read this manual to learn about SFTP Plug-in and SFTP Palette in ActiveMatrix BusinessWorks. TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP Release Notes Read the release notes for the known issues. Other TIBCO Product Documentation TIBCO ActiveMatrix BusinessWorks is a pre-requisite for TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP and is used with other products. You may find it useful to read the documentation for the following TIBCO products: TIBCO ActiveMatrix BusinessWorks The following documents form the TIBCO ActiveMatrix BusinessWorks documentation set: TIBCO ActiveMatrix BusinessWorks Concepts Read this manual before reading any other manual in the documentation set. This manual describes terminology and concepts of TIBCO ActiveMatrix BusinessWorks, and the other manuals in the documentation set assume you are familiar with the information in this manual. TIBCO ActiveMatrix BusinessWorks Getting Started This manual steps you through a very simple example of designing, deploying, and monitoring a TIBCO ActiveMatrix BusinessWorks process. TIBCO ActiveMatrix BusinessWorks Process Design Guide This manual describes how to create, edit, and test business processes using TIBCO ActiveMatrix BusinessWorks. TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP User s Guide

10 x Related Documentation TIBCO ActiveMatrix BusinessWorks Palette Reference This manual describes each of the palettes available in TIBCO ActiveMatrix BusinessWorks. TIBCO ActiveMatrix BusinessWorks Administration This manual describes how to use TIBCO Administrator to deploy, manage, and monitor TIBCO ActiveMatrix BusinessWorks processes. TIBCO ActiveMatrix BusinessWorks Installation Read this manual for information on installing one or more components of TIBCO ActiveMatrix BusinessWorks and setting up a TIBCO ActiveMatrix BusinessWorks domain. TIBCO ActiveMatrix BusinessWorks Error Codes This manual describes errors returned by TIBCO ActiveMatrix BusinessWorks. TIBCO ActiveMatrix BusinessWorks Release Notes Read the release notes for a list of new and changed features. This document also contains lists of known issues and closed issues for this release. Other TIBCO Products TIBCO ActiveMatrix BusinessWorks is used with other products. You may find it useful to read the documentation for the following TIBCO products: TIBCO Designer software: TIBCO Designer is an easy to use graphical user interface for design-time configuration of TIBCO applications. TIBCO Designer includes online help for each palette. TIBCO Administrator software: TIBCO Administrator is the monitoring and managing interface for new-generation TIBCO products such as TIBCO ActiveMatrix BusinessWorks. TIBCO Adapter software Third-Party Documentation TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP User s Guide

11 Preface xi Typographical Conventions The following typographical conventions are used in this manual. Table 1 General Typographical Conventions Convention Use TIBCO products are installed into an installation environment. A product installed into an installation environment does not access components in other installation environments. Incompatible products and multiple instances of the same product must be installed into different installation environments. An installation environment consists of the following properties: ENV_NAME TIBCO_HOME code font Name Identifies the installation environment. This name is referenced in documentation as ENV_NAME. On Microsoft Windows, the name is appended to the name of Windows services created by the installer and is a component of the path to the product shortcut in the Windows Start > All Programs menu. Path The folder into which the product is installed. This folder is referenced in documentation as TIBCO_HOME. The value of TIBCO_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco. Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example: Use MyCommand to start the foo process. bold code font Bold code font is used in the following ways: In procedures, to indicate what a user types. For example: Type admin. In large code samples, to indicate the parts of the sample that are of particular interest. In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable disable] TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP User s Guide

12 xii Typographical Conventions Table 1 General Typographical Conventions (Cont d) Convention italic font Key combinations Use Italic font is used in the following ways: To indicate a document title. For example: See TIBCO ActiveMatrix BusinessWorks Concepts. To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal. To indicate a variable in a command or code syntax that you must replace. For example: MyCommand pathname Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C. Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q. The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances. The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result. The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken. TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP User s Guide

13 Preface xiii Connecting with TIBCO Resources How to Join TIBCOmmunity TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is a place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To register, go to How to Access TIBCO Documentation You can access TIBCO documentation here: How to Contact TIBCO Support For comments or problems with this manual or the software it addresses, contact TIBCO Support as follows: For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site: If you already have a valid maintenance or support contract, visit this site: Entry to this site requires a user name and password. If you do not have a user name, you can request one. TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP User s Guide

14 xiv Connecting with TIBCO Resources TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP User s Guide

15 1 Chapter 1 Introduction This chapter provides an insight into TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP. Topics TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP Overview, page 2 SFTP Activities, page 3

16 2 Chapter 1 Introduction TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP Overview TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP encrypts both commands and data, providing effective protection against common network security risks. SFTP denotes security and it encrpts all data before sending it across the network. TIBCO ActiveMatrix BusinessWorks Plug-in for SFTP enables you to transfer files between hosts.

17 SFTP Activities 3 SFTP Activities Activities are the individual units of work in a process definition. Activities are generally operations that interface to external systems, but activities can also perform internal processing. Activities are available on the various palettes in TIBCO Designer. Each palette has a set of activities that can be performed for that palette. Each SFTP activities invoke different SFTP commands such as, cd, ls, mkdir, rmdir, rm, put, and get. The SFTP palette consists of the following activities of which the SFTP Connection is a shared resource: SFTP Change Default Directory SFTP Connection SFTP Close Connection SFTP Delete File SFTP Dir SFTP Get SFTP Get Default Directory SFTP Make Remote Directory SFTP Put SFTP Remove Remote Directory SFTP Rename File

18 4 Chapter 1 Introduction

19 5 Chapter 2 SFTP Palette The SFTP palette is used to issue the SFTP commands. Topics SFTP Change Default Directory, page 6 SFTP Connection, page 9 SFTP Close Connection, page 12 SFTP Delete File, page 14 SFTP Dir, page 17 SFTP Get, page 20 SFTP Get Default Directory, page 26 SFTP Make Remote Directory, page 29 SFTP Put, page 32 SFTP Remove Remote Directory, page 37 SFTP Rename File, page 40 SFTP Exec Remote Command, page 43

20 6 Chapter 2 SFTP Palette SFTP Change Default Directory Activity SFTP Change Default Directory activity changes the current default directory on the remote machine to the specified directory path. Configuration The Configuration tab has the following fields. Field Global Var? Description Name No The name to be displayed as the label for the activity in the process definition. Description No A short description of the activity. SFTP Connection No The path to the shared configuration resource containing the user information such as host name, username, password or private key. For configuration details, refer to SFTP Connection. Quit (post-command) No Selct this check box to specify that the SFTP connection should be closed after completing this command. If this field is not selected, the SFTP connection remains open so that all SFTP activities specifying the same SFTP connection, (that is, the same host, port, and username) share the SFTP session until the connection is closed.

21 SFTP Change Default Directory 7 Input The following is the input for the activity. Input Item Datatype Description Host string The name or IP address of the SFTP server. This overrides the value specified in the SFTP Connection resource. Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection resource. UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection resource. Password string The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection resource. PrivKey string The private key s absolute path to authenticate your login. The password and private key are the preferred methods of authentication when using the SFTP module. However, you can use either of them to connect to the SFTP server. PrivKeyPass string The password of the private key, if using the priv key authentication method to log on to SFTP server. NewDefaultDir string The new default directory to be set as default directory for the current session. This element is mandatory.

22 8 Chapter 2 SFTP Palette Input Item Datatype Description Timeout integer The amount of time to wait for the SFTP server to respond. This timeout is used when the SFTP server puts the SFTP connection used by this activity into a waiting state. This overrides the value specified in the SFTP Connection resource. Output This activity produces no output. Error Output The Error Output tab lists the possible exceptions thrown by this activity. Exception ConnectionErrorException CommandExecutionException Thrown When... An error occurred when connecting to the SFTP server. An error occurred when executing the SFTP command.

23 SFTP Connection 9 SFTP Connection Shared Configuration SFTP Connection shared configuration resource describes a connection to an SFTP server. SFTP connections are used when configuring activities in the SFTP palette. Configuration The Configuration tab has the following fields. Field Name Description Host Port UserName Password Private Key Authentication Private Key Private Key Password Description The name to be displayed as the label for the resource. A short description of the shared resource. The host name or IP address of the SFTP server. The port number of the SFTP server. For SFTP connections 22 is the default, when no value is specified in this field. The user name to use when logging into the SFTP server. The password to use when logging into the SFTP server when password supported authentication is used. Select this check box to specify the private key, when using private key supported authentication. The private key to authenticate your login. It should be in open SSH format. It is recommended that you use password protected private keys. The password and private-key are the preferred methods of authentication when using the SFTP module. The password of the private key. It is applicable only when private key supported authentication is used.

24 10 Chapter 2 SFTP Palette Field Strict HostKey Check Known Host File Setup Host Public Key Description When selected, it connects only to known hosts with valid host keys that are stored in the known host file. Host keys not listed in the known host list are rejected. It verifies the incoming host key against the keys in the known hosts list. If the host key does not match an existing known host entry for the remote server, the connection is rejected. When not selected, the client does not verify the server's host key entry into the know host file while establishing the connection. Note: This option can be selected with both methods of authentication, Password and Private Key. Contains the public keys with corresponding Host IP address for all hosts with which the client can communicate. Configure the path of known_host file in this field. Known_Host_File does not exist - Browse the Project Explorer and select the folder you want to generate the known_host file. Known_Host_File exists - Import the file with any preferred name within the project to use as known_host file. This field is available only when Strick Host Key Check check box is selected. Click to install the Host Key with the corresponding Host IP into the Known Host File. This field is available only when Strick Host Key Check is selected.

25 SFTP Connection 11 Field Connection Timeout (msec) Description The timeout specified in this field (in milliseconds) applies to the following situations: Making the socket connection to the SFTP Server Reading a reply from socket after sending a SFTP control command. Reading data from the socket. If the specified time is reached when attempting any of these operations, the activity using this SFTP connection terminates with a Connection Timeout error. Test Connection Button When you click the Test Connection button, Activematrix BusinessWorks attempts to connect to the specified remote SFTP server on the specified port using the specified username, password, or priv key and hostkey entry into the known_host file (if Strict Host Key Check check box is selected). Use this button to determine if the specified connection configuration is correct and valid. If Strict Host Key Check check box is selected and Host Public Key changes or does not exist in the known_host file, the test connection fails. In such case, click the Setup Host Public Key button to setup a new Host Public Key.

26 12 Chapter 2 SFTP Palette SFTP Close Connection Activity SFTP Close Connection activity closes the connection for the configured HostIP, Port, and username. This activity enables the user to close the used connection eventhough the Quit checkbox is not selected on the activity level configuration. Configuration The Configuration tab has the following fields. Field Name Description SFTP Connection Description The name to be displayed as the label for the resource. A short description of the shared resource. The path to the shared configuration resource containing the user information such as host name, username, port, and password or priv key. Input The following is the input for the activity. Input Item Datatype Description Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection resource. Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection resource. UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection resource.

27 SFTP Close Connection 13 Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity. Exception ConnectionErrorException CommandExecutionException Thrown When... An error occurred when connecting to the SFTP server. An error occurred when executing the SFTP command.

28 14 Chapter 2 SFTP Palette SFTP Delete File Activity SFTP Delete File activity issues an SFTP rm command to remove one or more files from the remote server. Configuration The Configuration tab has the following fields. Field Global Var? Description Name No The name to be displayed as the label for the activity in the process definition. Description No A short description of the activity. SFTP Connection No The path to the shared configuration resource containing the user information such as host name, username, port, and password or private key. For details, refer to SFTP Connection. Quit (post-command) No Select this check boxto specify the closing of the SFTP connection after completing this command. Not selecting this check box keeps the SFTP connection open so that all SFTP activities specify the same SFTP connection, (that is, the same host, port, and username) share the SFTP session until the connection is closed.

29 SFTP Delete File 15 Input This activity has the following input. Input Item Datatype Description Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection resource. Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection resource. UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection resource. Password string The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection resource. PrivKey string The private key s absolute path to authenticate your login. The password and private key are the preferred methods of authentication when using the SFTP module. However, you can use either of them to connect to the SFTP server. PrivKeyPass string The password of the private key, if using the priv key authentication method to log on to SFTP server. RemoteDirectory string The path to the directory containing the file(s) to be deleted. This element is concatenated with the RemoteFilename element to provide the complete path to the files to be deleted. This element is optional.

30 16 Chapter 2 SFTP Palette Input Item Datatype Description RemoteFilename string The path and name of the file to delete on the remote server. Wildcards (? for any one character, * for one or more characters) are permitted in this field. Note: It is recommended not to use the wild cards as this activity will delete all the files matching with configured wild card names. This will avoid loosing the file. You can specify an absolute or relative path for the remote file name. Relative paths are relative to the path specified in the RemoteDirectory element and the user s current remote directory. Timeout integer The amount of time to wait for the SFTP server to respond. This timeout is used when the SFTP server places the SFTP connection used by this activity into a waiting state. This overrides the value specified in the SFTP Connection resource. Output This activity produces no output. Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity. Exception ConnectionErrorException CommandExecutionException Thrown When... An error occurred when connecting to the SFTP server. An error occurred when executing the SFTP command.

31 SFTP Dir 17 SFTP Dir Activity SFTP Dir activity provides a list of files in the specified directory of the SFTP server. Configuration The Configuration tab has the following fields. Field Global Var? Description Name No The name to be displayed as the label for the activity in the process definition. Description No A short description of the activity. SFTP Connection No The path to the shared configuration resource containing the user information such as host name, username, port, and password or private key. For details, refer to SFTP Connection. Quit (post-command) Show Short File Names No No Select this check box to specify that the SFTP connection should be closed after completing this command. Not selecting this check box keeps the SFTP connection open so that all SFTP activities that specify the same SFTP connection (that is, the same host, port, username, and password) share the SFTP session until the connection is closed. To view only the file names as a list, select this checkbox. If the checkbox is not selected, the specified detailed information about the files and directories is visible.

32 18 Chapter 2 SFTP Palette Input The following is the input for the activity. Input Item Datatype Description Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection resource. Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection resource. UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection resource. Password string The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection resource. PrivKey string The private key s absolute path to authenticate your login. The password and private key are the preferred methods of authentication when using the SFTP module. However, you can use either of them to connect to the SFTP server. PrivKeyPass string The password of the private key, if using the priv key authentication method to log on to SFTP server Directory string The path to the directory for which you want to list the files and directory. This parameter is optional, and if null, the current remote directory is listed. Timeout integer The amount of time to wait for the SFTP server to respond. This timeout is used when the SFTP server places the SFTP connection used by this activity into a waiting state. This overrides the value specified in the SFTP Connection resource.

33 SFTP Dir 19 Output The following is the output for the activity. Output Item Datatype Description ItemCount integer The number of entries returned from the remote directory listing. DirectoryItems string A repeating element containing the list of files returned. Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity. Exception ConnectionErrorException CommandExecutionException Thrown When... An error occurred when connecting to the SFTP server. An error occurred when executing the SFTP command.

34 20 Chapter 2 SFTP Palette SFTP Get Activity SFTP Get activity issues an SFTP get and mget command to the specified server. The content of the remote files can be placed in the activity s output or written directly to local storage. If you choose to place the contents of a remote file into the activity s output, you can only retrieve one remote file (SFTP get command) and the file s content will be stored in memory as part of the activity s output. If you choose to write the contents of the retrieved files to local storage, you can retrieve one or more files (SFTP get and mget commands). Note: When transferring a directory from the source to the destination, the sub-directories and files are also transferred to the specified destination. Configuration The Configuration tab has the following fields. Field Global Var? Description Name No The name to be displayed as the label for the activity in the process definition. Description No Short description of the activity. SFTP Connection No Path to the shared configuration resource containing the user information such as host name, username, and password or private key. For details, refer to SFTP Connection. Quit (post-command) No Select this check box to specify that the SFTP connection should be closed after completing this command. If this check box is not selected, the SFTP connection remains open so that all SFTP activities that specify the same SFTP connection (that is, the same host, port, and username) share the SFTP session until the connection is closed.

35 SFTP Get 21 Field Global Var? Description Use Process Data Yes Specify to write contents of the file retrieved from the SFTP server to the process data. The activity s output includes an element that contains the remote file s contents, and the data can be used by subsequent activities in the process definition. Warning: Do not use this option if you are retrieving multiple files. You can only write the contents of one file to this activity s output. Do not specify wildcards in the RemoteFilename input element when this field is selected. Persist Timestamp while Copy File No Selecting this check box specifies that the original time stamp of file persists while transferring the original/source file from the remote machine to local machine. Binary Yes Specifies whether to retrieve the file content in the binary or ASCII mode (selected signifies binary). When the ASCII mode is used, differences in line endings between the SFTP server and the machine executing the SFTP command are automatically handled. Also, the ASCII mode implies text data, and that data can be encoded in a character encoding other than the ASCII (such as UTF-8 or Latin-1). Overwrite Existing File Yes If selected, any existing local files are overwritten if the SFTP command returns files with the same names. This field is disabled when the User Process Data checkbox is selected. If this field is not selected, any attempt to write a file to disk with the same name as an existing file throws an exception.

36 22 Chapter 2 SFTP Palette Input The following is the input for the activity. Input Item Datatype Description RemoteFilename string The path and name of the file to retrieve from the remote server. Wildcards (? for any one character, * for one or more characters) are permitted in this field. Use more specific wild cards that result into a file name, such as, *.txt or *.pdf. You can specify an absolute or relative path for the remote file name. Relative paths are relative to the current directory path. Note: Do not specify wildcards for this element, if the Use Process Data Configuration field is selected. LocalFileName string This input item is available only if the Use Process Data field on the Configuration tab is not selected. This input item specifies the name and path of the local file where the contents of the retrieved file should be written. If more than one remote file is retrieved, the local files are named to match the remote file names. Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection resource. Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection resource. UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection resource.

37 SFTP Get 23 Input Item Datatype Description Password string The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection resource. PrivKey string The private key s absolute path to authenticate your login. The password and private key are the preferred methods of authentication when using the SFTP module. However, you can use either of them to connect to the SFTP server. PrivKeyPass string The password of the private key, if using the priv key authentication method to log on to SFTP server. Encoding string When the retrieved file is not binary and the Use Process Data field on the Configuration tab is selected, this specifies the character encoding of the retrieved file. If this is not specified, it is assumed that the encoding of the file is the same encoding of the machine where the SFTP command is executed. If the encoding of the local machine and the SFTP server are different, specify the encoding used by the SFTP server in this element and the activity converts the retrieved file into the local machine s encoding. Timeout integer The amount of time to wait for the SFTP server to respond. This timeout is used when the SFTP server places the SFTP connection used by this activity into a waiting state. This overrides the value specified in the SFTP Connection resource.

38 24 Chapter 2 SFTP Palette Output The output for the activity is the following. Output Item Datatype Description FilesTransferred complex When one or more remote files are retrieved and written to local storage, this element contains a list of the remote filenames that were retrieved. This element contains two elements, Name and NumOfBytes. If an error occurred while retrieving files, the activity output is not available, but the Error Output tab lists the successfully transferred files and the files that failed to be transferred. ASCII data or Binary data string Available only when Use Process Data is selected. If binary element is selected, the field displays binary data. Selecting ASCII data element results in the Output tab getting populated with the retrieved file data from the remote server. Name string The name of the remote file retrieved. NumOfBytes integer The number of bytes contained in the associated file name. Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity. Exception GetFilesException ConnectionErrorException CommandExecutionException Thrown When... An error occurred during the SFTP get operation. An error occurred when connecting to the SFTP server. An error occurred when executing the SFTP command.

39 SFTP Get 25 Exception ConnectionTimeoutException Thrown When... The connection to the SFTP server has timed out before the command has completed its execution.

40 26 Chapter 2 SFTP Palette SFTP Get Default Directory Activity SFTP Get Default Directory activity retrieves the name of the current remote directory. The default remote directory is operating system-dependent and determined by the remote SFTP server. On UNIX systems, the default remote directory is usually the home directory of the user account that is used to establish an SFTP connection. The current remote directory may be different from the default directory. When SFTP Change Default Directory activity is used to change the default directory in the same session, it returns the currently set remote directory path. Configuration The Configuration tab has the following fields. Field Global Var? Description Name No The name to be displayed as the label for the activity in the process definition. Description No A short description of the activity. SFTP Connection Quit (post-command) No No The path to the shared configuration resource containing the user information such as host name, user name, and password or private key. For configuration details, refer to SFTP Connection. Select this check box to specify that the SFTP connection should be closed after completing this command. Not selecting this check box keeps the SFTP connection open so that all SFTP activities specifying the same SFTP connection (that is, the same host, port, and username) share the SFTP session until the connection is closed.

41 SFTP Get Default Directory 27 Input The input for the activity is the following. Input Item Datatype Description Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection resource. Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection resource. UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection resource. Password string The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection resource. PrivKey string The private key s absolute path to authenticate your login. The password and private key are the preferred methods of authentication when using the SFTP module. However, you can use either of them to connect to the SFTP server. PrivKeyPass string The password of the private key, if using the priv key authentication method to log on to SFTP server. Timeout integer The amount of time to wait for the SFTP server to respond. This timeout is used when the SFTP server places the SFTP connection used by this activity into a waiting state. This overrides the value specified in the SFTP Connection resource.

42 28 Chapter 2 SFTP Palette Output The output for the activity is the following. Output Item Datatype Description CurrentDirectory string The currently set directory on the remote SFTP server. By default, this directory is set by the SFTP server. Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity. Exception ConnectionErrorException CommandExecutionException Thrown When... An error occurred when connecting to the SFTP server. An error occurred when executing the SFTP command.

43 SFTP Make Remote Directory 29 SFTP Make Remote Directory Activity SFTP Make Remote Directory activity creates the specified directory on the remote SFTP server. Configuration The Configuration tab has the following fields. Field Global Var? Description Name No The name to be displayed as the label for the activity in the process definition. Description No A short description of the activity. SFTP Connection Quit (post-command) No No The path to the shared configuration resource containing the user information such as the host name, user name, and password or private key. For configuration details, refer to SFTP Connection. Select this check box to specify that the SFTP connection should be closed after completing this command. Not selecting this check box keeps the SFTP connection open so that all the SFTP activities that specify the same SFTP connection (that is, the same host, port, and username) share the SFTP session until the connection is closed.

44 30 Chapter 2 SFTP Palette Input The following is the input for the activity. Input Item Datatype Description Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection resource. Port integer The port number for the incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection resource. UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection resource. Password string Password for logging into the SFTP server. This overrides the value specified in the FTP Connection resource. PrivKey string The private key s absolute path to authenticate your login. The password and private key are the preferred methods of authentication when using the SFTP module. However, you can use either of them to connect to the SFTP server. PrivKeyPass string The password of the private key, if using the priv key authentication method to log on to SFTP server. ParentRemoteDire ctory string This element is concatenated with the RemoteDirName element to provide the complete path to the directory to create. If using the relative path, then this path will be relative to the current set directory. This element is optional.

45 SFTP Make Remote Directory 31 Input Item Datatype Description RemoteDirName string The name of the remote directory to create. You can optionally include the complete path of the directory to create. If relative path is used, then this path will be relative to the current set directory. Timeout integer The amount of time to wait for the SFTP server to respond. This timeout is used when the SFTP server places the SFTP connection used by this activity into a waiting state. This overrides the value specified in the SFTP Connection resource. Output This activity produces no output. Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity. Exception ConnectionErrorException CommandExecutionException Thrown When... An error occurred when connecting to the SFTP server. An error occurred when executing the SFTP command.

46 32 Chapter 2 SFTP Palette SFTP Put Activity SFTP Put activity issues an SFTP put or mput command to the specified server. You can use process data as the content of the file to send to the remote server or you can send files from local disk storage. If using process data, you can place only one file on the remote server (SFTP put command). If using locally stored files, you can place one or more files on the remote server (SFTP put or mput command). Note: When transferring a directory from the source to the destination, the sub-directories and files are also transferred to the specified destination. Configuration The Configuration tab has the following fields.input Field Global Var? Description Name No The name to be displayed as the label for the activity in the process definition. Description No A short description of the activity. SFTP Connection No The path to the shared configuration resource containing the user information such as the host name, user name, and password or private key. For configuration details, refer to SFTP Connection. Quit (post-command) No Select this field to specify that the SFTP connection should be closed after completing this command. Not selecting this field keeps the SFTP connection open so that all SFTP activities specifying the same SFTP connection, (that is, the same host, port, and username) share the SFTP session until the connection is closed.

47 SFTP Put 33 Field Global Var? Description Binary Yes Specifies whether to send the file content in binary or ASCII mode (selected signifies binary). When ASCII mode is used, differences in line endings between the SFTP server and the machine executing the SFTP command are automatically handled. Also, the ASCII mode implies text data and that data can be encoded in a character encoding other than ASCII (such as UTF-8 or Latin-1). Timeout (msec) Yes The amount of time to wait (in milliseconds) for the SFTP server to respond. This timeout is used when the SFTP server places the SFTP connection used by this activity into a waiting state. This overrides the value specified in the SFTP Connection resource. Overwrite Existing File Yes Selecting this check box overwrites any existing files on the SFTP server, if the SFTP command sends files with the same names. If this chec box is not selected, any attempt to send a file to the remote server with the same name as an existing file throws an exception. Append Yes This field is only available when the Overwrite Existing File check box is not selected. This field specifies whether to append data to an existing file. If the specified file exists on the SFTP server, append the data to the file when this field is selected. Use Process Data Yes Specifies to use process data as the content of the file to place on the remote server. If this check box is selected, you can only place one file on the remote server.

48 34 Chapter 2 SFTP Palette Field Persist Timestampwhile Copy File Global Var? No Description Selecting this check box specifies that the original time stamp of file persists while transferring the original/source file from the local machine to the remote machine. Input The following is the input for the activity. Input Item Datatype Description RemoteFilename string The path and name of the file to place onto the remote server. Wildcards are not permitted in this field. Data string This field is available only when the Use Process Data check box is selected. LocalFilename string The path and name of the local file to use in the SFTP Put command. This item is available only when the Use Process Data field is not selected. If using wild cards, keep them specific as a file name such as, *.txt or *.pdf. Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection resource. Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection resource. UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection resource. Password string The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection resource.

49 SFTP Put 35 Input Item Datatype Description PrivKey string The private key s absolute path to authenticate your login. The password and private key are the preferred methods of authentication when using the SFTP module. However, you can use either of them to connect to the SFTP server. PrivKeyPass string The password of the private key, if using the priv key authentication method to log on to SFTP server. Encoding string When the file to send is not binary and the Use Process Data check box on the Configuration tab is selected, this specifies the character encoding of the file to send to the SFTP server. If this is not specified, it is assumed that the encoding of the file is the same encoding of the machine where the SFTP command is executed. If the encoding of the local machine and the SFTP server are different, specify the encoding used by the SFTP server in this element and the activity converts the file into the specified encoding. Timeout integer The amount of time to wait for the SFTP server to respond. This timeout is used when the SFTP server places the SFTP connection used by this activity into a waiting state. This overrides the value specified in the SFTP Connection resource.

50 36 Chapter 2 SFTP Palette Output The output for the activity is the following. Output Item Datatype Description FilesTransferred complex A repeating element containing a list of names of files and NumOfBytes (file size) that were transferred. If an error occurred while transferring files, the activity output is not available. However, the Error Output tab lists the successfully transferred files and the files that failed to be transferred. Name string The name of the remote file retrieved. NumOfBytes integer The number of bytes contained in the associated file name. Error Output The Error Output tab lists the possible exceptions that can be thrown by this activity. Exception PutFilesException ConnectionErrorException CommandExecutionException ConnectionTimeoutException Thrown When... An error occurred during the SFTP put operation. An error occurred when connecting to the SFTP server. An error occurred when executing the SFTP command. The connection to the SFTP server has timed out before the command has completed it execution.

51 SFTP Remove Remote Directory 37 SFTP Remove Remote Directory Activity SFTP Remove Remote Directory activity deletes the specified directory from the remote SFTP server. Configuration The Configuration tab has the following fields. Field Global Var? Description Name No The name to be displayed as the label for the activity in the process definition. Description No A short description of the activity. SFTP Connection No The path to the shared configuration resource containing the user information such as host name, user name, and password or private key. For details, refer to SFTP Connection. Quit (post-command) Include Sub Directory/Files No No Select this field to specify that the SFTP connection should be closed after completing this command. Not selecting this check box keeps the SFTP connection open so that all SFTP activities specifying the same SFTP connection (that is, the same host, port, and username) share the SFTP session until the connection is closed. Select this check box, if you want to delete non-empty directories or folders.