Riva CRM Integration - Documentation and Knowledge Base

Riva Admin Center: Overview and User Guide

Article ID: 2390
Last updated: 26 Sep, 2023

Overview

Introducing Riva Admin Center, an app designed to simplify the management of Riva settings for on-premise deployments. With this app, admins can easily access and modify Riva settings from a browser without the need to access the server. Riva Admin Center has a user-friendly interface that makes it easy for the admins to onboard, manage, and troubleshoot. 

  1. Synchronization 
    1. Settings
    2. Advanced Options
    3. Connections & Connections Tests
  2. Users
    1. Reinitialize Users
    2. Sync Now
    3. Move Users
  3. Administration
    1. Authentication Settings
    2. Security Certificate
    3. Cluster Settings

User Guide

When Riva Admin Center launched, admins are greeted with our welcome page. From the top navigation bar, Admins can select the Cluster and Profile they wish to manage. Once they have chosen their desired profile, admins can then use the left navigation bar to review the details of their profile and perform actions against it.

Synchronization 

Admins can review their profile setting details.

Settings

At this point, these are read-only fields that would help with identification and troubleshooting. Admins, do have the power to enable or disable their policy from this view using the blue toggle button.

Advanced Options

Admins can review all of the configuration keys added to a policy on the Advanced Keys page. Here, Admins can add new keys, edit existing keys, and delete or disable keys. As the keys are modified, status indicators such as, “to be disabled”, or “to be deleted”, are presented to the admin, allowing them to review changes to be made before saving.

Connections & Connection Tests

Admins can view connections associated with their profile. Along with that, Admins have the additional capability to test Email and CRM connections from the kebab menu. 

Clicking on the 'Test Connection' Button, Admins can navigate to the Connection Test Overview page. 

Types of Connection Tests

  1. Service Account Test: Checks if the service account has the necessary permissions to access the resources it needs. 
  2. User Account Test: Checks if a specific user account has the necessary permissions to access the resources it needs. 
  3. General Test: Ensures that Riva Sync can communicate with the connection by testing the response time and connectivity of the device. 
  4. Poll Change Test: Validates the changes have been successfully applied to a certain number of objects. 
  5. Get By Id Test: Retrieves a single object from the connection based on its unique identifier, and verifies that the object exists. 

Users 

Admins can view a list of user accounts associated with their selected profile. Administrators can then perform actions on those user accounts, which will trigger specific synchronization reinitializations for quick fixes or troubleshooting.

The dropdown 'With Selected', allows admins to perform actions on the users in their profile. Admins can bulk select users with the checkbox or action individual users using the kebab menu

Actions Available

  1. Reinitialize Users
  2. Sync Now
  3. Move User

Reinitialize Users

Admins can select users from the 'Manage Users' page or input additional user email addresses, select the module, and type for reinitialization. Users are queued for reinitialization and the admins are presented with a success page. 

Sync Now

Admins can select users from the 'Manage Users' page or input additional user email addresses for initiating a sync. Users are queued for sync now and the admins are presented with a success page. 

Move User

Pre-requisite: Users must have a node identified and established on the Manage Users page to move from one node to another. 

Admins can select users from the 'Manage Users' page to move them to a different destination node. 

Admins must move the synchronization metadata to the target node for the users selected if they were syncing previously.

Once the metadata is moved manually in the background, the Admin can confirm the ask and move to the next step. The users require a reinitialization to ensure they continue to sync in the new node. The Module and Reinitialization Type is pre-selected and the Admin needs to initiate the process. 

Once the reinitialization is complete, the results are displayed to the Admin. 

Administration

This section covers actions required for set-up and security. 

Authentication Settings

When setting up the Riva synchronization profile, Admins are required to input authentication settings from their Azure AD App Registration.

Security Certificate

At times a security certificate is needed to ensure that data is protected. 

Cluster Settings

Clusters settings are managed by the Riva Support team when onboarding customers.

Article ID: 2390
Last updated: 26 Sep, 2023
Revision: 12
Views: 0