Skip to content

ZettelFlow Plugin Documentation

Introduction to Folder-Level Automated Flows

Overview

The ZettelFlow plugin supports a powerful feature: Folder-Level Automated Flows. This feature allows you to assign specific workflows to individual folders. Whenever a file is created in one of these configured folders, an automatic modal will trigger, guiding you through the workflow you have set up for that folder.

Key Benefits

  • Automation: Streamline your note-taking process by automating repetitive tasks.
  • Consistency: Ensure that all files created in a specific folder follow the same process, enhancing organization and standardization.
  • Ease of Use: Activate workflows without needing to manually trigger them, improving efficiency and user experience.

How It Works

  1. Assigning a Workflow to a Folder:
  2. Right-click on the folder you want to assign a workflow to.
  3. Select the option to configure the workflow for that folder.
  4. This action will create a canvas file in a configurable path (default: _ZettelFlow).

  5. The filename will be the path of the folder with slashes (/) replaced by underscores (_).

  6. Configuration File:

  7. The created canvas file will store the workflow configuration for the folder.

  8. You can adjust the configuration by editing this canvas file as needed.

  9. Automatic Modal Activation:

  10. Whenever a new file is created in a folder that has an assigned configuration, the associated workflow modal will automatically appear.
  11. This ensures that every file created in this folder follows the specified workflow, regardless of the creation method (e.g., directly in Obsidian, through a synced service, etc.).

Example Use Case

Consider you have a folder named Profiles. You can configure a workflow for this folder to collect essential information such as email, team, and name whenever a new profile document is created.

Steps to Configure:

  1. Open ZettelFlow Settings:

  2. Go to the ZettelFlow plugin settings in Obsidian.

  3. Assign Workflow:

  4. Select the Profiles folder.

  5. Assign the desired workflow (e.g., Profile Creation Workflow).

  6. Create a File:

  7. Create a new file in the Profiles folder.
  8. Watch as the Profile Creation Workflow modal appears, prompting you to fill out the necessary details like email, team, and name.

Example Use Case

Consider you have a folder named Profiles. You can configure a workflow for this folder to collect essential information such as email, team, and name whenever a new profile document is created.

Steps to Configure:

  1. Open ZettelFlow Settings:

  2. Go to the ZettelFlow plugin settings in Obsidian.

  3. Assign Workflow:

  4. Right-click on the Profiles folder.
  5. Select the configuration option to assign the Profile Creation Workflow.

  6. This will create a file named _ZettelFlow/Profiles.canvas.

  7. Create a File:

  8. Create a new file in the Profiles folder.
  9. Watch as the Profile Creation Workflow modal appears, prompting you to fill out the necessary details like email, team, and name.

Configuration Details

To set up Folder-Level Automated Flows, follow these detailed steps:

  1. Access Plugin Settings:

  2. Go to Settings > Community Plugins > ZettelFlow.

  3. Select Folder:

  4. Right-click on the folder you want to configure and choose the option to configure the workflow.

  5. Assign Workflow:

  6. The system will create a configuration file in the default path (_ZettelFlow) with the folder's path name.

  7. Adjust the workflow configuration in this file as needed.

  8. Save Settings:

  9. Ensure you save your settings to apply the changes.

Troubleshooting

  • Modal Not Appearing: Ensure that the folder is correctly configured in the ZettelFlow settings and the configuration file exists in the _ZettelFlow directory (or the custom path you have set).
  • Workflow Not Triggering: Check if the workflow is active and correctly assigned to the folder by reviewing the canvas file.

If the note was create with the Ribbon button inside one of the folders with a workflow, the modal will not appear. This is a expected behavior to avoid the modal to appear twice for the same note.