SharePoint Connector
- Topics:
- Administering
CREATED FOR:
- Admin
Day JCR Connector for Microsoft SharePoint 2010 and Microsoft SharePoint 2013, version 4.0.
This article includes details around the Adobe JCR Connector for Microsoft SharePoint 2010 and Microsoft SharePoint 2013, version 4.0.
The SharePoint connector supports the following base functionalities:
- Reading content and metadata from SharePoint.
- Acknowledging SharePoint security settings for accessed content by applying native SharePoint authentication and authorization
- Content Integration using Content Finder
- Using AEM components, such as External Resource to display SharePoint images and videos
- Synchronizing SharePoint with AEM Assets
All functionalities are implemented using the native SharePoint web services as the interface to SharePoint content and services.
Getting started
To get started with the connector, do the following:
-
Ensure that you have at least Java 7 installed.
-
Download the connector package distribution file from Package Share.
-
Copy a valid license.properties file to the directory that contains the cq-quickstart-6.4.0.jar file.
-
Double-click/tap the .jar file to start AEM, or start it from the command line.
-
Install the connector package from Package Manager.
-
Configure the connector options.
Installing SharePoint connector
The connector is a content package that facilitates easy installation. Install the package using Package Manager, and then set the SharePoint server URL
and other configuration options. The SharePoint content is available in the AEM repository.
Installation requirements
The connector requires the following:
- Java Runtime Environment 1.7 or later
- SharePoint Web Services available through the network
- SharePoint server URL
- User credentials and permissions for CRX and SharePoint repositories
- Supported platforms
The SharePoint connector is available for downloading from packageshare.
Supported Platforms
The connector supports the following:
-
AEM versions:
- AEM 6.4, 6.3
-
Microsoft SharePoint versions:
- Microsoft Office SharePoint Server (MOSS) 2010
- Microsoft Office SharePoint Server (MOSS) 2013
-
If you require support for custom deployments of the connector (OEM, special requirements, customized authentication methods), contact the Adobe office for your region.
Standard installation
AEM Package Share is used to distribute product features, examples, and hot fixes. For details, see the Package Share documentation.
To access Package Share on the AEM Welcome page, tap/click Tools and then select Package Share. You require a valid Adobe ID that includes your company email address. In addition, after logging in to your account, apply for Package Share access.
Integrating with AEM
To install the connector content package.
-
Open an Adobe Support ticket to request for the connector featurepack.
-
Download the package when it is available and then open Package Manager for your AEM instance.
-
Tap/click Install from the package description page.
-
From the Install Package dialog, tap/click Install.
Note: Make sure that you are logged-in as administrator.
-
When the package is installed, tap/click Close.
Configuring SharePoint connector
After you install the SharePoint connector, configure the application and the SharePoint layers for the connector.
Set the SharePoint server URL to make your SharePoint repository JCR compliant. You can set extra parameters to configure the connection with the SharePoint server. In addition, configure authentication with the SharePoint connector.
Configuring the connection with the SharePoint server
To set the URL of the SharePoint server and advanced options, perform these steps:
- Navigate to the OSGi Management Console: http://localhost:4502/system/console/configMgr.
- Search for the Day JCR Connector for Microsoft Sharepoint bundle.
- Edit the configuration values.
- Set the SharePoint Server URL as the value of Workspaces.
- Tap/click Save.
‘Workspaces’ and ‘Default Workspace Name’ parameters:
By default the connector exposes a single JCR workspace. The SharePoint server which is exposed by this workspace is set through the ‘Sharepoint Server URL’ configuration parameter.
The connector can also be configured for multiple workspaces. In this case, each workspace is associated with the URL of the respective SharePoint server that is exposed through the workspace. To add a workspace, add a workspace definition to the Workspaces parameter. A workspace definition has the following format:<name>
= <url>
where<name>
is the name of the JCR workspace and<url>
is the URL of the SharePoint server for that workspace.
In AEM, perform one more step apart from above configuration steps. Allow list the ‘com.day.cq.dam.cq-dam-jcr-connectors’ bundle.
To allow list bundles in AEM, perform the following steps:
-
Navigate to the OSGi Management Console: http://localhost:4502/system/console/configMgr.
-
Search for “Apache Sling Login Admin Whitelist” service.
-
Select Bypass the whitelist.
-
Add ‘com.day.cq.dam.cq-dam-jcr-connectors’ in whitelist bundles default
-
Click Save.
For additional information around authentication-related parameters, see Authentication.
Verifying the Sharepoint setup
After you configure the connector, verify the following:
- SharePoint server runs, and the web services are accessible to the connector instance
- SharePoint user credentials are valid and the user has necessary SharePoint permissions
- The connector is installed and configured properly
Configuring DAM Sync with the SharePoint server
To synchronize the SharePoint Assets with AEM, perform the following steps:
- Navigate to the OSGi Management Console: http://localhost:4502/system/console/configMgr.
- Search for “Default DAMAssetSynchronization” service.
- Edit the configuration values.
- Set the user name and the corresponding Password of the user having access on the SharePoint site.
- Click Save.
Enable the DAM Sync Service, which is disabled by default:
- Navigate to the OSGi Web Console Components: http://localhost:4502/system/console/components
- Search for “com.day.cq.dam.jcrconnectors.impl.AssetSynchronizationService.”
- Click Enable.
Optionally, you can configure the Synchronization delay between different synchronization cycles:
- Navigate to the OSGi Management Console: http://localhost:4502/system/console/configMgr
- Search for “DAY CQ DAM JCR Connector Asset Synchronization Service.”
- Edit the configuration values.
- Set the value of the Synchronization Period (in seconds).
- Click Save.
Configuring Authentication
Sharepoint includes the Classic and Claims Based authentication methods, both of which support the following authentication types:
- Basic
- Forms-Based
In particular, the following types of authentication are available:
- Classic-Basic
- Classic-Forms-based
- Claims-Basic
- Claims-Forms-based
The AEM JCR Connector for Microsoft SharePoint 2010 and Microsoft SharePoint 2013, version 4.0. supports Claims-based authentication (which is suggested by Microsoft), which operates in the following modes:
- Basic/NTLM authentication: The connector first tries to connect using basic authentication. If not available, it switches to NTLM-based authentication.
- Forms-based authentication: Sharepoint validates users based on credentials that users type in a login form (typically a web page). The system issues a token for authenticated requests that contains a key for reestablishing the identity for subsequent requests.
Configuring Forms Based Authentication
- Click OSGI -> Configuration
- Search “Day JCR Connector for Microsoft Sharepoint”
- Click “Edit the configuration values”
- Set the value of ‘Sharepoint Connection Factory’ as ‘com.day.crx.spi.sharepoint.security.FormsBasedAuthenticationConnectionFactory’
- Click Save
Configuring Basic Authentication (Windows)
- Disable Token Authentication.
- Go to http://localhost:4502/system/console/bundles.
- Click OSGI > Configuration.
- Search for Day JCR Connector for Microsoft Sharepoint.
- Click
Edit the configuration values
. - Set the value of Sharepoint Connection Factory to
com.day.crx.spi.sharepoint.security.WindowsAuthenticationConnectionFactory
. - Click Save.
Only a user who is authenticated on both AEM and SharePoint can access the SharePoint content through the connector.
You can also use the connector extension for authentication to create a custom authentication module, which, e.g., maps access by AEM users to specific SharePoint users. Create AEM users corresponding to SharePoint users (user name and password should match) to be able to see SharePoint content mapped to the connector instance.
To create a user in AEM:
- Login to http://localhost:9502/with the admin user.
- Click Tools.
- Click Security.
- Click Users.
- Click Create User
- Provide the user ID (User name having access on SharePoint)
- Provide the corresponding password
- Click the Green tick symbol to create the user
To add the user in the admin group:
- Go to Group Administration
- Click the ‘a’ node
- Click ‘administrators’
- Type the user ID create above in the text box before Browse button
- Click the Green tick symbol to add the user to admin group
Disable Token Authentication
-
Download and install the package
basic auth
.zip
from Package Share. -
Close Quickstart.
-
Open the file \crx-quickstart\repository\repository.xml.
-
Find the tag
<LoginModule class="com.day.crx.core.CRXLoginModule"> ... </LoginModule>.
-
Insert the tag
<param name="disableTokenAuth" value="true"/>
inside the tag mentioned in step 4. -
Save and close the xml file.
-
Restart QuickStart and log in with your credentials.
Supporting different authentication methods of the SharePoint server
In its standard version, the connector supports the standard IIS Windows authentication (Basic) and Forms-based authentication (token based). The other authentication methods can be supported through the extensibility mechanism.
The following steps provide guidelines around extending the standard authentication to support various authentication methods of the SharePoint server:
-
Implement
com.day.crx.spi.sharepoint.security.SharepointConnectionFactory
to handle the client side of your specific authentication process. -
Install the
SharepointConnectionFactory
implementation as a fragment bundle with fragment hostcom.day.crx.spi.crx2sharepoint-bundle
.When using Maven, adapt the following configuration of the
maven-bundle-plugin
to the requirements of your project:<plugin> <groupId>org.apache.felix</groupId> <artifactId>maven-bundle-plugin</artifactId> <extensions>true</extensions> <configuration> <instructions> <Export-Package /> <Private-Package> <!-- your private package here --> </Private-Package> <Fragment-Host> com.day.crx.spi.crx2sharepoint-bundle </Fragment-Host> </instructions> </configuration> </plugin>
-
Register the
SharepointConnectionFactory
implementation in the connector configuration. In the configuration window of the connector, click Advanced options. In the for Sharepoint Connection Factory field, specify the name of the implementationcom.day.crx.spi.sharepoint.auth.CustomConnectionFactory
. -
Restart the connector.
Experience Manager
- Administering User Guide overview
- Sites Features
- Website Administration
- Reusing Content: Multi Site Manager and Live Copy
- Live Copy Overview Console
- Configuring Live Copy Synchronization
- Creating and Synchronizing Live Copies
- MSM Rollout Conflicts
- MSM Best Practices
- Translating Content for Multilingual Sites
- Managing Translation Projects
- Identifying Content to Translate
- Preparing Content for Translation
- Creating a Language Root Using the Classic UI
- Connecting to Microsoft Translator
- Configuring the Translation Integration Framework
- Language Copy Wizard
- Translation Enhancements
- Translation Best Practices
- Configurations and the Configuration Browser
- AEM FAQs
- Operations
- Dashboards
- Operations Dashboard
- Backup and Restore
- Data Store Garbage Collection
- Monitoring Server Resources Using the JMX Console
- Working with Logs
- Configure the Rich Text Editor
- Configure the Video component
- The Bulk Editor
- Configuring Email Notification
- Configuring RTE for Producing Accessible Sites
- The Link Checker
- Troubleshooting AEM
- Audit Log Maintenance in AEM 6
- Editor
- Managing Access to Workflows
- Using cURL with AEM
- Configuring Undo for Page Editing
- Proxy Server Tool (proxy.jar)
- Configuring for AEM Apps
- Administering Workflows
- Configuring Search Forms
- Tools Consoles
- Reporting
- Administering Workflow Instances
- Configuring Layout Container and Layout Mode
- Enabling Access to Classic UI
- Starting Workflows
- Configure the Rich Text Editor plug-ins
- Admin Consoles
- Security
- User Administration and Security
- User, Group and Access Rights Administration
- Security Checklist
- OWASP Top 10
- Running AEM in Production Ready Mode
- Identity Management
- Adobe IMS Authentication and Admin Console Support for AEM Managed Services
- Creating a Closed User Group
- Mitigating serialization issues in AEM
- User Synchronization
- Encapsulated Token Support
- Single Sign On
- How to Audit User Management Operations in AEM
- SSL By Default
- SAML 2.0 Authentication Handler
- Closed User Groups in AEM
- Granite Operations - User and Group Administration
- Enabling CRXDE Lite in AEM
- Configuring LDAP with AEM 6
- Configure the Admin Password on Installation
- Service Users in AEM
- Encryption Support for Configuration Properties
- Handling GDPR Requests for the AEM Foundation
- Content Disposition Filter
- Personalization
- eCommerce
- Integration
- Integrating with Third-Party Services
- Integrating with Salesforce
- Integrating with Adobe Target
- Integrating with Adobe Analytics
- Connecting to Adobe Analytics and Creating Frameworks
- Configuring Link Tracking for Adobe Analytics
- Mapping Component Data with Adobe Analytics Properties
- Configuring Video Tracking for Adobe Analytics
- HTTP2 Delivery of Content FAQ
- Troubleshooting your Adobe Campaign Integration
- SharePoint Connector Licenses, Copyright Notices, and Disclaimers
- SharePoint Connector
- DHTML Viewer End-of-Life FAQs
- Integrating with Adobe Campaign Classic
- Related Community Articles
- Integrating with Adobe Campaign Standard
- Flash Viewers End-of-Life Notice
- Integrating with Adobe Creative Cloud
- Integrating with Adobe Dynamic Tag Management
- Opting Into Adobe Analytics and Adobe Target
- AEM Portals and Portlets
- Integrating with Dynamic Media Classic
- Troubleshooting Integration Issues
- Integrating with BrightEdge Content Optimizer
- Best Practices for Email Templates
- Catalog Producer
- Integrating with Silverpop Engage
- Integrating with Adobe Campaign
- Integrating with ExactTarget
- Analytics with External Providers
- Integrating with the Adobe Marketing Cloud
- Manually Configuring the Integration with Adobe Target
- Prerequisites for Integrating with Adobe Target
- Adobe Classifications
- Solutions Integration
- Target Integration with Experience Fragments
- Best Practices
- Content Management