by eVolpe Consulting Group

The Sugar/SuiteCRM & Alfresco Integrator by eVolpe is a perfect solution for all the companies, which are currently deploying or already using both of the systems. Are you facing difficulties trying to coordinate your documentation in the context of sales opportunities? This is the best solution!

Free 30 day trial
Try it Now

By clicking you consent to share your profile with the developer

Configuration Guide

Alfresco Plugin Configuration

CRM Plugin Configuration - Step 1: License Management - Step 2: Alfresco Connection Configuration - Step 3: Make sure if CRM job exists in crontab - Step 4: Setting up Users & Access - Step 5: Setting up Alfresco paths

Alfresco Plugin Configuration

NO configuration is needed on Alfresco Side

CRM Plugin Configuration

Configuration Guide - Administration Panel.JPG

Step 1: License Management

Alfresco integration module has it's own license system. Upon proper validation you will gain access to the Alfresco settings available in Administration panel.
  • In Administration go to Alfresco Integration License Management
  • Enter Your key in License Key field
  • Press Validate to see if your key is correct. You should see "Success" message
  • Click Save
Keep in mind that without proper license key (or with expired one):
  • You won't be able to setup anything in newly added Alfresco panels in administration module.
  • You won't have access to the Alfresco widget in subpanels for which you've defined paths.
  • Changes you’ve made to the record names won't map in Alfresco, which further on means that you will need to fix this later on your own in Alfresco, since CRM cron will create new folders upon detecting that there are some new records which haven't been mapped yet in Alfresco

Step 2: Alfresco Connection Configuration

  • Go to Administration panel
  • Scroll down to the section Alfresco Configuration and click on Alfresco Configuration.
  • Insert Alfresco login information.
Keep in mind:
  • Document server address: Url must be inserted in form /alfresco – without protocol
  • Document Server Admin Password: in case of importing data from database enter password manually in this field, as some characters might be lost during export/import sql.
  • Providing incorrect url such like: http://1.1.1.1:8080/alfresco will trigger popup with information: Cannot connect to the Document Server, this error will be thrown even if your address is handled correctly in web browser. You need to insert url in form: 1.1.1.1:8080/alfresco.
Configuration Guide - Document Server Connection Settings.JPG

Step 3: Make sure if CRM job exists in crontab

Go to Administration Panel and enter Schedulers section. AT the end of the list you’ll see „To Setup Crontab section”. Copy the line beginning with *. Now, depending what kind of access you’ve got to your host, you will need to add the line you’ve copied into background job manager.

For example on Apache server with SSH access, where Apache system user is www-data: You can simply enter command:

    crontab -e -u www-data

And add :

*   *   *   *   *    cd /var/www/crm; php -f cron.php > /dev/null 2>&1

With other servers there may be some kind of GUI in hosting panel. For instance: Configuration Guide - Crontab hosting panel.jpg Keep in mind:

  • Some hosting panels might not have crontab settings in directadmin. If such situation will occur you’ll either need to contact your administrator or hosting support.
  • Crontab panel presented above might vary from the one in your hosting panel.
  • Servers running on Windows have different mechanism for background task.

Step 4: Setting up Users & Access

For each CRM user you have to set up related Alfresco user. There are two ways of doing that.

If CRM user has already got an Alfresco account

  • Go to account profile Settings and click Edit
  • Go to External Accounts tab and click Create
  • From Application list select Alfresco and enter Your login and password for Alfresco
  • Click Connect and on next page click Save

If you need to create an Alfresco account for CRM user

Go to Alfresco section in administration panel and choose Manage Alfresco Users accounts and press Create user in action column.

In the new message popup you can decide whether you want to assign certain role to new user or not. Configuration Guide - Create User Popup.JPG   Keep in mind:

  • If you’ll assign your Alfresco admin credential to any other user, its full access will overwrite any role setting which this user should inherit from access groups he belongs to, which furthermore means that no matter what restriction you’ll put upon that user, his account will first be using full administration access.
  • As mentioned above, for new users you need to provide information that are entered upon first login, otherwise you won’t be able to create new account, and Alfresco Accounts panel in CRM won't have action button:
Configuration Guide - Alfresco Users.JPG

Roles Configuration

Once you've mapped CRM account to Alfresco via Manage Alfresco Users accounts panel, you can set user permissions to Alfresco Sites by assigning role to account. Alfresco Roles GUI works in similar way to CRM Role Management module. Go to Administration panel/Alfresco Access and create a role. In Detail View you can configure an Alfresco Role for each already defined Path and assign Users in subpanel.

Keep in mind:

  • Remember to click Save for corresponding section in which you make changes
  • One user can be assigned to more than one Roles group in Alfresco Access panel. User will then acquire the privileges with less restrictions which mean that the group with Collaborator Role will overwrite group that has Consumer role setup.
  • Each role provides set of predefined rules, about which you can read on: https://docs.alfresco.com/5.2/references/permissions_share.html
Configuration Guide - Role Management.JPG

From now on, once you assign role to the new user, you can start using Alfresco integration functionality.

Step 5: Setting up Alfresco paths

With this step you will set folders mapping so that CRM can see their content.

Configuration Guide - Create Path.JPG
  • Go to Administration Panel/ Alfresco section and click on Update Alfresco Fields
  • Next, in order to add a new path, click on small arrow next to module name and choose Create Document Path
  • Fill the form:
    • Path name: Used to display on paths in dropdown in Alfresco Widget under record if you have more than one path defined per module
    • Module: Module for which we want to enable integration. All standard modules are available as well as custom modules
    • Directory: Path schema to directory in Alfresco that will be created for each record from related module. It may contain variables in form of field names from related module surrounded by < >
    • Allow adding files: Decide whether files can be added via subpanel for given path or not (It does not affect ability to do that via Alfresco Share)
    • Shared directory: Decide if records with the same values for variables in path should share the same folder. If not, for duplicated paths system will automatically add postfix in node folder name :"_1", "_2" etc
    • Site name: Site name that you have created in Alfresco
Configuration Guide - Path Record Example.JPG

Keep in mind that:

  • Form should be filled up with data similar to this below, and that especially means that Directory should have form such as
    /Sites/YourSiteName/documentLibrary/YourFolderName/< name >,
  • < name > is the variable available in the vardefs.php file of module for which path is created. You can use other variables but they need to exist in Vardefs (each one must be placed in separated <> tags )
  • YourSiteName is the site name created in Alfresco,
  • YourFolderName in this case is a static grouping folder,
  • Site that you are mapping must exits, otherwise you might’ve problems with setting up permissions for given folder.
  • You might notice that only records created* after adding specified paths will have access to Alfresco folders. You can fix that by accessing Administration Panel and pressing Update Alfresco Fields.
  • If you’ve enabled folder sharing, and you’ve already have records that share some folders, then upon changing settings in Alfresco Paths these records will still share the same folder. You’ll need to, for example, to change the names of records and turn them back as they were – this way new separated/private folders will be created in Alfresco. In this situation, even if you remove one record with the same name, shared folder on Alfresco will remain untouched.
Saving Comment Saving Comment...