Skip to main content

SharePoint List

  • Updated

Audience

This guide is for technical audiences with some knowledge of integration technologies and SharePoint List administrators who want to configure BRYTER integration with SharePoint List.

Please note that this is a premium feature which needs to be enabled by your dedicated Customer Success Manager. For further information, please reach out to your BRYTER Customer Success Manager or support@bryter.io. Additional pricing may apply.

With this integration, you can...

Use actions to scale document management solutions:

  • SharePoint lists provide a single source of truth — multiple users can update the information in a list, there’s no need to create versions of the same list.
  • Permissions can be applied to individual items in a list to avoid inadvertent updates to information or changes to formulas.
  • Sophisticated templates can be created to structure the data entry process. Prompts, dropdown lists, data validation can all be utilised to ensure data integrity.
  • Document management — how documents are created, reviewed, published, disposed of, or archived.

Before you start

Before using either the SharePoint List or SharePoint Folder integration, you must first register a SharePoint app and grant the app permission to access to the SharePoint API. This requires SharePoint administrator permissions that BRYTER does not have. Contact your organization’s SharePoint administrator before proceeding.

Your SharePoint administrator should follow the instructions in: Granting access using SharePoint App-Only (Microsoft), using the following information:

<AppPermissionRequests AllowAppOnlyPolicy="true"> 
<AppPermissionRequest Scope="http://sharepoint/content/sitecollection" Right="Write"/> 
</AppPermissionRequests>
  • Permission XML (Write permission instead of FullControl)

Known limitations

  1. SharePoint field types map to BRYTER input and output fields as follows:
    - SharePoint Number → BRYTER integer
    - SharePoint DateTime → BRYTER date, only for date part, time part will be sent blank
    - SharePoint attachment → BRYTER file upload, currently cannot be left blank on the UI, see parameter to disable this type
    All other SharePoint types will be mapped to a BRYTER text input field and their values will be sent unprocessed to SharePoint
  2. The List Item URL output is currently only usable for items in a publicly available list. The List Item URL output for protected items uses a shareable link that differs from the returned output.
  3. Attachments must be disabled using the attachments-enabled parameter when not used. Otherwise, this is a required action input.
  4. Specific fields like 'person' or 'lookup' are not supported.

The Admin Console

Configurations in Admin Console

This image illustrates the Admin Console’s Integrations page, where you can configure integrations installed in the Catalog.

Parameters

Name

Description

Example value
sharepoint-instance The base URL of the SharePoint instance, without the http:// prefix bryter.sharepoint.com
sharepoint-site The SharePoint Site that the list belongs to. You should take the value as it appears in the URL as whitespace in the site name is removed from the URL. So when a site appears as A Test Site on the website you should use ATestSite or atestsite as a value for sharepoint-site. custom-integrations-test
sharepoint-list-name The name of the SharePoint list. It is safest to use a list whose name contains only alpha-numerical characters and spaces. Other characters like – may be present in the name of a list shown on the website but will not be present in the URL. So Test-List on the website will become TestList in the URL. The parameter sharepoint-list-name should be configured to use the name shown on the website as configuration value so use Test-List and not TestList. Note that, that is exactly opposite to how sharepoint-root-folder for the SharepointFolder integration needs to be configured. integration-demo
attachments-enabled A flag to determine whether the list will require attached documents true

Secrets

Name

Description

Example value
client-id An authorized SharePoint app client ID 3740b26c-292b-4d9b-9b09-a59da251d18d
client-secret An authorized client secret FKb0KZPyu6vTOfh2QFeWOHaf03kWlX1JI3RyCzW4qmp=

Troubleshooting

Sharepoint integration error messages

Cause
500: Initialization error: Service Error: API (*.sharepoint.com) operation failure: 503 / 500: Configuration error: There was an error configuring the SharePoint * integration : 404 Not Found - Not found
500: Configuration error: There was an error configuring the SharePoint * integration : 404 Not Found - Not found Sitename wrong, Trying to access a site the app does not have xml permissions to do so
401 Unauthorized - API (*.sharepoint.com) operation not allowed: 403 / {"error":{"code":"-2147024891, System.UnauthorizedAccessException","message":{"lang":"en-US","value":"Access is denied. (Exception from HRESULT: 0x80070005 (E_ACCESSDENIED))"}}} App does not have any xml access

 

Sharepoint List integration error messages

Cause
All Actions (Configuration error: There was an error configuring the SharePoint List integration: 401 Unauthorized - API (camposcorp185.sharepoint.com) operation not allowed: 401 / {"error_description": "Unsupported security token."} Sharepoint Add-Ins not enabled, wrong client-id, wrong client-secret -> This probably means we should do another check on the token before proceeding. If you are sure that the credentials are correct, try the steps described above in order to enable CustomAppAuthentication

Related articles