User transformations

On this page:

1 Apply transformations to users
- 1.1 User transformation use cases
2 How to apply transformations to users
- 2.1 Download and upload a file with user transformations
3 Guidelines for creating JSON user transformations
- 3.1 Required JSON records to transform users
  - 3.1.1 Required JSON records to change the user’s email address
  - 3.1.2 Required JSON records to map a source user to a destination user by ID
- 3.2 Edit a user in a downloaded JSON file
  - 3.2.1 Transformation to change the user’s email address
  - 3.2.2 Transformation to map a source user to a destination user by ID

Apply transformations to users

You can apply transformations to users the same way you do to the rest of the configuration in the deployment. Basically, you can overwrite user details with the Customize mapping button at the top right of the Analyze changes page in the deployment wizard. You can learn more about customizing configuration mapping and the mechanisms to do it.

What is mapping or configuration mapping?

Mapping or configuration mapping is an extensive map formed during the analysis process. It holds information on how the configuration elements in the deployment scope will be moved to the cloud.

The elements will either be created as new ones or modified if there’s a match between the source and destination counterparts.

Learn more about the transformations available in CMJ Cloud.

User transformation use cases

You can use the Customize mapping option to:

Correct user problems
The Customize mapping feature allows you to correct user problems, such as missing and invalid email addresses, when mapping users during a server-to-cloud deployment. You can also remap server and cloud users this way.
Merge user accounts
You can also use the transformations to map multiple source users to a single Jira Cloud account. To achieve it, you need to change the email addresses of multiple Jira Server/Data Center user accounts to be the same. This way, the CMJ Cloud will map all of them to a single Jira Cloud account.
Map to a chosen destination user
You can also apply a transformation to map a source user to a destination user of your choice. To do so, you just need to provide the destination user’s ID.

How to apply transformations to users

To address the use cases above, you just need to upload a file with the desired user transformations. For example, if an email address is missing, you’ll be able to prepare and apply a file with a corrected email for a particular user.

You can also visit the following use case page on Appfire's website to find more useful information and view a demo of customizing the configuration mapping.

https://appfire.com/products/use-cases/modify-configuration-mapping-cloud-migration

Download and upload a file with user transformations

To apply transformations to users:

Start a deployment.
On the Analyze changes phase, move to the Users tab. Read more about deploying users.
Check for any users with missing or invalid email addresses.
To resolve problems with unknown users or to change the default user information, click the Download mapping button at the top right. You will get a JSON file with the default mapping of all configuration elements in the deployment, including users.
Modify the JSON file to correct missing or invalid email addresses. Also, if you would like to map several server users to a single Jira Cloud account, change their email addresses to match the email address of that Jira Cloud user. Check the guidelines about customizing mapping.
Click Customize mapping, upload the JSON file with the changes, and click Confirm.
The video below shows how to upload and apply transformations from a JSON file.
After you’re done making changes to the user mapping, click Deploy to move on with the deployment.

After you click Confirm on the Customize mapping window, the CMJ Cloud performs a new analysis of the deployed configuration and applies the transformations from the file.

Guidelines for creating JSON user transformations

In the deployment wizard, you can download a file that contains all the information about the users and how they’ll be deployed to the cloud. Then, you can either make changes to that file to include your desired user transformations, or you can construct your own file and apply either of the files to the configuration.

The applied file must always be in JSON format. Also, there are some requirements on how to list the intended transformations in it. Check the guide we’ve prepared to quickly get you started on building your transformations.

With the Customize mapping option in the deployment wizard, you can apply two types of transformations to users being deployed:

Change email address
Map to a destination user by ID

By changing the email address, you can create new users, merge multiple users into a single account, and remap source and destination users.

The important thing to note is that we refer to source users by their names. This means that you always need to provide the source user’s name in the JSON file in order to apply a transformation to it.

Let’s look at the examples below to make it clearer.

Required JSON records to transform users

You can construct your own JSON file with user transformations and apply it to the configuration being deployed. The examples below show you the records you need to have in the file to change a user’s email address or to map it to a destination user.

Required JSON records to change the user’s email address

The example below shows the specific records required to change a user’s email address.

{
    "users": [
        {
            "source": {
                "id": "5ed730807d0c0f0ab20920b8",
            },
            "transformation": {
                "email": "validEmail@demo.com"
            }
        }
    ]
}

Required JSON records to map a source user to a destination user by ID

The example below shows the specific records required to map a source user to a destination user by ID.

{
    "users": [
        {
            "source": {
                "id": "5ed730807d0c0f0ab20920b8",
            },
            "transformation": {
                "id": "5da444878f33800c416f30ed"
            }
        }
    ]
}

Edit a user in a downloaded JSON file

You can apply the same transformations from above by downloading and editing the current mapping file. This guide provides more details about editing or constructing a mapping file. The examples below show how the user records will look in the downloaded file and the additional transformation record you need to add.

Transformation to change the user’s email address

When you download a mapping file, the source and destination records for the user will look like in the example below. You only need to add a transformation record with the new email address without changing the default source and destination user records. After applying the edited file, the user being deployed will have a new email address.

{
    "users": [
        {
            "source": {
                "id": "5ed730807d0c0f0ab20920b8",
                "name": "usernameInvalidEmail",
                "email": "invalidEmail@demo"
            },
            "destination": {
                "newObject": true
            },
            "transformation": {
                "email": "validEmail@demo.com"
            }
        }
    ]
}

Transformation to map a source user to a destination user by ID

When you download a mapping file, the source and destination records for the user will look like in the example below. You only need to add a transformation record with the destination user’s ID without changing the default source and destination user records. After applying the edited file, the source user will be mapped to that destination user.