Auto-count Active Users Plugin Configuration

Auto-count Active Users Plugin Configuration

1 Overview

Auto-count Active Users component is used to calculate automatically the number of active users. A user is considered as an active user only when he/she often adds topic/post in Forum and his/her last post date satisfies with the interval time that is predefined.

For example, after 15 days if one user does not have any new post, he/she is not considered as an active user.

When Job Schedule Service runs, it will get values which are returned from Auto-count Active Users plugin component to identify the number of active users. This value is updated at Active Members information when viewing Forum statistics.

2 Configuration

The properties of Auto-count Active Users plugin is configured in ks-plugins-configuration.xml file.

In details:

At Job Schedule Service runtime, Auto-count Active Users plugin component is called, then ks-plugins-configuration.xml file is executed, the component-plugin named RecountActiveUserJob will be referred to org.exoplatform.forum.service.conf.RecountActiveUserPeriodJob to calculate number active users.

<component-plugin>
      <name>RecountActiveUserJob</name>
      <set-method>addPeriodJob</set-method>
      <type>org.exoplatform.forum.service.conf.RecountActiveUserPeriodJob</type>
      <description>add a RecountActiveUser job to the JobSchedulerService</description>
      <init-params>
        <properties-param>
          <name>job.info</name>
          <description>save the monitor data  periodically</description>
          <property name="jobName" value="RecountActiveUserJob"/>
          <property name="groupName" value="KnowlegedSuite"/>
          <property name="job" value="org.exoplatform.forum.service.conf.RecountActiveUserJob"/>
          <property name="repeatCount" value="0"/>
          <property name="period" value="7200000"/> <!-- 2 hours-->    
          <property name="startTime" value="+0"/>
          <property name="endTime" value=""/>               
        </properties-param>
        <properties-param>
          <name>RecountActiveUser.info</name>
          <description></description>
          <property name="lastPost" value="15"/> <!-- users are active if have last posts in 15 day -->
        </properties-param>
      </init-params>
    </component-plugin>

The properties for Auto-count Active Members plugin are defined in property tag like below:

...
          <property name="jobName" value="RecountActiveUserJob"/>
          <property name="groupName" value="KnowlegedSuite"/>
          <property name="job" value="org.exoplatform.forum.service.conf.RecountActiveUserJob"/>
          <property name="repeatCount" value="0"/>
          <property name="period" value="7200000"/> <!-- 2 hours-->    
          <property name="startTime" value="+0"/>
          <property name="endTime" value=""/>     
...
         <property name="lastPost" value="15"/> 
 ...

In which:

With start and end time, you can give a specific date in format:yyyy-mm-dd HH:mm:ss.sss to define the start and end time for RecountActiveUserJob .

Besides, active time information is also defined:

By default, the default properties can only be changed by editing its value in ks-plugins-configuration.xml file.

At the runtime, the new changes in ks-plugins-configuration.xml file will be executed and updated, Auto-count Active Users plugin will be executed depending on its properties.