Data Sync Server Documentation Index
Configuration Reference Home

Groovy Scripted Sync Destination

Groovy Scripted Sync Destinations provide sync destination implementations defined in a dynamically-loaded Groovy script which implements the ScriptedSyncDestination class defined in the UnboundID server SDK.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

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

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ script-argument
↓ script-class

Basic Properties

description

Description
A description for this Sync Destination
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 Destination. 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

script-class

Description
The fully-qualified name of the Groovy class providing the logic for the Groovy Scripted Sync Destination.
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 Destinations:

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

To view the configuration for an existing Sync Destination:

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

To update the configuration for an existing Sync Destination:

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

To create a new Groovy Scripted Sync Destination:

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

To delete an existing Sync Destination:

dsconfig delete-sync-destination
     --destination-name {name}