In Detail:

Variables Glossary

reference list of preset variables

A complete list of all variables available in Opus Creator and Opus Pro. Note that the Question variables are only available in Opus Pro.

General Variables

Username and Log In Presets

LOGIN_USERNAME — to store the full username of the person logging in. The System_Username could be used as a default which the user could edit, clarify or extend or it can be requested explicitly from the user.

LOGIN_FIRSTNAME — to store the user's first name. Can be requested specifically or extracted from the Username using a QuickScript function

LOGIN_SURNAME — to store the user's second name. Can be requested specifically or extracted from the Username using a QuickScript function.

LOGIN_USER_EMAIL — to store the user's email address. To be input by the user/designer.

LOGIN_TUTOR — to store the tutor for the course. To be input by the user/designer.

LOGIN_MANAGER — to store the manager for the course. To be input by the user.

LOGIN_TUTOR_EMAIL — to store the email address of the tutor if required. To be input by the user/designer.

LOGIN_ORGANIZATION — the organization of the person logging in. Useful when training third party contractors for example. To be input by the user.

LOGIN_USER_ID — A unique ID number for the logged in user. Could be obtained from user or from course database or calculated internally.

Opus Publication Presets

CHAPTER_PASSWORD — this variable allows you to limit access to a chapter based on a password. This variable can only be used if you have set passwords for chapters in the Password tab of the Publication Properties dialog — see Passwords tab for more information.

PUBLICATION_TIME — contains the number of seconds the publication has been running since the user first opened it. This can be useful to time out a publication, if it has not been accessed for a while.

PUBLICATION_TITLE — contains the title you have given to the publication as displayed in the organizer and the Publication Properties. This is not the same as the filename of the publication unless you have made it deliberatly so.

PUBLICATION_PAGE_TITLE — contains the title of the current page as displayed in the organizer. Allows you to display the title of the page

DATABASE_ERROR_MESSAGE — If you have used a database in your publication, this variable will contain any error messages sent via the database if there has been a problem connecting or accessing the database. The error message may help you (or the user if you display the variable on screen) to solve the problem.

RADIO_GROUP_1_ID — contains the index position of the currently selected button in a group of radio buttons. This variable is only to be used if you have created Button objects on a page that are set to the Radio Button in the Buttons tab of the object Properties dialog.

RADIO_GROUP_1_NAME — contains the name of the Button object selected in group of radio buttons.

COMMAND_PARAM_COUNT — contains the number of parameters passed on the command line after the user runs the publication.

PUBLICATION_EVALUATION — contains information about the current evaluation state of the publication. This variable only contains meaningful information if the evaluation options evaluation options have been set on the Security properties page; otherwise it will be -1.


Back to Top

System Variables

Date and Time Information

SYSTEM_TIME_YEAR — provides the current year according to the system setup e.g. 1999. This is shown as a number.

SYSTEM_TIME_MONTH — provides the month e.g. May. This is shown as a word, not a number.

SYSTEM_TIME_DATE — provides the date e.g. 02. This is shown as a number.

SYSTEM_TIME_DAY — provides the day of the week, e.g. Fri. This is shown as a three-letter word.

SYSTEM_TIME_HOUR — Holds the hour of the day in twenty-four hour format, e.g. 23 for 11pm. This is shown as a number.

SYSTEM_TIME_MINUTE — provides the minute of the hour, e.g. 39. This is shown as a number.

SYSTEM_TIME_SECOND — provides the second of the minute, e.g. 45. This is shown as a number.

SYSTEM_TIME_12HOUR — Holds the hour in twelve-hour format, e.g. 11 for 11pm. This is shown as a number.

SYSTEM_TIME_AMPM — provides an AM or PM response depending on current hour, e.g. AM for 9am. This is shown as a two-letter word.

SYSTEM_DATE_FULL — provides the current date in full, formatted as 01 January 2001.

System Information

SYSTEM_USERNAME — provides the name of the user logged onto the Windows system e.g. Administrator.

SYSTEM_CD_DRIVE — provides the drive letter of the first CD-Rom drive on the system e.g.: D: — this is the normal drive letter for a CD drive.

SYSTEM_COLOUR_DEPTH — provides the colour depth of the current screen on the system e.g. 32 — the colour depth set to 32bits.

SYSTEM_SCREEN_RES_X — provides the current screen resolution width setting for the system e.g. 1024 — meaning 1024 pixels across the screen.

SYSTEM_SCREEN_RES_Y — provides the current screen resolution height setting for the system e.g. 768 — meaning 768 pixels down the screen.

SYSTEM_OPERATING_SYS — provides the Windows platform for the system e.g. 2000 — meaning a Windows 2000 machine.

System Folder Information

SYSTEM_WINDIR — provides the directory where Windows is installed e.g. C:\WINNT — the pathname to the folder on Windows 2000 systems.

SYSTEM_WINSYS_DIR — provides the location of the Windows' System directory e.g. C:\WINNT\System32 — the pathname on Windows 2000 systems.

SYSTEM_PUBLICATION_DIR — provides the location of the current Opus publication e.g. C:\Education\Tutorial\ — meaning the publication can be found in this folder.

SYSTEM_PROGRAMS_DIR — provides the location of the standard Program Files directory e.g. C:\Program Files — this is the standard folder in which applications are installed on a user's system.

SYSTEM_PROGRAMDATA_DIR — provides the location of the Vista/Windows 8+ Program Data Directory.

SYSTEM_DOCUMENTS_DIR — provides the location of the current user's documents directory e.g. C:\Documents and Settings\Administrator\My Documents — the pathname to the My Documents folder for an administrator on a Windows 2000 system.

SYSTEM_TEMP-DIR — provides the location of the Windows' Temp directory e.g. C:\DOCUME~1\ADMINI~1\LOCALS~1\Temp — the pathname to the folder for the administrator on Windows 2000 systems.


Back to Top

Score Variables

SCORE_VALUE — Calculates the total value of the allocated scores that have been answered correctly. For example, the user must answer 4 questions with scores allocated thus: Q1 = 1, Q2 = 3, Q3 = 5 and Q4 = 2. Only the first three answers are correct, so the score value would be 9. If all answers were correct, the score would have been 11.

SCORE_VALUE_TOTAL — Calculates the total value of the allocated scores which have been answered, whether the user answer the question correctly or not. Using the example above (point 1), this variable would contain the value 11.

SCORE_VALUE_PERCENT — Keeps track of the total value of available points as a percentage for a single question. It is not the total scored for all questions. SCORE_CORRECT — Use this to give you the number of questions which have been answered correctly, e.g. 5 out of 7 questions.

SCORE_INCORRECT — Use this to give you the number of questions which have been answered incorrectly e.g. 2 out of 7 questions.

SCORE_TOTAL — Calculates the number of questions the user has attempted to answer, whether that answer was correct or not. It is not their total score, which is stored in SCORE_VALUE. For example, if there are 10 questions, the user has attempted to answer 7 but only got 4 correct, the score total would be 7.

SCORE_PERCENT — Calculates the percentage of questions which have been answered correctly, for example 6 correct answers out of 10 questions would produce a score of 60%, 6 out of 15 questions would be 40%.

SCORE_TOTAL_POSSIBLE — User-defined variable in which to store the maximum possible score for the whole quiz irrespective of how many the user has answered. You need to add this value manually.

SCORE_CURRENT_POSSIBLE — User-defined variable to store the total possible score. It is calculated as SCORE_TOTAL_POSSIBLE less SCORE_VALUE_TOTAL.

SCORE_PASS_THRESHOLD — User-defined variable to store the score required to achieve a pass. This allows you to monitor the SCORE_CURRENT_POSSIBLE value against the Pass mark and force the user to recover the training until a pass level is maintained.


Back to Top

Question Variables

Q_SCORE_VALUE — This is the value or amount of the user's score so far. This variable keeps track of the total score for answers the user has got correct. The value for an individual answer is set on the Question Properties grid. This would be the "eight" in "eight out of ten" so far.

Q_SCORE_CORRECT — A count of the questions the user has answered correctly. In the case of multiple-answer questions only one correct answer needs to be chosen for SCORE_CORRECT. If two answers are marked as correct and the user has selected both answers the SCORE_CORRECT variables will still only increase by one.

Q_SCORE_INCORRECT — A count of the questions the user has answered incorrectly. In the case of trhe multiple answer questions the user only needs to get one answer correct for the question to be counted as correct, even if one of the user's other answers is makred as incorrect.

Q_SCORE_VALUE_POSSIBLE — The possible score amount of questions answered so far irrespective of whether that's what the user has scored for their answers. This would be the "ten" in "eight out of ten" for questions answered so far.

Q_SCORE_TOTAL_POSSIBLE — The possible value of all questions in the whole publication. This would be the "ten" in "eight out of ten" but for the whole publication.

Q_SCORE_VALUE_TOTAL_REMAININGThis is the total scoring value of quesitons in the publication which have not yet been answered

Q_SCORE_CURRENTLY_POSSIBLE — This variable keeps track of the score value the user could still acheive if all remaining questions are answered correctly  – includes the current Q_SCORE_VALUE. This enables you to track whether the user has failed the test even before they've answered all the questions – ithat is, their score will not hit the pass threshhold even if they get everything right from this point.

Q_SCORE_PERCENT_POSSIBLE — This variable keeps track of the percentage score the user could still acheive if all remaining questions are answered correctly – includes the current Q_SCORE_VALUE_PERCENT. This enables you to track whether the user has failed the test even before they've answered all the questions – that is, their score will not hit the pass threshhold even if they get everything right from this point.

Q_SCORE_VALUE_PERCENT — The score the user has been awarded so far as percent of the number the user could have got by this point.

Q_SCORE_OVERALL_PERCENT — The score the user has been awarded so far as percent of the score possible in the whole quiz.

Q_SCORE_ANSWERED_QUESTIONS — The number of questions the user has attempted so far.

Q_SCORE_TOTAL_QUESTIONS — The total number of questions in the whole publication.

Q_SCORE_COURSE_PASSED — This variable checks whether the course has been passed or not. It will be true if the course has been passed and false if it has been failed. It is only true once the course has been finished.

Q_SCORE_COURSE_FINISHED — This variable checks whether the course has been completed or not. It will be true if the course has finished and false if it has not.


Back to Top

SCORM Variables

There is a range of variables providing the Opus version of the corresponding SCORM data model variable e.g: LMS_LEARNER_ID would connect with the SCORM data model cmi.core.learner_ID

Note:
These variables are not connected to the relevant SCORM data models except in the SCORM template publications. They are providied in all publications merely for your convenience and you can use your own variables for the same function or rename these.

  • LMS_COMMENTS_FROM_LESSON
  • LMS_COMMENTS_FROM_LMS
  • LMS_COMPLETION_STATUS
  • LMS_EXIT_MODE
  • LMS_LEARNER_ID
  • LMS_LEARNER_NAME
  • LMS_LESSON_LOCATION
  • LMS_LESSON_STATUS
  • LMS_MAX_TIME
  • LMS_SCORE_RAW (or use SCORE_VALUE_PERCENT directly)
  • LMS_SCORE_SCALED

In addition there are a couple of variables which the LMS Initialization or closedown process will update automatically so they can be checked to ensure the initialisation process has succeeded.

LMS_INITIALIZE_RETURN — checks the success of the initialisation process. Will return 0 (zero) when it has been successful

LMS_COMMIT_RETURN — reports the success or failure of the SCORM Commit Action. Will return 0 (zero) if successful

LMS_FINISH_RETURN — checks the success of the LMS closedown procedure. Will return 0 (zero) when it has been successful


Back to Top