Data Sync Server Documentation Index
Configuration Reference Home

Groovy Scripted Sync Source

Groovy Scripted Sync Sources provide generic sync source implementations defined in a dynamically-loaded Groovy script which implements the ScriptedSyncSource class defined in the UnboundID server SDK.

Parent Component
Properties
dsconfig Usage

Parent Component

The Groovy Scripted Sync Source component inherits from the Scripted Sync Source

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ script-argument
↓ ignore-changes-by-user
↓ script-class

Basic Properties

description

Description
A description for this Sync Source
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

script-argument

Description
The set of arguments used to customize the behavior for the Scripted Sync Source. Each configuration property should be given in the form 'name=value'.
Default Value
None
Allowed Values
An argument in the form 'name=value'. Argument names are allowed to contain only ASCII alphabetic characters, numeric digits, dashes, and underscores.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

ignore-changes-by-user

Description
Modifications performed by accounts with the specified user name(s) will not be synchronized. This property is particularly useful when also using the Data Sync Server to synchronize changes to this source (i.e. bi-directional sync). In this case, a unique user account should be used by the Sync Pipe that applies changes to this source, and that user should be specified here to prevent those changes from being synchronized back to their original source.

In order for this to work, the Sync Source extension code must set the modifier's name on each ChangeRecord that is constructed. This will be examined by the Sync Pipe and the change will be dropped if the name matches one of the names specified here.

Default Value
No changes are ignored.
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

script-class

Description
The fully-qualified name of the Groovy class providing the logic for the Groovy Scripted Sync Source.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Sync Sources:

dsconfig list-sync-sources
     [--property {propertyName}] ...

To view the configuration for an existing Sync Source:

dsconfig get-sync-source-prop
     --source-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Sync Source:

dsconfig set-sync-source-prop
     --source-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Groovy Scripted Sync Source:

dsconfig create-sync-source
     --source-name {name}
     --type groovy
     --set script-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Sync Source:

dsconfig delete-sync-source
     --source-name {name}