Warning about using Site Collection App Catalogs
Although tyGraph Pages will work in a Site Collection App Catalog (as opposed to the Tenant App Catalog), we do not recommend it. If you do install it to the Site Collection App Catalog, after installation, please note the additional required steps below. Installation into Site Collection App Catalogs is a leading cause of support tickets and we recommend against it.
You can install the tyGraph Pages Engine in this App Catalog without running the extension on all sites in your tenant. This can be done for many reasons including:
Validation of tyGraph performance in a contained area
Your SharePoint environment is a critical business asset. Any slowdown from a 3rd party tool could mean weeks of headache and piles of internal tickets. We believe in supporting IT teams with the capability to "soft launch" tyGraph Pages to a site collection without the stress of a Tenant Wide deployment at first.
|Ease of Compliance|
Sometimes the idea of monitoring the entire tenant with no exceptions makes for lengthy compliance reviews and requires additional measures to ensure global compliance. With a Site Collection deployment you can reduce our tools surface area and get started faster.
|Focused Audience Support|
Sometimes interest in analytics starts in certain parts of your organization at first. Limiting the scope of our engine can allow your business to focus on what matters to you before approaching the broader organization.
Though these options allow for early validation, we always recommend you install the extension in your tenant's App Catalog.
tyGraph Pages Engine Installation Steps
To use the Site Collection App Catalog, follow these steps:
- If you have installed any tyGraph packages in your tenant App Catalog, please remove them first. Failure to do so can result in lost telemetry, web parts not being available, and the Report Bar not working.
- Create the Site Collection using PowerShell as described.
- After the Site Collection App Catalog is created, go to the Site Settings page of your Site Collection.
- Click on the Apps for SharePoint link.
- In the App Catalog, click on Apps for SharePoint.
- Upload the tyGraphPagesEngine.sppkg.
- Check Make this solution available to all sites in the organization and then click Deploy. On Site Collection App Catalogs, this does not make the solution across the organization. Even though the text says "all sites in this organization", this setting only applies to the current site collection. Failure to check this box will result in significant installation difficulties.
- If you did not check the above checkbox, do the following
- Go to Site Contents, Add -> App.
- Click From my organization and then select tyGraph Pages Engine.
For additional guidance on installation, the steps in the installation guide may be referenced.
tyGraph Pages Web Parts Installation Steps
The above steps will also work for the tyGraph Pages Web Parts package. Follow the installation guide for additional details. You must check "Make this solution available to all sites in the organization" checkbox in order for the Report Bar to work. After completing this step, configure authentication for the Report Bar using Tenant Wide Extensions.
Site Collection App Catalogs can be complicated and when mixed with a Tenant App Catalog, they can lead to erroneous results. Due to the large number of reported issues by customers, we do not recommend installation in a Site Collection App Catalog. However, if you do choose to proceed, here are some known issues:
Empty reports in Power BI or tyGraph Pages Web Parts
This can occur because the tyGraph Pages Engine is not loading. Most of the time this is because, the "Make this solution to all sites in the organization" was unchecked. If it's unchecked, you manually must add the tyGraph Pages Engine from Site Contents, Add -> App. If the tyGraph Pages Engine is not capturing data, more than likely you will need to start over. Remove the tyGraph Pages Engine package from the Site Collection App Catalog and from the tenant App Catalog.
Web Parts not available
If you can't find the Site Analytics Web Part, you likely didn't check the "Make this solution to all sites in the organization" checkbox. If it's unchecked, you manually must add the tyGraph Pages Web Parts from Site Contents, Add -> App.
Report Bar not present / doesn't show when clicking the Report bar button
If the Report Bar does not show when clicking the Report Bar button, you likely didn't check the Make this solution available to all sites in the organization checkbox. The Report Bar will only work if that checkbox is checked because authentication for the Report Bar cannot be configured without Tenant Wide Extensions on Site Collection App Catalogs. This article has more information on this issue.
Report Bar reports authentication has not been configured
Authentication for the Report Bar in Site Collection App Catalog can only be configured if you check the Make this solution available to all sites in the organization checkbox. You then must configure authentication in Tenant Wide Extensions as documented in the Report Bar Configuration Guide.
Duplicate Report Bars
If you see more than one Report Bar, you might have the web parts package installed in a Tenant App Catalog as well as the Site Collection App Catalog. Follow the steps in Duplicate Report Bars to resolve.
No desire to check Make this solution available to all sites in the organization
Although the wording is misleading, in a Site Collection App Catalog, this only makes the solution available to that Site Collection. You can avoid a number of potential issues by checking that checkbox during installation.
While installing tyGraph Pages into a Site Collection App Catalog might seem like a good idea for testing, you open yourself up to a variety of issues caused by the nuances of how SharePoint Site Collection App Catalogs and Tenant App Catalogs work together. If you do run into issues: remove all tyGraph Pages packages from both the Site Collection App Catalog and your Tenant App Catalog, reinstall and be sure you check Make this solution available to all sites in the organization.