ECMS - Internal - IBM Workload Scheduler File Transfer Job Type

This document explains the steps to create a IWS File Transfer job

IBM Workload Scheduler File Transfer Job Type

Create a new File Transfer job type in IWS Dynamic Workload Console

MUST BE USED FOR PUBKEY AUTH

There is no option in TWS/WebAdmin that exposes fields for specifying key store paths for SSH .id files, so must use Dynamic Workload Console if the file transfer uses PubKey authentication.

Also, the ability to use Password Type to choose among the four values is only available in the Dynamic Workload Console.

  1. Login to https://raspberry.doit.wisc.edu:16311/ibm/console/logon.jsp
  2. Click on Go butten to the right of Dynamic Workload Console
  3. Click on Administration at top left
  4. Under Administration | Workload Design select Manage Workload Definition
  5. In the Workload Designer window that opens, under the Create New left side navigation, select Job Definition
  6. In the JOB DEFINITION window that opens, scroll to the File Transfer and Coordination section and select File Transfer (9.4.0.05)
  7. In the screen that appears, on the FILETRANSFER(9.4.0.05) pane on the right, provide the following (* means the field is required)
    1. General tab
      1. *Name:
      2. *Workstation: - this must be, according to Kurt, one of the -1 workstations, a "dynamic" workstation, e.g., XFER-1
      3. Description:
      4. Check Variable resolution at runtime
      5. Set Successful Output Conditions (for when "no file found" is an acceptable condition, which will likely be all of the file transfer jobs). For example,
        1. Condition Name: STATUS_OK
        2. Condition Value: (RC=0) OR (RC=1) OR (RC=255)
    2. Affinity tab
      1. Nothing
    3. Recovery Options
      1. Nothing
    4. File Transfer
      1. Transfer Type
        1. ( ) Download
        2. Permissions (Octal Notation): Nothing here
        3. ( ) Upload
        4. [] Delete source files after transfer (for some customers, yes, for some no)
        5. * Server:
        6. * Remote file: [You can use asterisks (*) or question marks (?) as wildcard characters when downloading the file.]
        7. * Local file: [You can use asterisks (*) or question marks (?) as wildcard characters when downloading the file.]
        8. Protocol: FTP | FTPS | FTPES | SSH | WINDOWS | Auto <-- Select SSH for SFTP transfer type
        9. Remote Credentials
          1. * User Name:
          2. Password:
          3. [...] : Pick a PASSWORD TYPE value:
            1. Password
            2. User
            3. Agent User
            4. Variable
        10. Local Credentials
          1. * User Name:
          2. * Password:
          3. [...] : Pick a PASSWORD TYPE value:
            1. Password
            2. User
            3. Agent User
            4. Variable
        11. Certificates
          1. KeyStore File Path:
          2. Password
          3. [...] : Pick a PASSWORD TYPE value:
            1. Password
            2. User
            3. Agent User
            4. Variable
    5. TransferOption
      1. Transfer Mode: ( ) Binary or ( ) Text
      2. Codepage conversion: Remove versus local (nothing here)
      3. Timeout
      4. Connection Mode: ( ) Active Mode or ( ) Passive Mode
      5. Port Range
        1. Min port
        2. Max port
    6. Versions
      1. Nothing
  8. Select the Save control at the top (the floppy disk icon)

NOTE: It appears that one can use Create Like for an existing job and thus use existing File Transfer jobs as the basis for new File Transfer jobs.

Create a new File Transfer job type in TWS/WebAdmin

ONLY BE USED FOR UID/PWD FILE TRANSFERS

There is no option in TWS/WebAdmin that exposes fields for specifying key store paths for .ssh .id files, so cannot use TWS/WebAdmin if the file transfer uses PubKey authentication.

Also, TWS/WebAdmin does not appear to expose the ability to use Password Type to choose among the four values that the Dynamic Workload Console provides.

  1. Login to TWS/WebAdmin: https://raspberry.doit.wisc.edu/tws_login.php
  2. Under Database on the left-side navigation, select Jobs
  3. From the Actions menu select Add Job
  4. From the Add Job page
  5. Under General | Task Type: dropdown, select File Transfer
  6. General (* means the field is required)
    1. * Task Type: File Transfer
    2. * Workstation: <-- Select Dynamic Agent workstation (e.g., XFER-1)
    3. * Job Name:
    4. Description:
    5. Affinity Job Name:
  7. File Transfer
    1. Protocol: SSH <-- must be SSH for SFTP [SSH: A network protocol that provides file access, file transfer, and file management functions over any data stream. When transferring ASCII files, the local and remote code pages are identified automatically.]
    2. * Server:
    3. * Remote file: [You can use asterisks (*) or question marks (?) as wildcard characters when downloading the file.]
    4. * Local file: [You can use asterisks (*) or question marks (?) as wildcard characters when downloading the file.]
    5. Transfer mode: "Binary"
  8. Remote Credentials
    1. * User name:
    2. * Password:
  9. Local Credentials
    1. * User name:
    2. * Password:
  10. Return Code Mapping
    1. Condition Name:
    2. Condition Value:
    3. [ ] Successful
  11. Recovery Options
    1. Action:
    2. Recovery Workstation:
    3. Recovery Job:
    4. Recovery Prompt:
  12. Select Add button