Command line

ConfigureDMS.exe also runs from the command line. Without arguments, it starts the user interface.

ConfigureDMS.exe <verb> --url <site collection url> [options]

Verbs

Verb	Description
run	Run the configuration tool. Starts the user interface and connects to --url.
validate	Validate the configuration and show all configuration actions that can be applied.
apply	Apply a configuration action. Requires --action <name> or --all.

validate and apply run the standard DMSforLegal validation tasks of the Configuration tab. Matter Center tasks are not available from the command line.

Options

All verbs accept these options.

Option	Description
--url	Required. SharePoint server url.
--contentTypeSiteUrl	Specify the content type site url when different from the Epona365 site collection.
--username	User name.
--password	Password.
--domain	Domain.
--clientId	Client id.
--clientSecret	Client secret.
--thumbprint	The thumbprint of the certificate to use.
--certificatePath	The certificate path (.pfx) on the filesystem.
--certificatePassword	The certificate password.
--enableMatterCenterDetection	Enable MatterCenter detection. Only applies to SharePoint Online connections.

apply also accepts:

Option	Description
--action	Name of the configuration action to apply.
--all	Apply all configuration actions.

Use either --action or --all, not both.

Authentication

The options you pass select the authentication method. The first matching row wins.

Method	Options
Certificate	--clientId with --thumbprint, or --clientId with --certificatePath and --certificatePassword
App-only (client secret)	--clientId and --clientSecret
Modern	--clientId and --username (interactive sign-in can appear)
Windows	--username, --password and optionally --domain
Browser	No authentication options. A sign-in window opens.

With --thumbprint, the certificate is read from the current user's personal certificate store (CurrentUser\My).

WARNING

Errors show in a message box, also from the command line. This applies to failed authentication and to configuration actions that fail during apply. Unattended runs then wait until someone closes the message box.

Validate

validate connects, runs all validation tasks and prints the actions that can be applied:

Configuration actions that can be applied:
  <action name>                  (<action title>)
  ...

Usage:
  To a apply a specific action, use: ConfigureDMS.exe apply --action <action>
  To apply all actions, use: ConfigureDMS.exe apply --all

Pass an action name from this list to apply --action. If the list under the header is empty, nothing needs to change. Only when no validation task reports anything at all is the output: "The DMSforLegal lists on SharePoint are correctly configured."

Apply

• apply --action <name> applies the pending actions with that name. If the name matches no pending action, nothing runs.
• apply --all applies all pending actions of the tasks that support apply-all. Unlike Add all in the Configuration tab, this includes pending Fix actions. Run validate first, and use apply --action when you only want specific actions.

Each action prints Executing <action name>... done. If an action fails, its error shows in a message box (see the warning under Authentication). After the box closes, the line still ends with done., the remaining actions run, and the exit code stays 0. Run validate afterwards to check what is still pending.

Exit codes

Code	Meaning
0	Success.
1	Invalid arguments, connection or authentication failure, or missing --action/--all.

Examples

Validate with Windows authentication (SharePoint Server):

ConfigureDMS.exe validate --url https://sharepoint.contoso.com/sites/dms --username spadmin --password <password> --domain CONTOSO

Apply one action:

ConfigureDMS.exe apply --action FillEmptySiteURLs --url https://sharepoint.contoso.com/sites/dms --username spadmin --password <password> --domain CONTOSO

Apply all actions with certificate authentication:

ConfigureDMS.exe apply --all --url https://contoso.sharepoint.com/sites/dms --clientId 00000000-0000-0000-0000-000000000000 --thumbprint <thumbprint>

Validate with app-only authentication and a separate content type site:

ConfigureDMS.exe validate --url https://contoso.sharepoint.com/sites/dms --contentTypeSiteUrl https://contoso.sharepoint.com/sites/contenttypes --clientId 00000000-0000-0000-0000-000000000000 --clientSecret <secret>

Start the user interface connected to a site:

ConfigureDMS.exe run --url https://contoso.sharepoint.com/sites/dms