LiveTiles Intranet Search Connector

  • Updated

LiveTiles Intranet Search Connector

The main objective of LiveTiles Search connector is to make reach content discoverable within the MS SharePoint intranet. LiveTiles Search Connector allows you to bring a unified search experience Intranet. This connector enhances the user experience by providing a single entry point to find information published within the Reach portal. This provides real-time access to data, ensuring that search results are always up to date. This is crucial for applications where timely and accurate information retrieval is essential.

System Components

  • LiveTiles Reach Subscription/Portal
    1. This is the source system from where the webhooks will be called in LiveTiles Reach based on subscribed events. This system will be responsible for sending payload data to the Search connector, which will act as the input for the search connector.
  • LiveTiles Custom Search Connector
    1. The Search connector is deployed in Azure cloud service for securely accessing the data and making the connection to the destination system.
    2. This component accepts the input payload data from the Reach webhook and uses it for further processing.
    3. Search connector uses tenant ID from the payload to create the connection with M365 and Configure the search schema further it uses payload data to index the reach content into the search indexer.
  • Azure AD App Registration
    1. Azure App Registration is a critical component in the Intranet Search connector as it provides the means for the connector to securely authenticate and authorize itself to access Microsoft Graph and other Microsoft 365 services. It ensures that the connector has the appropriate permissions and security measures in place to access, retrieve, and interact with data and resources on behalf of applications.
  • Reach API
    1. LiveTiles Search connector makes use of reach API to fetch the details of reach users and group membership details, and this mainly ensures the permission trimming in MS search result.

 

Deployment Steps

  • Step 1 – Reach Subscription Connected to Azure Active Directory
    1. Ensure that LiveTiles Reach subscription is connected to the Azure Active Directory and with Admin consent. 
  • Step 2 – Azure AD App Registration Authorization
    1. Open the browser with the tenant admin user role and use the below Url to apply Azure AD App registration authorization.
https://login.microsoftonline.com/{tenant_id}/oauth2/v2.0/authorize?
client_id=1d82534b-04cf-4379-8069-1f342707f838&
redirect_uri=https://reach.livetiles.io/&
response_type=code&
scope=1d82534b-04cf-4379-8069-1f342707f838/.default&
response_mode=query

2. Replace {tenant_id} with customer Azure AD tenant ID.

3. Provide consent to the MS Graph permissions.

  • Step 3 – Generate Reach API Key with Owner Permissions
    1. Login to the Reach subscription with a user account with an owner role.
    2. Go to the Users section under settings and Generate New API Key.
    3. Make a copy of the generated API key as we'll need it in the upcoming steps.
    4. Go to the owner's section under settings and assign the owner right to the API key generated above
  • Step 4 – Update Reach API Key into function app configuration [To be performed by support team]
    1. Login to Azure portal and access the function configuration area under the settings section
    2. Add a new application setting entry.
      • Name : ReachSettings:ReachApiKey-{ReachSubscriptionID}
      • Value : {ApiKey}
    3. Replace {ReachSubscriptionID} with customer Reach Subscription ID.
    4. Replace {ApiKey} with ApiKey Generated at step 3.

 

  • Step 5 – Reach Webhook Configuration for Search Connector Configuration
      1. Login to the Reach subscription with a user account with an owner role
      2. Go to the Webhooks section under settings and Click “Add Webhook.”
      3. Provide the Below Value to the webhook.
        • description: LiveTiles Search Connector Configuration (Can provide another friendly title)
        • URL - <Can contact product support team>
        • Subscribed Event: Under News - Select “Publish” and “Published Version Update”
  1.  

4. Go to the news section of Reach Subscription and publish New or Existing News.

5. The publishing activity will trigger a webhook configured above to create and configure a custom connector under M365 Search Data Source.

6. The connection State will turn from the Publishing state to the Ready State within 10-15 mins.

7. Once the above-mentioned connection is successfully transited to Ready State, need to disable this webhook by unchecking the Subscribed Event.

 

  • Step 6 – Reach Webhook Configuration to Index Reach content
  1. Login to the Reach subscription with a user account with an owner role.
  2. Go to the Webhooks section under settings and Click “Add Webhook”.
  3. Provide the Below Value to the webhook.
    • Description: LiveTiles Search Connector – Index Content (Can provide another friendly title)
    • URL - <Please contact product support team>
    • Subscribed Event: Under News - Select “Publish” and “Published Version Update”
  4. Go to the news section of Reach Subscription and publish New or Existing News.
  5. The publishing activity will trigger a webhook configured above to index the reach content into MS search.
  6. The “Item indexed” count will increase (If this is the first item the count will change to 1).

 

  • Step 7 – Search Configuration – Result Type
    1. Login to the M365 Admin center and go to the “Search & intelligence” section under Settings.
    2. Go to “Data Sources” and act on actions shown in the “required action” column.
    3. Create “Result Type” (This can directly crate from Customization -> Result Type)
    4. In Pop up screen provide the Name as “Reach News” (This can also be another name)
    5. Next, Select a content source as “LiveTiles Enterprise Reach Connector”
    6. Next, Set rules for the result type (this can be skipped as this is an optional step)
    7. Next, Setup Design Layout. The JSON below is a suggested design but this can be updated to include any of the properties listed in the available properties section 
 {
"type": "AdaptiveCard",
"version": "1.3",
"body": [
{
"type": "ColumnSet",
"columns": [
{
"type": "Column",
"width": "auto",
"items": [
{
"type": "Image",
"url": "https://res.cdn.office.net/admincenter/admin-content/admin/images/udt/DefaultMRTIcon.png",
"size": "Small",
"horizontalAlignment": "Center",
"altText": "Result logo"
}
],
"height": "stretch"
},
{
"type": "Column",
"width": 5,
"items": [
{
"type": "TextBlock",
"text": "[${LTRTitle}](${LTRUrl})",
"color": "Accent",
"size": "Medium",
"weight": "Bolder",
"maxLines": 3
},
{
"type": "TextBlock",
"text": "**${LTRAuthor}** modified {{DATE(${formatDateTime(LTRModificationDate, 'yyyy-MM-ddTHH:mm:ssZ' )}, SHORT)}}",
"spacing": "Small",
"$when": "${LTRAuthor!='' && LTRModificationDate!=''}"
},
{
"type": "TextBlock",
"text": "Modified on modified {{DATE(${formatDateTime(LTRModificationDate, 'yyyy-MM-ddTHH:mm:ssZ' )}, SHORT)}}",
"spacing": "Small",
"$when": "${LTRAuthor=='' && LTRModificationDate!=''}"
},
{
"type": "TextBlock",
"text": "Modified by __${LTRAuthor}__",
"spacing": "Small",
"$when": "${LTRAuthor!='' && LTRModificationDate==''}"
},
{
"type": "TextBlock",
"text": "${if(LTRBody !='', LTRBody, if(LTRTitle !='', LTRTitle, if(LTRHeadline !='', LTRHeadline, if(LTRIntro !='', LTRIntro, 'No Text Found'))))}",
"wrap": true,
"weight": "Bolder",
"maxLines": 3,
"spacing": "Medium"
},
{
"type": "TextBlock",
"wrap": true,
"text": "**Channels** ${join(LTRChannels, ', ')}",
"maxLines": 3,
"isSubtle": true
},
{
"type": "TextBlock",
"wrap": true,
"text": "**Keywords** ${join(LTRKeywords, ', ')}",
"maxLines": 3,
"isSubtle": true,
"$when": "${LTRKeywords!= ''}"
}
],
"horizontalAlignment": "Center",
"spacing": "Medium"
},
{
"type": "Column",
"width": 2,
"items": [
{
"type": "Image",
"url": "${LTRImageId}",
"altText": "Result logo",
"horizontalAlignment": "Right",
"size": "Large"
}
],
"$when": "${LTRImageId != ''}"
}
]
}
],
"$schema": "http://adaptivecards.io/schemas/adaptive-card.json"
}

Available_Properties.png

 

8. It will look like this –

9. Next, Review the result type settings and click on Add result type.

10. This will lead to this output screen.

11. Next from the Required action section click on “Include connector result” and Click OK

 

  • Step 8 – Search Configuration – Verticals
    1. Login to the M365 Admin center and go to the “Search & intelligence” section under Settings.
    2. Go to “Customization” and click on the menu “Verticals” then Add a new Vertical.
    3. Set the Name of the Verticals as “Reach News” (This can also be another name)
    4. Next, Under Content Source, Select a content Source – Connector -> “LiveTiles Enterprise Reach Connector”
    5. Next, Add filters (optional step)
      Filters can be added for 4 properties, Channels, Keywords, Author and Publishing Date
      Filter_Properties.png

      To configure the filters, Select the Add a filter button -> select a filter -> click next
      Add_Filter.png

      In the set up your filter section, First set a name -> choose one of the option's (depending on preference) in select an interface -> Done
      Configure_Filter.png

      Once the Filter is created it will take a few minutes for the change to be available in SharePoint Search, Once it's ready you will see your configured filters at the top of search
      Sharepoint_Filters.png



    6. Next, Review the vertical settings and add the vertical.
    7. In the next screen click on enable the vertical.
    8. The resulting screen will look like this.
    9. Newly created vertical will be listed in the vertical list.

Comments

0 comments

Please sign in to leave a comment.

Articles in this section

Related articles

We're here to help!

Contact Us
Privacy Policy Terms and Conditions LSAA EULA © 2021 LiveTiles Limited