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:
All functionalities are implemented using the native SharePoint web services as the interface to SharePoint content and services.
SharePoint Connector is also supported with AEM 6.1 service pack 2. The connector no longer supports virtual repository mount and, therefore, it cannot be mounted. If you want to access the Sharepoint repository using Java APIs, use the Sharepoint connector’s JCR repository implementation in your project.
Installation, configuration, management, and IT operations of the SharePoint server and related IT infrastructure are outside the scope of this document. See vendor documentation on SharePoint for information about these topics. The connector requires these parts of the infrastructure to be properly installed, configured, and operated.
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.
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.
The connector requires the following:
The SharePoint connector is available for downloading from packageshare.
The connector supports the following:
Microsoft SharePoint versions:
If you require support for custom deployments of the connector (OEM, special requirements, customized authentication methods), contact the Adobe office for your region.
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.
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.
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.
To set the URL of the SharePoint server and advanced options, perform these steps:
‘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> 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
If you configure multiple workspaces, specify the name of the default workspace in the Default Workspace Name parameter.
For additional information around authentication-related parameters, see Authentication.
After you configure the connector, verify the following:
To synchronize the SharePoint Assets with AEM, perform the following steps:
Enable the DAM Sync Service, which is disabled by default:
Optionally, you can configure the Synchronization delay between different synchronization cycles:
Sharepoint includes the Classic and Claims Based authentication methods, both of which support the following authentication types:
In particular, the following types of authentication are available:
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:
Configuring Forms Based Authentication
Configuring Basic Authentication (Windows)
Edit the configuration values.
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:
To add the user in the admin group:
Download and install the package
zip from Package Share.
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.
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:
com.day.crx.spi.sharepoint.security.SharepointConnectionFactory to handle the client side of your specific authentication process.
SharepointConnectionFactory implementation as a fragment bundle with fragment host
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>
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 implementation
Restart the connector.