Vault 2021 was released worldwide in March 2020. This blog post will highlight the major API updates for this release.
In case you prefer to watch, rather than read, please feel free to skip to the below video! https://www.youtube.com/watch?v=dtWpkKAAnzM
New Web Service: Analytics Service
The Analytics Service collects and reports information back to users for Duplicate Search functionality, which finds geometrically identical shapes inside a Vault.
New Supporting Classes:
1. DuplicateSearchSnapshot
- CandidateFileCount (long)
- Total files that are within the indexing scope for determining duplicates.
- DuplicateFileCount (long)
- The number of files determined as duplicates.
- DuplicateFileGroupsCount (long)
- The number of files determined as having unique shapes (group).
- Extension (string)
- The file extension.
- IndexedFileCount (long)
- The number of files currently indexed for determining duplicates.
- VaultedFileCount (long)
- The total number of files that are in the current Vault.
2. DuplicateSearchStatus
- AnyFailedIndexedJobs (bool)
- Did any jobs fail for indexing the file data?
- IsEnabled (bool)
- Is the Duplicate Search functionality enabled?
- IsFoldersConfigured (bool)
- Are there any folders configured for file indexing?
- Snapshot (DuplicateSearchSnapshot)
- A snapshot of the duplicate search results.
3. DuplicateSearchFolderConfiguration
- FolderId (long)
- The folder ID in duplicate search’s scope.
4. DuplicateSearchConfiguration
- DuplicateSearchFolderConfigurationArray (DuplicateSearchFolderConfiguration[])
- A collection of duplicate search folder configurations, which defines the scope of folders to use in indexing.
- Enabled (bool)
- Is duplicate search enabled for the current Vault?
New Methods:
- DuplicateSearchConfiguration GetDuplicateSearchConfiguration()
- Gets the current Vault’s duplicate search configuration.
- void SetDuplicateSearchConfiguration(DuplicateSearchConfiguration config)
- Sets the duplicate search configuration for the current Vault.
- DuplicateSearchStatus GetDuplicateSearchStatus()
- Gets the Vault’s duplicate search status, which contains snapshot data.
Updated Web Service: Change Order Service
New Supporting Classes:
1. ChangeOrderEmailTemplate
- Body (string)
- The template for the email’s body.
- COPropDefIdArray (long[])
- A collection of which change order property definitions to include in the e-mail, selected by property definition ID.
- FilePropDefIdArray (long[])
- A collection of which controlled files’ property definitions to include in the e-mail, selected by property definition ID.
- ItemPropDefIdArray (long[])
- A collection of which controlled items’ property definitions to include in the e-mail, selected by property definition ID.
- Subject (string)
- The template for the email’s subject
2. EmailMsg
- Body (string)
- The e-mail’s body
- Subject (string)
- The e-mail’s subject
New Methods:
- ChangeOrderEmailTemplate GetDefaultEmailTemplate()
- Gets the current Vault’s system-generated (default) e-mail template for change order notifications.
- ChangeOrderEmailTemplate GetEmailTemplate()
- Gets the customized email template for change order notifications.
- void SaveEmailTemplate(string subject, string body, long[] coPropDefIds, long[] itemPropDefIds, long[] filePropDefIds)
- Saves the customized e-mail template to a ChangeOrderEmailTemplate object, for use in change order notifications.
- EmailMsg GetEmailMessageByChangeOrderId(long changeOrderId, string changeOrderNumber, string stateName, bool excludeRelatedObjects)
- Gets an e-mail message for a given Change order ID.
Removed Methods:
- string GetEmailBodyByChangeOrderId(long changeOrderId, string changeOrderNumber, string stateName, bool excludeRelatedObjects)
- This method has been replaced with GetEmailMessageByChangeOrderId()
Miscellaneous Changes
New Property:
- Role.SysName (string)
- Exposes the Role’s internal system name.
- This value is immutable and cannot be user set.
New Method:
- Job JobService.ResubmitJob(long jobId)
- You can now resubmit jobs from Vaults other than where they were originally submitted from.
Updated Enumerations:
- FileClassification.DesignPresentation
- With this new classification, we can identify Inventor Presentation (.IPN) files more accurately within Vault
Highlighted Feature Updates
1. Download Permisisons
- Updated Property:
- AccessPermis.Id (long)
- There’s a new Id value added to accommodate for setting or denying Download Permissions:
- 4, AllowDownload
- New Exception Class:
- VaultDownloadDeniedException
2. Purge Enhancements
New Method:
- void LifeCycleService.ApplyPurgeRestrictOptionToHistory(long lcStateId)
