From 418ce93b7a0a0c313853b47448ab785e42ce7ff4 Mon Sep 17 00:00:00 2001 From: Deborah Barnard Date: Mon, 24 Oct 2022 09:59:54 +0100 Subject: [PATCH 1/2] wip --- .../n8n-nodes-base.cron.md | 0 docs/_redirects | 6 +- .../n8n-nodes-base.scheduletrigger.md | 52 ++++++++++++ docs/reference/release-notes.md | 82 +++++++++++++++++++ 4 files changed, 139 insertions(+), 1 deletion(-) rename {docs/integrations/builtin/core-nodes => archive}/n8n-nodes-base.cron.md (100%) create mode 100644 docs/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger.md diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.cron.md b/archive/n8n-nodes-base.cron.md similarity index 100% rename from docs/integrations/builtin/core-nodes/n8n-nodes-base.cron.md rename to archive/n8n-nodes-base.cron.md diff --git a/docs/_redirects b/docs/_redirects index d051ec754..4cd38f279 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -1,10 +1,14 @@ +# 2022 UI changes -# code node +/integrations/builtin/core-nodes/n8n-nodes-base.imapemail/ /integrations/builtin/core-nodes/n8n-nodes-base.emailimap/ + +# code schedule start nodes /data/data-mapping/data-item-linking/item-linking-function-node/ /data/data-mapping/data-item-linking/item-linking-code-node/ /integrations/builtin/core-nodes/n8n-nodes-base.function/ /integrations/builtin/core-nodes/n8n-nodes-base.code/ /integrations/builtin/core-nodes/n8n-nodes-base.functionItem/ /integrations/builtin/core-nodes/n8n-nodes-base.code/ /integrations/builtin/core-nodes/n8n-nodes-base.functionitem/ /integrations/builtin/core-nodes/n8n-nodes-base.code/ +/integrations/builtin/core-nodes/n8n-nodes-base.cron/ /integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/ # methods / vars / paired items diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger.md new file mode 100644 index 000000000..d0e52bd85 --- /dev/null +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger.md @@ -0,0 +1,52 @@ +# Schedule Trigger + +Use the Schedule Trigger node run workflows at fixed intervals and times. This works in a similar way to the cron software utility in Unix-like systems. + +!!! note "Cron node" + The Code node replaces the Cron node from version 0.199.0 onwards. If you're using an older version of n8n, you can still view the [Cron node documentation](https://github.com/n8n-io/n8n-docs/blob/67935ad2528e2e30d7984ea917e4af2910a096ec/docs/integrations/builtin/core-nodes/n8n-nodes-base.cron.md){:target=_blank .external-link}. + +!!! note "Keep in mind" + 1. If a workflow uses the Schedule node as a trigger, make sure that you save and activate the workflow. + 2. Set the timezone correctly for the n8n instance (or the workflow). + + +## Schedule your workflow + +Select an interval in **Trigger Interval**. Once you select an interval, n8n displays more options to customize that interval. + +### Example + +In this example, schedule a workflow to run once a quarter, at the end of the quarter, at 09:00. + +1. In **Trigger Interval**, select **Months**. +2. Change **Months Between Triggers** to `3`. +3. To run the workflow at the end of the month, change **Trigger at Day of Month** to `28`. +4. Change **Trigger at Hour** to **9am**. Leave **Trigger at Minute** as its default, `0`. + +Note that the Schedule Trigger uses the workflow timezone if available. Otherwise it uses the n8n instance timezone. + +## Generate a custom cron expression + +If you need a custom time setting, select **Trigger Interval** > **Custom (Cron)**. + +To generate a cron expression, you can use [crontab guru](https://crontab.guru){:target=_blank .external-link}. Paste the cron expression that you generated using crontab guru in the **Expression** field in n8n. + +### Examples + +If you want to trigger your workflow every day at 04:08:30, enter the following in the **Cron Expression** field. +``` +30 8 4 * * * +``` + +If you want to trigger your workflow every day at 04:08, enter the following in the **Cron Expression** field. +``` +8 4 * * * +``` + +### Why there are six asterisks (*) in the cron expression? + +The sixth asterisk in the cron expression represents seconds. Setting this is optional. The node will execute even if you don't set the value for seconds. + +| * | * | * | * | * | * | +|---|---|---|---|---|---| +|second|minute|hour|day|week|month| diff --git a/docs/reference/release-notes.md b/docs/reference/release-notes.md index 1faaad912..820a80c33 100644 --- a/docs/reference/release-notes.md +++ b/docs/reference/release-notes.md @@ -1,5 +1,87 @@ # Release notes +## n8n@0.199.0 + +View the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.198.2...n8n@0.199.0){:target=_blank .external-link} for this version.
+**Release date:** _2022-10-21_ + +This release includes new nodes, an improved workflow UI, performance improvements, and bug fixes. + +### New features + +
+ +#### New workflow experience + +This release brings a collection of UI changes, aimed at improving the workflow experience for users. This includes: + +* Removing the Start node, and adding help to guide users to find a trigger node. +* Improved node search. +* New nodes: Manual Trigger and Execute Workflow Trigger. + +
+ +* Core: block workflow updates on interim changes. +* Core: enable sending client credentials in the body of API calls. +* Editor: add automatic credential selection for new nodes. + +### New nodes + +
+ +#### Compare node + +_Description of new feature. Link to new node doc._ + +
+ +
+ +#### Execute Workflow Trigger node + +_Description of new feature. Link to new node doc._ + +
+ +
+ +#### Manual Trigger node + +You can find documentation for the new node [here](/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/). + +
+ +
+ +#### Schedule Trigger node + +This release introduces the Schedule Trigger node, replacing the Cron node. You can find documentation for the new node [here](/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/). + +
+ +### Node enhancements + +* Hubspot node: you can now use your Hubspot credentials in the HTTP Request node to make a [custom API call](/integrations/custom-operations/). +* Rundeck node: you can now use your Rundeck credentials in the HTTP Request node to make a [custom API call](/integrations/custom-operations/). +* _Include link to node doc._ + +### Bug fixes + +* Editor: fix a hover bug in the bottom menu. +* Editor: resolve performance issues when opening a node, or editing a code node, with a large amount of data. +* Editor: ensure workflows always stop when clicking the stop button. +* Editor: fix a bug that was causing text highlighting when mapping data in Firefox. +* Editor: ensure correct linting in the Code node editor. +* Editor: handle null values in table view. +* Elasticsearch node: fix a pagination issue. +* Google Drive node: fix typo. +* HTTP Request node: avoid errors when a response doesn't provide a content type. +* n8n node: fix a bug that was preventing the resource locator component from returning all items. + +### Contributors + +_List external contributors. Do not use a bulleted list here._ + ## n8n@0.198.2 View the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.198.1...n8n@0.198.2){:target=_blank .external-link} for this version.
From 025bbb35fc10e88b750c3788f7b833220393c4f9 Mon Sep 17 00:00:00 2001 From: Deborah Barnard Date: Mon, 24 Oct 2022 11:05:42 +0100 Subject: [PATCH 2/2] release note and new nodes for 0.199.0 --- ...-base.venafitlsprotectdatacentertrigger.md | 0 .../n8n-nodes-base.comparedatasets.md | 23 +++++++++++++ .../n8n-nodes-base.executeWorkflow.md | 34 ++++--------------- .../n8n-nodes-base.executeworkflowtrigger.md | 2 ++ .../n8n-nodes-base.manualworkflowtrigger.md | 2 +- docs/reference/release-notes.md | 13 +++---- document-templates/release-notes.md | 1 - 7 files changed, 40 insertions(+), 35 deletions(-) rename {docs/integrations/builtin/trigger-nodes => archive}/n8n-nodes-base.venafitlsprotectdatacentertrigger.md (100%) create mode 100644 docs/integrations/builtin/core-nodes/n8n-nodes-base.comparedatasets.md diff --git a/docs/integrations/builtin/trigger-nodes/n8n-nodes-base.venafitlsprotectdatacentertrigger.md b/archive/n8n-nodes-base.venafitlsprotectdatacentertrigger.md similarity index 100% rename from docs/integrations/builtin/trigger-nodes/n8n-nodes-base.venafitlsprotectdatacentertrigger.md rename to archive/n8n-nodes-base.venafitlsprotectdatacentertrigger.md diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.comparedatasets.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.comparedatasets.md new file mode 100644 index 000000000..230b568ce --- /dev/null +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.comparedatasets.md @@ -0,0 +1,23 @@ +# Compare Datasets + +The Compare Datasets node helps you compare data from two input streams. + +## Usage + +1. Decide which fields to compare. In **Input 1 Field**, enter the name of the field you want to use from input stream 1. In **Input 2 Field**, enter the name of the field you want to use from input stream 2. +2. **Optional**: you can compare by multiple fields. Select **Add Fields to Match** to set up more comparisons. +3. Choose how to handle differences between the datasets. In **When There Are Differences**, select one of the following: + * **Use Input 1 Version** + * **Use Input 2 Version** + * **Use a Mix of Versions** + * **Include Both Versions** + + +## Understand the output + +There are four output options: + +* **In 1 only Branch**: data that occurs only in the first input. +* **Same Branch**: data that is the same in both inputs. +* **Different Branch**: data that is different between inputs. +* **In 2 only Branch**: data that occurs only in the second output. diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.executeWorkflow.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.executeWorkflow.md index a35c534dd..f61dd3e68 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.executeWorkflow.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.executeWorkflow.md @@ -1,49 +1,29 @@ # Execute Workflow -The Execute Workflow node is used to run a different workflow on the host machine that runs n8n. +Use the Execute Workflow node to run a different workflow on the host machine that runs n8n. -## Node Reference +## Node reference The Execute Workflow node has two properties: -- ***Source***: This field is used to specify from where to get the workflow's information. +- **Source**: This field specifies from where to get the workflow's information. - Database - Local File - Parameter - URL -- ***Workflow***: This field contains information about the workflow, such as the workflow ID, URL, or a file. - - -## Example Usage - -This workflow allows you to execute another workflow on the host machine using the Execute Workflow node. You can also find the [workflow](https://n8n.io/workflows/588) on n8n.io. This example usage workflow would use the following nodes. -- [Start](/integrations/builtin/core-nodes/n8n-nodes-base.start/) -- [Execute Workflow]() - -The final workflow should look like the following image. - -![A workflow with the Execute Workflow node](/_images/integrations/builtin/core-nodes/executeworkflow/workflow.png) - -### 1. Start node - -The start node exists by default when you create a new workflow. - -### 2. Execute Workflow node - -1. Enter the ID of the workflow that you want to execute in the ***Workflow ID*** field. You can find instructions on how to obtain the ID of a workflow in the FAQs below. -2. Click on ***Execute Node*** to run the workflow. +- **Workflow**: This field contains information about the workflow, such as the workflow ID, URL, or a file. ## FAQs -### How do I find the workflow ID? +### How to find the workflow ID 1. Open the workflow for which you want to get the workflow ID. -2. Copy the number after `workflow/` in your URL and paste that in the ***Workflow ID*** field. +2. Copy the number after `workflow/` in your URL and paste that in the **Workflow ID** field. ### How does data get passed from one workflow to another? -Let's say, that there's a Execute Workflow node in **Workflow A**. The Execute Workflow node calls another workflow, **Workflow B**. +Let's say that there's a Execute Workflow node in **Workflow A**. The Execute Workflow node calls another workflow, **Workflow B**. - The Execute Workflow node passes the data to the Start node of **Workflow B**. - The last node of **Workflow B** sends the data back to the Execute Workflow node in **Workflow A**. diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger.md index fdb94f0c4..ae02f7b65 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger.md @@ -6,3 +6,5 @@ n8n allows you to call workflows from other workflows. This is useful if you wan * Reuse a workflow: for example, you could have multiple workflows pulling and processing data from different sources, then have all those workflows call a single workflow that generates a report. * Break large workflows into smaller components. + +This node runs in response to a call from the [Execute Workflow](/integrations/builtin/core-nodes/n8n-nodes-base.executeWorkflow/) node. diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.manualworkflowtrigger.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.manualworkflowtrigger.md index 146e84709..6c4c78b87 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.manualworkflowtrigger.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.manualworkflowtrigger.md @@ -1,5 +1,5 @@ # Manual Trigger -Use this node to start a workflow by selecting **Execute Workflow**. +Use this node if you want to start a workflow by selecting **Execute Workflow**, and don't want any option for the workflow to run automatically. Workflows always need a trigger (start point). In most cases, a trigger node starts the workflow in response to an external event. However, you still need a trigger node even when starting the workflow manually. diff --git a/docs/reference/release-notes.md b/docs/reference/release-notes.md index 41c4b1268..04060f43c 100644 --- a/docs/reference/release-notes.md +++ b/docs/reference/release-notes.md @@ -3,7 +3,7 @@ ## n8n@0.199.0 View the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.198.2...n8n@0.199.0){:target=_blank .external-link} for this version.
-**Release date:** _2022-10-21_ +**Release date:** 2022-10-21 This release includes new nodes, an improved workflow UI, performance improvements, and bug fixes. @@ -31,7 +31,7 @@ This release brings a collection of UI changes, aimed at improving the workflow #### Compare node -_Description of new feature. Link to new node doc._ +The Compare Datasets node helps you compare data from two input streams. You can find documentation for the new node [here](/integrations/builtin/core-nodes/n8n-nodes-base.comparedatasets/). @@ -39,7 +39,7 @@ _Description of new feature. Link to new node doc._ #### Execute Workflow Trigger node -_Description of new feature. Link to new node doc._ +The Execute Workflow Trigger starts a workflow in response to another workflow. You can find documentation for the new node [here](/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger/). @@ -47,7 +47,7 @@ _Description of new feature. Link to new node doc._ #### Manual Trigger node -You can find documentation for the new node [here](/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/). +The Manual Trigger allows you to start a workflow by clicking **Execute Workflow**, without any option to run it automatically. You can find documentation for the new node [here](/integrations/builtin/core-nodes/n8n-nodes-base.manualworkflowtrigger/). @@ -63,7 +63,6 @@ This release introduces the Schedule Trigger node, replacing the Cron node. You * Hubspot node: you can now use your Hubspot credentials in the HTTP Request node to make a [custom API call](/integrations/custom-operations/). * Rundeck node: you can now use your Rundeck credentials in the HTTP Request node to make a [custom API call](/integrations/custom-operations/). -* _Include link to node doc._ ### Bug fixes @@ -80,7 +79,9 @@ This release introduces the Schedule Trigger node, replacing the Cron node. You ### Contributors -_List external contributors. Do not use a bulleted list here._ +[AndLLA](https://github.com/AndLLA){:target=_blank .external-link} +[Nicholas Penree](https://github.com/drudge){:target=_blank .external-link} +[vcrwr](https://github.com/vcrwr){:target=_blank .external-link} ## n8n@0.198.2 diff --git a/document-templates/release-notes.md b/document-templates/release-notes.md index 640e03faa..baf10715d 100644 --- a/document-templates/release-notes.md +++ b/document-templates/release-notes.md @@ -42,7 +42,6 @@ _Description of new feature. Link to new node doc._ * _List any nodes with new functionality_ * _Or other improvements._ -* _Include link to node doc._ ### Bug fixes