RDBMS
======

.. note:: This feature required Enterprise Edition

You can synchronize user directories with a Relational Database Management
System(RDBMS). A Relational Database Management System (RDBMS) is a database
engine/system based on a relational model. Most modern commercial and
open-source database applications are relational in nature

#. Go to **Preferences** in the top panel
#. Go to **User Authentication > Data Synchronization** in the left Preferences
   panel
#. Click **Tasks > Create**
#. Find **General** section in main window
#. For **ID**, Enter name here
#. For **Update Interval**, Select the specified time or periodic interval for synchronization.
#. For **Policy Apply**, After synchronization, select ``Enabled`` to reflect the changes. If you have multiple sync settings, you can set it to ``Disabled`` and enable only the last sync.
#. For **Environment**, Input is not required for basic synchronization tasks. However, it is used when defining variable values to be commonly referenced within a separate custom shell script executed for integration with external systems.

   .. warning::
      **Configuration Caution**: Incorrect environment variable declarations can lead to malfunctions in the integration script or system errors. Before configuration, please ensure that the variables are correctly processed within the script.
   Usage Scenario: Log Level Control Used when you want to control simple operation options such as Log Level or Retry Count during external script execution.

   .. code-block:: bash

      export LOG_LEVEL='ERROR'  
#. For **Query**, Enter the SQL query to be executed immediately after information synchronization is complete. This is used when secondary processing is required based on specific conditions using the synchronized information.

   .. warning::
      **Risk of Data Loss**: This feature directly affects the database. In particular, the use of ``UPDATE`` or ``DELETE`` statements may result in **irreversible data loss**.
   Usage Scenario: Account Lock Processing based on Employment Status Used when you want to automatically disable the NAC account of resigned (or on-leave) employees according to the 'Employment Status' code after information synchronization.

   Prerequisites 1. Create a field to manage employment status (e.g., USER_CUSTOM08) in [Settings] > [Property Management] > [Custom Fields] > [User Custom Fields]. 2. Assign the user custom field created in step 1 to [Additional Info] under [User Information] in [Information Synchronization].

   Writing Example If the value of USER_CUSTOM08 is '001' (Resigned/On-leave, etc.), update USER_STATUS to '0' (Disabled).

   .. code-block:: sql

      UPDATE USER
      SET USER_STATUS = 0
      WHERE USER_CUSTOM08 = '001';
      
#. Find **Advanced > External DB** section in main window. Select **RDBMS**
#. Find **Advanced** > **User, Department, Job Title, Node, and LifeCycle
   Information** sections in main window. Add in information as needed.
#. Click **Tasks > Synchronize Now**