How to Design SharePoint Power Apps with Database-Like Connectivity



This article shows how to gain real-time, database-like connectivity from mobile and tablet Power Apps.

Microsoft Power Apps provides a drag and drop interface, underpinned by a rich set of formulas, for generating mobile and tablet apps that are connected to data. The CData API Server extends Power Apps with connectivity to remote data sources, without a need to maintain a separate copy of the data in the Power Apps Common Data Service. The CData API Server provides database-like connectivity for SharePoint, augmenting the functionality of SaaS APIs and NoSQL databases with an in-memory SQL-92 engine.

The CData API Server also supports the Swagger metadata standard, whose UI-generation and code-generation possibilities are utilized across Azure App Service, Power Automate, and Power Apps. With Swagger, Power Apps generates a complete set of formulas for working with SharePoint -- this article shows how to use these formulas to connect your PowerApp to remote SharePoint data.

About SharePoint Data Integration

Accessing and integrating live data from SharePoint has never been easier with CData. Customers rely on CData connectivity to:

  • Access data from a wide range of SharePoint versions, including Windows SharePoint Services 3.0, Microsoft Office SharePoint Server 2007 and above, and SharePoint Online.
  • Access all of SharePoint thanks to support for Hidden and Lookup columns.
  • Recursively scan folders to create a relational model of all SharePoint data.
  • Use SQL stored procedures to upload and download documents and attachments.

Most customers rely on CData solutions to integrate SharePoint data into their database or data warehouse, while others integrate their SharePoint data with preferred data tools, like Power BI, Tableau, or Excel.

For more information on how customers are solving problems with CData's SharePoint solutions, refer to our blog: Drivers in Focus: Collaboration Tools.


Getting Started


Set Up the API Server

If you have not already done so, download the CData API Server. Once you have installed the API Server, follow the steps below to begin producing secure SharePoint OData services:

Connect to SharePoint

To work with SharePoint data from Microsoft Power Apps, we start by creating and configuring a SharePoint connection. Follow the steps below to configure the API Server to connect to SharePoint data:

  1. First, navigate to the Connections page.
  2. Click Add Connection and then search for and select the SharePoint connection.
  3. Enter the necessary authentication properties to connect to SharePoint.

    Set the URL property to the base SharePoint site or to a sub-site. This allows you to query any lists and other SharePoint entities defined for the site or sub-site.

    The User and Password properties, under the Authentication section, must be set to valid SharePoint user credentials when using SharePoint On-Premise.

    If you are connecting to SharePoint Online, set the SharePointEdition to SHAREPOINTONLINE along with the User and Password connection string properties. For more details on connecting to SharePoint Online, see the "Getting Started" chapter of the help documentation

  4. After configuring the connection, click Save & Test to confirm a successful connection.

Configure API Server Users

Next, create a user to access your SharePoint data through the API Server. You can add and configure users on the Users page. Follow the steps below to configure and create a user:

  1. On the Users page, click Add User to open the Add User dialog.
  2. Next, set the Role, Username, and Privileges properties and then click Add User.
  3. An Authtoken is then generated for the user. You can find the Authtoken and other information for each user on the Users page:

Creating API Endpoints for SharePoint

Having created a user, you are ready to create API endpoints for the SharePoint tables:

  1. First, navigate to the API page and then click Add Table .
  2. Select the connection you wish to access and click Next.
  3. With the connection selected, create endpoints by selecting each table and then clicking Confirm.

Gather the OData Url

Having configured a connection to SharePoint data, created a user, and added resources to the API Server, you now have an easily accessible REST API based on the OData protocol for those resources. From the API page in API Server, you can view and copy the API Endpoints for the API:

Retrieve the Swagger Metadata

You will use the metadata to create a Custom API connection. You can obtain the Swagger definition by making the following request in your browser and then saving the resulting JSON file:

http://MySite:MyPort/api.rsc/$oas?version=2

Connect to API Server in Power Apps

The following procedure shows how to create a simple app that searches remote SharePoint data.

  1. In Microsoft Power Apps, click Custom connectors.
  2. Click Create custom connector and choose Import an OpenAPI file.
  3. Name the connector, browse to the JSON file, and click Continue.
  4. Fill in the relevant General information, ensure that Base URL is of the form /api.rsc/@myauthtoken (where myauthtoken is the AuthToken for a configure API Server user), and click Continue.
  5. Select No authentication for the Authentication type. Click Continue.
  6. Review the Action and Reference definitions and click Create connector.
  7. To test the connector, you will need to create a new connection. Click Test, click New Connection under Connections, and click Create.
  8. Navigate back to the connector from the Custom connectors menu and click Test. From here, you can test the available operations.

Connect SharePoint to a Power App

Follow the steps below to connect to SharePoint from a Power App:

  1. From the Power Apps main menu, click Create an app and select the on-premises or cloud Power Apps Studio.
  2. Select a blank app (choose Phone layout or Tablet layout).
  3. In the View tab, click Data Sources and click Add data source.
  4. Click the Connection you created to test the connector.

Populate a Gallery

Follow the steps below to create a simple app that can search SharePoint data. You will use Power Apps formulas to bind SharePoint rows to rows in a gallery control.

  1. In the View tab, click Gallery -> Vertical to add a Gallery.

  2. After selecting a gallery, assign the Items property of the gallery to SharePoint data on the Advanced tab of the gallery settings. The formula below will allow you to access columns in the MyCustomList table.

    ForAll(CDataSwaggerAPI.getAllMyCustomList().value, {myName: Name, myRevenue: Revenue})
  3. Assign SharePoint columns to UI elements by clicking the element and then setting the Text property (on the Advanced tab of the UI element) to ThisItem.myName or ThisItem.myRevenue.

Search SharePoint Data

To filter the records displayed by the gallery, add a TextInput to your Screen, clear the Text property for the TextInput, and set the Items property of the gallery to a formula like the one below, replacing TextInput1 with the name of the TextInput control in your gallery, if necessary:

If(IsBlank(TextInput1.Text),
  ForAll(CDataSwaggerAPI.getAllMyCustomList().value, {myName: Name, myRevenue: Revenue}),
  ForAll(CDataSwaggerAPI.getAllMyCustomList({'$filter':Concatenate("contains(Name,",TextInput1.Text,")")}).value, {myName: Name, myRevenue: Revenue}))

The formula builds an OData query that the API Server executes against the remote SharePoint data, ensuring that the search is run against the current data without first pulling in every record into the app. You can find more information on the supported OData in the API Server help documentation.

Edit SharePoint Data

Follow the steps below to load an editable screen that shows the fields of the SharePoint record selected in the gallery.

  1. On the Insert tab, click New Screen->Blank and name the screen "Details".
  2. Tie the gallery to the new screen: Select the arrow button in the first entry of the gallery and in the OnSelect field in the Advanced properties, enter the following:
    Navigate( Details, None )
  3. In the Details screen, from the Insert tab, add a label "Id" and another label for the Id value. Set the Text property to BrowseGallery.Selected.Id

For each column you will need to do the following. Note that for Custom APIs form elements cannot detect which requests need to be formulated to the API Server, so you will need to write the data modification formulas manually.

  1. Add a label for the field.
  2. Add a text input from the Text menu to the screen and set the text property to the value from the selected item from the gallery (i.e.: BrowseGallery.Selected.myName).

To give your app basic update functionality and navigation, add Submit and Back buttons:

  1. For the Submit button, set the OnChange property to the following:
    CDataSwaggerAPI.updateMyCustomList(BrowseGallery.Selected.myId,BrowseGallery.Selected.myId,{Name:TextInput1.Text,Revenue:TextInput2.Text})
  2. For the Back button, set the OnSelect field to the following:
    Navigate( BrowseScreen, None )

Your mobile or tablet app can now browse, search, and update SharePoint data.

Ready to get started?

Learn more or sign up for a free trial:

CData API Server