Configuration File

This is located in the config subdirectory.

Adding New Config Options

If a new configuration option is to be enabled by default then it should be added to the install script, and to an upgrade script for users upgrading an existing instance.

Any new configuration items should be placed in the new config table (unless there is a specific reason it should remain in the config file).

Config items should be added via the install and update scripts using the Config→set_setting function.

Config items can be asked via the Config→get_setting function.

Current Config File Options

$cfg_company (String):: The Name of the University/Organisation

$cfg_academic_year_start (String):: The Month/Day when the academic year changes. In the example below the academic year will change on July 1st. The system will use the current year from the system clock, thus: a) 01/05/2013 = academic session 2012/13, b) 01/07/2013 = academic session 2013/13

$cfg_academic_year_start = '07/01';

$cfg_tmpdir (String):: The Temp directory for the system

$cfg_rogo_data (String):: Since Rogo 6.1.0 Stores the location that user data directories will be stored in. The path should use the local file system separator (in the case of Windows it will need to be properly escaped).  The setting should have a trailing shash.

 $cfg_rogo_data = '/var/www/rogodata/';

 $cfg_rogo_data = 'c:\\rogodata\\';

$cfg_summative_mgmt (Bool):: If Central Summative Exam Administration is enabled.

• true enables this.

$cfg_client_lookup (String):: How machines are evaluated for summative exam access. Either

• 'ipaddress' use the machines ip address
• 'name' looksup the name of the machine from its ip address (useful in dynamic environments)

$cfg_db_username (String):: This is the db (MySQL) username that is initially used for authentication (after authentication the system will switch the db to a specific user for each userrole)

$cfg_db_passwd (String):: This is the db (MySQL) password that goes with $cfg_db_username username

$cfg_db_database (String):: The name of the MySQL database.

$cfg_db_host (String):: The name of the MySQL host server.

$cfg_db_port (Integer):: The port number of the MySQL database.

$cfg_db_charset (String):: The character set that is used on the MySQL database.

$cfg_db_charset = 'utf8';

$cfg_db_student_user (String):: This is the db (MySQL) username that is switched to for the student user.

$cfg_db_student_passwd (String):: This is the db (MySQL) password that goes with $cfg_db_student_user username.

$cfg_db_staff_user (String):: This is the db (MySQL) username that is switched to for the staff user.

$cfg_db_staff_passwd (String):: This is the db (MySQL) password that goes with $cfg_db_staff_user username.

$cfg_db_external_user (String):: This is the db (MySQL) username that is switched to for the external review user.

$cfg_db_external_passwd (String):: This is the db (MySQL) password that goes with $cfg_db_external_user username.

$cfg_db_sysadmin_user (String):: This is the db (MySQL) username that is switched to for the sysadmin user.

$cfg_db_sysadmin_passwd (String):: This is the db (MySQL) password that goes with $cfg_db_sysadmin_user username.

$cfg_db_sct_user (String):: This is the db (MySQL) username that is switched to for the Script Concordance Test Expert user.

$cfg_db_sct_passwd (String):: This is the db (MySQL) password that goes with $cfg_db_sct_user username.

$cfg_db_inv_user (String):: This is the db (MySQL) username that is switched to for the invigilator user.

$cfg_db_inv_passwd (String):: This is the db (MySQL) password that goes with $cfg_db_inv_user username.

$cfg_short_date (String): the MYSQL_DATE_FORMAT that is used for display of short date only.

$cfg_short_date = '%d/%m/%y';

$cfg_long_date_time (String):: the MYSQL_DATE_FORMAT that is used for display of date & time.

$cfg_long_date_time = '%d/%m/%Y %H:%i';

$cfg_long_date_php = (String):: the PHP display format for the long date.

$cfg_long_date_php = 'd/m/Y';

$cfg_short_date_php (String):: the PHP display format for the short date.

$cfg_short_date_php = 'd/m/y';

$cfg_long_time_php (String):: the MYSQL_DATE_FORMAT that is used for display of long date & time.

$cfg_long_time_php = 'H:i:s';

$cfg_short_time_php (String):: the MYSQL_DATE_FORMAT that is used for display of short datae & time.

$cfg_short_time_php = 'H:i';

$cfg_timezone (String):: the timezone that the machine is in (force).

$cfg_timezone = 'Europe/London';

$cfg_tablesorter_date_time (String):: the timezone used by the jquery tablesorter library (should match above time zones) - ROGO 6.0.

$cfg_tablesorter_date_time = 'uk';

$cfg_cron_user (String):: Cron user (used by the system to run automated scripts - ROGO 6.0.

$cfg_cron_passwd (String):: Cron user password- ROGO 6.0.

$cfg_sms_api (String):: Configure the sms api.

$cfg_sms_url (String):: base url of the student management system.- ROGO 6.1.0

$cfg_lti_allow_module_self_reg (Bool):: if via lti and using standard integration allows auto adding of students onto self registration module.

• false disables this behaviour.

$cfg_lti_allow_staff_module_register (Bool):: if via lti and using standard integration allows auto adding of staff onto module.

$cfg_lti_allow_module_create (Bool):: if via lti and using standard integration allows auto creation of module.

$authentication_fields_required_to_create_user (Array):: This is an array of the required fields that the authentication stack requires before it will create a user.

$authentication_fields_required_to_create_user = array('username', 'title', 'firstname', 'surname', 'email', 'role');

$lookup (Array):: This is the configuration array for the Lookup Stack and lets you select which plugins are loaded and the configuration for each plugin. For plugin config options see Lookup Plugin Config. Each element of the outer array is another array with the first parameter being the name of the plugin (String) then an array of configuration options, followed by a description (String).

$lookup = array(
  array('ldap', array('ldap_server' => 'iLDAP.x.ac.uk', 'ldap_search_dn' => 'OU=xx,DC=xx,DC=xx,DC=ac,DC=uk', 'ldap_bind_rdn' => 'UserName', 
'ldap_bind_password' => 'PassWd', 'ldap_user_prefix' => 'sAMAccountName=', 'ldap_attributes' => array('sAMAccountName' => 'username', 'sn' => 'surname', 'title' => 'title', 
'givenName' => 'firstname', 'department' => 'school', 'xx' => 'email', 'xx' => 'email', 'mail' => 'email', 'UonStuID' => 'studentID', 
'UoNStaffID' => 'staffID', 'cn' => 'username', 'UoNPosition' => 'role', 'employeeType' => 'role', 'UoNUPSStatus' => 'role', 'initials' => 'initials'), 'lowercasecompare' => TRUE, 
'storeprepend' => 'ldap_'), 'LDAP'),
  array('XML', array('baseurl' => 'http://exports/', 'userlookup' => array( 'url' => '/student.ashx?campus=uk', 'mandatoryurlfields' => array('username'), 
'urlfields' => array('username' => 'username'), 'xmlfields' => array('StudentID' => 'studentID', 'Title' => 'title', 'Forename' => 'firstname', 'Surname' => 'surname', 
'Email' => 'email', 'Gender' => 'gender', 'YearofStudy' => 'yearofstudy', 'School' => 'school', 'Degree' => 'degree', 'CourseCode' => 'coursecode', 'CourseTitle' => 'coursetitle', 
'AttendStatus' => 'attendstatus'), 'oneitemreturned' => true, 'override' => array('firstname' => true), 'storeprepend' => 'sms_userlookup_')), 'XML')
);

$authentication (Array):: This is the configuration array for the Authentication Stack and lets you select which plugins are loaded and the configuration for each plugin. For plugin config options see Authentication Plugin Config. Each element of the outer array is another array with the first parameter being the name of the plugin (String) then an array of configuration options, followed by a description (String).

$authentication = array(
array('ltilogin', array(), 'LTI Auth'),
array('guestlogin', array(), 'Guest Login'),
array('impersonation', array('separator' => '_'), 'Impersonation'),
array('internaldb', array('table' => 'users', 'username_col' => 'username', 'passwd_col' => 'password', 'id_col' => 'id', 'encrypt' => 'SHA-512', 'encrypt_salt' => 'EncSalt'), 'Internal Database'),
array('ldap',array( 'table' => 'users', 'username_col' => 'username', 'id_col' => 'id', 'ldap_server' => 'iLDAP.nottingham.ac.uk', 'ldap_port' => 389, 
'ldap_search_dn' => 'OU=University,DC=intdir,DC=nottingham,DC=ac,DC=uk', 'ldap_bind_rdn' => 'UserName', 'ldap_bind_password' => 'PassWd', 'ldap_user_prefix' => 'sAMAccountName='),'LDAP')
);

$cfg_institutional_domains (Array):: = array('rji.ac.uk', 'nottingham.ac.uk'); list the domains that will authenticate against any external system. This will allow you to change the password of any users that do not match against those domains (e.g. external examiners)

$cfg_institutional_domains = array('rji.ac.uk', 'nottingham.ac.uk');

$enhancedcalc_type (String):: The method/system used to mark Calculation questions. Currently there is support for the in-built PHP method 'phpEval' or the more sophisticated 'Rrserve'.

$enhancedcalculation (Array): Array of settings to use with the set type. For phpEval set to an empty array.

$enhancedcalculation = array('host' => '127.0.0.1', 'port'=>6311,'timeout'=>5);

$cfg_js_root (String) (Javascript Code):: The Root path for Javascript

  $cfg_js_root = <<< SCRIPT
<script>
  if (typeof cfgRootPath == 'undefined') {
    var cfgRootPath = '$cfg_root_path';
  }
</script>
SCRIPT;

$cfg_editor_name (String):: The name of the editor

$cfg_editor_javascript (String) (Javascript Code):: Javascript Code to enable the editor

$cfg_editor_javascript = <<< SCRIPT
$cfg_js_root
<script type="text/javascript" src="$cfg_root_path/tools/tinymce/jscripts/tiny_mce/tiny_mce.js"></script>
<script type="text/javascript" src="$cfg_root_path/tools/tinymce/jscripts/tiny_mce/tiny_config.js"></script>
SCRIPT;

$cfg_hour_warning (Integer):: This is related to summative exam and gives a warning on the editing screen if the exam is set before this time

$cfg_autosave_settimeout (Integer):: This is the time in seconds before the autosave will try again.

$cfg_autosave_frequency (Integer):: How often the autosave routine runs in seconds.

$cfg_autosave_retrylimit (Integer):: How many times the auto fails or timesout before reporting a save failed.

$cfg_autosave_backoff_factor (Decimal):: The backoff amount on each failure. each retry is lenghtend to $cfg_autosave_settimeout + ($cfg_autosave_backoff_factor * $cfg_autosave_settimeout * retryCount);

$support_email (String):: The support email that is displayed.

$emergency_support_numbers (Array):: An array of the support contact as the key and the telephone number as the value

$emergency_support_numbers = array('Primary Rogo OSS Support '=>'111111', 'Secondary Rogo OSS Support '=>'222222');

$dbclass (String):: The class the db uses. This is for debugging as the mysqli class can be overloaded with debug functions.

$display_auth_debug (Bool):: Display extra debug on the authentication screen so you can see why login attempts failed etc.

$cfg_setting_icons_order (Array):: Allows system admin to customise the order/number of the admin screen items - ROGO 6.0.4

$cfg_setting_icons_order = array('calendar','modules','schools','courses');

$cfg_oauth_access_lifetime (Integer):: Since Rogo 6.1.0 Stores in seconds the lifetime of an oauth access token.

$cfg_oauth_refresh_token_lifetime (Integer):: Since Rogo 6.1.0 Stores in seconds the lifetime of an oauth refresh token.

$cfg_oauth_always_issue_new_refresh_token (Bool):: Since Rogo 6.1.0 Enables or disables the oauth refresh token.

$cfg_enable_api (Bool):: Since Rogo 6.1.0 Enables or disables API functionality.

$cfg_enable_gradebook (Bool):: Since Rogo 6.1.0 Enables or disables the gradebook functionality.

$cfg_enable_ims(Bool):: Since Rogo 6.1.0 Enables or disables IMS enterprise functionality.

$cfg_memcache_host(array)::  Since Rogo 6.1.0 Array of hosts for memcache servers (used by admin/healthcheck.php)

$cfg_memcache_port(String)::  Since Rogo 6.1.0 Port of memcache servers (used by admin/healthcheck.php)

$cfg_readonly_host(Bool)Since Rogo 6.2.0 Enables or disable file system read only mode

$file_config_override(Bool)Since Rogo 6.2.0 Enables or disable config settings in config.inc.php superseding the same config setting on the config table.

$logerrors(Bool)Since Rogo 6.2.0 Enables or disable logging php errors to file

$displayerrors(Bool) Enables or disable logging php errors to the screen (suggested FALSE on production systems)

$displayallerrors(Bool)  Enables or disable logging PHP notice and warning messages

$cfg_install_type(String) Optional string to append to 'Rogo' in browser page title - useful to visually separate different rogo instances i.e. test systems