Syncplicity Support

Search our knowledgebase to get the help you need, today

Follow

Exceptions

An account or group map exception provides the ability to explicitly map a specific user from one platform to another.  These are exceptions to the automatic account or group mapping policies specified.  Account or group map exceptions can be defined during the creation of the map or can be imported from a comma-separated values (CSV) file.  

Important CSV Template Information

If you receive an error when importing a CSV file, the file does not meet the expected format. You will need to edit the file before attempting to import it again. Please see Account Map / Group Map | CSV File Guidelines for map templates and sample downloads. 

User & Group Map Exceptions

A user or group map exception provides the ability to explicitly map a specific user from one platform to another.  These are exceptions to the automatic account or group mapping policies specified.  User account or group map exceptions can be defined during the creation of the map or can be imported from a comma-separated values (CSV) file. 

 

Create an account map with exceptions

Exceptions can be specified while creating an account map or can be added after the account map has been created.

Create an account map with exceptions specified within the JSON

POST {{url}}v1/account_maps

{
    "name": "{{account_map_name}}",
    "source": {
        "connection": {
            "id": "{{connection_id}}"
        }
    },
    "destination": {
        "connection": {
            "id": "{{connection_id}}"
        }
    },
    "exceptions": [
        {
            "source": {
                "email": "{{source_account_email}}",
                "type": "account"
            },
            "destination": {
                "email": "{{destination_account_email}}",
                "type": "account"
            }
        }
    ],
    "type": "account_map"
}

Create an account map with exceptions imported from a CSV file

To create an account map with exceptions imported from a CSV file

  • Create the CSV file following Account Map / Group Map | CSV File Guidelines
  • Upload the CSV file to an existing connection or create a new connection to the location of the CSV file
  • Be sure to specify the full path of the CSV file, including the extension


POST {{url}}v1/account_maps

{
    "name": "{{account_map_name}}",
    "source": {
        "connection": {
            "id": "{{connection_id}}"
        }
    },
    "destination": {
        "connection": {
            "id": "{{connection_id}}"
        }
    },
    "exceptions": {
        "text": {
            "connection": {
                "id": "{{connection_id}}"
            },
            "target": {
                "path": "/Path to Exceptions/Exceptions.csv"
            }
        }
    },
    "type": "account_map"
}

View account map exceptions

View the exceptions within the account map

GET

{{url}}v1/account_maps/{{account_map_id}}/exceptions

Use the offset and limit to view different sections of a large account map

GET

{{url}}v1/account_maps/{{account_map_id}}/exceptions?offset=40000&limit=1000

Import exceptions into an existing account map

Exceptions can be added to an existing account map by either appending to the current list of exceptions or overwriting all exceptions with a new list of exceptions.  Also, they can be added by specifying the exceptions in the JSON or importing them from a CSV.  

After appending to an existing account map, DataHub will not go back and remap content already transferred. However, the updated account map will be used for future operations.

If importing from a CSV file

  • Create the CSV file following Account Map / Group Map | CSV File Guidelines
  • Upload the CSV file to an existing connection or create a new connection to the location of the CSV file
  • Be sure to specify the full path of the CSV file, including the extension

Overwrite

POST url/v1/account_maps/account_map_id/exceptions

{
    "append": false,
    "text": {
        "connection": {
            "id": "{{connection_id}}"
        },
        "target": {
            "path": "/Path to Exceptions/Exceptions.csv"
        }
    }
}

Append

POST url/v1/account_maps/account_map_id/exceptions

{
  "append": true,
  "items": [
        {
          "source": {
            "name": "Joe Smith",
            "email": "jsmith@DataHub.com",
            "type": "account"
          },
          "destination": {
            "name": "suser02",
            "email": "suser02@test.com",
            "type": "account"
          }
        },
        {
          "source": {
            "name": "Mary Smith",
            "email": "msmith@DataHub.com",
            "type": "account"
          },
          "destination": {
            "name": "suser03",
            "email": "suser03@test.com",
            "type": "account"
          }
        }
      ]
}

Delete an exception from an account map

DELETE

{{url}}v1/account_maps/{{account_map_id}}/exceptions/{{exception_id}}

Group map

A group map is managed in much the same way as account maps, but must be managed separately.  All above documentation applies to group maps as well, just substitute "group_maps" in the URL for "account_maps" and "group_map" as the type, if the type is required in the JSON.

GET

{{url}}v1/group_maps/exceptions


POST {{url}}v1/group_maps

{
    "name": "{{group_map_name}}",
    "type": "group_map",
    "source": {
        "connection": {
            "id": "{{connection_id}}"
        }
    },
    "destination": {
        "connection": {
            "id": "{{connection_id}}"
        }
    },
    "exceptions": [
        {
            "source": {
                "name": "{{group_account_email}}",
                "type": "group"
            },
            "destination": {
                "name": "{{group_account_email}}",
                "type": "group"
            }
        }
    ],
    "type": "group_map"
}

Powered by Zendesk