Data Sync Server Documentation Index
Configuration Reference Home

JSON Attribute

A JSON Attribute is used when a subset of the fields in a JSON attribute are to be synchronized.

It is possible to specify which fields in the JSON attribute are synchronized with include-field and exclude-field. Synchronized fields are copied to the destination attribute. Existing non-synchronized fields on the destination attribute are retained. If all fields are synchronized, which happens if neither include-field nor exclude-field is specified, then the entire attribute is copied, just as it is with ordinary non-JSON attributes. For multi-valued attributes id-field is used to correlate source and destination values.

↓Relations to This Component
↓Properties
↓dsconfig Usage

Relations to This Component

The following components have a direct composition relation to JSON Attributes:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ destination-attribute  None
↓ description
↓ id-field
↓ include-field
↓ exclude-field

Basic Properties

destination-attribute (Read-Only)

Description
Specifies the name of the destination attribute whose JSON fields are to be synchronized.
Default Value
None
Allowed Values
The name of the destination attribute.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

description

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

id-field

Description
The JSON fields used to correlate source and destination attribute values. This must be set if there is any data at the destination that must be preserved. For each source value, id-field specifies the JSON fields that are matched in order to find the corresponding destination value. If a corresponding destination value is found the synchronized fields are copied from the source to the destination and the non-synchronized fields are preserved. Destination values that can not be correlated are deleted. A destination may fail to be correlated because it is not valid JSON, or because it is missing one of the fields specified by id-field, or because one of the fields specified by id-field does not have a corresponding source value.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

include-field

Description
Fields to include in the synchronization. Only fields from the source listed here or in the id-field property will be synchronized to the destination. Only one of include-field or exclude-field may be defined.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

exclude-field

Description
Fields to exclude from the synchronization. All fields from the source except those listed here will be synchronized to the destination. Only one of include-field or exclude-field may be defined.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured JSON Attributes:

dsconfig list-json-attributes
     [--property {propertyName}] ...

To view the configuration for an existing JSON Attribute:

dsconfig get-json-attribute-prop
     --attribute-name {name}
     --class-name {name}
     --pipe-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing JSON Attribute:

dsconfig set-json-attribute-prop
     --attribute-name {name}
     --class-name {name}
     --pipe-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new JSON Attribute:

dsconfig create-json-attribute
     --attribute-name {name}
     --class-name {name}
     --pipe-name {name}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing JSON Attribute:

dsconfig delete-json-attribute
     --attribute-name {name}
     --class-name {name}
     --pipe-name {name}