diff --git a/docs/nodes/credentials/ERPNext/README.md b/docs/nodes/credentials/ERPNext/README.md new file mode 100644 index 000000000..00c961b17 --- /dev/null +++ b/docs/nodes/credentials/ERPNext/README.md @@ -0,0 +1,40 @@ +--- +permalink: /credentials/erpnext +description: Learn to configure credentials for the Emelia node in n8n +--- + +# ERPNext + +You can use these credentials to authenticate the following nodes with Emelia. +- [ERPNext](../../nodes-library/nodes/ERPNext/README.md) + +## Prerequisites + +- Create a [ERPNext](https://erpnext.com) account. + +## Using API Key + +1. Open your ERPNext dashboard page. +2. Click on ***Settings*** on the top and select 'My Settings'. +3. Scroll down to the bottom of the page and click on ***API Access***. +4. Click on the ***Generate Keys*** button. +5. Copy the displayed API Secret. +6. Enter a name for your credentials in the ***Credentials Name*** field in the 'ERPNext API' credentials in n8n. +7. Paste the API Secret in the ***API Secret*** field in the 'ERPNext API' credentials in n8n. +8. Copy the API Key from ERPNext. +**Note:** You might have to refresh the ERPNext window to view the API Key. +9. Paste the API Key in the ***API Key*** field in the 'ERPNext API' credentials in n8n. +10. Enter the subdomain of your ERPNext account in the ***Subdomain*** field in the 'ERPNext API' credentials in n8n. Refer to the [FAQs](#how-to-find-the-subdomain-of-an-erpnext-account) to learn how to get your subdomain. +11. Click on the ***Create*** button to create your credentials in n8n. + +The following video demonstrates the steps mentioned above. + +
+ +
+ +## FAQs + +### How to find the subdomain of an ERPNext account? + +In the address bar of your browser, you can find the subdomain. The string between `https://` and `.erpnext.com` is your subdomain. For example, if the URL in the address bar is `https://n8n.erpnext.com`, the subdomain will be `n8n`. diff --git a/docs/nodes/credentials/IMAP/README.md b/docs/nodes/credentials/IMAP/README.md index 777b9774f..75d21b495 100644 --- a/docs/nodes/credentials/IMAP/README.md +++ b/docs/nodes/credentials/IMAP/README.md @@ -71,9 +71,38 @@ The following video demonstrates the steps mentioned above. +## Using Outlook.com + +1. Enter the name for your credentials in the ***Credentials Name*** field in the 'IMAP' credentials in n8n. +2. Enter your email address in the ***User*** field. +3. Enter your account password in the ***Password*** field. +4. Enter `outlook.office365.com` in the ***Host*** field. +5. Toggle ***SSL/TLS*** to `true`. +6. Click on ***Create*** to create your credentials. + +**Note** If you get a connection error, please follow the steps mentioned in the [FAQs](#how-to-solve-the-connection-error-when-connecting-to-outlook-com). + +The following video demonstrates the steps mentioned above. + +
+ +
+ +## FAQs + +### How to solve the connection error when connecting to Outlook.com? + +If you receive a connection error while configuring the credentials for your Outlook account, follow the steps mentioned below: +1. Go to [account.live.com/activity](https://account.live.com/activity). +2. Sign in using the email address and password of your account. +3. Under the ***Recent activity*** section, find the Session Type event that matches the most recent time you received the connection error and click to expand it. +4. Select ***This was me*** to let the system know you authorize the IMAP connection. + + ## Further Reading - [Set up IMAP for Gmail account](https://support.google.com/mail/answer/7126229?hl=en) - [Sign in with App Passwords for your Gmail Account](https://support.google.com/accounts/answer/185833?hl=en) - [Set up IMAP for Yahoo mail account](https://help.yahoo.com/kb/sln4075.html) - [Sign in with App Passwords for your Yahoo mail Account](https://help.yahoo.com/kb/generate-manage-third-party-passwords-sln15241.html) +- [POP, IMAP, and SMTP settings for Outlook.com](https://support.microsoft.com/en-us/office/pop-imap-and-smtp-settings-for-outlook-com-d088b986-291d-42b8-9564-9c414e2aa040) diff --git a/docs/nodes/nodes-library/core-nodes/ActivationTrigger/ActivationTrigger_node.png b/docs/nodes/nodes-library/core-nodes/ActivationTrigger/ActivationTrigger_node.png new file mode 100644 index 000000000..f09ebe8bc Binary files /dev/null and b/docs/nodes/nodes-library/core-nodes/ActivationTrigger/ActivationTrigger_node.png differ diff --git a/docs/nodes/nodes-library/core-nodes/ActivationTrigger/Mattermost_node.png b/docs/nodes/nodes-library/core-nodes/ActivationTrigger/Mattermost_node.png new file mode 100644 index 000000000..a958fa63e Binary files /dev/null and b/docs/nodes/nodes-library/core-nodes/ActivationTrigger/Mattermost_node.png differ diff --git a/docs/nodes/nodes-library/core-nodes/ActivationTrigger/README.md b/docs/nodes/nodes-library/core-nodes/ActivationTrigger/README.md new file mode 100644 index 000000000..33201e77d --- /dev/null +++ b/docs/nodes/nodes-library/core-nodes/ActivationTrigger/README.md @@ -0,0 +1,58 @@ +--- +permalink: /nodes/n8n-nodes-base.activationTrigger +description: Learn how to use the Activation Trigger node in n8n +--- + +# Activation Trigger + +The Activation Trigger node gets triggered when an event gets fired by n8n or a workflow. + +::: tip 💡 Keep in mind +If you want to use the Activation Trigger node for a workflow, add the node to the workflow. You don't have to create a separate workflow. +::: + +The Activation Trigger node gets triggered for the workflow that it gets added to. The Activation Trigger node can be used to trigger a workflow to notify the state of the workflow. + +## Node Reference + +- Events + - ***Activation:*** Run when the workflow gets activated + - ***Start:*** Run when n8n starts or restarts + - ***Update:*** Run when the workflow gets saved while it is active + +## Example Usage + +This workflow allows you to receive a message on Mattermost when a workflow is updated. You can also find the [workflow](https://n8n.io/workflows/1033) on n8n.io. This example usage workflow uses the following nodes. +- [Activation Trigger]() +- [Mattermost](../../nodes/Mattermost/README.md) + +The final workflow should look like the following image. + +![A workflow with the Webhook node](./workflow.png) + +### 1. Activation Trigger node + +Open the workflow where you want to add the activation workflow. Add the Activation Trigger node to the workflow. + +The Activation Trigger node will trigger the workflow when the workflow gets updated. + +1. Select 'Update' from the ***Events*** dropdown list. + +In the screenshot below, you will notice that the node triggers the workflow when the workflow gets updated. + +![Using the Activation Trigger node to trigger the workflow](./ActivationTrigger_node.png) + +### 2. Mattermost node (post: message) + +This node will send a message in the `workflow` channel on Mattermost. +::: v-pre +1. First of all, you'll have to enter credentials for the Mattermost node. You can find out how to enter credentials for this node [here](../../../credentials/Mattermost/README.md). +2. Select a channel from the ***Channel ID*** dropdown list. +3. Click on the gears icon next to the ***Message*** field click on ***Add Expression***. +::: v-pre +4. Enter the following message in the ***Expression*** field: `The workflow {{$workflow.name}}, was updated.`. `$workflow.name` returns the name of the workflow. +5. Click on ***Execute Node*** to run the workflow. +::: +In the screenshot below, you will notice that the node sends a message to Mattermost. + +![Using the Mattermost node to send a message to a channel](./Mattermost_node.png) diff --git a/docs/nodes/nodes-library/core-nodes/ActivationTrigger/workflow.png b/docs/nodes/nodes-library/core-nodes/ActivationTrigger/workflow.png new file mode 100644 index 000000000..5cfcce2f4 Binary files /dev/null and b/docs/nodes/nodes-library/core-nodes/ActivationTrigger/workflow.png differ diff --git a/docs/nodes/nodes-library/nodes/ERPNext/ERPNext1_node.png b/docs/nodes/nodes-library/nodes/ERPNext/ERPNext1_node.png new file mode 100644 index 000000000..b1b5802cb Binary files /dev/null and b/docs/nodes/nodes-library/nodes/ERPNext/ERPNext1_node.png differ diff --git a/docs/nodes/nodes-library/nodes/ERPNext/ERPNext2_node.png b/docs/nodes/nodes-library/nodes/ERPNext/ERPNext2_node.png new file mode 100644 index 000000000..68c4807ee Binary files /dev/null and b/docs/nodes/nodes-library/nodes/ERPNext/ERPNext2_node.png differ diff --git a/docs/nodes/nodes-library/nodes/ERPNext/ERPNext_node.png b/docs/nodes/nodes-library/nodes/ERPNext/ERPNext_node.png new file mode 100644 index 000000000..50fad3b29 Binary files /dev/null and b/docs/nodes/nodes-library/nodes/ERPNext/ERPNext_node.png differ diff --git a/docs/nodes/nodes-library/nodes/ERPNext/README.md b/docs/nodes/nodes-library/nodes/ERPNext/README.md new file mode 100644 index 000000000..36be93ccf --- /dev/null +++ b/docs/nodes/nodes-library/nodes/ERPNext/README.md @@ -0,0 +1,92 @@ +--- +permalink: /nodes/n8n-nodes-base.erpNext +description: Learn how to use the ERPNext node in n8n +--- + +# ERPNext + +[ERPNext](https://erpnext.com) is an open-source integrated Enterprise Resource Planning software. It is a generic ERP software used by manufacturers, distributors, and services companies. + +::: tip 🔑 Credentials +You can find authentication information for this node [here](../../../credentials/ERPNext/README.md). +::: + +## Basic Operations + +::: details Document +- Create a document +- Delete a document +- Retrieve a document +- Retrieve all documents +- Update a document +::: + +## Example Usage + +This workflow allows you to create, update, and retrieve a document from ERPNext. You can also find the [workflow](https://n8n.io/workflows/961) on n8n.io. This example usage workflow uses the following nodes. +- [Start](../../core-nodes/Start/README.md) +- [ERPNext]() + +The final workflow should look like the following image. + +![A workflow with the ERPNext node](./workflow.png) + +### 1. Start node + +The Start node exists by default when you create a new workflow. + +### 2. ERPNext node (document: create) + +This node will create a new document in ERPNext. + +1. First of all, you'll have to enter credentials for the ERPNext node. You can find out how to do that [here](../../../credentials/ERPNext/README.md). +2. Select 'Item' from the ***DocType*** dropdown list. +3. Click on the ***Add Property*** button. +4. Select 'Item Name' from the ***Field*** dropdown list. +5. Enter `item 1` in the ***Value*** field. +6. Click on the ***Add Property*** button. +7. Select 'Item Code' from the ***Field*** dropdown list. +8. Enter `item-1` in the ***Value*** field. +9. Click on the ***Add Property*** button. +10. Select 'Item Group' from the ***Field*** dropdown list. +11. Enter `Products` in the ***Value*** field. +**Note:** Make sure that the item group exists in your ERPNext account. +12. Click on ***Execute Node*** to run the node. + +In the screenshot below, you will notice that the node creates a new item with the name `item 1`. + +![Using the ERPNext node to create a new item](./ERPNext_node.png) + +### 3. ERPNext1 node (document: addContact) + +This node will add the `Item Tax` property to the item that we created in the previous node. +::: v-pre +1. Select the credentials that you entered in the previous node. +2. Select 'Update' from the ***Operation*** dropdown list. +3. Select 'Item' from the ***DocType*** dropdown list. +4. Click on the gears icon next to the ***Item Name*** field and click on ***Add Expression***. +5. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > name. You can also add the following expression: `{{$json["name"]}}`. +6. Click on the ***Add Property*** button. +7. Select 'Item Tax' from the ***Field*** dropdown list. +8. Enter `5` in the ***Value*** field. +10. Click on ***Execute Node*** to run the node. +::: +In the screenshot below, you will notice that the node adds the Item Tax property to the item that we created in the previous node. + +![Using the ERPNext node to update an item](./ERPNext1_node.png) + +### 4. ERPNext2 node (document: get) + +This node will get the information about the item that we created earlier. +::: v-pre +1. Select the credentials that you entered in the previous node. +2. Select 'Get' from the ***Operation*** dropdown list. +3. Select 'Item' from the ***DocType*** dropdown list. +4. Click on the gears icon next to the ***Item Name*** field and click on ***Add Expression***. +5. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > name. You can also add the following expression: `{{$json["name"]}}`. +6. Click on ***Execute Node*** to run the node. +::: + +In the screenshot below, you will notice that the node returns the information of the item. + +![Using the ERPNext node to return the information an item](./ERPNext2_node.png) diff --git a/docs/nodes/nodes-library/nodes/ERPNext/workflow.png b/docs/nodes/nodes-library/nodes/ERPNext/workflow.png new file mode 100644 index 000000000..c80f03c6c Binary files /dev/null and b/docs/nodes/nodes-library/nodes/ERPNext/workflow.png differ diff --git a/docs/nodes/nodes-library/nodes/GoogleSheets/README.md b/docs/nodes/nodes-library/nodes/GoogleSheets/README.md index 2f13b27ac..b803908e4 100644 --- a/docs/nodes/nodes-library/nodes/GoogleSheets/README.md +++ b/docs/nodes/nodes-library/nodes/GoogleSheets/README.md @@ -203,6 +203,9 @@ To insert the data in Google Sheets, you have to first convert the data in a val By default, the Lookup operation returns only the first value that it matches. To return all the values that match, click on ***Add Option*** and select 'Return All Matches'. Toggle ***Return All Matches*** to true. +### How to specify a sheet? + +By default, the Google Sheets node will operate on the default sheet, `Sheet 1`. If you rename the sheet or want to use a different sheet, you have to specify the name of the sheet. You can do that in the ***Range*** field. For example, if you need to use a sheet named `n8n` for the range `A` to `H`, enter `n8n!A:H` in the ***Range*** field. ## Further Reading