Looker lets you schedule periodic delivery of a user-defined dashboard, a Look’s visualization, or a Look’s data to an SFTP server. Sending results to an SFTP server is a good method when your data or visualization is too large to send via email. If you choose this delivery option, Looker prompts you for the SFTP server address, username, and password as described below. Check out this Community topic for more details about delivering data using SFTP.
To receive SFTP deliveries from Looker, be sure your network admin has added Looker’s IP addresses to your SFTP server’s IP whitelist or inbound traffic rules.
Depending on how your Looker admin has configured your permissions, the default delivery destination may be email, and this setting may not be visible.
Creating and Editing Schedules
After starting a schedule, Looker displays a dialog box with your scheduling choices. The screen below shows an example Schedule dialog box for a dashboard:
The following sections explain each scheduling setting for SFTP server destinations. For a description of all scheduling options, see the main scheduling documentation page.
Naming Your Delivery
Give the content a unique title in the Give your schedule a name field. The title is included in the file name of the data delivery.
Delivering to SFTP
In Destination, choose SFTP. If your destination is an SFTP server, Looker prompts you for the URL and login information for the server:
Address: The URL of the SFTP server to which you want to send your data. For example:
Note that this example URL ends with the
/character. This indicates that the file will be saved in a folder called
In. If you leave out the trailing
/, the file will be saved in the
Marketingfolder and "
In" will be prepended to the file name.
Username and Password: Login credentials for the SFTP server.
Currently, SFTP support is limited to username and password credentials. SSH private key credentials are not supported. Check out this Community topic for more details about delivering data using SFTP.
To learn more about other types of data delivery, see the page for each destination option: email, Amazon S3 bucket, applications using a webhook, or one of several integrated services.
Formatting the Data
In Format data as, choose the format for the data in your delivery.
For dashboards, you can choose:
- PDF: Your dashboard in PDF format. The default layout displays tiles as they are arranged in the dashboard, but other layout and sizing options are available under Advanced Options.
- Visualization: A visualization of your dashboard in a single image file. The default layout displays tiles as they are arranged in the dashboard, but other layout options are available under Advanced Options.
- CSV ZIP File: The unformatted data from your dashboard, delivered as a collection of comma-separated values (CSV) files in a zipped directory.
For Looks, you can choose:
- CSV: Your Look's data table as a comma-separated text file attachment.
- XLSX: Your Look's data table as an Excel file attachment.
- JSON — Simple: Your Look's data table as a JSON file attachment.
- JSON — Detailed, Inline: Your Look's data table submitted directly in JSON format, with additional details such as field metadata, cache information, the time when the query was completed, and how long it took the query to run.
- Text: Your Look's data table as a tab-delimited text file attachment.
- HTML: Your Look's data table as an HTML file attachment.
Using Advanced Options for SFTP Servers
The Advanced options section provides additional customization for your schedule. Click the arrow next to Advanced options to expand this menu.
For all Look formats other than JSON—Detailed, Inline, you can add conditions for when the data will be delivered:
- Send this schedule if: You can send the data only if there are results, only if there are no results, or in either case. With this option, you can send data deliveries only when the filters of your Look are met (or not met). For example, you can create filter conditions for situations you want to monitor, such as items that are below a certain amount in inventory, expenditures that are above a certain value, and so forth.
- and results changed since last run: This option cuts down on unnecessary data deliveries. Looker sends the data only if the query results have changed since the last data delivery was sent. This option is not available if you want to use the All Results limit option.
When scheduling Looks, you can limit the size of your delivery. Select one of the following limit options for your data:
- Results in Table: Data is sent as a single delivery.
- All Results: Data is streamed (see more in this Help Center article). This is useful for large datasets, as it bypasses file-size, browser, and memory limitations.
If you choose Results in Table, Looker will obey whatever row limitations you've set up in the saved Look. If you choose All Results, Looker will return all the rows of the query, regardless of the saved Look settings, and regardless of Looker's typical 5,000 row limit. This can be desirable for retrieving very large datasets, but you should use caution to ensure the query is not too large for your database.
Apply Visualization Options
For Looks, Explores, and CSV-formatted dashboards, you can configure whether you want the data delivery to use the same options as your visualization:
Select Apply visualization options to apply some of the visualization settings to your delivery, causing your delivery to appear similar to a table chart. Any of the following settings in the Plot, Series, and Formatting menus that are configured for the visualization will be applied to the data delivery:
- Show Row Numbers
- Hide Totals
- Hide Row Totals
- Limit Displayed Rows to a maximum of 500 rows shown or hidden.
- Show Full Field Name
- Custom labels for each column (note that JSON files will always use raw field names, not the field label)
- Conditional Formatting for deliveries of table chart visualizations in Excel format
Conditional formatting will display in Excel deliveries of Looks and Explores with table chart visualizations only if the Along a scale rule is applied.
- Unselect Apply visualization options if you do not want these visualization options applied. Looker sends the data as it appears in the Data section of the Look or a dashboard tile's Explore from Here window.
Formatted Data Values
For Looks and the CSV format of dashboards, you can configure the data's formatting:
- Select Formatted data values if you want the data to appear more similar to the Explore experience in Looker, although some features (such as linking) aren't supported by all file types.
- Unselect Formatted data values if you do not want to apply any special formatting of your query results, such as rounding long numbers or adding special characters your Looker developers may have put in place. This is often preferred when data is being fed into another tool for processing.
Single Column Layout
For dashboard deliveries in PDF or Visualization format, you have the option to print your PDF in a single column layout, which displays dashboard tiles in a single vertical column. Check the Use single column layout box to use this option, or leave the box unchecked to show the tiles as they are arranged in the dashboard.
To display all rows of a data table — rather than just those rows that display in the dashboard tile thumbnail — in a PDF dashboard delivery or download, check the Expand tables box. If you do not see the Expands tables option, talk to your Looker admin about installing the Chromium renderer for your Looker instance.
By default, Looker will use the time zone associated with your account to determine when to send your data delivery. If you don't have a time zone associated with your account, Looker will use your Application time zone. If you want to specify a different time zone, select Use custom timezone. The time zone you select does not affect the data in your Look or dashboard, just the timing of the delivery.
You have the option to specify the optimal size and orientation of dashboard PDFs by selecting from the Paper size drop-down menu. Large visualizations or groups of overlapping dashboard tiles may need to be resized to fit cleanly on a PDF page. If you do not see the Paper size option, talk to your Looker admin about installing the Chromium renderer for your Looker instance.