If you are using Sugar 6 or earlier, which uses a SOAP connection, see Create and test a Sugar 6.x connection.
In Riva 2.4.46 or higher, the connection to Sugar 7+ supports both on-premise and hosted Sugar services like SugarCRM and Sugar On-Demand.
Requirement: a connection to Sugar 7+ that uses the credentials of an admin account that can impersonate the target Sugar 7+ user accounts.
To create and test a Sugar 7+ connection:
Step 1: Create a Sugar 7+ Connection
- Ensure that you have followed this procedure: Prepare Sugar for Riva.
- Start the Riva Manager application. On the menu bar, select Setup. In the left pane, select CRM: SugarCRM 7+ to open the SugarCRM 7+ Wizard.
- On the Welcome page, select Next.
-
Provide the required information:
- Host: Provide the URL link to the Sugar 7+ login window, for example, https://crm.mycompany.com/sugar/rest10.
- User Name: Provide an admin-level Sugar account for Riva to connect to the Sugar system and impersonate the target user accounts.
- Password: Provide the password for the admin account.
-
Platform: (Default: Riva.) The custom platform configured in Sugar to enable Riva to log in or impersonate a user without terminating their Sugar web sessions.
- For information on platforms, see http://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_7.9/Architecture/Extensions/Platforms/
- Sugar 8.x: See Authenticate to Sugar 8 via a custom API platform.
- Sugar 7.x: For a tutorial on registering custom platforms in Sugar 7.x instances, see https://community.sugarcrm.com/docs/DOC-5875-tutorial-how-to-register-custom-platforms-in-sugar-instances
- Use proxy: If proxy options are required for this connection, specify a unique http/s proxy setting.
- Advanced Options: Opens the Advanced Options window, where you can apply advanced options or custom options to this connection. For tips and instructions on how to use the window, see Best practice.
- Select Next.
- (Riva 2.4.47 or higher.) On the Additional Connection Options page, optionally select the check box Is the connection user dedicated for synchronization: [user name]. For guidance, see Is the connection user dedicated for synchronization.
-
On the Successful Connection page, select Finish.
Result: The Riva Manager application creates a Sugar 7+ connection object.
Step 2: Test the Sugar 7+ Connection
To confirm that user impersonation is working:
- In the Riva Manager application, on the menu bar, select Setup. In the right pane, double-click the SugarCRM 7+ connection object.
-
In the CRM Connection Edit window that appears, select the Connection Test tab, and select Test Connection.
Result: Two tests are performed on the Sugar connection account. They ensure that
- the username and password are correct and
- the platform is valid.
- In the Test succeeded message box, select OK.
-
In the User E-Mail field, enter the user email address for a CRM target user, and select Run Test >>.
Result: The system tests that the Sugar connection account is able to impersonate the Sugar target user account.
- In the Test succeeded message box, select OK.
- Select Cancel to close the window.
Step 3: Edit the Sugar 7+ Connection
- In the Riva Manager application, on the menu bar, select Setup.
- In the right pane, double-click the Sugar 7+ connection to open the CRM Connection Edit window.
- Optional: On the General page, assign a user-friendly Display Name.
- Save the connection.