How do I Export/Download Screenshots?

There are two methods for downloading your organization’s screenshots. Please click on a method below to begin downloading screens:

Downloading screenshots directly from your Hubstaff dashboard

Downloading a copy of your team’s screenshots is easy with Hubstaff’s Bulk Screenshot Download feature.

Follow the steps below to get started:

Step 1

On the sidebar menu on the left-hand side of the screen, click on Activity -> Screenshots.

 

Step 2

This will open the Screenshot activity page. Click on the Download Screenshots button.

Step 3

The Download screenshots dialog will appear. From here, you can select the team member’s name, as well as the date range of the screenshots included in the download. Hit Save to continue.

 

Step 4

After saving, you’ll be directed to the screen informing you that your screenshots are being prepared. Click OK.

Step 5

An email will be sent to your registered email address confirming your download is ready. Click on the download link to begin your bulk screenshot download.

Step 6

Once the download is complete, navigate to your computer’s Downloads folder, or the location where your browser is set to store downloads by default.

Open the downloaded folder, then double click on the file named ScreenshotViewer.html

Optional: Open the Screenshots folder to view the raw screenshot image files organized by date and time.

Step 7

A browser window will open which will show the downloaded screenshots.

You can click on a date on the calendar marked with red dots to see the downloaded screens for each day.

You can also filter the report by project as shown below:

If your employee is using multiple displays, you can select which screen you need to view by filtering the report by Display as shown here:

Screenshots are stored up to 6 months on paid plans and 1 month on the free plan based on our Data Retention policy.

You may also opt to use our Export Screenshots function which lets you download files directly to your computer.

 

How to download screenshots using the Hubstaff Export tool?

 

To download screenshots directly from your Hubstaff dashboard you can follow these steps Bulk Screenshot download

Hubstaff screenshots are retained for 6 months on paid plans and 1 month on free plans. In order to save your screenshots, you will need to export them. Fortunately, we have a tool that makes it very easy to quickly export your screenshots to retain for your own records.

If for whatever reason you get stuck somewhere in the process, don’t hesitate to contact us.

Using the Hubstaff Export Tool

To use the Hubstaff Export Tool, you will need to have Ruby installed on your computer. See how to install Ruby on various operating systems. Additional Ruby setup guides can be seen below:

You can verify that Ruby is installed on your system by typing

ruby -v

into the command line in your terminal (OSX/Linux) or command prompt (Windows).

With Ruby installed on your system, you can run the hubstaff-export.rb file found at the repository.

Step 1

Download the Hubstaff Export Tool

Unzip the hubstaff-export.rb file to the location of your choice.

Please note down the directory where you saved the file. This location will dictate where the screenshots are saved.

Step 2

Open a terminal window or command prompt and navigate to the directory where you have downloaded and unzipped the hubstaff-export.rb file.

For example, if you have the hubstaff-export.rb file on your Windows desktop, your file path will be: C:Users{YourUserName}Desktop or on a Mac it would be $HOME/Desktop

You may change the directory by using the ‘cd’ command (without quotes) i.e. cd Desktop or cd Downloads.

Step 3

You will only need to do this step one time. First, make sure that you have a Hubstaff App Token. You can create a token by signing in, then clicking on the Create App button. With your App Token in hand, you can run this command:

ruby hubstaff-export.rb authenticate AppToken bob@example.com MyAwesomePass

Replace AppToken with your App Token, bob@example.com with your Hubstaff email login, and MyAwesomePass with your Hubstaff password.

Sample:

ruby hubstaff-export.rb authenticate SpGdasdflkjl-SAs22k1lnRREkals123 carlo@hubstaff.com Abc123!

After running the command, you should see, User authentication successful.

The Authentication token and App token are cached into a file named hubstaff-client.cfg in the current directory.

Need help with this step? Contact support@hubstaff.com for further assistance.

Step 4

Now you can run the command that will export your screenshots. An example command would be:

ruby hubstaff-export.rb export-screens 2015-07-01T00:00:00Z 2015-07-01T07:00:00Z -o [your_organization_id] -i both

The command should have the -o argument specified as it’s required (meaning the organization id). In order to obtain the organization id, you can go to the https://app.hubstaff.com/organizations page and click on the organization you want to extract screenshots from. Copy the id from the browser address bar. Example: https://app.hubstaff.com/organizations/[organization_id]/members

Start and Stop time are required. Start and stop time should be in the following format: YYYY-MM-DDThh:mmZ where Z means that the time is in UTC (or it can be a timezone offset).

Example: 2015-06-01T04:00Z or 2015-06-01T00:00-0400 or 2015-06-01T05:00+0100 all represent the same time.

If you are in a time zone that is +08:00 in order to specify times in UTZ (the Z suffix to the ISO 8601 date-time format) you need to subtract 8 hours.

Thus to fetch the 8 hours of screens that the user worked you would specify 2016-04-25T16:00Z -> 2016-04-26T00:00Z

Another way to specify the time is to explicitly specify the time zone in the iSO 8601 format e.g.

2016-04-26T00:00+0800 -> 2016-04-26T08:00+0800

If you want to specify time in eastern you need to use an offset on the time e.g.

2017-04-24T08:30:00-0400 (for DST) or 2017-01-01T08:30:00-0500 (for non-DST). Or convert your times to UTC first when using the Z suffix.

After the start and stop times, you can add optional parameters. In the example above, -o 84 means Hubstaff organization with the ID 84. The -i both option means that both full size and thumbnail images will be downloaded. Other options are -i full (to download full-size images only, this is the default), -i thumb (to download thumbnails only), and -u 12 which denotes a specific user on the organization.

For a complete list of the available options, run:

ruby hubstaff-export.rb -h

After running the command, you should see Saving screenshots:

hubstaff-screenshot-export

The screenshots will start to be downloaded to your current directory.

Once screenshots are deleted, they cannot be recovered. Please make sure to export your screenshots before they are removed.

See a complete breakdown of Hubstaff’s data retention policies.

SSL Errors

If you’re on Windows, you may get SSL errors when you try to authenticate or export the screenshots.

To fix this, you’ll first want to download this file: http://curl.haxx.se/ca/cacert.pem

Next, you’ll need to create an environment variable called SSL_CERT_FILE and set its value to where you downloaded the cacert.pem file.

If you’re not sure how to create an environment variable, please see the instructions below.

Hit a roadblock? Contact support@hubstaff.com for further assistance.

Windows 8/Windows 10

First, type System into your computer’s search bar and select the System option for the control panel.

Next, you’ll want to click on the Advanced system settings link on the side.

From there, click the button labeled Environment variables.

Under system variables, click New.

For the variable name, enter: SSL_CERT_FILE

For the variable’s value, enter the file path to where you downloaded the cacert.pem file previously. If you downloaded it to your desktop, for example, it might look like C:UsersYourNameDesktopcacert.pem

Finally, click OK.

Once you’ve done that, fully close out of all command prompt windows you might have open and restart the command prompt. You should no longer receive the SSL errors.

  • Was this Helpful ?
  • Yes   No
  • Was this Helpful ?
  • Yes   No