The table below lists the tools available to administer your system and your users and the privilege needed to use them:
Tool: | Available to: | Description: | |
---|---|---|---|
System Admin ID | Instructor ID | ||
Menu Creation | Yes | No | Used to create new items in the Main Menu (submenus, lessons, media links, ...), change existing menus and re-arrange menu content. |
System Attributes | Yes | No | Controls menu access by users or classes |
System Refresh | Yes | No | Refresh the system of all users and their data at term end or when desired using an import file. The menu layout and the lessons are not impacted by this action. |
Yes | Yes** | Allows the System Supervisor to create, change or delete a list of users (students and instructors) and classes using a tab separated text file.
** Since the 2015 09 29 version of CAN-8, instructors can use an import file to create their students and classes. They cannot create, delete or edit instructors' profiles not can they use it to delete other users than their own students, or delete classes.
In versions of CAN-8 pre-dating 2015, instructors cannot use import files. |
|
Class Function | Yes | Yes | Organizes student in groups for easier management. |
Manual Users Registration | Yes** | Yes | Used to create, edit or delete users. ** Note that the System Supervisor can ONLY register instructors using that tool, while instructors can only register/edit/delete students.
Although the system supervisor cannot register students with this tool, she/he can edit or delete their profile. |
Activity Reports | Yes | Yes | Display a log of the activities recorded in CAN-8 per user, date, or class group. |
The System Attributes are used to show/hide menu entries to the users by matching an attribute assigned to a menu or lesson to a profile or a class. A user with the attribute X will see the menu with the attribute X only.
It is therefore important to take the time to figure out the overall menu layout before proceeding with its creation so that attributes can be added as you create items and users. It will be much more time consuming to set up the attribute system after the menu entries are created.
Although other tools are available in CAN-8 to show/hide specific menus to the users, the attributes allow a much more flexible menu display.
The first step when defining system attributes is to create a layout of the system's organization.
This layout is unique to the need of each site, and therefore can only be created by the site administrator in consultation with the instructors. The following sample is only meant to illustrate how attributes are used:
In this illustration, Site A offers several language courses, each language divided by fluency level. Users progress over the sessions from Level 1 to 4:
The attributes selected represent each language, and each level.
When each menu is created, it is assigned an attribute, as defined in the attribute table. For example, in this illustration, the English menu is assigned attribute E and the French menu is assigned F. The Introductory level submenus for both languages are assigned the attribute 1, while attribute 2 is assigned to LEVEL 2, and 3 to LEVEL 3.
When students are registered, they are assigned the attributes for the menus that they will use. For example, a student with the attributes E, 1 will see only see in the menu the LEVEL 1 of the English menu, while a student with the attributes E, 1, 2 will see LEVEL 1 and LEVEL 2 English submenus. Next session, the next level's attribute can be added to their profile and they will be able to see the next level's entries in the menu.
Similarly, attributes can be assigned via classes. When a class is created, you can assign the attributes for the menus that will be used by that class. All students added to that class will inherit these attributes independently of the attributes assigned in their profiles. This facilitates the users' assignment. Simply changing the attributes for a class will change the attributes for all students (and instructors) who are members of that class.
If you create a class per level with the corresponding level's attribute, then simply adding the student to the next class will add the new attribute to the student's profile.
Although instructors can assign attributes to students and classes, only the System Supervisor can define them in the system and assign them to menus.
Up to 16 system attributes can be defined. Each one consists of a single letter or digit, and of a brief description of the attribute use. The selection of the letter and the description is left to the System Supervisor in consultation with the instructors.
The letters or numbers in the Attribute column are selected as mnemonic aliases for the attribute numbers. A simple system that uses E for English, F for French, and S for Spanish for example is recommended. However, the selection of letters is arbitrary. Any letters or digit can be used to classify the menu items.
By default, the CAN-8 system comes with one pre-defined attribute (attribute D). It is automatically assigned to all menu items and users created.
This attribute can be changed/removed at the user's discretion.
To define the system attributes:
The Attributes assigned to menus only show on the System Supervisor's interface. Students and instructors will not see them when they sign in. The attributes descriptions can only be viewed in this window.
Once the system attributes have been defined, any menu/sub-menu/lesson and user created will get all the attributes. The unwanted attributes can be removed at the time of creation. (This will be detailed later on in this chapter).
Note that:
Depending on the type of profile the user is registered with, the menu displayed is different:
User Profile Type |
Students' Menu And Sub-Menus |
Instructors' Menu And Sub-Menus |
System Supervisor's Menu And Sub-Menus |
---|---|---|---|
Students | Yes | No | No |
Instructors | Yes | Yes | No |
System Supervisor | Yes | Yes | Yes |
The illustration above is the default menu assignment per user role. These pre-defined menus already include certain entries. On a new system, they are the functions such as Register Users or Change your Password. These entries types are called Internal Command: they link to a system function.
This default menu assignment can be changed to restrict the access to a specific submenu, as seen in the attributes section. It can also be changed to give access to a higher level menu. For example, Instructors can be given access to the Master menu, but their access to the functions will not change. This instructor will see for example the link to Edit the attributes, but the system will restrict the instructor from accessing this function as it is reserved to the system supervisor.
As the CAN-8 data base is growing, new menu entries have to be created. The System Supervisor (signed in with the Master ID) is the only user who can create and edit menus. Although Instructors can create the content of a lesson, they cannot create, edit or delete the menu entry for that lesson in the main menu.
To add an entry in the menu:
There are several types of items that can be added to a menu; Each type has a unique function and can be recognized by the icon located in the menu before the title. They are:
Icon |
Type | Description | Corresponding field(s) activated |
---|---|---|---|
EAASy II | This is a lesson/test type entry. The instructors will be able to add exercises and content It is selected by default. |
PATH:
This field indicates the path on the file server that the selected item is to reside in.
This field can be left blank at item creation time, the system will automatically create a path based on some of the letters in the menu item name: SVI\ABCxxx If you choose to enter the path manually, be sure that the path points to a valid directory name on the server and that that you have rights to access it. The default path for CAN-8 lesson folder is SVI\FOLDER_NAME and should be preferably kept so when entered manually to keep an organized structure. FOLDER_NAME should be composed of a maximum of 8 characters or you will receive an error message. |
|
Submenu - closed | Each submenu created in the system can include up to 254 items, including nested submenus up to a maximum depth of 10 linked submenus. | MENU TAG:
This field can be left blank during item creation. The system will assign a non-conflicting tag for the submenu you are creating.
Tags are composed of 6 alphanumeric characters. They can be entered manually at creation but cannot be edited after. If entered manually, choose a descriptive tag will be easier to remember for future use: ENGL01 for English Level 1 for example. This menu Tag can be selected in the user's profile as the INITIAL MENU. |
|
Submenu - expanded | |||
Application link | Provides a link to external applications. When the path to an application is provided in the path field, and the application executable placed in the Application field, clicking on this menu link will start the application in a different window. | The PATH and COMMAND fields MUST be manually filled.
PATH: Type in the path to the folder where the Application's main executable can be found. COMMAND: Type in the name and extension of the executable that you wish to run.(i.e.: notepad.exe) |
|
INTERNAL | Link to one of the CAN-8 functions. | Internal
Select the command name associated to the CAN-8 function you wish to create a menu item for. The complete list of all available internal commands can be accessed via the dropdown selector. Click on the command to select it. |
|
Internet link | Opens the default browser and links to listed site | URL Type in the URL of the website you want the user to reach. |
|
Media link | Provides a link to the default media player on the workstation. When selected in CAN-8, this entry will open via the default media player any file the media player supports. (Audio and/or videos) external applications. | MEDIA Type in the path to the media. This path must be valid on all workstations. If this path points to C:\AUDIO, all workstations have to have an AUDIO folder on the C drive, and if it points to F:\AUDIO where F is a network share, all stations must have a mapped drive named F pointing to the drive where the shared AUDIO folder is located. |
You will find a list of all the system attributes available. By default they are all selected.
Only keep the attribute(s) that apply, deselect the others. For example, based on this illustration, if the menu is meant to be shown only to students in Italian, Level 1, Advanced, then all attributes should be deselected except for I, A and 1.
If you do not use attributes to assign menus, leave all the attributes selected and go back to the main tab.
If you'd like to make changes to an existing menu Item:
Some of the fields such as Path and Menu Tag will be greyed out. You cannot change these.
You may need to move an activity (test or lesson) that has been developed from the instructor's menu to the student's menu so they can access it. Or you may just want to reorganize your main menu differently.
To do so:
If you move an item by mistake or dropped it accidently and cannot find it anymore, you can select Abandon Changes under File in the top menu. Any changes that were made after the last saved menu will be undone.
You may occasionally need to view the tag and attributes of a submenu to assign it to a user or view the attributes and the path of a lesson.
By making a copy of a lesson, we mean creating an independent but identical lesson/test that can be edited without changing the original lesson.
To create a copy:
*** Steps 3 to 6 can be done with an instructor's ID. The system supervisor can sign out after creating the menu entry and leave the other steps to the instructors.
Linking to a lesson differs from copying a lesson in one fundamental way. Both allow you to create a similar activity (lesson or test) in different part of the menus: But whereas copying an activity creates a second independent lesson that can be edited without changing the original lesson, linking to an existing activity only creates a logical link to that lesson. Therefore any changes done to the linked lesson will also appear in the original lesson.
It is also possible to link to an existing submenu and its content using the same menu Tag. The Class Functions submenu is an example of that. It is present both in the System supervisor's menu, and in the instructors' menu.
To create a link to a lesson:
To link to an existing menu
There are 2 kinds of background images in CAN-8.
The one added to a lesson or an activity
and is directly related to the subject being taught, and the image that will be affixed to the CAN-8 main interface when the user first signs in. It may represent the logo of the organization or department using CAN-8, or their mission.
The latter will be placed in the user's profile but must first be imported into CAN-8 by the system administrator. Multiple images can be imported.
Whereas instructors can assign a background image to the students they create, they can only choose among images previously imported in CAN-8 by the system administrator.
From the top menu, select Edit > Background image.
The image selector appears.
Identify on your disk the image you want to import, then drag it directly into one of the empty boxes.
The first box (0) must remain empty. It is reserved for the CAN-8 default interface.
You can import up to 99 images. In this illustration, there are 2 images, one in the box labelled 1, one in the box labelled 2.
The maximum size for these images is 320px by 240px.
To change your background image, click on the image of your choice. The frame turns blue.
Then close the selector window.
.
CAN-8 users will be assigned a unique ID and a password in order to login. They can also be assigned a specific menu. This section of the manual details the creation of the users and the different methods to assign menus to their profiles. Grouping them in Classes is not only a way to restrict their menu, it also facilitates the monitoring display for the instructors. We start this section with class creation, since you can then add the users to the class during registration, but it is equally fine to start by the users' registration before the class creation and add them to a class later.
Classes are virtual grouping of students provided to ease their management.
Using classes, an instructor can:
Important points to remember about classes are:
The Create Class command is located in the Class Functions submenu. This submenu comes by default with the system but may have been renamed or moved to another place by the System Supervisor.
Since the instructors can also create classes, this submenu is usually present in the instructors' menu as well.
To create a class,
The window that comes up is common to both the Create Class function and the Modify Class function.
class codes can be deleted, but cannot be edited and must be unique
Once the OK button selected, the class form will display.
The Class Code field will already display the code you had entered in the step above. Note that you can no longer edit this field.
There are 3 tabs in this form. General Information, Attributes Add and Attributes Remove
Each field in that form requires specific information, but not all fields are mandatory. The table below details the format required for each field.
General Information Tab | ||||
---|---|---|---|---|
Field name | Field state | Input | Description | |
Class Code | Mandatory - Non Editable | Maximum 8 alphanumeric and punctuation characters. Space character will be ignored. | This code must be unique in the system. Access to any of the other class function will require that code. | |
Class Name | Mandatory - Editable | Maximum 40 alphanumeric and punctuation characters. Space character allowed. | For information purpose only. The name shows when a Class Listing is requested | |
Term | Optional - Editable | maximum 8 alphanumeric and/or punctuation characters. | For information purpose only. | |
Instructor | Optional - Editable | Max 30 Alphanumeric and/or punctuation characters. | For information purpose only. The name of the user who created the class appears there by default. Can be changed to the name of the instructor who will teach the class. It however does not place this instructor in the class, nor does it give this instructor special rights in that class. | |
Class schedule - start | Optional - Editable | 24:00 format. | If this field is filled, the schedule will take effect. If this field left blank, there will be no schedule for that class. For more information about Class Schedules, please read this section. |
|
Class schedule - End: | Default Value - Not Editable | N/A | This field is to remind that all schedules end at 23:59 that day | |
Attributes Add Tab | ||||
Attributes Add | Pre selected - Editable | Click to select or deselect | This tab shows all attributes that the class has. By default, the class has inherited the same attributes than its creator. Any attributes listed in that tab will be added to the class member's profile, if the class member does not already have it assigned. If the creator did not have a specific attribute, this instructor will not be able to add it to the class. The attribute will show but will be greyed out.
This is used to show menus otherwise hidden in organizations that use attributes for their menu layout. |
|
Attributes Remove Tab | ||||
Attributes Remove | Deselected by default - Editable | Click to select or deselect | This tab shows the list of system attributes. The Instructor selects the attribute(s) that will be removed from the profile of the class member. |
Caution should be taken when assigning attributes via classes. If users belong to more than 1 class, the attributes selected in the attribute ADD and attribute REMOVE of each class are added; therefore the users belonging to class A which adds X , and class B which removes X, will have X removed and will not be able to reach the menu with the attribute X. See the Case Example for alternatives.
Once all the fields of the form are filled in, or at least the mandatory ones, press the OK button in the bottom right corner to create the class.
The content format of these fourteen fields is HHMM. To set a start time for a day of the week, the instructor must enter the hour and minute of the beginning of the class. Hours are specified in 24-hour format. Two o'clock in the afternoon is entered as 1400.
Each scheduled class begins at its start time and continues until a different class begins or the specified day ends.
For the purpose of this example, the menu layout has been organized with attributes as follow:
The instructor creates 2 students, STUD1 and STUD2.
Student ID | System attributes assigned | Menu displayed if not in a class |
---|---|---|
STUD1 | None | This user has been registered with no attributes at all, therefore does not see any menu when signing in CAN-8. |
STUD2 | All system attributes | This user has been registered with all attributes therefore sees all the students' menu entries when signing in CAN-8. |
The instructor then creates and defines two classes:
Class | Class Code | Attributes Add | Attributes Remove |
---|---|---|---|
Spanish Class | SPAN | S | All system attributes except S |
English class | ENGL | E | All system attributes except E |
The table below details the impact of these schedules on the students:
Login Time | Student ID | Student's attributes | Visible menu | Attributes received |
---|---|---|---|---|
12:00 Am to 7:59 AM | STUD1 | None | None | Before the class starts, this user has no attributes. STUD1 does not see any lesson in the menu. |
STUD2 | ALL | All entries in the student menu | Because all attributes are listed in this user's profile, by default all menu entries are displayed. | |
8:00 AM to 9:59 AM | STUD1 | S | Spanish menu | The S attribute is added to STUD 1 via the ATTRIBUTE ADD tab of the scheduled class. The student now sees the Spanish menu. |
STUD2 | S | Spanish menu | All attributes except the S attribute were removed from STUD2 via the ATTRIBUTE REMOVE tab of the scheduled class. The student now only sees the Spanish menu. | |
10:00 AM to 1:59 PM *** | STUD1 | E | English menu | The E attribute is added to STUD 1 via the ATTRIBUTE ADD tab of the scheduled class. The student now only sees the English menu. The Spanish menu is no longer available. |
STUD2 | E | English menu | All attributes except the E attribute were removed from STUD2 via the ATTRIBUTE REMOVE tab of the scheduled class. This student only sees the English menu | |
2:00 PM to 4:00PM | STUD1 | S | Spanish Menu | The S attribute is added to STUD 1 via the ATTRIBUTE ADD tab of the scheduled class. The student no longer sees the English menu. |
STUD2 | S | Spanish menu | All attributes except the S attribute were removed from STUD2 via the ATTRIBUTE REMOVE tab of the scheduled class. The student now only sees the Spanish menu. The English menu is no longer available. | |
4:00 PM to 11:59 PM *** | STUD1 | E | English menu | The E attribute is added to STUD 1 via the ATTRIBUTE ADD tab of the scheduled class. Only the English menu is visible. |
STUD2 | E | English menu | All attributes except the E attribute were removed from STUD2 via the ATTRIBUTE REMOVE tab of the scheduled class. Only the English menu is visible. |
Although class codes cannot be modified, some other information such as class name, attributes, term, schedule and instructor's name can be edited.
The form that is presented is common to both the Create Class function and the modify Class function.
In the Class Code field, type the code of the class you wish to modify and select OK.
Alternatively, if you do not remember the code of the class, you can leave the class field empty and click on the Select button. In the Next pop up window, enter the first letter of the name of the class. The list of classes available starting with that letter will show. Locate the class name, then click on it and select OK.
To display a list of all the classes that currently exist in the system:
In the Class Functions Menu, select the List Classes link
A dedicated window with the list of all the classes and their details will show.
Each column can be sorted alphabetically or by order by clicking on the respective header title. (Class Code , Class Name, # Students in Class, Class created by and attributes + / -)
This list can then be saved in .txt or .csv format:
To add a student to a class:
In the Class Functions Menu, select the Add Student to a Class link
In the form that appears:
To remove a student from a class:
In the Class Functions Menu, select the Remove Student from Class link
The Delete Student from Class form appears.
Students can also be deleted from a class from their
To obtain a list of all the students (and instructors) who belong to a specific class:
Select List Students In class from the Class Functions Menu.
Type the class code or use the Down Arrow at the right of the field to find the class code.
Once displayed, this list can be saved in .txt or .csv format.
In the Class Functions Menu, select the Delete Entire Class link
Use the Select buttons to find the class code or simply type the class code in the required field.
Select OK at the prompt to confirm the deletion.
Deleting a class does not delete the students belonging to that class from the system, it only removes any links and menu restrictions the students had while in that class.
When newly delivered, the system comes with one pre-registered user ID only: MASTER.
This is the system supervisor's ID. The default password is PWORD and should be changed at the first login.
All other users will have to be registered according to the site's requirements and policies.
Registration functions are available from the System Supervisor menu and from the instructor menu.
However, these functions behave slightly differently depending if they are accessed with System Supervisor ID or with instructor privileges.
As we progress through each of these functions, the differences will be emphasized.
The only way for the System Supervisor to register a student is via an IMPORT FILE.
It's important to understand that although the System Supervisor can change an instructor menu tag to STUD, thus restricting the displayed menu of the user to the student's menu, this new user will keep full instructor's privileges and can Plan, Track, author, register and delete students and their records.
Instructors can only be registered by the system Administrator (MASTER), either using the internal CAN-8 function Register a User from the Master menu, or by using an Import Registration file.
To create an instructor using the CAN-8 internal function:
There are 3 tabs to that form. Each requiring specific information:
The Code and Description fields are pre-filled with all of the system-defined attributes. These attributes have been setup by the MASTER user at some earlier point in the operation of the system.
By default, all existing attributes are selected.
The System Supervisor should uncheck the attribute(s) that should not be assigned to the Instructor.
The Instructor will see only menu entries that have been assigned one of these attributes.
For more information about System Attributes and how to use them to customize menu displays, please refer to the About Attributes section of this chapter.
The default settings shown in the tab are inherited from the System supervisor. However, they can all be changed if desired.
The Inactivity timeout settings prevent licenses from being held indefinitely by a user who forgot to log out.
If the Inactivity Timeout is set to 15 min, a count-down starts when the software no longer detects ANY activity in the CAN-8 client (ie: no mouse clicks/audio played/etc). After 15 min, the user's session is automatically logged out and the license returned to the license pool. The work in progress will be saved before the session is terminated.
To display all timeout options, click on the down arrow at the right of the Inactivity Timeout field, as illustrated. The choices range between Never (no timeout ever) and 3 hours and 45 minutes. Select the time that seems most appropriate by clicking on it.
The default setting is Never, meaning the user can keep the license as long as they are signed on. There is no way to force a disconnection other that restarting the service.
30 seconds before disconnection, a warning message appears on the user's screen. If the user clicks on the button, the session is kept open on that station. The warning will appear again if the session becomes inactive for the specified time. The user on the client station cannot change this setting.
Sets the maximum number of simultaneous lesson tabs a user can open at the same time. The default number is 7.
If 1 is selected, the instructor will only be able to open one tab with one function (Player, Planner, Tracker, reports, student list etc...) at a time. If 7 is selected, the instructor can have up to 7 functions opened simultaneously.
If the instructor exceeds the tab limit defined in the profile, this warning message will appear.
These options allow you to customize the access to the CAN-8 main functions on a per user basis. You can for example allow a user to evaluate the student's answers but restrict that user from editing lessons. You can select any combination.
The Create a User form can also be accessed by selecting FILE > Create > Student. Removing the Register User link from the Instructors' menu is therefore not enough to prevent instructors from registering students. It should be restricted from their profile using the student Registration Controls option.
Students can only be registered by instructors using the internal function link (Register User in the main menu.
However, the system supervisor can create them using an Import file.
The information below is only applicable for users signed in with an instructor ID.
Your ID may have been restricted by the system supervisor to prevent user registration. When following the steps below, you will receive a message advising you that these steps cannot be completed due to your profile restriction.
The procedure below is mostly similar to the procedure to register an Instructor. Some options however will vary.
There are 3 tabs to that form. Each requiring specific information:
Classes are inherited from the instructor's profile. If the instructor belongs to one or more class(es), that section will be pre-filled with the same class(es). The class that does not apply can be removed.
The Code and Description fields are pre-filled with all of the system-defined attributes. These attributes have been setup by the System supervisor at some earlier point in the operation of the system.
Attributes in the students' profiles are inherited from the instructors. The instructors can restrict them more but cannot assign attributes that are not in their own profiles. The select button for these attributes will be greyed out.
The students will only see menu entries with matching attributes.
For more information about System Attributes and how to use them to customize menu displays, please refer to the About Attributes section of this chapter.
The default settings shown in the tab are inherited from the instructor. However, they can all be changed if desired.
This setting is inherited from the instructor. However, it can be changed if desired.
The Inactivity timeout settings prevent licenses from being held indefinitely by a user who forgot to log out.
If the Inactivity Timeout is set to 15 min, a count-down starts when the software no longer detects ANY activity in the CAN-8 client (ie: no mouse clicks/audio played/etc). After 15 min, the user's session is automatically logged out and the license returned to the license pool. The work in progress will be saved before the session is terminated.
To display all timeout options, click on the down arrow at the right of the Inactivity Timeout field, as illustrated. The choices range between Never (no timeout ever) and 3 hours and 45 minutes. Select the time that seems most appropriate by clicking on it.
The default setting is Never, meaning the user can keep the license as long as they are signed on. There is no way to force a disconnection other that restarting the service.
30 seconds before disconnection, a warning message appears on the user's screen. If the user clicks on the button, the session is kept open on that station. The warning will appear again if the session becomes inactive for the specified time. The user on the client station cannot change this setting.
Sets the maximum number of simultaneous lesson tabs a user can open at the same time. The default number is 7.
If 1 is selected, the student will only be able to open one lesson at a time and must close it before starting another one. If the default (7) is kept, the student can have up to 7 lessons opened simultaneously.
If the student exceeds the tab limit defined in the profile, this warning message will appear.
The Create a User form can also be accessed by selecting FILE > Create > User from the top menu bar.
This function will permanently remove a user ID and all associated records and recorded data for the user from the system.
The user deletion procedure is as follow:
The Delete a User form can also be accessed by selecting FILE from the menu bar and the option DELETE then User From System.
Users can also be deleted via an import file.
Use the Change a User function to modify the settings of a user profile.
The User Properties form containing the user's settings is displayed with the pre-filled information.
The Change a User form can also be accessed by selecting Edit from the menu bar and the option User.
User profiles can also be modified using an import file.
You can display a partial or full list of the system users.
The Display User List function behaves slightly differently if accessed by an instructor rather than by the System Supervisor (signed in with Master ID).
The System Supervisor can bring up a list of all the system users. When selecting DISPLAY USER LIST, the System Supervisor can choose to display the instructors only, or both, Instructors and Students.
Click on the option desired then select OK.
Instructors can only display students therefore do not see the Select User List dialog when selecting Display User List.
Furthermore, instructors can only display the list of students they themselves have registered. If the instructor has not registered any users, a message will display as illustrated.
The information shown in the display user list is the same for both types of IDs.
The user list shows 4 different fields:
This list can be saved in .txt or .csv format.
Select File > Save in the interface top menu. In the SAVE AS window, type the file's name and select the file format, then click on the Save button.
It is possible to generate reports to follow up on the users' activities in the system and the time spent in the system. These reports can help resolve certain issues such as missing students' recordings by confirming if they entered an activity, the time and location they accessed it from, and the time spent. It also gives information such as total time spent in the system for record keeping.
You can generate 2 types of reports:
A Detailed report and a Summary Reports
Instructors and the system supervisor can generate these reports; however, whereas the system administrator can generate a report for all system users, including the system supervisor, instructors can only generate a report for the students they have registered themselves
The Reports menu is by default present in both the system administrator's and the instructors' menu.
SUMMARY REPORT and DETAILED REPORT are Internal functions and can be added or removed from any menu at the organization's discretion.
Both types of reports can be generated
To generate a report, Open the Reports menu then select the option of your choice: Detailed Report or Summary Report
A report option window will open. There is a slight difference between the options available if you are signed in with the system supervisor ID or with the instructor's ID due to the fact that the system supervisor can do a report for instructors and students, whereas instructor can only generate reports for students.
System supervisor's options
Instructors' options
The date format, for these fields, is YYYYMMDD Where YYYY is the year, MM is the month and DD is the day. There is no space in the date field, only digits. For example, March 8, 2010 would be represented as 20100308 in the date fields.
For same day activity reports, enter identical dates in the Start Date and End Date fields.
It offers three options:
1. All Users Owned. |
Instructors will obtain a detailed report of the activities of all the users that were created under the ID they signed in with.
NOTEInstructors do not see the options Show Students Also and Report by Classes in the Report Options Window since they can only display the records of the users they have created themselves. |
2. User | Either enter the User ID in the User field or select Browse and choose a User ID from the user list. The report will show the activities from that user only, and for the time frame specified in the date fields or from their first entry recorded in the system if no dates were specified. NOTES
|
3. Class |
To view a class report, or activities recorded for users belonging to a specific class (including the instructor), select Class, enter the class code or click on Browse to select a class from the class list. NOTES
|
Depending on the date frame entered and the number of activities recorded on the system for that period, the report can take several minutes before being displayed.
The report is displayed in the Detailed Student Progress report window. The user can use the scroll bar on the right side of that window to show data that cannot be displayed.
The report is divided in columns. There are 4 headers in the top bar; each header corresponds to a column. each displaying a specific type of information.
Start Time | Type | Activity | Elapsed Time |
---|---|---|---|
Gives the absolute system time at which the action took place | Indicates that the action described in the Activity column was a system function executed by either an instructor or the system administrator This column will only display INST or Master. If the action is not a system function, it will not display anything. |
Describes the action taken by the users in the menu | Gives the time of the action relative to the starting time and the total session duration at the end. |
Most of the information is in the Activity column.
The reports can display the activity records of several users, therefore the first lines in the activity column always indicate:
If a report is done for a period over several days, and the user has been active in the system on different dates during that period, the Activity report for that user will show the login date followed by the activities, then the next login date, and the corresponding activities. The name and user ID are not repeated.
If the report lists the activities for several users, the users are sorted alphabetically by name. To sort by date, create a new report using the Date Start and Date End fields.
After the User information comes the activity details.
The table below lists the entries you can find in a report and a short description for each.
Entry | Description | Applies to | ||
---|---|---|---|---|
System Admin |
Instructor | Student | ||
Name: Julie Breton User ID: Jbret No Activity records stored for that user |
The user Julie Breton did not sign in CAN-8 during the time period specified in the report | |||
Logout Total Session Duration: 00:04:35 |
The user signed of CAN-8. The duration of this session was 4min 35 sec. | |||
MENU: MASTER Menu | Accessed master menu. This person was signed in with the MASTER ID. | X | X | |
MENU: INSTRUCTOR Main Menu | Accessed the Instructor's menu. | |||
MENU: STUDENT Main Menu | Accessed the Student's menu. | |||
MENU: STUDENT Main Menu ITEM: Chapter 9 |
Accessed the Student's menu. Entered the lesson titled "Chapter 9" as a student. | |||
Create Menu Item (Serial 142): ESL Level 1 Submenu: ESL1 |
The First line shows a menu creation record, the title ESL Level 1 and the serial number for the item created. This serial number will be referred to again if and when the menu entry is deleted. The second line shows the item type (Submenu in this case) and the MENU TAG (ESL1) |
X | X | |
Delete Menu Item: Item Name Not Available (Serial 00003) | The menu item that was assigned the serial number 3 was deleted. | X | X | |
Create Menu Item (Serial 1): ESL Level 1 - Part 1 EAASY - Item Path: SVI\ESL11 |
This is also a menu entry creation record. The first line shows the same type of information as above: Serial number and title. The second line shows the item type (EAASY) and the path assigned to the lesson. |
X | X | |
MENU: User Registration Menu ITEM: Register a User Create User: JR1234 Name: Royo, Jacqueline |
User created. ID and name are shown below. If this line is found under the system admin records, the user created is an instructor. If this line is part of an instructor's record, the user created is a student. | X | ||
INSTRUCTOR ITEM: Chapter 9 | Accessed a menu item (chapter 9) through a function that requires instructor's privileges, like the Planner or the Tracker. | X | ||
MENU: Report Functions Display Detailed Student Progress Report |
Created a detailed progress report | X | ||
Modify User: MASTER - System Supervisor | The System Supervisor's changed his profile's settings | |||
Modify User: JR1234 - Royo Jacqueline | Changes were made to the profile settings of the user mentioned | X | ||
MENU: User Registration Menu ITEM: Display user list |
Entered the User Registration menu and selected the display user list function | X | ||
ITEM: Edit system attributes | Modified the system Attributes. (Added, removed, or modified) | X | X |
The report is displayed in the Summary Student Progress Report window. The user can use the scroll bar on the right side of that window to show data that cannot be displayed.
The header bar divides the report in columns. There are 3 headers; each specifies the content of the column below.
User Name | Date Last Used | Total Time Logged In |
---|---|---|
Users' names, listed in alphabetical order | Displays either:
|
Gives the total time of all recorded sessions for that user since the user ID's creation.
The time displayed is in the format HH:MM:SS |
It may be important to save the report to a file for later use.
To do so, once the report is displayed
The System Supervisor can set up an import file to create multiple registrations at once instead of registering them manually.
Since the 20150929 version of CAN-8, instructors can also import their students' registrations. The system supervisor would have to create a link to the import function in the Instructors menu.
With an import file, the system supervisor can:
The import process requires a specially formatted import file, which can be created with:
The file must be entirely in ASCII with the field delimiters used as described:
When the importation process is done, a log file, (xxx.rep) is created in the same folder the import.txt file is located in. The report file contains details of the import process, successful registrations, warnings, and registration errors. This topic will be further discussed.
The import file can be created in several sections each starting with a different header followed by as many registration lines as necessary (one per class or user created). Alternately, several files can be generated, one to create classes, one for students, one for instructors, and another one for the system refresh, or all the above files can be condensed into one file only that will do all the different sections in sequence.
Each header will define to the system what to do with the lines below, and depending on the
header, the following lines will have to be formatted accordingly.
The order in which the [headers] are placed in the file matters. The file is read by the server and the registration generated from top to bottom. Therefore, any deletions should come first, followed by class creation, instructor creation, and finally student creation.
If the order is incorrect, the import process will generate warnings and error. For instance, a student cannot be placed in a class if the class has not been created first. Equally the student cannot be assigned to an instructor if the instructor has not yet been created.
An import file is composed of
Both reports will show in the import rep file. You can ignore these.
The sample file below has been commented out and empty lines have been added for clarity. These lines would not be present in an import file.
CLASSES | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Section Header | [CLASSES] | Mandatory. Must be placed between [square brackets] and followed by a carriage return. Spelling must be respected. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Line format | CODE [t] CLASS NAME [t] INSTID [t] TERM [t] ATT ADD [t]ATT REMOVE [carriage return] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Field format | CODE: | Mandatory field Class code, minimum 1 character, maximum length 8 characters |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CLASS NAME: | Mandatory field. Min. length 1 character, max. length 40 characters, alphanumeric, punctuation and symbols accepted | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
INSTID: | Optional field Instructor User ID code that has been previously registered. Alphanumeric only. Can be replaced by a *. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TERM | Optional field.. Term information field, maximum length 8 characters. Can be replaced by a * or a [sp] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ATT ADD | Class attributes. Attributes must exist in system. The attributes placed in this field will be added to the users belonging to that class. You can place the space holders * or [sp] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ATT REMOVE | optional field Class Attributes, maximum length 16 characters. These attributes MUST exist in the system. The attributes placed in this field will be removed from the profile of the users placed in that class. If no attribute should be removed, enter the [cr] * or [sp] to indicate the end of the line. It is not necessary to enter a space holder character. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[t] | Mandatory. Tab character. (Code 0x09 in the ASCII table.) A tab character must be inserted between each field or the import will fail. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[CR] | [Carriage Return] Or Enter key on the keyboard. Must be inserted at the end of each line to indicate the end of the information for this line. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[SP] and * | Space bar key or * character. Both can be used as space holders for optional fields. They must be present and must be preceded and followed by a tab character. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SAMPLE [CLASSES] SECTION | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[CLASSES]
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NOTES
|
INSTRUCTORS' SECTION | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section Header | [INST] | Mandatory. Must be placed between [square brackets] and followed by a carriage return. Spelling must be respected. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Line format |
Simple format:
INSTID [t] NAME [t] PASS [t] ATT [t][CLASS] [t][cr] Detailed format: INSTID [t]NAME [t] PASS [t] <+/-> ATT [t] & [t] MENU [t] INACT [t] MAXTAB [t]BACKGROUND-NUM [t] LANG [t] CAPS [t] CLASS [cr] |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Field format | INSTID: | Mandatory field. The user ID to be created/modified (max 18 alphanumeric characters. Punctuation not accepted.) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NAME: | Mandatory field. Instructor's name (Min 1 char, Max 30 chars). This field will accept alphanumeric characters, punctuation, spaces and symbols. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PASS: | Initial Password of user (Max 8 alphanumeric characters only).
If you wish to create a blank password (user signs in without password), a [sp] character must be entered in that field. It must be preceded and followed by a tab character. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ATT | Attributes to assign to the user (Max 16) These attributes must exist in the system. <+/-> These characters are optional and used when editing users' settings via an import file.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
& | Mandatory field. It is a format flag and must be present. It differentiates the detailed line format from the simple format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MENU: | Mandatory field. Initial Menu for the instructor. Type in:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
INACT: | Mandatory field. Sets the inactivity timeout. You must type at least one digit. Accepted Values range from 0 (no time out) to 195 (3 hours 15 min maximum timeout allowed) The time is rounded up to the nearest 15 minute interval. From 1 to 15, timeout it is rounded up to 15 min. From 16 to 30, it is rounded to 30 min, etc... Numbers greater than 195 will be defaulted to 195. Non numeric characters will generate an error. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MAXTAB: | Mandatory field. Sets the Maximum number of tabs in the main interface allowed to be open at one time
Only digit from 1 to 7 can be entered. 0 will be defaulted to 1, and all numbers greater than 7 will be defaulted to 7. Non-numeric characters will result in an error during the import. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BACKGROUND-NUM: | Mandatory field. This field takes numeric characters only and must contain at least one. Enter the number of the background image shown on the background selector screen.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LANG: | Mandatory field. Sets the interface language; use one of the following 2-letter codes
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CAP: | Mandatory field. Only accepted characters are P, T, R, C and [sp] where each
letter enables one of the following instructor functions:
If the ID created should have none of these functions enabled in the profile, then a space [sp] or a * (star character) should be typed in to keep the file format valid. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CLASS | Optional field. A class would have to be created first in order to use this field. If the user does not need to be placed in a class, this field can be simply ignored. There is no need to enter a [sp] character. Simply enter a [cr] after the CAP field. NOTE You can also use this field to remove users from classes. Place the "-"character in front of the class code. You need to create 1 line per class to delete from the user's profile. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[t] | Tab character. (Code 0x09 in the ASCII table.) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[sp] or * | Space key on the keyboard or * (star character). They are necessary in all optional fields when no data is desired to keep the file format, except in the CLASS field which can be ignored. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[cr] | Carriage return or Enter key on the keyboard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SAMPLE [INST] SECTION | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[INST]
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NOTES
|
STUDENTS' SECTION | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section Header | [STUDENTS] | Mandatory. Must be placed between [square brackets] and followed by a carriage return. Spelling must be respected. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Line format |
Simple format:
USERID [t] NAME [t] PASS [t] ATT [t] INSTID [[t] CLASS] [cr] Detailed format: USERID [t] NAME [t] PASS [t] <+/->ATT [t] INSTID [t] & [t] MENU [t] INACT [t] MAXTAB [t] BACKGROUND-NUM [t] LANG [[t] CLASS][cr] |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Field format | USERID | Mandatory field. Type the user ID the student will sign in with. (min 1, max 18 alphanumeric characters. Punctuation not accepted.) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NAME: | Mandatory field. Student's name or number assigned to th estudent in your organization (min 1, Max 30 chars). This field will accept alphanumeric characters, punctuation, spaces and symbols. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PASS: | Mandatory field. Initial Password of user (Max 8 alphanumeric characters only). To assign a blank password, a [sp] character must be entered in that field. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ATT | Mandatory field. Attributes to assign to the user (Max 16 attributes). Type here the attributes that the user should have. <+/-> These characters are optional and only used when editing existing users' settings via an import file.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
INSTID: | Mandatory field. The ID of the instructor the student will belong to (Max 18 alphanumeric characters). The instructor whose ID is entered will be able to manage that student as if he/she had created the student manually. This ID must be valid (see NOTE below) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
& | Mandatory field. Format flag. It differentiates the simple file format from the detailed format. If absent, the line will cause an error and be discarded | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MENU: | Mandatory field. Initial Menu for the Student. Type in:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
INACT: | Mandatory field. User timeout in minutes. Digits only ranging from 0 (no time out) to 195 (3 hours 15 min maximum timeout allowed) . At least one digit must be entered in this field The time is rounded up to the nearest 15 minute interval. From 1 to 15, timeout it is rounded up to 15 min. From 16 to 30, it is rounded to 30 mn, etc... Numbers greater than 195 will be defaulted to 195. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MAXTAB: | Mandatory field. Maximum number of tabs (lessons) the student can open at one time in the main interface.
Only digit from 1 to 7 must be entered. 0 will be defaulted to 1, and all numbers greater than 7 will be defaulted to 7. Non-numeric characters will result in an error during the import. At least one digit must be entered. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BACKGROUND-NUM: | Mandatory field. This field takes digits only and requires at least one. Enter the number of the background image shown on the background selector screen.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LANG: | Mandatory field. Interface language. Select one of the 2-letter codes below:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CLASS | Optional field. A class would have to be created first in order to use this field. If the user does not need to be placed in a class, this field can be simply ignored. There is no need to enter a [sp] character, enter a carriage return instead. If you are editing an existing student record, you can add a "-" character in front of the class code to remove the student from that class. You will need one line for each class to remove from the user's profile |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[t] | Mandatory field. Tab character. (code 0x09 in the ASCII table.) You must enter a tab after each field except the last one or the line will cause errors and be discarded. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[sp] | Space key on the keyboard. Used as space holder or when fields should remain blank. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
* | star character or SHIFT + 8 key on the qwerty keyboard. Used as space holder | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[cr] | Carriage return or Enter key on the keyboard | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[students]
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NOTES
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE USERS SECTION | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section Header | [DELETE] | Mandatory field. Must be placed between [square brackets] and followed by a carriage return. Spelling must be respected. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Line format |
Simple format:
[DELETE] USERID [cr] Detailed format: [DELETE] USERID [t] NAME [t] PASS [t] <+/-> ATT [t] INSTID [t] & [t] MENU [t] INACT [t] MAXTAB [t] BACKGROUND-NUM [t] LANG <[t]CLASS>[cr] |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Field format | USERID: | Valid user ID you wish to delete. It can be a student ID or an instructor ID. Each user ID is followed by a carriage return. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
User Registration Line | It is sometimes convenient to simply take a copy the file that was used to import the users, change the header from [STUDENTS] to [DELETE] and keep the user registration line as they were without having to remove the other fields. This will result in the same than using the short format above. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SAMPLE DELETE USER SECTION | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[DELETE]
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NOTES
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE CLASSES SECTION | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section Header | [DELETE-CLASSES] | Mandatory field. Must be placed between [square brackets] and followed by a carriage return. Spelling must be respected. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Line format |
Simple format:
[DELETE-CLASSES] CLASSCODE [cr] Detailed format CLASSCODE [t] CLASS NAME [t] INSTID [t] TERM [t] ATT ADD [t] ATT REMOVE[cr] |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Field format | CLASSCODE | Mandatory field. Existing class you wish to delete. Each class code is followed by a carriage return. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Class registration line | It is sometimes convenient to simply take a copy of the file that was used to import the classes, change the header to from [CLASSES] to [DELETE-CLASSES] and keep the class registration lines as they were. This will result in the same than using the simple format above. If you do not have an existing [CLASSES] import file, use the simple format to delete your classes. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SAMPLE DELETE CLASSES SECTION | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[DELETE-CLASSES][cr]
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NOTES
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
REFRESH Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section Header | [REFRESH] | Mandatory field. Must be placed between [square brackets] and followed by a carriage return. Spelling must be respected. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Line format |
REFRESH ALL [cr] or
REFRESH STUDENTS [cr] or
REFRESH CLASSES [cr]
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Field format | REFRESH ALL: | Mandatory field. Importing this file removes all registration information from the system including students and their recorded data, instructors, classes, and users activity records. Menu entries and lessons are not affected. They remain as they were prior to the import. The MASTER password is also reset to PWORD. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
REFRESH STUDENTS: | Mandatory field. Importing this file removes all student registration information from the system including their recorded data and their activity records. Menu entries, lessons, instructors and classes are not affected. They remain as they were prior to the import. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
REFRESH CLASSES: | Mandatory field. This file removes all classes from the system. Students and their recorded data, instructors, menu entries and lessons are not affected. Students belonging to the classes deleted are not deleted from the system. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SAMPLE RREFRESH FILESECTION | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[REFRESH]
REFRESH ALL
[REFRESH]
REFRESH STUDENTS
[REFRESH]
REFRESH CLASSES |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NOTES
|
Once the file is created, save it as .txt in a path easily accessed.
You can then proceed with the import:
The refresh password prompt appears. This added security prevents accidental system refresh.
Type in REMOVE DATA NOW then select OK.
This password cannot be changed.
The last warning window appears. Press OK if you wish to delete the users, or CANCEL if you wish to stop the deletion process.
Once the import is completed, the system will create a report file which logs all the processed records: successful registrations, warnings and errors.
Whereas it is not necessary to read that log file if the Import Progress windows shows no error and no warnings, it will be necessary to verify it if some errors or warning are reported as illustrated below:
The registration process illustrated was completed, however several errors and warnings were reported.
These are logged in a file created by the CAN-8 system. This file can be found in the same folder the registration file was saved in.
This file is named import.rep.
If the original import file was saved in the following location:
C:\CAN8\import-march-2021.txt
The system will create:
C:\CAN8\import.rep
This *.rep file can be opened with the text editor of your choice. The errors or warnings are listed per line.
Some warnings are to be expected and are a normal matter in a registration import where students are edited instead of created, as shown in the illustration above. It is however important to verify the report file to analyze it and make sure the registration was successful.
Both warnings and errors may result from formatting error, in which case the import
In rare cases, errors can be reporting issues at the server level. If such is the case, basic troubleshooting of the server software and the server machine is necessary. Contact the IT department if you encounter such error.
The table below lists the warnings and errors reported, their signification and what to fix:
Error/Warning Reported | Error Type | Troubleshooting |
---|---|---|
Import ABORTED at line xxx
ALL RECORDS IN IMPORT FILE MAY NOT HAVE BEEN PROCESSED! |
Server error. The registration import was not successful |
Check network connection. Check CAN-8 server process. Contact IT |
line xxx: ***ERROR - Found unknown record tag: | Header Format error - The section was ignored. |
Check for spelling mistake or invalid header. Also check if the [ or ] (open and closed square brackets) characters are missing from the header or present in one of the fields on the line mentioned. These characters are reserved for headers. |
line xxx: *** ERROR - Minimum info ID, NAME, PASSWORD was invalid
line xxx: Line ignored! |
Line Format error. The user was not created |
Check if line xxx was blank. If yes, you may ignore this error. Otherwise check on the line mentioned if the fields are all present and properly separated by tabs. Either a tab, a place holder or a mandatory field missing. |
line xxx: *** ERROR - Unknown refresh command in refresh section | Field format error in refresh section
The refresh section was ignored. |
Check for spelling mistake, or invalid command. The only 3 valid commands are refresh all, refresh classes and refresh students |
line xxx: *** ERROR - No username on line | Delete line format error
Line was ignored |
Check for empty (blank) line. Also check that the line format is respected if the line is of the full format (check tabs and fields). |
line xxx: --- Line found - no tag: % | Missing header.
Section ignored. |
The system did not find any section header before the line specified. Add the headers. |
line xxx: *** ERROR - Strange characters in record: %s | Field format error.
The line was ignored. |
Check fields on line specified for characters that are not accepted in these fields. Also check for missing field. This would cause the next fields' inputs to move one place to the left thus causing this error. This line was ignored, the import continued |
line xxx: *** ERROR - Class xxx already exist | Class creation failure |
The class already exists and cannot be created twice. You may ignore this error. |
line xxx: *** ERROR - write error creating class %s | System error Class was not created |
The system was unable to create the class on the server. The server file may have been locked or the server inaccessible. Contact IT |
line xxx: *** ERROR - class code is invalid %s | Field Format error. Class was not created |
Check if the name either includes too many characters or characters not allowed |
line xxx: *** ERROR - server would not create class | Server error. Class not created. |
The maximum number of classes allowed might have been reached, the server's disk might be full, server files are flagged Read Only. Try to create a class manually. If the same error appears, try to delete a class then recreate a new one. If no error appears, then the maximum classes allowed has been reached. Delete the classes no longer in use. Otherwise contact IT. |
--- Instructor: xxx not found, student will belong to MASTER | Warning The student has been registered. |
Information error in [students] section. The instructor ID entered does not exist. This student, although successfully created, does not belong to any instructor. If it is important that the student be registered under the instructor's name, correct the INSTID field and run this line again or the instructor can delete then recreate the student manually. |
line xxx: *** ERROR User xxx has invalid icon/normal setting. Must be I, N, L, M, O, or B line xxx: *** ERROR User xxx has invalid windows/traditional style setting |
Legacy format error. The user was not created |
Only shows for version pre-dating 2010. Check the mentioned fields and correct them. You may be missing one of these fields, a tab, or have used characters not allowed. |
line xxx: *** ERROR User xxx has invalid language specified - | Field Format error User was not created | Check for error in the language field or tabs missing in the line after the language field. |
line xxx: *** ERROR User xxx already exists but is not being added to another class | Line format error.
Line ignored |
This usually shows when re-importing a file after fixing some of the errors. If it is a first import, this line may be repeated. Since the user was previously registered, and this line does not bring any changes to the existing profile, it is ignored. Remove the line to avoid the error in the log file. |
line xxx: --- User xxx already exists, adding to class xxx if possible | Warning. User is added to the class. |
This warning is for information purpose during user edition. The system recognizes that the user ID already exists, and is processing the changes to the profile. In this case, the user is being placed in another class |
line xxx: --- Student xxx already in class xxx | Warning. No changes done to the user |
Information purpose only. The system recognizes that the user ID already exists, and that this line is identical to the student settings. Either that line is doubled or the user was previously created. Delete the double entry to avoid warning in the log file. |
line xxx: *** ERROR user xx was not created by the server . | Server error. Student NOT created |
The server's disk might be full or the files locked. Check if the user can be created manually. Contact IT. |
line xxx: *** ERROR Student xxx just created could not return number! | Server error. Student NOT created |
Disk error. Contact IT. Check if the disk is full or damaged. |
line xxx: --- class xx not found. Unable to add student to class | Warning. Student created |
The class code does not exist. The student has been created, but has not been added to that class.
|
line xxx: *** ERROR Student xxx is already in 16 other classes | Maximum reached. Student not added to class | This error shows when a student profile is being edited. This student already belongs to the maximum class allowed (16) and cannot be added to another one. Remove the student from some of the other classes using the class function menu or using the - character in the import file to remove some classes before importing again. |
line xxx: *** ERROR Write error when adding student to class | Server error. | Disk error. Contact IT Check if the disk is full or the server files locked |
line xxx: *** ERROR User: xxx not found, not deleted | Delete format error Student not deleted |
Under the [delete] section, the student at the line mentioned does not exist and cannot be deleted. Check for spelling mistake in the USERID field |
line xxx: *** ERROR student xxx was not deleted by the server. | Server error Student not deleted |
Contact IT. Check id disk full or server files locked |
|