11.9.4. Import a framework file

Administration menu → Extensions → SmartEvidence → Import

You can import a SmartEvidence framework by clicking the Import link in the SamrtEvidence navigation. The framework file must end in the extension .matrix to be recognized and interpreted by Mahara.

Upload a .matrix file that contains a competency framework

Téléverser un fichier .matrix contenant le référentiel de compétences.

  1. Click the Import link to go to the screen where you can upload a SmartEvidence file.

  2. Cliquez sur le le bouton Browse pour sélectionner le fichier qui contient le référentiel de compétences que vous désirez utiliser.

  3. Click the Upload matrix button to upload the file.

The file is checked for issues in the structure of the file. It is rejected if problems are encountered. Most common issues are:

  • The short name has more than 100 characters.

  • The name of a standard element has more than 255 characters.

  • Punctuation or parentheses are not correct.

A JSON validator such as JSON Formatter & Validator or JSON Formatter can usually unearth syntactical errors. Character length errors need to be sorted out manually.

11.9.4.1. Créer un fichier de référentiel de compétences

Get started with a SmartEvidence framework by downloading an existing file. You can then make any number of changes.

Note

If you created your own SmartEvidence framework files that you want to share with the community, please send them to us for review and inclusion in the download area.

You can use any text editor to create and edit your SmartEvidence framework files. If you have an edit that supports syntax highlighting for JSON files, you have an advantage as you can differentiate text that you can change from prompts that Mahara needs to interpret the file more easily.

You can also use a JSON editor, e.g. JSON Editor Online or JSONedit. These make it easy for you to edit the file because you can view it without much of the JSON syntax that is required.

Note

It is best to start your framework file with the help of one of the samples as you then know the structure and have all relevant elements in the file.

11.9.4.2. Début du fichier

Un fichier décrivant un référentiel de compétences contient en en-tête un nombre de paramètres qui vous permet de le modifier à votre guise et en fonction de vos besoins.

The start of a matrix file

L’entête du fichier de la matrice

  1. institution: The short name of the institution in which the framework should be used is entered here. If the framework is for all institutions, all is placed here.

    Note

    The institution short name can be seen by hovering over the institution name on the Institution overview page and looking at the end of the URL. The last parameter is the institution short name.

  2. name : Le titre du référentiel comme il sera affiché aux utilisateurs.

  3. description : La description du référentiel qui sera affichée sur la page du module Compétences dans une collection. Cette rubrique contient du code HTML standard.

  4. Si le code HTML dans la rubriques description nécessite l’utilisation de guillemets, ils doivent être précédé d’un caractère d’échappement. Ceci est réalisé en plaçant le caractère \" avant le guillemet.

  5. selfassess : Indique si les utilisateurs peuvent auto-évaluer leurs compétences ou si elle ne peuvent être évalue que par un tiers. Les deux valeurs suivantes sont possibles :

    • true : Les utilisateurs peuvent s’auto-évaluer.

    • false : Les utilisateurs ne peuvent pas s’auto-évaluer.

  6. evidencestatuses: Currently, there are four evidence statuses that can be used in an evidence map: begun, incomplete, partially complete, and completed. You can decide what words are used for these statuses in the framework that you set up. For example, this allows you to easily set up frameworks in different languages.

  7. standards : Le reste du document concerne les normes et sous-normes qui composent les compétences.

Note

Be careful when changing a matrix file. Make sure not to remove any commas, quotation marks, brackets, curly braces, or any other marks in sections that you use. They are required for the correct interpretation of the file.

Vous pouvez contrôler la syntaxe de votre fichier en collant son contenu dans la fenêtre du service JSON Formatter and Validator par exemple. Si votre fichier contient des erreurs de syntaxe, le service vous indiquera où il conviendrait de modifier le fichier.

11.9.4.3. Section des niveaux de compétences

Vous pouvez définir les Niveaux à la suite des informations initiales. Ils correspondent au niveau des en-têtes de la page d’aperçu du module Compétences.

The standards in a matrix file

Les niveaux dans un fichier matriciel

  1. standards : Introduction de cette section. Vous pouvez définir autant de niveaux que vous désirez. Il n’y a pas de limite.

  2. shortname: Each standard needs a short name, e.g. a number or a summary of the full title. The short name is mandatory and a maximum of 100 characters long.

  3. name : Titre du niveau de compétence. Cette information est requise et peut contenir jusqu’à 255 caractères.

  4. description : La description est optionnelle et elle est affichée lorsque vous placez la souris sur le nom du niveau (toucher-cliquer sur une plateforme mobile).

  5. standardid : Donnez à chaque niveau une valeur cardinale afin qu’il puisse être affiché dans l’ordre que vous désirez et aussi qu’on puisse se référer à cette numérotation dans les éléments de définition de la compétence.

  6. Ne placez pas de virgule après l’accolade finale du dernier niveau.

11.9.4.4. Section des éléments du niveau de compétence

Définissez toutes les éléments qui forment le niveau de compétence; par ex. les sous-niveaux d’acquisition de compétence tendant vers l’acquisition de la compétence globale. C’est à ces éléments que vous allez pouvoir ajouter des production pour prouver l’atteinte de la compétence.

Note

Placez les sous-niveaux directement après le niveau principal afin que le groupage se fasse correctement.

The standard elements in a matrix file

Les éléments d’un niveau de compétence dans le fichier matriciel

  1. standardelements : Introduction à la section. Il n’y pas de limite quant au nombre d’éléments qui caractérisent un niveau de compétence.

  2. shortname: The short name is displayed on the SmartEvidence overview page. It is mandatory and a maximum of 100 characters long.

  3. name : Le titre de l’élément pour le niveau de compétence visé. Cette rubrique est obligatoire et peut contenir au maximum 255 caractères.

  4. description: The description is optional and is displayed when you hover over the name of the standard element (touch-click on mobile).

  5. stadardid : Correspond à l’identifiant (ID) du niveau auquel se rattache l’élément défini avant.

  6. elementid : Attribuez à votre élément caractérisant le niveau de compétence un identifiant unique (ID). De cette manière vous pourrez lier un ou plusieurs sous-niveau à ce niveau. L’identifiant doit être placé entre deux guillemets simples.

  7. parentelementid : Correspond à l’identifiant de l’élément parent. En renseignant cette information, vous faite de cet élément un sous-élément dépendant de l’élément parent. L’identifiant doit être placé entre deux guillemets simples.

    Note

    Lorsqu’un élément qui caractérise un niveau de compétence a un sous-niveau, le premier ne peut pas être associé à une production; seul le dernier sous-niveau peut se voir attribué une production par l’utilisateur afin de prouver qu’il a atteint celui-ci.

11.9.4.5. La fin du fichier

Lorsque vous avez défini tous vos niveaux ainsi que les éléments qui les caractérisent, vous pouvez terminer le fichier.

The end of a matrix file

La fin du fichier matriciel

  1. Ne mettez pas de virgule après la dernière accolade du dernier élément de niveau.

  2. Assurez-vous que tous les crochets.

11.9.4.6. Le résultat

Once you finished the file, you can import it into Mahara and start using it.

The finished result once uploaded

Le résultat final une fois le fichier téléversé

  1. Titre du référentiel de compétences

  2. Description du référentiel de compétences

  3. Un niveau. On ne peut pas lui attribuer une production. Les productions sont attribuées seulement au plus bas des sous-niveaux.

  4. Un élément d’un niveau de compétence

  5. Un niveau de compétence avec un sous-niveau. Seul le dernier sous-niveau peut se voir rattaché des productions.

  6. Un troisième niveau d’éléments.

    Note

    Vous pouvez avoir plus de trois niveaux dans votre référentiel. Toutefois la lecture du référentiel décroît avec l’augmentation de son nombre de sous-niveaux.