Avendoo® online documentation

Clients

Clients act in Avendoo® as a classification system and as a distribution system of different visibilities and rights. To differ content client from user client allows a basic separation of the learning content from personal data of the learners as master data, learning progress or test results.

If you want to change the following access rights:

of the client, see for further information in chapter Category tree.

There are the mass processing functions Copy and Delete for clients. More information about these functions you find under Clients: Mass processing functions.

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

A distinction is drawn between three clients in Avendoo®:

User client
If you want to separate the personal data of the user groups (as in Reporting and Community) and the access to data from authors, you choose different clients for the users. Furthermore this option provides for simple handling of course activations and training plans plus appropiate design options.

Content client
If you want to separate multiple content developer teams for having an own content respository for each department, each team or each project for example, you choose different content clients. Furthermore you can configure different mail templates for events per content client.

Combination client
In this client you can create learning content as well as course activations and users in the same category structure. Therefore you use the same category structure. Basically we advise you not using combination clients as the separation of content and user data is not ensured.

If you have chosen the sub tab clients, you get a list of all created clients. On the left side you can filter for keywords to find a definite client faster. By clicking the name of a client the client wizard opens.

Avendoo® API

Experienced authors with appropriate HTML/CSS and JavaScript skills can use the  Avendoo® API (application programming interface) for the content of the event date table. So they can transfer certain parameters to an autonomous created design.

To create a new client, click on the button new client. The client wizard opens.

Master data

Client title

Enter a definite title for your new client.


Description

Enter the purpose or the content of the client for example.


External reference and reference type

Define an external reference and an external reference type for optimizing structure.


Basic properties

Define the basic properties. All checkboxes are set by default. If you deselect for example the checkboxes “Authors can be created” and “Course activations and users can be created”, you get an absolute content client.


Learning path as default presentation

Define the basic presentation of your learning path. Choose between the up-to-date design of the learning path (with or without status text), the presentation as a table, the presentation as a vertical learning path or the presentation as a learning path with line breaks.

Interface

Client logo

Choose a logo for your new client.


Template for the personal profile image

By uploading a file, you confirm that you are entitled to publish this image. Therefore click on the button Upload. Note that the image should be 210 x 210 pixels in size.


SCSS

Here you can overwrite the values for the SCSS variables from the system setting “global.system.scss.global.variables” for this client. If you haven’t defined variables in the system setting “global.system.scss.global.variables”, this will be shown.

Further information about the system setting “global.system.scss.global.variables” you find here.


CSS

If you have CSS skills, you can configure and change the interface of the user area via CSS programming.


FAQ information

There is the possibility that a FAQ area for the learning place of the users is displayed. Select the checkbox to activate the FAQ area and then define the favoured content per language. You can create and edit the content by using the editor.


Information

To display an own content in the user settings on the tab Informations, select the checkbox “Show additional information in the user settings” and create content per language via HTML/CSS. Thus you can point to the internal support team or you can provide other internal information for example.

The Avendoo® product information is displayed on the tab by default.

Messages

Note

If you create a new client, the notifications are selected on the appropriate message types per default

Notification in the event of a course registration

This notification is sent if a user is being registered for an active or closed course. You can select Do not send a notification or Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Notification upon a deregistration from a course

This notification is sent if a user is being deregistered for an course activation. You can select Do not send a notification or Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Approval for course activation registration

Stipulate which message is to be sent to the responsible person. You can select Do not send a notification or Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


New documents in course activation

Specify how participants are to be informed that there are new documents in the course activation. You can select Do not send a notification or Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Sending of invitation e-mail

Stipulate the e-mail content to be sent to participants. You can select Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Send registration confirmation

Stipulate the e-mail content to be sent to participants. You can select Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Sending of registration confirmation (waiting list)

The registration confirmation (waiting list) will be sent independent from the invitation and the automatic registration confirmation. Stipulate the e-mail content to be sent to participants. You can select Do not send a notification, Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Double opt-in

Stipulate the e-mail content to be sent to participants. You can select Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Hotel notifications regarding booking request

This notification informs the hotel about a booking request. It is sent prior to each change in the booking. You can select Do not send a notification or Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Room booking notification

This notification is sent to the room and specifies who will occupy it, where possible. You can select Do not send a notification or Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Notification regarding time obstacle

Stipulate how participants will be informed that the time obstacle in the course activation has been overcome. You can select Do not send a notification or Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Task notification – Created

This is a notification which is sent to the task owner as soon as the task is created.

You can select Do not send a notification or Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Task notification – Due date

This is a notification which is sent to the task owner as soon as the task is due.

You can select Do not send a notification or Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Task reminder (participants)

This is a notification which is sent to the participant before the specified task duration comes to an end.

You can select Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Task reminder (summary)

This is a notification which is sent to the recipient before his or her specified task duration comes to an end.

You can select Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Escalation (participants)

This is a notification which is sent to the participant after the specified task duration has come to an end.

You can select Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Escalation (summary)

This is a notification which is sent to the recipient after the specified task duration has come to an end.

You can select Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


Certification notifications

This notification is automatically sent by the system out at a preset time regarding a certificate. You can select Do not send a notification or Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.


IDD transmission error (only relevant in Germany)

This notification is sent to selected authors, if the IDD ID is unknown or inactive when the IDD times are sent to Gutberaten. You can select Do not send a notification or Send notification or you click on the button Select and select the appropriate individual notification. Then the source path of the individual notification will be shown. Further information about creating an individual notification you find here.

To define authors for notification, click on the button Add recipients and confirm your selection.


E-mail texts

In this section you find the standard templates of different e-mail texts. Under Message texts you find message texts regarding the topics Abo, Assessment, Certificate, Community, Course, Course assignment, Course blog, Course management, Essay question, Evaluation, Event, Forum, Knowledge test, Learning object, Login, NT account verification, Notification, Poll, Promotional action, Registration canceled, Tasks, Thank-you e-mail after the event and ePayment.

You can export these templates as CSV, upload new templates and edit existing e-mail texts.


Edit e-mail text

In this section you see the content of the appropiate e-mail template. The e-mail texts can be displayed in German, English, French and Italian. Furthermore you can edit these texts. For more information see Edit e-mail texts


Message texts (Community)

You can edit the following community message texts:

To do so, select an already created message text out of the selection field, select the appropiate language selection if applicable, change the title if applicable and edit the message text in the depicted editor.

Options

Required user data

Define if each user should have an e-mail address and if each user should have a cell phone number by selecting the appropiate checkboxes. If you have selected the checkboxes, these data of creating an user are required fields in this client.


Automatic team leader configuration
In this section you can assign the team leader configurations for superiors fully automatically. Superior is who is listed as superior in the user data of his or her employees. See Participant rules → Who is a superior? 

Note

Expired users are not considered in the automatic OU calculation. This means, the superior doesn’t see these users in his/her cockpit.

You can automatically assign the appropiate organisational entities (OEs) of the employees to the superiors. Following you can only add the organisational entities, but you cannot delete them. This applies for the team leader permissions, too. The permissions you assign for the superiors, you can only add in the author backend.

The depth of the permission you can define per system parameter updateTeamleaderForUser.maxDepth.


Composition of the OE of different fields

By selecting the checkbox “Enable” you define the number of the OE components and the delimiter for these fields. There is an advanced entry of entering the OE in user management.

If the OE is built up of a constant number of components, which are separated by a well-defined delimiter, you can configure it in this section.

You can make an advanced entry of the OE for users created in this client by entering each component separate in the user wizard.


Identity Provider ID

In this section you can enter for CSV user export to which identity provider the client’s users must pass authentification during single sign-on.


Community deep link

The so-called deep link is contained in a grouping mail for community messages. Select if the link leads to the community page or to the start page.


Pages in the user area

Define which pages are available in the user area:

  • Start page
  • Catalog page
    Note

    If you create a new client, the check mark Catalog page is not set.

  • Calendar page
  • Successes page
  • Setting page
  • Messenger page
  • Community page

Self-anonymization (Standard)

If you want to activate the self-anonymization (in the standard it is deactivated), select Activated. By this you define, if new users can anonymize themselves by standard. You can adjust the self-anonymization in the User wizard.

Users need access to the page Settings and see the function as Remove account.

Note

Only users with the login mechanism “Avendoo” and “Avendoo and SSO” can anonymize themselves.


Community settings

The community includes functions, which you can define for the whole client in detail.

Learners and authors can record and send private messages if you select the first checkbox. Furthermore you can configure the functions of the community for learners. You can activate and deactivate community messages, personal pin walls and community groups for learners. Also you can define the option if learners can create and manage community groups.


Restrictions on choice of recipients/participants

Define, which addresses from the address book are available for the user by selecting the following options:

Restrict users:

  • Users from the learner’s OE
  • Users from the learner’s region
  • Users from the learner’s area
  • Users from the learner’s group
  • Employees visible only to their superiors and superiors, only to their employees
  • Users who already had contact

Restrict authors:

  • all authors
Note

If you have chosen no restriction, you find all users of the same client in the address book.


Community update
 Define for new created users which functions are available for the community message by selecting the checkbox “Activate notification” (notification is a mail resuming unread messages).  This option is valid for authors, too. Then you define after how many days the users get a mail resuming unread community messages. Furthermore you can select the checkbox “Activate important messages” if you want to send important messages on short notice independent of the chosen message interval.


Languages available for users

You can select the visible language from all displayed languages for each client. Furthermore you can define a default language which is set for the client.


User profile

Define which user profiles are available in the user wizard.


Custom pages

Specify custom pages for certain areas. Under 404 you select your favored custom page for the Not-found-error-page. Under Course you select your favored custom page for the course. Under User area you select your favored custom page for the user area. You find further information about the custom page of the user area here.


Avendoo® layout

The layouts are a type of individual page that controls the appearance of Avendoo® in general and in certain areas.

A standard layout must always be selected, which you can change if applicable via the button Select. However, you can also select one or more several optional layouts via the button Add. If applicable you can remove these again. These optional layouts and the standard layout you can select in course activations.

You find further information about the custom page of the the Avendoo® layout here.


Catalog of settings

Define which views are available in the catalog and which view is displayed as standard (List, List with image or Titles). You select the standard view via radio button. This standard view is always available and thus you can’t deactivate the check mark. You can deactivate the availability or visibility of the other views by clicking the appropriate check mark.


Filter settings

Define if Avendoo® should display the catalog filter by selecting the checkbox “Filter activated”. Furthermore you can define which catalog filter are to be shown by selecting the appropiate checkbox. Define the order of the catalog filter by using drag and drop. You can select the following filters:

  • Title/teaser (set default on activating the filter/s)
  • Learning format
  • City
  • Suggested locations
  • At the latest, dates in
  • Time period
  • Status
  • Classification
  • Approval
  • Qualification
  • Language
  • Language for the event date
  • Minimum rating
  • Relevant to IDD
  • Content-Connector
  • Certificates

You select the standard view and visibility of the single views under Catalog of settings.


Start page – settings

Here you can define the displayed streams and their order for the user on the start page in the new frontend. Select by setting a check mark:

  • New releases
  • Continue the task
  • Event date booking
  • Hotel booking
  • Recommendations

Further information about defining individual streams you find here.


Certificate template for a manually generated training inventory
To choose a certificate template, click on the button Choose, select the appropriate certificate template and confirm with the button Select.

This selection is prerequisite that team leaders and user can enter certifications and training inventory entries in one step. Further information you find here.


User Content

Define, where the user content, which is created by the users of this client, should be saved. Therefore select the appropriate storage location under Content and Activations. Via click on the storage location and the button Delete selection you delete the selection.

Furthermore you have to select an author, which takes the content, when an user is deleted. Therefore click on the button Select besides Fall back author and confirm your selection. If needed you remove the fallback author via click on x.


Activated event date templates

Select the favored template for the course activation, course and event.

Regarding each new creation, there will be generated a copy of the objects.

If you change the templates, this is only valid on new activated event dates.

Further information about the Management of activated event dates you find here.

Further information about creating event dates for users under My content at the Learning place you find here.


Roles

On this tab you can add keywords and role to your client.

Keywords

You can enter and add keywords which can be assigned on this client to different questions. These keywords simplify searching for certain learning content and arrange objects topically together. Therefore you can choose questions with a certain keyword in knowledge tests for example.

Authors with specific rights can create keywords, too.

Note

You can add strings with maximum 255 characters as keyword.


Roles

Create roles for your new client by clicking New. A new window opens. Then you enter the description of the new role in your favoured languages. Later on you can assign the roles to the appropiate users in the user management. Typical roles are for example the coach for communication or the product manager. These roles can be a prerequisite for filling in an evaluation or feedbacks for example.

Classifications

If you have created classifications, they are available as classification filter in the browser area for the user. Likewise authors can filter the course activations of this client via classifications.

To add a classification, click on the button Add classification, set a check mark in front of the appropriate classification and confirm your selection by clicking on the button Select.
If you want the appropriate classification as mandatory selection in the Course activation and Training plan wizard, set the check mark Mandatory in the appropriate line of the added classification.
If applicable you can delete the added classification  via click on the recycle bin in the appropriate line. Note that all assignments to course activations and certificates are deleted, too.
Finally you click on the button Save.

The report “Course activations of a client” is available in the reporting. This report includes all course activations depending on the client with the classifications which are created in the client.

If you want to create or edit classifications or classification values, you can do this in the Classification wizard.

Texts/terms

On this tab you can make text adaptations for a certain client and a certain language.

Password policy

You can activate the password policy and you can define the password character categories and the password duration.

A password policy stands for a rule which generates passwords. Administrators and authors can define which password policy should apply.

You can activate the Password policy on clients. This is:

  • The new password may not match the already expired password.
  • The user name may not used as password. Exception is the Import user wizard.
  • An expiration time period can be set to update passwords constantly.
  • A password can basically consist of four different categories of characters (upper-case letters, lower-case letters, numbers and special characters).
  • The minimum length of the password for users and authors can be defined separately.

Further a generator for secure password was created.


Activate password policy

Select the checkbox “Activate” if you want to define that in this client the password policy is activated for users.


Password settings

Characters minimum length user
Enter the number of characters which the password for users should have minimum. It has to be a valuee between 4 and 255.

Characters minimum length authors
Enter the number of characters which the password for authors should have minimum. It has to be a value between 4 and 255.


Character categories

There are basically four character categories: upper-case letters, lower-case letters, numbers and special characters. Enter the number of character categories that the password must contain.


Duration and history

Expiration date in days
Enter the number of days after which the password has to be changed.

Hint: If you want that the password doesn’t expire after a while, enter “0”.

Password history
Enter the number of previous password that are not allowed to be reused.