User Tools

Site Tools


dolibarrconnectoruserguide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
dolibarrconnectoruserguide [2017/05/18 12:50] – [Module administration] object links fappelsdolibarrconnectoruserguide [2023/04/14 14:40] (current) – [Activate module] fappels
Line 1: Line 1:
 ====== Dolibarr connector ====== ====== Dolibarr connector ======
 ===== Installation ===== ===== Installation =====
 +==== Standard installation ====
 +If you get the module in a zip file (like when downloading it from the market place [[https://www.dolistore.com|Dolistore]], go into
 +menu **Home - Setup - Modules - Deploy external module** and upload the zip file.
 +To connect the Mobilid application you need to select the Dolibarr Custom connector in the Mobilid setup.
 +
 +==== Root installation ====
 +You can also use old Dolibarr root procedure.
 Place module_extdirect-1.0.x.zip file into dolibarr root directory on your server. Place module_extdirect-1.0.x.zip file into dolibarr root directory on your server.
 Uncompress file with command: Uncompress file with command:
 <code>unzip module_extdirect-1.0.x.zip</code> <code>unzip module_extdirect-1.0.x.zip</code>
-Module is ready to setup.+For this mode you need to select the Dolibarr Root connector in the Mobilid setup. 
 + 
 +==== Git clone installation ==== 
 +The connector module files are located in the 'extdirect' subfolder of the git repo. 
 +You can clone the repo in your dolibarr custom folder, but you need to make a symbolic link to the 'extdirect' subfolder. 
 +For the community version [[https://github.com/fappels/dolibarrextdirect|dolibarrextdirect]] you need to run command: 
 +<code>ln -s dolibarrextdirect/extdirect extdirect</code> 
 +For the payed [[https://github.com/fappels/dolibarr-mobilid|dolibarr-mobilid]] you need to run command: 
 +<code>ln -s dolibarr-mobilid/extdirect extdirect</code> 
 +For this mode you need to select the Dolibarr Custom connector in the Mobilid setup. 
 + 
 + 
 + 
 + 
 + 
  
-You can also install the module using the Dolibarr admin tools Upgrade/Extend option. When installed in this mode you will have to add /custom to the connection URL in the Mobilid app. 
 ===== Module setup ===== ===== Module setup =====
 ==== Activate module ==== ==== Activate module ====
Line 14: Line 35:
   - With an administrator account, go on page "Home - Setup - Modules".   - With an administrator account, go on page "Home - Setup - Modules".
   - Choose the "interfaces modules" tab.    - Choose the "interfaces modules" tab. 
-  - Look for the "ExtDirect" module.+  - Look for the "MOBILID CONNECTOR" or "EXTDIRECT" module.
   - Then click on "Activate" toggle switch.   - Then click on "Activate" toggle switch.
   - Click on module configuration icon to setup the connector.   - Click on module configuration icon to setup the connector.
Line 34: Line 55:
   - Set Parameter 'AutoAsign' to 'No' and click 'Modify'.   - Set Parameter 'AutoAsign' to 'No' and click 'Modify'.
   - Connect Mobilid (Set URL and Indentification in Mobilid Settings and push back button) and click 'Refresh'.   - Connect Mobilid (Set URL and Indentification in Mobilid Settings and push back button) and click 'Refresh'.
-  - Select Dolibarr user to assign to the connection.+  - Select Dolibarr user to assign to the connection request.
   - Click 'Save'.   - Click 'Save'.
   - Tap 'Yes' in Mobilid to confirm the connection.   - Tap 'Yes' in Mobilid to confirm the connection.
   - When you 'Refresh' again you should see the 'Acknowledge' flag set.   - When you 'Refresh' again you should see the 'Acknowledge' flag set.
 You can use this screen also to monitor which type and when a device was last connected. The list is sorted on last connection. You can use this screen also to monitor which type and when a device was last connected. The list is sorted on last connection.
 +
 +After connecting you can change still change assigned Dolibarr user or the request identification in the Mobilid app.
  
 **Important, when adding a connection your need to tap the '+' button, only when moving your server you may change the connection URL** **Important, when adding a connection your need to tap the '+' button, only when moving your server you may change the connection URL**
 === Activity tracking === === Activity tracking ===
 Choose the Activities tab to see all activities of the connected apps. You can see when a Mobilid module was started and finished (timetracking), the duration between start and finish is also shown. Choose the Activities tab to see all activities of the connected apps. You can see when a Mobilid module was started and finished (timetracking), the duration between start and finish is also shown.
-You can filter activities by dolibarr user, when filtered you will links to the objects handled by an activity.+You can filter activities by dolibarr user, when filtered you will have links to the objects handled by an activity.
 ===== Module update ===== ===== Module update =====
 When an existing installation is updated, disable and re-enable module to update module database. When an existing installation is updated, disable and re-enable module to update module database.
dolibarrconnectoruserguide.1495104657.txt.gz · Last modified: 2017/05/18 12:50 by fappels