Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

On This Page

Table of Contents

Overview

An account As part of a user or group map exception provides the ability to explicitly map a specific user from one platform to another.  These are , you can add explicit mappings from a user or group on the source to a user or group on the destination. These serve as exceptions to the automatic account user or group mapping policies specified.  Account or group map exceptions The explicit mappings will be used to maps users first, and any additional users or groups not in the mappings will be matched based on the automatic mapping rules selected for the map. Explicit user or group mapping can be defined manually during the creation of the map or can be imported from a comma-separated values (CSV) file.  

Info

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 see  Mapping CSV Import File Guidelines for map templates and sample downloads. 

User and 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. 

Importing an Exception File

...

Importing a Mapping File

  1. Click Migrate in the left navigation menu.

  2. Click Maps.

  3. You will be on the User Maps page. Select Group maps from the Maps menu if you need to create a group mapping.

  4. Find the map and

...

  1. click Manage mappings.

...

  1. If the map doesn’t exists, you will need to create it.

  2. On the User mappings or Group mappings page, click Import mappings.

...

  1. Image Added

  2. The Import user mappings modal appears. You have the option of uploading a file from your computer or from the source connection.
    To upload a file from your computer, verify you are on the Upload tab and select Browse. Navigate to the file and select Open

...

  1. Image Added


    To select a file from the source connection, click Select from the source connection. Navigate to the file or use the Manually enter path option to enter the path for the mapping file you want to use.

...

  1. Image Added

  2. Once you select the file, click Use this file.

  3. The screen will read the import file and display the mappings on the screen.

...

Manually Building the Explicit Mappings

  1. Click Migrate in the left navigation menu.

  2. Click Maps.

  3. You will be on the User Maps page. Select Group maps from the Maps menu if you need to create a group mapping.

  4. Find the map and click Manage mappings. If the map doesn’t exists, you will need to create it.

  5. Click More Options and

...

  1. click Create user mapping.

...

  1. Image Added

...

  1. Click Choose on the source side

...

  1. .

  2. Select the user and click Use this user.

...

  1. Image Added

  2. Click Choose on the destination side

...

  1. .

...

  1. Select the user and click Use this user

  2. Click Done to save the mapping. The user map is added to the list on the screen. 

    Image Added

  3. Repeat these steps for each

...

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

...

Code Block
{
    "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

...

Code Block
{
    "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.

Code Block
GET {{url}}v1/account_maps/{{account_map_id}}/exceptions

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

Code Block
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.  

Note

After appending to an existing account map, DryvIQ 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

...

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

Append

...

POST url/v1/account_maps/account_map_id/exceptions

...

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

Delete an Exception From an Account Map

Code Block
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.

Code Block
GET {{url}}v1/group_maps/exceptions

...

POST {{url}}v1/group_maps

...

  1. explicit mapping you need to add.