h1. External Component Plugins {anchor:id=CSref.Configuration.ExternalComponentPlugins}
The following table describes the main functions of external component plugins:

|| Applications|| Components || Description ||
| *Calendar*| {{NewUserListener}} | Create default personal calendars. |
| | {{NewGroupListener}}| Create default group calendars. |
| | {{NewMembershipListener}} | Share calendars to members of a specific group. |
| | {{ReminderPeriodJob}}| Execute sending reminder emails to users. |
| | {{PopupReminderPeriodJob}} | Open a pop-up reminder on the browser of users. |
| | {{AddActionsPlugin}} | Enable the systems to automatically update the updated date of events/tasks in a calendar when contents of these events/tasks are changed. |
| *Chat* | {{HistoryPeriodJob}} | Save the chat history of users. |
| | {{RequestFilterComponentPlugin}} | Delete the session of a user when the browser is suddenly closed or the session is changed. |
| | {{AuthenticationLoginListener}}| Start the session and log in the chat server. |
| | {{AuthenticationLogoutListener}} | End the session and log out the chat server. |
| *Contact* | {{NewUserListener}} | Create personal contact data for users. |
| | {{NewMembershipListener}} | Create address book for a specific group. |
| | {{UpdateUserProfileListener}} | Update the personal profile of a user when it is changed on the portal. |
| *Content* | {{RSSContentPlugin}} | The formatter used to analyze the data from a RSS resource. |
| | {{DescriptionPlugin}} | Represent the data from a RSS resource. |
| *Mail* | {{AuthenticationLogoutListener}} | Stop checking mails of a user when he logs out. |
| *Social Intergration* | {{CalendarDataInitialize}} | Create a calendar for a group in a specific space. |
|  | {{ContactDataInitialize}} | Create an address book for a group in a specific space. |
|  | {{ContactSpaceActivityPublisher}} | Customize the activity status of a specific space when an event happens on an address book. |
|  | {{CalendarSpaceActivityPublisher}} | Customize the activity status of a specific space when an event happens on a calendar. |
|  | {{PortletPreferenceRequiredPlugin}} | Declare the application that will automatically create database. |



h2. Calendar Configuration {anchor:id=CSref.Configuration.CalendarConfiguration}

h3. NewUserListener {anchor:id=CSref.Configuration.Calendar.NewUserListener}

Each user can have a default personal calendar created. Use the NewUserListener to configure that. To use the plugin in the component configuration, you must use the target-component:

{code:xml}
<target-component>org.exoplatform.services.organization.OrganizationService</target-component>
{code}
The configuration is applied mainly in _extension/webapp/src/main/webapp/WEB-INF/cs-extension/cs/calendar/calendar-service-configuration.xml_.

{code:xml} 
<component-plugin>
  <name>calendar.new.user.event.listener</name>
  <set-method>addListenerPlugin</set-method>
  <type>org.exoplatform.calendar.service.impl.NewUserListener</type>
  <description>description</description>
  <init-params>
    <value-param>
      <name>defaultEventCategories</name>
      <value>Meeting,Calls,Clients,Holiday,Anniversary</value>
    </value-param>
    <value-param>
      <name>defaultCalendarCategory</name>
      <value>My group</value><!-- Single value -->
    </value-param>
    <value-param>
      <name>defaultCalendar</name>
      <value>Default</value>
    </value-param>
    <!--Params for default calendar setting -->
    <value-param>
      <name>viewType</name>
      <value>1</value>
    </value-param>

    <value-param>
      <name>timeInterval</name>
      <value>15</value><!-- in minutes -->
    </value-param>

    <value-param>
      <name>weekStartOn</name>
      <value>2</value>
    </value-param>

    <value-param>
      <name>dateFormat</name>
      <value>MM/dd/yyyy</value>
    </value-param>

    <value-param>
      <name>timeFormat</name>
      <value>HH:mm</value> <!-- HH:mm/hh:mm a -->
    </value-param>

    <value-param>
      <name>localeId</name>
      <value>BEL</value>
    </value-param>

    <value-param>
      <name>timezoneId</name>
      <value>Europe/Brussels</value>
    </value-param>

    <value-param>
      <name>baseUrlForRss</name>
      <value></value>
    </value-param>

    <value-param>
      <name>isShowWorkingTime</name>
      <value>false</value><!-- boolean true/false -->
    </value-param>

    <value-param>
      <name>workingTimeBegin</name>
      <value>08:00</value><!-- -->
    </value-param>

    <value-param>
      <name>workingTimeEnd</name>
      <value>18:00</value><!-- -->
    </value-param>

    <values-param>
      <name>ignoredUsers</name>
      <description>Definition users to ignore create default calendar</description>
      <!-- <value>demo</value> <value>marry</value> -->
    </values-param>
  </init-params>
</component-plugin>   
{code}

Details:

* *Name*: {{calendar.new.user.event.listener}} - The unique key to avoid duplicate names. Users can change it.
* *Set-method*: {{addListenerPlugin}} - The function is executed  at the target of the component to register NewUserListener.
* *Type*: {{org.exoplatform.calendar.service.impl.NewUserListener}} - The class is set up to execute the creation of database.
* *Description*: It is a plugin used to create default personal calendars.


See the details about the init-params of the component in the following table:

||Value-params||Possible value||Default value||Description||
|*defaultEventCategories*|{{ String (Comma separated list of category names)}}|{{Meeting,Calls,Clients,Holiday,Anniversary }}|Default event categories for users.|
|*defaultCalendarCategory*|{{String }}|{{Default }}|Name of the calendar group. |
|*viewType*|{{0-6 (see below) }}|{{1}}|Default view after user logs in and goes to the Calendar portlet.|
|*timeInterval*|{{integer in minutes}}|{{15}}|The time unit interval when you drag and move the event (in Day and Week views only).|
|*weekStartOn*|{{1-7 (see below) }}|{{2}}|Day to use as the beginning of the week. It only affects the Week view.|
|*dateFormat*|{{valid Java Date format }}|{{MM/dd/yyyy}}|The display format for dates.|
|*timeFormat*|{{ valid Java Date format}}|{{HH:mm }}|The display format for time. |
|*localeId*|{{valid locale ID}}|{{BEL}}|Id of the geographic locale. |
|*timezoneIds*|{{valid TimeZone id}}|{{Europe }}|User time zone. |
|*baseUrlForRss*|{{none }}|{{none}}|The URL to publish the RSS content. |
|*isShowWorkingTime*|{{true/false }}|{{false}}|Indicate if the working time should be highlighted in the Day view. |
|*workingTimeBegin*|{{time in timeFormat}}|{{08:00}}|The start time in working time. |
|*workingTimeEnd*|{{time in timeFormat}}|{{18:00}}|The end time in working time. |
|*ignoredUsers*|{{user id, use multiple by each line}}|{{demo/marry }}|Definition users to ignore creating the default calendar. |

The *viewType* parameter is encoded by a number as follow:

0 : Day view

1 : Week view

2 : Month view

3 : Year view

4 : List view

5 : Schedule view

6 : Working days view

The *weekStartOn* parameter is encoded as follow:

1 : Sunday

2 : Monday

3 : Tuesday

4 : Wednesday

5 : Thursday

6 : Friday

7 : Saturday

h3. NewGroupListener {anchor:id=CSref.Configuration.NewGroupListener}

To use the plugin in the component configuration, you must use the target-component:

{code:xml}
<target-component>org.exoplatform.services.organization.OrganizationService</target-component>
{code}

The configuration is applied mainly in _extension/webapp/src/main/webapp/WEB-INF/cs-extension/cs/calendar/calendar-service-configuration.xml_.

{code:xml}
<component-plugin>
  <name>calendar.new.group.event.listener</name>
  <set-method>addListenerPlugin</set-method>
  <type>org.exoplatform.calendar.service.impl.NewGroupListener</type>
  <description>description</description>
  <init-params>
    <value-param>
      <name>defaultEditPermission</name>
      <value>*.*</value><!-- Multi value membership, use coma (,) to split values -->
    </value-param>
    <value-param>
      <name>defaultViewPermission</name>
      <value>*.*</value>
    </value-param>
    <value-param>
      <name>defaultLocale</name>
      <value>BEL</value>
    </value-param>
    <value-param>
      <name>defaultTimeZone</name>
      <value>Europe/Brussels</value>
    </value-param>
    <values-param>
      <name>ignoredGroups</name>
      <description>Definition group to ignore create default calendar</description>
      <!-- <value>/platform/guests</value> -->
      <value>/spaces/*</value> <!-- single value, use more <value> tags to add more group -->
    </values-param>
  </init-params>
</component-plugin>
{code}

Details:

* *Name*: {{calendar.new.group.event.listener}} - The unique key to avoid duplicate names. Users can change it.
* *Set-method*: {{addListenerPlugin}} - The function is executed at the target of the component to register NewGroupListener.
* *Type*: {{org.exoplatform.calendar.service.impl.NewGroupListener}} - The class which is set up to execute the creation of database.
* *Description* - It is the plugin used to create default group calendars.

See the details about the init-params of the component in the following table:

||Value-params||Possible values||Default values||Description||
| *defaultEditPermission* |{{User id }} (Multi value membership, use coma (,) to split values) | {{*.* means that all members in that group can  modify and add, remove a calendar, events/tasks of the calendar}}|The default permission assigned to membership in a specific group to edit calendars and events/tasks of the calendar.|
| *defaultViewPermission* |{{ User id }} (Multi value membership, use coma (,) to split values) | {{*.* means that all members in that group can view this calendar and all the events/tasks of this calendar.}}|The default permission assigned to membership in a specific group to view a calendar and events /tasks of the calendar.|
| *defaultLocale* |{{Valid locade id}} | {{BEL (see more locale ids http://userpage.chemie.fu-berlin.de/diverse/doc/ISO_3166.html )}}|The default locale of the calendar.|
| *defaultTimeZone* |{{Valid timezone id}} | {{Europe/Brussels (see more for timeZone ids http://www.unicode.org/cldr/data/docs/design/formatting/zone_log.html#windows_ids)}}|The default time zone of the calendar.|
| *ignoredGroups* |{{ Group id (use line to define multiple value)}} | {{/platform/guests}}| Definition group to ignore create the default calendar.|


h3. NewMembershipListener {anchor:id=CSref.Configuration.NewGroup.NewMembershipListener}
To use the plugin in the component configuration, you must use the target-component:

{code:xml}
<target-component>org.exoplatform.services.organization.OrganizationService</target-component>
{code}

The configuration is applied mainly in 
_extension/webapp/src/main/webapp/WEB-INF/cs-extension/cs/calendar/calendar-service-configuration.xml_.

{code:xml}
<component-plugin>
  <name>calendar.new.membership.event.listener</name>
  <set-method>addListenerPlugin</set-method>
  <type>org.exoplatform.calendar.service.impl.NewMembershipListener</type>
  <description>description</description>
</component-plugin>     	
{code}

Details:

* *Name*: {{calendar.new.membership.event.listener}} - The unique key to avoid duplicate names. Users can change it.
* *Set-method*: {{addListenerPlugin}} - The function which is executed at the target of the component.
* *Type*: {{org.exoplatform.calendar.service.impl.NewMembershipListener}} - The class which is set up to execute the creation of database.
* *Description*: It is a plugin used to execute sending reminder emails to users.

h3. ReminderPeriodJob {anchor:id=CSref.Configuration.ReminderPeriodJob}
The Calendar application of eXo Collaboration can send event reminders by using the email reminder plugin configuration. You will probably need to adjust this configuration to meet your own needs. The feature is based on a periodic poll of the stored reminders.

You must use the following target component to use the plugin in this configuration:

{code:xml}
<target-component>org.exoplatform.services.scheduler.JobSchedulerService</target-component>
{code}

The configuration is applied in _extension/webapp/src/main/webapp/WEB-INF/cs-extension/cs/cs-configuration.xml_.

{code:Xml}
<component-plugin>
  <name>RecordsJob</name>
  <set-method>addPeriodJob</set-method>
  <type>org.exoplatform.calendar.service.ReminderPeriodJob</type>
  <description>add e-mail reminder job to the JobSchedulerService</description>
  <init-params>
    <properties-param>
      <name>job.info</name>
      <description>save the monitor data periodically</description>
      <property name="jobName" value="ReminderJob" />
      <property name="groupName" value="CollaborationSuite" />
      <property name="job" value="org.exoplatform.calendar.service.ReminderJob" />
      <property name="repeatCount" value="0" />
      <property name="period" value="180000" />
      <property name="startTime" value="+0" />
      <property name="endTime" value="" />
    </properties-param>
  </init-params>
</component-plugin>
{code}

Details:
* *Name*: {{RecordsJob}} - The name of a schedule job.
* *Set-method*: {{addPeriodJob}} - The plugin which registers the method.
* *Type*: {{org.exoplatform.calendar.service.ReminderPeriodJob}} - A class that executes to transfer data into database of Job Scheduler.
* *Description*: Add email reminder job to the JobSchedulerService.

See details about the init-params of the component in the following table:
|| Properties-param || Description || Property names || Description || Possible values || Default values ||
| *job.info* | Save the monitor data  periodically. | {{jobName}} | The name of job | {{String}} | {{ReminderJob}}|
| ** |  | {{groupName}} | The name of group job. | {{String}} | {{CollaborationSuite}} |
| ** |  | {{job}} | The name of actual job class. | {{Class path}} | {{org.exoplatform.calendar.service.ReminderJob}} |
| ** |  | {{repeatCount}} | How many times to run this job. | {{Long}} | {{0, ( use '0' which means 'run forever)}}  |
| ** |  | {{period}} | The time interval (millisecond) between job executions. | {{Long}} | {{180000}} |
| ** |  | {{startTime}} | The time when the job starts running. | {{Integer}} | {{+0}} |
| ** |  | {{endTime}} | The time when the job ends running. | {{Integer}} | {{none}} |


h3. PopupReminderPeriodJob {anchor:id=CSref.Configuration.PopupReminderPeriodJob}

You must use the following target component to use the plugin in this configuration:

{code:xml}
<target-component>org.exoplatform.services.scheduler.JobSchedulerService</target-component>
{code}

The configuration is applied in _extension/webapp/src/main/webapp/WEB-INF/cs-extension/cs/cs-configuration.xml_.

{code:xml}
<component-plugin>
  <name>PopupRecordsJob</name>
  <set-method>addPeriodJob</set-method>
  <type>org.exoplatform.calendar.service.PopupReminderPeriodJob</type>
  <description>add popup reminder job to the JobSchedulerService</description>
  <init-params>
    <properties-param>
      <name>job.info</name>
      <description>save the monitor data periodically</description>
      <property name="jobName" value="PopupReminderJob" />
      <property name="groupName" value="CollaborationSuite" />
      <property name="job" value="org.exoplatform.calendar.service.PopupReminderJob" />
      <property name="repeatCount" value="0" />
      <property name="period" value="6000" />
      <property name="startTime" value="+0" />
      <property name="endTime" value="" />
    </properties-param>
    <properties-param>
      <name>popupreminder.info</name>
      <description>save the monitor data periodically</description>
      <property name="portalName" value="portal" />
    </properties-param>
  </init-params>
</component-plugin>
{code}

Details:

* *Name*: {{PopupRecordsJob}} - The name of the job. 
* *Set-method*: {{addPeriodJob}} - The plugin registering method.
* *Type*: {{org.exoplatform.calendar.service.PopupReminderPeriodJob}} - The class which executes to transfer the data into database of Job Scheduler.
* *Description*: Add popup reminder job to the JobSchedulerService.

See details about the init-params of the component in the following table:

* Properties-param: *job.info*. This param saves the monitor data periodically and includes the following sub-params:

||Properties-param||Description||Property names||Description||Possible values||Default values||
|*job.info*|Save the monitor data periodically.|{{jobName}}|The name of job.|{{String}}|{{PopupReminderJob}}|
| | |{{groupName}}|The name of group job.|{{String}}|{{CollaborationSuite}}|
| | |{{job}}|The name of actual job class.|{{Class path}}|{{org.exoplatform.calendar.service.PopupReminderJob}}|
| | |{{repeatCount}}|How many times to run this job.|{{Long}}|{{0, ( use '0' which means 'run forever)}}|
| | |{{period}}|The time interval (millisecond) between job executions.|{{Long}}|{{6000}}|
| | |{{startTime}}|The time when the job starts running.|{{Long}}|{{+0}}|
| | |{{endTime}}|The time when the job ends running.|{{Integer}}|{{None}}|
|*popupreminder.info*|Save the monitor data periodically.|{{portalName}}|The name of the portal.|{{String}}|{{portal}}|‎‏

h2. AddActionsPlugin {anchor:id=CSref.Configuration.AddActionsPlugin}
The configuration of the AddActionsPlugin is found in _WEB-INF/cs-extension/cs/webservice/webservice-configuration.xml_.

It is used to register the listener named {{org.exoplatform.webservice.cs.LastUpdateAction}} and it is executed, basing on eventTypes.

{code:xml}
<component>
  <type>org.exoplatform.services.jcr.impl.ext.action.SessionActionCatalog</type>
  <component-plugins>
    <component-plugin>
      <name>Last Update Action</name>
      <set-method>addPlugin</set-method>
      <type>org.exoplatform.services.jcr.impl.ext.action.AddActionsPlugin</type>
      <description>add actions plugin</description>
      <init-params>
        <object-param>
          <name>actions</name>
          <object type="org.exoplatform.services.jcr.impl.ext.action.AddActionsPlugin$ActionsConfig">
            <field name="actions">
              <collection type="java.util.ArrayList">
                <value>
                  <object type="org.exoplatform.services.jcr.impl.ext.action.ActionConfiguration">
                    <field name="eventTypes">
                      <string>addNode,changeProperty</string>
                    </field>
                    <field name="nodeTypes">
                      <string>exo:calendarEvent</string>
                    </field>
                    <field name="actionClassName">
                      <string>org.exoplatform.webservice.cs.LastUpdateAction</string>
                    </field>
                  </object>
                </value>
              </collection>
            </field>
          </object>
        </object-param>
      </init-params>
    </component-plugin>
  </component-plugins>
</component>
{code}

* *object-param*: {{Actions}} - The name of the object.
* *object type*: {{org.exoplatform.services.jcr.impl.ext.action.AddActionsPlugin$ActionsConfig}} - A class used to register the following field names in the table below:

||Field name||String||Description||
| *eventTypes*| {{addNode,changeProperty}} | The type of the event. |
| *nodeTypes* | {{exo:calendarEvent}}| The type of the node. |
| *actionClassName* | {{org.exoplatform.webservice.cs.LastUpdateAction}} |The registration class to execute the actions that the plugin requires. |
 
h2. Chat Configuration {anchor:id=CSref.Configuration.ChatConfiguration}
The Chat Configuration is applied in _/extension/webapp/src/main/webapp/WEB-INF/cs-extension/cs/chat/chat-service-configuration.xml_.

{docbook}
<warning><para>
The Chat portlet and its services are deprecated. It remains fully supported for eXo customers, however it will not receive any enhancement and will be removed from the product scope in the future.
</para></warning>
{docbook}

h3. HistoryPeriodJob {anchor:id=CSref.Configuration.HistoryPeriodJob}

{code:xml}
<external-component-plugins>
  <target-component>org.exoplatform.services.scheduler.JobSchedulerService</target-component>
  <component-plugin>
    <name>ChatRecordsJob</name>
    <set-method>addPeriodJob</set-method>
    <type>org.exoplatform.services.xmpp.connection.impl.HistoryPeriodJob</type>
    <description>add chat messages from Openfire Server to History</description>
    <init-params>
      <properties-param>
        <name>job.info</name>
        <description>save the monitor data periodically</description>
        <property name="jobName" value="messageToHistoricalMessageJob" />
        <property name="groupName" value="CollaborationSuite" />
        <property name="job" value="org.exoplatform.services.xmpp.connection.impl.HistoryJob" />
        <property name="repeatCount" value="0" />
        <property name="period" value="3000" />
        <property name="startTime" value="+0" />
        <property name="endTime" value="" />
      </properties-param>
      <properties-param>
        <name>history.info</name>
        <description>save the monitor data periodically</description>
        <property name="logBatchSize" value="50" />
      </properties-param>
    </init-params>
  </component-plugin>
</external-component-plugins>
{code}

Details:

* *Name*: {{ChatRecordsJob}} - The name of the job.
* *Set-method*: {{addPeriodJob}} - The plugin which registers the method.
* *Type*: {{org.exoplatform.services.xmpp.connection.impl.HistoryPeriodJob}} - A class which executes to transfer the data into the database of Job Scheduler.
* *Description*: It is used to save chat messages from Openfire Server to History.

See details about the init-params of the component in the following table:

|| Properties-param || Description || Property names || Description || Possible values || Default values ||
| *job.info* | Save the monitor data  periodically. | {{jobName}} | The name of job. | {{String}} | {{messageToHistoricalMessageJob}}|
| ** |  | {{groupName}} | The name of group name. | {{String}} | {{CollaborationSuite}} |
| ** |  | {{job}} | The name of actual job class. | {{Class path}} | {{org.exoplatform.services.xmpp.connection.impl.HistoryJob}} |
| ** |  | {{repeatCount}} | How many times to run this job. | {{integer}} | {{0}} ( use '0' which means 'run forever) |
| ** |  | {{period}} | The time interval (millisecond) between job executions. | {{Long}} | {{3000}} |
| ** |  | {{startTime}} | The time the job starts running. | {{Long}} | {{+0}} |
| ** |  | {{endTime}} | The time the job ends running. | {{Long}} | {{none}} |
| *history.info* | Save the monitor data  periodically. | {{logBatchSize}} | The maximum number of messages in the cache are saved once the job runs. | {{Integer}} | {{50}} |


h3. RequestFilterComponentPlugin {anchor:id=CSref.Configuration.RequestFilterComponentPlugin}
{code:xml}
<external-component-plugins>
  <target-component>org.exoplatform.services.rest.impl.RequestHandlerImpl</target-component>
  <component-plugin>
    <name>ws.rs.request.filter</name>
    <set-method>addPlugin</set-method>
    <type>org.exoplatform.services.rest.impl.RequestFilterComponentPlugin</type>
    <init-params>
      <value-param>
        <name>RESTXMPPServiceFilter</name>
        <value>org.exoplatform.services.xmpp.rest.filter.RESTXMPPServiceFilter</value>
      </value-param>
    </init-params>
  </component-plugin>
</external-component-plugins>
{code}

Details:

* *Name*: {{ws.rs.request.filter}} - The name of the filter. 
* *Set-method*: {{addPlugin}} - The plugin which registers the method.
* *Type*: {{org.exoplatform.services.rest.impl.RequestFilterComponentPlugin}} - The class which executes the requests of the plugin.
* *Description*: It is used to delete the session of a user when he suddenly closes the browser or changes the session.

See details about the init-params of the component in the following table:

|| Value-param || Description || Possible value || Default value ||
| *RESTXMPPServiceFilter* | The name of the filter. | {{Class path}} | {{org.exoplatform.services.xmpp.rest.filter.RESTXMPPServiceFilter}}|

h3. AuthenticationLoginListener and AuthenticationLogoutListener {anchor:id=CSref.Configuration.AuthenticationLoginListenerandAuthenticationLogoutListener}

Two functions, including login and logout of XMPPRestService, are responsible for creating a new XMPPSessionImpl and destroying an existing XMPPSessionImpl. They can be called by listeners: AuthenticationLoginListener, AuthenticationLogoutListener or from client(browser) through the REST protocol (jabberLogin, jabberLogout in UIMainChatWindow.js).
 
You must use the same target component for two external component plugins: 

{code:xml}
<target-component>org.exoplatform.services.listener.ListenerService</target-component>
{code}

h4. AuthenticationLoginListener {anchor:id=CSref.Configuration.AuthenticationLoginListener}

{code:xml}
<component-plugin>
  <name>exo.core.security.ConversationRegistry.register</name>
  <set-method>addListener</set-method>
  <type>org.exoplatform.services.xmpp.connection.impl.AuthenticationLoginListener</type>
  <description>description</description>
</component-plugin> 
{code}

Details:

* *Name*: {{exo.core.security.ConversationRegistry.register}} - The name of plugin.
* *Set-method*: {{addListener}} - The plugin which registers the method.
* *Type*: {{org.exoplatform.services.xmpp.connection.impl.AuthenticationLoginListener}} - The class to execute the requests of the plugin.
* *Description*: It is used to start the session and log in the chat server.


h4. AuthenticationLogoutListener {anchor:id=CSref.Configuration.RequestFilterComponentPlugin.AuthenticationLogoutListener} 

{code:xml}
<component-plugin>
  <name>exo.core.security.ConversationRegistry.unregister</name>
  <set-method>addListener</set-method>
  <type>org.exoplatform.services.xmpp.connection.impl.AuthenticationLogoutListener</type>
  <description>description</description>
</component-plugin>         
{code}

Details:

* *Name*: {{exo.core.security.ConversationRegistry.register}} - The name of plugin.
* *Set-method*: {{addListener}} - The plugin which registers the method.
* *Type*: {{org.exoplatform.services.xmpp.connection.impl.AuthenticationLogoutListener}} - A class to execute the requests of the plugin.
* *Description*: It is used to end the session and log in the chat server.


h2. Contact Configuration {anchor:id=CSref.Configuration.ContactConfiguration}
The Contact Application is configured by three external component plugins: {{NewUserListener}}, {{NewMembershipListener}}
and {{UpdateUserProfileListener}}. They use the same target component:

{code:xml}
<target-component>org.exoplatform.services.organization.OrganizationService</target-component>	
{code}

The Contact configuration is found in _extension/webapp/src/main/webapp/WEB-INF/cs-extension/cs/contact/contact-service-configuration.xml_.

h3. NewUserListener {anchor:id=CSref.Configuration.NewUserListener}

{code:xml}  	
<component-plugin>
  <name>contact.new.user.event.listener</name>
  <set-method>addListenerPlugin</set-method>
  <type>org.exoplatform.contact.service.impl.NewUserListener</type>
  <description>description</description>
</component-plugin>
{code}

Details:

* *Name*: {{contact.new.user.event.listener}} - The name of listener.
* *Set-method*: {{addListenerPlugin}} - The plugin which registers the method.
* *Type*: {{org.exoplatform.contact.service.impl.NewUserListener}} - A class that executes all requirements of the plugin.
* *Description*: It is used to initialize personal contact data for users.

h3. NewMembershipListener {anchor:id=CSref.Configuration.NewUser.NewMembershipListener}
 
{code:xml}
<component-plugin>
  <name>contact.new.membership.event.listener</name>
  <set-method>addListenerPlugin</set-method>
  <type>org.exoplatform.contact.service.impl.NewMembershipListener</type>
  <description>description</description>
</component-plugin>
{code}

Details:

* *Name*: {{contact.new.membership.event.listener}} - The name of the listener.
* *Set-method*: {{addListenerPlugin}} - The plugin which registers the method. Keep this value.
* *Type*: {{org.exoplatform.contact.service.impl.NewMembershipListener}} - The class which executes all requirements of the plugin.
* *Description*: It is used to initialize an address book for a specific group.

h3. UpdateUserProfileListener {anchor:id=CSref.Configuration.UpdateUserProfileListener}

{code:xml}
<component-plugin>
  <name>contact.new.userprofile.event.listener</name>
  <set-method>addListenerPlugin</set-method>
  <type>org.exoplatform.contact.service.impl.UpdateUserProfileListener</type>
  <description>description</description>
</component-plugin>
{code}


Details:

* *Name*: {{contact.new.userprofile.event.listener}} - The name of the listener.
* *Set-method*: {{addListenerPlugin}} - The plugin which registers the method. Keep this value.
* *Type*: {{org.exoplatform.contact.service.impl.UpdateUserProfileListener}} - The class which executes all the requirements of the plugin.
* *Description*: It is used to update the personal profile of a user when he changes it on the portal.

h2. Content Configuration {anchor:id=CSref.Configuration.ContentConfiguration}

The Content application, such as RSS reader of eXo Collaboration, is configured by two external component plugins: RSSContentPlugin and DescriptionPlugin.
Both the external components plugins use the same target component:

{code:xml}
<target-component>org.exoplatform.content.service.ContentDAO</target-component> 
{code}
This content configuration is applied in _extension/webapp/src/main/webapp/WEB-INF/cs-extension/cs/content/content-service-configuration.xml_.

h3. RSSContentPluginDescriptionPlugin {anchor:id=CSref.Configuration.RSSContentPluginDescriptionPlugin}
{code:xml}
<component-plugin>
  <name>rssreader.listener</name>
  <set-method>addPlugin</set-method>
  <type>org.exoplatform.content.service.RSSContentPlugin</type>
  <description>rss reader plugin</description>
</component-plugin>
{code}


Details:

* *Name*: {{rssreader.listener}} - The name of the listener.
* *Set-method*: {{addPlugin}} - The plugin which registers the method. Keep this value.
* *Type*: {{org.exoplatform.content.service.RSSContentPlugin}} - A class which extends ContentPlugin and implements the loadContentMeta method to get content items.
* *Description*: It is a formater used to analyze the data from a RSS resource.

h3. DescriptionPlugin {anchor:id=CSref.Configuration.DescriptionPlugin}
	    
{code:xml}
<component-plugin>
  <name>description.listener</name>
  <set-method>addPlugin</set-method>
  <type>org.exoplatform.content.service.DescriptionPlugin</type>
  <description>Description plugin</description>
</component-plugin>	    
{code}

Details:

* *Name*: {{description.listener}} - The name of the listener. 
* *Set-method*: {{addPlugin}} - The plugin registering method. Keep this value.
* *Type*: {{org.exoplatform.content.service.DescriptionPlugin}} - A class which executes all requirements of the plugin.
* *Description*: It is a plugin to represent data from a RSS source.

h2. Mail Configuration {anchor:id=CSref.Configuration.MailConfiguration}

{docbook}
<warning><para>
The Mail portlet and its services are deprecated. It remains fully supported for eXo customers, however it will not receive any enhancement and will be removed from the product scope in the future.
</para></warning>
{docbook}

h3. AuthenticationLogoutListener {anchor:id=CSref.Configuration.AuthenticationLogoutListener}

In the Mail application of eXo Collaboration, when a user checks messages for one account, the remote mailbox fetch is performed as a background job. Before eXo Collaboration 1.2, the job was continued until all messages had been retrieved or when the user stopped the check through the UI. Hence, even when a user was not logged in, the background job was continued. This can be the resource intensive for the server if many users have large mailboxes.
Since eXo Collaboration 1.2,  one capability is added to halt the background job when the user session terminates (logout or timeout). It makes eXo Collaboration more friendly with server resources. If you want to activate this feature, you need to add a bunch of the xml congifuration in _/extension/webapp/src/main/webapp/WEB-INF/cs-extension/cs/mail/mail-service-configuration.xml_:

{code:xml}     
<external-component-plugins>
  <target-component>org.exoplatform.services.listener.ListenerService</target-component>
   <component-plugin>
    <name>exo.core.security.ConversationRegistry.unregister</name>
    <set-method>addListener</set-method>
    <type>org.exoplatform.mail.service.AuthenticationLogoutListener</type>
    <description>description</description>
  </component-plugin>
</external-component-plugins>
{code}

Details:

* *Name*: {{exo.core.security.ConversationRegistry.unregister}} - The name of listener.
* *Set-method*: {{addListener}} The plugin which registers the method. Keep this value.
* *Type*: {{org.exoplatform.mail.service.AuthenticationLogoutListener}} - A class which executes all requirements of the plugin.
* *Description*: It is a plugin used to stop checking mails of a user when he logs out.

h3. MailSettingConfigPlugin {anchor:id=CSref.Configuration.MailConfig.MailSettingConfigPlugin}
 Since eXo Collaboration 2.2.0, _MailSettingConfigPlugin_ is used to define the behavior, for example, showing/hiding fields and checking/unchecking checkboxes, of email account settings in the mail-server-configuration.xml file. It allows administrators to preconfigure all settings and to specify if end-users have the modification right on each specific setting or not. 

{code:xml}
<external-component-plugins>
  <target-component>org.exoplatform.mail.service.MailService</target-component>
	<component-plugin>   
		<name>cs.mail.service.settings</name>
    	<set-method>addPlugin</set-method>
		<type>org.exoplatform.mail.service.MailSettingConfigPlugin</type>
		<description>description</description>
			<init-params>
				<object-param>
					<name>leaveOnServer</name>
		   		<description>options to keep a copy of the message on the mail server after eXo Mail has downloaded the message</description>
		   		<object type="org.exoplatform.mail.service.MailSettingConfig">
		     		<field name="name"><string>leaveOnServer</string></field>
		     		<field name="userAllowed"><boolean>true</boolean></field>
		     		<field name="defaultValue"><string>true</string></field>
		   		</object>
				</object-param>
				<object-param>
					<name>incomingServer</name>
		   		<description>default incoming server to check for new mails.</description>
		   		<object type="org.exoplatform.mail.service.MailSettingConfig">
		     		<field name="name"><string>incomingServer</string></field>
		     		<field name="userAllowed"><boolean>true</boolean></field>
		     		<field name="defaultValue"><string>imap.gmail.com</string></field>
		   		</object>
				</object-param>
				<object-param>
					<name>incomingPort</name>
		   		<description>default port incoming server to check for new mails.</description>
		   		<object type="org.exoplatform.mail.service.MailSettingConfig">
		     		<field name="name"><string>incomingPort</string></field>
		     		<field name="userAllowed"><boolean>true</boolean></field>
		     		<field name="defaultValue"><string>993</string></field>
		   		</object>
				</object-param>
				<object-param>
					<name>outgoingServer</name>
		   		<description>description</description>
		   		<object type="org.exoplatform.mail.service.MailSettingConfig">
		     		<field name="name"><string>outgoingServer</string></field>
		     		<field name="userAllowed"><boolean>true</boolean></field>
		     		<field name="defaultValue"><string>smtp.gmail.com</string></field>
		   		</object>
				</object-param>
				<object-param>
					<name>outgoingPort</name>
		   		<description>description</description>
		   		<object type="org.exoplatform.mail.service.MailSettingConfig">
		     		<field name="name"><string>outgoingPort</string></field>
		     		<field name="userAllowed"><boolean>true</boolean></field>
		     		<field name="defaultValue"><string>465</string></field>
		   		</object>
				</object-param>
				<object-param>
					<name>acceptIncomingSecureAuthentication</name>
		   		<description>description</description>
		   		<object type="org.exoplatform.mail.service.MailSettingConfig">
		     		<field name="name"><string>acceptIncomingSecureAuthentication</string></field>
		     		<field name="userAllowed"><boolean>true</boolean></field>
		     		<field name="defaultValue"><string>true</string></field>
		   		</object>
				</object-param>
				<object-param>
					<name>incomingSecureAuthentication</name>
		   		<description>description</description>
		   		<object type="org.exoplatform.mail.service.MailSettingConfig">
		     		<field name="name"><string>incomingSecureAuthentication</string></field>
		     		<field name="userAllowed"><boolean>true</boolean></field>
		     		<field name="defaultValue"><string>starttls</string></field>
		   		</object>
				</object-param>
				<object-param>
					<name>incomingAuthenticationMechanism</name>
		   		<description>description</description>
		   		<object type="org.exoplatform.mail.service.MailSettingConfig">
		     		<field name="name"><string>incomingAuthenticationMechanism</string></field>
		     		<field name="userAllowed"><boolean>true</boolean></field>
		     		<field name="defaultValue"><string>plain</string></field>
		   		</object>
				</object-param>
				<object-param>
					<name>acceptOutgoingSecureAuthentication</name>
		   		<description>description</description>
		   		<object type="org.exoplatform.mail.service.MailSettingConfig">
		     		<field name="name"><string>acceptOutgoingSecureAuthentication</string></field>
		     		<field name="userAllowed"><boolean>true</boolean></field>
		     		<field name="defaultValue"><string>true</string></field>
		   		</object>
				</object-param>
				<object-param>
					<name>outgoingSecureAuthentication</name>
		   		<description>description</description>
		   		<object type="org.exoplatform.mail.service.MailSettingConfig">
		     		<field name="name"><string>outgoingSecureAuthentication</string></field>
		     		<field name="userAllowed"><boolean>true</boolean></field>
		     		<field name="defaultValue"><string>starttls</string></field>
		   		</object>
				</object-param>
				<object-param>
					<name>outgoingAuthenticationMechanism</name>
		   		<description>description</description>
		   		<object type="org.exoplatform.mail.service.MailSettingConfig">
		     		<field name="name"><string>outgoingAuthenticationMechanism</string></field>
		     		<field name="userAllowed"><boolean>true</boolean></field>
		     		<field name="defaultValue"><string>plain</string></field>
		   		</object>
				</object-param>
			</init-params>
  	</component-plugin>      
  </external-component-plugins>
{code}

Details:
* *Name*: {{cs.mail.service.settings}} - The name of the mail settings.
* *Set-method*: {{addPlugin}} - The plugin which registers the method.
* *Type*: {{org.exoplatform.mail.service.MailSettingConfigPlugin}} - The plugin's class name.
* *object type*: {{org.exoplatform.mail.service.MailSettingConfig}} - A class of object that contains a specific setting.
* *Description*: Describes what the setting is or what the setting does.


|| Object-param||Desciption ||
|leaveOnServer|Options to keep the message on the mail server after it has been downloaded to the Mail application of eXo Collaboration.|
|incomingServer|The default incoming server used to check new mails.|
|incomingPort|The default port of the incoming server used to check new mails.|
|outgoingServer|The default port of the outgoing server used to send new mails.|
|outgoingPort|The default outgoing port to send new mails.|
|acceptIncomingSecureAuthentication|Accept the secure authentication of the incoming server.|
|incomingSecureAuthentication|The type of incoming secure authentication.|
|incomingAuthenticationMechanism|The type of incoming authentication mechanism.|
|acceptOutgoingSecureAuthentication|Accepts the secure authentication of the outgoing server.|
|outgoingSecureAuthentication|The type of outgoing secure authentication.|
|outgoingAuthenticationMechanism|The type of incoming authentication mechanism.|

The object parameters have the same field names, but the values of the parameters are different.
||Field names||Description||Possible values|
|name|The field name in the account settings form.|String|
|userAllowed|Allow users to edit the field in the account settings form or not.|Boolean|
|defaultValue|The default value of the field in the account settings form. |String|


h2. Social Integration Configuration {anchor:id=CSref.Configuration.SocialIntegrationConfiguration}

The Social Integration Configuration is applied in _/extension/webapp/src/main/webapp/WEB-INF/cs-extension/cs/social-integration/social-integration-configuration.xml_.

h3. CalendarDataInitialize {anchor:id=CSref.Configuration.CalendarDataInitialize}

{code:xml}
<external-component-plugins>
  <target-component>org.exoplatform.social.core.space.spi.SpaceService</target-component>
  <component-plugin>
    <name>CalendarDataInitialize</name>
    <set-method>addSpaceListener</set-method>
    <type>org.exoplatform.cs.ext.impl.CalendarDataInitialize</type>
    <init-params>
      <value-param>
        <name>portletName</name>
        <value>CalendarPortlet</value>
      </value-param>
    </init-params>
  </component-plugin>
</external-component-plugins>
{code}

Details:

* *Name*: {{CalendarDataInitialize}} - The name of plugin.
* *Set-method*: {{addSpaceListener}} - The plugin which registers the method.
* *Type*: {{org.exoplatform.cs.ext.impl.CalendarDataInitialize}} - A class that executes all requirements of the plugin.
* *Description*: It is used to initialize a calendar for a group in a specific space.


See the details about the init-params of the component in the following table:
|| value-param || Description || Possible value || Default value ||
| *portletName* | The name of the portlet | {{String}} | {{CalendarPortlet}}|


h3. ContactDataInitialize {anchor:id=CSref.Configuration.ContactDataInitialize}

{code:Xml}
<external-component-plugins>
  <target-component>org.exoplatform.social.core.space.spi.SpaceService</target-component>
  <component-plugin>
    <name>ContactDataInitialize</name>
    <set-method>addSpaceListener</set-method>
    <type>org.exoplatform.cs.ext.impl.ContactDataInitialize</type>
    <init-params>
      <value-param>
        <name>portletName</name>
        <value>ContactPortlet</value>
      </value-param>
    </init-params>
  </component-plugin>
</external-component-plugins>
{code}

Details:

* *Name*: {{ContactDataInitialize}} - The name of the plugin.
* *Set-method*: {{addSpaceListener}} - The plugin which registers the method.
* *Type*: {{org.exoplatform.cs.ext.impl.ContactDataInitialize}} - A class that executes all the requires of the plugin.
* *Description*: It is a plugin used to initialize an address book for a group in a specific space.


See the details about the init-params of the component in the following table:
||value-param||Possible value||Default value||Description||
| *portletName* | {{String}} | {{ContactPortlet}}|The name of the portlet. |


h3. ContactSpaceActivityPublisher {anchor:id=CSref.Configuration.ContactSpaceActivityPublisher}

{code:xml}
<external-component-plugins>
  <target-component>org.exoplatform.contact.service.ContactService</target-component>
  <component-plugin>
    <name>ContactEventListener</name>
    <set-method>addListenerPlugin</set-method>
    <type>org.exoplatform.cs.ext.impl.ContactSpaceActivityPublisher</type>
  </component-plugin>
</external-component-plugins>
{code}

Details:

* *Name*: {{ContactEventListener}} - The name of the plugin.
* *Set-method*: {{addListenerPlugin}} - The plugin which registers the method.
* *Type*: {{org.exoplatform.cs.ext.impl.ContactSpaceActivityPublisher}} - A class that executes all requirements of the plugin.
* *Description*: It is a plugin used to customize the activity status of a specific space when an event happens on an address book.

h3. CalendarSpaceActivityPublisher {anchor:id=CSref.Configuration.CalendarSpaceActivityPublisher}

{code:xml}
<external-component-plugins>
  <target-component>org.exoplatform.calendar.service.CalendarService</target-component>
  <component-plugin>
    <name>CalendarEventListener</name>
    <set-method>addEventListenerPlugin</set-method>
    <type>org.exoplatform.cs.ext.impl.CalendarSpaceActivityPublisher</type>
  </component-plugin>
</external-component-plugins>
{code}

Details:

* *Name*: {{CalendarEventListener}} - The name of the plugin.
* *Set-method*: {{addEventListenerPlugin}} - The plugin which registers the method.
* *Type*: {{org.exoplatform.cs.ext.impl.CalendarSpaceActivityPublisher}} - A class that executes all the requires of the plugin.
* *Description*: It is a plugin used to customize the activity status of a specific space when an event happens on a calendar.


h3. PortletPreferenceRequiredPlugin {anchor:id=CSref.Configuration.PortletPreferenceRequiredPlugin}

{code:xml}
<external-component-plugins>
  <target-component>org.exoplatform.social.core.space.spi.SpaceService</target-component>
  <component-plugin>
    <name>portlets.prefs.required</name>
    <set-method>setPortletsPrefsRequired</set-method>
    <type>org.exoplatform.social.core.application.PortletPreferenceRequiredPlugin</type>
    <init-params>
      <values-param>
        <name>portletsPrefsRequired</name>
        <value>CalendarPortlet</value>
        <value>ContactPortlet</value>
      </values-param>
    </init-params>
  </component-plugin>
</external-component-plugins>
{code}

Details:

* *Name*: {{ortlets.prefs.required}} - The name of the plugin.
* *Set-method*: {{setPortletsPrefsRequired}} - The plugin which registers the method.
* *Type*: {{org.exoplatform.social.core.application.PortletPreferenceRequiredPlugin}} - A class that executes all the requires of the plugin.
* *Description*: It is a plugin used to declare the application that will automatically create database.


See the details about the init-params of the component in the following table:
|| value-param || Possible value || Default value || Description ||
| *portletsPrefsRequired* | {{String}} | {{ContactPortlet / ContactPortlet}}| The name of plugin added to SpaceService. |

h1. Data Injectors {anchor:id=CSref.Configuration.DataInjectorService}
{include:document="DataInjectorService.wiki"}
