Avendoo® online documentation

System settings

You have the following functions in the area Administration → System settings:

Inhalte

The following functions are available via the context menu of the appropriate system setting title.

Learning content

Defining the duration of display for the note text on URL media

To shorten the waiting time for a URL routing, do the following steps:

  1. Enter in the search field of the system settings “goUrl.forwarding.timeout”.
  2. Open the Wizard for system settings via click on the title.
  3. Enter the time in seconds, when the user should be routed to the URL medium. Example: “1”.
  4. Click on the button Save.

Changing the standard date format on the event date import

To change the standard date format on the event date import, do the following steps:

  1. Enter in the search field of the system settings “importwizard.default.dateformat“.
  2. Open the Wizard for system settings via click on the title.
  3. “yyyy-MM-dd” is set as default. If applicable do changes.
  4. Click on the button Save.

Adjusting the standard configurations of events

If you want to adjust the standard configurations of events, do the following steps:

  1. Enter in the search field of the system settings “seminar.configuaration”
  2. Open the Wizard for system settings via click on the title.
  3. Enter the favored standard configuration for the favored event type in the field “Edit characteristic”.
    It is valid:
    2 = seminar
    3 = test
    4 = information event
    5 = training
    6 = lecture
    7 = instructions
    8 = training (education)
    If you want to define the numbers 9 to 20, you open the system setting changed.bundles.xml for a new bundle entry. Example: seminar.subtype.9=NEW TYPE
  4. For a new event it is always the standard configuration valid. If there a special standard configurations regarding the event type, the user is asked on changing the event type, if adjustments regarding the seminar settings should be done.
Configuration parameters on event level
ParameterDescription
SUB_TYPE.enableCustomConfigDefines if there should be used special adjustments for the type.
Communication [event process]
seminarEscort
Defines the number of escorts.
seminarReminderDaysBeforeEventStartDefines the number of days for the reminder.
seminarDeadlineDaysBeforeEventStartDefines the number of days for due date.
seminarClosingDateDaysBeforeEventStartDefines the number of days for closing date before starting date.
seminarClearWaitingListOnClosingDateDefines if the waiting list should be cleared on closing date.
seminarUnsubscribeDateDaysBeforeEventStartDefines the number of days for the deregistration date (-1= On starting date; 0= On closing date; all larger than zero= Number of the days)
seminarClearWaitingListOnUnsubscribeDateDefines if the waiting list should be cleared on deregistration date.
seminarAfterEventMailDaysDefines the number of days for the post-processing.
seminarMultipleEventRegistrationAllow to register on multiple event dates.
seminarAltenativeEventRegistrationParticipants are allowed to register on an alternative event date, if they have missed an event date.
seminarAdditionalWaitinglistAdditional waiting list registration
seminarAdditionalWaitinglistAndRemoveRemove participants from the additional waiting list, if the deregistration date of the event date is reached by registration.
seminarMoveFromWaitinglisAutomatic succeeding of the participants from the waiting list.
Communication [Registration and invitation e-mails]
seminarCommunicationMail
0 = No automatic mailing
1 = Automatic confirmation of registration
2 = Invitation e-mail immediately on registration
3 = Invitation e-mail automatically on closing date
4 = Confirmation of registration and invitation e-mail are automatized
seminarRejectMailCoordinatorThe coordinator should be informed, if a user rejects a meeting request of an invitation or of a confirmation of registration.
seminarRejectMailReferentThe event speaker should be informed if a user rejects a meeting request of an invitation or of a confirmation of registration.
seminarRejectMailCoReferentThe co-event speakers should be informed if a user rejects a meeting request of an invitation or of a confirmation of registration.
seminarMailReplyToRecipientCoordinatorThe coordinator should be informed if a user replies to an event e-mail.
seminarMailReplyToRecipientReferentThe event speaker should be informed if a user replies to an event e-mail.
seminarMailReplyToRecipientCoReferentThe co-event speaker should be informed if a user replies to an event e-mail.
seminarMailReplyToRecipientFreeAddressAn e-mail is sent to the info mail, if a user replies to an event e-mail.
seminarMailInviteReferentActivate meeting requests for event speakers
seminarMailInviteCoReferentActivate meeting requests for co-event speakers
seminarMailInviteEventDefaultActivate checkbox “Default for meeting requests for event speakers” (See Event wizard -> Communication -> Registration confirmation -> Send meeting request)
communityMessageRegisterParticipantCommunity message of registration to participant
communityMessageRegisterSuperiorCommunity message of registration to superior
communityMessageRegisterCoordinatorCommunity message of registration to coordinator
communityMessageRegisterOwnerCommunity message of registration to owner of the event
communityMessageUnregisterParticipantCommunity message of deregistration to participant
communityMessageUnregisterSuperiorCommunity message of deregistration to superior
communityMessageUnregisterCoordinatorCommunity message of deregistration to coordinator
communityMessageUnregisterOwnerCommunity message of deregistration to owner of the event
communityMessageMailInviteReferentResponseOwnerActivate community message about reply of the event speaker to the owner of the event.
communityMessageMailInviteReferentResponseCoordinatorActivate community message about reply of the event speaker to the coordinator of the event date.
communityMessageInformAboutCancelMailCoordinatorInform coordinator about unauthorized deregistration
communityMessageInformAboutCancelMailSuperiorInform superior about unauthorized deregistration
communityMessageInformAboutCancelMailCustomUserLogin of a user, who should be informed about unauthorized deregistrations.
Event dates [options]
seminarTimeTableShowReferent
Shows the event speaker.
seminarTimeTableShowPriceShows the price of the event.
seminarTimeTableShowSeats0 = Show no participant list of all event dates and the free places
1 = Show participant list of all event dates and the free places
2 = Show no participant list of all event dates and no free places
defaultAutoHotelBookingTo activate the default of the automatic hotel booking in the Event date wizard, set it to true.
Configuration parameters on event date level
ParameterDescription
newEventSubscribeCcMailSuperiourSends confirmation of registration CC to superior.
Note: To activate, you set the value “=true”.
newEventSubscribeCcMailCoordinatorSends confirmation of registration CC to coordinator.
newEventSubscribeCcMailOwnerSends confirmation of registration CC to the owner of the event.
newEventSubscribeCcMailTrainerSends confirmation of registration CC to the trainer coach.
newEventInvitationCcMailSuperiourSends invitation CC to superior. Note: To activate, you the value “=true”.
newEventInvitationCcMailCoordinatorSends invitation CC to coordinator.
newEventInvitationCcMailOwnerSends invitation CC to the owner of the event.
newEventInvitationCcMailTrainerSends invitation CC to the trainer coach.
newEventPresenceListOption0 = On closing date
1 = X days before starting date
newEventPresenceListRecipientCoordinatorSends attendance list to the coordinator.
newEventPresenceListRecipientReferentSends attendance list to the event speaker.
newEventPresenceListRecipientCoReferentSends attendance list to the co-event speaker.
newEventInvitationToResourcesSends meeting requests to the event speaker.
newEventMinParticipantMinimum number of participants
newEventMaxParticipantMaximum number of participants
newEventWaitinglistNumber of participants on waiting list

4. Click on the button Save.

Example:

#standard konfiguration
seminarEscort=5
...

#config für event sub typ 3
3.enableCustomConfig=1
3.seminarEscort=10
...

#config für event sub typ 4
4.enableCustomConfig=0
4.seminarEscort=20
...

This configuration defines for a new created event, that the number of escorts is standardized to 5.
If the event type will be changed to 3 and the user accepts the adjustments of the seminar, then the number of escorts changes to 10, because the configuration is activated for event type 3 (3.enableCustomConfig=1).
If the event type will be changed to 4 and the user accepts the adjustments of the seminar, then the standard configuration (number of escorts = 5) is valid, because the configuration is activated for the event type 4 (4.enableCustomConfig=0).
If the event type will be changed to 5 and the user accepts adjustments of the seminar, then the standard configuration (number of escorts =5) is valid, because the configuration contains no settings for type 5.
If the user doesn’t accept adjustments of the seminar, then the existing settings of the event won’t be changed. A query, if adjustments of the seminar should be done, only appears, if there is a special configuration for an event type.

Connecting a virtual classroom

If you want to connect a virtual classroom with Vitero, do the following steps:

  1. Enter in the search field of the system settings “connector.vc.vitero”.
  2. Open the Wizard for system settings via click on the title.
  3. To activate this function, set viteroConnection to true.
    This value is set to false by default and will be set to true on copying.
Parameter Description Mandatory/optional
hostName [www.host.de][:optional port]

This is the address, under which Vitero communicates. You don’t have to set the port mandatory, but you have to remove the square brackets.

Mandatory
username [vitero login user name]

This is the user name of the (Vitero-) Client Administrator.

Mandatory
password This is the password of the (Vitero-) Client Administrator. Mandatory
customerID The customerID represents the client of Vitero. Mandatory
defaultPassword Each Avendoo® user,who uses Vitero the first time, receives a new Vitero account with this password. The user don’t know it and also don’t need it. Mandatory
overbook This parameter represents a number of persons, which additionally is reserved for the room booking.

Default is 0.

Optional
leadTime This parameter stands for a number of hours in future, until then the room in Vitero is created.

Default is 24.

Special rule: If you enter -1, then there is no time limit and the Vitero room is created at once (in 15 minutes tact).

Please note, that changes of the room, time shiftings or deletions are not transferred by Avendoo®.

Optional
audienceCount This parameter represents the licensed number of audience. Audience is enabled, when the variable is greater than 0 and audience is needed at the point of booking regarding the number.

Default is 0.

Optional
audienceMode This parameter represents the booking priority with audience.

“1”means that the biggest room and the lowest audience is used (standard).

“2”means that the smallest room and the most audience is used.

Optional
phoneconference Enable dialing in

To activate set to true.

Default is false.

Optional
showdialogue Direct dial in

To activate set to true.

Default is false.

Optional
dialout Participants can get also called

To activate set to true.

Default is false.

Optional
dialoutphoneparticipant Switching participants on is allowed

To activate set to true.

Default is false.

Optional
capture Recording is allowed

To activate set to true.

Default is false.

Optional
pcstateokrequired Participation only with PC status okay

To activate set to true.

Default is false.

Optional
joinUrlBeforeBegin This value stands for, how many minutes before beginning of the event date the link is shown in order to join the Vitero room. Vitero is at this point already opened and serviceable. The following values are allowed: 15, 30, 45 or 60.

Default is 15.

Optional
endBuffer [Minutes (0 – 60)]

This value stands for, how many minutes after the end of the event date the room is opened. This has no effect to the join link.

The following values are allowed: 0, 15, 30, 45 or 60.

Default is 0.

Optional

4. Click on the button Save.

If you want to use iLinc or WebEx, please contact our support team.

Course management

Standard selection for rules on participants

If you want to define the standard selection for rules on participants, do the following steps:

  1. Enter “participant.rule.default.registerstatus” in the search field.
  2. Open the Wizard for system settings via click on the title.
  3. Set the system propertie to true, if the participant should be registered.
    Set the system propertie to false, if the content should be entered on the catalog.
    Note: Note that the setting regarding Optional or Required are transferred from the course activation to the new rules on participants in this course activation as default values.
  4. Click on the button Save.

Configuring the default value of the start and the end of the run

To configure the default value of the start of the run, do the following steps:

  1. Enter in the search field of the system settings “default.inning.start“.
  2. Open the Wizard for system settings via click on the title.
  3. Enter in the field Edit characteristic one of the following values: 0 (this means no start date), 1 (this means date is defined on the current day) and 2 (this means start date is dependent on the event date start and the days are defined on “0”).
  4. Click on the button Save.

To configure the default value of the end of the run, do the following steps:

  1. Enter in the search field of the system settings “default.inning.end“.
  2. Open the Wizard for system settings via click on the title.
  3. Enter in the field Edit characteristic one of the following values: 0 (this means no end date), 1 (this means date is defined on the current day) and 2 (this means end date is dependent on the event date end and the days are defined on “0”).
  4. Click on the button Save.

Defining the numbers of minutes of the organizational block of time

To define the numbers of minutes of  an organizational block of time in runs, do the following steps:

  1. Enter in the search field of the system settings “inning.config“.
  2. Open the Wizard for system settings via click on the title.
    You find the number of minutes (=15) in the line organisationalblock.start.before.
  3. Change the number of minutes if applicable.
  4. Click on the button Save.

Defining the size of preview images in course activations and training plans

To define the size of preview images in the course activations and training plans, do the following steps:

  1. Enter in the search field of the system settings “image.cropper.settings.max.widthheight“.
  2. Open the Wizard for system settings via click on the title.
  3. Change if applicable the size of preview images in course activations and training plans by entering the first value for the width (in pixel) and the second value for the height (in pixel) after the semicolon. Default setting: “300;300”
  4. Click on the button Save.

Defining IDD profiles for the registration management of the course activation

To define the IDD profiles for the registration management of the course activation in the system setting “insuranceDistributionDirective”, please contact our  Support Team.

Defining the standard default language for new courses

To define the standard default language for new courses, do the following steps:

  1. Enter in the search field of the system settings “course.multilingual.default“.
  2. Open the Wizard for system settings via click on the title.
  3. Select between the following parameters:
    – “none” for no default language,
    – “orig” for the original language of the language object or/and
    – Language code, this means “de”, “en”, “fr” etc. for the preferred language, otherwise the original.
    Note

    The languages have to be defined in the system setting “author.languages.available”. If there is a non-defined language in the system setting “course.multilingual.default”, “No alternative” is valid on the fallback language for course objects.

  4. Click on the button Save.

Further information about the fallback language for course objects you find here.

Deeplinks

Activating a deeplink on feedback forms with SSO

To activate a safe deeplink for users, so they can evaluate “My feedbacks” , do the following steps:

  1. Enter in the search field of the system settings “feedback.use.deeplink“.
  2. Open the Wizard for system settings via click on the title.
  3. To activate the old link for users, leave the setting on 0.  To activate the deeplink for users, change the setting to 1.
  4. Click on the button Save.

Event management

Suppression of the invitation e-mail, preparation and attendance list

If you want to configure the suppression of the invitation e-mail , of the preparation to the coordinator and of the attendance list (via e-mail) because of non-achievement of the minimum number of participants, do the following steps:

  1. Enter “seminar.disablemail.minparticipant.notreached” in the search field.
  2. Open the Wizard for system settings via click on the title.
  3. To activate the suppression of the e-mails, set the value to “true”.
  4. Click on the button Save.

Defining tags for the filter search

To define tags for the filter search in the event management, do the following steps:

  1. Enter in the search field of the system settings “seminar.event.tags” .
  2. Open the Wizard for system settings via click on the title.
  3. Enter in the field Edit propertie the favored tags. After each tag you press the key Enter.
  4. Click on the button Save.

Creating an info task if not achieving the minimum number of participants

If you want to create an info task before a main event date if the minimum number of participants isn’t achieved, do the following steps:

  1. Enter in the search field of the system settings “minParticipantTask.configuration“.
  2. Open the Wizard for system settings via click on the title.
    The function is deactivated per default, this means enabled=false.
  3. To activate the function, enter enabled=true.
  4. Define the ID of the standard task template, which should be used for the task. You can view the ID in the browser window of the contextmenu Edit, example: -5670601525796513620. To define the ID of the standard task template, enter the ID after defaultTemplateID= . This value is mandatory, because task assignments should be created on event dates.
  5. Define for whom the task should be created. Is this value incorrect, the system uses the default value.
    1=Coordinator of the event date (default)
    2=Owner of the event
    3=Manually defined author. The value from the parameter defaultRecipientId is used.
  6. Enter the UID of the author, whom should be assigned a task, after defaultRecipientId=. If there is no author for the appropriate UID, the default value of defaultRecipientType is used.
  7. Click on the button Save.

If the function is activated, the appropriate task will automatically assigned to the newly created event date (main event date).  This task will be adjustable and removable at any time.

A cron job checks each hour (0:35), if a new task shold be created for the main event date. Therefore the registration and deregistration deadline should be achieved, the start of the event date should be in the future, the minimum number of participants shouldn’t be achieved and there shouldn’t exist an open task for the task assignment of the main event date.

The expiry date of the task is defined at the current time, at which the task will be created. Then the author receives additionally an appropriate TODO community message. If authors mark this message off, the appropriate task doesn’t get the status “Completed”. And if authors set the status of the task to “Completed”, the TODO community message won’t be removed or set to “Completed”.

Activating the checkbox Cancel a price in the canceling template

If you want to set the checkbox “Cancel a price” in the canceling template on default, do the following steps:

  1. Enter in the search field of the system settings “seminar.event.price.reset“.
  2. Open the Wizard for system settings via click on the title.
  3. To activate the function, set it to true (=1).  For deactivating set it to false (=0).
    Note

    This system property has more priority than the value of “jms.billing.deregistered”.

  4. Click on the button Save.

Configuring registration deadline note for speakers

If you want to configure a time lock for selfregistration, do the following steps:

  1. Enter in the search field of the system settings “seminar.event.send.leader.invitation“.
  2. Open the Wizard for system settings via click on the title.
  3. Do the appropriate configurations. 1 represents e-mail type (5), this means the registration deadline note is activated. 0 represents the activation of the e-mail type (36).
  4. Click on the button Save.

Adding further reasons for cancellation

If you want to add further reasons of cancellation for the function “Change the event date status”, do the following steps:

  1. Enter in the search field of the system settings “changed.bundles.xml“.
  2. Open the Wizard for system settings via click on the title.
  3. Search for the entry “author.seminarevent.wizard.cancellationReason.7”.
  4. Enter after this entry “author.seminarevent.wizard.cancellationReason.8=” and your favored reason of cancellation in the next line. Number consecutively for each further entry the reason of cancellation.
  5. Click on the button Save.

Deactivating the e-mail Event – fulness status

If you want to deactivate the e-mail “Event – fulness status” to the coordinators , do the following steps:

  1. Enter in the search field of the system settings “system.property.disable.seminar.capacity.mail“.
  2. Open the Wizard for system settings via click on the title.
  3. To deactivate the e-mail “Event – fulness status”, enter the value true.
  4. Click on the button Save.

Configuring the displayed time period in Gantt diagrams

If you want to configure the daily start and end time in the Gantt diagrams (Utilization of speakers, Utilization of locations and Utilization of materials), do the following steps:

  1. Enter in the search field of the system settings “gantt.configuration“.
  2. Open the Wizard for system settings via click on the title.
    For the daily start time “daily.hour.start” “0” is defined per default, and for the daily end time “daily.hour.end” “24” is defined per default.
  3. Do some changes if required.
  4. Click on the button Save.

Defining possible memberships

If you want to define possible memberships, do the following steps:

  1. Enter in the search field of the system settings “user.membership.config“.
  2. Open the Wizard for system settings via click on the title.
Note

Each membership has to own an unique name. The following format is required. [Name].[Attribute]=[Value]

The following configuration is a typical example:
“member1.extRef=reference”
“member1.orig=de”
“member1.de=Innerer Kreis”
“member1.en=Inner Circle”
“member1.active=true”
The attribute extRef is mandatory and represents the external ID for accessing the membership.
The attribute orig is mandatory and represents the language code, which is being used as fallback.

[Language code] is mandatory if orig and respresents the graphical user interface in  each language that is displayed wherever memberships are dealt with.
The attribute active is on default true, this means the membership can be used. If a membership has been set to inactive, no settings can be changed (e.g. prices adjusted, users added). Moreover, the membership is not displayed in the user area or used for new price calculations. However, if a user has already calculated a price, it is retained if it is the most favorable for him/her, even if the membership has been set to inactive in the meantime.

Note

If a configuration isn’t complete, it is inactive and not usable.

3. Click on the button Save.

Configuring the billing data sets

To  define the options for the billing data sets, do the following steps:

  1. Enter in the search field of the system settings “seminar.billing”.
    Note

    The value “jms.billing.deregistered” is transferred into the value “billingForCancelByTutor” and the value “jms.billing.deregistered.tutor.multiplier” is transferred into the value “billingForCancelByTutorMultiplier”. Further informationen you find here.

  2. Open the Wizard for system settings via click on the title.
  3. If also for absent participants should be created billing data sets on closing the event date, set the value “billingForNoShow” to true. It is set to “false” by default.
  4. If also for deregistered participants with demand rate  should be created billing data sets on closing the event date, set the value “billingForCancelByTutor” to “true”.
  5. To define the standard multiplier for how much a participant has to pay, if he/she was deregistered, enter the portion in percentage for the value “billingForCancelByTutorMultiplier”. Example:”0,23″.
  6. Click on the button Save.

Defining the interval between the starting and end time of a blocker

To define the interval between the starting and end time of a blocker for preselecting the blocker on the same day, do the following steps:

  1. Enter in the search field of the system settings “calendar.default.entry.timespan“.
  2. Open the Wizard for system settings via click on the title.
    There are defined the following values per default as standard interval between the starting and end time of a calendar entry in minutes:
    – Day view: “day=60” (=1 h)
    – Weekly and monthly view: “month.week=1440” (=24 h)
  3. Change the values if applicable.
  4. Click on the button Save.

Gamification

Adjusting the level structure of gamification

To adjust the level structure of gamification (for example limits or text) , do the following steps:

  1. Enter in the search field of the system settings “gamification.configuration“.
  2. Open the Wizard for system settings via click on the title.
  3. To define the limits of the appropriate point level, enter after level= for example 25;50;100;250;500;1,000;2,000;5,000;10,000. The first number corresponds to the number of points, when level 2 starts (25 points). The second number corresponds to the number of points, when level 3 starts (50 points) and so on. There are nine levels in the standard configuration.
  4. To define the identifier, take the suffix user.gamification.element.level.title and the number of the identifier. In the standard configuarition the first three levels have the identifier user.gamification.element.level.title1, level four to six have the identifier user.gamification.element.level.title2, level seven to nine have the identifier user.gamification.element.level.title3. This corresponds to the definition title=1;1;1;2;2;2;3;3;3.
  5. If you adust text, this have to be defined in the bundles.xml, too.
  6. Click on the button Save.

Resources

ICAL

If you want to do system settings regarding the ICAL mailing, do the following steps:

  1. Enter “mail.configuration” in the search field.
  2. Open the Wizard for system settings via click on the title.
  3. If you want to send meeting requests, set the value “avendoo.mail.ical.mode” to default.
    The standard setting is default. E-mails, which can do ICAL, get the ICAL file attached at first position and the specific ICAL header are set.
    Please note the following table regarding mail type and description:
Mail typeMail description
4Event – reminder
13Event – reminder waiting list
15Event – deregistration waiting list
2Event – manual deregistration
3Event – automatic deregistration
16Event – automatic deregistration waiting list
1Event – invitation e-mail
12Event – confirmation registration waiting list
9Event – confirmation registration
4. If you want to send an e-mail with ICAL file, set the value “avendoo.mail.ical.mode” to file.
E-mails, which can do ICAL, get only the ICAL file attached and the specific ICAL header aren’t set. The ICAL is only shown as attachment in Outlook.

5. If you want to send an e-mail without ICAL, set the value “avendoo.mail.ical.mode” to disabled.
E-mails, which can do ICAL, are sent without ICAL attachment and the specific ICAL header aren’t set.

6. Click on the button Save.

Room in the calendar entry

If you want that the room is mentioned in the calendar entry, do the following steps:

  1. Enter “mail.ical.room” in the search field.
  2. Open the Wizard for system settings via click on the title.
  3. Set the value to true.
  4. Click on the button Save.

Sending notifications for the whole event date group

If you want to send notifications systemwide always for the whole event date group, do the following steps:

  1. Enter “seminar.configuration” in the search field.
  2. Open the Wizard for system settings via click on the title.
  3. Enter “enableGroupMail=1”.
    Note

    The default has only effect, if a new event or a new event date without copying and without event date template (at which this is not configured) is created.

  4. Click on the button Save.

User management

Password function for users without e-mail address

If you want to use the password function for users without e-mail address, do the following steps:

  1. Enter in the search field of the system settings “password.reset.phone“.
  2. Open the Wizard for system settings via click on the title.
  3. To activate the function, set it to true (=1).  For deactivating set it to false (=0).
    Configure the parameters showPhone and requirePhone in the appropriate way.
  4. Click on the button Save.

Automatic adjustment of the corporate colors in the system

If you want to define the basic attributes of the SCSS system, do the following steps:

  1. Enter in the search field of the system settings “system.scss.global.variables”.
  2. Open the Wizard for system settings via click on the title.
  3. Enter the variables, which should be substituted, with default values, whereas you have to use the SCSS syntax: $[name]: [value];
  4. Click on the button Save.
    Notes
  • You define the URLs of the CSS files (regarding the basic path), which should be compiled, in the system setting “system.scss.global.urls”.
  • The author can overwrite the variables of the appropriate client in the Client wizard on the tab Interface.

Definition of the URLs of the CSS files to be compiled

To define the URLs of the CSS files, which should be compiled, do the following steps:

  1. Enter in the search field of the system settings “system.scss.global.urls“.
  2. Open the Wizard for system settings via click on the title.
  3. When entering the URLs, please note that you separate the URLs via entering a semicolon.
    Example: /l/media/[media_id]/zip/file/[filename_in_zip].css;
  4. Click on the button Save.

Reporting

Configuring the number and the minimum width of the filter columns in dynamic reports

If you want to configure the number and the minimum width of the filter columns, do the following steps:

  1. Enter in the search field of the system settings “dynamic.report.filter.columns” for the number of filter columns, open the Wizard for system settings via click on the title, set the appropriate value to “true” and click on the button Save.
  2. Enter in the search field of the system settings “dynamic.report.filter.columns.minWidth” for the minimum width of the filter colums,  open the Wizard for system settings via click on the title, set the appropriate value to “true” and click on the button Save.

If you have done this configurations, you avoid an incorrect filter display in the report.

Overall system settings

Defining the e-mail address for password inquiries

If you want to maintain the e-mail address for password inquiries and thus the phone contact, do the following steps:

  1. Enter in the search field of the system settings “system.property.password.reset.phone”.
  2. Open the Wizard for system settings via click on the title.
  3. Set the parameters “showPhone” und “requirePhone” to true.
  4. Enter behind the parameter “phoneResetMail=” the e-mail address, which should receive the password inquiries, for example “philwoodman@avendoo.de”.
  5. Click on the button Save.

Impressum on the login site

If you want to maintain the links of Imprint, Privacy and TOS, do the following steps:

  1. Enter in the search field of the system settings “userArea.imprint.xml”.
  2. Open the Wizard for system settings via click on the title.
  3. Enter for the language, for example English, the following text: ““.
  4. Enter the link (for example: “https:///www.avendoo.de/impressum”) in the next line by considering the following scheme: “Imprint“.
  5. Consider the same scheme for Privacy and TOS. Enter these in an extra line.
  6. Click on the button Save.

Storing the Android App version for the login site of the user

If you want to store the current Android App version for the login site of the user, do the following steps:

  1. Enter in the search field of the system settings “android.app.id”.
  2. Open the Wizard for system settings via click on the title.
  3. Enter for the current Android App version for example: “de.avendoo.app.cardea”.
  4. Click on the button Save.

Storing the Apple App version for the login site of the user

If you want to store the current Apple App version for the login site of the user, do the following steps:

  1. Enter in the search field of the system settings “apple.app.id”.
  2. Open the Wizard for system settings via click on the title.
  3. Enter for the current Apple App version for example: “1506596140”.
  4. Click on the button Save.

Registering several users on the same mobile device regarding the Avendoo® App

If you want to use the function of Apple and Android to use several users on the same mobile device, do the following steps:

  1. Enter in the search field of the system settings “app.v2.config”.
  2. Open the Wizard for system settings via click on the title.
  3. Note by defining that {
    “isMultiuser”:true
    }
    is expected for the multiuser being active.
    Important

    If you change from multiuser to no multiuser, the users remain logged in, until a new registration process on the appropriate mobile device for an not until used combination of user and mobile device has been completed. This process will remove the data of the other users again.

  4. Click on the button Save.

Routing the login site of Avendoo (R) directly to SSO login site

If you want to route the login site of Avendoo® directly to the SSO login site, do the following steps:

  1. Enter in the search field of the system settings “system.index.login”.
  2. Open the Wizard for system settings via click on the title. “system.index.login” defines the path for the Index.jsp. Default value is “l/index”.
  3. To use SSO as standard, you have to change the value to “l/samlLogin”.
  4. Click on the button Save.

Changing the favicon

If you want to change the favicon, do the following steps:

  1. Enter in the search field of the system settings “system.favicon”.
  2. Open the Wizard for system settings via click on the title.
  3. Enter the path with the media ID (from global media; logo has be uploaded in the .ico format) for your individual favicon.
  4. Click on the button Save.

Adjusting text on the user interface of Avendoo(R)

Only for experienced users

If you want to adjust text on the interface of Avendoo®, do the following steps:

  1. Enter in the search field of the system settings “changed.bundles.xml”.
  2. Open the Wizard for system settings via click on the title. The file is structured in the following way for example:
    In this example the title of the page is changed, whereupon the code before the equals sign represents the bundle name and the text after the equals sign represents the new text, which overwrites the standard text.
global.appTitle=Avendoo® Lernwelt user.global.explanation.learnplace.title=Mein Lernplatz global.appTitle=Avendoo® world of learning user.global.explanation.learnplace.title=My learning place

To determine the bundle name, there are two ways:

  1. via the view of the world of learning with the bundle link:  ui/index?bundleKey=true#/start => example in the frontend system: https://erlebe.avendoo.de/ui/index?bundleKey=true/index#/start
    The link in the content area (for example course) is different: Here you have to suffix the supplement at the end of the domain: https://erlebe.avendoo.de/c/course?bundleKey=true.
    Notes

    1. The function “bundleKey=true” is not available everywhere.
    2. You can change the address line only in a new tab, but you can’t change it in pop up windows.

  2. via the search of text in the appropriate bundle file
    Each text in Avendoo® is stored in the bundle file. You can search the appropriate text in this file and then you can copy the adequate bundle into the system setting and then substitute it. Please contact your Avendoo® project manager for requesting the current bundle file.
    The text adjustments shouldn’t be done in this file, but separately! You can edit this file with the program  Notepad++.

For each text change you have to create an own line the system settings in Avendoo®. Here you have to insert only the changed text.

Note

Only changed bundles should be in your own file and not the whole list of all bundles. Thus you should only enter changed bundles in the system.

Configuring Push messages to other systems

The Avendoo® Push Interface is used for notifying a configured ActiveMQ server about certain occurrences. You can’t configure about which occurrences it will be notified. To send message to the Active MQ server, Avendoo® uses the Java Message Service API. The messages are formatted in XML and are sent at the following beginnings (occurrences):

  • If a user is registered to an event by an author (registration to event).
  • If a user is added to the waiting list of an event by an author (adding to the waiting list of an event).
  • If a user is deregistered from an event by an author (deregistration from event).
  • If a author saves the attendance list and the event date is closed (Billings).
  • If a user passes a course and receives a certification (Successes).
  • If a course activation with runs was deleted.

Example: structure of the message for registrating to the event:
Header
– sender: „avendoo“
– method: „create“
– correlationId: unambigous identifier of the message
– objectType: „datebooking“
– key: seminarbookingId-userId

Body
– userId
– externalReference
– externalReferenceType
– extChangedBy
– registerComment
– extUserId
– extDealerId
– extToolId
– approvalMode
– approvalStatus
– seminarEventStatus
– event
– id
– externalReference
– externalReferenceType
– seminar
– id
– externalReference
– externalReferenceType

Via the following system settings you can configure the Avendoo® Push Interface:

    1. Enter in the search field of the system settings „jms.enabled“.
    2. Open theWizard for system settings via click on the title.
    3. To send notifications and to mark them as sent, set the value to “true”.
      To do not generate the notifications and do not send them, set the value to “false” (default).
      To generate and pause notifications, this means not to send them, set the value to “pause”.
    4. Click on the button Save.
  1. jms.broker.url
    1. Enter in the search field of the system settings „jms.broker.url“.
    2. Open the Wizard for system settings via click on the title.
    3. Enter the URL of the ActiveMQ server.
    4. Click on the button Save.
  2. jms.sender.queue.courseassignment
    1. Enter in the search field of the system settings „jms.sender.queue.courseassignment“.
    2. Open the  Wizard for system settings via click on the title.
    3. Enter the name of the queue, in which the messages for the course activations should be written.
    4. Click on the button Save.
  3. jms.password
    1. Enter in the search field of the system settings „jms.password“.
    2. Open the Wizard for system settings via click on the title.
    3. Enter the password of the server for authentification.
    4. Click on the button Save.
  4. jms.critical.value
    1. Enter in the search field of the system settings „jms.critical.value“.
    2. Open the Wizard for system settings via click on the title.
    3. Enter the maximum value of the not edited data sets. If exceeding the critical value the error controls reports possible errors.
    4. Click on the button Save.
  5. jms.billing.deregistered is transferred into billingForCancelByTutor as parameter. Further informationen you find here.
  6. jms.billing.deregistered.tutor.multiplier is transferred into billingForCancelByTutorMultiplier as parameter. Further informationen you find here.
  7. jms.sender.queue.achievementcertificate
    1. Enter in the search field of the system settings „jms.sender.queue.achievementcertificate“.
    2. Open the Wizard for system settings via click on the title.
    3. Enter the name of the queue, in which the messages for achieving the training inventory for certifications should be written.
    4. Click on the button Save.
  8. jms.sender.queue.billing
    1. Enter in the search field of the system settings „jms.sender.queue.billing“.
    2. Open the Wizard for system settings via click on the title.
    3. Enter the name of the queue, in which the messages for billing should be written.
    4. Click on the button Save.
  9. jms.sender.queue.inning
    Note

    Note that only exclusive runs are considered for communication with the JMS connector.
    Further information you find  here.

    1. Enter in the search field of the system settings „jms.sender.queue.inning“.
    2. Open the Wizard for system settings via click on the title.
    3. To deactivate the JMS messages regarding runs, for example the notification if a course activation with runs was deleted, change the value correspondently.
    4. Click on the button Save.
  10.  jms.sender.queue.datebooking
    1. Enter in the search field of the system settings „jms.sender.queue.datebooking“.
    2. Open the Wizard for system settings via click on the title.
    3. Enter the name of the queue, in which the messages for the event date bookings should be written.
    4. Click on the button Save.
  11. jms.username
    1. Enter in the search field of the system settings „jms.username“.
    2. Open the Wizard for system settings via click on the title.
    3. Enter the user name for authentification.
    4. Click on the button Save.
  12. jms.warning.value
    1. Enter in the search field of the system settings „jms.warning.value“.
    2. Open the Wizard for system settings via click on the title.
    3. Enter the maximum value, at which someone is notfied if there are not edited data sets.
    4. Click on the button Save.

Configuring SSO via the HTTP header

To configure SSO via the HTTP header and not via the URL parameter, do the following steps:

  1. Enter in the search field of the system settings “saml.global.configuration“.
  2. Open the Wizard for system settings via click on the title.
  3. Enter in the field Edit characteristic one of the following characters: “httpHeaderSsoSelection=”
  4. Click on the button Save. Now is the IDP selection of SSO via the HTTP header activated.

Configuring JSON web token with SSO for authors and users

To configure JSON web token with SSO for users and authors , do the following steps:

  1. Enter in the search field of the system settings “jwt.configuration“.
  2. Open the Wizard for system settings via click on the title.
  3. To configure claim.key.user.login (field,which is calculated from the JSON to identify the user), auto.login.token.lifetime (lifetime of the token in milliseconds) and public.key, contact our support team.
  4. Click on the button Save.

Activating JMS messages via Redirect

To activate the JMS Redirect for the JMS messages achievement, assignment, billing and/or inningBooking, do the following steps:

  1. Enter in the search field of the system settings “jms.redirect“.
  2. Open the Wizard for system settings via click on the title.
  3. To activate the appropriate type, set it true (format: typename.identifier=value; e.g. achievement.active=true)
  4. Define your endpoint and configure the system property in that way that the favored data with the favored authentication is used (uses the same format as mentioned in 3, but different descriptions and values; detailed description and values are described in the system property).
  5. If you want to use the authentification variant „mTLS“ for the redirect webservice, define the identifier „mTLSCertificateId“. Prerequisite for this is the administrative right Certificate administrator of an author, with which the author can create and edit p12 certificates.
  6. Click on the button Save.

Defining the timeout when a session is opened by an author API call

To define the timeout of a session opened by an author API call in seconds , do the following steps:

  1. Enter in the search field of the system settings “api.session.timeout“.
  2. Open the Wizard for system settings via click on the title.
  3. Enter the timeout in seconds, for example “60”. If you enter “0”, the session opened by the API call will not be rejected.
  4. Click on the button Save.

Configuring the queues and their corresponding values of the function ActiveMQ

To define the queues and their corresponding values of the function “ActiveMQ” , do the following steps:

  1. Enter in the search field of the system settings “activemq.queues.values“.
  2. Open the Wizard for system settings via click on the title.
  3. Enter the name of the queue per queue and per line, its limit for “warning” and its limit for “critical”.
    Example: “ROOM_BOOKING_QUEUE=1;5”
  4. Click on the button Save.

Configuring IDD error control on transfer

To control IDD errors on transfer (IDD is only relevant for Germany) , do the following steps:

  1. Enter in the search field of the system settings “idd.monitor.config“.
  2. Open the Wizard for system settings via click on the title.
  3. Enter the value, since how many days a transfer has to be failed to get listed (default:7). Then you enter a semicolon.
  4. Enter the value, how much failed transfers at maximum you expect (default:100). Then you enter a semicolon.
  5. Enter the vaule, on how many failed transfers the warning status should be valid (default:1). Then enter a semicolon.
  6. Enter the value, on how many failed transfers the critical status should be valid (default:20).
  7. Click on the button Save.

Cross-list synchronization of filters

To synchronize filter via cross-list, do the following steps:

  1. Enter in the search field of the system settings “ob3.filter.link”.
  2. Open the Wizard for system settings via click on the title.
  3. You can decide between three assignments: You can assign direct columns (highest priority), define an OB3 assignment (medium priority) or you can define an ObjectType assignment (lowest priority).
    Note

    You can only synchronize filters, which are from the same filter type.

    1. Assign direct columns
      Example:”filterConfExample=38001.login, 38002.login, 135027.lastname”
      In this example three columns and their entries will be synchronized.
    2. Define an OB3 assignment
      Example: “ob3IdConfExample=38001, 38002, 135027”
      In this example all columnx from the OB3 are always synchronized. The same name of the filter in the OB3s is relevant.
    3. Define an ObjectType assignment
      Example: “ObjectTypeConfExample=40”
  4. Click on the button Save.

If you have any question, please contact our support team.

Substituting national flags

To substitute national flags in the appropriate areas in the author backend, do the following steps:

  1. Enter in the search field of the system settings “flag.image.locations”.
  2. Open the Wizard for system settings via click on the title.
    The list contains all paths of all national flag variants.
  3. Adjust the paths for the national flags, which should be shown, per line. Example: “de=/img/de15.png” und “de_off=/img/de15_off.png”
    Note

    Only the images and not the included texts will be substituted.

  4. Click on the button Save.

If you have any question about details, please contact our support team.

Sending and receiving mails via the MS Graph API

To send and receive mails via the MS Graph API alternative to SMTP and IMAP, do the following steps:

  1. Enter in the search field of the system settings “mail.configuration”.
  2. Open the Wizard for system settings via click on the title.
  3. Maintain the following properties (mandatory step):
    – avendoo.mail.msGraph.clientId,
    – avendoo.mail.msGraph.tenantId,
    – avendoo.mail.msGraph.clientSecret,
    – avendoo.mail.msGraph.id.eLearning (id.eLearning=Microsoft account, which is authorized to send mails),
    – avendoo.mail.msGraph.id.webmaster (id.webmaster=Microsoft account, which is authorized to send mails),
    – avendoo.mail.address.webmaster (e-mail address for the webmaster) and
    – avendoo.mail.address.elearningAdmin (e-mail address of the eLearning administrator).
    Note that avendoo.mail.address.alternative.webmaster and avendoo.mail.address.alternative.elearningAdmin should be emptied, if they were filled by previous configuration.
  4. Furthermore you can maintain the following optional properties/fields:
    – Id or name of the inbox: avendoo.mail.msGraph.inboxFolder=inbox
    – User Id for the MS User for internal actions like “Load” and “Delete Mail”: avendoo.mail.msGraph.id.internal= (ID of the webmaster),
    – User Id for MS User for sending mails with unknown address: avendoo.mail.msGraph.id.unknown= (ID of the webmaster),
    – avendoo.mail.address.name (Default: Avendoo Mail Agent),
    – avendoo.mail.bcc (Default: Zero),

    • avendoo.mail.postfix2.mailerdaemonAddress
    • avendoo.mail.postfix2.mailerdaemonSubject
    • avendoo.mail.postfix2.errorAttachment
    • avendoo.mail.postfix2.withOriginalMimeMessage
    • avendoo.mail.postfix2.mailerdaemonAddress

    – avendoo.mail.ical.mode (Default: default) and/or
    – avendoo.mail.delivery.maxerrors (Default: 5).

  5. Click on the button Save.

Further steps:
You have to configure an application, on which the rights are given, in the Active Directory. There are permissions for Mail.Send and Mail.ReadWrite. Also you can restrict the access on certain user data via an ApplicationAccessPolicy.

Notes

– An e-mail with attachment may not exceed 3MB.
– To use CC mails for invitations for example, you have to send mails via SMTP. It’s not possible, to send CC mails via iCAL per MS Graph API.

If you have any question about details, please contact our support team.

Providing tokens for IMAP authorization

To provide tokens for the IMAP authorization, do the following steps:

  1. Enter in the search field of the system settings “mail.configuration”.
  2. Open the Wizard for system settings via click on the title.
  3. Activate the authorization code flow in the system setting.
  4. Check, if the changes are saved and the data is correct.
  5. To execute the initial authorization, click on the button Start.
  6. Click on the button Save.

If you have any question about details, please contact our support team.

Defining a XSLT for the course interface

To adjust the XML (generated by Avendoo®) right before the answer for a better data work of the target systems, do the following steps:

  1. Enter in the search field of the system settings “xslt.transform.api.apiCourse”.
  2. Open the Wizard for system settings via click on the title.
  3. You define a XSLT in the field Edit properties for transforming the Api course object.
  4. Check, if the data is correct.
  5. Click on the button Save.

If you have any question about details, please contact our support team

Setting up IMAP connections

To set up IMAP connections, do the following steps:

  1. Enter in the search field of the system settings “mail.configuration”.
  2. Open the Wizard for system settings via click on the title.
  3. Maintain the required data for the configuration. Information about the configurations which are all optional, you find here.
    Important

    Note that you overwrite the standard configuration with you new entries.

  4. Click on the button Save.

If you have any question about details, please contact our support team.

Configuring the SCIM 2.0 interface

To configure the SCIM 2.0 interface, do the following steps:

  1. Enter in the search field of the system settings “scim.2.configuration”.
  2. Open the Wizard for system settings via click on the title.
  3. Maintain the options “userGroupID” (=ID of the client on which the users should be created), “deleteOption” (=operation which should be done when the user is deleted via SCIM; this is possible: Mark as deleted(0), Delete permanently(1), Anonymize(2, standard)) and “idpName” (=name of the Identity provider to which the user should be assigned to).
    Important

    Note that the SCIM API in Avendoo(R) is  not completely implemented. Thus this API isn’t fully functional.

  4. Click on the button Save.

If you have any question about details, please contact our support team

User frontend

Links in the footer of the login site

If you want to display links (title and URL) in the footer of the login site, do the following steps:

  1. Enter “userArea.imprint.xml” in the search field.
  2. Open the Wizard for system settings via click on the title.
  3. Do the appropriate changes.
  4. Click on the button Save.

Creating food requests by learners

To enable learners creating food requests on the self-registration, do the following steps:

  1. Enter in the search field of the system settings “seminar.configuration“.
  2. Open the Wizard for system settings via click on the title.
  3. Set the properties “seminarEnableUnsubscribeReason” and “enableNutritionNotes” to true.
  4. Click on the button Save.

Configuring a time lock

If you want to configure a time lock for selfregistration, do the following steps:

  1. Enter in the search field of the system settings “timeLock.config“.
  2. Open the Wizard for system settings via click on the title.
  3. Do the appropriate configurations of the parameters leewayescalatePunishmentsmallPunishTimebigPunishTime und reportAbuseCount.
  4. Click on the button Save.

Deactivating rating stars in the user frontend

If you want to deactivate the rating stars (course assessment) at Start, Leaning place and Catalog, do the following steps:

  1. Enter in the search field of the system settings “rating.showStars“.
  2. Open the Wizard for system settings via click on the title.
  3. To deactivate the rating stars at Start, Learning place and Catalog, enter the value false. The value true activates the rating stars.
  4. Click on the button Save.

Configuring Open ID Connect

To do configuration for Open ID Connect for registering external users in Avendoo®, do the following steps:

    1. Enter in the search field of the system settings “openidconnect.configuration”.
      Note

      GET and POST are supported for the third-party initiated login in the OpenID Connect Launch Flow and for the authentication request in the OpenID Connect Launch Flow.

    2. Open the Wizard for system settings via click on the title.
    3. a) If you select Manual, you have to enter all values in the text fields except, which are generally defined.
      b) If you select URL, the required data is given by defined setting URL. Thus the text fiels are filled corresponding to this.
      Enter the required data. The following tables are shown as help for deciding.
    4. You build new mappings via ” idpId.userAttribute[ Key ]= Path in the JWT Payload ” (except on “userAttributeDelimiter “) and you separate the path with “.” by standard (for example “user.adress”).
      Example for setting an e-mail mapping: “idpId.userAttribute[email]=user.email”

    Table of general values, at which there is a prefix, for example “ipid”.

Name Type Description Required
logout.redirect URL Defining an URL, which is used as redirect on logout of a user. If this value is given, the deregistering user is routed to the defined URL instead to the standard Avendoo® logout site. No
clientID text ID of the client in the authentification system Yes
clientSecret text Secret of the client in the authentification system Yes
issuer URL identifier for the server, to which the client sends authorization requests. Yes
kid text Key ID of the JWK keys. It is defined to use this key instead of the client ID in the ID token validation if needed. No
authorization.endpoint URL URL of the authorization endpoint Yes
token.endpoint URL Secret of the client in the authorization system Yes
userinfo.endpoint URL URL of the Userinfo endpoint. If it isn’ t defined, the userinfo is taken from the ID token. No
jwks.uri URI URI of the JWK set. It is used for decrypting the ID token. Yes
token.endpoint.auth.method text Authentification method for the token endpoint Only in the code flow
subject.type text Describes, how the Subject Identifier behaves. Possible values are  public and pairwise. Yes
response.type text The flow to be used. Only id_token, id_token token and code are supported. Yes
scope text The scope to be used. Until now only openid. Yes
id.token.signing.alg.value text The decrypting algorithym to be used, which should be used for decrypting the ID token (Example: “RS256”). Yes
reg.code text The name of the registration code created in Avendoo®-System. Defines OU, Division and others. Yes
permissionGroupWhitelist List of single texts A list of group identifiers. If the whitelist is activated, only users can be created or registered, if at minmum one of the groups in the groups claim in the ID token payload is existing on the whitelist. If the whitelist is active, but empty, it is impossible to register or create via this configuration. No
restrict.login Boolean (True/False) Activates the whitelist, if set to true. Otherwise the value is interpreted as false and the whitelist remains inactive. No
ignore.at.validation Boolean (True/False) If set to true, the acces token validation will be skipped. This can be necessary on SAP-Openid, but mainly should not be activated. No

Table regarding new mappings (optional):

Name Type Description
userAttributeDelimiter text Describes the delimiter which you should use instead of „.“
login text user name
IDPUserID Identity Provider User ID
email text e-mail
firstname text first name
lastname text last name
oe text organizational unit
company text company
street text street
postcode postal code
location text location
group text group
area text area
phone text phone number
phone_mobile text phone number of mobile device
field10 text defined field number 10
field11 text defined field number 11
field12 text defined field number 12
field13 text defined field number 13
field14 text defined field number 14
region text region
country text country
gender text gender supporting “m”, “n” and “f”
title text title
cost_center cost center
mobile_phone_private private phone number of mobile device
second_title text second title
external_reference external reference
external_reference_type external reference type
personnel_number personnel number

Table regarding old specific mappings (optional) which you already can use:

Name Type Description
attributeNameForIdpUserId text Takes the IDP-User-ID from this field instead from standard.
attributeNameForUniqueUsername text Takes the user name from this field instead from standard.
attributeNameForEmail text Takes the e-mail from this field instead from standard.
attributeNameForFullname text Takes the complete name from this field instead from standard.

Important

This attribute already has no counterpart in the new mapping.

attributeNameForFirstname text Takes the first name from this field instead from standard.
attributeNameForLastname text Takes the last name from this field instead from standard.
attributeNameForOe text Takes the OU from this field instead from the registration code.
attributeNameForArea text Takes the division from this field instead from the registration code.
attributeNameForGroup text Takes the group from this field instead from the registration code.
attributeNameForPermissionGroup text Takes the external reference for permission group from this field instead from standard (groups claim).

Important

This attribute already has no counterpart in the new mapping.

4. Click on the button Save.

Further information about authentification by Open ID Connect you find here.

Team leader cockpit

Hiding the start and end time of the learning inventory in the team leader cockpit

If you want to hide the start and end time of the learning inventory in the team leader frontend, do the following steps:

  1. Enter in the search field of the system settings “learningInventoryHideStartAndEndForTeamleader”.
  2. Open the Wizard for system settings via click on the title.
  3. Set the value to “1” (true).

Defining columns for the team leader cockpit

To define columns for the team leader cockpit in the standard, do the following steps:

  1. Enter in the search field of the system settings “cockpit.table.employeeslist.columnconfig.default” for configuring the columns on the tab Employees.
    1. Enter the appropriate character separated with a comma and without space in the field Edit characteristic. Example: 2,3,7 means that the following columns are shown: last name, e-mail and report. Description: 0=User name; 1= First name; 2=Last name; 3=E-mail; 4=OU; 5=Learning group; 6=Course activation and 7=report.
    2. Click on the button Save.
      Note

      If you’ve defined a column in the system setting “cockpit.table.employeeslist.columnconfig.default”, which is not defined in the system setting “cockpit.table.employeeslist.columnconfig.allowed”, then this column will not be shown on the tab Employees in the team leader cockpit.

  2. Enter in the search field of the system settings “cockpit.table.favoriteslist.columnconfig.default” for configuring the columns on the tab Favorites
    1. Enter the appropriate character separated with a comma and without space in the field Edit characteristic. Example: 18,20,22 means that the following columns are shown: report category, report and options. Description: 17=Favorite; 18=Report category; 19=Sub category; 20=Report; 21=Subscription and 22=Options.
    2. Click on the button Save.
  3. Enter in the search field of the system settings “cockpit.table.learngroupList.columnconfig.default” for configuring the columns on the tab Learning groups.
    1. Enter the appropriate character separated with a comma and without space in the field Edit characteristic. Example: 8,10,11 means that the following columns are shown: learning group, run and progress status. Description: 8=Learning group; 9=Course activation; 10=Run; 11=Progress status; 12=Learning assistance status and 13=Report.
    2. Click on the button Save.
  4. Enter in the search field of the system settings “cockpit.table.reportslist.columnconfig.default” for configuring the columns on the tab Reports.
    1. Enter the appropriate character separated with a comma and without space in the field Edit characteristic. Example: 14,16 means that the following columns are shown: report category and report. Description: 14=Report category; 15=Sub category and 16=Report.
    2. Click on the button Save.

Configuring available columns on the tab Employees in the team leader cockpit

If you want to make columns available on the tab Employees in the team leader cockpit, do the following steps:

  1. Enter in the search field of the system settings “cockpit.table.employeeslist.columnconfig.allowed“.
  2. Open the Wizard for system settings via click on the title.
  3. Enter in the field Edit characteristic the appropriate characters, separating them with a comma.
    0 = Username
    1 = First name
    2 = Last name
    3 = Email
    4 = OE
    5 = Learning group
    6 = Course activation
    7 = Report
    28 = Personnel No.
    27 = Overdue
    23 = IDD training completed
    24 = IDD training in progress
    25 = IDD training not yet begun
    35 = User status
  4. Click on the button Save. Now the display of the added columns is activated.

Configuring self-approval for team leaders

If you want to activate self-approval for team leaders, do the following steps:

  1. Enter in the search field of the system settings “teamleaderSelfApproval“.
  2. Open the Wizard for system settings via click on the title.
  3. Do the appropriate configurations. 1 represents activation of self-approval for team leaders. 0 represents deactivation of self-approval for team leaders. Default value is 1.
    The default of the system property “teamleaderSelfApproval” means that no approval requests have to be generated, if a team leader registrates to a course to approval or to an event to approval.
    If you set the value of the system property to Yes = 1, there are no Todos and mails generated on registration and deregistration. It doesn’t matter if another team leader is responsible for the same OU or if the team leader has a direct superior.
    If you set the value of the system property to No = 0, the team leader isn’t allowed to register to learning content to approval. The superior or a team leader with the same OU resposibility receives a Todo and an approval request via e-mail. Prerequisite is that the superior or team leader has approval rights.
  4. Click on the button Save.

User frontend and Team leader cockpit

Recording types of training inventory

If you want to define which types of training inventory should be allowed to record, do the following steps:

  1. Enter in the search field of the system settings “achievement.createtypes“.
  2. Open the Wizard for system settings via click on the title.
  3. Do the appropriate configurations. 22 stands for event, 24 for certificate, 40 for course, 61 for qualification and 84 for training plan.
  4. Click on the button Save.

Configuring the IDD status and data display in the user area and the team leader cockpit

To activate the display of the IDD status and the IDD data in the Frontend and to configure the IDD hours to be completed , do the following steps (IDD is only relevant for Germany):

  1. Enter in the search field of the system settings “insuranceDistributionDirective“.
  2. Open the Wizard for system settings via click on the title.
  3. To activate the display of the IDD data in the whole frontend, set iddEnabledFrontEnd to true.
  4. The limit of the IDD hours to be completed is set to 15 per default (regulated by law in Germany). If applicable you can change the limit.
  5. If applicable you maintain further IDD relevant characteristics.
  6. Click on the button Save.

Activating available event dates in My Calendar

To activate the event dates, which are available in the catalog, in My Calendar for individual frontends, do the following steps:

  1. Enter in the search field of the system settings “calendar.frontend.showPossibleEvents“.
  2. Open the Wizard for system settings via click on the title.
  3. To activate the available event dates in My Calendar, enter the value true. The value false deactivates the available event dates in My Calendar.
  4. Click on the button Save.

Defining MIME types in the Community

To give the MIME types to the author on the tab Options in the Client wizard for selecting and to activate these in the Community of the user and team leader area, do the following steps:

  1. Enter in the search field of the system settings “system.mime.types“.
  2. Open the Wizard for system settings via click on the title.
  3. Check this list and enter if needed the required data per line for the Mimetype mapping, for example „application/msword doc“ for Word documents or „application/pdf pdf“ for PDF documents.
  4. Click on the button Save.

Defining the manifest file for the Avendoo® PWA

To define a valid manifest file for the Avendoo® PWA, do the following steps:

  1. Enter in the search field of the system settings “pwa.manifest.config”.
  2. Open the Wizard for system settings via click on the title.
  3. Define the following parameters and their values like shown in the example. “src” (source) can also be a medium for use everywhere or any image accessible via URL. Note that the the values like shown in the example configuration of the default Avendoo® logo are freely selectable and you can add the icons in any way and that the icon URL can be any freely accessible URL.
    Important

    Each value has to exist and got one icon at minimum. Note that the icons got the corresponding size to the definition in the manifest.


    Note

    You need for Android mobile devices the following icon sizes (one size at minimum):
    – 72×72
    – 96×96
    – 128×128
    – 144×144
    – 152×152
    – 192×192
    – 384×384
    – 512×512
    You need for iOS mobile devices these two icon sizes at minimum:
    – 120×120 and
    – 180×180

{
     "name": "Avendoo",
     "short_name": "Avendoo",
     "theme_color": "#1976d2",
     "background_color": "#fafafa",
     "icons": [
          {
                 "src": "icon_152x152.png".
                 "sizes": "152x152",
                 "type": "image/png"
           }
     ]
}

4. Click on the button Save.

System activation of the Avendoo® PWA in the license

Note

You need a mobile license for using the Avendoo® PWA. To activate the system please contact our support team.

Displaying the language versions on the course tiles

To show users and team leaders the language versions of the course on the tiles, do the following steps:

  1. Enter in the search field of the system settings “system.global.css“.
  2. Open the Wizard for system settings via click on the title.
  3. Enter the following data:
.cardBottomInformation.cardLanguage {
      display: flex;
}

.cardBottomInformation.cardRating {
      display: none;
}

4. Click on the button Save.

Note

The order of language versions shown on the course tiles is defined by the order in the system setting „system.languages.available”.

For further information relating the mentioned functions you can call our support and project team  +49 5251 698899-6