Microsoft Viva Engage Connector for Navori QL: Quick Setup Guide
Prerequisites
Prerequisite | Steps |
1. Generate Yammer Developer Token | - Access the Yammer Developer Center and sign in. - Create a new app and copy the provided Developer Token. |
2. Register Azure AD Application | - Go to the Azure Portal. - Navigate to Azure Active Directory > App registrations > New registration. - Fill in the details and note the Application (client) ID. - Under API permissions, add necessary permissions (e.g., User.Read, File.ReadAll) and grant admin consent. |
3. MFA Disabled Email | - Use an Azure AD email account with Multi-Factor Authentication (MFA) disabled for API access. |
Here’s a detailed step-by-step guide for implementing a Microsoft Viva Engage Connector for Navori QL, starting with the prerequisites you've outlined:
How to Generate a Yammer Developer Token
Step 1: Access the Yammer Developer Site
Open Your Browser: Launch your preferred web browser.
Go to the Developer Site: Type in the URL: Yammer Developer Network and press Enter.
Log In:
Click on Sign In at the top right corner.
Enter your Microsoft account credentials. Make sure this account has access to the Yammer network you intend to work with.
Step 2: Register a New Application
Navigate to My Apps:
After logging in, look for My Apps in the navigation bar at the top and click on it.
Register a New Application:
Click the Register New App button.
Fill Out Application Details:
Application Name: Enter a meaningful name for your application (e.g., "My Yammer App").
Organization: Enter your organization name, if applicable (this could be your company or team name).
Support Email: Provide an email address for application support inquiries.
Website URL: Enter the URL of your application or your organization’s website (e.g., https://www.example.com).
Redirect URI: Input the URL where Yammer should redirect users after authentication. This is often the endpoint in your application that handles token reception (e.g., https://www.example.com/auth/yammer).
Submit the Registration:
After filling out all the required fields, review your information, and click Submit.
Step 3: Generate the Access Token
Select Your Application:
Return to My Apps and find the application you just registered. Click on it to open the details page.
Locate the Developer Token Section:
Scroll down until you find the Developer Token section on the application details page.
Generate the Token:
Click the Generate Token button. A developer token will be created and displayed on the screen.
Copy the Token:
Carefully copy the developer token, as you will need this to authenticate your API calls.
Important Notes
Token Scope: Developer tokens are specific to the user account that generated them. They inherit the permissions of that user. If your application requires broader access, you may need to implement OAuth 2.0 with the appropriate permissions.
Token Expiration: The developer token is long-lived but not permanent. Ensure your application handles token expiration gracefully by checking for expiration and refreshing tokens as necessary.
Azure App Registration Implementation Steps
Prerequisites
Ensure you have Azure Application administrator rights.
Have the necessary details ready for your application (name, permissions, etc.).
Step 1A: Log in to Azure Portal
Navigate to Azure Portal.
Sign in with your Azure account that has the required permissions.
Step 2: Register a New Application
Search for App Registrations:
In the Azure portal, use the search bar to find App registrations.
Create a New Application:
Click on New Registration.
Fill Out the Application Registration Form
Name: Enter a descriptive name for your application.
Supported account types: Select an option that suits your needs (e.g., "Accounts in this organizational directory only").
Redirect URI (optional): Specify a redirect URI if needed; this can be updated later.
Register the Application:
Click on Register to finalize the application registration.
Step 3: Configure API Permissions
Access the Application Overview:
After registration, you'll see a new application created.
API Permissions:
Click on API permissions in the left-hand menu.
Add Permissions:
Click on + Add a permission at the top of the API permissions pane.
Request API Permissions:
In the "Request API permissions" pane, select Microsoft API >Microsoft Graph
Search for Files:
In the search box, type Files and select Files.Read.All from the results.
Select Permissions
Delegate Permissions:
Choose Delegated permissions and select the required permissions for the Engage application. Make sure to select all the listed API permissions that you need.
Grant Admin Consent:
Once you’ve selected the permissions, click on Grant admin consent to apply the permissions.
Step 4: Click on Authentication
Authentication Section:
Click on Authentication in the left side pane at the top.
Advanced settings > Allow public client flows
Make it Yes (Enable the following mobile and desktop flows:)
Step 5: Copy Application (Client) ID
Overview Section:
Click on Overview in the left side pane at the top.
Copy the Application (client) ID. You will need this later.
Keep ready below details .
{
"Login": "***************",
"Password": "**************",
"AccessToken": "**********************,
"ClientId": "***********************",
"GroupUrl": "https://www.yammer.com/XXXXXXX#/threads/inGroup?type=in_group&feedId=115596435456&view=all"
}
Step 5: Log in to Qlmanager
Create a New Template:
Log in to Qlmanager.
Create a new template and open Data Feed Manager.
Create New Feed:
Click on + New Feed and select Engage from the dropdown.
Enter Data Source Details
In the Data Source Connection Window:
Type: Select Engage.
Name: Provide a name for your Engage template.
Login: Use the email ID of a user with MFA (Multi-Factor Authentication) disabled.
Password: Enter the password for the MFA-disabled user account.
Engage Access Token: Enter viva developer token
Client ID: Paste the Client ID you copied from Azure.
URL: Enter your viva Engage Group URL
Some common error and description:-
S.No. | Connector Name | Condition | Error Message | Possible Cause(s) | Suggested Resolution |
1 | Viva Engage | If any required input field missing | Value does not exist for property: (ABC) | One or more required fields (e.g., Username, Password, Client ID, Group URL) were not provided or left empty in the input form. | Verify that all mandatory fields are filled out with correct values in the input form, and ensure no field is missing or incorrectly named. |
2 | Viva Engage | If Username is wrong | Response status code does not indicate success: 401 (Unauthorized) | The provided username is incorrect or does not exist in the Viva Engage platform. | Check and re-enter the correct username. Ensure that the username exists and has permissions to access the specified Viva Engage resources. |
3 | Viva Engage | If password is wrong | Response status code does not indicate success: 401 (Unauthorized) | The password entered for the specified username is incorrect. | Confirm that the password entered is correct for the given username. Update the password if needed, or reset it if it is not known. |
4 | Viva Engage | If clientID is wrong | Response status code does not indicate success: 401 (Unauthorized) | The Client ID used in the configuration does not match the registered Client ID in Viva Engage, which is required for authentication. | Verify the Client ID against the one provided in the Viva Engage Developer portal and make sure it is accurately entered in the input form. |
5 | Viva Engage | If groupUrl is not valid | Invalid URL or Group identifier not found in the URL | The specified Group URL is either incorrectly formatted or does not correspond to a valid group identifier on Viva Engage. | Check the Group URL to ensure it is correctly formatted and points to an active group. Use the URL format provided in the Viva Engage documentation. |