Breadcrumbs

Badge Assertion Batch Process

Utilizing the Badge Assertion Batch Process enables the importing of Badge assertions through a batch process. This process aids in the creation of a large number of records with minimum effort utilizing a CSV file. Students have the ability to share their badge on social media, validate the badge, or import it to their digital wallet. 

🖥️

Product Tip: Institution Admins should ensure that all badges included in the badge assertion file are pre-existing in the platform. In the event that the assertion file includes badges that have not yet been created, delivery of badges could be delayed.

The badge assertion file can be imported by adding the file to your institution's existing SFTP server.

  • Files should be UTF-8 encoding format and initially (until files are validated) they should be added to the Validation folder. Once validated, files can then be added to the root folder.

The import process will be handled asynchronously using the Assessment Management Product’s standard nightly import process. Once the CSV File is processed via the import process, students are emailed a notification to claim their new digital badge. The Badge Settings article can be reviewed to learn more about the badge notification email.

The fields listed below are to be included in the CSV file for badge assertions; headers and the values in the file are to be placed between double quotes. The image below provides an example of an import file for reference.

image-20240529-210901.png

Field

Input

FirstName

Required. First name of learner

LastName

Required. Last name of the learner

User

Required. This field is utilized to match the Student to a platform user account. Valid entries can be email, university id, or username and predefined prefixes (shown below) assist HelioCampus during data file import.

If a username or university ID is provided for one or more records, and there is no matching user in the platform, the row will be rejected during the data file import to prevent the potential for duplicate accounts. If an email address is provided for one or more records, and there is no matching user in the system, a new guest account will be created to support non-SSO users.

🔎

Example

Example values can include the below, with the predefined prefixes of “email:”, “univId:”, “username:”:

If no prefix is defined, HelioCampus will assume the provided input is a Student university id.

AwardedDate

Required. Date the badge was awarded in the format of “YYYY-MM-DD:hrs:sec:mS”

Example: “2023-01-15:T04:30:00+0000”

Code

Required. The badge code can be located by navigating to Main Menu > Credentials > Badge Manager

ProcessDate

Required. The process date is the date the file is sent to Heliocampus in the format of “YYYY-MM-DD:hrs:sec:mS”

Example: “2023-01-15:T04:30:00+0000”

📔 Additional Resources