Verified Commit 52822b94 authored by dockx thibault's avatar dockx thibault
Browse files

:rocket: feat(archive) add archive task documentation and client command

Showing with 136 additions and 0 deletions
+136 -0
Archive task execution
======================
.. _archive-task-execution-label:
Once the task is configured, execute it using the **orchestrator-client** tool. You have two execution options:
.. code-block:: bash
fusiondirectory-orchestrator-client --archive
.. note::
**Recommendation** automate this process within a CRON job.
.. note::
Add the ``--verbose`` flag to the command for detailed output during execution.
.. note::
The logs are stored by default at the following location:
``/var/log/orchestrator/orchestrator.log``
\ No newline at end of file
...@@ -10,3 +10,4 @@ Endpoints ...@@ -10,3 +10,4 @@ Endpoints
userreminder.rst userreminder.rst
audit.rst audit.rst
mails.rst mails.rst
archive.rst
\ No newline at end of file
...@@ -65,6 +65,13 @@ Execute a Task of Type "Audit" ...@@ -65,6 +65,13 @@ Execute a Task of Type "Audit"
fusiondirectory-orchestrator-client --audit fusiondirectory-orchestrator-client --audit
Execute a Task of Type "Archive"
""""""""""""""""""""""""""""""""
.. code-block:: shell
fusiondirectory-orchestrator-client --archive
.. note:: .. note::
The client can be used with the `--help` option to obtain more details about the available commands. The client can be used with the `--help` option to obtain more details about the available commands.
......
Archive Task
============
The **Archive** task is designed to streamline the management and archiving of user data. By leveraging the selected supann status, the task identifies matching statuses among the specified members and initiates the archiving process accordingly.
This ensures a seamless and automated approach to data archiving, tailored to your organizational needs.
.. NOTE::
It must be used with FusionDirectory Orchestrator and supann plugins must be installed.
Task Setup
----------
Creating the Task
-----------------
- Open the **Tasks** section in FusionDirectory
- Define the task’s schedule and repetition interval.
- (Optional) - Decide if the task should be directly executed.
.. image:: images/archive_t1.png
:alt: Archive - Task creation step 1
:width: 600px
Configuring Supann Plugin States (Optional)
-------------------------------------------
We recommend setting up a **custom substatus** within the **inactive status** in the configuration of Supann plugin states.
This custom substatus can help you better categorize and manage archived data.
Steps to configure:
1. Navigate to the **Supann Plugin States** configuration section in FusionDirectory configuration.
.. image:: images/archive_sup_t1.png
:alt: Archive - Configuration supann
:width: 150px
2. Locate the **Inactive** status and substatus configuration.
.. image:: images/archive_sup_t2.png
:alt: Archive - Configuration supann
:width: 600px
.. image:: images/archive_sup_t3.png
:alt: Archive - Configuration supann
:width: 600px
3. Add a new custom substatus, such as `toBeArchived`, to clearly identify data that has been archived.
.. image:: images/archive_sup_t3.png
:alt: Archive - Configuration supann
:width: 600px
4. (Optional) Apply a custom label to the substatus for easier identification and filtering, if required.
.. image:: images/archive_sup_t4.png
:alt: Archive - Configuration supann
:width: 600px
5. Save your changes.
Benefits of using a custom substatus:
- Improved clarity in data categorization.
- Easier tracking of archived records.
- Enhanced control over data lifecycle management.
.. NOTE::
Configuring a custom substatus is optional but highly recommended for better organization and management of archived data.
Configuring Archive Task
------------------------
- Go to the Tasks Archive tab.
- Select the desired supann state required to trigger the archiving process.
- Select your groups or individual members.
.. NOTE::
We strongly recommend the usage of dynamic groups.
- Click **Save**.
.. image:: images/archive_t2.png
:alt: Archive - Task creation step 2
:width: 600px
Task Execution
--------------
For your configured task to execute, you need to configure your fusiondirectory-orchestrator-client.
See :ref:`Archive Task Execution <archive-task-execution-label>`. for more information.
Summary
-------
The **Archive Task**, when configured as described, will:
- Automatically archive all data matching the selected supann status
- Ensure efficient data management and archiving
- Provide granular control over data lifecycle management
\ No newline at end of file
source/fusiondirectory/plugins/archive/images/archive_sup_t1.png

5.25 KB

source/fusiondirectory/plugins/archive/images/archive_sup_t2.png

11.5 KB

source/fusiondirectory/plugins/archive/images/archive_sup_t3.png

55.5 KB

source/fusiondirectory/plugins/archive/images/archive_sup_t4.png

23.4 KB

source/fusiondirectory/plugins/archive/images/archive_t1.png

29.8 KB

source/fusiondirectory/plugins/archive/images/archive_t2.png

35.3 KB

...@@ -10,3 +10,4 @@ FusionDirectory Plugin Archive ...@@ -10,3 +10,4 @@ FusionDirectory Plugin Archive
installation installation
configuration configuration
functionalities functionalities
archiveTask
\ No newline at end of file
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