For the complete documentation index, see llms.txt. This page is also available as Markdown.

Command-Line Arguments Configuration

Command-line arguments tell the SharePoint Security Sync Scheduler Tool which operation to run, which Dataverse environment and connector to use, and which records or date ranges to process.

Before preparing the command, keep the following information ready:

  • Dataverse environment URL.

  • Azure application Client ID and Client Secret (refer to Section 3).

  • Connector ID for the selected operation.

  • Entity Configuration ID.

  • Date range, where required.

  • Required application permissions, Dataverse security role, and valid application license.

  • Access to the SharePoint site, depending on the connector configuration.

Important: Use Connector IDs and Entity Configuration IDs from the same Dataverse environment specified in --crmUrl.

Common Command-Line Arguments

Argument

Purpose

Expected Value

--scheduler

Starts the application in scheduler mode.

No value required

--operation

Specifies the operation to run.

RecordLevelAccess, UserAccess, DataMigration, or FailedSync

--crmUrl

Dataverse environment URL.

Environment URL

--clientId

Azure application Client ID.

Client ID

--clientSecret

Azure application Client Secret.

Client Secret

--connectorId

Identifies the connector configuration.

Connector GUID

--useDocumentLocationDate

Controls document-location date behavior for Record Level Access Sync.

true or false

--entityConfig

Identifies the Entity Configuration and its operation-specific parameters.

Depends on the operation

Command Formatting Guidelines

  • Enter the complete command on one line in the Add arguments field.

  • Use double quotation marks around values, as shown in the examples.

  • Use valid GUIDs for Connector IDs, Entity Configuration IDs, and User/Team IDs.

  • Enter dates in yyyy-MM-dd format, for example, 2026-10-07.

  • Use true or false for Boolean values.

  • Do not leave required values empty.

  • Use the correct pipe (|) and comma (,) separators for each operation.

User Access Sync

User Access Sync synchronizes group access for the selected Entity Configuration records.

Provide multiple Entity Configuration IDs as a comma-separated list in one --entityConfig argument.

Example:

Note: Use commas to separate Entity Configuration IDs. Do not include date ranges or User/Team IDs.

Record Level Access Sync

Record Level Access Sync synchronizes folders based on the selected Entity Configuration records, date ranges, and optional User/Team IDs.

Entity Configuration Format:

  • Without User/Team IDs: EntityConfigurationId|StartDate|EndDate

  • With User/Team IDs: EntityConfigurationId|StartDate|EndDate|UserOrTeamId1,UserOrTeamId2

Example – One Entity Configuration:

Example – Multiple Entity Configurations:

Note: Use | to separate the Entity Configuration ID and date fields. Separate multiple User/Team IDs using commas. Repeat --entityConfig for multiple configurations.

Data Migration

Data Migration allows you to migrate supported content from the selected Dataverse entity to the configured destination based on the selected migration type and date range.

For Notes, Activities, and SalesLiterature, you can choose one of the following actions:

  • Copy: Copies the supported content to the destination while retaining the original content in CRM.

  • Move: Transfers the supported content to the destination and removes it from the original location as part of the migration.

Before running a Move operation: Verify the selected entity, date range, connector, and migration type. We recommend performing a test using Copy first to confirm that the migration works as expected.

Configuration Guidelines:

  • Use one Entity Configuration ID per Data Migration execution.

  • To migrate another entity, create a separate task or run another execution.

  • For EmailBodyContent, use the Email Entity Configuration and do not include the --action argument.

Command Examples

Replace the sample values with the corresponding details from your Dataverse environment.

Example A – Notes (Copy)

Example B – Notes (Move)

Example C – Activities (Copy)

Example D – Activities (Move)

Example E – Sales Literature (Copy)

Example F – Sales Literature (Move)

Example G – Email Body Content

Note: The EmailBodyContent command does not require the --action argument. Use the Email Entity Configuration.

Failed Sync

Failed Sync allows you to reprocess records that previously failed during synchronization.

Command Example:

After execution, review the Scheduler Trace logs to check the operation status and identify any errors.

Before Running the Scheduled Task

Before saving the command-line arguments, verify the following:

  • Replace all placeholders (<CLIENT_ID>, <CLIENT_SECRET>, <CONNECTOR_ID>, and sample IDs) with the correct environment values.

  • Ensure the operation name matches the operation you want to execute.

  • Verify that the Dataverse URL, Connector ID, and Entity Configuration IDs belong to the same environment.

  • Check that the Entity Configuration format matches the selected operation.

  • Use the correct separators for Record Level Access, User Access, and Data Migration.

  • Verify the migration type, action, and date range for Data Migration.

  • Enter the complete command on a single line in the Add arguments field in Windows Task Scheduler.

Last updated

Was this helpful?