SharePoint (CMIS Binding)

From Grooper Wiki

This article is about the current version of Grooper.

Note that some content may still need to be updated.

2025 20232.72

SharePoint is a connection option for cloud CMIS Connections. It Grooper to Microsoft SharePoint, providing access to content stored in "document libraries" and "picture libraries" for import and export operations.

Connectivity is compatible with both online and on-premises SharePoint deployments via the SharePoint REST API.


About

Microsoft SharePoint is a web-based collaborative platform that integrates with Microsoft Office.  It is primarily a document management and storage platform, but it is highly configurable and its implementation varies from company to company.  Grooper utilizes what SharePoint calls "Document Libraries" to import and export documents with property mappings.  When you create a Document Library in SharePoint, not only do you have access to standard document properties like "Created By" or "Content Stream Length", but you can add custom ones as well.  This allows Grooper to map fields from a data model onto documents within a Document Library.

How To: Set Up a SharePoint Connection

Click here for an interactive walkthrough

  1. Expand your Projects Folder and right-click the Project (or Folder) where you want to add the CMIS Connection Type
  2. Select "Add", followed by "CMIS Connection..."
  3. Within the Add window, name your CMIS Connection.
    • For this example, we've named ours 'SharePoint', after its Connection Type.
  4. Click Execute to create.
  5. Within your newly created CMIS Connection, expand the dropdown menu on the Connection Settings tab.
  6. Select the SharePoint option.
  7. Enter the Base URL which will connect Grooper to your SharePoint site.
  8. Select your Authentication Method.
    • If your URL is secure, then OAuth may be the only Authentication Method available. In order to use OAuth, you will need to save, log in via Authentication sub-property, then save once more.
    • If using an unsecure URL, then you will select from the following Authentication Methods:
      • Anonymous Authentication
      • Auto Authentication
      • Basic Authentication
      • NTLM Authentication
  9. If necessary, turn the Subsites property from False to True.
    • This will enable Grooper to access any subsites that your SharePoint connection has.
  10. Click the List Repositories button to display all available, connected Repositories.
  11. From the list, select the Repository you wish to import.
  12. Click the Import Repositories button.
  13. Ensure you have selected the desired Repository and click Execute.
  14. Once successfully imported, the Repository will appear in the Node Tree as a child Object of your CMIS Connection'.
    • In addition, the Import Status on the CMIS Connection will turn from False to True.

How To: Set Up a Document Library in SharePoint

As mentioned earlier, Grooper connects to Document Libraries in SharePoint to map fields in a data model to properties of a Document Library.  First, we need to make a Document Library and set up its properties.


Click here for an interactive walkthrough


  1. Go to your SharePoint site.  Using the left navigation column, click on "Site Contents"
  2. From here, click on the "New" button next to the plus icon, and within the option window hat appears, select "Blank Library".  It will prompt you for a name and optional description.
  3. You've created an empty document library.  You can see a few of the default properties, Name, Modified, and Modified By.  At the end of this line, you will see "Add Column" next to a plus sign.  Click this to add new properties.
  4. This will give you a variety of types for your data elements.  For example, "Text" would correlate to a simple string variable.
  5. This brings up a new menu to name the column (or property), give it a description, alter the type (which will correspond to a similar type in Grooper), and assign a default value if desired.
  6. The added property will appear as a new column.

Known Issues & Limitations

Supported versions include SharePoint 2013 or higher. 

  • For SharePoint 2013 only, connections must be made to the root site.  Connecting directly to a subsite is not supported.

SharePoint CMISQL Query Limitations

The SharePoint connection binding does not support the IN_FOLDER predicate.

  • You must use the IN_TREE predicate instead when selecting a folder location to query.
  • Be aware the IN_TREE search is recursive where IN_FOLDER is not. This means any subfolders will be queried as well as the targeted folder.


The SharePoint connection binding has a hard limitation when it comes to querying larger repositories, with many thousands of folders and files.

  • There is currently a threshold limit of 5000 rows.
  • This means if a query has to scan more than 5000 items to return an item, SharePoint will return the following error:
    • "Internal Server Error (500): The attempted operation is prohibited because it exceeds the list view threshold."


Importing and Exporting with SharePoint

Importing

Submitting an Import Job

Click here for an interactive walkthrough


  1. To submit an Import Job, click the Imports icon.
    • IMPORTANT: Have an Import Watcher installed and running before submitting an Import Job.
  2. Once on the Imports page, click the Add New Jobs button.
  3. Add a Description to your Import Job.
  4. Next, select your Provider; to import from a Repository, select either Import Descendants or Import Query Results.
  5. Select the SharePoint Repository from which you'll be importing.
  6. Select the Base Folder.
    • The Base Folder is defaulted to the root of the SharePoint Repository. Be aware: should you leave this property unconfigured, then Grooper will import the entirety of your SharePoint library.
  7. Configure the Import Filter property if you only want to import certain file types.
    • For more information on the Import Filter property, click here
  8. Configure the Batch Creation property.
  9. When all the configurations have been made to the Import Job, click Submit.

Exporting

Adding an Export Behavior and Definition

Click here for an interactive walkthrough


  1. Select the Content Type Object where you wish to configure your Export Behavior.
    • You can configure an Export Behavior on a Content Model, Document Type, Content Category, or even on the Export Step of a Batch Process; the Content Model is the most common place to configure an Export Behavior
    For more information on Exporting and Export Behavior, click here
  2. Select the Behaviors property and click the ellipses at the end to being configuring.
  3. Within the Behaviors window, click the add Button and choose Export Behavior from the dropdown list.
  4. Next, configure your Export Definition; click the ellipses at the end of the property to begin.
  5. In the Export Definitions window, click the Add button and select the CMIS Export from the dropdown list.
  6. Select "CMIS Export".
  7. Select the hamburger icon at the end of the CMIS Repository property and drill down through the dropdown menu until you reach your SharePoint Repository.
  8. The Target Folder is defaulted to the root of the SharePoint library; to choose a specific sub-folder, click the ellipses and select a folder in the window that pops up.
  9. Choose the Object Type.
  10. Configure the Export Format.
    • Attached File is added by default. If you wish to export your files to your SharePoint in a different format, click the ellipses to configure.

The Export Activity

Click here for an interactive walkthrough


  1. Expand your Batch Process and select the Export Step.
    • If you configured your Export Behavior on a Content Type Object, you don't need to configure it on the Export Step of your Batch Process.
  2. Select the Activity Tester tab.
  3. Select your Batch, then select the first Document within your Batch.
  4. Click the "Submit Job" button.
    • IMPORTANT: You will need to have an Activity Processor installed and running in order to submit an Export job.
  5. Click OK on the Submit Job window.
  6. Your Export job will submit and complete.
  7. You will find your Documents within your SharePoint library.

See Also

For more information to use your CMIS Connection once its created, see the following articles:

Retrieved from "https://wiki.grooper.com/index.php?title=SharePoint_(CMIS_Binding)&oldid=28586"