FAQs: Administrator

helpdesk > administrator > configuration key > administrators > custom company statuses

Question

How to edit the custom company status options (for CRM)?

Answer

This is dealt with by editing a configuration key called addCustomCompanyStatus (Custom Company Status). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Setting this value to true allows each company in the system to be defined by additional customisable statuses.

You can go in as admin and edit a company status (Admin > Organisation > Company > Edit) and add from the drop down selection menu after ‘Name’.

Company status is listed to the right of Programme Status on the employee record and can be included in reports.

helpdesk > administrator > configuration key > administrators > impersonate learners

Question

How to Enable Impersonate Learners by Admin functionality.

Answer

This is dealt with by editing a configuration key called enableImpersonate (Enable Impersonate Learners by Admin functionality.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Set this value to true to allow Administrators to impersonate Learners. This is useful if the administrator needs to Login to troubleshoot a learner’s issues.

This functionality can be accessed by the administrator from the System Setup > Organisation > Users > Actions > Impersonate User.

We recommend setting this value to true.

helpdesk > administrator > configuration key > administrators > learner approval

Question

How to Approve learners before use.

Answer

This is dealt with by editing a configuration key called isApproveLearners (Approve learners before use.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. If this is set to true, then any user who registers on the system will need to be approved before using the system.

Administrators can track the approval status on their dashboard by viewing the ‘Approved’ column on the ‘Administer Learning > Add Learners’ data view.

helpdesk > administrator > configuration key > apprenticeships > AIM reference service url

Question

How to change the Learning Aim Reference Service URL to Open eLMS in the ILR?

Answer

This is dealt with by editing a configuration key called learnerAimReferenceURL (Learning Aim Reference Service URL). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Direct link to Learning Aim Reference Service ZIP file within each learner’s ILR.

helpdesk > administrator > configuration key > apprenticeships > dates

Question

How to use dates in ILR record for standard.

Answer

This is dealt with by editing a configuration key called linkIlrToUserProgramme (Uses dates in ILR record for standard.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. If this value is true, then the programme dates entered into the system will be replaced by the ILR record dates. This setting applies to UK Government apprenticeships.

helpdesk > administrator > configuration key > apprenticeships > Learner Reference Number iteration

Question

How to change the Learner Reference Number iteration?

Answer

This is dealt with by editing a configuration key called learnerReferenceNumberIteration (Learner Reference Number iteration.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Suffix iteration for the Learner reference number (part of the ILR). e.g.: “domain000001”.

helpdesk > administrator > configuration key > apprenticeships > Learner Reference Number Prefix

Question

How to set the first part of the Learner Reference number?

Answer

This is dealt with by editing a configuration key called learnerReferenceNumberId (Learner Reference number first part.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Default prefix number (first 6 numbers) in Learner reference number (part of the ILR) is changed by altering this value.

helpdesk > administrator > configuration key > apprenticeships > lock ILR

Question

How to Allow or prevent a Learner from editing the ILR (Individualised Learner Record)?

Answer

This is dealt with by editing a configuration key called allowLearnerEditILR (Allow Learner Edit ILR). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration.

helpdesk > administrator > configuration key > apprenticeships > on the job raito

Question

How to vary the prescribed training/work ratio used for calculating on-the-job training requirements?

Answer

This is dealt with by editing a configuration key called Training/work ratio (Training/work ratio). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the proportion of work time for every programme where training is carried out – this is 0.2 or 20% of UK apprenticeships.

helpdesk > administrator > configuration key > apprenticeships > user code replacement

Question

How to set a custom functionality to replace usercode field value data?

Answer

This is dealt with by editing a configuration key called fixUserCodeOnImport (Custom functionality to replace usercode field value data). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Should you need to replace an employee ID that starts with 1xxx…into 01xxx… then activate this option.

This is required in many council HR systems in the UK, where the first ‘0’ is stripped from the import by Excel during processing.

It is very rare that this value will need to be made true.

See fixUserNameOnImport too.

helpdesk > administrator > configuration key > company > CRM fields

Question

How to add CRM Fields to Company data

Answer

This is dealt with by editing a configuration key called companyCrm (Add CRM Fields to Company data). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This adds fields to the Company(e.g. products and contact details) which allows administrators to monitor sales activity for each company.

helpdesk > administrator > configuration key > Curriculum Developer > Go1 Auth token

Question

How to edit the Go1 Auth token?

Answer

This is dealt with by editing a configuration key called go1AccessToken (Go1 Auth token). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This setting connects the GO1 learning repository API. GO1 has the largest library of digital learning content globally.

Contact Open eLMS for details on how to purchase Go1 and set this setting.

helpdesk > administrator > configuration key > Curriculum Developer > Go1 authorisation code

Question

How to edit the Go1 authorization code?

Answer

This is dealt with by editing a configuration key called go1GrantCode (Go1 client secret). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This code connects the GO1 learning repository API. GO1 has the largest library of digital learning content globally.

Contact Open eLMS for details on how to purchase Go1 and set this setting.

helpdesk > administrator > configuration key > Curriculum Developer > Go1 automatic install

Question

How to automatically install resources from authenticated GO1 library?

Answer

This is dealt with by editing a configuration key called go1InstallResourcesCron (Automatically install resources from authenticated GO1 library). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This setting connects the GO1 learning repository API. GO1 has the largest library of digital learning content globally.

Contact Open eLMS for details on how to purchase Go1 and set this setting.

helpdesk > administrator > configuration key > Curriculum Developer > Go1 client ID

Question

How to edit the Go1 client ID?

Answer

This is dealt with by editing a configuration key called go1clientID (Centre category labels). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This ID connects the GO1 learning repository to Open eLMS via OAuth. GO1 has the largest library of digital learning content globally.

Contact Open eLMS for details on how to purchase Go1 and set this setting.

helpdesk > administrator > configuration key > Curriculum Developer > Go1 refresh tokens

Question

How to edit the Go1 Refresh token?

Answer

This is dealt with by editing a configuration key called Go1 Refresh token (Go1 Refresh token). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This setting connects the GO1 learning repository API. GO1 has the largest library of digital learning content globally.

Contact Open eLMS for details on how to purchase Go1 and set this setting.

helpdesk > administrator > configuration key > Curriculum Developer > Go1 secret

Question

How to edit the Go1 client secret?

Answer

This is dealt with by editing a configuration key called go1clientSecret (Go1 client ID). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This password connects the GO1 learning repository to Open eLMS via OAuth. GO1 has the largest library of digital learning content globally.

Contact Open eLMS for details on how to purchase Go1 and set this setting.

helpdesk > administrator > configuration key > Curriculum Developer > Go1 token expiry

Question

How to edit the date Go1 Access token expires on?

Answer

This is dealt with by editing a configuration key called Go1 Access token expires in (Go1 Access token expires in). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This setting connects the GO1 learning repository API. GO1 has the largest library of digital learning content globally.

Contact Open eLMS for details on how to purchase Go1 and set this setting.

helpdesk > administrator > configuration key > Curriculum Developer > Go1 token type

Question

How to edit the Go1 Access token type?

Answer

This is dealt with by editing a configuration key called Go1 Access token type (Go1 Access token type). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This setting connects the GO1 learning repository API. GO1 has the largest library of digital learning content globally.

Contact Open eLMS for details on how to purchase Go1 and set this setting.

helpdesk > administrator > configuration key > Curriculum Developer > import YouTube playlists

Question

How to enable YouTube playlist import into learning library?

Answer

This is dealt with by editing a configuration key called importYoutubePlaylist (Enable youtube playlist import into learning library). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Set this value to true to allow management to import YouTube playlists into the learning library. This method of adding video is much quicker than adding YouTube videos manually, as it automatically imports thumbnail images, titles and keywords directly from the video author.

helpdesk > administrator > configuration key > Curriculum Developer > reset/refresh programme dates after editing programmes

Question

How to show the reset custom completion dates button?

Answer

This is dealt with by editing a configuration key called showResetCustomDatesButton (Show reset custom completion dates button). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Selecting the role level (admin or manager) which will add a button to allow the user to edit all custom completion dates for all users in a given programme. The button shows up in the learning program/edit modal window.

This is useful for bulk editing the dates assigned to learners on the learning programme, normalising them for all learners. It is advised that this is only used to correct data errors, rather than making it a permanent feature of the system.

helpdesk > administrator > configuration key > elearning > SCORM in new window

Question

How to Allow SCORM Container to be played which allows authors to set learning to be opened in a new window?

Answer

This is dealt with by editing a configuration key called allowSCORMContainerPlayer (Allow SCORM Container to be played). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Allow SCORM container downloaded from site to be enabled/functioning.

helpdesk > administrator > configuration key > email > attach files

Question

How to allow the adding of files to email templates.

Answer

This is dealt with by editing a configuration key called enableEmailAttachments (Allows adding files to email templates.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. When activated, multiple files can be added to email templates as attachments.

helpdesk > administrator > configuration key > email > attachment size

Question

How to Maximum size allowed to be added to templates (MB).

Answer

This is dealt with by editing a configuration key called emailAttachmentsSize (Maximum size allowed to be added to templates (MB).). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. The amount is the limitation set on the combined file size per email template in MB. If file or files exceed specified limits, no new files can be added to template.

helpdesk > administrator > configuration key > email > audit report

Question

How to allow the system to send Civica a data audit report?

Answer

This is dealt with by editing a configuration key called allowSendCivicaData (Send Civica Data). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. If set to true, then a data dump of all sales via civica are sent to a named party. Define CivicaManagerEmail to receive this data. Define CivicaFrequencyDays to define how frequently this csv file is sent.

helpdesk > administrator > configuration key > email > civica email frequency

Question

How to set how often Civica audit reports do get sent to managers?

Answer

This is dealt with by editing a configuration key called CivicaFrequencyDays (Civica Frequency Days). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Define CivicaFrequencyDays to define how frequently this csv report is sent out. See allowSendCivicaData to activate this functionality. Define CivicaManagerEmail to record where the data is sent to.

helpdesk > administrator > configuration key > email > civica manager audit email

Question

How to define the Civica manager email?

Answer

This is dealt with by editing a configuration key called CivicaManagerEmail (Civica Manager Email). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Define CivicaManagerEmail to receive Civica data periodically. See allowSendCivicaData to activate this functionality. Define CivicaFrequencyDays to define how frequently this csv file is sent.

helpdesk > administrator > configuration key > email > directly assigned email alerts

Question

How to send emails when directly assigned learning is overdue?

Answer

This is dealt with by editing a configuration key called Allowemailalertassignedlearningoverdue (Send emails when directly assigned learning is overdue.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. If this value set to true, then any learning which has been directly assigned to a learner (i.e. not through a programme) becomes overdue if not completed by that time and the learner gets a periodic email with details of all overdue learning..

If not using learning programmes for the majority of learning (which schedules alerts) then it is advisable to change this value to ‘true’.

helpdesk > administrator > configuration key > email > frequency of alerts

Question

How to change the the Frequency in days by which automated system email alerts are sent out?

Answer

This is dealt with by editing a configuration key called apprentixEmailReminderFrequency (Frequency in days by which automated email alerts are sent out). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This applies to learning resources assigned to standards, programmes and qualifications only. The number represents how often in days emails will be sent out as reminders for resources that are not completed. First email will be sent out set days before expected completion date. Look in timings configuration for more information.

Setting value to 0 will disable this functionality.

helpdesk > administrator > configuration key > email > include line breaks in Outlook

Question

How to replace line breaks in Outlook calendar emails with HTML tags?

Answer

This is dealt with by editing a configuration key called UseHTMLLineBreaksInOutlook (Replace line breaks in Outlook calendar emails with HTML tags.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Line spacing in event descriptions (e.g. for bullets in the description text box) will appear on a single line in Outlook emails. This can be corrected by replacing new lines with <BR/> tags by setting this value to true.

In order not to ruin the formatting of email templates in existing systems, set this value to false; else if a new system, set this value to true.

helpdesk > administrator > configuration key > email > mandatory training

Question

How to activate email alerts for mandatory training?

Answer

This is dealt with by editing a configuration key called allowMandatoryTrainingEmailAlert (Email Alert for Mandatory Training.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Setting this value to true will send each course recipient an email telling them of the assigned learning.

If learners are using the system infrequently (annual training etc.) then it is a good idea to activate this feature. Most clients will want to set this value to false to avoid information overload.

helpdesk > administrator > configuration key > email > overwrite all emails

Question

How to overwrite the email field of all users to a single sent out from system?

Answer

This is dealt with by editing a configuration key called defaultEmailFromName (Overwrites email from field to all emails sent out from system). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. If this value is left empty then the name used in the ‘from’ field in automated emails uses the email address of the user who enters the email .

Alternatively enter an email address so all emails are sent from a group email address e.g. training@acme.com.

helpdesk > administrator > configuration key > email > refreshed learning notifications

Question

How to Send email alerts to learners when learning is due to be refreshed or repeated?

Answer

This is dealt with by editing a configuration key called sendRefreshEmail (Send refresh learning emails). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. When learning resource is refreshed, send email to learner as reminder.

helpdesk > administrator > configuration key > email > set time before meeting to send

Question

How to set how many minutes before to send email reminder about starting scheduled event to users?

Answer

This is dealt with by editing a configuration key called scheduleReminderLead (How many minutes before to send email reminder about starting scheduled event to users). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the time before a scheduled event is about to start when an email reminder is sent to the learner. The system checks every 5 minutes as to whether to send the email, with this in mind, it is advised that the time should always be in excess of 10 minutes.

helpdesk > administrator > configuration key > email > switch off

Question

How to switch off all emails from the system?

Answer

This is dealt with by editing a configuration key called enableEmailFunctionality (This will turn on all email sending features). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. If you want to enable all emails on the system, set this to true, to disable, set to false

helpdesk > administrator > configuration key > email > test email account

Question

How to set the test email account?

Answer

This is dealt with by editing a configuration key called testEmailAccount (Test Email Account). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. If this value is set then all emails generated by the system will go to this account. This field is populated when in testing mode to prevent all test accounts getting emails when setting up and testing the system.

Empty this field when you are ready to launch the system and are happy with the way the system is sending out emails.

helpdesk > administrator > configuration key > email > unique emails

Question

How to Allow Unique Email For User.

Answer

This is dealt with by editing a configuration key called uniqueEmailPerUser (Allow Unique Email For User.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. The email field is unique in user table by default, set this to false to allow importing multiple users with same email.

In most cases this value should be set to true.

helpdesk > administrator > configuration key > emails > CRON alerts

Question

How to send alerts to system administrator if there is problem with any Cron task?

Answer

This is dealt with by editing a configuration key called cronTaskDebug (Sends alerts to system administrator if there is problem with any Cron task.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Setting this to true will send an email alert to the Open eLMS system administrator if there are problems with any Cron task.

This is a setting controlled by Open eLMS and set to true in cases where there are issues with the Open eLMS CRON tasks.

helpdesk > administrator > configuration key > finance > billing

Question

How to change the billing contact name?

Answer

This is dealt with by editing a configuration key called BillingContactName (Contact Name). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This sets the billing company name

helpdesk > administrator > configuration key > finance > Civica ledger code

Question

How to Civica Default General Ledger Code

Answer

This is dealt with by editing a configuration key called civicaDefaultGeneralLedgerCode (Civica Default General Ledger Code). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the default general ledger code used for third party Civica payments. The system otherwise records the ‘Learning Resource Code’ if it is defined.

helpdesk > administrator > configuration key > finance > Civica payments

Question

How to Enabled the Civica Payments Engine

Answer

This is dealt with by editing a configuration key called isCivicaPaymentsEngine (Enabled the Civica Payments Engine). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Setting this value to true will allow learning to be purchased from the system using the Civica payments engine.

helpdesk > administrator > configuration key > finance > Civica request URL

Question

How to Civica Payments Engine Request URL

Answer

This is dealt with by editing a configuration key called civicaPaymentsEngineRequestURL (Civica Payments Engine Request URL). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the request URL for the third party Civica Payments Engine. Contact Civica for this URL if required.

helpdesk > administrator > configuration key > finance > Civica VAT code

Question

How to Civica Vat code relating to product

Answer

This is dealt with by editing a configuration key called civicaPaymentsEngineVatCode (Civica Vat code relating to product). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the VAT payment code for the third party Civica Payments Engine.

Contact Civica for further details if required.

helpdesk > administrator > configuration key > finance > Xero charge by time

Question

How to set billing by Charge by Time

Answer

This is a Xero Accounts Package setting only. This is dealt with by editing a configuration key called BillingisChargebyTime (BillingisChargebyTime). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This means that the system is charged for by the time period, rather than per student registered (only set true for Apprentix charging agreements pre Aug 2019.)

helpdesk > administrator > configuration key > finance > Xero contact ID

Question

How to Contact ID

Answer

This is dealt with by editing a configuration key called BillingContact_ID (Contact ID). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the ID which links the system to the Xero billing system API.

helpdesk > administrator > configuration key > finance > Xero currency

Question

How to Currency

Answer

This is a Xero Accounts Package setting only. This is dealt with by editing a configuration key called BillingDefaultCurrency (Currency). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This sets the default currency

helpdesk > administrator > configuration key > finance > Xero demo

Question

How to Demo Version

Answer

This is a Xero Accounts Package setting only. This is dealt with by editing a configuration key called BillingisDemo (Demo Version). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This decides whether the system is in a demo state or is ready for billing.This is a Xero Accounts Package setting only.

helpdesk > administrator > configuration key > finance > Xero email

Question

How to Billing Email Address

Answer

This is a Xero Accounts Package setting only. This is dealt with by editing a configuration key called BillingEmailAddress (Billing Email Address). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the email of the person dealing with invoices.

helpdesk > administrator > configuration key > finance > Xero first name

Question

How to Billing Contact First Name

Answer

This is a Xero Accounts Package setting only. This is dealt with by editing a configuration key called BillingFirstName (Billing Contact First Name). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the contact first name for the person to whom invoices are sent.

helpdesk > administrator > configuration key > finance > Xero frequency of billing

Question

How to Frequency of Billing

Answer

This is a Xero Accounts Package setting only. This is dealt with by editing a configuration key called BillingRepeats_Months (Frequency of Billing). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This sets the frequency of when invoices are sent out in months. A value must be set – minimum 1 month.

helpdesk > administrator > configuration key > finance > Xero last name

Question

How to Billing Contact Last Name

Answer

This is a Xero Accounts Package setting only. This is dealt with by editing a configuration key called BillingLastName (Billing Contact Last Name). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the contact last name for the person to whom invoices are sent.

helpdesk > administrator > configuration key > finance > Xero membership

Question

How to Membership

Answer

This is a Xero Accounts Package setting only. This is dealt with by editing a configuration key called BillingisMembership (Membership). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This sets up membership and all the related services. For a full description see https://www.e-learningwmb.com/page/membership

helpdesk > administrator > configuration key > finance > Xero next invoice date

Question

How to Next Invoice Date

Answer

This is a Xero Accounts Package setting only. This is dealt with by editing a configuration key called BillingNext_Invoice (Next Invoice Date). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This sets the date of the next invoice, leave blank if you want the system to calculate this for you from the date the system goes live.

helpdesk > administrator > configuration key > finance > Xero set unlimited courses

Question

How to Unlimited Courses

Answer

This is a Xero Accounts Package setting only. This is dealt with by editing a configuration key called BillingisUnlimitedCourses (Unlimited Courses). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This enables the client to full access to all e-learning WMB curated courses.

helpdesk > administrator > configuration key > finance > Xero telephone number

Question

How to Billing Telephone Number

Answer

This is a Xero Accounts Package setting only. This is dealt with by editing a configuration key called BillingTelephone (Billing Telephone Number). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the number of the person dealing with invoices.

helpdesk > administrator > configuration key > general > adding credits to uploads

Question

How to Allow Learners and Managers to define Credits at the upload level.

Answer

This is dealt with by editing a configuration key called learnersDefineEvidenceCredits (Allow Learners and Managers to define Credits at the upload level.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Setting this value to true will allow managers and learners to both set how many course credits any work is worth when it is being uploaded. Set this to true in cases where you want to give learners undertaking qualification programmes to have the maximum control over awarded credits.

helpdesk > administrator > configuration key > general > automatically add all events to Outlook

Question

How to Add all events to Outlook.

Answer

This is dealt with by editing a configuration key called addAllEventsToOutlook (Add all events to Outlook.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Set this to true to automatically add all a learner’s enrolled events to their Outlook calendar.

This will only work if enableGlobalOutlookIntegration is true and GlobalOutlookIntegrationSecurityToken contains a valid security token.

helpdesk > administrator > configuration key > General > Badgr API for badges

Question

How to add the key for Badgr API?

Answer

This is dealt with by editing a configuration key called BadgrApiKey (Data for Badgr API). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the API key for connecting your installation of Open eLMS with the Badgr open badge standard. Use Badgr to create badges which you can award to learners through achievements in Open eLMS (completing elearning resources, programmes or gaining competencies via CPD points) and can then display them on third party applications e.g. LinkedIn, websites, CVs etc. These badges act as lifelong learning achievements which learners can take with them when they leave the LMS.

Badgr uses OAuth2 for most operations. As an API client user, you may obtain an OAuth2 Bearer Token on behalf of your own Badgr user account using a password-based grant, or you can obtain such auth tokens on behalf of many users by registering your own Connected App. See more about registering for an app key and secret here – https://community.canvaslms.com/t5/Canvas-Badges-Badgr/Developers-Build-an-app-that-integrates-with-the-Badgr-API/ta-p/528727.

Your first step is to visit the site https://eu.badgr.com/auth/login to create an account or Login to find your API key (if outside Europe you will need to select the appropriate region).

helpdesk > administrator > configuration key > General > browser tab title

Question

How to edit the Tab Title

Answer

This is dealt with by editing a configuration key called LMSTitle (Tab Title). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the title used in the browser window or tab at the top of the screen. This will identify your company name when accessing the system.

Use an entry such as “Acme – LMS”.

helpdesk > administrator > configuration key > general > CPD

Question

How does one add or remove Competencies and CPD points from the LMS?

Answer

This is dealt with by editing a configuration key called competenciesGamification (Enable Competencies/”Gamification” functionality.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. The learner board demonstrates to the learner how they are performing (in terms of CPD points awarded) when compared with their tot ten cohorts.

helpdesk > administrator > configuration key > general > cron timeout

Question

How to set the maximum time a cron task is allowed to run before it is killed?

Answer

This is dealt with by editing a configuration key called CrontTaskKillTime (Maximum time cron task is allowed to run before it is killed, minutes). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. CRON tasks are server side automated tasks which generate data within Open eLMS.

In some cases CRON tasks can run for a long time, or even indefinitely. THis is bad since it will take up server resources and eventually cause the system to go down.

Open eLMS will close any CRON task after a period of time in order to prevent this from happening. The default time is 2 hours, this can be increased to a ceiling of 5 hours, or reduced to a minimum of 20 minutes.

helpdesk > administrator > configuration key > General > custom programme statuses

Question

How to set up custom programme statuses?

Answer

This is dealt with by editing a configuration key called addCustomProgrammeStatus (Custom Programme Status). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Set this value to true to allow each user to be defined by additional customisable statuses. The status is attached to the learner (not programs) and can be seen at the top of each learner’s Progress page (obtained by managers drilling down into each learner’s details.)

This allows more granularity to the standard Not Started, In Progress and Completed statuses applied to learners; this does not replace these core statuses.

helpdesk > administrator > configuration key > general > data retention

Question

How to limit the number of years logging data is retained

Answer

This is dealt with by editing a configuration key called loggingDataRentention (How many years logging data is retained). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Login data is deleted after the amount of years shown in the configuration value.

helpdesk > administrator > configuration key > General > Define the badges’ region

Question

How to edit the Badgr API region (badges)?

Answer

This is dealt with by editing a configuration key called badgrRegion (Badgr API Region). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Ensure your region (which matches where you registered Badgr) matches the values of either: Us (defaulT), AU, CA or EU.

European clients would register at https://eu.badgr.com/auth/login , whilst canadian clients would register at https://ca.badgr.com/auth/login.

If you have not already done so, your first step is to visit the site which matches your region and register there:

https://badgr.com/auth/login

https://au.badgr.com/auth/login

https://ca.badgr.com/auth/login

https://eu.badgr.com/auth/login

helpdesk > administrator > configuration key > General > domain permission for embedding

Question

How to specify domains that can embed Open eLMS on the site?

Answer

This is dealt with by editing a configuration key called allowIframeEmbedFromDomains (Specify domains that can embed site.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. If you are allowing third party sites to embed registration forms, for security reasons you may want to validate the URLs first.

Do do this add the list of URLs which are allowed to embed the registration from in an iframe e,g. ‘self’, example.com, *.example.net

helpdesk > administrator > configuration key > General > Enable badges status

Question

How to enable the status of Badges via the API?

Answer

This is dealt with by editing a configuration key called badgesEnabled (Status of Badges API). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This enables badges on Open eLMS. Ensure badges are enabled first by defining the configuration key BadgrApiKey first.

helpdesk > administrator > configuration key > general > enable outlook

Question

How to enable the global Outlook integration?

Answer

This is dealt with by editing a configuration key called enableGlobalOutlookIntegration (Enable Global Outlook integration.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Add all events to a single (global) Outlook calendar. The GlobalOutlookIntegrationSecurityToken options must also be set.

helpdesk > administrator > configuration key > General > enabled Google Analytics

Question

How to add Google Analytics?

Answer

This is dealt with by editing a configuration key called googleAnalyticsCode (Make Resources link to Home). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Google Analytics can be linked with Open eLMS by adding Google Analytics tracking code here.

To do this you will need to first sign up for a Google Analytics account. (You’ll need a Gmail account to do it!)

Then copy your Google Analytics tracking ID/code:

In your GA account, head to Admin in the bottom left corner of the page.

Click ‘Create Property’ and follow the instructions until you click ‘Create’ (unless you already have a property connected)

Under ‘Choose a platform,’ select Web. Add your URL and stream name under ‘Set up your web stream.’

Click the settings icon, click ‘Show advanced options’ under ‘Page views.’ Deselect the ‘Page changes based on browser history events’ checkbox.

Disable the ‘Site search’ toggle and click save.

Click ‘Create stream’ and copy the tracking code/measurement ID and paste it here to track activity in Google Analytics.

helpdesk > administrator > configuration key > General > Enforce default role

Question

How to enforce the default role when first logging in (e.g. always Login as learners)?

Answer

This is dealt with by editing a configuration key called EnforceDefaultRole (Enforce Default Role). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. If set to true, then the default role (see defaultIlrRole) is used the first time a learner logs in.

Set this value to true if you want users to all have a consistent experience when logging in.

It is advised that in most installations to leave this value as false, since users will usually remain using the same role each time they Login.

helpdesk > administrator > configuration key > General > fields monitored for completion

Question

How to List of fields in user table, monitored for completion

Answer

This is dealt with by editing a configuration key called userFieldAlertSystemMonitoredFields (User field alert system alert sent time/date). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. If the registration field alert system is enabled (i.e. enableUserFieldAlertSystem = True) then the fields for checking are added here. if any of the fields have not completed been, then a reminder email will be sent to the selected users.

Some sample field names are: ‘DateOfBirth,fname,lname,email,extended_Gender__c,extended_Salutation,extended_Year_of_Onset__c,extended_Employment_Status__c,extended_Health_Consent__c,country_id,Postcode” – do check with Open eLMS prior to setting these variables’.

helpdesk > administrator > configuration key > General > Google Analytics code

Question

How to Enable Google Analytics code.

Answer

This is dealt with by editing a configuration key called enableGoogleAnalytics (Google Analytics). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Setting this to true will enable the Google Analytics code. The key googleAnalyticsCode will need to be defined first, check out this configuration option first.

helpdesk > administrator > configuration key > General > H5P client id

Question

How to set the H5P client Id?

Answer

This is dealt with by editing a configuration key called H5P_CLIENT_ID (H5P client Id). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. H5P is a gamification authoring system which allows users to create learning to add to the Open eLMS Learning Library from directly within Open eLMS.

Change the LTI configuration if H5P is purchased by your organisation to your own client ID. You will need to obtain this ID from H5P.

helpdesk > administrator > configuration key > General > H5P client lti url

Question

How to set the H5P LTI 1.1 Url?

Answer

This is dealt with by editing a configuration key called H5P_LTI_URL (H5P LTI 1.1 Url). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. H5P is a gamification authoring system which allows users to create learning to add to the Open eLMS Learning Library from directly within Open eLMS.

Change the configuration if H5P is purchased by your organisation to your own LTI url You will need to obtain this url from H5P.

helpdesk > administrator > configuration key > General > H5P client secret

Question

How to set the H5P client Secret?

Answer

This is dealt with by editing a configuration key called H5P_CLIENT_SECRET (H5P client Secret). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. H5P is a gamification authoring system which allows users to create learning to add to the Open eLMS Learning Library from directly within Open eLMS.

Change the configuration if H5P is purchased by your organisation to your own secret key. You will need to obtain this key from H5P.

helpdesk > administrator > configuration key > General > Integrations

Question

Anders Pink

Answer

This is dealt with by editing a configuration key called AndersPinkApiKey (Private API key for Anders Pink). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Adding this key will add the Anders Pink news feed into the Open eLMS system for the learners to review. Anders Pink will need to be purchased through Open eLMS, this key can be obtained from https://anderspink.com/export-settings/ .

helpdesk > administrator > configuration key > general > IP range

Question

How to Block specific IPs or range.

Answer

This is dealt with by editing a configuration key called ipBlock (Block specified IPs or range.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. For security reasons (ISO 27001, GDPR compliance etc.) it is advisable – where there is a security concern – to limit access to the site to pre-designated IP addresses.

Specify IP or IP range to block from accessing site.

Examples:

192.168.10.1

192.168.10.*

10.1.0.0-10.1.255.255

172.16.1.0/24

helpdesk > administrator > configuration key > General > Jamboard client secret

Question

How to edit the Google Jamboard client secret?

Answer

This is dealt with by editing a configuration key called GoogleJamboardclientSecret (Google Jamboard client Secret). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This allows learners and managers to access a shared Google whiteboard in events (i.e. Jamboards).

Make sure allowJamboards is true and GoogleJamboardclientId is also defined.

helpdesk > administrator > configuration key > General > Jamboard ID

Question

Where to add the Google Jamboard client Id?

Answer

This is dealt with by editing a configuration key called GoogleJamboardclientId (Google Jamboard client Id). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This allows learners and managers to access a shared Google whiteboard in events (i.e. Jamboards).

Make sure allowJamboards is true and GoogleJamboardclientSecret is also defined.

helpdesk > administrator > configuration key > General > Jamboard redirect URL

Question

How to Jamboard Redirect Url

Answer

This is dealt with by editing a configuration key called JamboardRedirectUrl (Jamboard Redirect Url). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Make sure allowJamboards is true to activate this feature.

helpdesk > administrator > configuration key > General > Jamboard template

Question

How to a Jamboard template field?

Answer

This is dealt with by editing a configuration key called JamboardTemplateFileId (Jamboard Template FileId). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This loads in a default starting template which is then used as a shared Google whiteboard in events (i.e. Jamboards). Add the URL for the Jamboard you want to use as a template.

Make sure allowJamboards is true to activate this feature.

helpdesk > administrator > configuration key > General > Jamboards

Question

How to add Jamboards

Answer

This is dealt with by editing a configuration key called allowJamboards (Use Jamboards). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This allows learners and managers to access a shared Google whiteboard in events (i.e. Jamboards).

Make sure the values of GoogleJamboardclientId and GoogleJamboardclientSecret are set before enabling this feature.

helpdesk > administrator > configuration key > general > leaderboard visible

Question

How to show the leaderboard list/table.?

Answer

This is dealt with by editing a configuration key called enableLeaderBoardList (Show leaderboard list/table.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Set this value to true to show a leaderboard on the learner’s data page. Accessed via the ‘Progress’ button in the top right hand corner of the learner’s interface.

helpdesk > administrator > configuration key > General > link teams and sub-teams

Question

How to group teams and sub teams together?

Answer

This is dealt with by editing a configuration key called isGroupCountries (Group Teams). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Set this to true to create a link between Teams and sub-Teams, so if a team is selected, then only sub teams from that team can be selected.

By default this is set to ‘false’ and cities are grouped by country instead.

helpdesk > administrator > configuration key > general > Microsoft Application client Id

Question

How to define the Microsoft Application client Id?

Answer

This is dealt with by editing a configuration key called MicrosoftAppclientId (Microsoft Application client Id.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. You need to define the MicrosoftAppclientId and MicrosoftAppclientSecret to integrate MS Services. Currently these values are set using eLearning WMB’s MS Azure values for demonstration purposes only.

To create the app, Login to https://portal.azure.com and create an app. Then set the value in Open eLMS Configuration settings for the MicrosoftAppclientId to its client id and set MicrosoftAppclientSecret. Give this app the correct permissions (i.e. accessing Teams, One Drive, PowerBi, Outlook calendar, etc.) and set up the following redirect urls:

https://lms.e-learningwmb.co.uk/msintegration/teams (to enable teams integration)

https://lms.e-learningwmb.co.uk/msintegration/powerbi (powerbi)

https://lms.e-learningwmb.co.uk/msintegration/teams/outlook (outlook)

https://lms.e-learningwmb.co.uk/msintegration/teams/onedrive (one drive, needed to fetch teams recordings)

helpdesk > administrator > configuration key > general > Microsoft Application secret

Question

How to define the Microsoft Application client secret?

Answer

This is dealt with by editing a configuration key called MicrosoftAppclientSecret (Microsoft Application client Secret.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. You need to define the MicrosoftAppclientId and MicrosoftAppclientSecret to integrate MS Services. Currently these values are set using eLearning WMB’s MS Azure values for demonstration purposes only.

https://lms.e-learningwmb.co.uk/msintegration/teams (to enable teams integration)

https://lms.e-learningwmb.co.uk/msintegration/powerbi (powerbi)

https://lms.e-learningwmb.co.uk/msintegration/teams/outlook (outlook)

https://lms.e-learningwmb.co.uk/msintegration/teams/onedrive (one drive, needed to fetch teams recordings)

helpdesk > administrator > configuration key > general > moodle

Question

How to Moodle Link

Answer

This is dealt with by editing a configuration key called moodleLink (Moodle Link). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Open eLMS can be combined with Moodle so it can use the learning resources in that LMS but track them in Open eLMS (progress is tracked in both systems.) Enter the URL of the Moodle location to enable this functionality.

helpdesk > administrator > configuration key > General > MS Teams client ID

Question

How to MS Teams App client Id

Answer

This is dealt with by editing a configuration key called TeamsclientId (MS Teams App client Id). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the ‘Microsoft Teams client Secret’ string connecting the system to Teams. Do not change this value – i.e. 68a2742e-92f8-471a-b1c4-7251ca5b2fa9

helpdesk > administrator > configuration key > General > MS Teams Secret

Question

How to add the MS Teams App client Secret?

Answer

This is dealt with by editing a configuration key called TeamsclientSecret (MS Teams App client Secret). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the ‘Microsoft Teams client Secret’ string connecting the system to Teams. Do not change this value – i.e. 3yrR[RZ_2nuF82gwtKTUBMJjYCstxw]:

helpdesk > administrator > configuration key > general > nightly export

Question

How to set up a nightly user data export?

Answer

This is dealt with by editing a configuration key called enableMightlyUserDataExport (Nightly user data export). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Setting this value to true will export enabled user data as a CSV file, every night. Contact Open eLMS for more information on how to receive this file.

helpdesk > administrator > configuration key > general > Olark code

Question

How to Enable Olark code.

Answer

This is dealt with by editing a configuration key called enableOlark (Enable Olark code.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This adds the Olark chat integration to the Open eLMS system. Olark needs to be purchased separately.

helpdesk > administrator > configuration key > general > Olark integration

Question

How to integrate Olark chat engine?

Answer

This is dealt with by editing a configuration key called olarkCode (Script from Olark). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This will integrate the Olark chat engine within Open eLMS. Add the integration code from Olark in Value field to activate this feature.

helpdesk > administrator > configuration key > general > Open eLMS API

Question

How to Enable the Open eLMS API?

Answer

This is dealt with by editing a configuration key called allowApi (Enable API for site.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Allow Learner to add Blog Entry as new learning type. That can be assigned to other learners by managers

helpdesk > administrator > configuration key > general > Open eLMS API setup

Question

How to add an API Access Token?

Answer

This is dealt with by editing a configuration key called APITokenAccess (API Access Token). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the access token for using the Open eLMS API.

More details on the API can be found at https://openelms.com/support/open-elms-api/

helpdesk > administrator > configuration key > general > Open eLMS Creator Version

Question

How to Jackdaw Version

Answer

This is dealt with by editing a configuration key called BillingJackdawVersion (Jackdaw Version). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This is the maximum Jackdaw version of the system which the administrator is allowed to assign to anyone.

helpdesk > administrator > configuration key > general > outlook security token

Question

How to enter Global Outlook integration security token?

Answer

This is dealt with by editing a configuration key called GlobalOutlookIntegrationSecurityToken (Global Outlook integration security token.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This security token used to add all events to each users’ calendars. Use this link to generate a token https://lms.e-learningwmb.co.uk/base_business/./teams/globaloutlooktoken

helpdesk > administrator > configuration key > General > password attempts

Question

How to set the maximum number of password attempts?

Answer

This is dealt with by editing a configuration key called PasswordMaxAttempts (Password Maximum Attempts). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Only use this option if you are using manual logins (i.e. not single sign-on – SSO.)

Entering a number here will limit the number of access attempts allowed. After exceeding the number of tries the user will get the following message “You have unsuccessfully tried to access this account too many times. You will need to reset your password by accessing the forgotten password link in order to gain access to this account again.”

helpdesk > administrator > configuration key > general > RAG settings

Question

How to edit the RAG or Traffic light system timings?

Answer

This is dealt with by editing a configuration key called nextDueTrafficLight (Traffic light system for next Due Date). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. When a line manager views the ‘Check Progress’ table, green indicates the ‘Next Due date’ is more than 4 weeks from when viewed, amber represents the ‘Next Due date’ to be less than 4 weeks away, whilst red signifies the due date has been passed (overdue)

helpdesk > administrator > configuration key > general > responsibilities and committees

Question

How do you record Responsibilities and Committees to Open eLMS?

Answer

This is dealt with by editing a configuration key called showResponsibilitiesAndCommittees (Manage Responsibilities and Committees for non-SMCR sites.). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. Responsibilities and committees functionality allows managers to assign a record of these responsibilities to learners. This assists managers identify training needs of their assigned personnel.

helpdesk > administrator > configuration key > General > Salesforce access token

Question

How to edit the Salesforce access token?

Answer

This is dealt with by editing a configuration key called Salesforce access token (Salesforce access token). You can edit configuration settings by logging in as admin and editing the key in System Settings>Defaults>Configuration. This setting connects the Salesforce API so data can be written to and read from this CRM system.