TIBCO ActiveMatrix BusinessWorks Plug-in for sftp User's Guide

Transcription

1 TIBCO ActiveMatrix BusinessWorks Plug-in for sftp User's Guide Software Release 6.1 January 2016 Two-Second Advantage

2 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 THE 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, Two-Second Advantage, TIBCO Hawk, TIBCO Rendezvous, TIBCO Runtime Agent, TIBCO ActiveMatrix BusinessWorks, TIBCO Administrator, TIBCO Designer, TIBCO ActiveMatrix Service Gateway, TIBCO BusinessEvents, TIBCO BusinessConnect, and TIBCO BusinessConnect Trading Community Management are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise Edition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle Corporation 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 3 Contents TIBCO Documentation and Support Services...4 Accessing Documentation and Changing Help Preferences...5 SFTP Activities...6 About TIBCO ActiveMatrix BusinessWorks Plug-in for sftp...7 SFTP Palette...8 SFTP Change Default Directory...8 SFTP Close Connection...10 SFTP Delete File...11 SFTP Dir...13 SFTP Get...15 SFTP Make Remote Directory...18 SFTP Get Default Directory...20 SFTP Put SFTP Remove Remote Directory SFTP Rename File...27 SFTP Connection Error Codes SFTP Plug-in Error Codes...33 Samples...39 Accessing Samples Setting the Default Application Profile...39 SFTP Put and SFTP Get Activities Sample...40

4 4 TIBCO Documentation and Support Services Documentation for this and other TIBCO products is available on the TIBCO Documentation site. This site is updated more frequently than any documentation that might be included with the product. To ensure that you are accessing the latest available help topics, please visit: Product-Specific Documentation The following documents for this product can be found on the TIBCO Documentation site: TIBCO ActiveMatrix BusinessWorks Plug-in for sftp Installation TIBCO ActiveMatrix BusinessWorks Plug-in for sftp User's Guide TIBCO ActiveMatrix BusinessWorks Plug-in for sftp Release Notes How to Contact TIBCO Support For comments or problems with this manual or the software it addresses, contact TIBCO Support: 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. 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 the following web address:

5 5 Accessing Documentation and Changing Help Preferences By default, access to the TIBCO ActiveMatrix BusinessWorks Plug-in for sftp documentation from TIBCO Business Studio, is through However, if you do not have constant Internet access, you can download the complete TIBCO ActiveMatrix BusinessWorks Plug-in for sftp 6.X.X documentation set and configure TIBCO Business Studio to this local copy. Accessing Documentation The TIBCO ActiveMatrix BusinessWorks Plug-in for sftp documentation can be accessed in the following ways: Online Mode: The online documentation is available on the TIBCO Product Documentation site at The site contains latest versions of the documentation. Check the Doc site frequently for updated documentation. Offline Mode: For environments that do not have Internet access, the product documentation can be downloaded from the TIBCO Product Documentation site using the Download All button, or from and made available offline either on a local or a network drive. By default, TIBCO Business Studio accesses documentation from the TIBCO Product Documentation site. To access the product documentation in the offline mode, change the help preferences in TIBCO Business Studio to access help from a local directory or from an internal web server. Prerequisites Before changing the help preferences, download TIBCO ActiveMatrix BusinessWorks Plug-in for sftp 6.X.X documentation from 1. Click 2. In the Search field, type ActiveMatrix BusinessWorks Plug-in for sftp and press Return. 3. Select TIBCO ActiveMatrix BusinessWorks Plug-in for sftp 6.X.X from the list. 4. Scroll to the bottom of the page and click the Download All button. 5. A zip file containing the latest documentation downloads to your web browser's default download location. Copy the zip file to a local directory, or to an internal web server and then unzip the file. Changing Help Preferences Procedure 1. In TIBCO Business Studio, click Window > Preferences. On Mac OS X, click TIBCO Business Studio > Preferences. 2. In the Preferences dialog, click BusinessWorks > Help. 3. Under BusinessWorks SFTP Plugin, click Custom Location and then click Browse to select the html directory where you unzipped the documentation, or provide the URL to the html directory on your internal web server. 4. Click Apply and then click OK.

6 6 SFTP Activities Activities are individual units of work in a process. Activities are generally operations that interface to the external systems, but they can also perform internal processing. These activities are available on the various palettes in TIBCO Business Studio. Each palette has a set of activities that can be performed for that palette. Each SFTP activity invokes different SFTP commands such as, cd, ls, mkdir, rmdir, rm, put, and get. The SFTP palette consists of the following activities. The SFTP Connection is a shared resource: SFTP Change Default Directory 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 SFTP Connection

7 7 About TIBCO ActiveMatrix BusinessWorks Plug-in for sftp TIBCO ActiveMatrix BusinessWorks Plug-in for sftp encrypts both commands and data, providing effective protection against common network security risks. SFTP (Secure File Transfer Protocol) denotes security and it encrypts all data before sending it across the network. Using TIBCO ActiveMatrix BusinessWorks Plug-in for sftp you can transfer files between hosts. Migration Support TIBCO ActiveMatrix BusinessWorks Plug-in for sftp supports migration of an existing sftp Plug-in TIBCO Designer based project to TIBCO ActiveMatrix BusinessWorks Plug-in for sftp in Eclipse Modeling Framework Refer to TIBCO ActiveMatrix BusinessWorks Migration guide for more information about migrating an existing ActiveMatrix BusinessWorks 5.x TIBCO Designer based project to ActiveMatrix BusinessWorks in Eclipse Modeling Framework.

8 8 SFTP Palette The SFTP palette is used to issue the SFTP commands. SFTP Change Default Directory The SFTP Change Default Directory activity changes the current default directory on the remote machine to the specified directory path. General The General tab has the following fields. Field Literal Value/ Module Property Name No The name to be displayed as the label for the activity in the process. SFTP Connection Yes The path to the shared configuration resource containing the user information such as Host, Port, User Name, Private Key or Password, and Known Host File. For more details on configuration, see SFTP Connection. Quit (postcommand) No When this check box is selected, it specifies 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 specifying the same SFTP Connection, (that is, the same host, port, and username) share the existing SFTP session until the connection is closed. Provide a short description for the activity. Input The following is the input for the activity. Input Item Datatype Host string The name or IP address of the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Port integer The port number for the incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection shared resource.

9 9 Input Item Datatype UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Password password The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared 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 password The password of the private key, if using the PrivKey authentication method to log on to SFTP server. Proxy Host string Specifies the host name or IP address of the proxy server. Proxy Port integer Specifies the port number of the proxy server. Proxy User Name string Specifies the user name used to connect to the proxy server, if necessary. Proxy Password password Specifies the password for the specified user name when connecting to the proxy server, if necessary. NewDefaultDir string The new default directory to be set as a default directory for the current session. This element is mandatory. 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 shared resource. Fault The Fault tab lists the possible exceptions thrown by this activity. Exception CommandExecutionException ConnectionErrorException Thrown When... An error occurs when executing the SFTP command. An error occurs when connecting to the SFTP server.

10 10 SFTP Close Connection The SFTP Close Connection activity closes the connection for the configured HostIP, Port, and username. This activity enables the user to close the used connection even when the Quit check box is not selected on the activity level configuration. General The General tab has the following fields. Field Literal Value/ Module Property Name No The name to be displayed as the label for the resource. SFTP Connection Yes The path to the shared configuration resource containing the user information such as Host, Port, User Name, Private Key or Password, and Known Host File. For configuration details, refer to SFTP Connection. Quit (postcommand) No When this check box is selected, it specifies 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 specifying the same SFTP Connection, (that is, the same host, port, and username) share the existing SFTP session until the connection is closed. Provide a short description for the activity. Input The following is the input for the activity. Input Item Datatype Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection shared resource. UserName string The user name for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Proxy Host string Specifies the host name or IP address of the proxy server. Proxy Port integer Specifies the port number of the proxy server.

11 11 Input Item Datatype Proxy User Name string Specifies the user name used to connect to the proxy server, if necessary. Fault The Fault tab lists the possible exceptions that can be thrown by this activity. Exception CommandExecutionException ConnectionErrorException Thrown When... An error occurs when executing the SFTP command. An error occurs when connecting to the SFTP server. SFTP Delete File The SFTP Delete File activity issues an SFTP rm command to remove one or more files from the remote server. General The General tab has the following fields. Field Literal Value/ Module Property Name No The name to be displayed as the label for the activity in the process. SFTP Connection Quit (postcommand) Yes No The path to the shared configuration resource containing the user information such as Host, Port, User Name, Private Key or Password, and Known Host File. For configuration details, refer to SFTP Connection. When this check box is selected, it specifies 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 specifying the same SFTP Connection, (that is, the same host, port, and username) share the existing SFTP session until the connection is closed. Provide a short description for the activity. Input The following is the input for the activity.

12 12 Input Item Datatype Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Port integer The port number for the incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection shared resource. UserName string The username for logging to the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Password password The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource. PrivKey string The private key s absolute path to authenticate your login. 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 password The password of the private key, if using the PrivKey authentication method to log on to SFTP server. Proxy Host string Specifies the host name or IP address of the proxy server. Proxy Port integer Specifies the port number of the proxy server. Proxy User Name string Specifies the user name used to connect to the proxy server, if necessary. Proxy Password password Specifies the password for the specified user name when connecting to the proxy server, if necessary. 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 file(s) to be deleted. This element is optional. RemoteFilename string The path and name of the file to delete on the remote server. Wildcards (? for any one character or * for one or more characters) are permitted in this field. It is recommended not to use wildcards as this activity may delete all the files matching with configured wild card names. This leads to loss of the files. You can specify an absolute or relative path for the remote file name. Relative paths are specified in the RemoteDirectory element and the user s current remote directory.

13 13 Input Item Datatype 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 shared resource. Fault The Fault tab lists the possible exceptions that can be thrown by this activity. Exception CommandExecutionException ConnectionErrorException Thrown When... An error occurs when executing the SFTP command. An error occurs when connecting to the SFTP server. SFTP Dir The SFTP Dir activity provides a list of files in the specified directory of the SFTP server. General The General tab has the following fields. Field Literal Value/ Module Property Name No The name to be displayed as the label for the activity in the process. SFTP Connection Yes The path to the shared configuration resource containing the user information such as Host, Port, User Name, Private Key or Password, and Known Host File. For configuration details, refer to SFTP Connection. Quit (postcommand) Show Short File Names No No When this check box is selected, it specifies 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 specifying the same SFTP Connection, (that is, the same host, port, and username) share the existing SFTP session until the connection is closed. Select this check box to view the file names only as a list. If the check box is not selected, the specified detailed information about the files and directories is visible.

14 14 Provide a short description for the activity. Input The following is the input for the activity. Input Item Datatype Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection shared resource. UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Password password The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared 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 password The password of the private key, if using the PrivKey authentication method to log on to SFTP server. Proxy Host string Specifies the host name or IP address of the proxy server. Proxy Port integer Specifies the port number of the proxy server. Proxy User Name Proxy Password string password Specifies the user name used to connect to the proxy server, if necessary. Specifies the password for the specified user name when connecting to the proxy server, if necessary. Directory string The path to the directory for which you want to list the files and directory. This parameter is optional, and if null, lists the 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 shared resource. Output The following is the output for the activity.

15 15 Output Item Datatype ItemCount integer The number of entries returned from the remote directory listing. DirectoryItems string A repeating element containing the list of files returned. Fault The Fault tab lists the possible exceptions that can be thrown by this activity. Exception CommandExecutionException ConnectionErrorException Thrown When... An error occurs when executing the SFTP command. An error occurs when connecting to the SFTP server. SFTP Get The 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). Using the SFTP Get activity, you can copy the directories and subdirectories including all files from the source machine to the destination machine. General The General tab has the following fields. Field Literal Value/ Module Property Name No The name to be displayed as the label for the activity in the process. SFTP Connection Yes The path to the shared configuration resource containing the user information such as Host, Port, User Name, Private Key or Password, or Known Host File. For configuration details, refer to SFTP Connection. Quit (postcommand) No When this check box is selected, it specifies 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 specifying the same SFTP Connection, (that is, the same host, port, and username) share the existing SFTP session until the connection is closed.

16 16 Field Literal Value/ Module Property Use Process Data No 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. 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. It is recommended not to specify wildcards in the RemoteFilename input element, when this check box is selected. Binary No Specifies whether to retrieve the file content in the binary or ASCII mode (selected signifies binary). When the ASCII mode is used, differences inline 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 Persist Timestamp while Copy File No No If selected, any existing local files are overwritten if the SFTP command returns files with the same names. This check box option is disabled when the User Process Data check box is selected. If this check box is not selected, any attempt to write a file to disk with the same name as an existing file throws an exception. 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. Provide a short description for the activity. Input The following is the input for the activity. Input Item Datatype 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. Do not specify wildcards for this element, if the Use Process Data Configuration check box is selected.

17 17 Input Item Datatype LocalFileName string This input item is available only if the Use Process Data check box on the General 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 shared resource. Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection shared resource. UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Password password The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource. PrivKey string The private key s absolute path to authenticate your login. Password and private key are the preferred for authentication when using the SFTP module. However, you can use either of them to connect to the SFTP server. PrivKeyPass password The password of the private key, if using the PrivKey authentication method to log on to SFTP server. Proxy Host string Specifies the host name or IP address of the proxy server. Proxy Port integer Specifies the port number of the proxy server. Proxy User Name string Specifies the user name used to connect to the proxy server, if necessary. Proxy Password password Specifies the password for the specified user name when connecting to the proxy server, if necessary. 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 shared resource. Input Item is Datatype. Output The following is the output for the activity.

18 18 Output Item Datatype Files Transferred 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 happens while retrieving files, the activity output is not available. However, the Fault 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 check box is selected. Name string The name of the retrieved remote file. NumOfBytes integer The number of bytes contained in the associated file name. Fault The Fault tab lists the possible exceptions that can be thrown by this activity. Exception GetFilesException ConnectionErrorException CommandExecutionException ConnectionTimeoutException When Thrown.. An error occurs during the SFTP get operation. An error occurs when connecting to the SFTP server. An error occurs when executing the SFTP command. The connection to the SFTP server times out before completing the command execution. SFTP Make Remote Directory The SFTP Make Remote Directory activity creates the specified directory on the remote SFTP server. General The General tab has the following fields. Field Literal Value/ Module Property Name No The name to be displayed as the label for the activity in the process. SFTP Connection Yes The path to the shared configuration resource containing the user information such as Host, Port, User Name, Private Key and Password or Known Host File. For configuration details, refer to SFTP Connection.

19 19 Field Quit (postcommand) Literal Value/ Module Property No When this check box is selected, it specifies 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 specifying the same SFTP Connection, (that is, the same host, port, and username) share the existing SFTP session until the connection is closed. Provide a short description for the activity. Input The following is the input for the activity. Input Item Datatype Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Port integer The port number for the incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection shared resource. UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Password password The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource. PrivKey string The private key s absolute path to authenticate your login. 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 password The password of the private key, if using the PrivKey authentication method to log on to SFTP server. ParentRemoteDirectory 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. Proxy Host string Specifies the host name or IP address of the proxy server.

20 20 Input Item Datatype Proxy Port integer Specifies the port number of the proxy server. Proxy User Name string Specifies the user name used to connect to the proxy server, if necessary. Proxy Password password Specifies the password for the specified user name when connecting to the proxy server, if necessary. 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 shared resource. Fault The Fault tab lists the possible exceptions that can be thrown by this activity. Exception CommandExecutionException ConnectionErrorException Thrown When.. An error occurs when executing the SFTP command. An error occurs when connecting to the SFTP server. SFTP Get Default Directory The 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. General The General tab has the following fields. Field Literal Value/ Module Property Name No The name to be displayed as the label for the activity in the process.

21 21 Field Literal Value/ Module Property SFTP Connection Yes The path to the shared configuration resource containing the user information such as Host, Port, User Name, Private Key and Password or Known Host File. For configuration details, refer to SFTP Connection. Quit (postcommand) No When this check box is selected, it specifies 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 specifying the same SFTP Connection, (that is, the same host, port, and username) share the existing SFTP session until the connection is closed. Provide a short description for the activity. Input The following is the input for the activity. Input Datatype Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Username string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Password password The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared 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. PrivKeyPasss password The password of the private key, if using the PrivKey authentication method to log on to SFTP server. Proxy Host string Specifies the host name or IP address of the proxy server. Proxy Port integer Specifies the port number of the proxy server. Proxy User Name string Specifies the user name used to connect to the proxy server, if necessary.

22 22 Input Datatype Proxy Password password Specifies the password for the specified user name when connecting to the proxy server, if necessary. 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 shared resource. Output The output for the activity is the following. Output Item Datatype CurrentDirectory string The current set directory on the remote SFTP server. By default, this directory is set by the SFTP server. Fault The Fault tab lists the possible exceptions that can be thrown by this activity. Exception CommandExecutionException ConnectionErrorException Thrown when.. An error occurs when executing the SFTP server. An error occurs when connecting to the SFTP command. SFTP Put The 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). Using the SFTP Put activity, you can copy the directories and subdirectories including all files from the source machine to the destination machine. General The General tab has the following fields. Field Literal Value/ Module Property Name No The name to be displayed as the label for the activity in the process.

23 23 Field SFTP Connection Quit (postcommand) Use Process Data Literal Value/ Module Property Yes No No The path to the shared configuration resource containing the user information such as Host, Port, User Name, and Private Key or Known Host File. For configuration details, refer to SFTP Connection. When this check box is selected, it specifies 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 specifying the same SFTP Connection, (that is, the same host, port, and username) share the existing SFTP session until the connection is closed. 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. Binary No 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). Overwrite Existing File Persist Timestamp while Copy File No No Selecting this check box overwrites any existing files on the SFTP server, if the SFTP command sends files with the same names. If this check 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. 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. Append No This option is only available when the Overwrite Existing File check box is not selected. This 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 check box is selected. 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. Default is This overrides the value specified in the SFTP Connection shared resource.

24 24 Provide a short description for the activity. Input The following is the input for the activity. Input Item Datatype RemoteFilename string The path and name of the file to place onto the remote server. Wildcards are not permitted in this field. LocalFilename string The path and name of the local file to use in the SFTP put command. This element is available only when the Use Process Data check box 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 shared resource. Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection shared resource. UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Password password The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared 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. PriveKeysPass password The password of the private key, if using the PrivKey authentication method to log on to SFTP server. Proxy Host string Specifies the host name or IP address of the proxy server. Proxy Port integer Specifies the port number of the proxy server. Proxy User Name string Specifies the user name used to connect to the proxy server, if necessary. Proxy Password password Specifies the password for the specified user name when connecting to the proxy server, if necessary.

25 25 Input Item Datatype 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 shared resource. Output The output for the activity is the following. Output Item Datatype 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 Fault 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. Fault The Fault tab lists the possible exceptions thrown by this activity. Exception PutFilesException ConnectionErrorException CommandExecutionException ConnectionTimeoutException Thrown When.. An error occurs during the SFTP put operation. An error occurs when connecting to the SFTP server. An error occurs when executing the SFTP command. The connection to the SFTP server has timed out before the command has completed it execution. SFTP Remove Remote Directory The SFTP Remove Remote Directory activity deletes the specified directory from the remote SFTP server. General The General tab has the following fields.

26 26 Field Literal Value/ Module Property Name No The name to be displayed as the label for the activity in the process. SFTP Connection Quit (postcommand) Remove Recursively Yes No No The path to the shared configuration resource containing the user information such as Host, Port, User Name, Private Key or Password, and Known Host File. For configuration details, refer to SFTP Connection. When this check box is selected, it specifies 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 specifying the same SFTP Connection, (that is, the same host, port, and username) share the existing SFTP session until the connection is closed. Selecting this check box deletes all the non-empty directories from the remote location (including subdirectories). Provide a short description for the activity. Input The input for the activity is the following. Input Item Datatype Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection shared resource. UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Password password The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared 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.

27 27 Input Item Datatype PrivKeyPass password The password of the private key, if using the PrivKey authentication method to log on to SFTP server. Proxy Host string Specifies the host name or IP address of the proxy server. Proxy Port integer Specifies the port number of the proxy server. Proxy User Name string Specifies the user name used to connect to the proxy server, if necessary. Proxy Password password Specifies the password for the specified user name when connecting to the proxy server, if necessary. ParentRemoteDirectory string The parent directory path of the remote directory, you want to remove. This element is concatenated with the RemoteDirName element to provide the complete path to the directory to remove. This element is optional. RemoteDirName string The name of the remote directory to remove. Optionally, include the complete path of the directory to remove. 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. Fault The Fault tab lists the possible exceptions that can be thrown by this activity. Exception CommandExecutionException ConnectionErrorException Thrown When.. An error occurs when executing the SFTP server. An error occurs when connecting to the SFTP command. SFTP Rename File The SFTP Rename File activity renames the specified file on the remote SFTP server. General The General tab has the following fields. Field Literal Value/ Module Property Name No The name to be displayed as the label for the activity in the process.

28 28 Field SFTP Connection Quit (postcommand) Literal Value/ Module Property Yes No Path to the shared configuration resource containing the user information such as Host, Port, User Name, Private Key or Password, or Known Host File. For configuration details, refer to SFTP Connection. When this check box is selected, it specifies 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 specifying the same SFTP Connection, (that is, the same host, port, and username) share the existing SFTP session until the connection is closed. Provide a short description for the activity. Input The following is the input for the activity. Input Item Datatype Host string The name or IP of the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Port integer The port number for incoming SFTP requests on the SFTP server. This overrides the value specified in the SFTP Connection shared resource. UserName string The username for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared resource. Password password The password for logging into the SFTP server. This overrides the value specified in the SFTP Connection shared 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 password The password of the private key, if using the PrivKey authentication method to log on to SFTP server. Proxy Host string Specifies the host name or IP address of the proxy server. Proxy Port integer Specifies the port number of the proxy server. Proxy User Name string Specifies the user name used to connect to the proxy server, if necessary.

29 29 Input Item Datatype Proxy Password password Specifies the password for the specified user name when connecting to the proxy server, if necessary. OldRemoteDirectory string The path to the remote directory which contains the file you want to rename. This element is concatenated with the OldRemoteFileName element to provide the complete path to the file to rename. OldRemoteFilename string The name of the remote file you want to rename. You can optionally include the complete path of the file to rename. NewRemoteDirector y string The new path of the remote directory which contains the file to rename. This element is concatenated with the NewRemoteFileName element to provide the complete path to the file to rename. This element is optional. NewRemoteFilename string The new name for the remote file. You can optionally include the complete path of the file. 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 in a waiting state. This overrides the value specified in the SFTP Connection shared resource. Fault The Fault tab lists the possible exceptions that can be thrown by this activity. Exception CommandExecutionException ConnectionErrorException Thrown When... An error occurs when executing the SFTP command. An error occurs when connecting to the SFTP server. SFTP Connection The SFTP Connection shared resource describes a connection to an SFTP server. SFTP connections are used when configuring activities in the SFTP palette. General The General tab has the following fields. Field Package Name The name of the package. The name to be displayed as the label for the shared resource.

30 30 Field Short description of the shared resource. SFTPConnection Refer to the following table for the details. Field Datatype Literal Value/ Module Property Host string Yes The host name or IP address of the SFTP server. Port integer Yes The port number of the SFTP server. For SFTP connections 22 is the default, when no value is specified in this field. User Name string Yes The user name to log on to the SFTP server. Password password Yes The password to use when logging into the SFTP server when password supported authentication is used. Public Key Authentication No Select this check box to specify the private key, when using private key supported authentication. This check box when selected, displays the Private Key and Private Key Password fields. Private Key string Yes 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. It is recommended to configure the PrivKey path located out of the project to maintain privacy. Private Key Password password Yes The password of the private key. It is applicable only when private key supported authentication is used.

31 31 Field Datatype Literal Value/ Module Property Strict HostKey Check No 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. This option can be selected with both methods of authentication, Password and Private Key. Known Host File string Yes Contains the public keys with corresponding Host IP address for all hosts with which the client can communicate. This field is available only when Strict HostKey Check check box is selected. Configure the path of known_host file in this field. Known_Host_File does not exist - Browse using the Choose a resource and select the folder you want to generate the known_host file. It is recommended to configure the Known_ Host file path located out of the project to maintain privacy. Known_Host_File exists - Import the file with any preferred name within the project to use as known_host file. Connection Timeout (msec) integer Yes 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.

32 32 Field Datatype Literal Value/ Module Property Setup Host Public Key string Yes Click to install the Host Key with the corresponding Host IP into the Known Host File. This field is available only when Strict HostKey Check check box is selected. Firewall Yes Selecting firewall check box enables the Proxy Host, Proxy Port, and Proxy User Name fields and Proxy Password. If this check box is selected, you must supply the Proxy Host and Proxy Port fields with the name and the port of the proxy server used to access sites outside of a firewall. You can optionally specify the user name and password for the proxy server, if required. Proxy Host string Yes Specifies the host name or IP address of the proxy server. Proxy Port integer Yes Specifies the port number of the proxy server. Proxy User Name string Yes Specifies the user name used to connect to the proxy server, if necessary. Proxy Password password Yes Specifies the password for the specified user name when connecting to the proxy server, if necessary. Test Connection Button When the Test Connection button is clicked, ActiveMatrix BusinessWorks attempts to connect to the specified remote SFTP server on the specified port using the specified username, password, or priv key and host key entry into the known_host file (if Strict HostKey Check 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.

33 33 Error Codes This topic lists the error codes returned by the TIBCO ActiveMatrix BusinessWorks Plug-in for sftp. SFTP Plug-in Error Codes Refer to the following table for sftp Plug-in error codes: Error Codes Error Resolution BW-SFTP SFTP connection is required. Verify the SFTP connection. BW-SFTP BW-SFTP Cannot perform SFTP Operation: %1. Error Info: %2 Cannot establish SFTP connection when performing SFTP function: %1. Error Info: %2 Resolve the issue described in the Error Info section. Resolve the issue with config parameters for SFTP connection as described in the Error Info section. BW-SFTP File %1 already exists. Check whether the file with the specified name already exists. BW-SFTP BW-SFTP BW-SFTP Error in PUT or MPUT command. See Error Tab for details. Error in GET or MGET command. See Error Tab for details. SFTP Connection Succeeded. Server Version: %1. Resolve the issue as per the error details displayed in the Error tab. Resolve the issue as per the error details displayed in the Error tab. SFTP connection verified/succeeded. BW-SFTP Client is not initialized: %1. Make sure that the connection is already created and not getting closed before this activity. BW-SFTP Connection timeout. Try increasing the time limit configured in the timeout field. BW-SFTP BW-SFTP BW-SFTP Local file %1 cannot be found on specified location. Module property %1 not defined. Mandatory Private key field is not configured while using private Key based Authentication. Verify whether the file with specified file name exists at the specified location on the local disk. Verify whether the module property %1 is defined in the module property section. Provide the correct path for private key while using the private key based authentication.

34 34 Error Codes Error Resolution BW-SFTP BW-SFTP BW-SFTP Invalid user name or password for Host: %1. Error in executing remote command: %1 Connection reference is missing. Verify whether the username or password is correct for Host %1. Verify the environment to run the command %1 and then retry. Configure the shared connection resource before using this activity. BW-SFTP Field %1 is required. Configure the value for field %1. BW-SFTP BW-SFTP SFTP Connection Test Failed. Validate Host Name: %1 or Port %2. SFTP Connection Test Failed. Error: %1. Verify the configured host name or port number. Resolve the error mentioned in the error details. BW-SFTP File %1 does not exist. Verify whether the file %1 exists in the specified location. BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP Error while sftp connection. Reason : Hostkey has been rejected as Error while sftp connection. Reason : Hostkey has been changed & does not match with the existing key in Known Host File for Host: %1 Error changing remote working directory. Reason : input is null Error changing remote working directory. Reason : Remote Directory %1 not found. Error deleting remote directory. Reason : Remote Directory %1 does not exist. Error creating remote directory %1. Error creating remote directory. Reason: Remote Parent Dir %1 does not exist. Setup the host key in the Known Host File for Host %1. Setup the new host key in the Known Host File for Host %1. Verify the value for the new default directory. It should not be null or empty. Verify whether the specified remote directory %1 exists. Verify whether the specified remote directory %1 exists. Verify the valid permission for creating remote directory %1. Verify whether the remote parent directory %1 exists.

35 35 Error Codes Error Resolution BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP Error creating remote directory. Reason: Remote Dir %1 already exists. Error listing remote directory %1. Error performing PUT command for file %1. Error performing PWD command. Error while fetching server version information. Error in establishing sftp connection. SFTP Connection Test Failed. Host Key Validation Fail Path %1 for input field is not Absolute Path. Error renaming remote File. Reason: Remote File %1 already exist. Error renaming remote File. Reason: %1 Remote File %2 does not exist. The remote directory %1 should not already exist. Check for the required permission for listing the remote directory %1. Check for the required permission and configured environment to perform the PUT command for file %1. Check whether the specified directory exists and has the required permission for listing. Verify whether the server supports publishing the server version information. Verify the configuration values for establishing connection with specified host. Verify whether the correct host key is listed in the Known Host File for configured SFTP server. Verify whether the configured path %1 is Absolute Path. Verify whether file with the name %1 does not exist on the remote server. Verify whether %1 remote file with name %2 exist s on the remote server. BW-SFTP Error renaming remote File. Check the file location and required permission for renaming. BW-SFTP BW-SFTP BW-SFTP Error renaming remote File. Reason: Remote File %1 is not unique. Error creating remote directory. Reason: Permission Denied to make remote dir %1. Error deleting remote directory %1. Verify whether the configured file name %1 is unique and does not contain any wild card characters. Verify the required permission for creating the remote dir %1. Verify the required permission for deleting the remote directory %1.

36 36 Error Codes Error Resolution BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP Error deleting remote directory. Reason: Remote Dir %1 seems non empty. Error deleting remote directory. Reason: Permission Denied to remove remote dir %1. Error renaming remote File. Reason: Permission Denied to rename file %1. Error deleting remote File. Reason: Permission Denied to delete file %1. Error in establishing sftp connection. Reason: Connection Timeout with host %1. Remote File specified can not be found. Error in closing sftp connection. Invalid user name or private key or private key password for Host: %1. Private key not found in specified location: %1. Error while setting up host public key. Reason: Connection timeout for Host: %1 Error renaming remote File. Reason: %1 Remote Directory %2 does not exist. Error performing GET command for file %1 as the configured encoding type %2 is not supported. Verify and check whether the remote directory %1 is empty. Verify the required permission for deleting the remote directory %1. Verify the required permission for renaming the remote directory %1. Verify the required permission for deleting the remote file %1. Verify the configured timeout for host %1. Verify whether the specified remote file exists. Verify whether the SFTP Connection for the configured host, port, and username is not already closed. Verify the username, private key or private key password for Host %1. Verify whether the private key exists on the specified location %1. Verify whether the configured value for timeout is enough to setup the host key of Host %1. Verify whether %1 remote directory with the name %2 exists on the remote server and has the required permission. Verify whether the configured encoding type is correct and supported.

37 37 Error Codes Error Resolution BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP BW-SFTP Error performing PUT command for file %1 as the configured encoding type %2 is not supported. Error to GET remote File. Reason: Permission Denied to read remote file %1. Error to PUT remote File. Reason: Permission Denied to write remote file %1. Error listing remote directory. Reason: Permission Denied to read remote dir %1. Error to PUT remote File. Reason: Permission Denied to read/write remote dir %1. Error to GET remote File. Reason: Permission Denied to read/write remote dir %1. Error performing PUT command. Reason: File name expression is not unique for file %1. Error performing GET command. Reason: File name expression is not unique for file %1. File or Directory %1 does not exist. Error performing PUT command. Reason: Remote dir %1 does not exist. Error performing GET command. Reason: Remote dir %1 does not exist. Error performing GET command. Reason: Wild card character not allowed in Local file name %1. Error performing PUT command for file %1 as the configured encoding type %2 is not supported. Verify whether the required permission is granted to read remote file %1. Verify whether the required permission is granted to write remote file %1. Verify whether the required permission is granted for reading remote directory %1. Verify whether the required permission is granted for reading/ writing remote directory%1. Verify whether the required permission is granted for reading/ writing remote directory%1. Verify whether the configured file name %1 is unique and does not contain wild card characters. Verify whether the configured file name %1 is unique and does not contain wild card characters. Verify whether the file or directory with the name %1 exists. Verify whether the remote directory %1 exists. Verify whether the remote directory %1 exists. Verify to check that the local file name %1 does not contain wild card characters.

38 38 Error Codes Error Resolution BW-SFTP BW-SFTP BW-SFTP Error listing remote directory. Reason: Remote dir %1 does not exist. Error deleting remote file. Reason: Remote file %1 does not exist or not a valid file type. Error creating remote directory. Reason: Wild card character not allowed in directory name %1. Verify whether the remote directory %1 exists. Verify whether remote file %1 exists and is in a valid file type format. Check that the directory name %1 does not contain wild card characters.

39 39 Samples You can run the sample end-to-end and understand how the TIBCO ActiveMatrix BusinessWorks Plugin for sftp works in the Eclipse Modeling Framework. Accessing Samples Procedure 1. Launch TIBCO Business Studio from $TIBCO_HOME\studio\3.6\eclipse \TIBCOBusinessStudio.exe. By default, TIBCO Business Studio opens the Design perspective. 2. Navigate to the directory containing the sample you want to access. 3. Double-click the archive file, <sample_name>.zip, to import the sample application to your workspace. For example, double-click tibco.bw.sample.palette.sftp.putandget.zip to import the application and the application module to your workspace. Setting the Default Application Profile Procedure 1. Before running the sample make sure to update the default Application Profile according to the OS Platform you are running on. 2. Click the <Project>.application, expand Package Unit folder and open the Properties file. 3. If you are running on Unix based system, then select UnixProfile column header to enable Set as Default button. Click the Set as Default button to set it as the default Application Profile. The default Profile is indicated by the straight brackets [ ] around the Profile name.

40 40 If you are running on Windows system, then make sure the WindowsProfile is set as default before running or debugging this application in TIBCO Business Studio. 4. Save your project. SFTP Put and SFTP Get Activities Sample This sample service invokes the SFTP put and get commands. The service reads a file and places it on the specified SFTP server. After a short wait, the SFTP get command is issued and the file contents are written back to local storage. Prerequisites Copy the sftp-file.txt file included in this sample to the D:\tmp directory. If the directory is not available, refer to the steps listed in the Understanding the Configuration section. Ensure that the following SFTP server information is available: SFTP server name or IP address SFTP server port (default is 22) SFTP Username SFTP user Password Procedure 1. In the samples directory, select palette > sftp > PutAndGet and double-click tibco.bw.sample.palette.sftp.putandget. For more information, refer to Accessing Samples. 2. In the Project Explorer expand the tibco.bw.sample.palette.sftp.putandget project. 3. Set the default ApplicationProfile to match the OS you are running on. For more information, refer to Setting the Default Application Profile. 4. Copy the sftp-file.txt file to D:\tmp. 5. Fully expand the Resources directory and then double-click SFTPConnectionResource.sftpResource. Specify valid values for your SFTP connection in the Host, Port, User Name, and Password fields. Click Test Connection connection. Result to verify your SFTP The file specified by the module property SFTP-PutFile is copied to the SFTP server.