31,028
edits
Using Dolibarr node in the n8n automation platform: Difference between revisions
Jump to navigation
Jump to search
m
Using Dolibarr node in the n8n automation platform (view source)
Revision as of 09:47, 25 May 2023
, 3 years agono edit summary
Lpierson002 (talk | contribs) (→Credits: adding link to AuTEAMation) |
mNo edit summary Tag: 2017 source edit |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
If you want a tutorial to the integration of Dolibarr to the n8n automation platform you can find it [[Integration of Dolibarr to the n8n automation platform|here.]] | {{TemplateDocUser}} | ||
[[Category:No Code Automation]] | |||
If you want a developer tutorial to the integration of Dolibarr to the n8n automation platform you can find it [[Integration of Dolibarr to the n8n automation platform|here.]] | |||
==Prerequisites== | ==Prerequisites== | ||
| Line 6: | Line 9: | ||
*You have access to an instance of Dolibarr configured to use SSL encryption (with the HTTPS protocol), | *You have access to an instance of Dolibarr configured to use SSL encryption (with the HTTPS protocol), | ||
*You have access to a user account with rights to use some specific modules such as Calendar, Project or Documents, | *You have access to a user account with rights to use some specific modules such as Calendar, Project or Documents, | ||
*You have obtained an API key for | *You have obtained an API key for this user account that you will be used to test your integration (generated by an administrator, or by the user himself if he has permission to modify his user account information). | ||
When necessary, we will use the following URL to refer to your Dolibarr instance: `https://yourdolibarrurl`. You will have to replace it with the URL of your own Dolibarr instance, without trailing slash. | When necessary, in this documentation, we will use the following URL to refer to your Dolibarr instance: `https://yourdolibarrurl`. You will have to replace it with the URL of your own Dolibarr instance, without trailing slash. | ||
<br /> | <br /> | ||
| Line 56: | Line 59: | ||
For every Dolibarr node there will be some fields that will be the same. | For every Dolibarr node there will be some fields that will be the same. | ||
These fields are the first three one on the picture below : | These fields are the first three one on the picture below: | ||
*'''Credential to connect with''' | *'''Credential to connect with''': this is where you can set your '''credentials''' as explained just before, | ||
*'''Resource''' : this is where you choose which module of Dolibarr will be affected, there are 4 options : Calendar, Task, Document and Custom API Call (use this one only if you know what you are doing), | *'''Resource''': this is where you choose which module of Dolibarr will be affected, there are 4 options : Calendar, Task, Document and Custom API Call (use this one only if you know what you are doing), | ||
*'''Operation''' : this is in this field where you select the kind of operation you want to do on this specific resource, for now it only supports creation operation. | *'''Operation''': this is in this field where you select the kind of operation you want to do on this specific resource, for now it only supports creation operation. | ||
<br /> | <br /> | ||
| Line 71: | Line 74: | ||
If you have selected the '''Create an Event''' operation and have alreary set your credentials the first three fields will be already completed. | If you have selected the '''Create an Event''' operation and have alreary set your credentials the first three fields will be already completed. | ||
For the next fields : | For the next fields: | ||
*'''Event Name''' corresponds with the '''Label''' field in Dolibarr interface (this field is required), | *'''Event Name''' corresponds with the '''Label''' field in Dolibarr interface (this field is required), | ||
| Line 102: | Line 105: | ||
You can either type or drag and drop from the left window which field you want to have from the Google Calendar Event. | You can either type or drag and drop from the left window which field you want to have from the Google Calendar Event. | ||
Here : | Here: | ||
*<code>$json.summary</code> corresponds to the Google Caldendar Event Name, | *<code>$json.summary</code> corresponds to the Google Caldendar Event Name, | ||
| Line 127: | Line 130: | ||
You can either type or drag and drop from the '''INPUT''' window on the left which field you want to have from the received mail. | You can either type or drag and drop from the '''INPUT''' window on the left which field you want to have from the received mail. | ||
Here : | Here: | ||
*<code>$json.subject</code> corresponds to the subject of the mail, | *<code>$json.subject</code> corresponds to the subject of the mail, | ||
| Line 150: | Line 153: | ||
If you have selected '''Create a document''' and have alreary set your credentials the first two fields will be already completed. | If you have selected '''Create a document''' and have alreary set your credentials the first two fields will be already completed. | ||
For the next fields : | For the next fields: | ||
*'''File Name''' corresponds to the file name is Dolibarr, it is important not to forget the file extension if you want it to have one (this field is required), | *'''File Name''' corresponds to the file name is Dolibarr, it is important not to forget the file extension if you want it to have one (this field is required), | ||
| Line 178: | Line 181: | ||
You can either type or drag and drop from the '''INPUT''' window on the left which field you want to have from the received mail. | You can either type or drag and drop from the '''INPUT''' window on the left which field you want to have from the received mail. | ||
Here : | Here: | ||
*<code>$json.topic</code> corresponds to the topic of the Zoom meeting, | *<code>$json.topic</code> corresponds to the topic of the Zoom meeting, | ||
| Line 200: | Line 203: | ||
If you have selected '''Create a Task''' and have alreary set your credentials the first three fields will be already completed. | If you have selected '''Create a Task''' and have alreary set your credentials the first three fields will be already completed. | ||
For the next fields : | For the next fields: | ||
*'''Task Reference''' corresponds with the '''Ref.''' field in Dolibarr interface, the '''Task Reference''' is a '''string''' that must be unique, (this field is required), | *'''Task Reference''' corresponds with the '''Ref.''' field in Dolibarr interface, the '''Task Reference''' is a '''string''' that must be unique, (this field is required), | ||
| Line 216: | Line 219: | ||
To produce this use case you will have to connect a '''Github Trigger node''' on the '''Dolibarr node'''. | To produce this use case you will have to connect a '''Github Trigger node''' on the '''Dolibarr node'''. | ||
It is important here if you are using a self-hosted instance of n8n to start it in tunnel mode. To do so, just run the following command : <code>n8n start --tunnel</code>. | It is important here if you are using a self-hosted instance of n8n to start it in tunnel mode. To do so, just run the following command: <code>n8n start --tunnel</code>. | ||
To trigger on receiving issues select the type '''Issues''' in the '''Events''' field. | To trigger on receiving issues select the type '''Issues''' in the '''Events''' field. | ||
| Line 233: | Line 236: | ||
You can either type or drag and drop from the left window which field you want to have from the Github Issue. | You can either type or drag and drop from the left window which field you want to have from the Github Issue. | ||
Here : | Here: | ||
*<code>$json.body.repository.name</code> corresponds to the name of the Github repository, | *<code>$json.body.repository.name</code> corresponds to the name of the Github repository, | ||