Skip to main content

Overview

Sproket consists of a client layer, which is implemented by two Microsoft SharePoint Framework Apps. The client layer reads data from various external systems, such as Microsoft Graph or SharePoint Search and displays this data in web parts within a SharePoint site.

Sproket provides a number of web parts and customizers for SharePoint Modern. This article details the technical architecture of Sproket and the services in which is depends on.

App Catalog

Platform

Sproket is built with Microsoft SharePoint Framework (SPFx), which is the recommended way and technology issued by Microsoft for implementing custom solutions for the Microsoft 365 platform.

Installation

The solution consists of two SPFx app packages Sproket 365 and Sproket Library, which have to be deployed into the customer's SharePoint Online App Catalog. Once deployed to the App Catalog, the app packages can be installed as Apps on the desired SharePoint sites. Refer to our installation page for more information.

Required Permissions

When deploying the Sproket, a set of permission requests are created that need to approved in the "API Management" section in the SharePoint Admin Center.

Be aware the you might not need all permissions, if you don't need the functionality that requires them. Also note, that everything is executed under the context of the logged in user. That means users will only be able to load data, they are have permission to.

The below list are the Microsoft Graph permissions that are needed for all of Sproket's web parts to function correctly. For more information on Microsoft Graph and what these permissions request mean please refer to Microsoft Graph permissions reference article.

Microsoft Graph API

  • Delegated: User.Read.All
  • Delegated: People.Read.All
  • Delegated: Directory.Read.All
  • Delegated: Group.Read.All
  • Delegated: Files.Read.All
  • Delegated: Presense.Read.All
  • Delegated: Sites.ReadWrite.All
  • Delegated: Contacts.Read.All

Data storage

All business information is stored within your Microsoft 365 tenant e.g. documents, configuration, pages etc.

When Sproket functionality is loaded within SharePoint it will call our Sproket API service to ensure your tenant has a valid Sproket subscription and enough seats. For us to determine this information we store your tenant ID, user IDs (no personal) & tenant admin information. See managing your subscription for more information.

Optional Modules

Knowledge Hub

Sproket includes our "Knowledge Hub" feature which leverages SharePoint Modern and adds additional capabilities for providing a better user experience for your workforce to access policies, procedures, and knowledge base articles. All page content and navigation is stored within your Microsoft 365.

Knowledge Hub provides significant enhancements (included within your subscription) that you may wish to utilise. These additional features require additional permissions to be granted

Knowledge Hub can be broken up into three key features; Content, Reading Lists, & Converters.

Content

The Content features of Knowledge Hub is essentially the enhanced user experience within SharePoint – providing a hierarchy navigation, search & other commands like print, table of contents, read duration etc. All of this content and functionality uses SPFx and fits within the standard Sproket scope as per detailed in the 'platform' section above. No additional security is required for this to function. There is no dependency on Sproket services and no data is stored outside of your Microsoft 365 tenant.

Reading Lists

Sproket's Reding List feature enables Admin's and management staff to ensure the workforce has acknowledged & read the required pages of the Knowledge Hub's. For those pages that have been marked as required to be read – users will need to navigate to each of the pages and click the 'mark as read' button. Admins & managers can produce reports on who has read what pages on what dates.

Permissions

For a tenant to utilise the Reading List feature of Knowledge Hub a tenant admin must approve the Sproket Knowledge Hub Application. The approval grants Sproket's API to connect to your tenants Microsoft Graph with the following permissions:

  • Application: User.Read.All
  • Application: Sites.Read.All
  • Application: GroupMember.Read.All

For more information on Microsoft Graph and what these permissions request mean please refer to Microsoft Graph permissions reference article.

Converters

A popular feature for Sproket subscribers to use our Sproket Actions so help with content management. More specifically there are two Sproket Actions commonly used; "Convert Word to Modern Page" & "Convert Word to PDF". Subscribers will use a SharePoint document library to store policies & procedures making use of its co-authoring, version control, meta data, and integration of Power Automate for approvals. Once the business has approved the document the Sproket actions can be used to convert the Word document into a SharePoint page for the consumption of the workforce. At the same time the Word document can be converted to PDF and the PDF stored in a defined SharePoint document library and link created between the page and the PDF.

If you wish to use these actions, refer to the Sproket Actions section.

Sproket Actions

Sproket Actions, included within your subscription, provides a set of custom actions which can be used in the Microsoft Power Platform to automate common tasks. For example, create Site Collection Template, Apply Site collection template, Convert Word to Page, Convert word to PDF.

The below is a list of available Sproket Actions

NameDescription
1. Convert Word to PDFConverts Word document stored in SharePoint to PDF and stores in SharePoint Library.
2. Convert Word to Modern PageConverts Word document stored in SharePoint to Modern SharePoint Page.
3. Convert Word to SP Classic Publishing PageConverts Word document stored in SharePoint to Classic SharePoint Publishing Page.
4. Create Site Collection TemplateStores an existing SharePoint site as a template ready for use by 'Create Site Collection from Template' action.
5. Create Site Collection from Template (Credentials)
6. Create Team Site from TemplateCreate a SharePoint Team Site from an existing template. Communication sites are not supported.
7. Clone Microsoft Teams TeamClone an existing Microsoft Teams Team. This will create the team, site and channels.
8. Enable Site Collection Feature
9. Archive Team and Site (Credentials)
10. Unarchive Team and Site (Credentials)
11. Batch Copy Folder Permission
12. Batch setting list item permission
13. Set SharePoint Site, List or Item file PermissionSet SharePoint a Site, List or Item file Permission
14. Bulk set item permissions with list filterLoop through all items in a list or library and set permissions based on filter
15. Create Microsoft Teams Private ChannelCreate a private channel within an existing MS Team
16. Add Member to Private Teams ChannelAdd member to channel

Permissions

Sproket Actions requests a high level of application permissions as Sproket will perform operations on your Microsoft 365 tenant from Sprokets Services.

For a tenant to utilise Sproket Action's a tenant admin must approve the Sproket Actions Application. The approval grants Sproket's API to connect to your tenants Microsoft Graph & SharePoint with the following permissions:

API / Permissions nameType
Microsoft Graph (20)
ChannelMember.ReadWrite.AllApplication
Directory.ReadWrite.AllApplication
Group.ReadWrite.AllApplication
GroupMember.Read.AllApplication
Team.CreateApplication
Team.ReadBasic.AllApplication
TeamMember.ReadWrite.AllApplication
TeamSettings.ReadWrite.AllApplication
SharePoint (5)
Sites.FullControl.AllApplication
TermStore.ReadWrite.AllApplication
User.Read.AllApplication

For more information on Microsoft Graph and what these permissions request mean please refer to Microsoft Graph permissions reference article.