📘

Configuration and Usage

For configuration and usage of this connector please go to the Microsoft SharePoint guide.

Installation Requirements

📘

SaaS Environments

No action needs to be taken for customers on cloud deployments hosted by Smart Communications as the environment should already have this connector installed. If you need a licence please contact your Customer Service Manager.

For customers on self-hosted deployments (either in the cloud or on-premise), consider the following requirements before installing or upgrading this extension:

• You must have administrator/elevated permissions to a suitable web server to install the service.

• Ensure you have a compatible version of the connector with your current SmartIQ version (Connector and SmartIQ should match versions).

🚧

️ ️Licence key required

You must have a valid license key to enable the SharePoint module (ID 6123). If you do not have that module id enabled, please contact your SmartIQ representative. If there is a possibility that your SharePoint service uses module 9022, refer to older modules for instruction on how to remove before proceeding.

This connector has now been implemented as a service which can be registered to an instance which behaves in a similar fashion to the previous versions. This is referred to as the Dynamics Service.

🚧

The Dynamics Service needs to be hosted somewhere accessible only by the SmartIQ platform.

🚧

Remove the existing Extension if deployed as a dll (all upgrades previous to v13). This may include removing entries in the appSettings.json as well as the dll’s from directories.

Older Modules

Before starting, run the following SQL in the database to remove any references to module id 9022 which is an old and no longer valid installation of SharePoint.

Failing to do this will cause the SharePoint service to not register. If the service does not register correctly, check these tables, remove all the records that reference module id 9022 and then complete the registration steps again.

DELETE [Routing_ElementType] WHERE [Routing_ElementType].[RoutingTypeId] 
IN (SELECT [RoutingTypeId] FROM [Routing_Type] WHERE ModuleId = 9022)
GO

DELETE [Routing_Type] WHERE ModuleId = 9022
GO

DELETE [ConnectorSettings_ElementType] WHERE [ConnectorSettings_ElementType].[ConnectorSettingsTypeId] 
IN (SELECT [ConnectorSettingsTypeId] FROM [ConnectorSettings_Type] WHERE ModuleId = 9022)
GO

DELETE [ConnectorSettings_Type] WHERE ModuleId = 9022
GO

IIS Deployment of the Service

.Net Framework 4.8 has to be installed on the machine and registered for usage within IIS.

📘

These steps are almost identical to installing Manage and Produce in IQ12 (as they ran on .Net Framework)

1. Create a new site in IIS and define a port. For example, 8080. This can run over http or https.
2. Extract the files from the SharePoint Service zip archive to the site root.
3. Create a .Net Framework App Pool for the service. Do not use the same application pools that are already allocated to Manage and Produce.
4. Convert the SharePoint Service directory to an Application selecting the App Pool from #3.
5. With no other settings changes the service will have bindings to http://localhost:8080 as the <serviceURL>.

Verify the Installation

From your web browser navigate to <serviceURL>/v1/CreateConnection/Metadata For example, <http://localhost:8080/v1/CreateConnection/Metadata> which should return a metadata document. Anything else and you will need to troubleshoot the specific error in relation to requirements above.

If valid, the result will look like xml or json (browser decides what it will look like).

Register the Service with the Instance as a Connector Service

📘

A Tenant Ops Api key is required to complete these steps.

For an information sheet on how to implement a Tenant Ops Api key and available endpoints, please contact Support.

This connector has the following url endpoints to be registered using the RegisterService endpoint in the Tenant Ops API | Register-Service :

1. <serviceURL>/v1/SaveList
2. <serviceURL>/v1/SaveDocument
3. <serviceURL>/v1/DataConnection