Custom importers: Preparing data
Learn more about ‘Custom Importers‘ and how to prepare your data before upload and importing to your site
Custom Importers
Be able to effectively use the ‘Custom Importers’ functionality on your intranet
For guidance on how to import data via Admin see the full how to guide.
CSV formatting
The following rules apply when creating a CSV file:
- Comma-separated value format only
- No empty columns
- Do not include any columns with attributes that are not defined in the formats outlined
- Remove any non-mandatory columns that have not been used
- Attribute titles are case sensitive
- TF8 encoded only
Preparing your data
User import
* = Mandatory field. ** = Mandatory field if you are using single sign-on
⬇️ Download User import sample
| Field | Description | Rule | Format | Description |
| id * | GUID. This is the unique identifier for each user. | Must be unique. | String | b1d084c4 |
| email * | The email address of the user. | Must be unique. | ||
| username * | We recommend using the email address here if you do not have a current set of usernames. | Must be unique. | String | |
| email * | The email address of the user. | Must be unique. | ||
| authname ** | The unique string used for SSO (in most cases this will be the same as the value used for GUID) | Must be unique. | String | Could be anything |
| forename | The person’s first name. | String | Laura | |
| surname | The person’s last name. | String | Marling | |
| date of birth | The person’s birthday | String | 10/07/1985 | |
| mobile phone | Mobile phone number of the person. | String | 01987654321 | |
| desk phone | Work phone number of the person. | String | 01234567891 | |
| location | The unique identifier of the person’s location. | This must reference an existing location in the system. | String | Chertsey House |
| jobrole | The unique identifier of the person’s job role. | This must reference an existing job role in the system. | String | Auditor |
| member Of | The unique identifier of the person’s team. | This must reference an existing team in the system. | String | Sales and Marketing |
| A user can be added to multiple teams via import. Each team should be separated by ||| in the csv file | ||||
| Link to the person’s LinkedIn profile. | URL | https://www.linkedin.com/in/lauramarling/ | ||
| Link to the person’s Facebook profile. | URL | |||
| Link to the person’s Twitter profile. | URL | https://twitter.com/LauraMarling | ||
| external id |
A_field_to_store_an_organisational_identifier |
String | Akagera Ltd | |
| manager | The unique identifier (GUID) of the person’s manager. This will be used to build the Org Chart on the site. | This must reference an existing user in the system. | String | Maxine Hayes |
| hide email | Hide or show email address | String |
Add ‘1’ if you want to hide, ‘0’ if you want to show |
|
| hide phone numbers | Hide or show email address | String |
Add ‘1’ if you want to hide, ‘0’ if you want to show |
|
| status |
For the users you want to block or activate – ‘blocked’ or ‘active’.
|
String | Blank field will default to ‘active’. |
Team import
* = Mandatory field.
⬇️ Download Team import sample file
| Field | Title | Rule | Format | Description |
| id * | Unique identifier used to reference this location. | Must be unique. | String | location-1234 |
| parent | Use the ID (above) to reference a parent team if you have a team hierarchy. This will help build the team hierarchy on your site. | String |
team-1233 |
|
| description | A description of the team, which will display on the team page. | String | This is the marketing team, responsible for marketing our product. | |
| type | This field allows you to display contact information for the team which will display on the team page. | String |
To get in contact with the marketing team use this shared inbox – marketing@akagera.com or alternatively call 0987654333. |
|
| published | Define whether or not the team should be published and visible. 1 = Published 0 = Unpublished |
Integer | 1 |
Location import
* = Mandatory field.
⬇️ Download Location import sample file
| Field | Description | Rule | Format | Description |
| id * | Unique identifier used to reference this location. | Must be unique. | String | location-1234 |
| title | The name of the location. | String | Chertsey House | |
| parent | Use the ID (above) to reference a parent location if you have a location hierarchy. | String |
location-1233 |
|
| description | A description of the location, which will display on the location page. | String | This is our head office. | |
| published |
Define whether or not the location should be published and visible. 1 = Published |
Integer | 1 |
Job role import
* = Mandatory field.
⬇️ Download Job role import sample file
| Field | Description | Rule | Format | Description |
| id * | Unique identifier used to reference this job role. | Must be unique. | String | jobrole-1234 |
| title | The name of the job role. | String | Digital Workplace Manager | |
| description | A description of the job role if necessary. | String | Manager of the site in internal comms. | |
| published |
Define whether or not the location should be published and visible. 1 = Published |
Integer | 1 |
Couldn't find what you're looking for?
We're here to help. Please raise a support request via our help desk and we'll get back to you asap