Riva CRM Integration - Documentation and Knowledge Base

Prepare SuiteCRM for Riva

Article ID: 1303
Last updated: 03 May, 2016

The Riva On-Premise server supports data synchronization with SuiteCRM On-Premise. This article describes how to prepare a SuiteCRM server and the Riva server, to support a Riva impersonation connection to SuiteCRM.

To prepare SuiteCRM for Riva:

  1. Prepare the host Windows system.
  2. Prepare the SuiteCRM server.
  3. Prepare the Riva connection account in SuiteCRM.
  4. Prepare the target user accounts in SuiteCRM.
  5. Gather information for creating the Riva SuiteCRM connection.

Step 1: Prepare the Host Windows System

The Riva server can be installed on any Windows system that meets the system requirements; 32-bit Windows is preferred.

Note: Installing Riva on the Windows server that hosts the SuiteCRM server is not recommended.

Confirm that you can log in to the SuiteCRM application through a web browser by using an administrator-level account.

Step 2: Prepare the SuiteCRM Server

The Riva On-Premise server supports the latest release of SuiteCRM On-Premise.

Up to three preparations and performance-tuning improvements may be required for on-premise and independent SuiteCRM service providers:

2.1: SuiteCRM preparation for user impersonation

Riva requires user impersonation access through an administrator-level account to access the target user CRM accounts. By default, SuiteCRM Community Edition does not install this support. See How to configure "user impersonation" support for Sugar Community Edition and SuiteCRM.

2.2: SuiteCRM server performance tuning

When Riva server attempts to sync multiple target users concurrently, it can create many Apache instances on the SuiteCRM host server that use most of the available memory. For six tips that can greatly reduce the impact of memory usage, see Performance Tuning: Sugar ... SuiteCRM.

2.3: Performance tuning and resource planning for CRM hosted on LAMP/WAMP

Another best practice on host Apache servers is to adjust the maximum number of worker processes to match the amount of memory available on the server. For more information, see Recommendations for performance tuning and resource planning for CRM hosted on LAMP/WAMP.

Step 3: Prepare the Riva Connection Account in SuiteCRM

The Riva connection to the target CRM must be configured to use the credentials of an administrator-level account. For SuiteCRM, choose one of the following options:

  • Use an existing account assigned to the Administrator role, or
  • Create a service account in SuiteCRM for Riva, for example rivacrm or riva_svc, and assign it to the Administrator role.

The administrator account provides the privileges necessary to impersonate each target user and make the necessary changes to records in the CRM for each target user.

Step 4: Prepare the Target User Accounts in SuiteCRM

Two configurations must be confirmed to enable the target users:

  • Configure the correct primary email address value
  • Enable sufficient access permissions

4.1: Configure the correct primary email address value

The Riva server attempts to match the primary SMTP email address of each target user's email account to the primary email address value of the corresponding target user in SuiteCRM. Ensure that for each user, the email address values from the email system and SuiteCRM are identical.

4:2: Enable sufficient access permissions

The Riva connection to SuiteCRM uses the Enterprise Impersonation Model: When Riva creates new items in the CRM, it assigns ownership to the "target user". Since Riva is now acting on behalf of the target user, all audit fields in the CRM record the target user as the user that created and modified the item. Riva uses the permissions of the CRM target user to create and modify items and data in the CRM.

If the access permissions defined for the target user are not sufficient, the Riva server displays Access denied errors for each data change it tries to synchronize. Ensure that for each target user, permissions are assigned to create, modify, delete, import, and export datatypes that Riva will attempt to sync for that user. For more information, see Sugar Access Denied errors explained.

Step 5: Gather Information for Creating the Riva SuiteCRM Connection

For SuiteCRM, Riva uses a Sugar connection. Gather the following information:

  • User name and Password: The SuiteCRM user name and password for the Riva connection account and
  • Address: The http:// or https:// website link to log in to the target CRM.

That information will be required when you create the Riva connection to the target SuiteCRM system.

This article was:   Helpful | Not helpful
Report an issue
Article ID: 1303
Last updated: 03 May, 2016
Revision: 11
Views: 6616
Comments: 0
Also read

Also listed in