Understanding Sidekick

Sidekick in Livedocs is a powerful and flexible sidebar designed to aid your workflow when working on documents. Positioned on the left side of the document workspace, Sidekick provides quick access to data sources, variables, and scheduling tools, enabling you to stay focused on your analysis without frequent navigation away from the document.

This guide explains the three main sections of Sidekick: Explorer, Variables, and Schedules, and how they support your work in Livedocs.

Toggling Sidekick

Sidekick can be toggled open or closed using the chevron button located at the top-left of the document workspace. When open, it provides immediate access to its three sections. When closed, it keeps the workspace streamlined and uncluttered.

Explorer Section

The Explorer section provides a centralized view of all your data sources, allowing you to browse, search, and examine their structure and fields.

Key Features

1. Data Source List: Displays all data sources in a tree-view format. These sources are global to your account and not tied to the current document session.
   • For databases, it displays schemas and tables. Clicking a table shows its fields below.
   • For file-based sources like CSVs, it displays the file fields directly.
2. Search Field: Quickly locate specific fields or data sources by entering a search term.
3. Refresh Link: Updates the list of data sources to reflect their most current state.
4. Add Data Source: Clicking this link opens the Data tab, where you can configure and add a new data source.

The Explorer section mirrors much of the functionality of the Data tab, offering convenience for browsing data within your document.

Variables Section

The Variables section centralizes the management of secrets, built-in metadata, and variables used within the document.

Subsections

1. Secrets

   • View, add, or delete secrets directly within the document workspace. This mirrors the functionality of the Secrets tab but keeps it accessible for faster workflows.
   • To add a secret, click + Add secret, enter the name and value, and save it.
   • Secrets added here are available globally across documents.

2. Built-ins

   • Displays system-generated metadata related to the document's configuration. For example:
     • last_scheduled_run: Tracks the time of the last scheduled run (if set).
     • run_context: Displays the context in which the document is running, such as "logic."
   • These variables are read-only and dynamically updated by Livedocs.

3. Variable Explorer

   • Tracks all variables created or used within the document, whether from Python elements or Query elements.
   • Displays variable information in a three-column layout that shows the name, type, and value of each variable.
   • For example:
     • A variable months created in a Python element will show as:
       • Name: months
       • Type: list
       • Value: [January, February, March]
     • Query results from a Query element are displayed as Polars DataFrame objects.

The Variables section provides transparency and control over the dynamic components of your document, making debugging and organization easier.

Schedules Section

The Schedules section allows you to set up automated runs for your document, ensuring updates happen without manual intervention. Scheduled runs are particularly useful for documents that rely on dynamic data sources, such as real-time databases, ensuring they reflect the latest data.

Key Features

1. Scheduled Runs Overview: Displays a list of all scheduled runs for the document. If no schedules exist, it prompts you to add one.
2. Add Scheduled Run: Click the + Add scheduled run button to open the Schedule run dialog box.
   • Specify whether to run the published or editable version of the document.
   • Choose a time, timezone, and (if applicable) week days for the run.
   • Optionally, enable notifications via email, Slack, or webhook to stay informed when the document is executed.

For detailed instructions on creating scheduled runs, refer to the Scheduling Document Runs guide.

Why Sidekick Matters

Sidekick streamlines your workflow by consolidating essential tools in one place. Whether you are managing data sources, monitoring variables, or automating document runs, Sidekick ensures you can focus on your work without unnecessary navigation or interruptions.

By integrating Sidekick into your document workflows, you can maintain a seamless and efficient experience in Livedocs.

---

Now that you are familiar with Sidekick and its features, explore additional guides in the Working with Documents section of this documentation to enhance your knowledge of Livedocs' capabilities.