Line of Business Integration
Summary
Very often SharePoint is used as the unique and central access point for all of the content and services related to a business, hence the name of the product. Thus, very often customers need to consume and access Line-of-Business (LOB) data and applications from within SharePoint, whether having custom metadata fields of list items and documents whose values are retrieved from external systems, whether using custom developed solutions that consume business data. In order to access and consume LOB data and systems from within SharePoint, you can leverage multiple techniques, which you can choose based on the kind of data sources that you need to consume, and on the physical architecture of your solution (i.e. SharePoint 2013/2016 on-premises or SharePoint Online). In this article you can find detailed information about the various LOB integration techniques that you can choose from.
High-level guideline/general rules
Here follow some high-level guidelines and general rules that you should consider whenever you need to integrate SharePoint with any LOB system:
- Try to consume REST-based APIs, rather than SOAP services or custom APIs, in order to being able to leverage modern development techniques and to use modern security protocols (OAuth 2.0, OpenID Connect, etc.).
- Use a data cache intermediary, instead of directly consuming any external service, so that you can speed up the consumption process and avoid useless network round trips to retrieve data that you already requested from the LOB system.
- Make your best to list data page by page, rather than listing all the data in "one huge shot", to avoid flooding the data cache and to overload the network bandwidth.
- From an Authentication and Authorization perspective, tend to use services that leverage well-known protocols like OAuth 2.0, OpenID Connect, etc. and which are possibly registered in Azure Active Directory, in order to share a unique security infrastructure.
Client-side Connection
Applies to: Office 365 | SharePoint Online | SharePoint 2016
Whenever you need to consume LOB systems from a client-side solution, like a client-side web part developed using SharePoint Framework, or a bunch of JavaScript code hosted in a Script Editor web part, you can consume a LOB system just using a REST API, eventually registered in Azure Active Directory. In this section you can find useful links to further information about this topic.
Articles
- Connect to API secured with Azure Active Directory
- Connect to Azure AD-secured APIs in SharePoint Framework solutions
- Consume enterprise APIs secured with Azure AD in SharePoint Framework
Samples
- Call custom Web API secured with AAD from SharePoint Framework client-side web part
- Azure Active Directory implicit flow authentication samples
- Call custom Web API secured with AAD from SharePoint Framework client-side web part using Angular v1.x
- Angular MS Graph web part Built with Angular v1.x
- Application Customizer GraphClient from Modern Team site
Videos
- Calling external APIs securely from SharePoint Framework
- Let's build with SharePoint (web parts, Extensions and much more)
Business Connectivity Services
Applies to: SharePoint Online | SharePoint 2013 | SharePoint 2016
Business Connectivity Services (BCS) is a service application of Microsoft SharePoint 2013/2016 and SharePoint Online. It provides capabilities to read and write data from external systems, such as line-of-business applications (LOB), web services, databases, or any other external source that offers a suitable connector. In SharePoint 2013/2016 on-premises the BCS can connect to a variety of LOB systems either using a DBMS connection-oriented approach, either using a SOAP service, or using a custom .NET library. In SharePoint Online the BCS can connect to an OData REST service, to a SOAP service, or to an Azure SQL Database. Moreover, in SharePoint Online, if compared with SharePoint on-premises, you don't have functionalities like External Data Search, Profile Pages, custom Actions, and Office client support.
Articles
- Business Connectivity Services in SharePoint
- Make an External List from a SQL Azure table with Business Connectivity Services and Secure Store
Videos
Hybrid - Connect to on-premises
Applies to: Office 365 | SharePoint Online
While consuming LOB systems, another option that you have is to create SharePoint Online solutions that leverage on-premises data through an hybrid topology. For example, you can create an Azure App Service that connects to an on-premises infrastructure and consumes a SQL Server database, or any other on-premises data repository, through an Hybrid Connection.
Note
This kind of solution architecture can have challenges with network latency. Due the direct hybrid connectivity, services in SharePoint Online would have a dependency on the on-premises services which is not optimal. It's recommended to have data cache intermediary in Azure side rather than connecting directly to the on-premises, even though technically this can be implemented relatively easily.
Articles
Videos
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for