Synchronize files from SharePoint
Use this page to run and schedule SharePoint file synchronization in Pimics; for the full SharePoint setup and how to prepare SharePoint libraries for Pimics, see SharePoint as Digital Asset Management for Pimics.
Pimics provides a report that can be run on demand, or in the background as a Job Queue entry. This report checks a SharePoint library, or a selected folder within that library, and creates or updates objects in Pimics based on the file data it finds.
Initial synchronization
Use this process when synchronization is done just once.
Run the synchronization
- Choose the Search icon (or use Alt + Q), enter Pimics SharePoint File Synchronization, then choose the related link.
- Specify the following fields
- Import Action
- Create New will create only new files. The existing records in Pimics will be skipped.
- Update Existing will update existing Pimics records for files found in the selected SharePoint library or folder. Files without a matching Pimics record are not created.
- Both will create new files and update existing records in Pimics.
- SharePoint Drive Id - select the library you want to synchronize.
- Folder - optional. Use the lookup to select a folder in the selected library. Leave this empty to synchronize the whole library. When a folder is selected, synchronization starts in that folder rather than at the library root.
- Include Subfolders - applies to the selected starting location. Choose Yes to also synchronize files in folders below it; choose No to synchronize only files directly in the selected folder. If Folder is empty, this controls whether files in folders below the library root are included.
- Get Thumbnails - keep it to Yes. You can disable it to improve performance for big libraries.
- Request Size - keep the default value. This can impact the performance.
- Import Action
- Select OK to start the synchronization.
When synchronizing a specific folder, the folder lookup stores the folder's SharePoint ID. The folder name/path is shown for selection, but synchronization uses that ID. The selected folder does not change the SharePoint library (drive) selected above.
Note
With Update Existing or Both, the report also checks whether existing Pimics documents in the selected library still exist in SharePoint. This check covers the whole library, even when Folder is set to a specific folder; it is not limited to that folder.
Update Existing or Refresh Metadata?
Use Update Existing in the SharePoint synchronization report when you want to reconcile Pimics records with the files in a SharePoint library or selected folder. The report lists files in that location, matches them to Pimics by SharePoint drive and item IDs, and updates matching records with SharePoint file data. It also updates filename-related fields and can refresh thumbnails when Get Thumbnails is enabled. It does not create records for unmatched files; use Both if you also want new files imported.
Use Refresh Metadata when you want to refresh metadata for existing Pimics document records, rather than scan a SharePoint location for files. The report processes the records selected by its filters (such as Repository Type and Document ID) and retrieves each file's metadata from its repository. It does not create records for files that are not already in Pimics, and it does not refresh thumbnails.
The reports also differ in how they handle files that are missing from SharePoint:
- Update Existing checks whether existing documents in the selected library still exist. This check is drive-wide, including when a folder is selected.
- Refresh Metadata checks each filtered document individually and updates its file-missing and last-download status when the file cannot be found.
Recommendation: To keep SharePoint-backed Pimics documents current, use Update Existing when you need a full scan of a library or folder, or SharePoint Delta Sync for routine scheduled updates. Use Refresh Metadata for a targeted refresh of selected existing document records, not as the primary SharePoint synchronization job: it works from Pimics records rather than discovering new or changed files in a SharePoint location.
Ongoing updates with SharePoint Delta Sync
The SharePoint Delta Sync report is intended for ongoing synchronization. It processes SharePoint changes since the configured start date or, for a Job Queue entry, since its last successful run. It updates matching Pimics documents, creates Pimics records for new files, and marks known documents as missing when SharePoint reports their deletion. This means a single Delta Sync job can handle both new files and updates; separate Create New and Update Existing full-sync jobs are not needed just to cover those two actions.
Delta Sync has one Get Thumbnails setting for every changed file it processes. It defaults to Yes:
- With Yes, new files get thumbnails and existing changed files have their thumbnails refreshed.
- With No, thumbnails are not fetched for either new or existing changed files.
Therefore, Delta Sync does not replace the two-job arrangement if the requirement is specifically to fetch thumbnails for new files while avoiding thumbnail refreshes for existing files. The report does not offer separate thumbnail behavior for creates and updates. If the same thumbnail policy is acceptable for both, one scheduled Delta Sync job can replace the split jobs.
Use the full Pimics SharePoint File Synchronization report with Both for an initial import or a full reconciliation; it scans the selected location and checks existing document existence across the entire library. Use Delta Sync for regular incremental updates, and run a full sync periodically or when you need to reconcile the library.
To schedule Delta Sync, create a Job Queue entry for report 70113740, select the SharePoint Domain Repository and Drive Id, and configure the optional Folder, Get Thumbnails, and start-date settings as needed. Keep the same domain, drive, and folder scope for recurring runs so the incremental job continues tracking the intended SharePoint location.
Periodic synchronization
Use this process when you want to run synchronization automatically as a recurring job.
Define the synchronization as a Job Queue entry
- If you want to run this periodically, you can define it as a Job Queue entry.
- Choose the Search icon, enter Job Queue Entries and then choose the related link.
- Define a new job queue by following Microsoft documentation.
- Set Object Type to Run to Report and Object Id to Run to 70113723.
- Define your Recurrence.
- In Report Parameters set Report Request Pages to Yes and follow instructions from point 2 in Run the synchronization. To synchronize a specific folder periodically, select that folder in Folder and retain the same library selection.
- When finished, select Set Status to Ready.
- If you need to synchronize more libraries just follow steps 1 - 5 for each library.