Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure additional lockbox settings

Configure lockbox mappings, SFTP connection, schedule, and notifications after completing the initial lockbox configuration.

  • Ensure you have completed the initial lockbox configuration.
  • Your SFTP server is SSH-enabled so that the Lockbox application can connect. Otherwise, you might receive an authentication error when you set up the SFTP server.
  • If you are an SFTP user, you have permission to access the folder path that you specify in the SFTP configuration.
  1. Optional: In the Mappings and Options section, adjust the mapping relationships that you configured in Map File Headers to Zuora Payment Fields section.
  2. In the SFTP Settings section, complete the fields in the Credential area to configure the SFTP server that stores the lockbox files.
    1. In the Host field, enter the IP address of the SFTP server.
    2. In the Port field, enter the port number of the SFTP server.
    3. In the Username field, enter the username that authenticates to the server.
    4. Select or clear the Use Key Based Authentication checkbox to choose the authentication method.
    5. In the Password field, enter the password of the user.

      If you clear Use Key Based Authentication, the password is required. If you select Use Key Based Authentication, the password is optional.

    6. If you selected Use Key Based Authentication, in the Private Key field, enter the RSA private key of the user.

      To generate an RSA key in PEM format, run the following command:

      ssh-keygen -t rsa -m PEM -f my_rsa_key

      The private key has the following format:

      -----BEGIN RSA PRIVATE KEY-----
      ...
      -----END RSA PRIVATE KEY-----

      The trailing new line is optional.

      Note: The Lockbox application supports only RSA private keys. OpenSSH private key formats are not supported.
    7. If you selected Use Key Based Authentication, in the Passphrase field, optionally enter the passphrase of the user.
    8. In the Path field, enter the directory path of the lockbox files, for example, /outbound/LBX01.

      The path must be a directory path because Lockbox can fetch multiple files from the directory.

      Note: For the Fixed Width Text - Single-Record Type (FWTSR) and Fixed Width Text - Multi-Record Type (FWTMR) file formats, the uploaded file must be a .txt file.
    9. In the Delete After field, select whether Zuora deletes the lockbox file after retrieving it.

    The SFTP process continues to run until the folder is empty.

  3. Click Save.
  4. In the Schedule area, define when Zuora downloads files from the SFTP server.
    Note: This step is optional. If you do not define a schedule, you can manually download lockbox files by selecting Run Automated File Download from the lockbox menu.
    1. In the Timezone field, select the same time zone as the tenant to avoid payment errors.
    2. In the Select to begin schedule builder field, select the frequency of the run schedule: Yearly, Monthly, Weekly, Daily, Hourly, or Minutes.
    3. Complete the time-frame details for the selected frequency.

      Start times use the 24-hour format.

  5. In the Notification Settings section, specify the email addresses that receive notifications about completed runs.

    The To field is required.

  6. Click Save to apply the schedule and notification settings.

Example: Monthly schedule

The following example shows a monthly lockbox run that starts at the beginning of the third day of each month:

  • Select to begin schedule builder: Monthly
  • Day 3 of every 1 month
  • Start time: 00:01