# Records of learning

{% hint style="info" %}
Records of learning require Business or Enterprise plans
{% endhint %}

All attempts done on Synap are stored against exams and users, and if you're using assignments there is a record of all the users progress and certifications on Synap. However some things are done off platform and with Synap's records of learning you can import and recreate these records and store them on Synap.&#x20;

**Examples of Record of learning use**

* Storing person interview assessments scores
* Additional qualifications&#x20;
* Importing previous attempts from another LMS / platform&#x20;
* Storing certifications and certificate files&#x20;
* Recreating qualifications which have expiry dates&#x20;

<figure><img src="https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2FPyLSK7G01quVGNnbKpts%2FScreenshot%202023-12-07%20at%2010.06.58.png?alt=media&#x26;token=47b5f30a-b271-4a7a-a50a-950a2e3c3842" alt=""><figcaption><p>Record of learning on a user</p></figcaption></figure>

### Navigating to the Records of learning table

To find a user's Record of learning, select a user through a group and navigate to their **Overview** then under the management section go to their individual **Record of learning** page.

<figure><img src="https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2F6Rxg0OqfuAjAOeeDUwUS%2FDashboard%20_%20Synap%20Portal.gif?alt=media&#x26;token=ab3cf939-ab3a-41b7-9512-b7aa16d34486" alt=""><figcaption><p>Finding a users record of learning </p></figcaption></figure>

### Record fields

There are 3 default fields when creating a record:&#x20;

* `Record name` which is required for every record&#x20;
* `Score` is not required but we do recommend inputting it where possible, stored as a percentage&#x20;
* `Record date` this is the date of the record activity, not the date you are creating the record on

You can create your own additional custom record attributes which will show as additional columns on the record table.&#x20;

<figure><img src="https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2F26WhcuNhqgqpB9zCOoco%2FScreenshot%202023-12-07%20at%2012.55.03.png?alt=media&#x26;token=f4ff6f7b-d570-4359-9737-5ee7a3e7ad96" alt=""><figcaption><p>Default fields and custom record attributes</p></figcaption></figure>

Records of learning come with an additional `File` type attribute which can be used to attach files to a particular record row

| Attribute type  | Expected value on CSV                                                                                                                                        |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Checkbox        | `TRUE` or `FALSE`                                                                                                                                            |
| Long answer     | `string`                                                                                                                                                     |
| Short answer    | `string`                                                                                                                                                     |
| Multiple choice | One of defined `options`                                                                                                                                     |
| Checkboxes      | defined `options` separated by commas                                                                                                                        |
| Number          | Any numerical value                                                                                                                                          |
| Date            | `DD/MM/YYYY`                                                                                                                                                 |
| Link            | Choose whether to display as text or as a button. The link can be typed as an absolute URL (opens in new tab), or a root-relative URL (open in the same tab) |
| File            | Only `.pdf`  files are accepted on platform or through the API. Files uploaded through the API are limited to 5mb each, or 10mb per request.                 |

### Custom Record of learning attributes

To make custom record attributes to store extra information against your Records of learning go to **Settings** > **Data management** > **Attributes** > **Records of learning.** From here you can create new record attributes the same way as other attributes on platform&#x20;

<figure><img src="https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2FU1QPGbpsiDVkhWcePmaj%2FScreenshot%202023-12-07%20at%2013.01.17.png?alt=media&#x26;token=958a1eda-c7a3-4bbf-b458-fe9e9baaa60e" alt=""><figcaption><p>Creating new Record of learning attributes </p></figcaption></figure>

{% content-ref url="attributes" %}
[attributes](https://academy.synap.ac/doc/portal-settings/data-management/attributes)
{% endcontent-ref %}

### Creating a new Record of learning

From the records table click the **Add record** button, a modal will open with all the available fields to add a new record&#x20;

<figure><img src="https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2FfZJwbvMNcaBu5iES4VnA%2FAddNewRecord.gif?alt=media&#x26;token=479ae805-8666-4823-895b-7ebba45f3463" alt=""><figcaption><p>Creating a new record </p></figcaption></figure>

### Student side Record of learning

Enable the student side record of learning by navigating to **Settings** > **User Access** > **Students** > **Student Insights** > **Enable Records of learning tab**

<figure><img src="https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2Fqz9umX4ACDm8i7ZZBjo3%2FScreenshot%202023-12-07%20at%2016.58.43.png?alt=media&#x26;token=e6e35d2a-608f-44c0-ad2f-1a9970ac12be" alt=""><figcaption><p>Enable Record of learning to show to students</p></figcaption></figure>

Once enabled students will be able to navigate to their Insights page and to a Records of learning tab to view all the records set to them. Note if any record attributes have been hidden from student users they won't see any values for these fields.&#x20;

<figure><img src="https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2FEwqpEU8sFz4kGcDDT7Uj%2FrecordStudent.gif?alt=media&#x26;token=19f773f6-eb66-4aa9-839f-5524e8a696d0" alt=""><figcaption><p>Student Record of learning</p></figcaption></figure>

### Advanced permissions for Records of learning

{% hint style="info" %}
Advanced global and specific permissions required, available on Pro and Enterprise plans - get in touch with support to discuss upgrading and enabling
{% endhint %}

All admins and managers will be able to create, delete, and edit Records of learning. You can create custom roles using advanced permissions on specific educator groups to allow certain educators to edit/delete/create Records of learning for a specific user group. To do this you'll need to have or make a custom educator group

<figure><img src="https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2FBhm7hq9ynnL6hFJ7vURe%2FScreenshot%202023-12-08%20at%2008.57.29.png?alt=media&#x26;token=070fede3-5c85-4351-bc1d-cb61e527a306" alt=""><figcaption><p>Educator group creation</p></figcaption></figure>

Go to the specific user group's access page to give a specific educator group permissions related to Records of learning. In the example below the **'💿 Record makers'** is allowed to view and edit existing records for the **'👨‍🚀 Astronauts'** group, they can't create or delete new ones but this could be configured.

<figure><img src="https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2F2krZayVh4jtWDaW67SGl%2FScreenshot%202023-12-08%20at%2012.34.16.png?alt=media&#x26;token=3367780b-5ad1-4982-91bc-0e0706ef0e7d" alt=""><figcaption><p>Advanced permissions for Records of learning</p></figcaption></figure>

***

### Record of learning API&#x20;

Use Synap's API for Records of learning to automate workflows. [API Docs](https://docs.synap.ac/#ce7d0f9f-d634-4998-8260-167acc9a54d7)

<details>

<summary>Record of learning API </summary>

* **GET** all Records of learning for user a `https://api-org.synap.ac/learning-records/?userId=id1234&page[limit]=2&page[offset]=0`

```
page limit - max number of learning record to return
page offset - point at which to start returning learning records
```

* **DELETE** a Record of learning `https://api-org.synap.ac/learning-records/:learningRecordId`
* **POST** a Record of learning `https://api-org.synap.ac/learning-records`
* **PATCH** an existing Record of learning `https://api-org.synap.ac/learning-records/:learningRecordId`

When creating your request bodies with form data. Please ensure that values are JSON spec compliant, eg using double not single quotes: `"["foo","bar"]"` not `"['foo', 'bar']`&#x20;

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://academy.synap.ac/doc/portal-settings/data-management/records-of-learning.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
