appsettings.json Reference
Every setting, what it does, and the procedure for changing one.
Warning Consult GDSI before changing anything in appsettings.json.
How to apply a change
- Save and close appsettings.json.
- Run IISRESET as Administrator on the web server.
- Restart the GDSI.DMSyncArchiveService service.
Connection and identity
| Setting | Purpose |
|---|---|
iManageAdminName | The service account. A virtual account in the NRTADMIN group at the highest role. |
| iManageAdminPassword | Encrypted. Cannot be edited in plain text. |
| iManageAdminClientId | The registered iManage application ClientID |
| FilesStorage | UNC root for on-premises archiving. Every backslash must be doubled. |
| WebPort | Service port for the IIS web application |
| ArchiveServicePort | Service port for the application service |
Archive behavior
| Setting | Purpose |
|---|---|
SetArchiveDocumentType | Change the archived document to ANSI from its native type |
| UseWorkspaceNameForArchive | Prepend #ARCHIVE# to the workspace name |
| UseWorkspaceDescForArchive | Prepend #ARCHIVE# to the workspace description |
| PrefixDocumentName | The prefix applied to an archived document name |
| DocumentComment | Text prefixed to the document Description field |
| UndeclareDeclared | Automatically undeclare records-declared documents so they can be archived |
| DisableArchiveRuleWhenDone | Disable a rule once it has completed |
| ArchiveCheckinPeriodInYears | How old a checkout must be before Archive checks it in automatically |
| BatchSize | Archive threads. Do not change without GDSI. |
Restore behavior
| Setting | Purpose |
|---|---|
RequireRestoreComment | Force a comment on restore |
| RestoreValidateChecksum | Verify the restored document matches the original size |
| RestoreArchiveDateRequired | Force a Date to Archive Again |
| MaxDaysOnReArchive | Cap how far ahead that date may be set |
| RequestForRestoreRecipients | Who receives a Request to Restore. Comma-delimited. |
| RequestForRestoreEmailSubject | Subject line of that email |
Scope filters
| Setting | Purpose |
|---|---|
ArchiveFilterFolders | Include only these folders |
| ArchiveFilterClasses | Include only these classes |
| ArchiveOutFilterFolders | Exclude these folders |
| ArchiveOutFilterClasses | Exclude these classes |
| UseCustomFieldForArchive | Nominate a CUSTOM3–12, 29 or 30 field carrying yes or no |
Retry and rest period
| Setting | Purpose |
|---|---|
MaxArchiveRetryCount | How many times a failing document is retried before the request settles as Partial Success |
| CheckRetryPeriodInMinutes | How long to wait between retries |
| RulesMaintenancePeriod_TimeOfDayFrom | Start of the window in which all rules are paused |
| RulesMaintenancePeriod_TimeOfDayTo | End of that window |
Warning Archives lock the Documents table and can deadlock DMSync command-line work. If your deployment also runs nightly core DMSync jobs, set the rest period so the two do not overlap. An unset rest period on such a deployment is a deadlock waiting to happen.
Add-ons
| Setting | Purpose |
|---|---|
ExtractDocumentsMetadataServerUrl | Metadata extraction service for stub indexing |
| DocumentsMetadataContainerName | Container for that service |
| SolrUserName / SolrPassword | Credentials for the Solr indexing appliance |
| ApiClientId / ApiClientSecret | Basic authentication for the Archive API |
| ArchiveLocationFormat | Override the default Custom1\Custom2\Class path shape |
Note The Solr add-on restores searchability inside the stub, at the cost of the stub growing to roughly half the size of the original document.