Verified Commit 3cfe79ab authored by dockx thibault's avatar dockx thibault
Browse files

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

Enhance plugin supann backend configuration p7
Showing with 41 additions and 26 deletions
+41 -26
......@@ -37,6 +37,9 @@ Configure SupAnn Options
4. The SupAnn configuration menu will appear:
.. image:: images/supann-configuration-menu_1.png
:alt: SupAnn configuration menu in FusionDirectory
- **SupAnn RDN**: Defines the branch where SupAnn structures will be stored (**required**).
- **SupAnn Mail for Recovery**: Enables password recovery using email addresses from the personal mail field in a SupAnn account.
- **Show mailForwardingAddress Field**: Displays the **mailForwardingAddress** attribute, making it available and editable in individual user configurations.
......@@ -45,12 +48,14 @@ Configure SupAnn Options
- **Custom supannAdressePostalePrivee Types**: Permits the definition of a **Type** and a **Label** for private postal addresses, ensuring compliance with SupAnn guidelines.
- **SupAnn Civilité**: Expands available titles beyond "M." and "Mme." to provide greater inclusivity, following SupAnn recommendations.
.. image:: images/supann-configuration-menu_1.png
:alt: SupAnn configuration menu in FusionDirectory
Configure SupAnn Resources
--------------------------
**Overview of Supann Resources configuration section**
.. image:: images/supann-configuration-menu_2.png
:alt: SupAnn configuration menu in FusionDirectory
**In order to configure a new resource:**
1. Fill in the appropriate fields as shown below.
2. Click **Add**.
......@@ -67,11 +72,6 @@ Configure SupAnn Resources
- **Custom Labels**: Defines labels for custom substates.
**Overview of Supann Resources configuration section**
.. image:: images/supann-configuration-menu_2.png
:alt: SupAnn configuration menu in FusionDirectory
*Example: Adding a "Lost" Substate*
To add the substate **Perdu** (Lost) under the "Library" resource:
......@@ -82,38 +82,53 @@ To add the substate **Perdu** (Lost) under the "Library" resource:
Once all settings are configured, click **OK** at the bottom right.
Configure Supann Multiservice Card
Configure SupAnn Multiservice Card
----------------------------------
**Configuration Options**
The **Multiservice Card** settings allow configuration of various card-related parameters.
- **Card types**: Defines available card types and their labels. Prefix non-standard types with `{ORIGIN}`.
- **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.
**Overview:**
*Below is an overview:*
.. image:: images/supann-multiservice-card-settings_1.png
:alt: Multiservice Card settings in FusionDirectory
.. image:: images/supann-multiservice-card-settings_1.png
:alt: Multiservice Card settings in FusionDirectory
.. image:: images/supann-multiservice-card-settings_2.png
:alt: Multiservice Card settings continuation in FusionDirectory
.. image:: images/supann-multiservice-card-settings_2.png
:alt: Multiservice Card settings continuation in FusionDirectory
**Configuration Options:**
- **Card Types**: Defines available card types and their labels. Prefix non-standard types with `{ORIGIN}`.
- **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.
Configure SupAnn Consent
------------------------
The following configuration allows you to define **consent objects** and **consent types** within SupAnn.
The **Important Features** panel enables activation or deactivation of specific features displayed on the individual user configuration page.
.. image:: images/supann-configuration-menu_4.png
:alt: SupAnn configuration menu continuation in FusionDirectory
**Steps to Configure Consent:**
1. **Consent Object**: Add a new **Object** such as `"PNGPHOTO"` and specify its related **Label**. Click "Add".
2. **Consent Types**: Add a **Type** with its corresponding **Label** as shown in the example. Click "Add".
💡 **Important:** Click **"Apply"** or **"OK"** at the bottom right of the page to validate all new entries.
Configure SupAnn Features
-------------------------
.. image:: images/supann-configuration-menu_5.png
:alt: SupAnn configuration menu continuation in FusionDirectory
The **Important Features** panel allows activation or deactivation of specific features on the individual user configuration page.
By default, **SupAnn Status** is enabled, allowing accounts to have a designated status for resources linked to them.
The **Multiservice Card** and **FranceConnect** follow the same behavior, providing seamless integration.
*Default Enabled Features* :
You have the flexibility to enable or disable these SupAnn features based on your requirements.
- **SupAnn Status**: Assigns a designated status to accounts for linked resources.
- **Multiservice Card**: Ensures seamless card integration.
- **FranceConnect**: Facilitates authentication via FranceConnect.
.. image:: images/supann-configuration-menu_4.png
:alt: SupAnn configuration menu continuation in FusionDirectory
You may enable or disable these SupAnn features based on your requirements.
\ No newline at end of file
source/fusiondirectory/plugins/supann/images/supann-configuration-menu_1.png

26.8 KB | W: | H:

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

33.5 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

41.2 KB | W: | H:

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

50.4 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_4.png

35.2 KB | W: | H:

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

33.3 KB | W: | H:

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

6.5 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