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.
|
en:software:dashboard:dashboard_documentation [2015/11/27 16:51] jan.mayer |
en:software:dashboard:dashboard_documentation [2021/07/01 09:52] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ==== Login to the Dashboard ==== | ||
| - | {{ en:software:dashboard:dashborad_login.png?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. | ||
| - | {{ software:dashboard:new_dashboard.jpg?300 |}} | ||
| - | ----- | ||
| - | |||
| - | ==== Adding and creating widgets ==== | ||
| - | {{ 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. | ||
| - | > Please refer to the following [[dashboard_tablestructure|information]] on which type of chart and which structure can be selected to be used in TIM. | ||
| - | |||
| - | The development of widgets requires knowledge of SQL which also conforms to the standards of MySQL syntax. | ||
| - | <code sql SQL examples> | ||
| - | SELECT name, email FROM view_identity where identityType = 'user'; | ||
| - | </code> | ||
| - | In this example, the widget provides an overview of all existing users of the system. Please refer to this [[analyses|page]] to access further illustrative examples. | ||
| - | |||
| - | ----- | ||
| - | |||
| - | ==== How to save a widget ==== | ||
| - | {{ en:software:dashboard:widgets_save_run.png?direct&300|}} | ||
| - | 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 name has to be given to the widget which can freely be chosen. \\ | ||
| - | |||
| - | In this example the widget has the name **All Users** and is selectable via the menu **"Add Widgets"**. | ||
| - | |||
| - | |||
| - | ---- | ||
| - | |||
| - | |||
| - | ==== 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. \\ | ||
| - | {{en:software:dashboard:widgets_layout.png?500| }} | ||
| - | {{en:software:dashboard:widgets_drag_drop.png?500| }} | ||
| - | \\ | ||
| - | |||
| - | ---- | ||
| - | ==== Widget menu ==== | ||
| - | ^ Symbol ^ Function ^ | ||
| - | ^{{ software:dashboard:widgetmenue_diagramm.jpg?30 |}} | This item on the menu renders the widget in a new graphic design | | ||
| - | ^{{ 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 maximizes the widget to the broadest possible width | | ||
| - | ^{{ software:dashboard:widgetmenue_drucken.jpg?30 |}} | This item opens the printer dialog of the local computer | | ||
| - | ^{{ software:dashboard:widgetmenue_konfigurieren.jpg?30 |}} | This option enables the setting of the diagram type or removal and deletion of a widget from the Dashboard | | ||
| - | |||
| - | |||
| - | ----- | ||
| - | |||
| - | ==== 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. | ||
| - | <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. 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. | ||
| - | >> TIP! | ||
| - | > 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:widgets_chart_type.png?600 |}} | ||
| - | |||
| - | ------- | ||
| - | ==== 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: | ||
| - | <code sql> | ||
| - | SELECT name, email FROM view_identity WHERE identityType = :identType | ||
| - | </code> | ||
| - | {{ en:software:dashboard:widgets_variables.png?direct&300|}} | ||
| - | >>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: **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: | ||
| - | *Name - please enter here the name of the variable | ||
| - | *Type - this indicates if the output will consist of letters, numbers or formats representing specific dates | ||
| - | *Providing - this shows if this is a single outcome or a list containing several outcomes | ||
| - | *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 | ||
| - | *Remove - this function will delete the complete variable from the system | ||
| - | {{ en:software:dashboard:widgets_variables_example.png?direct&300|}} | ||
| - | <code sql Variable identType> | ||
| - | select identityType from view_identity group by identityType | ||
| - | </code> | ||
| - | To test this variable it should be executed and then provide **5 results** before saving. \\ | ||
| - | {{ 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: | ||
| - | {{ en:software:dashboard:widgets_variables3.png?direct |}} | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== 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> | ||
| - | |||
| - | {{ 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. | ||
| - | |||
| - | |||
| - | ==== Using global variables ==== | ||
| - | 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 to will be indicated here | | ||
| - | ^ :CURRENT_CLIENT_NAME ^ This gives the name of the client | | ||
| - | ^ :CURRENT_CLIENT_ID ^ This entry provides the current ClientID | | ||
| - | ^ :CURRENT_TIMESTAMP ^ The current timestamp will be shown in this entry | | ||
| - | ^ :CURRENT_USER_GROUPS_NAMES ^ This field renders separatly the group membership of the current user in quotation marks (",") | | ||
| - | ^ :CURRENT_USER_GROUPS_NAME1 ^ This entry mentions the first group to which the logged in user belongs to | | ||
| - | ^ :CURRENT_USER_GROUPS_NAME2 ^ This provides information on any second group to which the currently logged in user belongs to as a memeber | | ||
| - | | et cetera... || | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ==== Approving predefined Dashboards ==== | ||
| - | {{ en:software:dashboard:widgets_configure.png?600|}} | ||
| - | A Dashboard can be approved for groups of individuals working cooperatively together with TIM if a this has been amended by all sorts of different crucial widgets and settings. Users of this group can then login to this Dashboard and have access to the corresponding Dashboard encompassing these widgets and settings. | ||
| - | Authorized access can then be granted by setting the following item in the menu: | ||
| - | **Dashboards -> Settings -> Dashboards** \\ | ||
| - | An opportunity for making an choice is provided in the submenu of the selected Dashboard. By holding the Crtl Key pressed when conducting the selection the desired TIM groups can be jointly assigned the status of approval. | ||
| - | {{en:software:dashboard:widgets_shared_group.png?300|}} | ||
| - | ----- | ||
en/software/dashboard/dashboard_documentation.txt · Last modified: 2021/07/01 09:52 (external edit)
Except where otherwise noted, content on this wiki is licensed under the following license: 2013 T!M Solutions GmbH
