Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device.
Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Learn how to add hundreds of Users to your platform at once from a spreadsheet, using your in-built platform import tool!
The import tool allows you to create records in bulk. This page is designed to provide you with a step-by-step guide to efficiently and accurately import User data into your accessplanit platform.
Follow this page to learn the steps to import Users.
Please note
The Import tool is available to Super Administrators. If you are not able to access the Import options please speak to a member of the accessplanit team.
Create and format your Import File
This step will show you how to create a .csv file that contains all of the information needed for your Users import
To create and format your Import File, you will follow these steps:
Download the User Import Template File (included in this guide)
Format the User Import Template File
Populate the User Import Template File
Save as a .csv file
Download the User Import Template File
In this step, you will download our template file for User Imports.
There are two files to download to support your import, there is a reference spreadsheet which you can look at to understand the import options, and there is an import template which you will edit and fill with your import data.
Please download our ‘BLANK’ User Import Template here (this is the file you will add your import data into):
Please download our reference Import Profile here to view all of the options for your import file:
All mandatory fields are shown in Red All optional fields are shown in Grey This file is a reference file only
Format the User Import Template File
This step will take you to set up your import file with the columns that you want to import data for, ready for populating it with data!
You will remove the columns you don’t need, and you can add additional columns if you want to import any custom field data.
Open the ‘BLANK User Import Template’ file (download available above), this will open a blank Excel file which will only contain column headings, these will be listed in the first row
This is the file that you will be working from, amending, and adding data to Open the ‘EXAMPLE User Import Template’ file (download available above), this will open an Excel file with further information and example data for each available import column
This file is a useful reference, to understand what data is required in each column Within the 'BLANK User Import Template’ file, remove any columns that you do not plan to import data to, you can remove the following: CompanyName Title Middle Names UserID Status External ID Phone Number Address Town County Country Postcode Employment Start Date Employment End Date Job Title Billing Address, Billing Town, Billing County, Billing Country, Billing Postcode Alternative Address, Alternative Town, Alternative County, Alternative Country, Alternative Postcode Shipping Address, Shipping Town, Shipping County, Shipping Country, Shipping Postcode Marketing Opt In Notes Sex Job Role NI Number DOB Custom Field Name 1, 2 and 3 If you plan to import any data into your User Custom Fields for your Users, edit the additional columns in your 'User Import Template’ file for these Make sure that you have the following mandatory columns included within your 'User Import Template’ file CompanyName - This is the name of the Account your User will belong to UserID (optional) - This can be a key column if Email addresses are duplicated Forename - Users First Name Surname - User Surname Email - Users Email Address Progress to the next step, to fill your import file in with your User data
Populate the User Import Template File
This step will take you populating your import file with your User data, ready for importing it into your platform!
Using the 'EXAMPLE User Import Template’ file as a reference, add your User data into your 'User Import Template’ file The table below outlines each column that you can include in your import file: Column Description Format Rules CompanyID Mandatory The Account ID This can be found by adding the ‘Account ID’ column to your Account DataGrid You can find the steps for adding a DataGrid column in our dedicated guide Text The Account ID must match an existing Account ID in your platform
Forenames
Mandatory This is the User's Forename Text Surname
Mandatory This is the User's Surname Text Email
Mandatory This is the User's Email Address Text If multiple Users share the same Email address, please reach out to a member of the Customer Support Team before you run this import CompanyName
The Account Name This can be found by viewing the ‘Account Name’ column in your Account’s DataGrid
Text This must match an existing Account Name in your platform UserID This is the User's unique identifier within the Platform Text If left blank the Platform will automatically generate the User ID for your Users. You can manually enter your User IDs yourself, these can be in text format and/or numbers This field can be mandatory & a Key Field when importing if Email addresses are duplicated within the Platform You are best to use this field for updating Users rather than creating unless you already have a defined User ID that you would like your Users to have. Title The User title can be Mr, Mrs, Ms, Miss, Dr, Sir, Lord, Prof, Rev, Fr, Sr, Bro, Lady Text If the title you require isn't available you can contact one of our Customer Support Team to have the title added MiddleNames This is the User's Middle Name Text Status You can choose which Status your Users will be in when they are imported Text 0: Disabled 1: Enabled 2: New 3: Import 4: Deleted 5: Locked 6: Temporary ExternalID Used to store the ID for this User from another software/system Text PhoneNumber This is the User's Phone Number Number Address This is the first line of the User's Address Text Town This is the User's Town Text County This is the User's county Text Country This is the User's Country Text Postcode The is the User's Postcode Text EmploymentStartDate This is the date the User started their Employment Date Time Must follow the same date format as used in your platform EmploymentEndDate This is the date the User finished their Employment (If applicable) Date Time Must follow the same date format as used in your platform JobTitle This is the Users Job Title Text BillingAddress
BillingTown
BillingCounty
BillingCountry
BillingPostcode The next 5 columns are the Users Billing address information. This is usually the same as their Main address however, if different you may want to add these fields to your import ' Text Ensure each option is a separate column AlternativeAddress
AlternativeTown
AlternativeCounty
AlternativeCountry
AlternativePostcode These next 5 columns are the User's Alternative Address, this is typically used if the User has a a different address from their Main Address Text Ensure each option is a separate column ShippingAddress
ShippingTown
ShippingCounty
ShippingCountry
ShippingPostcode These next 5 columns are the Users Shipping Address, this is typically used to capture the address for Products and Services and where they should be shipped to. These can be the same as the Users Main Address or if different, it can be added to your Import here Text Ensure each option is a separate column MarketingOptIn This is to notify you if the User is happy to be opted in to Marketing or not Text Yes No Notes Here you can add notes for your User Text Sex This is the Sex of your User Text Must be in letter format F = Female M = Male O = Other I = Intersex U = Unknown JobRole This will assign a Job Role / User Type to the User Text If the Job Role does not yet exist in the platform, it will be created NINumber This is the Users National Insurance Number (If applicable) Text DOB This is the Users Date of Birth Number Must follow the same date format as used in your platform CustomField1
CustomField2
CustomField3 If you have Custom Fields that you wish to add to your Import, you can do this by using one of the Custom Field columns available.
We have given you an example here The column name must match the exact name of the Custom Field within your Platform If you wish to add a Custom Field but haven't created it yet, please see our dedicated guide here Please Note If your organisation/business operates using Languages where the following special characters are present - Č, Š, Ž and Ć - and you wish to use the importer to upload content containing these characters to the platform - you will need to contact the accessplanit Support Team.
Save as a .csv file
This step will take you through saving your User Import file into the file format needed for the import tool
Once you have all the information you require within your import file, you can then save it as a .csv file Within Excel, click the ‘File’ option in the top left hand corner Click ‘Save as’ Using the drop down box under the file name, select CSV (comma delimited) (*.csv) and name your file (for example ‘User Import’) Click the ‘Save' button to complete the Save
Your Import file has now been saved, ready for importing. Please Note
If your organisation/business operates using other Languages, when saving a .csv file, ensure that the document is saved with ‘,' rather than ';’ as this can prevent the document from Importing
Create an Import Profile
This step will run through how to create an Import Profile in your accessplanit platform, to use when importing Users.
You will be able to reuse this profile each time you import Users using the same file structure (i.e. the same columns of data are included).
Open the ‘Administration’ menu from the Profile options at the top-right of your platform Scroll down the page until you find the ‘Import Profiles’ menu option
The menu is in alphabetical order Click on the ‘Import Profiles’ option to be taken to the Import Profiles page Click the ‘New Profile’ button at the top right corner of the page to create a new Import Profile Provide a ‘Profile name’ for your Import Profile
We advise providing your Profile with a unique name so that's its easily identifiable Select ‘Users’ as your import ‘Destination’, this lets the Platform know that you will be importing User information The next step is to upload the .csv file that you created and saved earlier, click the selecting the ‘Choose file’ button and selecting the file from your saved location Leave the ‘Header Label Row’ set to '1', this tells your platform that the column headings of your import are in the first row Click the ‘Next ->’ option at the top right of your page to proceed to the column mapping step for your Import Profile In the column mappings step you will match each column in your import file (Source column) to a User setting in your accessplanit platform (Destination column), this is where you define where the information in your import file will be imported to and displayed in your platform, much of this will be pre-populated for you! Please Note
The Source Columns may look different depending on which columns you removed from the ‘BLANK User Import Template’, your Import Profile will only show the columns within your .csv file If you see ‘IGNORE' within the 'Destination Column’, you will need to select the correct column from the drop down option
Leaving it as IGNORE will mean that the Platform will ignore this column in the file when running the Import If there is no option within the drop down to select, leave it as IGNORE
When running an Import, your platform needs to know which column(s) can be used to uniquely identify each row, this is important as the importer supports both creating Users and updating Users, if each row is not uniquely identified by its key columns there is a risk that the existing Users will be overwritten with the details of new Users. Use the ‘Key column' field to select 'Yes’ for your unique identifiers. Key Columns for Users Key Column(s) are used to identify Users, so that your platform to differentiate between one User and another User. For example, if you have two User with the same name ‘John Smith’, your platform needs to know the difference between the two, in this case you could set your key column to UserID (because this should always be unique for each individual user), or a combination of Forenames, Surname, Email, and DOB, because this combination will be different for the two Users. If there isn’t an existing column or combination of columns that can be used to uniquely identify your Users from one another, a common way to manage this issue is to generate a unique code for each User and record this as the ‘External ID’, then use ‘External ID’ as the Key Column for your import. Click the ‘Finish’ button at the top right of your page to complete your Import Profile Click the ‘OK’ button to return to the ‘Import Profiles’ page
Your Import Profile has now been created Please note The columns within your Import Profile MUST match the columns within your .csv file in the exact same order otherwise your Import will not work.
Run a sample Import Job
Before you run your full import into the platform, we recommend that you first run a test to check that your Import Profile has been set up correctly.
This involves only importing a small sample of Users and checking that they have imported correctly.
To run a test Import Job, you will follow these steps:
Create a sample import file
Run an Import Job
Check the Users
Create a sample import file
This step will show you how to import your sample Users using your Import Profile
Open the .csv file that you created for your import earlier and remove data so that you only have 3-4 lines of data remaining in the file Go to ‘File’ in the top left hand corner Click ‘Save As’ to save this as a new import file
Do not click ‘Save’ as this will overwrite your import file Rename this version of your import file so that you know if it is the test import file, for example 'User Import - Test File', and make sure that the format is still CSV (Comma Delimited) (*.csv) Click the ‘Save’ button to create your Test import file
You are now ready to run your test import Please Note
If your organisation/business operates using other Languages, when saving a .csv file, ensure that the document is saved with ‘,' rather than ';’ as this can prevent the document from Importing
Run an Import Job
This step will show you how to import your sample Users using your Import Profile
Click ‘Profile’ and then ‘Administration’ in the top right corner of the Platform Scroll down the menu and click ‘Import Jobs’, the menu is in alphabetical order Click on the ‘Import Jobs’ option to be taken to the Import Jobs page Click ‘New job’ in the top right hand corner Select your Import Profile from the ‘Profile’ drop down menu From the File option, click on the ‘Choose File’ button and upload the Test file that you created in the previous step The ‘Initial State’ option is where you can choose to Import now, or put the Import on Hold if you would like to set the import off to run later Click the ‘Upload’ button to start the Import Job Once you have uploaded your file to start the Import Job, your page will show the Import job being processed
a. ID - This is the ID number of the Import Job
b. Profile - This is the name of the Profile used for the Import
c. Filename - This is the name of the Import file uploaded
d. Status - This is the status of the Import Job, it will begin as ‘Queued’ but will change to ‘Completed’ once the Import has finished
e. Due - This is when the Import is due to run
f. Started - This will be blank to begin with, once the Import Job has started, the Start date and time will populate.
g. Completed - This will be blank and will populate once the Import has completed
h. Row Count - This shows how many rows are to be imported
i. Processed - This will show the number of rows that have been imported and will change as the Import runs.
Your Import will have the status of ‘Completed’, the Completed time and date will be populated and the Processed' column number will match the same number as the ‘Row Count' column Once your import is complete, click the ‘Show Errors' button to see if there were any issues with the import Example of an Import with no errors: Example of an Import with Errors: The Import Errors page shows you which rows have failed The ‘Stop’ and ‘Restart' buttons can be used while your Import Job is processing, to pause and restart your import, please note that it can take a few seconds for these to be actioned after you have clicked them We do not recommend using the 'Delete’ button for your Import Jobs unless absolutely necessary Move on to the next step to check whether your Import Profile has worked or not.
Check the Users
This step will talk you through the process of checking your new Users have imported correctly
Select Users from the Main Navigation Menu This will open the User DataGrid with a list of all Users Available Add an additional column into your DataGrid using the ‘Change Columns’ button in the top right hand side of the DataGrid Use the ‘+' button to add the column ‘Date Created’, sort this ‘Descending’ and click on the 'Apply’ button, this will add this column to your Users DataGrid and show the most recently created Users at the top One User at a time, right-click on each imported User and select ‘Edit’ from the context menu options Check that the details of the User have been imported as expected, for example: The First and Last Name is correct The correct Account has been assigned Their Status is correct All Addresses are correctly entered + any other information you have imported If you are satisfied that all the sample Users have been imported correctly, your testing is now complete
Run your Import
Once you have run your test import and you are happy that everything imported correctly, you are ready to import your Users!
Go back to the original .csv file that you created earlier (which contains all of the Users you plan to import) within Excel and open the file with all your data showing and check you are happy with the file Within your accessplanit platform, open the ‘Administration’ menu from the Profile options at the top-right of your platform Scroll down the menu and click ‘Import Jobs’, the menu is in alphabetical order Click on the ‘Import Jobs’ option to be taken to the Import Jobs page Click ‘New job’ in the top right hand corner Select your Profile from the drop down menu. This is the name of the Profile created in the step above. In this case it is ‘Users - Users Import’ Select the ‘File’ you wish to upload, this is the original import file you created and saved earlier The ‘Initial State’ option is where you can choose to Import now, or put the Import on Hold if needed Click the ‘Upload’ button to start your Import Jobs Once you have uploaded your Import Job, it will show the Import Job uploading a. ID - This is the ID number of the Import Job
b. Profile - This is the name of the Profile used for the Import
c. Filename - This is the name of the Import file uploaded
d. Status - This is the status of the Import Job, it will begin as ‘Queued’ but will change to ‘Completed’ once the Import has finished
e. Due - This is when the Import is due to run
f. Started - This will be blank to begin with, once the Import Job has started, the Start date and time will populate.
g. Completed - This will be blank and will populate once the Import has completed
h. Row Count - This shows how many rows are to be imported
i. Processed - This will show the number of rows that have been imported and will change as the Import runs.
Your Import will have the status of ‘Completed’, the Completed time and date will be populated and the Processed' column number will match the same number as the ‘Row Count' column There is a section at the end of the Import named ‘Actions’. Here you will find the option to ‘Show Errors’, ‘Restart’, ‘Stop’ and ‘Cancel’ your Import You can use the ‘Show Errors’ button to see if anything has stopped your Import from working correctly, if the Import Errors page is blank, this means the data in your import file hasn’t failed any validation checks Please note You can download the errors file to view more information about any failures from the ‘Import Errors’ page If you do not understand what any of the errors mean, please reach out to the support team and they will be able to provide further guidance and help you with your import Example of an Import with no errors: Example of an Import with Errors: The Import Errors page shows you which rows have failed The ‘Stop’ and ‘Restart' buttons can be used while your Import Job is processing, to pause and restart your import, please note that it can take a few seconds for these to be actioned after you have clicked them We do not recommend using the 'Delete’ button for your Import Jobs unless absolutely necessary
FAQs
Marketing Opt In Field
The ‘Marketing Opt In’ field can be added as a column to update as part of the User import!
How do I import the sex of users?
You must import the sex of each user in a letter format F = Female M = Male O = Other I = Intersex U = Unknown