Webpart and viva add on package

Xoralia webparts and Viva addons

Xoralia webparts

Webparts are the core components that build value in any SharePoint intranet site. To keep your organisation using the intranet as a high-value resource, Xoralia provides 3 bolt-on web parts. These include:

'All documents' web part

This webpart appeals to anyone within an organisation looking to browse through the documents, forms and policy’s as shown in Xoralia.

The web part combines all document library views for a streamlined approach to find the information needed.

As this web part is a holistic view of all documents in Xoralia, we display tags and status labels such as ‘Must read’ for easy browsing.


'Must read documents' web part

This web part provides the user with a targeted view of documents that have been assigned and attested to. It saves time by only displaying relevant documents.


'Due for review' webpart

This web part helps document owners to see which documents they need to review and maintain before their validity expires.

Using Xoralia’s custom expiry date field, this web part will display all documents that may be out of date (expired) and documents due for Owner review within the next 30 days.


Viva addon extensions

Viva extensions are a powerful tool that can help utilise productivity. Xoralia's adaptive card extensions deliver notifications directly to your Viva account, so that you never have to miss a thing!

‘Must read’ notification

This adaptive card is targeted towards each user to filter out documents they need to read each day.


‘Due for review’ notification

This adaptive card is targeted towards document owners with documents due for review and which may require re-validating/updating.


‘Expired documents’ notification

This adaptive card is targeted towards document owners with documents overdue for review and are therefore require validating


Instructions for Installation

These deployment instructions describe how to install the Xoralia SPFX webparts and adaptive card extensions (ACE’s) onto a SharePoint Tenancy. These bolt-ons will be provided via ZIP file from your Account Manager, or to enquire email [email protected]

The installation assumes that:

  • The deployment is undertaken by a competent I.T. professional
  • The person undertaken the deployment has administrator permissions (including access to the SharePoint App Catalogue).

At the end of the deployment, the SharePoint tenancy will have access to the following SPFX webparts/ACE’s:

  • Must Read Documents Webpart
  • Documents Due for Review Webpart
  • Documents Webpart





Deploying the 'Xoralia-SPFX.sppkg' package to your App Catalogue

  1. Save a copy of the “Xoralia SPFX.zip” file to your desktop.


  2. Extract the file to your desktop, then open the newly extracted folder.
  3. 'Hold shift and right click' on the file Select “Copy as Path”.
  4. Paste this path into a Notepad file or similar for later.




Visit the App Catalogue on your SharePoint tenancy

For example https://[yourtenant].sharepoint.com/sites/apps/AppCatalog/Forms/AllItems.aspx

If you do not know how to find this URL, please refer to Appendix A:



Add the “Xoralia-SPFX.sppkg” file to your App Catalogue

  1. Click 'Upload'
  2. Click 'Choose Files'
  3. Paste in the link to the 'Xoralia-SPFX.sppkg' file into the Windows Explorer window
  4. Click 'Open'
  5. Click 'OK'


Deploy the “Xoralia-SPFX.sppkg” file to your App Catalogue.

Generally, there are 2 strategies available to SharePoint administrators to manage the addition of SPFX apps to SharePoint sites. For more detailed information visit https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-scoped-deployment.

'Tenant Scoped' Deployment

Tick the “Make this solution available to all sites in the organization” checkbox.

This will have the following implications:

  • The webparts and ACE’s contained in the “Xoralia-SPFX.sppkg” package will be available to every site in your SharePoint tenancy.
  • There will be no need to manually add the App Package to the sites which require the use of the webparts and ACE’s.
  • Whenever the App is upgraded to a new version in the future, there will be no need to manually upgrade.

'Site Scoped' Deployment

Untick the “Make this solution available to all sites in the organization” checkbox.

This will have the following implications:

  • The webparts and ACE’s will have to be manually added to each Site in your SharePoint Tenancy for them to appear when editing site pages.
  • Every time a new version of the “Xoralia-SPFX.sppkg” package is available, each site will have to be manually upgraded.


Deploy the 'Xoralia-SPFX.sppkg' file to a Site App Catalogue.

If option (a) i.e. 'Tenant Scoped' deployment is selected, then skip to the next step of this deployment document.

  • Visit the site you would like to add the Webpart's and ACE's to e.g. https://[yourtenant].sharepoint.com/sites/XoraliaDeploymentGuide
  • Click the Settings “Cog” in the top right hand corner
  • Click 'Add an App'


  • Click “Add” for the 'Xoralia SPFX' App containing the Webparts and ACE's


Add the Webparts to a Page

  • Visit a page to add the webparts to e.g. https://[yourtenant].sharepoint.com/sites/XoraliaDeploymentGuide/SitePages/Xoralia-Installation.aspx
  • Click the 'Edit' pencil button


  • Click the “+” divider to add an App – you should be able to select from the following 3 options.


Must Read Documents Webpart

  • This webpart does not require any additional configuration to work 'out of the box'.
  • The webpart also comes with some other additional options which can be customized to your liking:


Documents Due for Review Webpart

  • This webpart does not require any additional configuration to work 'out of the box'.
  • The webpart also comes with some other additional options which can be customized to your liking:


Add the ACE’s to the Viva Connections Dashboard

This step assumes you have setup a Viva Connections dashboard where you can add ACE’s (Adaptive Card Extensions).

To set this up you will need to designate a “Home” site using the instructions contained here https://sharepoint.handsontek.net/2021/03/17/create-sharepoint-home-site/

Then follow the instructions here https://sharepoint.handsontek.net/2021/10/01/create-viva-connections-dashboard/

You will then see the following ACE’s ready to add to the dashboard as shown below:



Appendix A

Follow these steps to find the location of your App Catalogue to install the “Xoralia-SPFX.sppkg” file containing the Xoralia SPFX Webparts and ACE’s.

  • Visit the SharePoint Admin center located at https://[yourtenant]-admin.sharepoint.com (replacing “[yourtenant]” with your own tenancy name).
  • Click “More features”


  • Click “Open” under the Apps section


  • Click “App Catalogue”


  • Click “Apps for SharePoint” in the sidebar

  • Xoralia webparts

    Webparts are the core components that build value in any SharePoint intranet site. To keep your organisation using the intranet as a high-value resource, Xoralia provides 3 bolt-on web parts. These include:

    'All documents' web part

    This webpart appeals to anyone within an organisation looking to browse through the documents, forms and policy’s as shown in Xoralia.

    The web part combines all document library views for a streamlined approach to find the information needed.

    As this web part is a holistic view of all documents in Xoralia, we display tags and status labels such as ‘Must read’ for easy browsing.


    'Must read documents' web part

    This web part provides the user with a targeted view of documents that have been assigned and attested to. It saves time by only displaying relevant documents.


    'Due for review' webpart

    This web part helps document owners to see which documents they need to review and maintain before their validity expires.

    Using Xoralia’s custom expiry date field, this web part will display all documents that may be out of date (expired) and documents due for Owner review within the next 30 days.


    Viva addon extensions

    Viva extensions are a powerful tool that can help utilise productivity. Xoralia's adaptive card extensions deliver notifications directly to your Viva account, so that you never have to miss a thing!

    ‘Must read’ notification

    This adaptive card is targeted towards each user to filter out documents they need to read each day.


    ‘Due for review’ notification

    This adaptive card is targeted towards document owners with documents due for review and which may require re-validating/updating.


    ‘Expired documents’ notification

    This adaptive card is targeted towards document owners with documents overdue for review and are therefore require validating


    Instructions for Installation

    These deployment instructions describe how to install the Xoralia SPFX webparts and adaptive card extensions (ACE’s) onto a SharePoint Tenancy. These bolt-ons will be provided via ZIP file from your Account Manager, or to enquire email [email protected]

    The installation assumes that:

    • The deployment is undertaken by a competent I.T. professional
    • The person undertaken the deployment has administrator permissions (including access to the SharePoint App Catalogue).

    At the end of the deployment, the SharePoint tenancy will have access to the following SPFX webparts/ACE’s:

    • Must Read Documents Webpart
    • Documents Due for Review Webpart
    • Documents Webpart





    Deploying the 'Xoralia-SPFX.sppkg' package to your App Catalogue

    1. Save a copy of the “Xoralia SPFX.zip” file to your desktop.


    2. Extract the file to your desktop, then open the newly extracted folder.
    3. 'Hold shift and right click' on the file Select “Copy as Path”.
    4. Paste this path into a Notepad file or similar for later.




    Visit the App Catalogue on your SharePoint tenancy

    For example https://[yourtenant].sharepoint.com/sites/apps/AppCatalog/Forms/AllItems.aspx

    If you do not know how to find this URL, please refer to Appendix A:



    Add the “Xoralia-SPFX.sppkg” file to your App Catalogue

    1. Click 'Upload'
    2. Click 'Choose Files'
    3. Paste in the link to the 'Xoralia-SPFX.sppkg' file into the Windows Explorer window
    4. Click 'Open'
    5. Click 'OK'


    Deploy the “Xoralia-SPFX.sppkg” file to your App Catalogue.

    Generally, there are 2 strategies available to SharePoint administrators to manage the addition of SPFX apps to SharePoint sites. For more detailed information visit https://docs.microsoft.com/en-us/sharepoint/dev/spfx/tenant-scoped-deployment.

    'Tenant Scoped' Deployment

    Tick the “Make this solution available to all sites in the organization” checkbox.

    This will have the following implications:

    • The webparts and ACE’s contained in the “Xoralia-SPFX.sppkg” package will be available to every site in your SharePoint tenancy.
    • There will be no need to manually add the App Package to the sites which require the use of the webparts and ACE’s.
    • Whenever the App is upgraded to a new version in the future, there will be no need to manually upgrade.

    'Site Scoped' Deployment

    Untick the “Make this solution available to all sites in the organization” checkbox.

    This will have the following implications:

    • The webparts and ACE’s will have to be manually added to each Site in your SharePoint Tenancy for them to appear when editing site pages.
    • Every time a new version of the “Xoralia-SPFX.sppkg” package is available, each site will have to be manually upgraded.


    Deploy the 'Xoralia-SPFX.sppkg' file to a Site App Catalogue.

    If option (a) i.e. 'Tenant Scoped' deployment is selected, then skip to the next step of this deployment document.

    • Visit the site you would like to add the Webpart's and ACE's to e.g. https://[yourtenant].sharepoint.com/sites/XoraliaDeploymentGuide
    • Click the Settings “Cog” in the top right hand corner
    • Click 'Add an App'


    • Click “Add” for the 'Xoralia SPFX' App containing the Webparts and ACE's


    Add the Webparts to a Page

    • Visit a page to add the webparts to e.g. https://[yourtenant].sharepoint.com/sites/XoraliaDeploymentGuide/SitePages/Xoralia-Installation.aspx
    • Click the 'Edit' pencil button


    • Click the “+” divider to add an App – you should be able to select from the following 3 options.


    Must Read Documents Webpart

    • This webpart does not require any additional configuration to work 'out of the box'.
    • The webpart also comes with some other additional options which can be customized to your liking:


    Documents Due for Review Webpart

    • This webpart does not require any additional configuration to work 'out of the box'.
    • The webpart also comes with some other additional options which can be customized to your liking:


    Add the ACE’s to the Viva Connections Dashboard

    This step assumes you have setup a Viva Connections dashboard where you can add ACE’s (Adaptive Card Extensions).

    To set this up you will need to designate a “Home” site using the instructions contained here https://sharepoint.handsontek.net/2021/03/17/create-sharepoint-home-site/

    Then follow the instructions here https://sharepoint.handsontek.net/2021/10/01/create-viva-connections-dashboard/

    You will then see the following ACE’s ready to add to the dashboard as shown below:



    Appendix A

    Follow these steps to find the location of your App Catalogue to install the “Xoralia-SPFX.sppkg” file containing the Xoralia SPFX Webparts and ACE’s.

    • Visit the SharePoint Admin center located at https://[yourtenant]-admin.sharepoint.com (replacing “[yourtenant]” with your own tenancy name).
    • Click “More features”


    • Click “Open” under the Apps section


    • Click “App Catalogue”


    • Click “Apps for SharePoint” in the sidebar


    • You should now arrive at the App Catalogue for your SharePoint Tenancy


    https://xoralia.com/wp-content/uploads/2022/03/Xoralia-Web-Part-26-1.jpg">

  • You should now arrive at the App Catalogue for your SharePoint Tenancy


  • We use cookies to give you the best experience on our site. By continuing to use our website, you are agreeing to our use of cookies. To find more about the cookies, please see our Privacy Policy

    Contact Support

    If you have a question about Xoralia software, please fill out the form below and a member of our support team will be in contact with you shortly.