diff --git a/entity/Usersettings_entity/Usersettings_entity.aod b/entity/Usersettings_entity/Usersettings_entity.aod index 969bd62d6e2eedf73772cbe1acb391e9836822d1..50b2150922a0e1a6f34abf485daf91a0e07abc95 100644 --- a/entity/Usersettings_entity/Usersettings_entity.aod +++ b/entity/Usersettings_entity/Usersettings_entity.aod @@ -2,6 +2,7 @@ <entity xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.3.14" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.14"> <name>Usersettings_entity</name> <majorModelMode>DISTRIBUTED</majorModelMode> + <documentation>%aditoprj%/entity/Usersettings_entity/documentation.adoc</documentation> <title>Settings</title> <grantDelete v="false" /> <afterUiInit>%aditoprj%/entity/Usersettings_entity/afterUiInit.js</afterUiInit> diff --git a/entity/Usersettings_entity/documentation.adoc b/entity/Usersettings_entity/documentation.adoc new file mode 100644 index 0000000000000000000000000000000000000000..5eb27c8972d266957edf45e9924c283553d49309 --- /dev/null +++ b/entity/Usersettings_entity/documentation.adoc @@ -0,0 +1,44 @@ += Usersettings_entity + + +== Overview + +=== Definition + +Entity to read, write and handle user settings. + + +=== Purpose + +Enables users to edit their own settings and change their password. + + +=== Particularities + +* The settings are stored in the table `ASYS_USERS` as key-value pairs and therefore direct access via DB container is not possible +* The read/write logic is implemented in the `UserSettings_lib` and will be accessed in the jDito Container +* The field `UID` exists to prevent errors but is not actually needed + + +== Related entities + +- + + +== Best Practice + +- + + +== FAQ + +[qanda] +How can I add more fields to the settings view?:: + You need to do the following: + + * Add a new field to this entity. The name must be the same as in the users data model/the settings table + * Add the field to `UsersettingsEdit_view` + * Add the name of the field to the arrays in `UserSettings_lib`. Most of them are located in the user objects `params` property => `paramSettings` + +Which setting fields are possible?:: + You can find out if you have a look at the return value of `tools.getCurrentUser()` \ No newline at end of file