Labels are tags that can be applied to data in Handshake to help you classify and organise that data within the system. Labels can be applied to students, contacts, employers, and jobs. There are three types of labels in Handshake: normal, public, and system.
This article will highlight the process of bulk importing a normal or public label onto data in Handshake via the Importer.
You can only import 10 unique labels per file. If you have more than 10 different labels in the file, you'll need to split your existing file into multiple separate CSV files.
Prerequisites
- Make sure you have access to the Importer Tool.
- Understand how to manually add/edit a label in Handshake - refer to Institution Settings: Labels for more information.
Best Practice: to ensure your label is connected to the appropriate Used For type, we recommend manually creating the label in Handshake first, then adding the label via the Importer.
High Level Workflow
- Format your CSV file according to the specifications below.
- Upload the CSV file to the Importer with the file-type Labels.
- Review any error messages or file warnings once analysis completes.
- Choose the button to Run Job.
Available fields for importing a Labels file
Download an example Labels CSV file
The fields listed below should be formatted as shown and saved as a CSV. Column headers are case sensitive and should be in all lowercase. If any of your headers differ from the formatting included below, the Importer will not identify it and it will be skipped. We recommend reviewing the example file linked above to ensure correct header formatting.
Required Fields: The column headers marked as required are necessary in the file. The column values marked as 'can't be blank' must contain values. Column values that aren't required can be left blank - this will not erase any existing data in that field.
Optional Fields: You can leave out any headers or values that are not marked as required - this will not erase any existing data in that field.
| Column header | Column value |
|---|---|
| identifiable_type *Required |
The object type you are attaching a label to. User *Can't be blank |
| user_type *Required |
The user type you are attaching a label to. Must use one of the following (case sensitive): Students Only used when uploading a label to a User. If you are uploading a label to a Contact, Employer, or Job, leave this field blank but still include the header. |
| identifier *Required |
|
| identifiable_id *Required |
|
| name *Required |
This is the name of the label you want to use. Only one label name can be inserted into a row. |
| label_type |
Must be on of the following: normal For more information regarding label types, see Handshake's Guide to Using Labels |