Transfer Files
Host Access for the Cloud supports three different file transfer protocols:
- IND$FILE for 3270 host transfers
- AS/400 for 5250 host transfers
- File Transfer Protocol (FTP), which allows a local computer to act as an FTP client.
Once connected, you can view files on the server and transfer files between your local computer (or any networked drive) and the host.
Batch file transfer is available for FTP transfers. Using this option you can download and upload multiple files in one operation.
Before you can transfer or send files, the administrator must enable the transfer, send options for the current session, and make the necessary configurations. This is done on the File Transfer settings panel.
Depending on the host file system and transfer method you want to use, you will see different configuration options. Once configured, the file transfer dialog box is available from the tool bar.
IND$FILE
IND$FILE is a file transfer program from IBM which you can use to transfer information between your computer and a 3270 host computer.
From the Host file system drop down list, select which IBM 3270 operating environment the host is running. Host Access for the Cloud supports TSO (Time Sharing Option), CMS (Conversational Monitor System) and CICS. The default selection is None.
There is support for ASCII or binary transfers and, if you connected to a TSO host, you can navigate directly to a particular TSO dataset.
General options for CICS, CMS, and TSO host file types
Automatically show host files - By default, the host file list contains all the host files that are available to transfer. To retrieve host files only when you request them, disable this option. On the Transfer dialog box, click Show host files to retrieve the host files.
Transfer options for CICS, CMS, and TSO host file types
Option | Description |
---|---|
Transfer method |
|
CR/LF processing | If this option is selected, carriage return - line feed pairs will be stripped from files sent to the host and added to the end of each line on files received from the host. |
Startup command | Specifies the host program used to initiate the file transfer. IND$File, the default, is appropriate for CMS and TSO hosts. For CICS hosts, IND$File may be appropriate, or you many need to specify your site’s CICS transaction (for example, CFTR). |
Startup parameters | Use this field for any parameters specific to the IND$File program on your host system. The contents of this field are appended to the end of the transfer command generated by Host Access for the Cloud. Host Access for the Cloud does not validate the parameters. |
Max field size | Select a field size to use with the Write Structured Field protocol. The default value is 4 kilobytes. Typically, the larger the buffer size, the faster the transfer. Most systems support 8K; if you choose a value that is too large for your host, it will disconnect your session when you first attempt to send a file big enough to fill the buffer. The person who installs the host communication software usually supplies this value. For example, IBM’s host TCP/IP product gets this value from the DATABUFFERPOOLSIZE parameter, which defaults to 8K buffers. See your system administrator if you don’t know what to enter here. |
Lead key | You can specify certain actions before transferring or listing files. Your choices are None, Auto Sense, and Clear. If set to None, LISTCAT is issued automatically. If set to Auto Sense, the current screen contents are examined to determine if a LISTCAT or TSO LISTCAT should be sent. If set to Clear, the Clear key is sent before issuing command. For TSO, Clear also means "TSO" will not be prepended to the request files command. |
PC code page | The character set to use when reading or writing local files during a file transfer. The value Default uses the code page corresponding to your operating systems locale. If you need a different character set to specify the PC code page, select it from the list. |
Host code page | The character set to use when translating EBCDIC characters while transferring files to or from the host. The default, Use NCS setting, uses the national character set specified on the Display panel under Terminal. If you need a different character set to specify the host code page, select it from the list. |
Response timeout (seconds) | Specifies how many seconds Host Access for the Cloud should wait for a host response before timing out and returning an error. The default value is 60 seconds. |
Startup timeout (seconds) | Specifies the number of seconds Host Access for the Cloud should wait for a host response when attempting to connect to a host. If the specified amount of time elapses with no response from the host, Host Access for the Cloud times out and returns an error. The default value is 25 seconds. |
Send options for CICS, CMS, and TSO host file types
Option | Description | Applies to this host type |
---|---|---|
Record format | Use this option to specify the record format for files sent to the host.
|
TSO, CMS |
Allocation units | Specifies the disk subdivisions for your primary and secondary space allocations. If you select Default (default), the unit is determined by the host. You can also select Cylinder, Track, or Block. If you select Block, use the Average block box to specify the size for an average block (in bytes). | TSO |
Logical record length | The record size (in bytes) for the file being created on the host. If you leave this box blank, the record size is determined by the host. You can set any value between 0 and 32767 to accommodate any range accepted by your host. This option is not available on CICS hosts. For ASCII files, set this value to accommodate the longest line in your file. When you leave this box blank, the host usually accepts lines of up to 80 characters. | TSO, CMS |
If host file exists | Specifies how the transfer should operate if a file with the same name already exists.
|
TSO, CMS |
Block size (bytes) | On TSO hosts, specifies the block size for the file being created on the host. For files with fixed-length records, this value must be a multiple of the Logical record length (because blocks are divided into logical records). You can set any value between 0 and 32767, to accommodate any range accepted by your host. | TSO |
Average block (bytes) | The size for an average block. This value is only relevant if you are using blocks as your allocation unit. | TSO |
Primary allocation (allocation units) | The size of the primary allocation for the host file being created. | TSO |
Secondary allocation (allocation units) | The size of any additional allocations in the event that the primary allocation is not sufficient. Multiple secondary allocations (known as "extents") are allowed, up to a host-specified limit (generally 15). | TSO |
note
When using CICS as the host system you must enter the names of the files you are transferring manually. A list of files to choose from is not available.
Transferring files (IND$FILE)
You must be connected and logged into the host to transfer files for the current 3270 session.
-
Verify that the host is in a ‘ready’ state to accept the IND$FILE command.
-
From the tool bar, click the IND$File icon .
-
The File Transfer dialog box displays a list of host files and directories that are available to transfer. Directories and files are indicated by an icon when you select the file. For CICS hosts, type in the names of the files you want to transfer.
-
Select the transfer method. The options are:
-
Binary
Use for program files and other types of files that should not be translated, such as files that have already been formatted for a particular type of printer or files with application-specific formatting. Binary files contain non-printable characters; using this method, a file is not converted or translated during the transfer.
-
ASCII
Use to transfer text files with no special formatting. ASCII files on the PC are translated to the EBCDIC character set on the host and host text files are converted from EBCDIC to ASCII when they are downloaded.
-
-
If you are connected to a TSO host, click Level to type in the new dataset you want to view. Host Access for the Cloud updates the remote file list using the dataset level you specify.
note
When specifying files using Upload As or Download, a fully qualified data set name needs to be enclosed in single quotes. Data set names not enclosed in single quotes will, by default, be prefixed with a high level qualifier specified in the TSO PROFILE.
You can refresh the file list at any time by clicking the Refresh icon in the upper left corner of the File Transfer dialog box.
Downloading files (IND$FILE)
-
From the list, click the name of the file to initiate the transfer.
or
Click Download and enter the name of the host file you want to transfer. You can download from both TSO and CMS host types. However, TSO and CMS represent host files differently; this means the format of the file name you enter into the message prompt will vary.
- TSO - Wrap the name of the host path in single quotes to specify the complete dataset name. For example,
'BVTST03.DATA.TXT'
. To specify a file location relative to the dataset level you set above, omit the single quotes. For example,DATA.TXT
, which identifies the same dataset but relative toBVTST03
. - CMS - A typical CMS input would be
BVTSTT01 DATA A1
. Single quotes are not needed.
- TSO - Wrap the name of the host path in single quotes to specify the complete dataset name. For example,
-
If necessary, you can cancel the transfer from the transfer progress panel.
Uploading files (IND$FILE)
note
IBM mainframe computer systems impose certain naming conventions for files. For detailed information on naming requirements, see the IBM documentation.
Choose either method for uploading files:
-
From the File Transfer dialog box, click Upload.
You can specify a different name for the uploaded file. Click Upload as, browse to the file you want to upload, and when prompted type the name you want to use. Remember that when connected to a TSO host, a fully qualified data set named needs to be enclosed in single quotes. See Step 5 under Transferring files.
or
-
Drag the file you want to upload from its location to the File Transfer dialog box. Click Refresh to verify the file was successfully uploaded.
If you cancel the upload process before a file has been completely transferred, a partial file will be left behind on the host.
Troubleshooting your file transfers
Occasionally you might encounter errors when attempting a file transfer. These errors may be mainframe issues or may be caused by browser security settings.
-
If a transfer completes but the file doesn’t contain the data expected, verify that the transfer method is properly set to either Binary or ASCII.
-
There is a 50MB file size limit on file transfer upload operations. You can modify this value. See the Deployment Guide for instructions.
-
For host-specific errors, see IBM File Transfer Error Messages
AS/400
Using AS/400 file transfer you can transfer data between your computer and an iSeries host.
Generally, AS/400 file transfers are straightforward and not complex. However, since the host data is managed as a DB2 database, you can, using the SQL Editor, create fairly complex queries.
To configure AS/400 file transfer
-
Create an HACloud 5250 terminal session, enter a host name or address and name the session.
-
On the Settings panel, choose File Transfer.
-
Select Enable AS/400 and proceed with the configuration.
-
Host
The host address that you provided for the terminal session is pre-populated in the host field. You can, if needed, use a different host. To specify a different port, append the port number to the host address. For example, host.mycompany.com:23.
-
TLS Security
From the drop down list, select the TLS security option you want to use.
To use this option: The AS/400 database server's certificate must be added to the list of trusted certificates in MSS. If the certificate has not already been added, then see Trusted Certificates in the MSS documentation for instructions.
-
Default transfer method
Set your preferred default transfer method; fixed width Text, or Comma Separated Values (CSV). The transfer method can be changed when you perform a transfer.
-
Include column headers by default
Select this option to include column headers by default for all downloaded data. You can modify this setting for each download on the file transfer dialog box.
Column headers do not originate on the host file, but are added when a file is downloaded. They are automatically removed when a file is uploaded.
-
-
Click Save and connect to the session.
Transferring files (AS/400)
After the session has been configured to use AS/400 file transfer functionality, click on the toolbar to open the File Transfer dialog box. This dialog contains a list of host files that are available to transfer. If prompted, enter your AS/400 login credentials.
Downloading files (AS/400)
The AS/400 file system consists of Libraries, Files and Members. Libraries are identified by this icon: . While you cannot download libraries, you can click on the library to see the files and members contained within.
Select Include column headers to display column headings for downloaded data.
-
Open the library containing the files ( ).
-
Expand the file that contains the member you want to download.
-
Click on a member to download it.
-
Open the browser's download folder to confirm the file is there. Open the file in a text editor.
Downloading using SQL
You can create SQL queries to obtain only the data you need from a file member on the host. This lets you select specific fields and ignore others.
-
Open the library and file you want to download.
-
Open the options menu and click SQL.
-
The SQL Editor opens and contains the SELECT statement that is used to download the whole member. The file member is referenced as LIBRARYNAME/FILENAME(MEMBERNAME).
-
Click Run to download the whole member. or edit the SQL and click Run to retrieve a subset of the data.
Uploading files (AS400)
You can only upload data into files as either new or replacement members. The AS/400 file contains a specification describing the data in members and each member in a given file has the same structure. Typically, you cannot (or should not) download a member from one file and upload it to another unless both files have the same data specification.
Since data can only be uploaded as members, you need to open a file and display its members in the file list dialog before the Upload button is enabled.
-
Open the file that you want to upload to. The Upload button is now available.
-
Either:
Click the Upload button and select a file from your local file system to upload.
or
Click the down arrow on the Upload button and select Upload as... Then select the file, give it a new name, and click OK.
Adding a Library
Typically, as an AS/400 user, you will have access to a certain set of libraries that has been assigned by a system administrator. These libraries appear as the top level entries in the file transfer dialog. If you need to access a library that is not on your list, your system administrator can update your configuration so that the new library is added to your list. Occasionally you may need to work with a library on a temporary basis; you do not need it added permanently to your library list.
To add a library
On the AS/400 file transfer dialog box, click Add Library. This button is available from the library list panel. This addition is not permanent and you will have to add the library again if you close and reopen the file transfer dialog box.
FTP
With Host Access for the Cloud your local computer can act as an FTP client. Using the FTP client, you can connect to an FTP server running on another machine. Once connected, you can view files on the server and use FTP to transfer files between your local computer (or any networked drive) and the FTP server. Using FTP, a client can upload, download, delete, rename, move and copy files on a server, either singly or as a batch transfer, where you can build lists of files to be transferred as one operation.
hint
If you plan on using a batch transfer, first select and configure the Enable FTP option.
To configure FTP
Select Enable FTP and proceed with the configuration:
-
Protocol
Use FTP to start a standard FTP session. Use SFTP to start an SFTP session.
You can set up an FTP client to use the SFTP protocol and perform all operations over an encrypted secure shell transport. Host Access for the Cloud uses user name and password to authenticate.
-
Host
Specify the host name or IP address of the FTP server to which you want to connect.
-
Port
The port of the FTP server specified.
-
Anonymous user
Select this option to log onto the specified FTP server as a guest, with the user name “Anonymous”. If the host you are connecting to does not support anonymous users, it may be necessary to supply your credentials.
-
Account
In the Account field, specify the name of the account to log into on the FTP server. A few servers require the account name as part of the login. For case-sensitive servers, be sure to use the appropriate case when entering the account name.
Select Prompt user for account to give the user the option to override the account value you set here. If the checkbox is not checked, then the set value is sent to the host upon connect/login without prompting the user.
-
Session timeout (seconds)
This value tells the FTP client the maximum number of seconds to wait for data packets being transferred to or from the host. If nothing is received within the period specified, a timeout error displays and the transfer terminates; in this case, try the operation again. If you receive repeated timeout errors, increase the timeout value. Entering 0 (zero) in this box prevents the FTP client from ever timing out when waiting for a response. For SFTP sessions, the default is 0 (zero).
-
Keep Alive time (seconds)
Select this option and enter a time in seconds if you want to continue your connection to the server beyond the server’s automatic timeout value for inactivity. Most servers have an idle time value that specifies how long a user’s FTP session can last when no activity is detected. When the user exceeds the time limit, the server connection is closed.
This setting allows you to direct the FTP client to send a NOOP command to the server at timed intervals to prevent the server from closing the connection due to inactivity. Be aware that by continuing your session you may prevent another user from making a connection to the FTP server.
-
Automatically show host files
By default, the host file list contains all the files that are available in the current working directory. To retrieve the list of host files only when you request them, disable this option. Then on the Transfer dialog box, click Show host files to retrieve the list of host files. This feature is useful when the host file system contains large numbers of files.
-
Startup QUOTE command
The string you specify here is sent to the FTP server as the session starts. The Startup QUOTE command allows you to set FTP server options when starting the session.
-
Initial remote directory
Specify the path to a home or default directory for the FTP site. When a connection to the FTP site is opened, the server working directory is set automatically to the specified home path. The files and folders in the server home directory appear in the FTP session window. If the initial remote directory is not found, a warning is reported and the connection continues.
-
If remote files exists when uploading file
Specify how you want to handle the transfer if a file with the same name already exists.
Select this option to do this .... Append Append the file being sent to the existing fileB1 Ask user (default) Prompt for a decision on how to handle the duplicate file name Cancel Cancel the file transfer Fail Cancel the file transfer and receive a notification of failure Overwrite Overwrite the existing file on the remote machine Skip When multiple files are in a request, skip the file matching an existing file name, but proceed with the transfer for other files. Unique Create a new file with a unique file name -
Host encoding
Specifies the character set used by the host to display the names of files that are transferred. By default Host Access for the Cloud uses UTF-8 (Unicode). If you transfer files with the default setting and the file names are unrecognizable, change the Host encoding option to the character set used by the host. (This option does not affect the encoding for the contents of the files that are transferred; it applies to the file names only.)
Transferring files (FTP)
After the administrator configures a session to include FTP functionality, click on the toolbar to open the FTP File Transfer window containing a list of host files that are available to transfer. Directories and files are indicated by an icon when you select the file.
-
Select the transfer method. The options are:
-
Binary
Use for program files and other types of files that should not be translated, such as files that have already been formatted for a particular type of printer or files with application-specific formatting. Binary files contain non-printable characters; using this method, a file is not converted or translated during the transfer.
-
ASCII
Use to transfer text files with no special formatting. Text files on the PC are translated to the appropriate character set on the host and host text files are similarly converted to the local character set when they are downloaded.
-
-
You can rename, delete, or download a file from the list of files.
-
Refresh the file list at any time by clicking the Refresh icon in the upper left corner of the File Transfer dialog box.
Downloading files (FTP)
-
From the list, select the file to initiate the transfer.
-
Optionally select the Download button and specify a fully qualified path to a file for download. The format of the remote file identifier depends on the type of file system on the host system but here are a few examples:
- Unix example: /home/user/subdirectory/myfile.txt
- TSO example: 'ACCT.INVOICES(INTL)'
- AS/400 example: ACCT/INVOICES.INTL
-
If necessary, you can cancel the transfer from the transfer progress panel.
Uploading files (FTP)
Choose from the following methods when uploading files:
-
From the File Transfer dialog box, click Upload.
Choose the file you want to upload from the Browse window.
-
Click the down arrow on the Upload button and select Upload as... Then select the file, give it a new name, and click OK.
-
Drag the file you want to upload from its location to the File Transfer dialog box.
TSO
You can provide a fully qualified data set name as the receiver of the transferred file. The name must be surrounded by single quotes e.g. 'ACCT.INVOICES(INTL)'
Click Refresh to verify the file was successfully uploaded.
Click New Directory to create a new directory on the remote server. You are prompted to enter the new directory name.
Batch transfers
note
You must first enable FTP on the File Transfer settings panel FTP tab before you can configure batch transfers.
To transfer multiple files in one operation, use the Batch option.
-
From the Settings > File Transfer > FTP panel, check Enable FTP.
-
Click to open the Batch file transfer panel.
-
Select Cancel batch when single failure occurs to stop the transfer if a file fails to transfer.
-
Click to create the list of files you want to transfer.
a. Name the list. To aid in building similar lists, you can copy an existing list, rename it, and then add or delete files as needed using the options available when the original list is highlighted.
b. From the right panel, click to open the Add transfer request dialog box.
-
On the Add transfer request panel, begin building the list:
Option Description Transfer Choose whether to upload or download the file. Local file name Identify the file you want to transfer. You can enter the name of the file or browse to it. Remote file path Provide a location to name and store the file after transfer. You can: - Keep original file name and use the initial remote directory - leave the field blank
- Use a new file name - enter newfilename.txt. Puts the file in the initial remote directory using the given name.
- Keep original file name but use a new directory path -
/folder/
. Uses the original file name with the new path. - Use new directory and a new file name -
/folder/newfilename.txt
.
Transfer method You can choose from Binary or ASCII transfer methods. If remote file exists Decide how to handle file transfer if a remote file already exists. The options are: - Overwrite (default) - Overwrite the existing file on the remote machine
- Append - Append the file being sent to the existing file
- Ask user - Prompt for a decision on how to handle the duplicate file name
- Cancel - Cancel the file transfer
- Fail - Cancel the file transfer and send notification of the failure
- Skip - The file matching an existing file name is skipped, but the transfer proceeds for the other files in the batch
- Unique - Create a new file with a unique file name
-
Click Save.
Transferring files (Batch)
hint
Administrators grant permission to transfer files using the User Preference Rules option from the Settings panel.
Click on the tool bar to open the list that contains the files you want to transfer.
-
Due to browser requirements, you need to specify the location of all files that you want to upload. Locate files as needed using the Search icon. Those files are easily identified with a yellow icon as such:
-
Files in the batch list are selected by default. To edit the file prior to transfer, you can eliminate files from the transfer operation by clearing their respective check boxes, or by selecting All from the drop down menu. You can also filter the list of transferable files based on their download or upload status.
-
Click Start to initiate the transfer.