Loading...
 

Webpart Deployment

Version 3.11

Introduction

1   The WebPart

If your company already uses SharePoint for team-based project and document management, MindLink SharePoint and WebPart allow you to introduce communication streams within the community sites. The MindLink Desktop client can be embedded into a SharePoint page, making it possible to access conversations whilst working around them on a website. The WebPart can be configured so that its different functions and components can work as you require them to.

For further information, you may wish to consult the MindLink WebPart Technical Overview. MindLink WebPart requires the setup of FCF and MindLink Desktop, for which you should consult the Operations and Configurations Guide, respective Installations Guides, and Technical Overviews.

 

2   Installation Checklist

 

  Initial setup and prerequisites

  • The following prerequisites are assumed:

 

  • Microsoft SharePoint Server 2010/2013 (Foundation or Server)
  • A server for the FCF services to be installed on
  • Administration privileges on the machines
  • Site collection administration privileges on the SharePoint server
  • The SharePoint farm service account must have the following database roles ‘dbcreator’, ‘securityadmin’ and ‘db_owner’. The user account running the installation of the WebPart must have ‘db_owner’ access to the SharePoint configuration database. For further information see http://technet.microsoft.com/en-us/library/ee662513.aspx

  • Installation files
  • A proxy server (in front of the SharePoint server and FCF server)
  • If using Windows Firewall on the frontend servers, port exceptions need to be made
  • Root certificate of the connector server must be a trusted root authority on the SharePoint frontend server (SSO)
  • Windows PowerShell must be installed on the SharePoint server

  Installing the MindLink Desktop Server

  • Install the MindLink Desktop server according to the MindLink Desktop installation guide (according to the customized installer) 

  Installing the WebPart (section 3.3)

  • Select the directory where the WSP file will be copied to
  • Copy the installer to the SharePoint server
  • Double-click the supplied MSI file to run the installer
  • Ensure that you are logged onto the SharePoint server and run the installation as a SharePoint Site Collection administrator account
  • If the installer requests administrator privileges, grant these and the installation will begin
  • Click the ‘Finish’ button when the installation is complete
  • To verify the installation, check that the ‘Solution Management’ page in the SharePoint Central Administration Site includes the ‘mindlinksharepoint.wsp solution

  Configuration

 

  • Follow the FCF Management tool instructions to configure the WebPart

 

  • Configure a proxy so that the SharePoint Web Front End server and MindLink Desktop server appear to be serving files from the same domain. (section 3.4)

 

 

 

 

  • All requests should get directed to the SharePoint Web Front End server, except when there is a specific prefix for requests

 

 

 

 

  • Requests with specific prefixes should be routed to the MindLink base URL

 

  • Requests beginning with a separate prefix should be routed to the FCF private API

 

  • To use IIS as the proxy install ARR on every Web fronted server

 

  • If Windows Firewall is enabled on the frontend server(s), inbound and outbound port exceptions need to be made to allow the WebPart to communicate with the MindLink Desktop server. The value of the Information Service Port in the General Settings, the WebClient Port in MindLink Desktop Feature Settings, and the SharePoint API Port under MindLink Desktop for SharePoint Feature Settings need to be excepted (section 3.5)

 

  • Set up a certificate, so that the Host name of the SharePoint site is an authorized host (section 3.6)

 

  • Single Sign-On can be enabled – use the Operations and Configurations Guide.

 

  • Adding the WebPart to a Page (section 4.1-4.4)

 

 

  • Navigate to the page, click the edit button in the top-left of the screen

 

  • Move the caret to the position where you wish to place the WebPart

 

  • Click on the ‘Insert’ tab

 

  • Click on the ‘WebPart’ button

 

 

  • Select the ‘Custom’ category from the far-left column

 

  • Select ‘MindLink Web Part’ in the second column

 

  • Click the ‘Add’ button

 

  • Click on the small triangle in the top-right of the unconfigured WebPart

 

  • Select ‘Edit WebPart’ from the drop-down menu

 

  • Use the various settings to configure the WebPart

 

  Multiple-Connector Configuration (section 4.4.3)

 

 

  • A load balancer must be in place over the private API and ‘GcwaSharePointApi’

 

  • The IIS URL rewrite rule for the MindLink base path needs to point to the load balancer

 

  • For SSO, the host name and port of the MindLink service should be that of the load balancer 

 

  • To ensure AJAX requests are made back to the same instance of the Connector service that the WebPart code behind initiated the SSO session on, a rewrite rule that forwards requests to explicit connectors is required. Configure this by specifying the ‘Reverse Proxy URL Rule’, which is a relative path that contains a ‘{0}’ placeholder. The code behind will insert the FQDN of the Connector service host on which the session is homed into the placeholder, to form the actual address of the service that AJAX requests should be made to.

 

 

3   Installation

There are several alternative configurations that the system can be deployed in. This guide will describe how to install and configure a system that includes a machine running MindLink WebPart and a single SharePoint server machine, both behind a proxy server.

Suggestions will be given where possible for alternative setups. For example, it is possible to have a SharePoint farm with multiple servers, or to have multiple MindLink WebPart Connector servers running together behind a load balancer.

 

3.1   Prerequisites

The following prerequisites are assumed:

  •          Microsoft SharePoint Server 2010/2013 (Foundation or Server).
  •          A server for the FCF services to be installed on.
  •          Administration privileges on the machines.
  •          Site collection administration privileges on the SharePoint server.
  •          The Microsoft SharePoint Server 2010/2013 site collection administrator account credentials which also has ‘db_owner’ access to the SharePoint configuration and admin databases, to run the installation process.
  •          The installation files.
  •          A proxy server (in front of the SharePoint server and FCF server; see section 0).
  •          If you are using Windows Firewall on the frontend servers, port exceptions need to be made (see section 3.5).
  •          For SSO, the root certificate of the connector server is a trusted root authority on the SharePoint frontend server (see section 3.6).
  •          Windows PowerShell must be installed on the SharePoint server.

The installation steps in this guide are specific to SharePoint 2010/2013.

 

Refer to the MindLink Desktop installation guide for instructions on installing the MindLink Desktop server. To enable some features required by the WebPart a customized installer, provided with the MindLink WebPart installation media, will be needed first. Also, please follow the FCF Management tool instructions to configure the WebPart.

 

3.3   Installing the WebPart

3.3.1   Deploying the Solution

 

 

Figure 1: Selecting the destination folder.

The installer must be copied to the SharePoint serverr. To run the installer, double-click the supplied MSI file. This will display the installer welcome screen.

The first step is done automatically by the installer. Ensure that you are logged onto the SharePoint server1 and run the installation as a SharePoint Site Collection administrator account, with a ‘db_owner’ access to the SharePoint configuration and admin databases. The WebPart solution will be deployed to the SharePoint farm.

 

Figure 2: Installation destination.

Click ‘Next’. This will display a screen that allows the destination folder to be selected. This is the directory where the WSP file will be copied to. Once deployed, the WebPart will be stored in the SharePoint database.

 

 

Figure 3: The confirmation screen.

Click ‘Next’. The installation confirmation screen will be displayed.

 

 

Figure 4: The installing screen.

The installer may request administrator privileges, and then the installation will begin. A progress bar will be visible.

 

 https://svn.formicary.net/fcf.docs/trunk/Product/Gcwa/SharePoint%20Web%20Part/Installation%20Guide/Images/2%20-%20Installation/The%20installer%20command%20window.png

Figure 5: The installer command window.

During the installation, a command window will appear, showing the progress of the deployment. The installer waits for the solution to be deployed, so this may take a while to complete.

 

 

Figure 6: Completed installation.

Once complete, there will be a notification of this. Click the ‘Finish’ button to exit the installer.

 

https://svn.formicary.net/fcf.docs/trunk/Product/Gcwa/SharePoint%20Web%20Part/Installation%20Guide/Images/2%20-%20Installation/The%20deployed%20farm%20solution.png

Figure 7: The deployed farm solution.

The installation can be verified from the SharePoint Central Administration site. Check that the ‘Solution Management’ page includes the ‘mindlinksharepoint.wsp’ solution.

 

3.4   Configuring the Proxy

A proxy (or similar gateway/firewall solution) is required so that the SharePoint Web Front End server and MindLink Desktop server appear to be serving files from the same domain. This is required because, from the browser’s point of view, the page is loaded from SharePoint, but AJAX requests are subsequently directed to the MindLink Desktop server, and browsers require that these two communication channels operate on the same domain.

The proxy needs to be configured so that all requests get directed to the SharePoint Web Front End server, except in two cases:

1.       Requests beginning with a specific prefix (for example ‘/MindLink/’), which should be routed to the MindLink base URL.

2.       Requests beginning with a separate prefix (for example ‘/Connector/’), which should be routed to the FCF private API.

These URL prefixes are required for the WebPart configuration in section 4.2.

It is possible to use IIS as the proxy (using ARR1 and the ‘URL Rewrite’ feature), and, in fact, this can potentially be the same IIS server that hosts the SharePoint site. ARR will need to be installed on every Web frontend server.

Using ARR:

1.       Install the ARR binary on the Web Front End following the on-screen instructions.

2.       Launch Internet Information Services (IIS) Manager

3.       Click on the root IIS node (labeled with the machine name), in the right pane double click on ‘Modules’.

4.       The ‘Modules’ list will appear. Under the ‘Actions’ pane, click on ‘View Ordered List…”

5.       In the ‘Modules’ list, select the module ‘Application Request Routing’ and move it to the top of the list.

6.       Click on the root IIS node (labeled with the machine name), in the right pane double click on ‘Application Request Routing                   Cache’.

7.       Under the ‘Actions’ pane, click on the ‘Server Proxy Settings’. Then select the option ‘Enable Proxy’.

8.       Within IIS expand the ‘Sites’ node and select the relevant SharePoint IIS site.

9.       In the right pane, find and double click on the ‘URL Rewrite’ application within the ‘IIS’ section.

 

 

Figure 8: Add Rules window

10.   Within the ‘URL Rewrite’ screen, click on the ‘Add Rule(s)…’ option within the ‘Action’ panel.

11.   Select ‘Blank Rule’ under the ‘Inbound Rules’ heading in the Add Rule(s) dialog. Click the ‘OK’ button.

12.   Within the ‘URL Rewrite’ screen, click on the ‘Add Rule(s)…’ option within the ‘Action’ panel.

13.   Select ‘Blank Rule’ under the ‘Inbound Rules’ heading in the Add Rule(s) dialog. Click the ‘OK’ button.

 

Figure 9: Edit Inbound Rule

12.   In the ‘Edit Inbound Rule’ screen, enter the name for the rule.

13.   Within the Match URL section, select ‘Matches the Pattern’ value from the ‘Requested URL:’ drop down box and set the value ‘Wildcards’ within the ‘Using:’ drop down box.

14.   Enter the name of the MindLink Base URL (followed by /*) in the ‘Pattern’ field: MindLink/*. See section 4.2 for details on the MindLink Base URL.

15.   Ensure the ‘Ignore case’ checkbox is checked.

16.   Within the ‘Action’ section, select the value ‘Rewrite’ from the ‘Action type:’ drop down box.

17.   Under the ‘Action Properties’ section, within the ‘Rewrite URL’ field, enter the full URL including the relevant port number (followed by /{R:1}) that points to the MindLink Desktop instance i.e. https://server.domain:port/{R:1}.

18.   Select the option ‘Append query string’

19.   Click ‘Apply’ to create and save the rule.

This will route every request to the SharePoint server at the MindLink relative path to the Connector service. Test this by visiting ‘/MindLinkReverseProxy//’ on the SharePoint server – you should see the full client page.

 

3.5   Configuring Windows Firewall

If the Windows Firewall is enabled on the frontend server(s)., inbound and outbound port exceptions need to be made on Windows Firewall to allow the WebPart to communicate with the MindLink Desktop server.

The port numbers that need to be included as exceptions can be derived from the following sections within the MindLink Management Center:

Figure 10: Information service port value

Under the ‘General’ section of the MindLink Management Center, the value of the ‘Information Service Port’.

 

Figure 11: Web client port value

Under the ‘MindLink Desktop’ section of the MindLink Management Center, the value of the ‘Web Client Port’.

 

Figure 12: SharePoint API Port value

Under the ‘MindLink WebPart’ section of the MindLink Management Center, the value of the ‘SharePoint API Port’.

 

3.6   Certificates

Figure 13: Settings for MindLink Desktop for SharePoint feature extension

Because the SharePointAPI trusted logon method is protected with certificate credentials, the WebPart must call it with a client certificate. The host name of the SharePoint (machine.FQDN) site must be added as an authorized host within the ‘Authorized Hosts (only required for SSO)’ section in the MindLink Management Centre tool.

 

 

4   Configuration

4.1   Adding the WebPart to a Page

 https://svn.formicary.net/fcf.docs/trunk/Product/Gcwa/SharePoint%20Web%20Part/Installation%20Guide/Images/3%20-%20Configuration/Editing%20the%20page.png

Figure 14: Editing the page.

Navigate to the page that the WebPart will be added to, and click the edit button (in the top-left of the screen.

 

 https://svn.formicary.net/fcf.docs/trunk/Product/Gcwa/SharePoint%20Web%20Part/Installation%20Guide/Images/3%20-%20Configuration/Inserting%20a%20web%20part%20into%20the%20page%20-%201.png

Figure 15: Inserting a WebPart into the page (part one).

Once in edit mode, move the caret to the position where the WebPart will be inserted, and click on the ‘Insert’ tab (under ‘Editing Tools’). Then click on the ‘WebPart’ button (the button may take a moment to become enabled).

 

 https://svn.formicary.net/fcf.docs/trunk/Product/Gcwa/SharePoint%20Web%20Part/Installation%20Guide/Images/3%20-%20Configuration/Inserting%20a%20web%20part%20into%20the%20page%20-%202.png

Figure 16: Inserting a WebPart into the page (part two).

This will cause the WebPart form to appear. Select the ‘Custom’ category from the far-left column, and select ‘MindLink Web Part’ in the second column. Then click on the ‘Add’ button.

 

 https://svn.formicary.net/fcf.docs/trunk/Product/Gcwa/SharePoint%20Web%20Part/Installation%20Guide/Images/3%20-%20Configuration/Editing%20the%20unconfigured%20web%20part.png

Figure 17: Editing the un-configured WebPart.

The un-configured WebPart will appear in the page. Initially, there will be a notice stating that the WebPart is loading. Click on the small triangle in the top-right of the WebPart and then select ‘Edit WebPart’ from the drop-down menu.

 

This will put the WebPart into edit mode, and the available settings will appear in a column on the right side of the screen. The settings will appear in a number of separate sections. Initially, the ‘Appearance’ section will be seen. The various relevant settings are explained in the following sections.

 

 https://svn.formicary.net/fcf.docs/trunk/Product/Gcwa/SharePoint%20Web%20Part/Installation%20Guide/Images/3%20-%20Configuration/The%20web%20part%20general%20properties.png

Figure 18: The WebPart general properties.

This section deals with configuring the WebPart so that it is in a state where it can communicate with the FCF server.

With a correctly configured proxy, there are two settings that need to be provided: ‘MindLink Base URL’ and ‘Web Service Base URL’. These are available in the ‘MindLink General Properties’ section.

The ‘MindLink Base URL’ needs to be set to the URL that the proxy server is serving MindLink WebPart static content from. This will have been established when configuring the proxy (in section 0 above). Note that the URL should have a trailing slash. If you have configured the proxy with the values provided in section 3.4, then the default values in this section are correct and do not need to be edited.

The ‘Web Service Base URL’ will look something like /MindLink/Connector/PrivateApi/Json

 

Layout-related options are available under the ‘MindLink General Properties’ section. A number of checkboxes exist to enable or disable features:

  •          ‘Show Dock’ configures whether the dock (the tree-orientated panel on the left of the WebPart) is enabled. If this is  disabled, a chat room to join must be specified, since without the dock it won’t be possible to switch between chat rooms (this is described later).
  •          ‘Show Toolbar’ configures whether the toolbar at the top of the WebPart is visible. Without the toolbar, it is not possible to access settings or online help.
  •          ‘Show Chat Room Input’ configures whether the input box is visible for chat rooms. If this is disabled, users will be able to read messages, but they will not be able to send messages from the WebPart.
  •          ‘Show Chat Room User List’ shows or hides the list of chat room participants found on the right of the chat room history.
  •          ‘Show Add-Ins’ shows or hides add-ins for chat rooms that have them available.

 

Below the checkboxes is an option to switch the ‘Look and Feel’ that the WebPart uses. This will change colors and icons that are used.

Below the ‘Look and Feel’ option, there is a ‘Chat Room to Join Automatically’ field. This text box can be used to optionally specify a chat room that will automatically be displayed when the WebPart is loaded. This field is required if the ‘Show Dock’ checkbox is unchecked.

 

Finally, there is a ‘Thread to show’ field. This text box can be used to optionally specify a thread (sub-category) of the chat room specified in the ‘Chat Room to Join Automatically’ field to be displayed when the WebPart is loaded.

For Group Chat, tags consist of a hash character followed by alphanumeric characters, underscores or hyphens. For example: ‘#sales_2011’

 

The ‘Web Service Base URL’ needs to be the base URL that the proxy exposes for communicating with the private API of the FCF server. This path will also have been decided during the load balancer configuration.

It is possible to check this URL by loading it in your browser – you should be able to access the full client version of MindLink Desktop for SharePoint.

 https://svn.formicary.net/fcf.docs/trunk/Product/Gcwa/SharePoint%20Web%20Part/Installation%20Guide/Images/3%20-%20Configuration/The%20web%20part%20configured%20without%20SSO.png

Figure 19: The WebPart configured without single sign-on.

Once these two properties are correctly set and settings are saved (by clicking the ‘OK’ button), the WebPart should be functional. It should be possible to manually log in and use the application.

The WebPart can optionally be setup to use single sign-on (SSO) – this will be covered in section 4.4.

 

4.3   Layout Options

Figure 20: The WebPart appearance and advanced settings.

A number of settings are available for configuring the layout. Some standard WebPart properties are available under the ‘Appearance’ section. These can be used to change the title that appears above the WebPart, the dimensions of the WebPart, and chrome type. Please note that these are standard in-built SharePoint configuration options and not custom features supplied with the MindLink WebPart.

 

There are optional layout options:

  •          Entering text in the ‘Title’ box will modify the title at the top of the WebPart. Leave this blank if you do not wish to add a title. The default title is “MindLink Web Part”.
  •          The ‘Height’ options can be used to adjust the height dimensions of the WebPart.
  •          The ‘Width’ options can be used to adjust the width dimensions of the WebPart.
  •          Toggling the ‘Chrome State’ radio buttons allows you to minimize the WebPart, or have it appear as normal.
  •          The ‘Chrome Type’ drop down menu allows you to add and configure a border to appear around the WebPart.
  •          The ‘Allow Minimize’ checkbox allows you to minimize the WebPart manually directly on the WebPart itself.
  •          The ‘Allow Close’ checkbox allows you to close the WebPart manually on the WebPart itself.
  •          The ‘Allow Hide’ checkbox allows you to hide the WebPart manually using a control on the WebPart.
  •          The ‘Allow Zone Change’ checkbox allows you to move the WebPart on the page to a different location manually using a control on the WebPart.
  •          The ‘Allow Connections’ checkbox allows you to using a control on the Webpart.
  •          ‘Allow Editing in Personal View’ checkbox allows you to edit the WebPart
  •          The ‘Title URL’ box allows you to add a URL to the title of the WebPart.
  •          The default description is “Web Part that allows MindLink Desktop for SharePoint components to be embedded in the page.”
  •          The ‘Help URL’ box allows you to add a help link and URL to the WebPart.
  •          Help mode allows you to edit the help settings.
  •          Catalog icon image allows you to select an image.
  •          The ‘Title Icon Image URL’ box allows you to add an icon to appear next to the title and to apply a URL.
  •          Import error message allows you to find an error message.
  •          The ‘Target Audiences’ box allows you to control who can access the WebPart using SharePoint’s target audiences  feature.
     

 

Figure 21: A stripped-down WebPart.

A stripped down WebPart with the dock, toolbar and users list hidden can be seen here. It has been configured to join a chat room automatically, in which users are able to send messages.

 

4.4   Single Sign-On (SSO)

A feature of the WebPart is that it is able to use the credentials of the user logged into SharePoint in order to log into MindLink WebPart automatically. This removes the need to enter your user credentials twice. Please see the Operations and Configurations Guide for more detail on SSO general configuration.

 

4.4.1   Requirements

A number of additional features are required to enable SSO:

1.       The SSO feature requires that the ‘Sessions’ module is installed on the SharePoint server. This can be verified using the ‘Internet Information Services (IIS) Manager’.

a.       Within IIS, select the SharePoint site in the tree menu.

b.      Locate and launch the ‘Modules’ tool within the right pane, or if it does not exist, click the ‘Add Managed Module’ option.

c.       Enter a name for the module i.e. SessionState.

d.      From the ‘Type’ dropdown list, select the appropriate type i.e. System.Web.SessionState.SessionStateModule.

e.      Click ‘Ok’ to save the changes.

Figure 22: Add Managed Module

 

Figure 23: Modules

2.       The FCF server must have the ‘GcwaSharePointApi’ service enabled, which must be running over a secure connection (and hence requires a server-side certificate). You must configure the server-side certificate, the port number this service uses in addition, and have a list of authorized hosts configured. Please use the MindLink Management Center to configure these options and refer to the Operations and Configuration guide for instructions.

3.       The SharePoint server must have a client-side certificate, which is used to communicate with the trusted logon method of the ‘GcwaSharePointApi’. The account that the SharePoint application pool runs as must be given access to the private key of this certificate.

a.       Open the Management Console on the server.

b.       Add the ‘Certificates’ snap-in.

c.       On the ‘Certificates (Local Computer)’ node, expand ‘Personal’ > ‘Certificates’ nodes and select the relevant client certificate.

d.       Right-click the certificate, select ‘All Tasks’ and ‘Manage Private Keys’.

e.       Add the service account which runs the SharePoint application pool, and grant allow permissions ‘Full Control’ and ‘Read’.

f.        Click ‘OK’ to save the changes.

4.       Log onto the Central Administration Tool as the SharePoint service account.

5.       Click on ‘Security’.

6.       Within the ‘Security’ page, click on ‘Manage Trust’, or if it does not exist, add the server hosting the ‘GcwaSharePointApi’ service. Click on ‘New’.

 

Figure 24: Establish Trust Relationship dialog

7.       Within the ‘Establish Trust Relationship’ dialog, enter a name for the trust relationship.

8.       Browse for the root certificate.

9.       Click ‘OK’ to save the changes.

 

 

4.4.2   WebPart Configuration

https://svn.formicary.net/fcf.docs/trunk/Product/Gcwa/SharePoint%20Web%20Part/Installation%20Guide/Images/3%20-%20Configuration/The%20web%20part%20SSO%20properties.png

Figure 25: The WebPart SSO settings.

The SSO settings are located in the ‘MindLink SSO Properties’ section. Ensure that the ‘Enable Single Sign-On’ check box is checked, and then enter the following settings:

  •          ‘Host Name of the MindLink Service’ – the host name of the server running MindLink WebPart as visible from the SharePoint server.
  •          ‘Port Number of the MindLink Service’ – the port that MindLink WebPart is running on.
  •          ‘Certificate Subject’ – the ‘subject’ of the certificate that is used to host the MindLink WebPart server.
  •          ‘Reverse Proxy URL Rule’ – this is only required in a multiple-connector FCF configuration (see section 4.4.3 below).

Once the settings are saved, users will be logged in automatically to the WebPart. If the user cannot be logged in, a regular MindLink WebPart log on dialog will be displayed.

 

4.4.3   Multiple-Connector Configuration

When using multiple FCF Connector services, a load balancer must be in place over the private API and ‘GcwaSharePointApi’ (it might make sense to host these on the same port and have one load balancing rule). The IIS URL rewrite rule for the MindLink base path would then point to the load balancer. For SSO, the host name and port of the MindLink service would be that of the load balancer.

The only complication is that to ensure that AJAX requests are made back to the same instance of the Connector service that the WebPart code behind initiated the SSO session on, a rewrite rule that forwards requests to explicit connectors is required. This is configured in terms of the WebPart by specifying the ‘Reverse Proxy URL Rule’, which is a relative path that contains a ‘{0}’ placeholder. The code behind will insert the FQDN of the Connector service host on which the session is homed into the placeholder, to form the actual address of the service that AJAX requests should be made to.

For example, if the Reverse Proxy URL Rule is specified as ‘/MindLinkReverseProxy/{0}/Connector/PrivateApi/Json’ and the code-behind provides a user with a session on ‘wc1.example.com’, the client will make AJAX requests to ‘/MindLinkReverseProxy/wc1.example.com/Connector/PrivateApi/Json’. There must therefore be a URL rewrite rule on the load balancer that forwards requests for ‘/MindLinkReverseProxy/wc1.example.com/Connector/PrivateApi/Json’ to ‘wc1.example.com/Connector/PrivateApi/Json’.

 

4.4.3.1   Using IIS as a Reverse Proxy

See section 3.4

 

4.5   SharePoint Unified Logging Service (ULS) logs

MindLink WebPart logs messages in the SharePoint ULS log file, usually stored at

”C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\LOGS”.

Log messages appear under a custom Diagnostics Area and Category:

  •          Diagnostics Area: MindLink WebPart
  •          Category: WebPart Diagnostics

 

5   Troubleshooting

5.1   Installation Failure

In case of a failed webpart installation, an error dump file is generated in ‘C:\Windows\System32\Deployment_error-dump.xml’. This may be used to troubleshoot and diagnose the nature of the failure.

 

6   Glossary

Term

Definition

SharePoint Farm

A set of multiple SharePoint servers that all work together to provide SharePoint services.

Load balancing

Distributing the workload across multiple computers or network links in order to ensure optimum efficiency of the system.

Frontend server

The OCS server whose role is the central coordinator of configuration and authentication.

Root certificate

The base certificate in a certificate chain.

SharePoint Site Collection

SharePoint sites sharing administration and site settings, which allow for sharing of content.

WSP file

WindowsSharePoint, a file extension for a solution file used by Windows.

MSI file

Microsoft Installer extension file.

AJAX requests

An asynchronous client request from a Javascript-enabled web site.

FCF private API

MindLink internal application programming interface (not to be used by 3rd parties).

FCF server/ service

The connector server.

Connector server

The service application that hosts the MindLink server suite of products.

ARR - Application Request Routing

An extension to IIS that allows the definition of a pool of servers to which http requests can be routed. A load-balancing solution.

Web Client Port

The port on which the connector server hosts the MindLink Desktop client.

SharePoint API Port

The port on which the connector server listens for SharePoint authentication requests.

MindLink WebPart static content

The content files and resources that make up the MindLink Desktop client.

Certificates

The electronic documents that use a digital signature to bind a public key with an identity. Used for cryptographic operations.

Reverse Proxy URL Rule

A proxy that retrieves resources on behalf of a client from a server.

 

1 Application Request Routing, available from http://www.iis.net/download/applicationrequestrouting