View source for Accounting Portlet ABANDONED

==Introduction==

This portlet allows the users of the infrastructure to view the accounting information (based on the resources consumption and collected by the services) both in a report form (aggregated data) and is raw form (single accounting information).

Below is shown the overall layout of the Accounting Portlet:

[[Image:accounting_portlet_overall.png|800px|center|Accounting Portlet Overall]]


==Reports==

The purpose of the portlet is to have the views and the data customized by the user roles and the scopes, avoiding to present all accounting records as the first glance and showing some reports by resource type. For each report there are filter and aggregation options.
In particular, for each resource type is possible to select a specific report. Besides, for each resource type all the options related to the data filtering and/or aggregation are specific.

Below is shown an example of the available reports for the Task resource type:

[[Image:accounting_portlet_reports_menu.png|center|Accounting Portlet Reports Menu]]

For each resource type (defined in the [http://gcube.wiki.gcube-system.org/gcube/index.php/Common-accounting-model common-accounting-model]) are available different type of report. 

Following a complete description of these reports:


==== Storage Status ====

# Volume : represents the latest dataVolume value.
# Entities : represents the latest dataCount value.

Additional dimension (and filters) : dataType, providerID.


==== Storage Usage ====

# Volume : represents the sum of the dataVolume values (DELETE operation is not considered).
# Num. of Entities : represents the sum of the dataCount values.
# Num. of Operations : represents the number of storage operations, obtained by counting the common ids.

Additional dimension (and filters): dataType, operationType.


==== Job ====

# Elapsed Time : represents the sum of execution times of the jobs.
# Net Elapsed Time : represents the total wall clock time elapsed, obtained by summing the wallDuration values.
# Num. of Jobs : represents the number of jobs, obtained by counting the job ids.

Additional dimension (and filters): domain, jobStatus.


==== Task ====

# Worker Time : represents the sum of the execution times of the tasks.
# Num. of Processors : represents the number of processors, obtained by summing the processor values.
# NetworkTraffic : represents the consumption of the network resource, obtained by summing the overallNetwork values (two results, one for network input and one for network output).

Additional dimension (and filters): domain, jobStatus.


==== Service ====

# Num. of Operations : represents the number of operations, obtained by counting the invocationCount values.
# Avg Invocation Time : represents the average invocation time, obtained by averaging the averageInvocationCount.

Additional dimension (and filters): ServiceClass, ServiceName, domain.

==Timeline graph==

This is the main section of the portlet. A user can select different zoom options, slide the graph moving the cursor at the bottom or dragging the graph.

[[File:accounting_portlet_timeline_graph.png]]

In the up-right side there is the “Aggregation By” option. This section allows the user to change the aggregation granule of the report.
Below the graph there is the button to show raw accounting data used to generate the accounting report.

==Context==

This menu shows the context information of the user logged in on the portlet. According to the user’s roles, in the Context section is shown a subsection for each Infrastructure/VO/VRE where the user is manager/admin. Besides, is always shown the subsection “My Dashboard” which covers the set of the accounting information where the user is directly involved.

[[File:accounting_portlet_context_menu.png]]

==Time period==

This section allows the user to select a time range of interest for the accounting report. The default value is the last month.

[[File:accounting_portlet_time_period.png]]

==Dimensions and filters==

Each report/graph data can be filtered either on some common dimensions for all the available resource types and on some specific dimensions. Each resource type has a contextual section of filters. The following menu allows users to select values of these filters clicking the related Select button.

[[File:accounting_portlet_dimensions_filters.png]]

The left side of the “Dimension and Filters” section allows the user to select, through a radio button, a dimension that will be shown in the graph (by different colors). If the user select "No dimension" option, only filters will be used to build the graph, without showing dimension.

The filter selection is guided by a popup that shows both a pie chart and a table which representing the rating information of the selected filter. These information are useful to more easily select the values on which to apply the selected filter. Indeed, this representation shows at a first glance the values in descending order, then allows the user to understand the “resource” consumption against a particular field.

[[File:accounting_portlet_pie_chart.png]]

Below is shown an example of timeline graph with selected dimension and filters:

[[File:accounting_portlet_timeline_graph_example.png]]

Each line represents a combination of three factors: report type, selected dimension and selected filters.

==Installation==

# Install Vaadin Control Panel for Liferay portlet ([https://vaadin.com/directory#addon/vaadin-control-panel-for-liferay:vaadin vaadin-controlpanel-for-liferay.war])
# The menu path for Vaadin Control Panel is Manage → Control Panel → Vaadin
#:[[File:accounting_portlet_vaadin_control.png]]
# Use Vaadin Control Panel to update Vaadin to version 6.8.12
#:[[File:accounting_portlet_vaadin_version.png]]
# Copy [https://gcube.wiki.gcube-system.org/gcube/images_gcube/c/cd/Vaadin_libs.tar.gz libraries] below to following path /home/portal/tomcat-6.0.29/webapps/ROOT/WEB-INF/lib/
#* ButtonGroup-1.2.jar	
#* flexibleoptiongroup-1.1.0.jar	
#* VaadinVisualizations2.1.jar	
#* gwt-visualization.jar
# Click on [re-scan] in Vaadin Control Panel
# Select ButtonGroup 1.2, FlexibleOptionGroup 1.1.0 and VisualizationsForVaadin 1.1.2
#:[[File:accounting_portlet_vaadin_addons.png]]
# Click on Manage Additional Dependencies and select the dependency gwt-visualization.jar
#:[[File:accounting_portlet_vaadin_additional_deps.png]]
# Click on Compile Widget Set
# Install the accounting portlet (artifact name: org.gcube.portlets-admin.accounting-portlet.<<version>>)