primedocs Server Commissioning
The commissioning of the freshly installed primedocs server is done in few steps.
This page concerns the OnPremises option.
With the "Software as a Service" option, no server installations by the customer are necessary.
Step 1: Check configuration
First the configuration file "primedocs.config" is checked. It is located in the installation directory (by default at C:\inetpub\wwroot\primedocs\primedocs.config
).
In the "primedocs.config" there should be no placeholders like {OPERATION_DB_CONNECTION_STRING}
, {GUID}}
or {RAND}}
.
Check whether the structure matches the examples on primedocs.config.
Step 2: Initialize database via dashboard
Now the database must be initialized. For this purpose, the DataSourceAdminApp or the so-called Dashboard can be used.
The dashboard can be called in the browser via the appropriate URL, e.g. https://your-url.local/datasourceadminapp
.
Authentication for access is done using the built-in Windows authentication (see Step 3).
The Dashboard shows an overview of the configured databases. Select the only configured database (in the example "primedocs-primesoft"; in the screenshot it’s already initialized!).
Afterwards the initialization can be triggered by selecting the button "Init Datasource".
Step 3: Restrict access to admin/dashboard
After installation, every Windows user in the domain has access to the dashboard. At this point, access should be restricted to a few users.
Authentication is done via Windows. The permission configuration for this can be done in the appropriate "Web.config" file (by default located at "C:\inetpub\wwroot\primedocs\datasourceadminapp\Web.config"
) and is enforced by IIS.
Step 4: Generate encryption key
A symmetric encryption key should be created on new databases.
The following message indicates the absence of this key:
The key can be created in the "Settings" tab in "General Settings" at "SymmetricEncryptionKey" with the "generate" button.
Step 5 (optional): Configure background jobs
The "JobHost" is a console application which e.g., can be used for automatic user data synchronization, administration of dynamic groups, caching of group information for users or for an automated backup of primedocs data in the primedocs package format (".oopx").
Using the default installation, it is suggested to set up the "JobHost" as a "Scheduled Task" once a day. In this case, the "JobHost" is started without parameters. This ensures that both user synchronization ("UserSync"), management of dynamic groups ("DynamicGroupLinking") and caching of all group information for users ("PrincipalConnectorCaching") are started. The actual configuration of these jobs is done in the respective data source.
Configure user data synchronization
The JobHost can be used to automatically store the primedocs data in the primedocs package format (".oopx") in a configurable directory (p
for path
). Using another parameter (r
für retain
), older backups can be deleted automatically. The generated primedocs packages or parts of them can be imported again via the Admin Dashboard.
CAUTION
These backups only contain data that can also be exported as "Package Export" via the Admin Dashboard. E.g. user data are not exportable. This is not a full backup of all data. For a complete backup in the event of a disaster recovery, an SQL Backup & Restore is recommended.
Call:
primedocs.JobHost.exe PackageBackup -p "D:\primedocsBackup" -r 14
The default value of -r
is 7, which means that a maximum of 7 backups from each data source remain in the directory.
Display help
Use this parameter to display the help at the JobHost:
primedocs.JobHost.exe --help
PrimeSoft AG, Bahnhofstrasse 4, 8360 Eschlikon, Switzerland