Installation and Setup

This page will provide step-by-step instructions for getting started with SharePoint for Connect 365.

Prerequisites

IMPORTANT: Before beginning setup of SharePoint for Connect 365, please ensure that the following setup steps have been completed:

Note: At this time, SharePoint for Connect 365 does not support folder structures "Based on entity". Please ensure that this option is not selected when configuring Document Management for entities.

Configure SharePoint Service Account in SharePoint Site Collection

Connect 365 uses a user account termed a service account to access SharePoint documents. The user account must be granted access to the SharePoint site collection. It is also recommended to set the service account's password to not expire.

  1. C reate a new user account in your Office 365 tenant that is assigned a SharePoint license
  2. Navigate to the SharePoint site collection website
  3. Navigate to Settings > Site settings

  4. Click People and groups

  5. Click New > Add Users, to add the service account to the Members group

  6. Enter the user account name that Connect 365 will be using, click Share. Note the user account's credentials for Connect 365 Settings, below.

  7. Using a new web browser session, validate that the new user account is able to login and access SharePoint.

 

Dynamics 365 Solutions Import

The following solutions must be imported to create the entities and security roles used by SharePoint for Connect 365:

  • AdoxioDynamicsUI_<version>_managed.zip
  • AdoxioConnect365Base_<version>_managed.zip
  • AdoxioConnect365Identity_<version>_managed.zip
  • AdoxioConnect365SharePoint_<version>_managed.zip

During upgrades, it is recommended to always choose the stage for upgrade and overwrite customization options during import. Changes to the components contained in these solutions are not recommended.

Security Role Assignment

The Dynamics 365 User that is used to authenticate in Connect 365 must be assigned the following security roles imported by the Connect 365 solutions:

  • Connect 365 Application
  • Connect 365 Application - Identity
  • Connect 365 Application - SharePoint

Custom Security Role Creation and Assignment

In addition to the Connect 365 provided security roles, the Dynamics 365 user must also be granted read permissions to any entities that will use Connect 365 for SharePoint document management.

  1. Create a new security role and assign read permission to each entity that will use Connect 365 SharePoint document management. An example custom Application entity with read permission is seen in the following image:
  2. Assign the new security role to the Dynamics 365 User.
  3. Add the new security role to a custom solution that will be exported and imported along with the Connect 365 managed solutions in other Dynamics 365 instances to maintain permissions across deployments.
  4. Assign the new security role in deployments to other instances during promotions.

Connect 365 Settings

To allow Connect 365 to connect to SharePoint, SharePoint settings need to be entered into Dynamics 365 through the Connect 365 Settings entity.

  1. Navigate to Connect 365 > SharePoint > SharePoint Settings
    1. Create new records, one for each of the following settings:
      Feature Name Type Value
      SharePoint Service Account Username Single Line of Text The username (email address) for the SharePoint user that will be used by Connect 365 to authenticate to SharePoint
      SharePoint Service Account Password Single Line of Text The password for the above SharePoint user
  2. New in Version 1.4 The following SharePoint Settings are also supported, but optional:
    Feature Name Type Value
    SharePoint Maximum File Size Single Line of Text The maximum size of file to allow, in MB. For example, to limit uploads to 10MB or less: 10

SharePoint Content Record

Surfacing a SharePoint grid in a portal requires the creation of a SharePoint Content record. One or more SharePoint Content records will be created depending on the number of entities involved and the permissions associated with the SharePoint documents to show.

  1. Navigate to Connect 365 > SharePoint > SharePoint Content

  2. Create a new SharePoint Content record to define which SharePoint information to expose in a portal when viewing CRM record in a web page. See SharePoint Content for details.

 

SharePoint Permission Record 

Surfacing a SharePoint grid and controlling the allowed actions requires the creation of a SharePoint Permission record. The permissions defined control who may view the SharePoint documents associated to a CRM record.

  1. Navigate to Connect 365 > SharePoint > SharePoint Permissions

  2. Create a new SharePoint Permission record to control access to documents. See SharePoint Permissions for details.

 

Dynamics 365 Portal Web Templates

If they do not already exist, create the following web templates that are used to facilitate the placement of SharePoint content inside a web page:

Name Source Notes
Connect 365 - Widget Download as text This template may already exist as it is used to load all Connect 365 widgets.
Connect 365 - SharePoint Content Download as text This template is used to control the SharePoint template being included in a web page, web form, or entity form.

Dynamics 365 Portal Site Settings

If they do not already exist, create the following site settings:

Name Value Notes
Connect365/Url

Enter your provided adoxiocloud.com domain.

e.g. https://contoso.adoxiocloud.com

This site setting may already exist as it is used to load all Connect 365 widgets.

It is referred to by the previously created web templates to generate HTML script elements referring to your Connect 365 instance.

Web Template Usage

HTML

This example shows how to add SharePoint documents to a page by invoking the Connect 365 - SharePoint Content web template from an HTML section such as a web page copy field. The documents will be displayed immediately after the position of the include statement.

The parameters to use for this situation are:

  • key – The Key value from the SharePoint Content record.
  • type – "html" means the widget will be placed directly into the page source with all required parameters. This is the default and preferred method.
  • record_id – The unique id of the record whose documents will be shown.
Template "Connect 365 - SharePoint Content" not found.

 

Javascript

 

Entity Form

This example shows how to add SharePoint documents to an entity form step by invoking the Connect 365 - SharePoint Content web template from the entity form's custom JavaScript field.

The parameters to use for this situation are:

  • key – The Key value from the SharePoint Content record.
  • type – "script" means the widget will be loaded dynamically client-side.
  • selector – A CSS selector of an existing item on the web page. If provided, the SharePoint document list will be appended immediately following the specified element.
  • record_id – The unique id of the record whose documents will be shown.
Template "Connect 365 - SharePoint Content" not found.

 

Web Form Step

This example shows how to add SharePoint documents to a web form step by invoking the Connect 365 - SharePoint Content web template from the web form step's custom JavaScript field.

The parameters to use for this situation are:

  • key – The Key value from the SharePoint Content record.
  • type – "script" means the widget will be loaded dynamically client-side.
  • selector – A CSS selector of an existing item on the web page. If provided, the SharePoint document list will be appended immediately following the specified element.
  • record_id_selector – A CSS selector for obtaining the record ID from a hidden input in the HTML.
Template "Connect 365 - SharePoint Content" not found.

Sign In with Azure AD B2C

Usage of SharePoint functionality requires that users must first sign in with Azure AD B2C. Attempts at using a local account or any other login method will result in Connect 365 functionality not being able to recognize who is signed in and will result in permission denied errors.

See Also