Data sync mappings

Mappings are an optional set of rules that remap what gets copied and synchronized from source to target.

Each rule pairs a specific source item with its desired target. Anything not explicitly listed in the mapping is copied and synchronized unchanged (1:1).

Minimal JSON

{
  "fromKey": "",
  "toKey": ""
}

Property	Description	Values	Mandatory
fromKey	Key of the original attribute type from which the value is copied.	string	Yes
toKey	Key of the new attribute type.	string	Yes
clearEmbeddedTexts	Determines whether embedded texts are saved as static text.	boolean	No

objectTypeMappings

Example JSON

{
  "key": "cust_syncDataAutomation",
  "type": "syncData",
  "targetApplicationKey": "cust_exampleApp",
  "targetSpacePath": "Personal/Knowledge Base",
  "objectTypeMappings": [
    {
      "fromKey": "core_documentation_document",
      "toKey": "cust_exampleApp_objectType"
    }

}

Property	Description	Values	Mandatory
fromKey	Key of the original object type.	string	Yes
toKey	Key of the new object type.	string	Yes

relationTypeMappings

Example JSON

{
  "key": "cust_syncDataAutomation",
  "type": "syncData",
  "targetApplicationKey": "cust_exampleApp",
  "targetSpacePath": "Personal/Knowledge Base",
  "relationTypeMappings": [
    {
      "fromKey": "core_isParentOf",
      "toKey": "cust_exampleApp_contains",
      "toAttributeKey": "core_description"
    }

}

Property	Description	Values	Mandatory
fromKey	Key of the original relation type from which the value is copied.	string	Yes
toKey	Key of the new relation type. To not include this relation during sync, use null.	string	Yes
toAttributeKey	Key of the attribute type that will contain the ID of the target object in the relation.	string	No

userRelationTypeMappings

Example JSON

{
  "key": "cust_syncDataAutomation",
  "type": "syncData",
  "targetApplicationKey": "cust_exampleApp",
  "targetSpacePath": "Personal/Knowledge Base",
  "userRelationTypeMappings": [
    {
      "fromKey": "core_business_owner",
      "toKey": "cust_exampleApp_businessOwner",
      "toAttributeKey": "core_description",
      "toAttributeKeyValueType": "email"
    }

}

Property	Description	Values	Mandatory
fromKey	Key of the source user relation type from which the value is copied.	string	Yes
toKey	Key of the new user relation type. To not include this user relation during sync, use null.	string	Yes
toAttributeKey	Key of the attribute type that will contain information about the user from the user relation.	string	No
toAttributeKeyValueType	Type of the value inserted into the attribute. See all supported values. This property is mandatory when toAttributeKey is defined.	string	Yes (when toAttributeKey is defined)

To attribute key supported values

Supported values of the toAttributeKeyValueType property are the following:

• login: Username of the user.
• email: Email address of the user.
• name: Name of the user as set in Dawiso.
• id: ID of the user.

workflowStateMappings

Example JSON

{
  "key": "cust_syncDataAutomation",
  "type": "syncData",
  "targetApplicationKey": "cust_exampleApp",
  "targetSpacePath": "Personal/Knowledge Base",
  "workflowStateMappings": [
    {
      "fromKey": "core_draft",
      "toKey": "core_approved"
    }

}

Property	Description	Values	Mandatory
fromKey	Key of the original workflow type.	string	Yes
toKey	Key of the new workflow type.	string	Yes