Repository navigation
docs: refresh Snowflake integration screenshots and add schedules section - #3103
JanHranicky wants to merge 5 commits into
Conversation
Refresh screenshots for the current app UI, document Run Task and scheduled imports, and fix outdated details (export schema, token scope, privileges, token update path). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…creenshot Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…schedules Restore the page text from master and limit the change to refreshed screenshots and the new schedules section. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
✅ Preview for this PR (commit |
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
marcel-rbro
left a comment
There was a problem hiding this comment.
Should the frontmatter description, the intro, and the "To get started" list mention scheduled imports? Your first commit had them.
| Once installation is complete, open the app and go to the **API Token** page to verify the connection is working. If the token secret was configured correctly during setup, the page shows your Apify username and email. | ||
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
The new screenshots no longer match the text around them. For example, this page no longer shows the username and email, Next: Run Actor and Fetch Data are now Run Actor and Fetch data, and the options table lacks Flatten. Was reverting the text updates from 39a5d5e intentional?
|
|
||
|  | ||
|
|
||
| 1. **Actor or task setup** - pick **Choose an Actor** and enter its input, or pick **Choose a task** and optionally enter input overrides. Select **Continue** to start a preview run. The schedule repeats this run, so its dataset shows you the data each scheduled run produces. |
There was a problem hiding this comment.
This page doesn't explain tasks anywhere since the "Run a task" section was dropped. Should that section come back, or should this step link to tasks?
|
|
||
| Scheduled imports run outside Snowflake and connect back to your account to write the data, so each schedule needs: | ||
|
|
||
| - A Snowflake [programmatic access token (PAT)](https://docs.snowflake.com/en/user-guide/programmatic-access-tokens) for a user whose role can write to the destination table. Snowflake only accepts a PAT from a user who is subject to a [network policy](https://docs.snowflake.com/en/user-guide/network-policies). Apify Actor runs don't connect from a fixed range of IP addresses, so the policy must allow connections from them. |
There was a problem hiding this comment.
What should readers actually put in the network policy: allow all IP addresses, or something narrower? Right now they can't tell what to configure, and it affects security.
|
|
||
| 1. **Actor or task setup** - pick **Choose an Actor** and enter its input, or pick **Choose a task** and optionally enter input overrides. Select **Continue** to start a preview run. The schedule repeats this run, so its dataset shows you the data each scheduled run produces. | ||
| 1. **Import dataset** - when the preview run finishes, select **Continue** and configure the import as described in [Import a dataset](#import-a-dataset). The dataset is locked to the preview run's dataset, since every scheduled run imports the dataset it produces itself. For the same reason, **Unwind** and **Flatten** aren't available, and **Offset** and **Limit** apply to the preview only. | ||
| 1. **Review** - check the schedule and its destination table. Then fill in the Snowflake connection details: **Snowflake account identifier**, **Snowflake username**, **Snowflake programmatic access token (PAT)**, and optionally **Snowflake warehouse**. For the username, enter your login name, which you find in Snowsight under your name > **Connect a tool to Snowflake** > **Login name**. Select **Save and start**. |
There was a problem hiding this comment.
Should this field take the login name or the user name? The app's helper query on the Review step fills it with CURRENT_USER(), which returns the user name, and the two can differ.
| - **Run now** - start a run immediately, outside the schedule. | ||
| - **Pause** - stop the schedule's runs. A paused schedule shows **Resume** instead, which restarts them. | ||
| - **Delete** - remove the schedule and everything it created in your Apify account. | ||
| - **Edit timing** - change the frequency. |
There was a problem hiding this comment.
What happens to a schedule when the PAT expires, and how do users update the stored credentials? Edit timing only changes the frequency.
|
|
||
| - **Run now** - start a run immediately, outside the schedule. | ||
| - **Pause** - stop the schedule's runs. A paused schedule shows **Resume** instead, which restarts them. | ||
| - **Delete** - remove the schedule and everything it created in your Apify account. |
There was a problem hiding this comment.
What exactly does Delete remove, and does it touch the Snowflake table? If it only removes the Apify schedule and task, something like this would be clearer:
| - **Delete** - remove the schedule and everything it created in your Apify account. | |
| - **Delete** - remove the schedule and the Apify schedule and task it created. Data already imported into Snowflake stays in your tables. |
There was a problem hiding this comment.
A schedule is made of an Apify schedule, task, and webhook, so the suggestion should cover the webhook too:
| - **Delete** - remove the schedule and everything it created in your Apify account. | |
| - **Delete** - remove the schedule and the Apify schedule, task, and webhook it created. Data already imported into Snowflake stays in your tables. |
| 1. **Review** - check the schedule and its destination table. Then fill in the Snowflake connection details: **Snowflake account identifier**, **Snowflake username**, **Snowflake programmatic access token (PAT)**, and optionally **Snowflake warehouse**. For the username, enter your login name, which you find in Snowsight under your name > **Connect a tool to Snowflake** > **Login name**. Select **Save and start**. | ||
|
|
||
|  | ||
|
|
||
| The Snowflake credentials are stored only in the schedule's configuration in your Apify account. |
There was a problem hiding this comment.
Readers need to know where the credentials are stored before they enter the PAT, so move that sentence into the Review step.
| 1. **Review** - check the schedule and its destination table. Then fill in the Snowflake connection details: **Snowflake account identifier**, **Snowflake username**, **Snowflake programmatic access token (PAT)**, and optionally **Snowflake warehouse**. For the username, enter your login name, which you find in Snowsight under your name > **Connect a tool to Snowflake** > **Login name**. Select **Save and start**. | |
|  | |
| The Snowflake credentials are stored only in the schedule's configuration in your Apify account. | |
| 1. **Review** - check the schedule and its destination table. Then fill in the Snowflake connection details: **Snowflake account identifier**, **Snowflake username**, **Snowflake programmatic access token (PAT)**, and optionally **Snowflake warehouse**. For the username, enter your login name, which you find in Snowsight under your name > **Connect a tool to Snowflake** > **Login name**. The credentials are stored only in the schedule's configuration in your Apify account. Select **Save and start**. | |
|  |
| - **Edit timing** - change the frequency. | ||
| - **Run history** - check each run's status, start time, and the number of rows it imported. | ||
|
|
||
|  |
There was a problem hiding this comment.
Could this be reshot with realistic data? "PR test schedule" with 1 row per run looks like a test, and it highlights View in Apify Console, which the text never mentions.
|
|
||
|  | ||
|
|
||
| The Snowflake credentials are stored only in the schedule's configuration in your Apify account. |
There was a problem hiding this comment.
The app stores the PAT in the schedule's Apify task configuration, so can anyone with access to the Apify account, like organization members, read it there? If so, should the page say that, so users scope the PAT's role accordingly?
Updates the Snowflake integration page's app screenshots to the current UI (as WebP) and adds a section on scheduled imports. The rest of the page text is unchanged.