Home > Get Started > Setup of AvePoint Cloud Index App in SharePoint Online Sites

Export to PDF

Setup of AvePoint Cloud Index App in SharePoint Online Sites

Site collection administrators can refer to the sections below to complete the setup in SharePoint Online sites.

Get the AvePoint Cloud Index App

Follow the steps below to get the AvePoint Cloud Index app.

  1. Sign in to AvePoint Online Services.

  2. Navigate to the AvePoint Cloud Index interface to download the AvePoint Cloud Index app file.

    • If this is the first time you are accessing AvePoint Cloud Index, or you have not configured Gateway Settings before, you will be brought to the Gateway Settings page directly. Click the download link to download the AvePoint Cloud Index app file.

    • If you have configured Gateway Settings, click the Settings (gear) button on the upper-right corner of the page and select Gateway Settings from the drop-down list to access the Gateway Settings page. Click the download link to download the AvePoint Cloud Index app file.

Create an App Catalog Site with the AvePoint Cloud Index App

Follow the steps below to create the App Catalog site.

  1. Sign in to Microsoft 365 with the SharePoint Admin account.

  2. Click the app launcher to select Admin in the Apps section to access the Admin Center.

  3. On the left pane, click Admin centers to expand it and select SharePoint to access SharePoint admin center.

  4. Click More features on the left pane, and click Open in the Apps section.

  5. On the Manage apps page, click Upload.

  6. Select the downloaded AvePoint Cloud Index app file and upload it.

  7. Once the app is successfully uploaded, the Enable app panel appears. In the App availability section on the Enable app panel, select a method from the following:

    • Only enable this app

    • Enable this app and add it to all sites

    *Note: If you select Only enable this app, you need to consent to the app when you Add the AvePoint Cloud Index App to a SharePoint Online Site. If you select Enable this app and add it to all sites, you can directly add the app to SharePoint Online sites.

    ![The "Enable app" panel.](/en/cloud-index-admin/get-started/images/image1.png "The "Enable app" panel.")

  8. Click Enable app.

  9. In the Approve access so this app works as designed panel, click Go to API access page.

  10. On the API access page, expand Pending requests and Organization-wide sections, select the AvePoint Cloud Index for M365 package, and click Approve.

  11. In the Approve access panel, click Approve. The table below lists the required permissions for your review.

Cloud Index FeatureAPI NamePermissionTypePurpose
General Settings > Permission Management > Trim permissions from the SharePoint site where the Cloud Index App Part resides on the SharePoint sideSharePointAllSites.Read(Read items in all site collections)DelegatedRetrieve information from all site collections to check if the current login user is the Site Administrator.
  1. On the authorization page, click Accept.

  2. The admin consent is successful and you can close the page.

Add the AvePoint Cloud Index App to a SharePoint Online Site

Follow the steps below to add the AvePoint Cloud Index app to SharePoint Online site pages.

  1. Log in to the SharePoint Online site where you want to add the AvePoint Cloud Index app with the site collection administrator account.

    *Note: The AvePoint Cloud Index app can only be deployed to Site pages. It is unsupported on pages of other types.

  2. Click the Settings (gear) button on the upper-right corner of the site page and select Site contents from the drop-down menu. The Site contents page appears.

  3. Click New > App, and the My apps page appears. Click From my organization on the left pane of the page.

  4. Click the AvePoint Cloud Index app and then click Trust It in the pop-up window to add the app.