Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Setting the Number of Days to Retire Users

  1. Log in to OpenMRS.

  2. Set the global property(users.numberOfDaysToRetire ):

    Find global property

    users.numberOfDaysToRetire

    .Enter the desired number of days of inactivity after which users should be retired.

  3. Save the changes.

Running the Auto-Deactivating User Task

...

  1. Set up configuration details for the task:

    • Task config ID: A unique id

    • Name: Name of the task e.g. Auto Retire Users

    • Description: Short description of the task e.g. Retires all active users that are inactive for XX number of days specified by the value of the global property 'users.numberOfDaysToRetire'.

    • Class: Set schedulable_class to be org.openmrs.scheduler.tasks.AutoRetireUsersTask

    • Start Time: Set the desired start time.

    • Start Time Pattern: Determines the pattern of start time.

    • Repeat Interval: Set to desired repeat interval.

    • Start on Startup: Set to true if you want the schedule to start immediately after the application starts.

    • Started: Set to true to start the task.

    • Other properties: You can set other properties as desired (see example below)

  2. Save the configuration:

    1. Save the task configuration.

    2. The task will now be scheduled to run at the specified interval, automatically retiring inactive users based on the global property setting.

Example Database Changeset

Code Block
languagexml
<changeSet author="name (generated)" id="202405201900-1">
    <insert tableName="scheduler_task_config">
       <column name="task_config_id" valueNumeric="3"/>
       <column name="name" value="Auto Retire users"/>
       <column name="description" value="Retires all active users that are inactive for XX number of days specified by the value of the global property 'users.numberOfDaysToRetire'"/>
       <column name="schedulable_class" value="org.openmrs.scheduler.tasks.AutoRetireUsersTask"/>
       <column name="start_time" value="05/22/2024T23:59:59"/>
       <column name="start_time_pattern" value="MM/dd/yyyy HH:mm:ss"/>
       <column name="repeat_interval" valueNumeric="86400"/>
       <column name="start_on_startup" valueBoolean="true"/>
       <column name="started" valueBoolean="false"/>
       <column name="created_by" valueNumeric="1"/>
       <column name="date_created" value="2024-05-20T10:00:00"/>
       <column name="changed_by"/>
       <column name="date_changed"/>
       <column name="last_execution_time"/>
       <column name="uuid" value="02f598d9-e3bb-4f6f-94b6-182c6856413a"/>
    </insert>
</changeSet>

...

    1. .