Importing and Exporting Accounts

Abstract

How to import and export accounts

Important

Importing and exporting data to accounts requires the Tempo Account Administrator permission.

You can import accounts by setting the data up in CSV format. The CSV file can either be in a custom format or imported from template.  Previously imported or manually created accounts can also be exported in the Tempo Accounts Template CSV format. The status of imported accounts will be open. You can change the account status, if needed.

Important

The Account Custom Field is installed automatically with Tempo Accounts, but needs to be associated to Jira screens according to your needs.

To access the Import/Export Accounts page:
  1. Select Settings Settings.png in the Tempo sidebar.

  2. Under Accounts, select Import/Export.

Importing CSV Files
  1. On the Import/Export Accounts page, click Import from CSV. If you want to create the CSV file from a template, click Download the Template.

  2. Click Browse and locate the .csv file to import.

  3. On the Map CSV fields to Account attributes page, match up the account attributes with the CSV header rows by selecting the appropriate row from the drop-down. If you use the recommended CSV header rows from the template, these fields will auto-fill. The following columns can be read by Tempo. Columns that are required are marked with an asterisk (*).

    Map CSV fields to Account attributes
  4. When you have mapped all attributes correctly, click Next.

  5. On the Validation page, Tempo validates the CSV file and indicates if there are any problems with converting the information, such as duplicated values or user names that cannot be found in the system. If all data is validated and confirmed, select and Import Option:

    • Update and add to current accounts list. The imported accounts will be added to the list of current accounts. OR

    • Archive existing accounts not included in the CSV file. All existing accounts will be archived and replaced with the imported accounts.

  6. Click Import.

CSV File

The CSV file can either be an export from an external account system or a file that is maintained manually. The table below explains the CSV file template attributes or columns.

NoteWhen importing, the delimiter in the file has to be a semicolon (;). Quotes around the values are not mandatory.

Table 2. The CSV file attributes/columns in order, both required and optional

Order

Name

Required*

Description

1

Account Key

Yes

Unique identifier for the Account Name, but it is also used as primary key for an account dataset. 

Notice

The key can be a combination of any letter (a-z, A-Z), digit (0-9), underscore ("_"), dash ("-") or a dot (".").

2

Account Name

Yes

Descriptive name for the account. The combination of the Account Key and Name is used to display the account in a Jira issue or in the Log Time dialog box. 

Notice

The Account Key and Name are the only required values to be included in the import file.

3

Customer Key

Yes

Unique identifier for the Customer Name, which is only displayed on the add account Customers view.

Notice

If an imported Customer Key already exists, the Customer Name is updated with the imported Customer Name.

4

Customer Name

Yes

Descriptive name for the customer. The customer is a way to group together Jira projects or cost centres by customer or a common entity of your definition for the projects. 

Notice

The Customer Key and Name always need to be a pair in an import file.

5

Customer Contact

Yes

This is someone who represents the customer, either internally or externally.

6

Category Key

Yes

Unique identifier for the Category Name, which is only displayed on the add account Categories view. 

Notice

If an imported Category Key already exists, the Category Name is updated with the imported Category Name.

7

Category Name

Yes

Descriptive name for the Category. This is a way to create a division for an Account/Customer like Development or Marketing

Notice

The Category Key and Name always need to be a pair in an import file.

8

Account Lead Username

Yes

The Account Lead is responsible for the account. The value provided for the Account Lead in the import file needs to be the Atlassian user id for the Account lead user and matches an existing Jira username, this user is stored as the Account Lead.

  • If the Account Lead Name is the only value provided, it is used instead.

  • The Account Lead Username takes precedence if the Jira username value is provided.

9

Account Lead Name

Yes

See no. 8 above on Account Lead Username.

10

Jira Project Key

No

The project key as in Jira. Use comma (",") separator to import keys for many projects for the same account. 

Notice

Remember that the column delimiter is a semicolon (";").

11

Global Account

No

If you want the account to be Global, add value TRUE for this attribute in the import file and it will be displayed as Global in the linked Projects column in the Accounts Browser. 

Notice

This means the account can be included in every Jira project.

If the value is FALSE or no value is provided, the account is not Global.

12

Monthly Budget

No

The final available attribute is to add a Monthly Budget if preferred to the account



* Required attribute/column, which means that the column must be included with a semicolon delimiter in the file, even though it has no value. The only required values are the Account Key and Name for successful import.

Notice

  • The Account Key - NameCustomerCategory and Account Lead Name are all searchable in the Account Timesheet and account Reports.

  • If the relationship between an account and a project is one-to-one, then the account is selected by default when a new issue is created in the project.

An example of a row in a CSV file, where two optional attributes are included, e.g., a Jira Project Key (TST) and a Global Account as false.

12000002;TM Software: Tempo;12345;Tempo Development;John Doe;300;Internal Dev.;JJ;John Johnsson;TST;false

The Account, Customer and Category keys do not need to be numeric.

An example from the Tempo template where the Customer and Category Keys are not numeric (only required attributes are shown in this example).

#Account Key;Account Name;Customer Key;Customer Name;Customer Contact Name;Category Key;Category Name;Account Lead Username;Account Lead Name2200001;Acme Development;ACME;Acme Corporation;John Steel;DEV;Development;erica;Erica Jefferson

Exporting Accounts

You can export account data in CSV format.

  1. Select Settings Settings.png in the Tempo sidebar.

  2. Under Accounts, select Import/Export.

  3. Click Export Accounts.