Verified Commit 21079696 authored by dockx thibault's avatar dockx thibault
Browse files

:sparkles: Feat(User-manual) - enhance supann documentation

Enhance plugin supann backend configuration p1
Showing with 83 additions and 51 deletions
+83 -51
Configuration Configuration
============= =============
The SupAnn standard specifies how to fill cn attribute: https://services.renater.fr/documentation/supann/supann2018/recommandations2018/attributs/cn SupAnn standard (2020) documentation can be found `here <https://services.renater.fr/documentation/supann/supann2020/recommandations2020/index>`_.
Additionally, the SupAnn standard specifies how to fill the `cn` attribute: `SupAnn CN Attribute Documentation <https://services.renater.fr/documentation/supann/supann2018/recommandations2018/attributs/cn>`_.
You can modify how FusionDirectory renders the `CN` attribute by adjusting the **CN Pattern** in the configuration backend.
For more details, refer to :ref:`configuration_people_and_group_storage`.
Default CN Pattern
------------------
The default pattern is:
.. code-block:: text
%t[fr_FR]|sn% %t[fr_FR]|givenName%
This pattern determines how the `cn` attribute is structured within FusionDirectory.
You can change how FusionDirectory fill cn attribute by modifying CN Pattern by **%t[fr_FR]|sn% %t[fr_FR]|givenName%** in the configuration backend :ref:`configuration_people_and_group_storage`
Configure SupAnn Status Configure SupAnn Status
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
Click on Configuration icon on FusionDirectory main page To configure the SupAnn status in FusionDirectory, follow these steps:
1. Click on the **Configuration** icon on the FusionDirectory main page.
.. image:: images/supann-configuration-icon-main.png
:alt: Configuration icon in FusionDirectory
2. Navigate to the **SupAnn** tab.
.. image:: images/supann-configuration-icon-main.png .. image:: images/supann-tab.png
:alt: Picture of configuration icon in FusionDirectory :alt: SupAnn tab in FusionDirectory
Go to SupAnn tab 3. Click the **Edit** button at the bottom right.
.. image:: images/supann-tab.png .. image:: images/supann-edit-button.png
:alt: Picture of supann tab in FusionDirectory :alt: Edit button in FusionDirectory
Click on Edit button bottom right 4. The SupAnn configuration menu will appear:
.. image:: images/supann-edit-button.png .. image:: images/supann-configuration-menu_1.png
:alt: Picture of Edit button in FusionDirectory :alt: SupAnn configuration menu in FusionDirectory
.. image:: images/supann-configuration-menu_1.png - **SupAnn RDN**: Specifies the branch where SupAnn structures will be stored (required).
:alt: Picture of SupAnn configuration menu_1 in FusionDirectory - **SupAnn mail for recovery**: Allows password recovery using email addresses from the personal mail field in a SupAnn account.
- **Custom resources**: Defines custom resources and their labels.
.. image:: images/supann-configuration-menu_2.png .. image:: images/supann-configuration-menu_2.png
:alt: Picture of SupAnn configuration menu_2 in FusionDirectory :alt: SupAnn configuration menu continuation in FusionDirectory
* **SupAnn RDN** : branch in which SupAnn structures will be stored (required)
* **SupAnn mail for recovery** : allow the use of mail addresses from the personal mail address field from SupAnn account for password recovery
* **Custom resources** : custom resources and thei labels
For example : if you want to add a label resources for the library, fill-in the following fields as showned and click "add" **In order to configure a new resource**
1. Fill in the appropriate fields as shown below.
2. Click **Add**.
.. image:: images/supann-example-library.png .. image:: images/supann-example-library.png
:alt: Picture of example of resource label in FusionDirectory :alt: Example of resource label configuration in FusionDirectory
* **Substates** : allowed substates for an account. There are three substates type : Active, Inactive and Suspended
* **Custom labels** : labels for cutsom substates
For Example, you can add the ressource Library having substatus "Perdu", lost - **Substates**: Specifies the allowed substates for an account. There are three types:
- Active
- Inactive
- Suspended
- **Custom labels**: Defines labels for custom substates.
.. image:: images/supann-example-substatus.png #### Example: Adding a "Lost" Substate
:alt: Picture of example of substatus label in FusionDirectory
When you are done, click on OK button bottom right To add the substate **Perdu** (Lost) under the "Library" resource:
.. image:: images/supann-ok-button.png .. image:: images/supann-example-substatus.png
:alt: Picture of OK button in FusionDirectory :alt: Example of substatus label configuration in FusionDirectory
Now, in order to see if your settings have been correctly added to a user, go to user SupAnn status tab.
On **Resource** drop-down menu you have now a "Library" entry ### Finalizing the Configuration
On **Substatus** drop-down menu you have now a "Library" entry Once all settings are configured, click **OK** at the bottom right.
.. image:: images/supann-example-user-supann-status.png .. image:: images/supann-configuration-menu_3.png
:alt: Picture of supann status menu in FusionDirectory :alt: SupAnn configuration menu continuation in FusionDirectory
Configure Multiservice card - **SupAnn RDN**: Specifies the branch where SupAnn structures will be stored (required).
- **SupAnn mail for recovery**: Allows password recovery using email addresses from the personal mail field in a SupAnn account.
- **Custom resources**: Defines custom resources and their labels.
.. image:: images/supann-configuration-menu_4.png
:alt: SupAnn configuration menu continuation in FusionDirectory
---
Configure Multiservice Card
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
Here is the wiew of Multiservice Card settings to configure The **Multiservice Card** settings allow configuration of various card-related parameters. Below is an overview:
.. image:: images/supann-multiservice-card-settings_1.png .. image:: images/supann-multiservice-card-settings_1.png
:alt: Picture of Multiservice Card settings in FusionDirectory :alt: Multiservice Card settings in FusionDirectory
.. image:: images/supann-multiservice-card-settings_2.png .. image:: images/supann-multiservice-card-settings_2.png
:alt: Picture of Multiservice Card settings in FusionDirectory :alt: Multiservice Card settings continuation in FusionDirectory
* **Card types** : card types and their labels. Please, prefix with {ORIGIN} for non standard types ### Configuration Options
* **Card sources** : multi service card possible sources, with format system@domain
* **Card formats** : allowed formats for multiservice cards - **Card types**: Defines available card types and their labels. Prefix non-standard types with `{ORIGIN}`.
* **Card application domains** : domains for card applications - **Card sources**: Specifies possible sources for multiservice cards, using the format `system@domain`.
- **Card formats**: Lists allowed formats for multiservice cards.
- **Card application domains**: Defines the domains in which card applications are valid.
This concludes the configuration guide for SupAnn and Multiservice Cards in FusionDirectory.
source/fusiondirectory/plugins/supann/images/supann-configuration-menu_1.png

15.4 KB | W: | H:

source/fusiondirectory/plugins/supann/images/supann-configuration-menu_1.png

25.6 KB | W: | H:

source/fusiondirectory/plugins/supann/images/supann-configuration-menu_1.png
source/fusiondirectory/plugins/supann/images/supann-configuration-menu_1.png
source/fusiondirectory/plugins/supann/images/supann-configuration-menu_1.png
source/fusiondirectory/plugins/supann/images/supann-configuration-menu_1.png
  • 2-up
  • Swipe
  • Onion skin
source/fusiondirectory/plugins/supann/images/supann-configuration-menu_2.png

58.7 KB | W: | H:

source/fusiondirectory/plugins/supann/images/supann-configuration-menu_2.png

41.2 KB | W: | H:

source/fusiondirectory/plugins/supann/images/supann-configuration-menu_2.png
source/fusiondirectory/plugins/supann/images/supann-configuration-menu_2.png
source/fusiondirectory/plugins/supann/images/supann-configuration-menu_2.png
source/fusiondirectory/plugins/supann/images/supann-configuration-menu_2.png
  • 2-up
  • Swipe
  • Onion skin
source/fusiondirectory/plugins/supann/images/supann-configuration-menu_3.png

34.6 KB

source/fusiondirectory/plugins/supann/images/supann-configuration-menu_4.png

35.2 KB

source/fusiondirectory/plugins/supann/images/supann-example-user-supann-status.png

27.4 KB

Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment