04 Installation ONYX Editor

system

myonyxeditor

3.0

Mandatory. The serviceprovider name (used by ONYX Player)and must be adopted to your Onyx Player configuration.

previewAddress

https://demo.bps-system.de/onyx

3.0

Mandatory. The ONYX Player to use as preview component. In this example is the ONYX Player used at URL https://demo.bps-system.de/onyx

selfRegistrationEnabled

false

6.0

Optional. Should users be able to register themselves? Default is true.

defaultLicences

see above

6.0

Optional. This defines whether or not new users should automatically be assigned to a licence, and if, of which type that licence should be.

This only works with the integrated login e.g. with OLAT, which come with a repository parameter in the ONYX Editor call. This repository name is the key and must match to the name attribute of one of the repository definitions in moduleConfigurationContext.xml.

Format: There are three parts per line, separates by semicolons
Repository name: As stated. In Example above: YourRepoConfiguration
Licence type: One of DEMO, SINGLE, CAMPUS, PUBLISHER
Valid until date: Date in format yyyyMMdd, e.g. 20270731. This will be the date until which the licence is valid for the user.

reporterUrl

https://demo.bps-system.de/onyx

6.3

URL of an ONYX Reporter. This is used for all statistics and evaluation views. The ONYX Reporter instance needs to be configured to be usabe as such, especially the reporterProviderId (see next line) must be known.

reporterProviderId

myInstanceId

6.3

Config name of this ONYX Editors instance in the ONYX Reporter configuration. This configuration contains ONYX Editor data as the URL to send results to. Please contact the ONYX Reporters administrator and negotiate this value.

Note: In earlier versions of the ONYX Editor this was configured in an addtional config file (webServiceContext.xml), which was removed in version 6.3

htmlEntitiesList

https://html.spec.whatwg.org/multipage/entities.json
or /tmp/entities.json

6.3

Optional. Source for HTML entities list. This is used to transform users unicode input in valid XML. Provide a valid URL or file path here.

To avoid Onyx from downloading this file from an external server just do this by yourself and configure the absolute path to this file. Please always keep this file up-to-date since entities may change and non-existent entities will cause XML failures which will destroy user contents.

Default is https://html.spec.whatwg.org/multipage/entities.json

message

Attention! Application restarts at 3 pm!

The fully localized message or a localization key defined in the messages_xy.properties files.

messageParams

3

If message is a localization key defined in the messages_xy.properties files, this option can be used to populate variable placeholders. If the key maps th a localized string "Attention! Application restarts at {1} pm!" and messageParams contains a value "3", the user will see the message as given as example at the message option. This way you are able to show fully localized messages.

messageFrom

0300

A time in Java defined format HHmm (this means two digits hours in 24 hours format, immediately followed by the minutes value). This defines the point in time from which user will see the message. Must have exactly 4 digits.

If not given the message will be shown all the time.

messageDurationInMinutes

90

Defines how long the message will be shown, starting at messageFrom.

publishDirectory

/intern/instances/onyxeditor/data/publish/

Hard disc directory to copy the published tests to.

Leave empty to deactivate publish. Must end with / and must be writable for tomcat user.

publishUniqueIdPrefix

owe

Prefix to use for test runs in player registration. An underscore will be appended automatically.

These keys will be used in communication with Onyx player. This is configurable to adopt this according to your needs, e.g. to be able to distinguish published test runs from other ones in the Onyx player. If you do not need this just leave to value owe.

publishProviderWs

http://my.hot.system.edu/onyx

Service provider Onyx WS location. If not there the preview player instance will be used.

This is the URL to the Onyx player. May be the same as the preview player instance. Please do not enter a trailing slash!

publishProviderId

owePublishedRun

Service provider name referenced in Onyx configuration.

This value must be configured in Onyx player configuration as a valid service provider and with the Onyx Editor URL as results destination.

publishPath

published

Path in URI to published tests. As the "published" in http://my.hot.system.edu/owe/published/

This the last part of the URLs communicated to the users to use the published tests. The server domain is automatically taken from the current system.

publishLimitBase
publishLimitDemo
publishLimitPro
publishLimitCampus
publishLimitPublisher

 200

 License dependent published test starts limits.

The test start count of published tests is restricted according to the publishing users license. The default values are configurable here.

ltiProductInstance

ONYX Customer X

Name of the product instance. Must be unique for every ONYX Editor instances acting as LTI tool provider.

This is also the main config key. If this is not given, the whole LTI functionality will be disabled.

ltiProductInfoToolName

ONYX

Name of the tool as can be displayed by tool consumer.

ltiProductInfoToolDescription

ONYX shows and automatically evaluates tests.

Description of the tool as can be displayed by tool consumer.

ltiProductInfoVersion

10.0

Optional. If not configured the ONYX version will be used

ltiProductInfoToolTechnical

ONYX imports QTI test files and show them to users very fancyly.

Technical description of the tool as can be displayed by tool consumer.

ltiProductFamilyId

https://www.bps-system.de/cms/index.php?id=43&L=1

LTI tool provider product family id

ltiProductFamilyCode

onyx

LTI tool provider product family code.

ltiVendorCode

BPS

LTI tool providers vendor code.

ltiVendorName

BPS Bildungsportal Sachsen GmbH

 LTI tool providers vendor name

ltiVendorDescription

BPS GmbH develops professional e-learning services...

LTI tool providers vendor description

ltiVendorWebsite

https://www.bps-system.de/cms/en/welcome/

LTI tool providers vendor website

ltiResourceHandlerName

ONYX

LTI tool providers resource handler name. This is what the end users in LTI tool consumer can select from.

ltiUrl

https://next.bps-system.de

LTI tool provider URI. This is transmitted from LTI tool provider to tool consumer for backend communication.

ltiInternalPort

20000

LTI tool providers internal port (the one listening on server side). Must be given.

ltiExternalPort

8443

LTI tool providers external port (the one which is SSL enabled and will be communicated by LTI TP to TC to use in GUI. Must be given, but may be the same as internal port if this is already SSL enabled.