How to deploy to SharePoint 2010

Last update:

Audience: System administrators installing and configuring Sapho Server

1. Download the SharePoint 2010 add-in for Sapho

Download one of the following WSP solutions:

2. Install the SharePoint 2010 add-in

Add the solution either directly to your SharePoint instance or using the command line.

To add the solution directly to your SharePoint instance:

  • Open Sharepoint Central Administration in a browser.
  • Navigate to System Settings → Manage farm solutions.
  • Click on 'saphowebpart.wsp'.
  • Deploy the solution by clicking on Deploy Solution.

To add the solution via command line:

  • Copy the file to a directory on a machine where your SharePoint instance is installed.
  • Open Sharepoint 2010 Management Shell and navigate to the directory.
  • Add the solution to the Sharepoint using this command:
    stsadm -o addsolution -filename .\SaphoWebPart.wsp.

3. Add the Sapho Web Part to the list of available Web parts

  • Open SharePoint and go to Site Actions → Site Settings.
    Screen_Shot_2017-05-25_at_16.11.22_.png
  • Click on Web parts under Galleries section.
    Screen_Shot_2017-05-25_at_16.13.30_.png
  • On the top ribbon, click on Documents under Library Tools.
  • Click on New Document.Screen_Shot_2017-05-25_at_16.22.26_.png
  • Find 'SaphoWebPart.SaphoWebPart.SaphoWebPart' and check the checkbox.Screen_Shot_2017-05-25_at_16.23.10_.png
  • Click on Populate Gallery on the top of the modal. You should see a new Sapho Web Part in the list.
    Screen_Shot_2017-05-25_at_16.25.46_.png

4. Obtain the API Key for the Sapho micro app

  • In Sapho Builder, go to the Publish tab and publish the micro app you want to use within SharePoint.sp20101.png
  • Navigate to Endpoints → SharePoint 2010 and click the plus button.sp20102.png
  • Select your micro app and hit Add to enable its embedding.sp20104.png
  • Copy the value of the displayed API Key.sp20105.png

5. Add the Sapho Web Part on a SharePoint page

  • In SharePoint, edit the page where you’d like to embed your Sapho micro app.
  • Click on Add a Web Part.
  • From Miscellaneous choose SaphoWebPart and click Add.Screen_Shot_2017-05-25_at_16.28.20_.png
  • In the editor you should see the Sapho - Embedded Application web part.Screen_Shot_2017-05-24_at_13.27.44_.png
  • Click on the dropdown and choose Edit Web Part.
    Screen_Shot_2017-05-24_at_13.35.35_.png
  • In the right menu pick Sapho.
    Screen_Shot_2017-05-24_at_13.35.48_.png
  • Enter the URL of your Sapho server and the API key obtained earlier.
    Screen_Shot_2017-05-24_at_13.39.36_.png
  • Click OK. The embedded micro app will load in the iframe.
    Screen_Shot_2017-05-24_at_13.36.40_.png
  • After saving the SharePoint page, you can begin using the micro app right away.

Video showing the whole process