Master List of CSV File Headers

TOPICS


Job Assignment 

Heading Format Notes
fullname (optional)

Up to 100 characters

Can include spaces, ampersands, parentheses, forwardslashes

Job assignment title.
useridnumber 1-100 characters The user's ID number.
timemodified Unix timestamp The last time the item detail changed.
deleted 0 or 1

Required when only job assignments to create, update, or delete are provided. Otherwise, not necessary.

Entering 0: Does nothing.

Entering 1: Deletes the job assignment.

Empty: No action assumed. 

idnumber 1-100 characters

Matches the valid job assignment number. Null assumed if a value is not provided.

To assign a user to a manager, the user must have a job assignment. 

startdate (optional) CSV import date format Data in the field needs to match the format defined under Location > Location settings > CSV import date format. 
enddate (optional) CSV import date format Data in the field needs to match the format defined under Location > Location settings > CSV import date format. 
orgidnumber (optional) 1-100 characters Matches valid organization ID number. Null assumed if a value is not provided.
posidnumber (optional)  1-100 characters Matches valid position ID number. Null assumed if a value is not provided. 
appraiseridnumber (optional) 1-100 characters Matches valid user ID number. Null assumed if a value is not provided. 
manageridnumber (optional) 1-100 characters Matches valid user ID number. Null assumed if a value is not provided.

managerjobassignmentid

(optional; mandatory if manageridnumber is enabled)

 

Automatically required if manageridnumber is set to on, and updateidnumbers is off (i.e., you are using more than one job assignment). 

ID number for the specific job assignment involved in the manager relationship. 

Back to TOPICS

Organizations, Positions, and Competencies

Heading Format Notes
idnumber 1-100 characters Unique for each hierarchy item.
timemodified Unix timestamp The last time the item detail changed.
frameworkidnumber 1-100 characters ID number that matches an existing hierarchy framework. 
shortname 1-100 characters  
fullname 1-1000 characters Position, organization, or competency name. 
parentidnumber 0-100 characters

Matches the ID number of another hierarchy item. 

Left empty for the top level.

description Up to 1000 characters, describing the organization If unnecessary, this field can be left empty.
typeidnumber 0-100 characters Matches the ID number of an existing item type.
deleted 0 or 1

Required only when organizations, positions, or competencies to create, update, or delete are provided. Otherwise, not necessary.

Entering 0: Does nothing.

Entering 1: Deletes the organization, position, or competency.

customfield_[shortname] (optional) Up to 1000 characters

Custom field data. Multiple columns allowed, where the column heading matches the type's custom field shortname. If no match, nothing will be updated.

If the custom field type is date format, then the data in the field needs to match the format defined under Location > Location settings > CSV import date format. 

aggregationmethod 1, 2, or 3

Note: Competency source only.

is the All aggregation method.

2 is the Any aggregation method. 

is the Off aggregation method. 

Back to TOPICS

Users

Heading Format Notes
idnumber 1-100 characters

Unique for all users (never changes for a given user). 

Use the value shown in the User profile Optional field ID number. 

Check the ID number value exists for existing users if you want to update existing user's profile fields. 

username 1-100 characters Unique for all users.
timemodified Unix timestamp

Last time the user's details were changed. 

Note that if the same value is imported on a subsequent sync then the sync records will not be updated. 

deleted; suspended

0 or 1; 0 or 1

Required when only users to create, update, or delete are provided. Otherwise, not necessary.

Entering 0: Does Nothing

Entering 1: Deletes/Suspends a user. 

Empty: No action assumed.

However, when an empty suspended field is included in the user source for new records and the Empty strings erase existing data option has been chosen, the added user gets the default value of Active. The erasing of the data does not mean there is no value in the field if the field has a default value. 

firstname 1-100 characters No leading or trailing space characters.
lastname 1-100 characters No leading or trailing space characters.
firstnamephonetic (optional) 1-100 characters No leading or trailing space characters.
lastnamephonetic (optional) 1-100 characters No leading or trailing space characters.
middlename (optional) 1-100 characters  No leading or trailing space characters.
alternatename (optional) 1-100 characters No leading or trailing space characters.
email Valid email address, max. 100 characters Unique for each user.
emailstop 0 or 1

Disables non-essential, system-generated email notifications. 

This does not affect the 'Welcome email' received by new or revived users.

country 2 character ISO 3116 country code (e.g. New Zealand: NZ)  
city 120 characters  
timezone (optional) 1-100 characters

A location-based time zone identifier (e.g. America/New_York, Europe/London, Asia/Singapore). 

Click here for a list of all locations.

lang (optional) 1-30 characters 2 char ISO 639-1 code.
description (optional) 1-1000 characters  
url (optional) 1-200 characters  
institution (optional) 1-40 characters  
department (optional) 1-30 characters  
phone1 (optional) 1-20 characters  
phone2 (optional) 1-20 characters  
address (optional) 1-70 characters  
auth (optional)

manual: Manual accounts

nologin: No login

email: Email-based self-registration

cas: CAS server (SSO)

db: External database

fc: FirstClass server

gauth: Google Openid Authentication 

imap: IMAP server

ldap: LDAP server

mnet: MNet authentication 

nntp: NNTP server

none: No authentication

pam: PAM (Pluggable Authentication Modules)

pop3: POP3 server

radius: RADIUS server

shibboleth: Shibboleth

webservice: Web services authentication

oauth2: OAuth 2

 
password (optional) 1-32 characters

If the password column is included and the CSV file has an empty password field, then a 'Welcome email' is sent allowing the user to create their own password. This only works when adding new users. 

If you are adding a large amount of new users without passwords, this will result in a large amount of emails being sent. 

customfield_[shortname] (optional)  1-1000 characters

Custom field data. Multiple columns allowed, where the column heading matches an existing user custom field shortname. If no match, nothing will be updated. 

If the custom field type is date format, then the data in the field needs to match the format defined under Location > Location settings > CSV import date format. 

Back to TOPICS

Export

When exporting competencies, positions, organizations, or goals, the behaviour of custom field types is as per the table below.

Hierarchy exports are available when viewing all competencies, positions, organizations or goals frameworks, or when viewing a specific framework

Custom Field Type Export Import
Checkbox

1 for checked

0 for not checked

Same as export.
Date/Time A timestamp Either a timestamp, or a date in a format given by the 'csvdateformat' configuration setting. 
File Name of the file File custom fields cannot be imported.
Location Address Same as export.
Menu Text of the selected value Same as export.
Multi-select Within quotes, a comma-separated list of the selected values Same as export.
Text area Full value, including HTML tags Same as export.
Text input Value itself Same as export.
URL URL itself; the display text or checkbox value opening in a new window are not included Same as export. 

important-1  NOTE

For text values that include anything other than letters or numbers (special characters), the value should be within double quotes. If the value itself contains double quotes, an additional double quote should be added in front of each, e.g.: 

There are "quotes" within this value

Would be represented like so in the export or import csv files (if importing via external database, this is not necessary), e.g.:

"There are ""quotes"" within this value"

Back to TOPICS