diff --git a/docs/_images/integrations/builtin/app-nodes/cortex/cortex1_node.png b/docs/_images/integrations/builtin/app-nodes/cortex/cortex1_node.png deleted file mode 100644 index e2834cabb2a..00000000000 Binary files a/docs/_images/integrations/builtin/app-nodes/cortex/cortex1_node.png and /dev/null differ diff --git a/docs/_images/integrations/builtin/app-nodes/cortex/cortex_node.png b/docs/_images/integrations/builtin/app-nodes/cortex/cortex_node.png deleted file mode 100644 index 5b5e6c5fa33..00000000000 Binary files a/docs/_images/integrations/builtin/app-nodes/cortex/cortex_node.png and /dev/null differ diff --git a/docs/_images/integrations/builtin/app-nodes/cortex/workflow.png b/docs/_images/integrations/builtin/app-nodes/cortex/workflow.png deleted file mode 100644 index 0aee30798eb..00000000000 Binary files a/docs/_images/integrations/builtin/app-nodes/cortex/workflow.png and /dev/null differ diff --git a/docs/_images/integrations/builtin/app-nodes/facebookgraphapi/workflow.png b/docs/_images/integrations/builtin/app-nodes/facebookgraphapi/workflow.png deleted file mode 100644 index 19e2fd74465..00000000000 Binary files a/docs/_images/integrations/builtin/app-nodes/facebookgraphapi/workflow.png and /dev/null differ diff --git a/docs/_images/integrations/builtin/core-nodes/compression/compression_node.png b/docs/_images/integrations/builtin/core-nodes/compression/compression_node.png deleted file mode 100644 index cec7c60f030..00000000000 Binary files a/docs/_images/integrations/builtin/core-nodes/compression/compression_node.png and /dev/null differ diff --git a/docs/_images/integrations/builtin/core-nodes/compression/dropbox_node.png b/docs/_images/integrations/builtin/core-nodes/compression/dropbox_node.png deleted file mode 100644 index 5d77328c193..00000000000 Binary files a/docs/_images/integrations/builtin/core-nodes/compression/dropbox_node.png and /dev/null differ diff --git a/docs/_images/integrations/builtin/core-nodes/compression/httprequest1_node.png b/docs/_images/integrations/builtin/core-nodes/compression/httprequest1_node.png deleted file mode 100644 index 7a33e771f2a..00000000000 Binary files a/docs/_images/integrations/builtin/core-nodes/compression/httprequest1_node.png and /dev/null differ diff --git a/docs/_images/integrations/builtin/core-nodes/compression/httprequest_node.png b/docs/_images/integrations/builtin/core-nodes/compression/httprequest_node.png deleted file mode 100644 index 0cca8d94775..00000000000 Binary files a/docs/_images/integrations/builtin/core-nodes/compression/httprequest_node.png and /dev/null differ diff --git a/docs/_images/integrations/builtin/core-nodes/compression/workflow.png b/docs/_images/integrations/builtin/core-nodes/compression/workflow.png deleted file mode 100644 index f1c188a9a16..00000000000 Binary files a/docs/_images/integrations/builtin/core-nodes/compression/workflow.png and /dev/null differ diff --git a/docs/_redirects b/docs/_redirects index 4a4fe0bf6fd..8d162d5b127 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -1,4 +1,9 @@ - +/integrations/builtin/core-nodes/n8n-nodes-base.spreadsheetfile/ /integrations/builtin/core-nodes/n8n-nodes-base.converttofile/ +/integrations/builtin/core-nodes/n8n-nodes-base.ical/ /integrations/builtin/core-nodes/n8n-nodes-base.converttofile/ +/integrations/builtin/core-nodes/n8n-nodes-base.movebinarydata/ /integrations/builtin/core-nodes/n8n-nodes-base.converttofile/ +/integrations/builtin/core-nodes/n8n-nodes-base.readpdf/ /integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile/ +/integrations/builtin/core-nodes/n8n-nodes-base.readbinaryfiles/ /integrations/builtin/core-nodes/n8n-nodes-base.filesreadwrite/ +/integrations/builtin/core-nodes/n8n-nodes-base.writebinaryfile/ /integrations/builtin/core-nodes/n8n-nodes-base.filesreadwrite/ /integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.documentbinaryinputloader/ /integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.documentdefaultdataloader/ /integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.documentjsoninputloader/ /integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.documentdefaultdataloader/ @@ -81,7 +86,7 @@ /security-audit/ /hosting/security-audit/ /reference/data-collection/ /privacy-security/privacy/ -/integrations/builtin/core-nodes/n8n-nodes-base.readbinaryfile/ /integrations/builtin/core-nodes/n8n-nodes-base.readbinaryfiles/ +/integrations/builtin/core-nodes/n8n-nodes-base.readbinaryfile/ /integrations/builtin/core-nodes/n8n-nodes-base.filesreadwrite/ /reference/release-notes/ /release-notes/ /integrations/builtin/core-nodes/n8n-nodes-base.htmlextract/ /integrations/builtin/core-nodes/n8n-nodes-base.html/ @@ -492,7 +497,7 @@ /nodes/n8n-nodes-base.humanticAi/ /integrations/builtin/app-nodes/n8n-nodes-base.humanticai/ /nodes/n8n-nodes-base.humanticai/ /integrations/builtin/app-nodes/n8n-nodes-base.humanticai/ /nodes/n8n-nodes-base.hunter/ /integrations/builtin/app-nodes/n8n-nodes-base.hunter/ -/nodes/n8n-nodes-base.iCal/ /integrations/builtin/core-nodes/n8n-nodes-base.ical/ +/nodes/n8n-nodes-base.iCal/ /integrations/builtin/core-nodes/n8n-nodes-base.converttofile/ /nodes/n8n-nodes-base.if/ /integrations/builtin/core-nodes/n8n-nodes-base.if/ /nodes/n8n-nodes-base.intercom/ /integrations/builtin/app-nodes/n8n-nodes-base.intercom/ /nodes/n8n-nodes-base.interval/ /integrations/builtin/core-nodes/n8n-nodes-base.interval/ @@ -584,8 +589,8 @@ /nodes/n8n-nodes-base.mongodb/ /integrations/builtin/app-nodes/n8n-nodes-base.mongodb/ /nodes/n8n-nodes-base.monicaCrm/ /integrations/builtin/app-nodes/n8n-nodes-base.monicacrm/ /nodes/n8n-nodes-base.monicacrm/ /integrations/builtin/app-nodes/n8n-nodes-base.monicacrm/ -/nodes/n8n-nodes-base.moveBinaryData/ /integrations/builtin/core-nodes/n8n-nodes-base.movebinarydata/ -/nodes/n8n-nodes-base.movebinarydata/ /integrations/builtin/core-nodes/n8n-nodes-base.movebinarydata/ +/nodes/n8n-nodes-base.moveBinaryData/ /integrations/builtin/core-nodes/n8n-nodes-base.converttofile/ +/nodes/n8n-nodes-base.movebinarydata/ /integrations/builtin/core-nodes/n8n-nodes-base.converttofile/ /nodes/n8n-nodes-base.mqtt/ /integrations/builtin/app-nodes/n8n-nodes-base.mqtt/ /nodes/n8n-nodes-base.mqttTrigger/ /integrations/builtin/trigger-nodes/n8n-nodes-base.mqtttrigger/ /nodes/n8n-nodes-base.mqtttrigger/ /integrations/builtin/trigger-nodes/n8n-nodes-base.mqtttrigger/ @@ -658,12 +663,12 @@ /nodes/n8n-nodes-base.rabbitmqTrigger/ /integrations/builtin/trigger-nodes/n8n-nodes-base.rabbitmqtrigger/ /nodes/n8n-nodes-base.rabbitmqtrigger/ /integrations/builtin/trigger-nodes/n8n-nodes-base.rabbitmqtrigger/ /nodes/n8n-nodes-base.raindrop/ /integrations/builtin/app-nodes/n8n-nodes-base.raindrop/ -/nodes/n8n-nodes-base.readBinaryFile/ /integrations/builtin/core-nodes/n8n-nodes-base.readbinaryfile/ -/nodes/n8n-nodes-base.readbinaryfile/ /integrations/builtin/core-nodes/n8n-nodes-base.readbinaryfile/ -/nodes/n8n-nodes-base.readBinaryFiles/ /integrations/builtin/core-nodes/n8n-nodes-base.readbinaryfiles/ -/nodes/n8n-nodes-base.readbinaryfiles/ /integrations/builtin/core-nodes/n8n-nodes-base.readbinaryfiles/ -/nodes/n8n-nodes-base.readPDF/ /integrations/builtin/core-nodes/n8n-nodes-base.readpdf/ -/nodes/n8n-nodes-base.readpdf/ /integrations/builtin/core-nodes/n8n-nodes-base.readpdf/ +/nodes/n8n-nodes-base.readBinaryFile/ /integrations/builtin/core-nodes/n8n-nodes-base.filesreadwrite/ +/nodes/n8n-nodes-base.readbinaryfile/ /integrations/builtin/core-nodes/n8n-nodes-base.filesreadwrite/ +/nodes/n8n-nodes-base.readBinaryFiles/ /integrations/builtin/core-nodes/n8n-nodes-base.filesreadwrite/ +/nodes/n8n-nodes-base.readbinaryfiles/ /integrations/builtin/core-nodes/n8n-nodes-base.filesreadwrite/ +/nodes/n8n-nodes-base.readPDF/ /integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile/ +/nodes/n8n-nodes-base.readpdf/ /integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile/ /nodes/n8n-nodes-base.reddit/ /integrations/builtin/app-nodes/n8n-nodes-base.reddit/ /nodes/n8n-nodes-base.redis/ /integrations/builtin/app-nodes/n8n-nodes-base.redis/ /nodes/n8n-nodes-base.redisTrigger/ /integrations/builtin/trigger-nodes/n8n-nodes-base.redistrigger/ @@ -710,8 +715,8 @@ /nodes/n8n-nodes-base.splunk/ /integrations/builtin/app-nodes/n8n-nodes-base.splunk/ /nodes/n8n-nodes-base.spontit/ /integrations/builtin/app-nodes/n8n-nodes-base.spontit/ /nodes/n8n-nodes-base.spotify/ /integrations/builtin/app-nodes/n8n-nodes-base.spotify/ -/nodes/n8n-nodes-base.spreadsheetFile/ /integrations/builtin/core-nodes/n8n-nodes-base.spreadsheetfile/ -/nodes/n8n-nodes-base.spreadsheetfile/ /integrations/builtin/core-nodes/n8n-nodes-base.spreadsheetfile/ +/nodes/n8n-nodes-base.spreadsheetFile/ /integrations/builtin/core-nodes/n8n-nodes-base.converttofile/ +/nodes/n8n-nodes-base.spreadsheetfile/ /integrations/builtin/core-nodes/n8n-nodes-base.converttofile/ /nodes/n8n-nodes-base.sseTrigger/ /integrations/builtin/core-nodes/n8n-nodes-base.ssetrigger/ /nodes/n8n-nodes-base.ssetrigger/ /integrations/builtin/core-nodes/n8n-nodes-base.ssetrigger/ /nodes/n8n-nodes-base.ssh/ /integrations/builtin/core-nodes/n8n-nodes-base.ssh/ @@ -789,8 +794,8 @@ /nodes/n8n-nodes-base.workflowTrigger/ /integrations/builtin/core-nodes/n8n-nodes-base.workflowtrigger/ /nodes/n8n-nodes-base.workflowtrigger/ /integrations/builtin/core-nodes/n8n-nodes-base.workflowtrigger/ /nodes/n8n-nodes-base.Workflowtrigger/ /integrations/builtin/core-nodes/n8n-nodes-base.workflowtrigger/ -/nodes/n8n-nodes-base.writeBinaryFile/ /integrations/builtin/core-nodes/n8n-nodes-base.writebinaryfile/ -/nodes/n8n-nodes-base.writebinaryfile/ /integrations/builtin/core-nodes/n8n-nodes-base.writebinaryfile/ +/nodes/n8n-nodes-base.writeBinaryFile/ /integrations/builtin/core-nodes/n8n-nodes-base.filesreadwrite/ +/nodes/n8n-nodes-base.writebinaryfile/ /integrations/builtin/core-nodes/n8n-nodes-base.filesreadwrite/ /nodes/n8n-nodes-base.wufooTrigger/ /integrations/builtin/trigger-nodes/n8n-nodes-base.wufootrigger/ /nodes/n8n-nodes-base.wufootrigger/ /integrations/builtin/trigger-nodes/n8n-nodes-base.wufootrigger/ /nodes/n8n-nodes-base.xero/ /integrations/builtin/app-nodes/n8n-nodes-base.xero/ diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-base.cortex.md b/docs/integrations/builtin/app-nodes/n8n-nodes-base.cortex.md index 74edc3da249..cba089051ce 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-base.cortex.md +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-base.cortex.md @@ -13,11 +13,12 @@ On this page, you'll find a list of operations the Cortex node supports and link /// note | Credentials Refer to [Cortex credentials](/integrations/builtin/credentials/cortex/) for guidance on setting up authentication. /// + /// note | Examples and templates For usage examples and templates to help you get started, take a look at n8n's [Cortex integrations](https://n8n.io/integrations/cortex/){:target="_blank" .external-link} list. /// -## Basic Operations +## Operations * Analyzer * Execute Analyzer @@ -27,45 +28,5 @@ For usage examples and templates to help you get started, take a look at n8n's [ * Responder * Execute Responder -## Example Usage - -This workflow allows you to analyze a URL and get the job details using the Cortex node. You can also find the [workflow](https://n8n.io/workflows/809) on n8n.io. This example usage workflow would use the following nodes. -- [Start](/integrations/builtin/core-nodes/n8n-nodes-base.start/) -- [Cortex]() - -The final workflow should look like the following image. - -![A workflow with the Cortex node](/_images/integrations/builtin/app-nodes/cortex/workflow.png) - -### 1. Start node - -The start node exists by default when you create a new workflow. - -### 2. Cortex node (analyzer: execute) - -This node will analyze a URL. If you want to analyze a different observable type, select that instead. - -1. First of all, you'll have to enter credentials for the Cortex node. You can find out how to do that [here](/integrations/builtin/credentials/cortex/). -2. Select 'Abuse_Finder_3_0' from the ***Analyzer Type*** dropdown list. -3. Select 'URL' from the ***Observable Type*** dropdown list. -4. Enter the URL you want to analyze in the ***Observable Value*** field. -5. Click on ***Execute Node*** to run the node. - -In the screenshot below, you will notice that the node starts the analysis of the URL. - -![Using the Cortex node to analyze a URL](/_images/integrations/builtin/app-nodes/cortex/cortex_node.png) - -### 3. Cortex1 node (job: get) - -This node will return the job details for the analysis that we executed in the previous node. - -1. Select the credentials that you entered in the previous node. -2. Select 'Job' from the ***Resource*** dropdown list. -3. Click on the gears icon next to the ***Job ID*** field and click on ***Add Expression***. -4. Select the following in the ***Variable Selector*** section: Nodes > Cortex > Output Data > JSON > _id. You can also add the following expression: `{{$node["Cortex"].json["_id"]}}`. -5. Click on ***Execute Node*** to run the node. - -In the screenshot below, you will notice that the node starts the analysis of the URL. -![Using the Cortex node to get job details](/_images/integrations/builtin/app-nodes/cortex/cortex1_node.png) diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-base.facebookgraphapi.md b/docs/integrations/builtin/app-nodes/n8n-nodes-base.facebookgraphapi.md index af274e9e87f..73410b2b19e 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-base.facebookgraphapi.md +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-base.facebookgraphapi.md @@ -13,11 +13,12 @@ On this page, you'll find a list of operations the Facebook Graph API node suppo /// note | Credentials Refer to [Facebook Graph API credentials](/integrations/builtin/credentials/facebookgraph/) for guidance on setting up authentication. /// + /// note | Examples and templates For usage examples and templates to help you get started, take a look at n8n's [Facebook Graph API integrations](https://n8n.io/integrations/facebook-graph-api/){:target="_blank" .external-link} list. /// -## Basic operations +## Operations **Default** - GET @@ -44,29 +45,7 @@ For usage examples and templates to help you get started, take a look at n8n's [ * **Node**: The node on which to operate, for example `//feed`. Read more about it in the [official Facebook Developer documentation](https://developers.facebook.com/docs/graph-api/using-graph-api). * **Edge**: Edge of the node on which to operate. Edges represent collections of objects which are attached to the node. * **Ignore SSL Issues**: Toggle to still download the response even if SSL certificate validation is not possible. -* **Send Binary Data**: Available for `POST` operations. If enabled binary data is sent as the body. Requires setting the following: - * **Binary Property**: Name of the binary property which contains the data for the file to be uploaded. - -## Example usage - -This workflow allows you to retrieve the first and last name of a profile on Facebook. You can also find the [workflow](https://n8n.io/workflows/514) on the website. This example usage workflow would use the following two nodes. -- [Start](/integrations/builtin/core-nodes/n8n-nodes-base.start/) -- [Facebook Graph API]() - -The final workflow should look like the following image. - -![A workflow with the Facebook Graph API node](/_images/integrations/builtin/app-nodes/facebookgraphapi/workflow.png) - -### 1. Start node - -The start node exists by default when you create a new workflow. - -### 2. Facebook Graph API node +* **Send Binary File**: Available for `POST` operations. If enabled binary data is sent as the body. Requires setting the following: + * **Input Binary Field**: Name of the binary property which contains the data for the file to be uploaded. -1. First of all, you'll have to enter credentials for the Facebook Graph API node. You can find out how to do that [here](/integrations/builtin/credentials/facebookgraph/). -2. Enter `me` in the *Node* field. -3. Click on the *Add Option* button and select 'Fields' from the dropdown list. -4. Click on the *Add Field* button and enter `first_name` in the *Name* field. -5. Click on the *Add Field* button and enter `last_name` in the *Name* field. -6. Click on *Execute Node* to run the workflow. diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.compression.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.compression.md index d3743b45d4d..20a71f4d0d0 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.compression.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.compression.md @@ -18,83 +18,7 @@ For usage examples and templates to help you get started, refer to n8n's [Compre - **Input Binary Field(s)**: the name of the fields in the input data that contain the binary files you want to compress. To compress more than one file, use a comma-separated list. - **Output Format**: choose from **Zip** and **Gzip**. - **File Name**: the name of the zip file you create. -- Options - - ***Binary Property*** field: This field allows you to specify the name of the binary property - - ***Output Prefix*** field: This field allows you to specify a prefix for the name of the file that gets generated. This field gets displayed for the 'Decompress' operation and the 'gzip' output format for the 'Compress' operation - - ***Output Format*** field: This field allows you to select an output format. This field is displayed when 'Compress' gets selected from the ***Operation*** dropdown list. The following are the available formats: - - gzip - - zip - - ***File Name*** field: This field allows you to specify a file name. This field is displayed when 'zip' gets selected from the ***Output Format*** dropdown list. - - ***Binary Property Output*** field: This field allows you to specify a name for the file that gets generated. This field is displayed when 'zip' gets selected from the ***Output Format*** dropdown list. - -## Example Usage - -This workflow allows you to compress binary files to zip format and upload them to Dropbox. You can also find the [workflow](https://n8n.io/workflows/908) on n8n.io. This example usage workflow would use the following nodes. -- [Start](/integrations/builtin/core-nodes/n8n-nodes-base.start/) -- [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) -- [Dropbox](/integrations/builtin/app-nodes/n8n-nodes-base.dropbox/) - - -The final workflow should look like the following image. - -![A workflow with the Edit Image node](/_images/integrations/builtin/core-nodes/compression/workflow.png) - -### 1. Start node - -The start node exists by default when you create a new workflow. - - -### 2. HTTP Request node (GET) - -This example workflow uses the HTTP Request node to fetch an image from a URL. You can also use the [Read Binary File](/integrations/builtin/core-nodes/n8n-nodes-base.readbinaryfile/) node to read a file from the path you specify. - -1. Enter the URL of the image in the ***URL*** field. For example, `https://docs.n8n.io/assets/img/final-workflow.f380b957.png`. -2. Select 'File' from the ***Response Format*** dropdown list. -3. Enter `workflow_image` in the ***Binary Property*** field. -4. Click on ***Execute Node*** to run the node. - -In the screenshot below, you will notice that the HTTP Request node fetches the image from the URL. This image gets passed on as binary data to the next node in the workflow. - -![Using the HTTP Request node to fetch an image from a URL](/_images/integrations/builtin/core-nodes/compression/httprequest_node.png) - -### 3. HTTP Request1 node (GET) - -This node fetches an image from a URL. You can also use the [Read Binary File](/integrations/builtin/core-nodes/n8n-nodes-base.readbinaryfile/) node to read a file from the path you specify. - -1. Enter the URL of the image in the ***URL*** field. For example, `https://n8n.io/n8n-logo.png`. -2. Select 'File' from the ***Response Format*** dropdown list. -3. Enter `logo` in the ***Binary Property*** field. -4. Click on ***Execute Node*** to run the node. - -In the screenshot below, you will notice that the HTTP Request node fetches the image from the URL. This image gets passed on as binary data to the next node in the workflow. - -![Using the HTTP Request node to fetch an image from a URL](/_images/integrations/builtin/core-nodes/compression/httprequest1_node.png) - - -### 4. Compression node (compress) - -This node compresses the binary file that we received from the HTTP Request nodes in a zip file. If you want to compress them in `gzip` format, select that option instead. - -1. Select 'Compress' from the ***Operation*** dropdown list. -2. Enter `logo,workflow_image` in the ***Binary Property*** field. -3. Select 'zip' from the ***Output Format*** dropdown list. -4. Enter `images.zip` in the ***File Name*** field. -5. Click on ***Execute Node*** to run the node. - -In the screenshot below, you will notice that the node compresses the files and generates `images.zip`. - -![Using the Compression node to compress files](/_images/integrations/builtin/core-nodes/compression/compression_node.png) - -### 5. Dropbox node (upload: file) - -This node will upload the compressed file to your Dropbox account. - -1. First of all, you'll have to enter credentials for the Dropbox node. You can find out how to do that [here](/integrations/builtin/credentials/dropbox/). -2. Enter `/images.zip` in the ***File Path*** field. -3. Toggle ***Binary Data*** to `true`. This option allows us to upload binary data from the previous node. -4. Click on ***Execute Node*** to run the node. - -In the screenshot below, you will notice that the node uploads the compressed file that we generated in the previous node. - -![Using the Dropbox node to upload a file](/_images/integrations/builtin/core-nodes/compression/dropbox_node.png) - + - **Put Output File in Field**: set the name of the field in the output data to contain the file. +- **Operation** > **Decompress**: + - **Put Output File in Field**: set the name of the field in the output data to contain the file. + - **Output Prefix**: add a prefix to the output file name. diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.converttofile.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.converttofile.md new file mode 100644 index 00000000000..8c95f0d084f --- /dev/null +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.converttofile.md @@ -0,0 +1,49 @@ +--- +title: Convert to File +description: Documentation for the Convert to File node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +--- + +# Convert to File + +Use the Convert to File node to take input data and output it as a file. This converts the input JSON data into a binary format. + + +/// note | Examples and templates +For usage examples and templates to help you get started, refer to n8n's [Convert to File integrations](https://n8n.io/integrations/convert-to-file/){:target=_blank .external-link} page. +/// + +/// note | Extract From File +To extract data from a file and convert it to JSON, use the [Extract from File](/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile/) node. +/// + +## Node parameters + + +* **Operation** > **Convert to CSV**: + * **Put Output File in Field**: set the name of the field in the output data to contain the file. +* **Operation** > **Convert to HTML**: + * **Put Output File in Field**: set the name of the field in the output data to contain the file. +* **Operation** > **Convert to iCal**: + * **Event Title** + * **Start**: event start time. + * **End**: event end time. + * **All Day**: whether the event is an all day event (enabled) or not (disabled). + * **Put Output File in Field**: set the name of the field in the output data to contain the file. +* * **Operation** > **Convert to JSON**: + * **Mode**: choose **All Items to One File** to send all input items to a single file, or **Each Item to Separate File** to create a file for every input item. + * **Put Output File in Field**: set the name of the field in the output data to contain the file. +* **Operation** > **Convert to ODS**: + * **Put Output File in Field**: set the name of the field in the output data to contain the file. +* **Operation** > **Convert to RTF**: + * **Put Output File in Field**: set the name of the field in the output data to contain the file. +* **Operation** > **Convert to XLS**: + * **Put Output File in Field**: set the name of the field in the output data to contain the file. +* **Operation** > **Convert to XLSX**: + * **Put Output File in Field**: set the name of the field in the output data to contain the file. +* **Operation** > **Move Base64 String to File**: + * **Base64 Input Field**: the name of the field in the node input data that contains the Base64 string. + * **Put Output File in Field**: set the name of the field in the output data to contain the file. + +## Options + +Use the **Options** parameters to configure additional settings. These vary depending on the file type you're creating. You can set the **File Name** for all file types. diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.crypto.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.crypto.md index 396ba548511..3e2f9f47a8f 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.crypto.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.crypto.md @@ -6,11 +6,15 @@ contentType: integration # Crypto -The Crypto node is used to encrypt data in workflows. +Use the Crypto node to encrypt data in workflows. -## Node Reference +/// note | Examples and templates +For usage examples and templates to help you get started, refer to n8n's [Crypto integrations](https://n8n.io/integrations/crypto/){:target=_blank .external-link} page. +/// -You can configure further options for each action by selecting the type of encryption and encoding to be used, in the *Type* and *Encoding* fields respectively. +## Parameters + +You can configure further options for each action by selecting the type of encryption and encoding to be used, in the **Type** and **Encoding** fields. - Action - Hash a text in a specified format @@ -28,23 +32,5 @@ You can configure further options for each action by selecting the type of encry - BASE64 - HEX -## Example Usage - -This workflow allows you to encrypt data using the Crypto node. You can also find the [workflow](https://n8n.io/workflows/574) on the website. This example usage workflow would use the following two nodes. -- [Start](/integrations/builtin/core-nodes/n8n-nodes-base.start/) -- [Crypto]() - - -The final workflow should look like the following image. - -![A workflow with the Crypto node](/_images/integrations/builtin/core-nodes/crypto/workflow.png) - -### 1. Start node - -The start node exists by default when you create a new workflow. - -### 2. Crypto node -1. Enter the data that you want to encrypt in the *Value* field. -2. Click on *Execute Node* to run the workflow. diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.editimage.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.editimage.md index e0fddf2298f..387a318d575 100644 --- a/docs/integrations/builtin/core-nodes/n8n-nodes-base.editimage.md +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.editimage.md @@ -13,6 +13,10 @@ Use the Edit Image node to manipulate and edit images. 2. You need to use a node such as the [Read Binary File](/integrations/builtin/core-nodes/n8n-nodes-base.readbinaryfile/) node or the [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) node to pass the image file as a data property to the Edit Image node. /// +/// note | Examples and templates +For usage examples and templates to help you get started, refer to n8n's [Edit Image integrations](https://n8n.io/integrations/edit-image/){:target=_blank .external-link} page. +/// + ## Operations - Add a blur to the image to reduce sharpness diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile.md new file mode 100644 index 00000000000..4da8ff97776 --- /dev/null +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile.md @@ -0,0 +1,37 @@ +--- +title: Extract From File +description: Documentation for the Extract From File node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +--- + +# Extract From File + +Use the Extract From File node to get data from a binary format and convert it to JSON. + +/// note | Examples and templates +For usage examples and templates to help you get started, refer to n8n's [Extract From File integrations](https://n8n.io/integrations/extract-from-file/){:target=_blank .external-link} page. +/// + +/// note | Convert to File +To convert JSON data to a file format, use the [Convert to File](/integrations/builtin/core-nodes/n8n-nodes-base.converttofile/) node. +/// + +## Node parameters + +* **Operation**: + * **Extract From CSV** + * **Extract From HTML** + * **Extract From JSON** + * **Extract From ICS** + * **Extract From ODS** + * **Extract From PDF** + * **Extract From RTF** + * **Extract From Text File** + * **Extract From XLS** + * **Extract From XLSX** + * **Move File to Base64 String** + +The other parameters depend on the operation: + +* All operations have **Input Binary Field**: the name of the field in the node input data that contains the binary file. +* **Extract From JSON**, **Extract From ICS**, **Extract From Text File**, and **Move File to Base64 String** also have **Destination Output Field**: the name of the field in the node output that will contain the extracted data. + diff --git a/docs/integrations/builtin/core-nodes/n8n-nodes-base.filesreadwrite.md b/docs/integrations/builtin/core-nodes/n8n-nodes-base.filesreadwrite.md new file mode 100644 index 00000000000..2ae1c85ad38 --- /dev/null +++ b/docs/integrations/builtin/core-nodes/n8n-nodes-base.filesreadwrite.md @@ -0,0 +1,42 @@ +--- +title: Read/Write Files from Disk +description: Documentation for the Read/Write Files from Disk node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +--- + +# Read/Write Files from Disk + +Use the Read/Write Files from Disk node to read and write files to/from the machine where n8n is running. + + +/// note | Examples and templates +For usage examples and templates to help you get started, refer to n8n's [Read/Write Files from Disk integrations](https://n8n.io/integrations/read-write-files-from-disk/){:target=_blank .external-link} page. +/// + +## Node parameters + +* **Operation** > **Read File(s) From Disk**: + * **File(s) Selector**: the path to read files from. +* **Operation** > **Write File to Disk**: + * **File Path and Name**: set the destination for the file. + * **Input Binary Field**: the name of the field in the node input data that contains the binary file. + +## Options + +The node options available depend on the operation. + +### Read File(s) From Disk + +* **File Extension**: set the extension for the file in the node output. +* **File Name**: set the name for the file in the node output. +* **MIME Type**: set the file's MIME type in the node output. +* **Put Output File in Field**: set the name of the field in the output data to contain the file. + +### Write File to Disk + +**Append**: enable this to append to an existing file, instead of creating a new one. + +## File locations + +If you run n8n in Docker, your command runs in the n8n container and not the Docker host. + +This node looks for files relative to the n8n install path. n8n recommends using absolute file paths to prevent any errors. diff --git a/document-templates/app-nodes.md b/document-templates/app-nodes.md index 571b047f332..da541bdcad1 100644 --- a/document-templates/app-nodes.md +++ b/document-templates/app-nodes.md @@ -29,7 +29,7 @@ Match the brand name exactly. For example, GitHub NOT Github +Use the _Name_ node to automate work in _Name_ and integrate _Name_ with other applications. n8n has built-in support for a wide range of _Name_ features, which includes creating, updating, and deleting events, people, tags, and signatures. --> On this page, you'll find a list of operations the _Name_ node supports, and links to more resources. diff --git a/document-templates/core-nodes.md b/document-templates/core-nodes.md index eacaea83c82..462fb52e37d 100644 --- a/document-templates/core-nodes.md +++ b/document-templates/core-nodes.md @@ -29,6 +29,7 @@ _Briefly summarize the functionality._ /// note | Credentials You can find authentication information for this node [here](/integrations/builtin/credentials/_Name_/). /// + /// note | Examples and templates For usage examples and templates to help you get started, refer to n8n's [_Name_ integrations](https://n8n.io/integrations/_Name_/){:target=_blank .external-link} page. /// diff --git a/document-templates/trigger-nodes.md b/document-templates/trigger-nodes.md index 166df106e85..a812938c643 100644 --- a/document-templates/trigger-nodes.md +++ b/document-templates/trigger-nodes.md @@ -29,7 +29,7 @@ Match the brand name exactly. For example, GitHub NOT Github On this page, you'll find a list of events the _Name_ trigger node can respond to, and links to more resources. diff --git a/mkdocs.yml b/mkdocs.yml index 81cb49ca508..ec60c4aeb81 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -246,7 +246,7 @@ nav: - integrations/builtin/core-nodes/n8n-nodes-base.code.md - integrations/builtin/core-nodes/n8n-nodes-base.comparedatasets.md - integrations/builtin/core-nodes/n8n-nodes-base.compression.md - - integrations/builtin/core-nodes/n8n-nodes-base.movebinarydata.md + - integrations/builtin/core-nodes/n8n-nodes-base.converttofile.md - integrations/builtin/core-nodes/n8n-nodes-base.crypto.md - integrations/builtin/core-nodes/n8n-nodes-base.datetime.md - integrations/builtin/core-nodes/n8n-nodes-base.debughelper.md @@ -258,13 +258,13 @@ nav: - integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow.md - integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger.md - integrations/builtin/core-nodes/n8n-nodes-base.executionData.md + - integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile.md - integrations/builtin/core-nodes/n8n-nodes-base.filter.md - integrations/builtin/core-nodes/n8n-nodes-base.ftp.md - integrations/builtin/core-nodes/n8n-nodes-base.git.md - integrations/builtin/core-nodes/n8n-nodes-base.graphql.md - integrations/builtin/core-nodes/n8n-nodes-base.html.md - integrations/builtin/core-nodes/n8n-nodes-base.httprequest.md - - integrations/builtin/core-nodes/n8n-nodes-base.ical.md - integrations/builtin/core-nodes/n8n-nodes-base.if.md - integrations/builtin/core-nodes/n8n-nodes-base.interval.md - integrations/builtin/core-nodes/n8n-nodes-base.itemlists.md @@ -279,15 +279,13 @@ nav: - integrations/builtin/core-nodes/n8n-nodes-base.formtrigger.md - integrations/builtin/core-nodes/n8n-nodes-base.n8ntrigger.md - integrations/builtin/core-nodes/n8n-nodes-base.noop.md - - integrations/builtin/core-nodes/n8n-nodes-base.readbinaryfiles.md - - integrations/builtin/core-nodes/n8n-nodes-base.readpdf.md + - integrations/builtin/core-nodes/n8n-nodes-base.filesreadwrite.md - integrations/builtin/core-nodes/n8n-nodes-base.renamekeys.md - integrations/builtin/core-nodes/n8n-nodes-base.respondtowebhook.md - integrations/builtin/core-nodes/n8n-nodes-base.rssfeedread.md - integrations/builtin/core-nodes/n8n-nodes-base.rssfeedreadtrigger.md - integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger.md - integrations/builtin/core-nodes/n8n-nodes-base.sendemail.md - - integrations/builtin/core-nodes/n8n-nodes-base.spreadsheetfile.md - integrations/builtin/core-nodes/n8n-nodes-base.ssetrigger.md - integrations/builtin/core-nodes/n8n-nodes-base.ssh.md - integrations/builtin/core-nodes/n8n-nodes-base.start.md @@ -297,7 +295,6 @@ nav: - integrations/builtin/core-nodes/n8n-nodes-base.wait.md - integrations/builtin/core-nodes/n8n-nodes-base.webhook.md - integrations/builtin/core-nodes/n8n-nodes-base.workflowtrigger.md - - integrations/builtin/core-nodes/n8n-nodes-base.writebinaryfile.md - integrations/builtin/core-nodes/n8n-nodes-base.xml.md - Actions: - integrations/builtin/app-nodes/index.md