Integration pack for SharePoint

Article
02/28/2023

Important

This version of Orchestrator has reached the end of support. We recommend you to upgrade to Orchestrator 2022.

Integration packs are add-ons for System Center - Orchestrator. They help you to optimize the IT operations across heterogeneous environments. Using integration packs, you can design runbooks in Orchestrator that use activities performed by other System Center components, other Microsoft products, and non-Microsoft products.

Learn more about Orchestrator privacy.

This article provides information about System Center integration pack for Microsoft SharePoint.

The System Center Integration Pack for Microsoft SharePoint enables the automation of common tasks in SharePoint. For example, to create list items, to upload and download documents, and to monitor a list for changes.

System requirements

The integration pack for SharePoint requires the following software to be installed and configured before you implement the integration.

System Center - Orchestrator
Microsoft .NET Framework 4
Microsoft SharePoint

System Center - Orchestrator 2019
Microsoft .NET Framework 4.6.1 or above (latest .NET Framework recommended)

Important

SharePoint Integration Pack (v10.19.38.0 or above) targets .NET Framework 4.6.1. Ensure that .NET Framework Runtime v4.6.1 or later is installed on Runbook Designer and Runbook Server machines. We recommend installing the latest available .NET framework version.
Create the following files with (identical) contents as shown below to update supportedRuntimeVersion to v4:
- %systemdrive%/Program Files (x86)/Microsoft System Center/Orchestrator/Runbook Designer/RunbookDesigner.exe.config
- %systemdrive%/Program Files (x86)/Microsoft System Center/Orchestrator/Runbook Designer/RunbookTester.exe.config
- %systemdrive%/Program Files (x86)/Microsoft System Center/Orchestrator/Runbook Server/PolicyModule.exe.config
Contents:
```
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <startup useLegacyV2RuntimeActivationPolicy="true">
    <supportedRuntime version="v4.0.30319"/>
  </startup>
  <system.xml.serialization>
    <xmlSerializer tempFilesLocation="C:\ProgramData\Microsoft System Center 2012\Orchestrator\Activities\XmlSerializers\"/>
  </system.xml.serialization>
</configuration>
```

System Center - Orchestrator 2022
Microsoft .NET Framework 4.7 or above (latest .NET Framework recommended)

Download the pack

Download the pack for 2022

Register and deploy the integration pack

After you download the integration pack file, you must register it with the Orchestrator management server, and then deploy it to runbook servers and Runbook Designers. Learn about installing the pack.

The SharePoint Integration Pack performs actions on behalf of a user who can access your SharePoint domain. The IP authenticates with SharePoint as this user in two modes:

Basic Auth (default, supports both SharePoint Online and SharePoint on-premises).
Modern Auth (also known as OAuth) using Azure AD (applicable only for SharePoint Online).

Configure the pack connections for Basic Auth

A connection establishes a reusable link between Orchestrator and a SharePoint site. You can create as many connections as you require to specify links to multiple sites. You can also create multiple connections to the same server to allow for differences in security permissions for different user accounts.

In the Orchestrator Runbook Designer, select Options, and select Microsoft SharePoint.
The Microsoft SharePoint dialog appears.
On the Configurations tab, select Add to begin the connection setup. The Add Configuration dialog appears.
In the Name box, enter a name for the connection. This name can be the name of the SharePoint site or a descriptive name to distinguish the type of connection.
In the Type box, select SharePoint Configuration.
In the SharePoint Site box, enter the URL of the SharePoint site that you want to integrate with.
In the User Name and Password boxes, enter the credentials that Orchestrator will use to connect to the SharePoint site.
In the Domain box, enter the name of the domain to authorize access.
In the SharePoint Online box, enter False if the SharePoint instance is on-premises.
Set the Utilize OAuth box to False.
In the Default Monitor Interval (seconds) box, enter a timeout value in seconds or keep the default value.
In the Default Maximum Items box, enter a maximum value, or keep the default value.
Select OK.
Add additional connections, if applicable, and select Finish.

Configure the pack connections for Modern Auth (SharePoint Online)

Register an AD Client Application on your Azure Active Directory (AD Instance), and configure the IP to use this client. The IP authenticates on your behalf; hence, your credentials are required in the IP configuration pane.

Note

This authentication mode is supported only for SharePoint Online.

Register a Client application on Azure AD

To register a client application on Azure AD, follow these steps:

Go to the Azure portal.
Navigate to Azure Active Directory > App registrations, and select New registration to register.
Set an applicable name for the application and choose the indicated Redirect URI (Public Client/native app) from the dropdown menu.
Choose the account type depending on your AD setup and whether you use both on-premises and online products.
Select Register.

App overview

The ApplicationID and TenantID are displayed under Overview; note them down.

Screenshot of Overview.

Redirect URI

Set the OAuth redirection URI. Choose the Public client (Mobile/Desktop app) platform:

Under Platform configurations, select Add a platform.
Select https://login.microsoftonline.com/common/oauth2/nativeclient as the Redirect URI and select Configure.
Under Advanced Setting, set Allow Public Client flows to Yes and select Save.

API permissions

SharePoint offers different API scopes/permissions.

Follow these steps to set API permissions:

Under Configured permissions, select Add a permission, and select SharePoint.
Grant the AllSites.Write permission to the app, or higher and then select Add permissions. AllSites.Write is required for all the SharePoint IP activities to work, and you can choose a narrower scope depending on the activities that your runbooks use.

Configure the SharePoint IP for Modern Auth

Use the following steps to configure the SharePoint IP for OAuth authentication:

In the Orchestrator Runbook Designer, select Options, and select Microsoft SharePoint.
The Microsoft SharePoint dialog appears.
On the Configurations tab, select Add to begin the connection setup. The Add Configuration dialog appears.
In the Name box, enter a name for the connection. This name can be the name of the SharePoint site or a descriptive name to distinguish the type of connection.
In the Type box, select SharePoint Configuration.
In the SharePoint Site box, enter the URL of the SharePoint site that you want to integrate with.
In the User Name and Password boxes, enter the (user) credentials that Orchestrator will use to connect to the SharePoint site when runbooks are executed.
In the Domain box, enter the name of the domain to authorize access.
In the SharePoint Online box, enter True.
Set the Utilize OAuth box to True.
Set the Application ID to the application ID seen on the portal.
Set the Directory ID to the directory (tenant) ID seen on the portal. This is also referred to as Microsoft 365 Tenant ID.
Set the AAD Instance URI to your AD URL (or leave it to default value).
Select OK.
Add additional connections, if applicable, and select Finish.

Get data from SharePoint

After performing the above steps, create a new runbook and use the Get List Items SharePoint activity. When you set the desired configuration in the activity's settings, the Runbook Designer will exercise your connection options to fetch some data from SharePoint.

A pop-up appears in case there's some problem with the credentials or other settings.

Share via