SharePoint Web Part

Revision as of 11:37, 18 June 2019 by Csalter (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The XLCubed SharePoint Webpart, available from XLCubed version 6.5, allows XLCubed Reports to be embedded into SharePoint pages and allows connections between filter web-parts and other XLCubed Report web-parts.

Please note the Report Viewer Webpart will not work in SharePoint 2010 running in IE 8 Compatibility mode against V9 XLCubedWeb.

Please contact support@xlcubed.com if you'd like to gain access to this feature.

Installing

Copy the CAB file onto the SharePoint server, for example c:\inetpub\wwwroot\xlcubedweb\extensions.

SharePoint 2010

  • Enable full trust in IIS - run Internet Information Services Manager.
    • Click on the server and select .Net Trust Levels

SharepointTrust1.png

  • Change the trust level to Full (Internal)

SharepointTrust2.png

  • Enable full trust on the SharePoint website
    • Click on the SharePoint website and select .Net Trust Levels

SharepointTrust3.png

  • Change the trust level to Full (Internal)

SharepointTrust2.png


  • Run the SharePoint 2010 ManagementShell (Start -> Microsoft SharePoint 2010 Products -> SharePoint 2010 Management Shell:

Sharepoint1.png

  • Register the .CAB with Sharepoint:
    • Add-SPSolution -LiteralPath c:\inetpub\wwwroot\xlcubedweb\extensions\XLCubed.Sharepoint.cab

Sharepoint2.png

  • Deploy the webpart to the SharePoint websites
    • Install-SPSolution -Identity xlcubed.sharepoint.cab -allwebapplications -force

Sharepoint3.png

The webpart will now be available in the list of available webparts, under the "Miscellaneous" items

Sharepoint4.png

SharePoint 2013/2016/2019

You will need Version 7.5 to run in Sharepoint 2013+

  • Run the SharePoint 2013/2016/2019 ManagementShell (Start -> Microsoft SharePoint 201x Products -> SharePoint 201x Management Shell:

Sharepoint2013 1.png

  • Register the .CAB with Sharepoint:
    • Add-SPSolution -LiteralPath c:\inetpub\wwwroot\xlcubedweb\extensions\XLCubed.Sharepoint.cab

Sharepoint2013 2.png

  • Deploy the webpart to the SharePoint websites
    • Install-SPSolution -Identity xlcubed.sharepoint.cab -allwebapplications -force -FullTrustBinDeployment

Sharepoint2013 3.png

The webpart will now be available in the list of available webparts, under the "Miscellaneous" items

Sharepoint2013 4.png

Uninstalling

SharePoint 2010

  • Run the SharePoint 2010 ManagementShell (Start -> Microsoft SharePoint 2010 Products -> SharePoint 2010 Management Shell:

Sharepoint1.png

  • Remove the webpart from the SharePoint websites
    • UnInstall-SPSolution -Identity xlcubed.sharepoint.cab -allwebapplications

Sharepoint5.png

  • Remove the .CAB from SharePoint:
    • Remove-SPSolution xlcubed.sharepoint.cab

Sharepoint6.png


SharePoint 2013/2016/2019

  • Run the SharePoint 2013/2016/2019 ManagementShell (As Administrator) Start -> Microsoft SharePoint 201x Products -> SharePoint 201x Management Shell:

Sharepoint2013 1.png

  • Remove the webpart from the SharePoint websites
    • UnInstall-SPSolution -Identity xlcubed.sharepoint.cab -allwebapplications

Sharepoint2013 5.png

  • Remove the .CAB from SharePoint:
    • Remove-SPSolution xlcubed.sharepoint.cab

Sharepoint2013 6.png

Using WebPart

Configuring

Insert the XLCubed Webpart:

Sharepoint4.png

Edit the Webpart:

Sharepoint7.png

Setup the XLCubed web server details and click OK:

Sharepoint8.png

Now the Report browser button will be enabled:

Sharepoint9.png

Click on the button and browse to the report to display on this page:

Sharepoint10.png


Give the report a defined height (if not already inserted into a control with a height defined)

Sharepoint11.png

Click OK/Apply to see the report embedded in the page

Sharepoint12.png

Linking XLCubedReport WebParts

XLCubed Webparts can be linked via Web Parameters - once a link is in place then when the web parameters with the same name are passed between the linked WebParts.

Insert 2 or more webparts in the same page, the select the Connections menu when editing the webpart:

Sharepoint13.png

Limitations

Will not work if XLCubedWeb is setup to use Kerberos Delegation

Linking to filter WebParts

XLCubed Webparts can be linked to Filter webparts so that the parameters can be passed into the XLCubed Report - first you would need to defined the Web Parameters to be driven by the Filter control.

Then select the connections menu and Inbound Parameters - select the filter control to receive the parameter from

Sharepoint14.png

Select which Web Parameters is to receive the data from the filter:

Sharepoint15.png

Limitations

Will not work if XLCubedWeb is setup to use Kerberos Delegation

Customising Progress Indicator

You can change the look and position of the progress indicator by adding the following to the SharePoint web.config (\inetpub\wwwroot\wss\VirtualDirectories\80) AppSettings section:

To change the image:

   <add key="ProgressBarUrl" value="http://server/images/image.gif"/> 

To change the location (valid values are "xl3-progress", the standard position and "xl3-progress-center" which centers the image)

   <add key="ProgressBarCss" value="xl3-progress-center"/>

Using on different server to Sharepoint (cross domain)

For more information about setting up the Web Part and XLCubed to work cross domain refer to: SharePoint Web Part Cross Domain

Page Viewer Webpart

There is now an alternate XLCubed webpart control, this allows the display of a single report so cannot be linked with other controls, but is good for the scenario where you have cross-domain issues with the existing web part. It allows the display of a single fixed report or can also be used to display different report passed via the URl.

The following gives an example of how to create a page using this web part.

Insert a "XLCubed Page Viewer" web part and edit it:

Set the height of the web part and change the "Chrome Type" to none:

SharepointPageViewerAppearance.png

Fixed Report

Under "Custom Properties" set "Report URL" to the direct report URL, there is more information about how to get that URL here:

Web Reports in Other portals

Dynamic Report

If you want the report to be passed via the URL then you can enter the "Report URL" using the following form (updating it to reflect the actual xlcubedweb location):

 http://servername/xlcubedweb/WebForm/ShowReport.aspx

After setting the properties you should see an XLCubed error message, this is fine it's showing that the page is able to find the server but hasn't been supplied with a report to display yet.

Now you can add a link to the Sharepoint page including an additional "rep" parameter in the URL, for more information about how to generate the information to pass please see Web Reports in Other portals


Web Parameters

You can pass any web parameters to the Sharepoint page you have created and they will be passed onto the displayed report.

Toolbar

To enable the toolbar add:

 &toolbar=true 

to the "Report URL"

Troubleshooting

If the SharePoint website is in the browser's "Trusted Sites" list then you may need to enable "Access data sources across domains". This can be found in the browser's Tool -> Internet Options form, under "Security" click "Custom" for "Trusted Sites".

See Also