Differences

This shows you the differences between two versions of the page.

--- en:software:dashboard:dashboard_documentation [2015/12/10 10:58]
amanda.zens
+++ en:software:dashboard:dashboard_documentation [2021/07/01 09:52] (current)
@@ Line 1: / Line 1: @@
+====== Dashboard - Overview ======
 ==== Dashboard Login ====
 {{ en:software:dashboard:dashborad_login.png?300 |}}
@@ Line 4: / Line 5: @@
 {{ software:dashboard:new_dashboard.jpg?300 |}}
------
+----
 ==== Adding and Creating Widgets ====
 {{ en:software:dashboard:add_widgets.png?direct&300|}}
-A dashboard can contain as many widgets as desired by the user. A widget can display almost any piece of information and has to be defined by an [[en:software:tim:rights|administrator]].  It is not possible to add a console widget (by which all existing information can be processed) if the current (logged-in) user does not have administrative rights.
+A dashboard can contain as many widgets as desired by the user. A widget can display almost any piece of information and has to be defined by an [[en:software:tim:roles|administrator]].  It is not possible to add a console widget (by which all existing information can be processed) if the current (logged-in) user does not have administrative rights.
 > Please refer to the following [[dashboard_tablestructure|information]] for more on the types of charts and  structures that can be used in TIM.
@@ Line 17: / Line 18: @@
 In this example, the widget provides an overview of all existing users in the system. Please refer to this [[analyses|page]] to access further examples.
------
+----
 ==== How to Save a Widget ====
@@ Line 34: / Line 35: @@
 {{en:software:dashboard:widgets_drag_drop.png?500| }}
 \\
 ----
 ==== Widget Menu ====
 ^ Symbol ^ Function ^
-^{{ software:dashboard:widgetmenue_diagramm.jpg?30 |}} | This item on the menu allows the widget information to be displayed graphically  |
+^{{ software:dashboard:widgetmenue_diagramm.jpg?30 |}} | This item on the menu allows the widget information to be displayed graphically in a diagram  |
 ^{{ software:dashboard:widgetmenue_excelexport.jpg?30 |}} | This item on the menu exports the complete content of the widget to a single file in Excel-format |
 ^{{ software:dashboard:widgetmenue_maximieren.jpg?30 |}} | This item changes the widget size to be displayed with the largest possible width |
@@ Line 45: / Line 45: @@
------
+----
 ==== Graphical Analysis of Widgets====
-If the user wished to display the widget information graphically, this can be easily and flexibly implemented. For correctly implementation, X- and Y-axes have to be created. In the current example, this is not possible to do because an axis cannot be created based only on entities such as "name" and "Email". To make this possible, a new widget, showing how many users were generated on each weekday, has to be generated.
+If the user wishes to display the widget information graphically, this can be easily and flexibly implemented. For correct implementation, X- and Y-axes have to be created. In the current example, this is not possible to do because an axis cannot be created based solely on entities such as "name" and "Email". To create the graph, a new widget, showing how many users were generated on each weekday, needs to be generated.
 <code sql>
 select DAYNAME(creationtime) as Tag, count(DAYNAME(creationtime)) as number from view_identity group by DAYNAME(creationtime)
 </code>
 This can be saved in the usual manner and then added to the dashboard. Next, the diagram symbol/function can be used to set the X- and Y-axes.  If a specific type of diagram is desired, this is modified via the widget configuration settings.
->> TIP!
+<note tip> If an analysis is deemed invalid due to a value being too far outside the norm, this may be removed by selecting and deleting the respective group from the legend. </note>
-> If an analysis is deemed invalid due to a single value(s) being too far outside the norm, this may be deleted by selecting the respective analysis in the legend.
 {{ en:software:dashboard:widgets_chart_type.png?600 |}}
--------
+----
 ==== Working with Variables ====
-The dashboard enables widgets to be displayed based on the selection of the value of a particular variable. For instance, in the first example not every user should be displayed by the widget. Rather, the user should be able to choose the information displayed. To enable this function the widget has to be changed as follows:
+The dashboard enables widgets to be displayed based on the selection of particular variable's value. For instance, in the first example not every user should be displayed by the widget. Rather, the user should be able to select the information to be displayed. To enable this function the widget has to be changed as follows:
 <code sql>
 SELECT name, email FROM view_identity WHERE identityType = :identType
 </code>
 {{ en:software:dashboard:widgets_variables.png?direct&300|}}
->>Note!
+<note> Within the dashboard, the displayed variables will always be identified by ":Variable name"</note>
-> Within the dashboard, the displayed variables will always be identified by ":Variable name"
 In a second step, the desired content of the variable is defined. To do this the following menu items must be selected: **Dashboards -> Settings -> Variables** \\
@@ Line 73: / Line 71: @@
   *Name - enter here the name of the variable
   *Type - this indicates if the output is formatted as letters, numbers or dates
-  *Providing - This indicates if the result is a single output or a list of multiple outputs
+  *Returns - This indicates if the result is a single output or a list of multiple outputs
   *Query - the content of a variable can be defined within this field by using MySQL syntax
-  *Executing - this shows the test results of the variable
+  *Execute - this shows the test results of the variable
   *Remove - this function will delete the complete variable from the system
 {{ en:software:dashboard:widgets_variables_example.png?direct&300|}}
@@ Line 81: / Line 79: @@
 select identityType from view_identity group by identityType
 </code>
-To test this variable, the user should executed the variables before saving and **5 results** should be returned. \\
+To test this variable, the user should execute the variables before saving and **5 results** should be returned. \\
 {{ en:software:dashboard:widgets_variables2.png?direct |}}
 After this, the value of the variable can be defined and confirmed within the widget configuration menu by clicking **OK**. The new content will be adapted to reflect the system and the variable settings. The selection will look as depicted below after the widget has been saved:
@@ Line 89: / Line 87: @@
 ==== Locking Variables ====
-<note tip> If the same widget is to be used by multiple entities, e.g. several departments, a variable that blocks access to the widget can be implemented. This ensures that end user cannot change the variable</note>
+<note tip> If the same widget is to be used by multiple entities, e.g. several departments, a locked variable can be implemented in the widget. This ensures that end user cannot change the variable</note>
 {{ en:software:dashboard:widgets_variables_lock.png?300|}}
-If the variable has been locked, the user is not able to change its value. For example, in the present screenshot the value "user" would always be selected by default. This can only be changed by the owner of the widget. This makes it possible to use a widget for several dashboards, while ensuring that various users only have access to the information for which tare authorized.
+If the variable has been locked, the user is not able to change its value. For example, in the present [[:play|screenshot]] the value "user" would always be selected by default. This can only be changed by the owner of the widget. This makes it possible to use a widget for several dashboards, while ensuring that various users only have access to the information for which they are authorized.
 ==== Using Global Variables ====
-So-called global variables can be used within the Dashboard. The following variables belong to this category: \\
+So-called global variables can be used within the dashboard. The following variables belong to this category: \\
 \\
 ^ Variable ^ Results ^
 ^ :CURRENT_USER_NAME ^ This names the current logged-in user|
 ^ :CURRENT_USER_ID ^ This provides the UserID of the user |
-^ :CURRENT_USER_DEPARTMENT ^ The department to which the user belongs is indicated here |
+^ :CURRENT_USER_DEPARTMENT ^ This shows the department to which the user belongs |
 ^ :CURRENT_CLIENT_NAME ^ This gives the name of the client |
-^ :CURRENT_CLIENT_ID ^ This entry provides the current ClientID |
+^ :CURRENT_CLIENT_ID ^ This provides the current ClientID |
-^ :CURRENT_TIMESTAMP ^ The current timestamp will be shown in this entry |
+^ :CURRENT_TIMESTAMP ^ This shows the current time stamp |
-^ :CURRENT_USER_GROUPS_NAMES ^ This field shows to which groups the current user belongs in quotation marks (",") |
+^ :CURRENT_EMAIL ^ Shows the currently registered e-mail addresses |
-^ :CURRENT_USER_GROUPS_NAME1 ^ This entry mentions the first group to which the logged-in user belongs |
+^ :CURRENT_USER_GROUPS_NAMES ^ This shows to which groups the current user belongs in quotation marks (",") |
+^ :CURRENT_USER_GROUPS_NAME1 ^ This shows the first group to which the logged-in user belongs |
 ^ :CURRENT_USER_GROUPS_NAME2 ^ This provides information on any second group in which the currently logged in user is a member |
 |  	et cetera...  ||
@@ Line 114: / Line 113: @@
 ==== Approving Predefined Dashboards ====
-{{ en:software:dashboard:widgets_configure.png?600|}}
+{{ en:software:dashboard:widgets_configure.png?600 |}}
 If a dashboard containing all required widgets and settings has been created, this may be distributed to all individuals working together with TIM. Users of this group can then login to the dashboard and have access to its widgets and widget settings.
 Authorized access can then be granted by selecting the following items in the menu:
 **Dashboards -> Settings -> Dashboards** \\
-Here the configurations of the respective dashboards can be chosen. The user can then select the desired T!M groups (while holding the "Crtl" key) and grant them authorization to the dashboard.
+Here the configurations of the respective dashboards can be chosen. The user can then select the desired TIM groups (while holding the "Crtl" key) and grant them authorization to the dashboard.
-{{en:software:dashboard:widgets_shared_group.png?300|}}
+\\
+{{ en:software:dashboard:widgets_shared_group.png?300 |}}
+----
+==== Uploading Reports ====
+{{ :software:dashboard:dashboard_report_upload.png?500 |}} \\
+If needed, the dashboard can export widgets in a report.  These reports may be sent to specific users/groups in regular intervals. For this, a Word file with a table must be composed. The name of the to-be-exported widgets should be placed in the first cell. \\
+{{:software:dashboard:dashboard_report_layout.png?600|}}
 -----
+==== Configuring Reports ====
+{{ :software:dashboard:dashboard_report_configuration.png?800 |}}
+^ Element  ^ Description  ^
+^1^ Shows the subject of a generated mail. |
+^2^ Shows the content of a generated mail. |
+^3^ Activates or deactivate the report. |
+^4^ Shows the date on which the first report should be sent. |
+^5^ Shows how often the report should be sent, if is it active. |
+^6^ Takes the time from the entry in the Dashboard.properties (see "Generate Automatic Reports"). |
+^7^ Here, the recipients may be chosen from either users or groups. |
+----
+==== Generate Automatic Reports =====
+In order to be able to send the reports automatically, the [[en:software:dashboard:dashboard_installation#installation|dashboard.properties (see Installation)]] must be configured. For this, the following values must be adjusted accordingly.
+ 	^ Name ^ Description ^
+ 	^ timerInterval ^ How often i check should be run to see if a report is necessary |
+ 	^ timerIdentityName ^ [[en:software:tim:log_in|User name]] that creates the corresponding entry in the [[en:software:tim:administration_client#email_queue|EMail_queue]] (i.e. wiki/dashboard) |
+ 	^ timerIdentityPassword ^ The user password |
+ 	^ emailSender ^ Here, the engine with which the mails should be sent can be entered. This is "tim" in almost every case. |
+ 	^ morningReportHours ^ Gives the time (in hours) at which the report should be sent in the morning (the server time is used as a basis).  A value of 10 means 10:00 o'clock |
+ 	^ eveningReportHours ^ Gives the time (in hours) at which the report should be sent in the evening (the server time is used as a basis). |

TIM Wiki / NEW TIM 6 Documentation

User Tools

Site Tools

Differences

Page Tools