Home > Configure Administration Settings > Settings in AvePoint Cloud Index
Export to PDFThe application administrator must configure the sections below to complete the settings.
Follow the steps below to configure the Gateway Settings to enable AvePoint Cloud Index to connect with your file systems or Azure File Storage.
If this is the first time you are accessing AvePoint Cloud Index, or you have not configured the gateway settings before, you will be brought to the Gateway Settings page directly. Otherwise, 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.
In the Gateway Service Settings section, configure the gateway service information.
Gateway Service URL – Enter the URL of the Gateway Service that you have configured in the AvePoint Cloud Index Gateway Admin.
Passphrase – Enter the passphrase that you have configured for the gateway service in the AvePoint Cloud Index Gateway Admin.
In the Domain Connections section, connect the domains of AvePoint Online Services tenants with the domain of SharePoint Online sites.
*Note: This feature is only available if you have configured the Microsoft 365 (All permissions) app profile in AvePoint Online Services > App management.
Click Load Existing Domains, all domains retrieved from the App profiles will be listed.
*Note: If your SharePoint domain name has been changed, the updated domain name will be retrieved after you click Load Existing Domains.
Select the checkboxes of the corresponding domains and click Add.
Each selected domain will be added as a domain connection and displayed in the Domain Connections table. You can click Delete (
) in the Action column to delete the domain connection.
Click Save to save your settings and exit the current page, or click Cancel to discard your settings without saving any changes.
Follow the steps below to configure the general settings.
Click the Settings (gear) button on the upper-right corner of the page and select General Settings from the drop-down list to access the General Settings page.
On the General Settings page, you can configure the domain mappings, user mappings, column settings, manage the App Part settings, permission management, and upload/download settings.
Domain Mapping – Manage the domain mappings, which map the domain for SharePoint Online to the domain of the local file system. Click Domain Mapping on the left pane.
Add Domain Mapping – Click Add Domain Mapping to create a domain mapping. Refer to Add Domain Mapping for details.
Edit a Domain Mapping – Click the Edit (pencil) button in the Action column to edit a certain domain mapping.
Delete a Domain Mapping – Click the Delete (bin) button in the Action column to delete a certain domain mapping.
User Mapping – Manage the user mappings, which map SharePoint Online users to your local AD users. Click User Mapping on the left pane.
Add User Mapping – Click Add User Mapping to create a user mapping. Refer to Add User Mapping for details.
Edit a User Mapping – Click the Edit (pencil) button in the Action column to edit a certain user mapping.
Delete a User Mapping – Click the Delete (bin) button in the Action column to delete a certain user mapping.
Column Settings – Choose the columns that you would like to show with the files in SharePoint Online.
Click Column Settings on the left pane, select the checkboxes of the columns that you want to show, select a number from the drop-down list next to the checkbox to adjust the display order of the columns, and click Save to save your settings, or click Cancel to discard your settings without saving any changes.
App Part Management – Manage the app part settings. Click the Delete (cross mark) button in the Action column to delete the app part settings, or select one or more app parts by selecting the checkboxes and click the Delete button to remove the app part settings for selected app parts. This deletion will only remove the app part settings of the selected app parts and will not remove the app parts.
Permission Management – This feature only works for AvePoint Cloud Index App on the SharePoint site. AvePoint Cloud Index provides the ability to trim permissions from the SharePoint site where the Cloud Index App Part resides. By selecting this option, Cloud Index will follow the SharePoint site permission to perform the Cloud Index App Part security trimming, and then users who have permissions to the SharePoint site can access the files and folders in the app part regardless of their permissions to the connected file system.
The following table shows the back-end permission mappings between SharePoint Online and Cloud Index when enabling this feature.
| Permissions in SharePoint Online | Permissions in Cloud Index |
|---|---|
| Add Items | Upload, New Folder |
| Edit Items | Edit |
| Delete Items | Delete |
| View Items | View, Download |
Follow the steps below to add a domain mapping.
On the Add Domain Mapping page, configure the basic settings first.
Name – Enter a name in the text box as the mapping name.
Description – Enter an optional description for the mapping.
Add the mapping rules for the domain mapping. A domain mapping can consist of multiple mapping rules.
Enter the domain name of the SharePoint Online sites environment in the Source Domain Name text box.
Enter the domain name of the local file system environment in the Destination Domain Name text box.
Click Add to add this mapping rule. Once added, it will be displayed in the table below. In the table, you can delete a certain mapping rule by clicking the Delete (bin) button in the Action column.
Repeat the steps from a to b to add more mapping rules.
Click Save to save your settings, or click Cancel to discard your settings without saving any changes.
Follow the steps below to add a user mapping.
In the General Settings pane, click User Mapping.
Configure the following basic settings.
Name – Enter a name in the text box as the mapping name.
Description – Enter an optional description for the mapping.
Choose one of the following methods to add mapping rules.
To add mapping rules in batch, click download a template, add mapping rules in the downloaded template, and click Upload Configured Mapping List to upload the configured template.
To manually add mapping rules, follow the steps below:
In the Source Username textbox, enter the username of a SharePoint Online user.
In the Destination Username textbox, enter the username of a local AD user.
Click Add to add this mapping rule. Once added, it will be displayed in the table below. In the table, you can delete a certain mapping rule by clicking the Delete (bin) button in the Action column.
Repeat the steps above to add more mapping rules.
Click Save to save your settings, or click Cancel to discard your settings without saving any changes.
Manage connections between AvePoint Cloud Index gateway service and your file systems or Azure File Storage.
Click the Settings (gear) button on the upper-right corner of the page and select Connections from the drop-down list to access the Connections page.
Follow the steps below to add a connection.
On the Add Connection page, configure the basic settings in the Basic Settings section.
Name – Enter a name in the text box as the connection name.
Description – Enter an optional description for the connection.
In the Connection Source Settings section, configure the data source information for accessing the source data.
Storage Type – Select the storage type (File System or Azure File Storage) from the drop-down list.
Access Options (for Azure File Storage only) – Choose an access option from the following:
Use Active Directory Domain Services or Microsoft Entra Domain Services to manage access
Manage access based on Azure role-based access control (Azure RBAC)
*Note: If you want to choose this option, you must create an app profile for Custom Azure app in AvePoint Online Services first. For details about creating an app profile for a custom Azure app, refer to Integration with AvePoint Online Services.
For the Azure File Storage type, if you choose the Manage access based on Azure role-based access control (Azure RBAC) option, you need to configure the following information:
Subscription – Select a subscription from the drop-down list.
Resource Group – Select a resource group from the drop-down list.
Storage Account – Select a storage account from the drop-down list.
File Share Name – Enter a file share name in the field.
Path – Enter the UNC path in the text box to specify the location where the documents will be displayed. The path can be any path in the same local area network where AvePoint Cloud Index Gateway Admin belongs.
A hidden folder named .apci will be created in this path to store the temp files when you upload a file or download multiple files.
Username – Enter the name of the user that has Full Control permission to the specified path. The username format is domain\username or username@domain.com.
Password – Enter the corresponding password.
In the General Settings section, choose a domain mapping from the drop-down list to map the domain of the SharePoint Online site to the domain of the UNC path. You can click New Domain Mapping from the drop-down list to create a new domain mapping and refer to Add Domain Mapping for details on how to create a domain mapping.
In the Advanced Settings section, choose whether or not to limit access to this connection.
Public – There are no limits to access this connection. Anyone who has at least Read permission to the SharePoint Online sites that have the AvePoint Cloud Index app added can view the connection.
Private – Only the specified users can view this connection. Enter the names of the Microsoft Entra ID users and groups who can view the connection. You can click Check Name to verify the username.
*Note: This option is only available if you have configured the Microsoft Entra ID app profile in the AvePoint Online Services > App management.
Click Save to save your settings, or click Cancel to discard your settings without saving any changes.
Audit Report can track how content is being used in your connections, such as document views, file uploads, renamed files, content edits or deletions, or folder creation. Knowing who is taking what action on which content in your connections can be critical in helping your organization fulfill its requirements.
Click the Settings (gear) button on the upper-right corner of the page and select Audit Report from the drop-down list to access the Audit Report page.
You can perform the following actions to achieve the audit report:
| Column Name | Description |
|---|---|
| User ID | The user account that performs the action. |
| Action | The action that has been taken by the user. |
| Path | The path of file/folder that has been taken action. |
| Action Time | The time when the action has been taken. |
| IP | The IP address of the user. |
| Action | Object |
|---|---|
| View | File |
| Edit | File |
| Upload | File |
| Download | File |
| Rename | File |
| Delete | File, Folder |
| Create Folder | Folder |
Deployment Manager provides you the ability to add the AvePoint Cloud Index App Part to multiple site pages and specify the connection for each App Part in batch.
*Note: Before deploying App parts in SharePoint sites, ensure your AvePoint Online Services tenant has an available app profile for Microsoft 365, and the SharePoint Online permissions have been granted to the app profile.
Click the Settings (gear) button on the upper-right corner of the page and select Deployment Manager from the drop-down list to access the App Part Batch Deployment page.
Follow the steps below to configure the settings for the batch deployment.
In the Deployment Settings section, configure the settings for the batch deployment of AvePoint Cloud Index App Part. You should download the template of the configuration file where you can configure the site pages to add AvePoint Cloud Index App Part, set the connection for each path, and even specify the relative path if necessary.
Download Template – Click Download Template to download the configuration file template to local. The download file is BatchDeploymentTemplate.csv.
Open the downloaded file and configure the site page information where you want to add AvePoint Cloud Index App Part. There are examples as references about how to add the configuration information. Please remove the examples before you customize your own information.
Site URL – Enter the full URL of the site where the page you want to add AvePoint Cloud Index App Part resides in.
Page URL – Enter the full URL of the page where you want to add the AvePoint Cloud Index App Part.
Name – Enter the name of the app part that you want to configure for the app part on this page.
Connection Name – Enter the name of the connection that you want to configure for the app part on this page. The connection must be an existing one.
Relative Path (Optional) – Enter a subdirectory name of the connection path. If you want to only display documents in a subset of a connection, you can detail the connection path down to a subfolder under it.
For example, if the connection path is \10.0.1.1\c$\US Technical Writing and the folder path you want to display in the App part is \10.0.1.1\c$\US Technical Writing\AvePoint Online Services\PDFs, you should enter AvePoint Online Services\PDFs in the text box.
You can add more entries in the configuration file for the batch deployment. After your configurations, save your changes and close the file.
*Note: Make sure the SharePoint site collection administrator has permission to all the sites configured in the file.
*Note: You cannot add multiple AvePoint Cloud Index App Parts to the same page. That means if you happen to add the same site page information more than once in the configuration file, the system will use the first entry for the deployment, and the duplicate entries will be excluded. The excluded duplicate entries will not be calculated into the Deployment Report.
Import Configuration File – Click Browse to choose the configuration file in the pop-up window and click OK in the pop-up window to import the file. The configuration filename will be populated in the text box.
Click Deploy to add the AvePoint Cloud Index App Part to the configured site pages with pre-configured connections. After executing the deployment, you can go to the Deployment Report page to view the details.
Deployment Report displays the history of deployment jobs that you have executed. Every entry indicates one deployment job that you have performed, and the following table lists the properties for every deployment job.
| Column Name | Description |
|---|---|
| Deployment Job ID | The ID of every deployment job. |
| Job Status | The status for every deployment job. There are two values:Completed – The deployment job has been completed regardless of the deployment status of the AvePoint Cloud Index App Part to the site pages.Failed – The deployment job failed, which means no deployment has been done. |
| Number of Deployed Site Pages | The total number of pages that will add the AvePoint Cloud Index App Part, the number of failed deployments, and the number of successful deployments. |
| Action | The actions you can take on the job record.View Details – View the detailed deployment status of every entry you configured in the deployment configuration file.Delete – Delete the deployment history from this view. |
On the View Details page of a deployment job, you can view the overview deployment statuses of the entries configured in the deployment configuration file on the top of this page. In the table below, you can view the detailed deployment information for every entry.
| Column Name | Description |
|---|---|
| Page URL | The URL of the page where the AvePoint Cloud Index App Part was added. |
| Deployment Status | The deployment status for this entry. There are three statuses:Successful – AvePoint Cloud Index App Part has been added to the site page successfully, and its connection has been configured properly.Partially Successful – AvePoint Cloud Index App Part has been added to the site page successfully, but its connection configuration failed. The detailed reason can be found in the Comments column.Failed – It failed to add AvePoint Cloud Index App Part to the site page. The detailed reason can be found in the Comments column. |
| Comments | The detailed reason if there is an issue for the deployment. |
| Action | The actions you can take on the deployment record.Delete – Delete the deployment history for this entry. |
Background Migration allows you to migrate data to the SharePoint site where your app part resides during a large migration, and you can access your files in the app part in Microsoft 365.
Background Migration is integrated with Fly Server to perform the migration jobs. Currently, the recommended version of Fly Server to work together with Background Migration is 4.0.0.4077. Before configuring the migration settings, you must install Fly Server to build up the Fly Server environment. Refer to the Fly Server Installation Guide for the details on the installation.
After preparing the Fly Server environment, follow the steps below to configure the migration settings and perform migration jobs.
Complete the steps below to connect to the Fly Server Manager.
*Note: This page only appears the first time you enable the integration with Fly Server. After completing the integration settings, this page will not appear.
Click the Settings (gear) button on the upper-right corner of the page and select Background Migration from the drop-down list to access the Migration Settings page.
Enter the URL of Fly Server Manager in the first text box. It is the URL which you use to log into Fly Server Manager.
Enter the Fly Server API Key in the second text box. You can find the Fly Server API Key by accessing Fly Server Manager and navigating to Management > General Settings > API Keys.
Click Connect.
Complete the steps below to configure the migration settings.
Click the Settings (gear) button on the upper-right corner of the page and select Background Migration from the drop-down list to access the Migration Settings page.
On the Migration Settings page, configure the following information in the Basic Settings section.
Destination SharePoint Library NamingConvention – Choose the way to define the name of the destination library where you want to migrate file system data.
Use the root folder name as the library name – Use the root folder name of the file system connection as the destination library name.
Use the App Part name as the library name – Use the App Part name as the destination library name.
Customize a library name – Define a custom name for the destination library. Enter a name for the library in the text box. If the entered name is an existing library, the file system data will be migrated to the existing library directly.
Display Library in Navigation – Choose whether or not to display the destination library in site navigation. Select the Show the library in site navigation checkbox to display it.
Make App Part as Read Only – You can choose to make the app part as read-only in order to ensure data accuracy or follow your migration policy.
When the migration starts – Make the App Part as read-only when the migration starts, which means you cannot manage files in the App Part side when the migration starts.
When the migration ends – Make the App Part as read-only when the migration ends, which means you cannot manage files in the App Part side after the migration ends.
None – The App Part is always active during the migration, and you can manage files on the App Part side.
Maximum number of Jobs in Parallel – Choose the maximum number of migration jobs that can be run at the same time. Select a number from the drop-down list.
Migration Policy – Choose a migration policy from the drop-down list. Migration policy includes conflict resolutions, filters, mappings, and advanced migration options. You can go to Fly Server Manager to customize your own migration policy, and the customized policies can be loaded in this drop-down list.
*Note: AvePoint recommends you configure a Folder level filter in your filter policy to exclude the hidden .apci folder for the migration. .apci folder is a hidden folder which resides in the root folder of the connection path, and it is best not to migrate this folder to the destination SharePoint library. The configuration of this Folder level filter in Fly Server can be Name + Does Not Equal + .apci.
In the Account Settings section, configure the user information which will be used to run the migration.
App Profile – Choose an app profile from the drop-down list. The app profile is used to connect to the Microsoft 365 API with a Microsoft Entra ID app. With a Microsoft Entra ID app, API calls will be less throttled. The app profile is configured in Fly Server Manager, you can go to Fly Server Manager to add app profiles, and the added app profiles can be loaded in this drop-down list.
Microsoft 365 GlobalAdministrator – Configure the user to perform the migration jobs. The user must be the Microsoft 365 Global Administrator. Click the Modify button, the Configure page appears. Enter the username and corresponding password in the text boxes, and click Save.
In the Active Runtime Settings section, configure and manage the time range to run the migration jobs. All the active runtime is displayed in the table. You can click the Delete (bin) button to remove the runtime. You can click Add Active Runtime to add new active time, and configure the following information in the Add Active Runtime window.
Choose the days to run the migration – Click the corresponding checkboxes to select the days that you want to run migration jobs.
Choose the time range – Configure the exact time that you want to run the migration jobs.
Whole Day – The active time range will be a whole day.
From … To … – Select the time from the drop-down list to define the active time range to run the migration jobs. Select the Next Day checkbox if you set the end time for the next calendar day.
Click Add to add the runtime and repeat the procedures in this step to add additional runtime.
Click Save to save all your configurations, or click Reset to clear your settings.
The Migration page displays all of the app parts in a table. Click the Settings (gear) button on the upper-right corner of the page and select Background Migration from the drop-down list, and click Migration on the left pane to access the Migration page. The table displays the following information regarding the app parts and their migration jobs.
Additionally, you can perform actions on an individual app part in the Actions column, and you can also perform the following actions on app parts in batch.
AvePoint Cloud Index provides you with a centralized interface to manage all of the files in different connections.
Click the Manage Files (file) button on the upper-right corner of the page to access the Manage Files page. All of the configured connections will be displayed on the left pane. You can perform the following actions in every connection: Upload, Download, Create Folder, View, Edit, Rename, Delete, Copy UNC Path, and Search. For details on how to use these actions, refer to AvePoint Cloud Index User Guide.