h1. Engagement gadgets {anchor:id=GadgetUserguide.AngagementGadgets}
*Engagement* gadgets include gadgets designed to aid users in engagement activities and events.
These gadgets analyze the existing communications and community engagement in your organization, then show what is going on by providing statistics.

eXo Platform currently provides 4 types of *Engagement* gadget as follows:

{docbook}
<para xml:id="GadgetUserguide.AngagementGadgets.LatestForumPosts">
	<citetitle>
		<emphasis role="bold">Latest Forum</emphasis>
	</citetitle>
</para>
{docbook}

The *Latest Forum Posts* gadget shows the latest posts in Forum. You can decide the specified number of the latest posts to be shown. This gadget helps you always stay updated with what is going on in the forum.

!images/Latest_forum_posts_gadget.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

* *Latest Forum Posts settings:*

{docbook}
<para>
              <emphasis role="bold">1.</emphasis> Click <inlinemediaobject>
                <imageobject role="fo">
                  <imagedata fileref="images/edit_gadget.png" format="PNG" scalefit="1" width="4mm"/>
                </imageobject>
                <imageobject role="html">
                  <imagedata fileref="images/edit_gadget.png" format="PNG" scalefit="1" width="4mm"/>
                </imageobject>
              </inlinemediaobject> in the <guilabel>Title</guilabel> bar to open the form to edit the gadget settings.
</para>
{docbook}
*Details:*

|| Field || Description ||
| *Total* | The number of last posts to be displayed in this gadget. |
| *Forum portlet* | The URL pointing to the Forum portlet. |
| *Subscription url* | The link to the service which you request to get data from (in this case, the data are last posts). For example: http://mycompany.com:8080/portal/rest/ks/forum/getmessage. |

{docbook}
<para>
<emphasis role="bold">2.</emphasis> Input the values for all the fields, then click <guibutton>Save</guibutton> to accept your changes.</para>
{docbook}

{docbook}
<para xml:id="GadgetUserguide.AngagementGadgets.TopVotedTopics">
	<citetitle>
		<emphasis role="bold">Top Voted Topics</emphasis>
	</citetitle>
</para>
{docbook}

The *Top Voted Topics* gadget lists the highest rated topics in a forum. You can decide the maximum number of posts to be shown.

!images/Top_voted_raring_topic.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

By clicking the post previewed-content, you will go to that post in the forum.


* *Top Voted Topics gadget settings:*

{docbook}
<para>
              <emphasis role="bold">1.</emphasis> Click <inlinemediaobject>
                <imageobject role="fo">
                  <imagedata fileref="images/edit_gadget.png" format="PNG" scalefit="1" width="4mm"/>
                </imageobject>
                <imageobject role="html">
                  <imagedata fileref="images/edit_gadget.png" format="PNG" scalefit="1" width="4mm"/>
                </imageobject>
              </inlinemediaobject> in the <guilabel>Title</guilabel> bar to open the form to edit the gadget settings.
</para>
{docbook}

!images/Top_voted_raring_topic_setting.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

{docbook}
<para>
<emphasis role="bold">2.</emphasis> Select the maximum number of topics to be displayed in the <guilabel>Maximum to display</guilabel> drop-down list, then click <guibutton>Save</guibutton> to accept your changes.
</para>
{docbook}

{docbook}
<para xml:id="GadgetUserguide.AngagementGadgets.ForumStatistics">
	<citetitle>
		<emphasis role="bold">Forum Statistics</emphasis>
	</citetitle>
</para>
{docbook}

The *Forum Statistics* gadget displays statistics about the forum's activity. This gadget is especially useful for administrators who always need global as well as detailed view about how the forum is going on.
Based on these statistics, the administrators can find the solution to increase the forum activities.

The statistics include the total number of the topics, posts, members, active members and the maximum number of online users.

You can switch between different views:

* *Global statistics view:* This is the default view.

!images/Forums_statistics_gadget.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

* *Weekly statistics view:*
** Click !images/Calendar_weekly_stat_icon.png| scalefit="1" width="4mm"! to switch to the *Weekly statistics* view.
** Click !images/Calendar_global_stat_icon.png|scalefit="1" width="4mm"! to back to the *Global statistics* view.

After switching to the *Weekly statistics* view, you can display the statistics in a list or a chart.

*List view*

!images/Forums_weekly_statistics.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

* Click !images/Calendar_weekly_chart_icon.png|scalefit="1" width="4mm"! to switch to the *Chart* view.

*Chart view*

!images/Forums_weekly_statistics_graph.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!


* Click !images/Calendar_weekly_list_icon.png|fo:scalefit="1" width="4mm"! to go back to the *List* view.

{docbook}
<para xml:id="GadgetUserguide.EngagementGadgets.FriendSuggestions">
	<citetitle>
		<emphasis role="bold">Friend Suggestions</emphasis>
	</citetitle>
</para>
{docbook}

The *Friend Suggestions* gadget will suggest you to connect with people that have mutual friends with you.

!images/Friend_suggestion_gadget.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!
{docbook}
<para>To send the invitation to connect with the suggested people right on this gadget, simply click <guilabel>Send invitation</guilabel> under their usernames.</para>
{docbook}

h1. Management and Monitoring Gadgets {anchor:id=GadgetUserguide.ManagementMOnitoringGadget}

The *Management and Monitoring* gadgets include gadgets designed for providing the overall vision of the system. These gadgets monitor the system and provide the current system performance statistics which are especially useful for the system administrators and developers.

eXo Platform provides 7 types of *Management and Monitoring* gadget as follows:

{docbook}
<para xml:id="GadgetUserguide.ManagementMonitoringGadget.MemoryCharts">
	<citetitle>
		<emphasis role="bold">Memory Charts</emphasis>
	</citetitle>
</para>
{docbook}

The *Memory Charts* gadget provides the chart of memory used during runtime.

!images/Memory_gadget.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

The chart shows:
* The ratio between free and used heap memory.
* The ratio between free and used non-heap memory.

{docbook}
<para xml:id="GadgetUserguide.ManagementMonitoringGadget.CacheLevels">
	<citetitle>
		<emphasis role="bold">Cache Levels</emphasis>
	</citetitle>
</para>
{docbook}

The *Cache Levels* gadget displays the eXo cache levels and settings. Based on these statistics, the administrators can configure the cache settings properly to get better performance:

* If the cache is full but the hit ratio is low (or missed ratio is high), it means the cache is full of unnecessary data. It should be cleared and/or its size is increased, or its lifetime is decreased.
* If the cache is full and the hit ratio is high, this is good. It means most data are retrieved from the cache not the database, so the system gets better performances.
* If the cache is empty, it should be configured differently, for example, increasing its lifetime.

!images/Caches_gadget.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

{docbook}
<itemizedlist>
              <listitem>
                <para>The <guilabel>Consumption</guilabel> tab shows the overall cache consumption in the system.</para>
              </listitem>
              <listitem>
                <para>The <guilabel>Hit ratio</guilabel> tab shows the ratio between requested data fetched from cache and data fetched from database.</para>
              </listitem>
</itemizedlist>
{docbook}
!images/Caches_gadget_hitratio.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

{docbook}
<para> The <guilabel>Details</guilabel> tab shows the cache level and the current cache settings.</para>
{docbook}
!images/Caches_gadget_details.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

In which:
{docbook}
<itemizedlist>
              <listitem>
                <para>
                  <guilabel>Max size</guilabel>: The maximum size of the cache.</para>
              </listitem>
              <listitem>
                <para>
                  <guilabel>Time to live</guilabel>: The lifetime (in seconds) of cache entries before being cleared.</para>
              </listitem>
              <listitem>
                <para>
                  <guilabel>Hit/Missed</guilabel>: The percentage of data fetched from cache versus the percentage of data fetched from database.</para>
              </listitem>
</itemizedlist>
{docbook}

{docbook}
<para xml:id="GadgetUserguide.ManagementMonitoringGadget.ApplicationStatistics">
	<citetitle>
		<emphasis role="bold">Applications Statistics</emphasis>
	</citetitle>
</para>
{docbook}

The *Application Statistics* gadget displays how fast applications are. It shows administrators and developers which applications should be optimized.

!images/Applications_statistic_gadget.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

Applications that take long time to execute will be highlighted so that you can easily recognize.

!images/Applications_statistic_highlight.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

Each application is provided with these statistics:

* The number of executions (exec).
* The minimum execution time (min).
* The maximum execution time (max).

{docbook}
<para xml:id="GadgetUserguide.ManagementMonitoringGadget.AllTemplateStatistics">
	<citetitle>
		<emphasis role="bold">All Template Statistics</emphasis>
	</citetitle>
</para>
{docbook}

The *All Template Statistics* gadget displays how fast templates are. It shows administrators and developers which templates should be optimized.

!images/All_template_statistics_gadget.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

Each template is provided with these statistics:

* The number of executions (nb exec).
* The minimum execution time (min).
* The maximum execution time (max).
* The average execution time (avg).

{docbook}
<para xml:id="GadgetUserguide.ManagementMonitoringGadget.10SlowestTemplates">
	<citetitle>
		<emphasis role="bold">10 Slowest Templatesstics</emphasis>
	</citetitle>
</para>
{docbook}

The *10 Slowest Templates* gadget displays the 10 slowest groovy templates and their speed statistics. It helps administrators and developers specify what templates are slowing down the system performance most.

!images/10Slowest_templates_gadget.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

Similar to the *All Template Statistics* gadget, each template is provided with these statistics:

* The number of executions (nb exec).
* The minimum execution time (min).
* The maximum execution time (max).
* The average execution time (avg).

{docbook}
<para xml:id="GadgetUserguide.ManagementMonitoringGadget.ServiceManagement">
	<citetitle>
		<emphasis role="bold">Services Management</emphasis>
	</citetitle>
</para>
{docbook}

The *Services Management* gadget provides an easy access to REST management API.

!images/Service_management_gadget.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

* Select the service from the *Services* drop-down list. For each selected service, its respective methods and properties are shown.
* Click !images/Service_management_help.png|scalefit="1" width="4mm"! to get the description of the selected service.

* *Manage a remote service on another Platform settings:*


{docbook}
<para>
              <emphasis role="bold">1.</emphasis> Click <inlinemediaobject>
                <imageobject role="fo">
                  <imagedata fileref="images/edit_gadget.png" format="PNG" scalefit="1" width="4mm"/>
                </imageobject>
                <imageobject role="html">
                  <imagedata fileref="images/edit_gadget.png" format="PNG" scalefit="1" width="4mm"/>
                </imageobject>
              </inlinemediaobject> in the <guilabel>Title</guilabel> bar.
</para>
{docbook}
The form to edit the gadget settings appears.

!images/Service_management_settings.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!
{docbook}
<para>2. Enter the link to the service in the <guilabel>Services URL</guilabel> field, then click <guibutton>Save</guibutton> to accept your changes.</para>
{docbook}

{docbook}
<para xml:id="GadgetUserguide.ManagementMonitoringGadget.GroovyConsole">
	<citetitle>
		<emphasis role="bold">eXo Scripting Console</emphasis>
	</citetitle>
</para>
{docbook}

The *eXo Scripting Console* gadget provides a Groovy console that developers can use to interact with the runtime. This gadget is useful when you want to experiment on code.
It accepts eXo API and can access eXo components deployed in the portal container, so this can be used as a tool for drafting code, testing or exploring eXo API/components/data interactively on a live system.
The eXo Scripting Console gadget is better viewed on the entire screen. You should configure an entire page or a Dashboard tab for it.

!images/GroovyConsole.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

* Click !images/GroovyConsole_font.png|fo:scalefit="1" width="8mm"! to change the font size.
* Click !images/GroovyConsoleColor.png|fo:scalefit="1" width="8mm"! to change the font color.
* Click !images/GroovyConsoleHelp.png|fo:scalefit="1" width="8mm"! to view the Groovy Console Help.

h1. Audit & Collab gadgets {anchor:id=GadgetUserguide.AuditGadgets.CollabGadgets}
eXo Platform currently provides:
* One type of *Audit* gadget that is named [Login History|#GadgetUserguide.AuditGadgets.UserLoginHistory].
* One type of *Collab* gadget that is named [eXo Calendar Gadget|#GadgetUserguide.CollabGadgets.Calendar_gadget]

{docbook}
<para xml:id="GadgetUserguide.AuditGadgets.UserLoginHistory">
	<citetitle>
		<emphasis role="bold">Login History</emphasis>
	</citetitle>
</para>
{docbook}

Under the group of Audit gadgets, *Login History* records user login history and provides statistics.

!images/Login_history_gadget.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

{docbook}
<para>You can look up a specific user by entering his username in the <guilabel>User</guilabel> field and click <guilabel>Find</guilabel>. </para>
{docbook}

{docbook}
<para> Click <guibutton>Reset</guibutton> to clear the <guilabel>User</guilabel> field and return the default list of users who have signed in.</para>
{docbook}

{docbook}
<itemizedlist>
              <listitem>
                <para>Click the <guilabel>Statistics</guilabel> and <guilabel>History</guilabel> links to view the global statistics and global history respectively.</para>
              </listitem>
</itemizedlist>
{docbook}

* Click !images/Calendar_weekly_chart_icon.png|fo:scalefit="1" width="4mm"! corresponding to the user to view his login statistics.

!images/Login_history_statistic.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

* Click !images/Calendar_weekly_list_icon.png|fo:scalefit="1" width="4mm"! corresponding to the user to view his login history.

!images/Login_history_history.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

{docbook}
<para xml:id="GadgetUserguide.CollabGadgets.Calendar_gadget">
	<citetitle>
		<emphasis role="bold">eXo Calendar Gadget</emphasis>
	</citetitle>
</para>
{docbook}

Under the group of *Collab* gadgets which are designed for collaborative activities, the *eXo Calendar* gadget displays a mini calendar and allows you to quickly add an event.

!images/eXo_Calendar_gadget.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

{docbook}
<para>There are three tabs in this gadget, including <guilabel>Appearance, Quick add,</guilabel> and <guilabel>Refresh</guilabel>.</para>
{docbook}

* *Appearance:*

!images/eXo_Calendar_gadget_appearance.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!

{docbook}
<para>If you have more than one personal calendar, you can select which calendar to display. Select the calendars from the list, then click <guibutton>save</guibutton>. Only the event in the calendar of your choice will be displayed. </para>
{docbook}

* *Quick add:*

{docbook}
<para>You can add a new event to your personal calendar in this gadget by simply entering the date, time and description, then selecting <guibutton>add</guibutton>.</para>
{docbook}

!images/eXo_Calendar_gadget_quickadd.png|align="center" width="70mm" fo:scalefit="1" html:scalefit="0"!


h1. Intranet gadgets {anchor:id=GadgetUserguide.IntranetGadgets}

Intranet gadgets are ones which come with the [Intranet homepage|#Access_intranet], including:

* [My Profile gadget|#GadgetUserguide.IntranetGadgets.MyProfile]
* [My Invitations gadget|#GadgetUserguide.IntranetGadgets.MyInvitations]
* [My Agenda gadget|#GadgetUserguide.IntranetGadgets.MyAgenda]
* [Featured Poll gadget|#GadgetUserguide.IntranetGadgets.FeaturedPoll]
* [Who is online? gadget|#GadgetUserguide.IntranetGadgets.WhoIsOnline]
* [Bookmarks gadget|#GadgetUserguide.IntranetGadgets.Bookmarks]
* [Favorite Documents gadget|#GadgetUserguide.IntranetGadgets.FavoriteDocuments]

{note}
Intranet gadgets only work in the Intranet context.
{note}

{docbook}
<para xml:id="GadgetUserguide.IntranetGadgets.MyProfile">
	<citetitle>
		<emphasis role="bold">My Profile</emphasis>
	</citetitle>
</para>
{docbook}

!images/My_Profile_gadget.png|align="center" width="90mm" fo:scalefit="1" html:scalefit="0"!

*My Profile* gadget provides a quick access to your profile page where you can update your profile information.

{docbook}
<para xml:id="GadgetUserguide.IntranetGadgets.MyInvitations">
	<citetitle>
		<emphasis role="bold">My Invitations</emphasis>
	</citetitle>
</para>
{docbook}

!images/My_invitations_gadget.png|align="center" width="90mm" fo:scalefit="1" html:scalefit="0"!

*My Invitations* gadget displays number of invitations from people or spaces.
You can click the *People*/*Space* to view invitations from people/space or you can click *Find more* to open the *My Connections* page and view all the requests received.

{docbook}
<para>
	<citetitle xml:id="GadgetUserguide.IntranetGadgets.MyAgenda">
		<emphasis role="bold">My Agenda</emphasis>
	</citetitle>
</para>
{docbook}

!images/My_agenda_gadget.png|align="center" width="90mm" fo:scalefit="1" html:scalefit="0"!

*My Agenda* gadget displays the upcoming events and tasks created in your calendars.

* To change the *My Agenda* settings, click !images/Gadget_setting_button.png|width="4mm" fo:scalefit="1" html:scalefit="0"!.

!images/My_Agenda_settings.png|align="center" width="90mm" fo:scalefit="1" html:scalefit="0"!

Here, you can:

|| Field || Description ||
| *Number of Items to Display* | Set the maximum number of tasks and events to be displayed. |
| *Calendar* | Choose the calendar that you want to show tasks and events. |
| *Save*/*Cancel* | Save/Discard changes. |
| *Show My Calendars* | Show your calendars in the *Calendar* application. |

{docbook}
<para xml:id="GadgetUserguide.IntranetGadgets.FeaturedPoll">
	<citetitle>
		<emphasis role="bold">Featured Poll</emphasis>
	</citetitle>
</para>
{docbook}

!images/Featured_poll_gadget.png|align="center" width="90mm" fo:scalefit="1" html:scalefit="0"!

*Featured Poll* gadget displays the poll created in the *Forum* or *Poll* application that you have permission to vote. You can directly vote and see results on the gadget. This gadget also provides links to create your own poll or discuss about the poll topic in the Forum.

* *Vote for a specific poll:* Normally, the latest poll will be displayed on this gadget. However, you can indicate another poll to vote by clicking !images/Gadget_setting_button.png|width="4mm" fo:scalefit="1" html:scalefit="0"!, then choose one from the drop-down list.

!images/Featured_Poll_settings.png|align="center" width="90mm" fo:scalefit="1" html:scalefit="0"!

Here, you can:

|| Field || Description ||
| *Vote*/*Vote Again* | Vote for option(s)/ Change your vote (appeared when the option "Change your vote" is enabled).|
| *Create Your Own Poll*| Create a new poll in the *Forum* application.|
| *Discuss in Forum*| Go to the topic in the *Forum* application.|

{docbook}
<para xml:id="GadgetUserguide.IntranetGadgets.WhoIsOnline">
	<citetitle>
		<emphasis role="bold">Who is online?</emphasis>
	</citetitle>
</para>
{docbook}

!images/WhoIsOnline_gadget.png|align="center" width="90mm" fo:scalefit="1" html:scalefit="0"!

*Who is online?* gadget displays people that are currently connected to the Intranet.

|| Fields || Description ||
| *My Connections* | Display social connections and their avatars, full names and excerpt of their last posted status. Clicking the link on a name will lead to the profile of that person. |
| *Others* | Display names of other people who are not in social connections. Only their names are displayed. Clicking the link on a name will lead to the profile of that person. |

{docbook}
<para xml:id="GadgetUserguide.IntranetGadgets.Bookmarks">
	<citetitle>
		<emphasis role="bold">Bookmarks</emphasis>
	</citetitle>
</para>
{docbook}

!images/Bookmarks_gadget.png|align="center" width="90mm" fo:scalefit="1" html:scalefit="0"!

*Bookmarks* gadget is a simple link management gadget which displays your quick links. You can add or remove any links.

* To change the Bookmarks gadget settings, click !images/Gadget_setting_button.png|width="4mm" fo:scalefit="1" html:scalefit="0"!.

!images/Bookmarks_settings.png|align="center" width="90mm" fo:scalefit="1" html:scalefit="0"!

Here, you can:

|| Field || Description ||
| *Add bookmark* | Add a new bookmark. |
| *Name* | The bookmark name. For example: "Documents".|
| *URL* | The bookmark link. For example: "http://int.exoplatform.org/portal/intranet/documents". |
| !images/Accept_discard_changes.png|width="9mm" fo:scalefit="1" html:scalefit="0"! | Accept/Delete changes. |
| !images/Gadget_save_setting_button.png|width="4mm" fo:scalefit="1" html:scalefit="0"! | Save gadget settings. |

{docbook}
<para xml:id="GadgetUserguide.IntranetGadgets.FavoriteDocuments">
	<citetitle>
		<emphasis role="bold">Favorite Documents</emphasis>
	</citetitle>
</para>
{docbook}

!images/Favorite_Documents_gadget.png|align="center" width="90mm" fo:scalefit="1" html:scalefit="0"!

*Favorite Documents* gadget lists your favorite documents in the *Sites Explorer* so you can quickly access them.

|| Field || Description ||
| *My Favorites* | Show a list of favorite documents by created date. |
| *My Documents* | Show a list of your document by created date. |
| *Show all* | Show all your favorite documents in *Sites Explorer*. |