Reach News Web Part
Overview
This guide shows how to install and Set-Up the LiveTiles Reach News Web Part,
There are 4 Templates to choose from Compact, List, Cards and Full Width each with different option's to configure the template.
Installation
Prerequisites
- The latest version of LiveTiles Reach News (LiveTiles.Reach.sppkg) app package.
Installation Steps
To install LiveTiles Reach News, follow these steps:
Install the app in either your SharePoint tenant app catalog or in a site collection app catalog.
Go to the SharePoint site where the LiveTiles Reach News web part should be installed.
Add the app LiveTiles Reach News to the site.
Create a new page or go to an existing page where you would like to add the LiveTiles Reach News web part.
Click Edit to edit the page.
Click the + and search for the LiveTiles Reach News web part.
Select LiveTiles Reach News and then continue to Set-Up to configure the web part.
Note: You will need a LiveTiles Reach subscription and will have to approve the Api Permissions to use the LiveTiles Reach News Web part.
- Go to this page and login with your account and give consent. You will be redirected to the LiveTiles Reach start page.
- Login and give consent again.
- In case you don't already have a subscription create a new one.
- Go to SharePoint admin center.
- Go to the API management section.
- Under Pending requests you can see the Condense API permission request.
- To approve a pending permission request, select the request in the list of permissions, and on the toolbar, choose Approve or reject. In the Approve or reject access pane, choose Approve.
- This permission is used to display news from LiveTiles Reach with LiveTiles Reach News web part.
Set-up
Once you have installed the app, set-up a Reach subscription and approved the api permission follow these steps to configure the LiveTiles Reach News web part.
- Once the web part has been added to the page, This view will be displayed prompting you to edit the web part.
- Click the pencil icon to the left to configure the web part.
Configure LiveTiles Reach News Web Part
Follow these steps to configure the web part
Enter your Reach subscription Id.
Select a template.
Templates
Compact
The compact template view displays the news items in a compact list with chevrons above and below for pagination.
List
The List template view displays the news items in a list with chevrons above and below for pagination.
Compact and List Template Option
The Compact and List template option allows you to set the Number of items to display per page.
Cards
The Cards template view displays the news items as a grid of cards with pagination option's below.
Cards Template Options
The Cards template options allows you to set up the cards in a grid by supplying values for the number of columns and the number of rows to be displayed per page.
Full Width
The Full Width template view displays the news items in a full width slider.
Full Width Template Options
The Full Width template options includes:
- Enable/Disable the sliders autoplay functionality.
- When enabled you can then set the Autoplay Interval(in milliseconds).
- You can also set the number of slides to display.
- Sets the height of the slider.
Manage Channels
The Manage Channels dropdown enables you to select multiple channels to filter the displayed news items.
Manage Keywords
The Manage Keywords dropdown enables you to select multiple keywords to filter the displayed news items.
Open News in Detail View Toggle
The Toggle button gives the option to load the news item in a detail view dialog set to true by default but when toggled the news items will open in the reach web app.
Enable Toolbar Toggle
The Toggle button gives the option to Enable the Toolbar for the selected template.
Toolbar
The Toolbar once enabled gives the ability for the user to filter news items by using the channels dropdown and will filter the news based on the channel selection, The channels available in the dropdown are determined by the channel selection made by an admin in web part settings, If no channels or keywords are selected the user can select from all channels and has the option the manage channel subscriptions.
Toolbar
Channels Dropdown
Manage Channel Subscriptions
On the right side of the toolbar there are options for searching the news content, Mark all news items as read and the pencil icon allows the opening of the news editor dashboard, Once opened when clicking a news item it opens the reach web app to allow the user to edit the news item.
Filter Panel In Toolbar
Filter Panel Toggle
In the web part settings there is a toggle to enable the filter panel in the toolbar.
Once enabled, You can click the filter icon to open the filtering option's in the toolbar.
In the toolbar you will now see the option's available for filtering.
Channels Filter
In the channels filter panel you can filter the displayed news items by channel name and you have the AND & OR Mode option.
Keywords Filter
In the keywords filter panel you can filter the displayed news items by keyword and you have the AND & OR Mode option.
Author Filter
In the author filter panel you can filter the displayed news items by author.
Publishing Date Filter
In the publishing date filter panel you can filter the displayed news items by Publishing date.
AND & OR Mode
Some Filter components contain a toggle which allows the user to choose whether multiple selections in the filter are applied in AND mode or in OR mode.
Detail View Toolbar
To use the toolbar in the detail view you first need to ensure it is enabled in the web part settings by using the toggle, Once enabled the toolbar is available in detail view. The toolbar consists of Next/Previous buttons to page through the news items, It also has a language selector that allows you to translate news items in your preferred language.
News Editing
Inline Editing Toggle
To enable inline editing, use the toggle in the web part settings. Once enabled, clicking the pencil icon in the toolbar/detail view toolbar will open the news item in Sharepoint for editing. When the toggle is off, the news item will open in the reach web app for editing.
News Item editing
When editing is enabled in SharePoint you can edit the news item and republish it.
News Editor Dashboard
The News Editor dashboard displays the news articles available in your subscription, When clicking a news item and with inline editing enabled, the news item will open in SharePoint for editing.
Clicking the New Article button will open the new article dialog, enabling you to create news items in SharePoint
Full Width Section
You can now add the Reach News web part to the full width section in SharePoint.
Full Width Section
Filtering
Unread News Filter on Toolbar
If toolbar is enabled, option to have a Read/Unread news filter is available in Webpart properties under Show Read/Unread News Filter Toggle? option.
If enabled, user will have the option to switch between Read/Unread News using this filter on toolbar.
Show only unread news
To only bring unread news in the Reach News Webpart, use the Show only unread news? toggle inside the News options section of webpart settings.
By default if this feature is disabled, the Reach News Webpart will bring all news. If the button is toggled to the right, then only unread news will be brought by the Reach News Webpart.
Bookmarked News Filter on Toolbar
If toolbar is enabled, option to have a Bookmarked news filter is available in Webpart properties under Show Bookmarked News Filter Toggle? option.
If enabled, user will have the option to switch between bookmarked and not bookmarked News using this filter on toolbar.
Show only bookmarked news
To only bring bookmarked news in the Reach News Webpart, use the Show only bookmarked news? toggle inside the News options section of webpart settings.
By default if this feature is disabled, the Reach News Webpart will bring all news. If the button is toggled to the right, then only bookmarked news will be brought by the Reach News Webpart.
Filter News By Channel Name in URL
To filter your view by channel you can append a channel name to your URL. Once this is set, the news on the page will be filtered by the name provided in the URL parameter.
eg . https://<-Your reach news page URL->?channel=General
Filter News By Keyword in URL
To filter your view by keyword you can append a keyword to your URL. Once this is set, the news on the page will be filtered with the name provided in the URL parameter.
eg . https://<-Your reach news page URL->?keyword=HR
Detail View Web Part
Installation
The Detail View Web Part comes packaged with the Reach News app package and requires Reach News web part to be installed on a SharePoint page. Once installed create a new SharePoint page to add the Detail View Web Part. To add the Detail View Web Part switch the page to edit mode and click the plus icon to add a web part. Select the Reach News Detail View.
Once the web part is added to the page you will see a placeholder for the Detail view and you must enter your subscription Id in the settings pane.
Usage
To use the Detail View you must go to the page where the Reach News web part is installed and open the property pane to edit the settings for Detail View.
In the Detail View settings you have 2 toggles for opening your news items. If you toggle off the "Open News Articles In Dialog?" you will see a new toggle appear for "Open News Articles In Custom Page?" with a input box for "Custom News Page URL:". Inside the input box you can add the URL for the page that has the Detail View Web Part installed.
Note: You can use a full URL in the input box or a relative URL
- Relative Url /sites/SitePages/<-Your detail view page->.
- Full Url https://<-Your-Tenant-Url->/sites/<-Your detail view page->
Once added and the page is published, When you now click a news item it will open it in the Detail View page.
If both toggles are set to off, When clicking a news item it will open it in the Reach web app.
Detail View News Item Editing
In the detail view toolbar you can click the pencil icon to edit your news article in SharePoint.
Detail View Single Page Web Part
To add the Detail View Web Part as single page web part you create a new SharePoint page.
In the apps tab select the Detail View Web Part and click create.
Once the page is created you will need to add a title and your Reach Subscription Id and click save.
You can then add the URL of this page to the Reach News web part Detail View Custom Url input box to display the news item on this page when it's clicked.