Support & Troubleshooting
      Back to home
      1. GivingData Knowledge Base
      2. Support & Troubleshooting

      How to Download a .bacpac Export File Using SFTP

      This guide covers how to download .bacpac files via SFTP, either using tools like FileZilla or via the command line (Command Prompt on Windows).

      All data on the GivingData platform is securely backed up through automated scheduling processes. For clients needing to access these backups, GivingData can assist you in obtaining a .bacpac file that contains this essential data for your records. 

      ⚠️The following steps involve detailed technical configurations, such as connecting to an SFTP server, managing usernames, and handling connection strings. These tasks are best performed by IT staff or a qualified technical resource. If you're unfamiliar with these procedures, please consult with your IT department or someone experienced with server management and SFTP connections to ensure security and accuracy.

      After the file has been prepared, this guide will provide you with step-by-step instructions to download the .bacpac export file from a remote server using an SFTP client.

      Set Up and Install an SFTP Client

      Before starting, ensure you have an SFTP client installed on your computer. Popular options include:

      These pages will provide you with the latest executable files for installation on Windows, Mac, or Linux.

      Download and install one of these clients if you haven’t already.

      Gather Necessary Credentials

      To connect to the SFTP server and download the .bacpac file, you'll need specific connection details that are typically provided by the Givingdata Development Team. Here’s the required connection information:

      Hostname: The server’s address where the file is stored (e.g., yourserveraddress.sftp.example.com).

      Username: May contain specific prefixes related to the storage account.

      Password: This will be provided securely, typically via encrypted email.

      📌PLEASE REACH OUT TO GIVINGDATA SUPPORT IF YOU REQUIRE CONNECTION INFORMTION.

      Connect to the SFTP Server

      For clients or end users accessing the .bacpac file, follow these steps to connect to the SFTP server using the client you installed previously. (The examples in this guide follow FileZilla's FTP client)

      Enter Connection Details

      Launch the sFTP client and configure the the connection.

      • Hostname: Input the server’s address (e.g., yourserveraddress.sftp.example.com).

      • Username: Enter the username, ensuring any required prefix is included (e.g., username-prefix.your-username).

      • Password: Enter the secure password you received.

      • Port: Enter 22 as the port number.

       

      Initiate the Connection

      Click “Connect” or “Login” to establish a connection to the server.

      **If prompted, confirm that you trust the connection, especially if a security certificate warning appears. You should see a “Status” log if connection is successful. ( this log will also indicate unsuccessful connections which is useful for troubleshooting)

      Status: Connecting to mockserver.example.com...
      Status: Using username "mockserver.testuser".
      Status: Connected to mock.storage.server.net
      Status: Retrieving directory listing...
      Status: Listing directory /
      Status: Directory listing of "/" successful

      Locate the .bacpac file

      The SFTP client will display a list of files and directories available on the server.

      Navigate through the directory structure to find the .bacpac file. Often, it will be located in the Remote Site directory specific to the client or backup task (if unsure get confirmation from Devs on exact file location).

      Start the Download

      Select the .bacpac file and choose “Download” or drag the file to your target local directory or folder. You can also right-click on the .bacpac file you want to download.

      Monitor the Transfer

      The sFTP client will display the progress of the download, including the amount of data transferred, the transfer speed, and the time remaining.

      Confirm Successful Transfer

      Once the download is complete, the client will confirm that the file transfer was successful (e.g., “File transfer successful, transferred 56,278,980 bytes in 13 seconds”).

      Disconnect from the server by closing the session in the SFTP client. This ensures that the connection is securely terminated.

      Optional: Command-Line SFTP (Windows)

      For users who prefer working in a terminal environment, Windows systems have a built-in SFTP client accessible through the command line. This method allows users to transfer files efficiently without needing a GUI like Filezilla. Below is a guide on how to securely download a .bacpac file using the command line.

      Establish an SFTP Connection

      Use the sftp command to connect to the server:

      sftp username@hostname

      You'll be prompted to enter the password securely provided to you.

      List the Directory Contents

      Once connected, use the ls command to list all files and directories in the current directory:

      ls

      This will display a list of files and folders at the root directory. You can determine if the .bacpac file is present or if further navigation is required.

      Navigate to the Correct Directory

      If the .bacpac file isn’t in the root directory, use the cd command to move into the relevant directory:

      cd directory_name

      Use the ls command again to list the files in this directory until you find the .bacpac file.

       Download the .bacpac File

      Once you locate the file, use the get command to download it:

      get filename.bacpac

      This will download the file to your local directory.

      Exit the SFTP Session

      After the download is complete, type exit to close the SFTP session:

      exit

      ⚠️Command Line GET is a high-level guide that assumes technical familiarity with navigating remote directories, handling SFTP connections, and executing basic file transfer commands. If you are uncomfortable following these steps we suggest a sFTP client with Graphical User interface like Filezilla

      Troubleshooting Tips

      Because Azure often uses a combination of the storage account name and the user’s login to authenticate and organize access to the blob storage, it is important to ensure you are passing the correct credentials during authentication. Pay attention to any prefixes that may be required in your host/username.

      > Connection Issues

      Double-check the hostname, port, username, and password if the connection fails.

      Ensure the username is correct and or includes any necessary prefix.

      > Permissions Errors

      Verify that the user has the correct permissions on the server to access the .bacpac file.

      > Firewall or Security Settings

      If you encounter connection problems, check if a local firewall or security software is blocking the SFTP connection and adjust settings as needed (IT or other technical resource may be needed to assist with this)

      Security Best Practices

      • Always handle passwords securely, using encrypted emails for transmission.

      • Keep the sFTP client updated to avoid security vulnerabilities.