Plugin installed incorrectly. Rename plugin directory 'swiftmail.backup' to 'swiftmail'.
en:software:dashboard:dashboard_documentation
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:software:dashboard:dashboard_documentation [2014/12/01 11:29] felix.studnitz |
en:software:dashboard:dashboard_documentation [2021/07/01 09:52] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | FIXME **This page is not fully translated, yet. Please help completing the translation.**\\ //(remove this paragraph once the translation is finished)// | + | ====== Dashboard - Overview ====== |
| + | ==== Dashboard Login ==== | ||
| + | {{ en:software:dashboard:dashborad_login.png?300 |}} | ||
| + | Currently, every user can login to the dashboard with his/her own personal login data. It is possible to individualize the displayed information for the user. A new dashboard can be generated by selecting the item **dashboards** in the menu. | ||
| + | {{ software:dashboard:new_dashboard.jpg?300 |}} | ||
| - | ==== Login to the Dashboard ==== | + | ---- |
| - | {{ en:software:dashboard:loginscreen.jpg?300 |}} | + | |
| - | Currently, every user can login to the Dashboard with his own personal login data. It is possible to arrange your own individualized options regarding displayed information. A new Dashboard including new viewing options can be generated by chosing the item **Dashboards** in the menu. | + | |
| - | {{ en:software:dashboard:new_dashboard.jpg?300 |}} | + | |
| - | + | ||
| - | ----- | + | |
| - | ==== Adding and creating widgets ==== | + | ==== Adding and Creating Widgets ==== |
| - | {{ en:software:dashboard:widget_hinzufuegen.jpg?direct&300|}} | + | {{ en:software:dashboard:add_widgets.png?direct&300|}} |
| - | Every Dashboard can have as many widgets as desired. A widget can entail almost any piece of information and has to be defined by an [[en:software:tim:rights|administrator]]. Adding another widget to the Dashboard is not possible if the logged-in user does not have any necessary administrator rights. But in general, the Dashboard panel can process any piece of available information necessary for analyzing business processes. | + | 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]] on which type of chart and which structure can be selected to be used in T!M - Task !n Motion. | + | > Please refer to the following [[dashboard_tablestructure|information]] for more on the types of charts and structures that can be used in TIM. |
| - | The development of widgets requires knowledge of SQL which also conforms to the standards of MySQL syntax. | + | The development of widgets requires knowledge of SQL, which also conforms to the standards of MySQL syntax. |
| <code sql SQL examples> | <code sql SQL examples> | ||
| SELECT name, email FROM view_identity where identityType = 'user'; | SELECT name, email FROM view_identity where identityType = 'user'; | ||
| </code> | </code> | ||
| - | This widget shows all existing users of the system for example. Please refer to this [[analyses|page]] to access further illustrative examples. | + | 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 ==== | + | ==== How to Save a Widget ==== |
| - | {{ en:software:dashboard:widget_speichern_hinzufuegen.jpg?direct&300|}} | + | {{ en:software:dashboard:widgets_save_run.png?direct&300|}} |
| - | A widget providing the desired content can be saved and then made accessible to other users for their own benefit. To save a widget click on the button "Save a Widget". A name has to be given to the widget which can freely be chosen. \\ | + | A widget providing the desired content can be saved and then eventually made accessible to other users for their own benefit. To save a widget, click on the button "Save a Widget". A user-defined name has to be given to the widget. \\ |
| - | In this example the widget has the name **All Users** and is selectable via the menu **"Add Widgets"**. | + | In this example, the widget is named **All Users** and is selected via the menu **"Add Widgets"**. |
| Line 32: | Line 31: | ||
| ==== Layout and Arrangement ==== | ==== Layout and Arrangement ==== | ||
| - | The arrangement of the widgets can be organised automatically by selecting any desired layout as shown in the preview. The selection of the layout will always have effects on the design of the current Dashboard. In case that a widget is rendered in a wrong position within the Dashboard it can easily be moved on to another tile. It then acquires the exact size and shape in accordance with the predefined layout. \\ | + | The arrangement of the widgets can be performed automatically by selecting the desired layout from the menu, as shown in the preview. The layout selection will always effect the design of the dashboard currently being accessed. If a widget is improperly located within the Dashboard, it can easily be moved onto another tile. The exact size and shape of the widget are then set in accordance with the predefined layout. \\ |
| - | {{en:software:dashboard:layout.jpg?500| }} | + | {{en:software:dashboard:widgets_layout.png?500| }} |
| - | {{en:software:dashboard:widget_drag_and_drop.jpg?500| }} | + | {{en:software:dashboard:widgets_drag_drop.png?500| }} |
| \\ | \\ | ||
| - | |||
| ---- | ---- | ||
| - | ==== Widget menu ==== | + | ==== Widget Menu ==== |
| ^ Symbol ^ Function ^ | ^ Symbol ^ Function ^ | ||
| - | ^{{ en:software:dashboard:widgetmenue_diagramm.jpg?30 |}} | This item on the menu renders the widget in a new graphic design | | + | ^{{ software:dashboard:widgetmenue_diagramm.jpg?30 |}} | This item on the menu allows the widget information to be displayed graphically in a diagram | |
| - | ^{{ en:software:dashboard:widgetmenue_excelexport.jpg?30 |}} | This item on the menu exports the complete content of the widget to a file in Excel-format | | + | ^{{ 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 | |
| - | ^{{ en:software:dashboard:widgetmenue_maximieren.jpg?30 |}} | This item maximizes the widget to broadest possible width | | + | ^{{ software:dashboard:widgetmenue_maximieren.jpg?30 |}} | This item changes the widget size to be displayed with the largest possible width | |
| - | ^{{ en:software:dashboard:widgetmenue_drucken.jpg?30 |}} | This item opens the printer dialog of the local computer | | + | ^{{ software:dashboard:widgetmenue_drucken.jpg?30 |}} | This item opens the printer dialog of the local computer | |
| - | ^{{ en:software:dashboard:widgetmenue_konfigurieren.jpg?30 |}} | This option enables the setting of the diagram type or removal and deletion of the widget from the Dashboard | | + | ^{{ software:dashboard:widgetmenue_konfigurieren.jpg?30 |}} | This option enables the user to set the diagram type, and remove or delete a widget from the Dashboard | |
| - | ----- | + | ---- |
| - | ==== Graphical analysis of widgets==== | + | ==== Graphical Analysis of Widgets==== |
| - | In case that the graphical design of a widget is accepted this can be implemented in an easy and flexible way. For this to be correctly implemented a X and Y axis has to be provided in a useful way. In our example, this is not possible to do due to the fact that an axis cannot be created based only on such entities as "name" and "Email". To make this eentually possible, we have to generate a new widget which is supposed to show how many users had been generated on each weekday. | + | 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> | <code sql> | ||
| select DAYNAME(creationtime) as Tag, count(DAYNAME(creationtime)) as number from view_identity group by DAYNAME(creationtime) | select DAYNAME(creationtime) as Tag, count(DAYNAME(creationtime)) as number from view_identity group by DAYNAME(creationtime) | ||
| </code> | </code> | ||
| - | This can be saved in the usual manner and then added to the Dashboard. After this step, the X and Y axis can be adjusted via the symbol granting access to the diagram function. Via the configuration of the corresponding widget a desired diagram type can be generated. | + | 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> |
| - | > By clicking on the corresponding legend an analysis which has become invalidated due to a crucial value not being in accordance with the norm can be deleted. | + | |
| - | {{ en:software:dashboard:widget_grafische_auswertung.jpg?800 |}} | + | {{ en:software:dashboard:widgets_chart_type.png?600 |}} |
| - | ------- | + | ---- |
| - | ==== Working with variables ==== | + | ==== Working with Variables ==== |
| - | The Dashboard enables access to widgets based on the selection of the value of a particular variable. For example, in the first example not every user should be named by the widget. Rather, this widget is supposed to display entries based on a specified selection of content as predefined by the user. To enable this function the widget has to be changed according to the following way: | + | 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> | <code sql> | ||
| SELECT name, email FROM view_identity WHERE identityType = :identType | SELECT name, email FROM view_identity WHERE identityType = :identType | ||
| </code> | </code> | ||
| - | {{ en:software:dashboard:variablendefinition.jpg?direct&300|}} | + | {{ 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 displayed variables will always be identified by ":Variable name" | + | |
| - | In a second step, the supposed content of the variable has to be defined. To do this the following menu item has to be selected: **Dashboard -> Settings -> Definition of variables** \\ | + | 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** \\ |
| - | By clicking on the button "Add Variable" an input field shows up to enable the definition of the variable. The following fields are available for this: | + | By clicking on the button "Add Variable" an input field enabling the definition of the variable is displayed. The following fields are now available: |
| - | *Name - please enter here the name of the variable | + | *Name - enter here the name of the variable |
| - | *Type - this indicates if the output will consist of letters, numbers or formats representing specific dates | + | *Type - this indicates if the output is formatted as letters, numbers or dates |
| - | *Providing - this shows if this is a single outcome or a list containing several outcomes | + | *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 | *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 | *Remove - this function will delete the complete variable from the system | ||
| - | {{ en:software:dashboard:variablen_beispiel.jpg?direct&300|}} | + | {{ en:software:dashboard:widgets_variables_example.png?direct&300|}} |
| <code sql Variable identType> | <code sql Variable identType> | ||
| select identityType from view_identity group by identityType | select identityType from view_identity group by identityType | ||
| </code> | </code> | ||
| - | To test this variable it should be executed and then provide **5 results** before saving. \\ | + | To test this variable, the user should execute the variables before saving and **5 results** should be returned. \\ |
| - | {{ en:software:dashboard:widget_variable.jpg?direct |}} | + | {{ en:software:dashboard:widgets_variables2.png?direct |}} |
| - | After this the value of the variable can be defined and confirmed within the configuration menu of the widget. The content will be rendered according to the system and the exact settings of the variable. The selection will look as depicted below after the widget has been saved: | + | 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: |
| - | {{ en:software:dashboard:gespeicherteswidget_variable.jpg?direct |}} | + | {{ en:software:dashboard:widgets_variables3.png?direct |}} |
| ---- | ---- | ||
| - | ==== Locking variables ==== | + | ==== Locking Variables ==== |
| - | <note tip> In case that the same widget has to be set for, e.g., several departments a variable can be implemented for which blocks access to the widget. This ensures that from now on the variable cannot be changed by the end user</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:lock_variables.png?300|}} | + | {{ en:software:dashboard:widgets_variables_lock.png?300|}} |
| - | The users cannot change this value if this variable has been locked. In the example of 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 different users have only the authorization to access particular data. | + | 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 ==== | + | ==== 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 ^ Ergebnis ^ | + | ^ Variable ^ Results ^ |
| - | ^ :CURRENT_USER_NAME ^ Gibt den aktuell angemeldeten Benutzer zurück| | + | ^ :CURRENT_USER_NAME ^ This names the current logged-in user| |
| - | ^ :CURRENT_USER_ID ^ Gibt die UserID des aktuell angemeldeten Users zurück | | + | ^ :CURRENT_USER_ID ^ This provides the UserID of the user | |
| - | ^ :CURRENT_USER_DEPARTMENT ^ Gibt die Abteilung des aktuell angemeldeten Users zurück | | + | ^ :CURRENT_USER_DEPARTMENT ^ This shows the department to which the user belongs | |
| - | ^ :CURRENT_CLIENT_NAME ^ Gibt den aktuellen Clientnamen zurück | | + | ^ :CURRENT_CLIENT_NAME ^ This gives the name of the client | |
| - | ^ :CURRENT_CLIENT_ID ^ Gibt die aktuelle ClientID zurück | | + | ^ :CURRENT_CLIENT_ID ^ This provides the current ClientID | |
| - | ^ :CURRENT_TIMESTAMP ^ Gibt einen aktuell Timestamp zurück | | + | ^ :CURRENT_TIMESTAMP ^ This shows the current time stamp | |
| - | ^ :CURRENT_USER_GROUPS_NAMES ^ Gibt alle Gruppen des Benutzer mit "," separiert zurück | | + | ^ :CURRENT_EMAIL ^ Shows the currently registered e-mail addresses | |
| - | ^ :CURRENT_USER_GROUPS_NAMES1 ^ Gibt die erste Gruppe des aktuell angemeldeten Users zurück | | + | ^ :CURRENT_USER_GROUPS_NAMES ^ This shows to which groups the current user belongs in quotation marks (",") | |
| - | ^ :CURRENT_USER_GROUPS_NAMES2 ^ Gibt die zweite Gruppe des aktuell angemeldeten Users zurück | | + | ^ :CURRENT_USER_GROUPS_NAME1 ^ This shows the first group to which the logged-in user belongs | |
| - | | und so weiter... || | + | ^ :CURRENT_USER_GROUPS_NAME2 ^ This provides information on any second group in which the currently logged in user is a member | |
| + | | et cetera... || | ||
| ---- | ---- | ||
| - | ==== Vordefinierte Dashboards freigeben ==== | + | ==== Approving Predefined Dashboards ==== |
| - | {{ :software:dashboard:dashboard_konfiguration.jpg?600|}} | + | {{ en:software:dashboard:widgets_configure.png?600 |}} |
| - | Ist ein Dashboard mit allen nötigen Widgets und Einstellungen versehen, kann dies für T!M - Task !n Motion Gruppen freigegeben werden. Die Benutzer dieser Gruppe können sich danach ins Dashboard einloggen und sehen das entsprechende Dashboard mit den dazugehörigen Widgets und deren Einstellungen. | + | 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. |
| - | Freigaben können unter folgenden Menüpunkt eingerichtet werden: | + | Authorized access can then be granted by selecting the following items in the menu: |
| - | **Dashboards -> Einstellungen -> Dashboards** \\ | + | **Dashboards -> Settings -> Dashboards** \\ |
| - | Hier kann unter Konfiguration des entsprechenden Dashboards gewählt werden. Durch Auswahl der gewünschten T!M-Gruppen (Strg gedrückt halten) kann das Dashboard nun für die gewünschten Gruppen freigegeben werden. | + | 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. |
| - | {{:software:dashboard:auswahl_freigabe.jpg?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). | | ||
en/software/dashboard/dashboard_documentation.1417429765.txt.gz · Last modified: 2021/07/01 09:55 (external edit)
Except where otherwise noted, content on this wiki is licensed under the following license: 2013 T!M Solutions GmbH
