Skip to end of metadata
Go to start of metadata

The following entries describe the server settings in LAMS. They may be set via the "Configuration Settings" screen in System Administration. The entries with the (info) are entries used for customising LAMS to your site.

In most cases, changing a setting using the "Configuration Settings" screen will change the setting straight away. But if you change the User Inactive Timeout Period or the Allow Multiple Login flag then you will need to restart LAMS for the changes to take affect as these settings are cached for efficiency.

Please do not change any of the values that do not have an (info) unless specifically told to change them!

If you wish to change the logo or colour scheme in LAMS, see Themes.

Chat Server

This is not longer required from LAMS v 2.4.1 onwards.

Chat server settings. See "Setting Up Wildfire Chat Server" on http://wiki.lamsfoundation.org/display/lamsdocs/Windows+Installer+Help

 

Label

Configuration Key

Description

(info)

Chat Service Admin Username

XmppAdmin

Admin username set up in Wildfire e.g. admin

(info)

Chat Server Conference

XmppConference

Same as XmppDomain, but prepended with 'conference.', e.g. 'conference.localhost'

(info)

Chat Server Domain

XmppDomain

The address of the chat server e.g. localhost

(info)

Chat Server Admin Password

XmppPassword

Password for the Wildfire admin user

Email

 

Label

Configuration Key

Description

(info)

LAMS Support Email

LamsSupportEmail

Not used in LAMS 2.0. In LAMS 2.1 it is the the return address used on system emails (e.g. Forgot Password emails).

(info)

SMTP Server

SMTPServer

Required for sending system emails.

Features

 

Label

Configuration Key

Description

(info)

Allow Direct Lesson Launch

AllowDirectLessonLaunch

The lesson launch page is a special url which will display a short page with basic lesson details and a button to allow the user to start the learner interface for this lesson. If AllowDirectLessonLaunch is "true" then the url for the lesson launch page will be shown in authoring for staff to copy and paste into another system, or send by email to the learners. Default to "false". Should be "true" or "false".

(info)

Allow Live Edit

AllowLiveEdit

Live Edit allows a staff member to change a learning design (sequence) once a lesson has started. It changes just the copy of the learning design that is being used for the lesson - the original design created in authoring is not changed by LiveEdit. This configuration parameter shows/hides the Live Edit button in Monitoring. Added in LAMS 2.0.3 / RAMS 1.0. Defaults to "true". Should be "true" or "false".

(info)

Enable LAMS Community

LAMS_Community_enable

Turn on the LAMS Community tab on the user's main screen.

Look and Feel

 

Label

Configuration Key

Description

(info)

Authoring Screen Size

AuthoringScreenSize

The size of the Authoring client window. The value should be in the format of {width}x{height} e.g. 1024x768 Added in LAMS 2.1.

(info)

Monitor Screen Size

MonitorScreenSize

The size of the Monitor client window. The value should be in the format of {width}x{height} e.g. 1024x768 Added in LAMS 2.1.

(info)

Learner Screen Size

LearnerScreenSize

The size of the Learner client window. The value should be in the format of {width}x{height} e.g. 800x600 Added in LAMS 2.1.

(info)

System Admin Screen Size

AdminScreenSize

The size of the System Admin window. The value should be in the format of {width}x{height} e.g. 800x600 Added in LAMS 2.1.

(info)

Authoring Activities Colour

AuthoringActivitiesColour

Show the the activity icons with a variety of background colours in authoring. Defaults to true, change to false to give the icons a consistent background colour

(info)

Custom Tab URL

CustomTabLink

A custom tab is a tab that appears next to the My Profile tab on the main screen. If this entry is blank, then no tab is displayed. If this entry is not blank, Custom Tab Link should also be filled in. This entry should contain the URL to be called when the tab is selected. Added in LAMS 2.1.

(info)

Custom Tab Title

CustomTabTitle

The text to be displayed on the custom tab (see Custom Tab URL). Added in LAMS 2.1.

(info)

Default Flash Theme

DefaultFlashTheme

Default theme to be used for Flash parts. Defaults to "default", which matches to the defaultTheme.xml in lams.ear\lams-central.war\flashxml. No alternative themes are available at the moment.

(info)

Default HTML Theme

DefaultHTMLTheme

Default theme to be used for HTML pages. Defaults to "default", which matches to the defaultHTML.css and defaultHTML_learner.css files in lams.ear\lams-central.war\css. No alternative themes are available at the moment.

(info)

Batch size for monitoring's learner progress screen.

LearnerProgressBatchSize

Number of learners to be displayed on the learner progress screen in monitoring

(info)

Locale

ServerLanguage

Default server language. Must be an entry from the lams_supported_locale table e.g. en_AU, es_ES. If this entry is invalid, the login pages will revert to Australian English

(info)

Locale Page Direction

ServerPageDirection

Overall page layout - LTR (Left to right) or RTL (Right to left). Should match the ServerLanguage. Not fully supported in LAMS 2.0.

LDAP (Added in LAMS 2.1)

See LDAP Configuration.

LDAP Attribute Mapping (Added in LAMS 2.1)

See LDAP Configuration.

System Configuration

 

Label

Configuration Key

Description

 

Number of Days to Keep Preview

CleanupPreviewOlderThanDays

Not currently in use.

(info)

Flash Dump Files Directory

DumpDir

When the Flash clients receive an unexpected response from the server, the user can write out a dump file to this directory. The dump file can be used for reporting bugs back to the LAMS team.

(info)

EAR Directory

EARDir

The "deployed" or "running" version of LAMS will go here. It is usually <JBOSS directory>/server/default/deploy/lams.ear. If this is wrong then the export portfolio will not work correctly.

(info)

Help URL

HelpURL

This website! Defaults to http://wiki.lamsfoundation.org/display/lamsdocs/

(info)

Server URL

ServerURL

ServerURL must be set to the url you intend to use to run LAMS. If you put one url here, and then access LAMS via another url the look and feel will be wrong as the stylesheets will not load properly. It may also call the Flash parts of LAMS to fail.

(info)

Server URL Context Path

ServerURLContextPath

This is the part of the ServerURL that comes after the http://<server:port>/. For example, if your ServerURL is "http://localhost:8080/lams/" then the ServerURLContextPath must be "lams/". If your ServerURL is "http://somehostofmine.com.au/rams/" then the ServerURLContextPath must be "rams/". This is used to build paths to the HTML editor, so if it is wrong then the HTML editor will not work.

(info)

Temporary Files Directory

TempDir

Location of temporary files. Should be allocated to an area with plenty of disk space. These files can be deleted if they are more than a couple of days old.

 

Cache Debug Listener

UseCacheDebugListener

Development only usage - used when debugging issues with the JBOSS Debugger.

(info)

Inactive User Timeout

UserInactiveTimeout

Number of seconds until an inactive user's session should timeout. Defaults to 86400 (24 hours).

 

Version

Version

Overall version string identifying LAMS. Displayed on the login screen. Value set when a release is done.

Uploaded Files

 

Label

Configuration Key

Description

(info)

Content Repository Directory

ContentRepositoryPath

This is where all uploaded files are stored, so it needs to be on a disk with plenty of space.

 

Executable Extensions

ExecutableExtensions

Not used at present.

(info)

Maximum Memory Used When Uploading

UploadFileMaxMemorySize

Maximum amount of memory that should be used when user's uploading files. If the file is larger than this, then it is temporarily written to disk.

(info)

Maximum Upload Size

UploadFileMaxSize

Maximum size of file uploaded by a learner. Given in bytes. Defaults to 1048576 (1 MB). Used from LAMS 2.0.1 onwards.

(info)

Maximum Large Upload Size

UploadLargeFileMaxSize

Maximum size of file uploaded in special areas where a larger file is permitted (e.g. authoring). Given in bytes. Defaults to 10485760 (10 MB). Used from LAMS 2.0.1 onwards.

Version

 

Label

Configuration Key

Description

 

Authoring Client Version

AuthoringClientVersion

Version string identifying the build of the Authoring Flash client. Value set when LAMS is compiled.

 

Language Pack Install Date

DictionaryDateCreated

Date when last language pack was installed. Used to trigger the download of new language files to the Flash clients. Should be set when new language packs are installed.

 

Learner Client Version

LearnerClientVersion

Version string identifying the build of the Learner Flash client. Value set when LAMS is compiled.

 

Monitor Client Version

MonitorClientVersion

Version string identifying the build of the Monitoring Flash client. Value set when LAMS is compiled.

 

Server Version Number

ServerVersionNumber

Version string identifying server component version. Value set when LAMS is compiled.



  • No labels