Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Using the SharePoint Online component

Updated on April 6, 2022

Enable efficient usage of the data pages from the SharePoint Online (SPO) integration component by adding relevant data types to the Data Explorer of your application.

When you add a data type to your application definition, your application gains access to the data model of that data type. With that, you can use and run data pages from these data types in the context of your application.
Before you begin: Review the SharePoint interaction scenarios that you want to include in your business process, and then note the data types corresponding to the data pages that you plan to use. For more information about available SharePoint interactions, see the following articles:
  1. In the header of Dev Studio, click the name of the application, and then click Definition.
  2. On the Cases & data tab, in the text field of the Data section, enter the data type that you want to add to your Data Explorer, and then click Add.
    For example: For example, the following figure illustrates a scenario in which an application can use data pages responsible for creating, renaming, and deleting SharePoint list entities:
    SPO data types in the application definition
    SharePoint Online data types added to the appliation Data Explorer.
  3. Apply the changes to your application definition rule form by clicking Save.
What to do next: You can now use the data pages from the SPO integration component in your application to interact with various SharePoint entities. Depending on your business requirements, review the following articles about SharePoint interactions, and then configure the corresponding data pages and their parameters as required:
  • Interacting with list entities

    Make use of the list entity data pages to interact with your SharePoint lists directly from your Pega application. In addition to retrieving all or single lists, you can use these data pages to create, rename, and delete lists.

  • Interacting with field entities

    Make use of the field entity data pages to interact with fields in your SharePoint lists directly from your Pega application. You can use these data pages to retrieve fields and create list fields.

  • Interacting with list item entities

    Make use of the list item entity data pages to interact with items in your SharePoint lists directly from your Pega application. In addition to retrieving multiple or single list items, you can use these data pages to create, rename, and delete list items. Moreover, these data pages give you the ability to interact with attachments in list items.

  • Interacting with folder entities

    Make use of the folder entity data pages to interact with your SharePoint folders directly from your Pega application. In addition to creating, renaming, and deleting folders, you can use these data pages to retrieve folder metadata and information about folder items, properties, and fields.

  • Interacting with file entities

    Make use of the file entity data pages to interact with your SharePoint files directly from your Pega application. In addition to retrieving information about specific files, you can use these data pages to create and delete files. Moreover, you can check files in or out, as well as update their content.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us