netDocShare Sync Admin app User Guide

netDocShare Sync Admin app User Guide



A blue text on a black background

Description automatically generated





netDocShare Sync Admin app 

User Guide – Web and Desktop




Login

A screenshot of a computerDescription automatically generated

Please enter your Email ID. This information is required to validate your access and ensure proper licensing.

A screenshot of a computerDescription automatically generated



SharePoint

Before creating any sync jobs, the Global Admin must add the SharePoint Connection settings.

Users will not be able to create new sync jobs if Connection settings are not created

Generate Client ID and Client Secret. Please look at the respective documentation.

Connection Settings – SharePoint OnPrem

SharePoint

+ Add 

Click this button and a modal popup will appear
Fill in the following details

A screenshot of a computerDescription automatically generated

Tenant details 

SharePoint Tenant - Enter the SharePoint Tenant Name

Tenant URL- Enter the Tenant URL

Username: Enter the Username

Password: Enter the Password

Click on Connect to establish SharePoint connection with the details

Connection Settings – SharePoint Online

SharePoint

+ Add 

Click this button and a modal popup will appear

A screenshot of a computerDescription automatically generated

Tenant details 

Fill in the following details

SharePoint Tenant - Enter the SharePoint Tenant Name

Tenant URL -Enter the Tenant URL

Client ID- Enter Client ID 

Client Secret- Enter Client Secret 

(Additional steps for acquiring the generate the Client ID and Client Secret ID details can be found within the "Click here” link in the modal)

Click on Connect to establish SharePoint connection with the details 

To modify the Connection Settings details
  1. Edit icon – the tenant
  2. Delete icon – Delete the tenant
Users can later Edit or Delete the SharePoint connection settings if desired. However, the Delete button will appear disabled if any User has created one or more sync jobs for the respective connection setting.
User can also 
  1. Download Template (Downloads template file for creating multiple SharePoint connections)
  2. Bulk Upload (Upload a filled-out template file)

Please note that for detailed instructions, refer to the Pre-Requisite and Installation guide.

A screenshot of a computerDescription automatically generated


SharePoint and NetDocuments Sync

SharePoint and NetDocuments can be synchronized to allow users to seamlessly manage files and folders across both platforms. Users can sync files and folders in real time, ensuring that any change such as File updates, renaming, deleting, or adding new files/folder are immediately reflected in both systems. This integration enhances collaboration and ensures that users always have access to the latest versions of their documents.

A screenshot of a computerDescription automatically generated

Sync Admin/Global Admin Users can create the following sync job types in the netDocShare Sync Admin Portal:

  1. SharePoint to NetDocuments
  2. NetDocuments to SharePoint
  3. Bi-Directional (SharePoint - NetDocuments)

Sync Features

Sync Frequency

The sync frequency interval is crucial for optimizing performance and ensuring timely syncing of the updates.

The minimum value should be 30 sec

Copy Metadata Columns

  1. Sync Job Creation process if User Select the Copy metadata values as yes and mapping the columns 
Custom column mapping values are synchronized along with Documents in SharePoint and NetDocuments based on the sync type
If there are any changes in metadata values, they should be synchronized at specified frequency intervals in SharePoint and NetDocuments based on the sync type
Note: Only text, number, note, and Date Time data type columns are supported


Move Files

Move File – This feature is only applicable for the SharePoint to NetDocuments sync process. This option will permanently move a document or folder from SharePoint to NetDocuments  based on the selected Move options

  1. Move File – Replace Link as Yes

After the move, the file is removed from SharePoint and replaced with the NetDocuments file link

  1. Move File – Replace Link as No

After the move, the file is removed from the SharePoint location and effectively moved to the NetDocuments location

Update Date Time Stamp

  1. Sync Job Creation process if User Select the Update time stamp as yes 

The value of SharePoint documents created by users should sync to the NetDocuments Created By, Created, Modified By and Modified properties if the SharePoint documents are created by users who have access to the NetDocuments source. Otherwise, the NetDocuments service user account will be captured in the Created by and Modified By properties

The value of SharePoint documents Created and Modified values should sync to the NetDocuments Created and Date modified properties values if user select the Update time stamp as Yes

  1. Sync Job Creation process if User Select the Update time stamp as No

NetDocuments service user account will be captured in the  Created by and Modified By properties The NetDocuments Created and Date Modified property values should be captured as the syncing file date

Copy Doc links

  1. Copy Doc Links – This feature is only applicable for the NetDocuments to SharePoint sync process. It syncs the NetDocuments document links instead of the actual NetDocuments documents

Apply Permissions:

  1. If the permission option is set to "Yes", the destination will inherit all permissions from the source. This includes Users and Groups along with their assigned access levels, ensuring consistent permission settings between the source and destination.
  2. If the permission option is set to "No", the destination will not inherit any permissions from the source. Instead, default permissions configured at the destination will apply. For items at the source without specific Users or Groups assigned, those items will adhere to the default access rules defined at the destination.


Delete Sync

  1. This feature is crucial for document management, helping to prevent discrepancies between SharePoint and NetDocuments synced documents and folders, and ensuring that deleted items remain inaccessible in other synced locations. If a user deletes files or folders from the source, they are automatically deleted from the synced destination location

Rename Sync

  1. The process of changing the name of a file/folder in SharePoint/NetDocuments location and ensuring that this change is reflected across all synchronized location

Check-in and Check-out sync

  1. Check-in and Check-out states are essential for maintaining documents, especially in collaborative environments where multiple users interact with shared documents.
  2. Synchronization reflects the current checkout status of the file

Create Job –Bidirectional (SharePoint-NetDocuments)

Click “Create Job” on the left side panel or Click Add on Right Side Panel

The Create Job Page will be displayed

The following fields are displayed on the Create job page: 

  1. Select the Sync Type as Bidirectional (SharePoint-NetDocuments)
  2. Sync Frequency (hours:minutes:seconds)-Default value set as 30 seconds
  3. Copy Metadata Columns-Default is selected as No
  4. Apply Permissions -Default is selected as No
  5. Update Date Time Stamp-Default is selected as No
  6. Under the SharePoint section, select the SharePoint tenant.
  7. Enter the SharePoint Site
  8. Select the Document library 
  9. Folders and documents are displayed under the SharePoint section.
  10. Select All checkbox and the New Folder Creation icon displayed under the SharePoint section.
  11. Select all the files/folders or select any folders or files from the SharePoint section.
  12. Under the NetDocuments section, users select the Cabinet.
  13. Select the  workspace.
  14. Select the All checkbox displayed under the NetDocuments section.
  15. Users can click on any workspace folder.
  16. New Folder Creation icon is displayed under the NetDocuments section.
  17. Click the New Folder icon, and the user will be able to create the folder.
  18. Select all the files/folders or any folders or files from the NetDocumnets section.
  19. Click Save.
  20. Bi-directional (SharePoint - NetDocuments) sync job is created.



A screenshot of a computerDescription automatically generated

Scheduled Jobs

Once the sync job is created and a success message is displayed, the page should redirect to the Scheduled Job screen, where the Sync/Global admin user can create, edit, and delete existing jobs.

A screenshot of a computerDescription automatically generated


Filter: Use the 'Filter' option to narrow down the displayed sync jobs based on specific criteria.
Refresh: Click 'Refresh' to update the view with the latest job  and Sync Job Status information.
Select Job Type Dropdown: Choose the sync job type from the dropdown options: SharePoint, OneDrive, Microsoft Teams, Move NetDocuments, or Copy NetDocuments.
SharePoint: Select 'SharePoint' - SharePoint related sync jobs are displayed.
OneDrive: Select 'OneDrive' - OneDrive related sync jobs are displayed
Microsoft Teams: Select Microsoft Teams’ Teams related sync jobs are displayed
Move NetDocuments: Select 'Move NetDocuments'-Move Jobs are displayed
Copy NetDocuments: Select 'Copy NetDocuments' - Copy Related jobs are displayed


Users are able to view, edit, copy and delete Sync info: Users can view, edit, copy, and delete sync job information as needed."

The user can also stop the scheduled sync job: Users can stop any scheduled sync job from running.



Microsoft Teams

Before creating any sync jobs, the Global Admin must add the Teams Connection settings.

Users will not be able to create new sync jobs if Connection settings are not created

+ Add 

Click this button and a modal popup will appear
Fill in the following fields

A screenshot of a computerDescription automatically generated

Tenant Detail
Teams Tenant: Enter the Teams Tenant Name
Tenant Id: Generate the Tenant Id using Azure App Registration Service
Client ID: Enter Client ID
Client Secret: Enter Client Secret
(Additional steps for acquiring the Client details can be found within the ”Click here” link in the modal)
Click on Connect to establish Teams connection with the details 
  1. To modify the tenant details
  2. Edit icon – the tenant

Delete icon – Delete the tenant

User can also:

Download Template (Downloads template file for creating multiple connections)
Bulk Upload (Upload a filled-out template file)

A screenshot of a computerDescription automatically generated


Teams and NetDocuments Sync 

Teams and NetDocuments can be synchronized to allow users to seamlessly manage files and folders across both platforms. Users can sync files and folders in real time, ensuring that any change such as File updates, renaming, deleting, or adding new files/folder are immediately reflected in both systems. This integration enhances collaboration and ensures that users always have access to the latest versions of their documents.

Sync Admin/Global Admin Users can create the following sync job types in the netDocSync Admin Portal:

Sync Type

Bi-directional (Teams to NetDocuments)
NetDocuments to Teams
Teams to NetDocuments

Sync Features

Sync Frequency

The sync frequency interval is crucial for optimizing performance and ensuring timely syncing of the updates.

The minimum value should be 30 sec

Copy Metadata Columns

  1. Sync Job Creation process if User Select the Copy metadata values as yes and mapping the columns  

Custom column mapping values are synchronized along with Documents in Teams and NetDocuments based on the sync type

If there are any changes in metadata values, they should be synchronized at specified frequency intervals in Teams and NetDocuments based on the sync type

Note: Only text, number, note, and Date Time data type columns are supported

Move Files

Move File – This feature is only applicable for the Teams to NetDocuments sync process. This option will permanently move a document or folder from Teams to NetDocuments based on the selected Move options

  1. Move File – Replace Link as Yes

After the move, the file is removed from Teams and replaced with the NetDocuments file link

  1. Move File – Replace Link as No

After the move, the file is removed from the Teams location and effectively moved to the NetDocuments location

Update Date Time Stamp

  1. Sync Job Creation process if User Select the Update time stamp as yes  

The value of Teams documents created by users should sync to the NetDocuments Created By and Modified By properties if the Teams documents are created by users who have access to the NetDocuments source. Otherwise, the NetDocuments service user account will be captured in the Created By and Modified By properties

The value of Teams documents created and Modified values should sync to the NetDocuments Created and Date modified properties values if user select the Update time stamp as Yes 

  1. Sync Job Creation process if User Select the Update time stamp as No

NetDocuments service user account will be captured in the Created By and Modified By properties The NetDocuments Created and Date Modified property values should be captured as the syncing file date 

Copy Doc Links – This feature is only applicable for the NetDocuments to Teams sync process. It syncs the NetDocuments document links instead of the actual NetDocuments documents

Delete Sync

This feature is crucial for document management, helping to prevent discrepancies between Teams and NetDocuments synced documents and folders, and ensuring that deleted items remain inaccessible in other synced locations. If a user deletes files or folders from the source, they are automatically deleted from the synced destination location

Rename Sync

The process of changing the name of a file/folder in Teams/NetDocuments location and ensuring that this change is reflected across all synchronized location

Check-in and Check-out sync

Check-in and Check-out states are essential for maintaining documents, especially in collaborative environments where multiple users interact with shared documents.

Synchronization reflects the current checkout status of the file

A screenshot of a computerDescription automatically generated

Create Job –Bidirectional (Teams-NetDocuments)

Click “Create Job” on the left side panel or Click Add on Right Side Panel

The Create Job Page will be displayed

How to Create a Teams-NetDocuments Bi-directional Sync Job

  1. Sync Type-Select sync type as Bidirectional (Teams – NetDocuments)
  2. Sync Frequency (hours: minutes:seconds)-Default value set as 30 seconds
  3. Copy Metadata Columns-Default is selected as No
  4. Update Date Time Stamp-Default is selected as No
  5. Apply Permission as No
  6. Select the Tenant under Microsoft Teams Location
  7. Select the Team
  8. All the Channel are displayed
  9. Select all the Channel
  10. Under the NetDocuments section, users select the Cabinet. 
  11. Select the workspace. 
  12. Select the All checkbox displayed under the NetDocuments section. 
  13. Users can click on any folder.
  14. Select all the files/folders or select any folders or files from the NetDocuments section. 
  15. Click Save


Scheduled Job

A screenshot of a computerDescription automatically generated




OneDrive

Before creating any sync jobs, the Global Admin must add the OneDrive Connection settings.

Users will not be able to create new sync jobs if Connection settings are not created

A screenshot of a computerDescription automatically generated

+ Add 

Click this button and a modal popup will appear
Fill in the following fields

A screenshot of a computerDescription automatically generated

OneDrive Tenant - Enter the OneDrive Tenant Name

Tenant ID- Generate the Tenant Id using Azure App Registration Service 

Client ID- Enter Client ID 

Client Secret- Enter Client Secret 

(Additional steps for acquiring the generate the Client ID and Client Secret ID details can be found within the "Click here” link in the modal)

Click on Connect to establish OneDrive connection with the details 


To modify the Connection Settings details
  1. Edit icon – the tenant
  2. Delete icon – Delete the tenant
Users can later Edit or Delete the OneDrive connection settings if desired. However, the Delete button will appear disabled if any User has created one or more sync jobs for the respective connection setting.
User can also 
  1. Download Template (Downloads template file for creating multiple OneDrive connections)
  2. Bulk Upload (Upload a filled-out template file)


A screenshot of a computerDescription automatically generated



OneDrive and NetDocuments Sync 

OneDrive and NetDocuments can be synchronized to allow users to seamlessly manage files and folders across both platforms. Users can sync files and folders in real time, ensuring that any change such as File updates, renaming, deleting, or adding new files/folder are immediately reflected in both systems. This integration enhances collaboration and ensures that users always have access to the latest versions of their documents.

Sync Admin/Global Admin Users can create the following sync job types in the NetDocShare Sync Admin Portal:

  1. OneDrive to NetDocuments
  2. NetDocuments to OneDrive
  3. Bi-Directional (OneDrive - NetDocuments)


Sync Features

Sync Frequency

The sync frequency interval is crucial for optimizing performance and ensuring timely syncing of the updates.

The minimum value should be 30 sec

Copy Metadata Columns

  1. Sync Job Creation process if User Select the Copy metadata values as yes and mapping the columns 

Custom column mapping values are synchronized along with Documents in OneDrive and NetDocumnets based on the sync type

If there are any changes in metadata values, they should be synchronized at specified frequency intervals in OneDrive and NetDocuments based on the sync type

Note: Only text, number, note, and Date Time data type columns are supported

Move Files

Move File – This feature is only applicable for the OneDrive to NetDocuments sync process. This option will permanently move a document or folder from OneDrive to NetDocuments based on the selected Move options

  1. Move File – Replace Link as Yes

After the move, the file is removed from OneDrive and replaced with the NetDocuments file link

  1. Move File – Replace Link as No

After the move, the file is removed from the OneDrive location and effectively moved to the NetDocuments location

Update Date Time Stamp

  1. Sync Job Creation process if User Select the Update time stamp as yes 

The value of OneDrive documents created by users should sync to the NetDocuments Created by and Modified By properties if the OneDrive documents are created by users who have access to the NetDocuments source. Otherwise, the NetDocuments service user account will be captured in the Created By and Modified By  properties

The value of OneDrive documents created and Modified values should sync to the NetDocuments Created and Date modified properties values if user select the Update time stamp as Yes


  1. Sync Job Creation process if User Select the Update time stamp as No

NetDocuments service user account will be captured in the  Created By and Modified By properties The NetDocuments Created and Date Modified property values should be captured as the syncing file date

Copy Doc Links – This feature is only applicable for the NetDocuments to OneDrive sync process. It syncs the NetDocuments  document links instead of the actual NetDocuments documents

Delete Sync

This feature is crucial for document management, helping to prevent discrepancies between OneDrive and NetDocuments  synced documents and folders, and ensuring that deleted items remain inaccessible in other synced locations. If a user deletes files or folders from the source, they are automatically deleted from the synced destination location

Rename Sync

The process of changing the name of a file/folder in OneDrive/NetDocuments location and ensuring that this change is reflected across all synchronized location

Check-in and Check-out sync

Check-in and Check-out states are essential for maintaining documents, especially in collaborative environments where multiple users interact with shared documents.

Synchronization reflects the current checkout status of the file

Create Job –Bidirectional (OneDrive-NetDocuments)

Click “Create Job” on the left side panel or Click Add on Right Side Panel

The Create Job Page will be displayed

The following fields are displayed on the Create job page:

  1. Sync Type- Select the Sync Type as Bidirectional (OneDrive-NetDocuments) 
  2. Sync Frequency (hours:minutes:seconds)-Default value set as 30 seconds
  3. Copy Metadata Columns-Default is selected as No
  4. Move File -Default is selected as No
  5. Update Date Time Stamp-Default is selected as No
  6. Under the OneDrive section, select the OneDrive tenant.
  7. Enter the OneDrive user email address.
  8. Click the Connect button.
  9. The relevant user’s folders and documents are displayed under the OneDrive section.
  10. Select t All checkbox and the New Folder Creation icon displayed under the OneDrive section.
  11. Users can click on any folder or select all the folders and files.
  12. Select all the files/folders or select any folders or files from the OneDrive section.
  13. Under the NetDocuments section, users select the Cabinet
  14. Select the workspace.
  15. Select the All checkbox displayed under the NetDocuments  section.
  16. Users can click on any workspace folder 
  17. New Folder Creation icon is displayed under the NetDocuments section.
  18. Click the New Folder icon, and the user will be able to create the  NetDocuments workspace folder.
  19. Select all the files/folders or select any folders or files from the NetDocuments section.
  20. Click Start Save.
  21. Bi-directional (OneDrive - NetDocuments) sync job is created



A screenshot of a computerDescription automatically generated



Scheduled Job

Once the sync job is created and a success message is displayed, the page should redirect to the Scheduled Job screen, where the Sync/Global admin user can create, edit, and delete existing jobs.

A screenshot of a computerDescription automatically generated


Copy NetDocuments 


As a user can copy a single document or multiple documents or folders from one NetDocuments Cabinet location to another Other Cabinet Location or Same Cabinet Location

Select the Sync type as Copy NetDocuments to NetDocuments

Select the Source location Cabinet

Select the Workspace from Source location

Select the Files and folder

Select the destination folder where you want to copy the document or folder.

Click Save

The document is copied to the new location.

A screenshot of a computerDescription automatically generated


Move NetDocuments 


As a user can Move a single document or multiple documents or folders from one NetDocuments location to another on NetDocuments Location

Select the Sync type as Move NetDocuments to NetDocuments

Select the Source location Cabinet

Select the Workspace from Source location

Select the Files and folder

Select the destination folder where you want to Move the document or folder.

Click Save

Document is moved to the new location.


A screenshot of a computerDescription automatically generated


NetDocuments Settings

A screenshot of a computerDescription automatically generated

Users – Global Admin, (ask for Client ID and Client Secret from respective System Admins).

SSO– Enable or Disable the SSO Login

NetDocuments Repository Id- Entered the NetDocuments Repository Id

Microsoft Client ID – Enter the Microsoft client Id

Microsoft Secret Key – Enter the Microsoft  client secret 


Network Share
Network Share Connection Settings 



Global users can view the Network Share navigation menu under the Connection Settings group. They can also access the Network Share Connection Settings page through the Network Share navigation menu.






Users can open the Connection Settings Add popup using the 'Add' button located at the top-right corner of the page.




All field information should be mandatory for creating a setting.
After filling in the data in the respective inputs, the Connect button will be enabled.
When users click the 'Connect' button, the provided information undergoes validation. Once the information is successfully validated, it is updated in the Network Share Connection Settings list.



Users can view the Edit and Delete icons in the respective connection settings listed.
  1. The Edit button is always enabled.
  2. When the user clicks the 'Edit' button, a connection setting popup will appear with the existing data, excluding the 'Password' value. (For security reasons, the existing password data is not populated.)


If the respective connection setting has been assigned any one of the sync, the “Delete” button is disabled or it’s in enabled.
o When the user clicks the 'Delete' button, a connection setting deletion confirmation will appear.                  
o Click “Yes” to proceed with deleting the connection setting record from the list.
o "Click 'No' to cancel the deletion request.



netDocShare Sync Jobs
Users can be able to view the Network Share drop down menu, if the Network Share related sync job has been selected from the admin application.



Create Job
In the sync type dropdown, users can view the following job types: Bidirectional (NetworkShare to NetDocuments), NetDocuments to NetworkShare, and NetworkShare to NetDocuments, provided a Network Share-related sync job has been selected in the admin application.


In the Network Share Connection dropdown menu, users can view the list of Network Share connection settings, provided they have already been updated in the Network Share connection settings list.


After selecting the Network Share connection, users can view the root level of folders and files in the respective Network Share setting.


Users can be able to Save the sync job setting using the “Save” Button.

               The Save button will be enabled once the sync data validation is successfully completed.

               Files and folders on the Network Share side are in a disabled state if a container on the NetDocuments side has not been selected.

Email Alerts for Sync Jobs - NEW


To receive e-mail alerts for sync jobs, users must enable the “Send Sync Mail Alerts” option on the Sync Settings page.

Users have two options:

  1. Every Cycle: An email will be triggered for each sync cycle for all jobs under the license.
  2. Frequency (1 to 24 Hours): An email will be triggered based on the selected frequency (in hours) for all jobs under the license
Note: Email alerts are sent only for the jobs created by the user.


Mail Notifications for Co-Editors and Sync Job Status – netDocShare Sync

Mail to Other Specified Users:
After creating a Sync Job, users can view the Co-Editors icon in the Scheduled Jobs list.
Clicking the Co-Editors icon will display a popup.
This popup shows a list of Global Admins and Sync Admins.
Users can select additional recipients from this list to receive sync job mail alerts.




Sync Job Status Mail Triggers:

The Sync Job status email is triggered based on specific conditions and the configured mail trigger settings. These conditions include:
Sync Job settings not received from the server.
Sync Job data not properly assigned from the server.
Required metadata fields missing in either the source or destination.
Previously processed file information not fetched from the server.
Issues related to connection settings.
Source or destination path validation failures.
Invalid access to the source or destination.
Content from source or destination paths not retrieved due to API or network issues.
Folder not created on the destination side.
Files not synced due to any reason.

Link Click Behavior - NEW




This feature was recently introduced for the following sync types.
It replaces the previous "Go To" and "Read Only" options in the existing "Copy Doc Links" feature.

Link Click Behavior now has three options:
Check-Out
            The link will directly navigate to the NetDocuments file, check it out, and download it.
            If the user has the NetDocuments viewer application installed, the file will be checked out and opened in the viewer.
Read-Only
            The link will navigate to the NetDocuments file.
            If the NetDocuments viewer application is installed, the file will open in read-only mode.
Go To
            The link will navigate to the location of the file within NetDocuments.

Migrate NetDocuments files/folders to SharePoint / Teams / OneDrive - NEW


1.1 Overview
The Delete from NetDocuments feature in netDocShare Sync enables users to automatically delete content from NetDocuments once files and folders are successfully synced to SharePoint library.
Customers leveraging NetDocuments for document storage often wish to reduce storage usage and licensing costs after migration. This feature allows users to safely remove original content from NetDocuments, while optionally maintaining reference links to the SharePoint library.
The feature supports full migration (“Select All”) and selective item migration. It provides a controlled mechanism to ensure data is removed only after a successful copy to the target destination.
In NetDocuments, the terms hard delete and soft delete are used to describe different methods of removing documents from the system. These terms refer to how the deletion process works and what happens to the deleted data. Here's a detailed explanation of both:

Soft Delete:

Definition: A soft delete in NetDocuments refers to the process where a document is marked for deletion, but it is not permanently removed from the system immediately. Instead, the document is typically moved to a "deleted items" or "recycle bin" area where it remains for a certain period of time.

How it works: 
  1. When you perform a soft delete, the document is hidden from regular view and is no longer accessible for normal operations.
  2. However, it is not entirely removed from the database. The system keeps it in a deleted or suspended state for a period (often configurable), giving you the option to restore the document if it was deleted by mistake.
Recovery: 
  1. Since the document still exists in the system (just in a "deleted" state), you can usually restore it back to its original location without any data loss.
  2. The system typically provides an easy-to-use interface for users or admins to recover soft-deleted documents.
Example Use: 
  1. You might choose a soft delete when you aren't sure if a document is truly no longer needed or if you think you may want to recover it later.
  2. Soft deletes are usually reversible, so they are safer in case of accidental deletion.
Hard Delete:

Definition: A hard delete is the process of permanently removing a document from NetDocuments. Once a document is hard deleted, it cannot be recovered, and it is irreversibly removed from the system.

How it works: 
  1. When a document is hard deleted, it is completely removed from the system's storage and database.
  2. No traces of the document remain in the platform once this process is completed.
Recovery: 
  1. Unlike a soft delete, there is no recovery option for hard-deleted documents.
  2. Once hard deletion has been executed, the document is permanently gone.
Example Use: 
  1. Hard deletes are often used when a document is deemed absolutely unnecessary or sensitive, and you want to make sure it is permanently erased from the system, without any possibility of recovery
1.2 Behavior

This feature introduces a new configuration option in the Sync job setup UI:

Delete from NetDocuments (Yes/No).
Key behavioral rules:
  1. Delete validation:
    1. Deletion from NetDocuments occurs only after successful file sync into SharePoint/SharePoint.
  2. Sync frequency behavior:
    1. If deletion is enabled (Yes), the Sync Frequency option will auto-hide because the deletion sync job is treated as a one-time operation.
  3. Warning Prompt:
    1. When selecting Yes, the system displays a deletion warning, confirming that original files will be permanently removed from NetDocuments.
  4. Full or selective deletion support:
    1. Select All:
  5. All chosen items are deleted, and a single link reference to the SharePoint library is maintained in NetDocuments (Only if Copy Doc Link is selected as Yes when the job is created).
  6. All chosen items are deleted, and no reference to the SharePoint library is maintained in NetDocuments if Copy Doc Link is selected as N when the job is created).
    1. Selective selection:
  7. Only chosen items are deleted, and per-item links are created in the respective folders/files if Copy Doc Links is selected as Yes when the job is created.
  8. Only chosen items are deleted, and no links are created in the respective folders/files if Copy Doc Links is selected as No when the job is created.
  9. Validation after sync:
            Only after successful completion does the system perform deletion and link creation.

1.3 Configuration Steps
Below are configuration instructions for users setting up a job that deletes content from NetDocuments once synced:
Login:
  1. Sign in to netDocShare Sync as Global Admin or Sync Admin.
Create Job Page:
  1. Navigate to Create Job from the left navigation. The job builder page loads.
Sync Job Settings:
Select the following values:
  1. Sync Type: NetDocuments to SharePoint/Teams/OneDrive
  2. Delete from NetDocuments: Yes
  3. Copy Metadata Columns: No (optional)
  4. Copy Doc Links: No (optional)
  5. When Delete = Yes → Sync Frequency dropdown is automatically removed.
  6. NetDocuments Source Selection:
  7. Select Cabinet from dropdown.
  8. Load Cabinet folder/workspace details.
  9. Search/select workspace.
  10. Select all relevant folders and files, including checked-out files.
  11. SharePoint Destination Setup:
    1. Choose SharePoint Tenant.
    2. Enter User ID and connect.
    3. Browse and select destination folder location.
  12. Save Job:
  13. Click Save. The new sync job appears in the Schedule Jobs page.
  14. Monitor Execution:
  15. Job status transitions:
  16. Scheduled → In Progress → Completed.
  17. Validation:
    1. Confirm documents are present at SharePoint and deleted in NetDocuments.


1.4 Example / Use Case
            Scenario: Customer wants to reduce NetDocuments storage
    1. A law firm decides to move documents from an active workspace to SharePoint for archival access and cost reduction.
     Steps:
  1. Administrator selects “NetDocuments to SharePoint” sync type.
  2. Sets Delete From NetDocuments = Yes.
  3. Selects Action to Delete = Hard Delete
  4. Selects the workspace folders.
  5. Runs the sync.
  6. After sync completion:
    1. All documents appear in SharePoint.
    2. NetDocuments displays links pointing to their new SharePoint location.
    3. Original documents are permanently removed from NetDocuments.
This gives the customer full retention, reduced storage cost, and end-user access continuity.

1.5 Limitations
  1. Dependent on successful sync:
  2. No deletion occurs if the sync job fails.
  3. Checked-out file dependency:
    1. Checked-out items must be selected manually; system will not auto-override checkout locks.
  4. File Name Special Character Limitation
    1. File name containing multiple special characters causing duplicate files.
1.6 Best Practices / Benefits
Benefits
  1. Reduced NetDocuments storage costs:
    1. By deleting original files, firms reduce workspace capacity usage and financial overhead.
  2. Zero data loss risk:
    1. Files are deleted only after successful sync validation.
  3. Metadata retention:
    1. Created Date, Modified Date, Created By, and Modified By properties are preserved in SharePoint.
  4. Operational efficiency:
    1. Administrators can migrate large segments of workspaces without manual deletion.
  5. Business continuity:
    1. NetDocuments retains reference links to SharePoint, ensuring end-users can still navigate to required content.
  6. Migration Reliability and File State Handling
    1. After a migration job is completed, the system continues to update the job status and associated dates to verify that all files are successfully migrated to SharePoint. This ensures migration continuity and helps mitigate issues caused by API timeouts or throttling.
    2. Files that are checked out in NetDocuments continue to reside in NetDocuments and are migrated to SharePoint while retaining the checked-out status. After the file is checked in within NetDocuments, the system updates the SharePoint copy and removes the checked-out state and deletes the files from NetDocuments.
Best Practices
  1. Use service accounts for syncing:
    1. Maintain consistent Created By and Modified By history.
  2. Perform workspace cleanup before sync:
    1. Remove obsolete or outdated folders to reduce job runtime.
  3. Run deletion jobs outside business hours:
    1. Reduces user conflict with source data.
  4. Enable link creation:
    1. Keeping reference links helps users locate files post-migration.
  5. Version and audit logging:
    1. Always validate logs and timestamps to confirm deletion events.



    • Related Articles

    • netDocShare Provisioning User Guide

      netDocShare Provisioning User Guide Table of Contents Login Connection Settings + Add User Screen Create Request My Requests Admin Screen Teams Tab Requests Create Request Login To use netDocShare provisioning web for netDocuments users ...
    • netDocShare OneDrive Client ID and Secret Id Generation

      OneDrive Client ID and Secret Id Generation Step 1: Please open the azure portal in browser https://portal.azure.com/#home Step 2: Please click the “Azure Active Directory Step 3: Once Azure Active Directory open after click the “App Registrations” ...
    • netDocShare Sync Admin Online & OnPrem Installation Guide

      netDocShare Sync Admin app Installation Guide Installation You can access the netDocShare Sync Admin app by entering sync.netdocshare.com in any browser Users need to provide the valid Email ID to completed the login process. There is no installation ...
    • netDocShare Teams User Guide

      netDocShare Teams App User Guide Introduction This user guide is a general overview of how to use and access the netDocShare Teams App designed for netDocShare Users. The netDocShare Teams App is a powerful application which can use almost all ...
    • netDocShare v4.2.0.1612

      New Features netDocShare Sync Sync deleted files and folders. Sync checkout status Sync selected files and folders in Bidirectional sync. Default meta data column creation for Document type when doc links Export jobs – Export the sync jobs filter by ...