WebApps:Tiles
System requirements
The requirements can be found here.
The automatic refresh by changes on the tiles is supported from Windows 8 or Windows Server 2012.
Dimension "NavigationTiles" has to exist in the model. The tiles are built based on this dimension. These columns have to exist at least:
| Title | Text (any length) | Display text |
| Icon | Text (any length) | Path to the displayed picture starting from the server directory |
| Style | Integer - standard value 0 | Representation of the entry. Currently these options are implemented:
0 = small tile 1 = big tile |
| NavigationAction | Text (any length; a mximum number of 4000 is recommended) | CopLink for navigation. Information for creating this link can be find in the section "Creation of a NavigationLink (NavigationAction)". |
| OpenIcon | Text (any length) | Path to the displayed image starting from the server directory. This icon will be shown if the state has value 1. |
| ReadyIcon | Text (any length) | Path to the displayed image starting from the server directory. This icon will be shown if the state has value 2. |
| ErrorIcon | Text (any length) | Path to the displayed image starting from the server directory. This icon will be shown if the state has value 3. |
| Color | Text (any length) | Background color. Can be defined as Hex-Value (just type) or as RGB value (Input: rgb(153,180,209)). |
| OpenColor | Text (any length) | Background color. Can be defined as Hex-Value (just type) or as RGB value (Input: rgb(153,180,209)). This background color will be used if the state has value 1. |
| ReadyColor | Text (any length) | Background color. Can be defined as Hex-Value (just type) or as RGB value (Input: rgb(153,180,209)). This background color will be used if the state has value 2. |
| ErrorColor | Text (any length) | Background color. Can be defined as Hex-Value (just type) or as RGB value (Input: rgb(153,180,209)). This background color will be used if the state has value 3. |
| TextColor | Text (any length) | Font color. Can be defined as Hex-Value (just type) or as RGB value (Input: rgb(153,180,209)). |
| IsEnabled | Text (any length) | Defines if specified action can be executed. True/False or an expression which returns True/False can be set here.
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True) |
| IsVisible | Text (any length) | Defines if the element will be shown. True/False or an expression which returns True/False can be set here.
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True) |
| State | Text (any length) starting from 9.5 HF 1.9 (before it has been Integer) | Via state the background color and the picture can be defined.
0 = no state 1 = open 2 = done/finished 3 = faulty All other values as well as no given query will be interpreted as "no state". |
Representation
If the structure for the section Enterprise will be displayed, this will be displayed
Dimension elements oflevel 1 will not be displayed.
Dimension elements of level 2 represent display views which call the tiles.
Dimension elements of level 3 represent groups (see model, planing, consolidation, ...)
Dimension elements of level 4 represent simple tiles which can evaluate a navaction or include a submenu.
Dimension elements of level 5 represent submenus which are opened via the superior element. These elements can evaluate a navaction or include a submenu.
Dimension elements of level 6 represent another level of submenus which are opened via the superior element.
Dimension elements of further level will not be considered.
Groups
Groups are defined by level 3 of the dimension "NavigationTiles" and define a collection of menu entries. The group itself can not evaluate actions. These properties will be evaluated on groups:
| Title | Display text. If not defined name of dimension element will be used. |
| Icon | Path to the displayed image starting from the server directory |
| Style | Currently not implemented |
| NavigationAction | Currently not implemented |
| OpenIcon | Currently not implemented |
| ReadyIcon | Currently not implemented |
| ErrorIcon | Currently not implemented |
| Color | Currently not implemented |
| OpenColor | Currently not implemented |
| ReadyColor | Currently not implemented |
| ErrorColor | Currently not implemented |
| TextColor | Font color |
| IsEnabled | Defines if the specified action can be executed. True/False or an expression which returns True/False can be set here.
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True) |
| IsVisible | Defines if the element will be shown. True/False or an expression which returns True/False can be set here.
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True) |
| State | Currently not implemented |
Tiles
Tiles are elements of level 4 from the "NavigationTiles" dimension. An action can be executed on tiles. These properties will be evaluated:
| Title | Display text. If not specified name of dimension element will be used. |
| Icon | Path to the displayed image starting from the server directory |
| Style | Representation of entry. Currently these options are implemented:
0 = small tile 1 = big tile |
| NavigationAction | CopLink for the navigation. Information to create this link can be found in the section "Creation of navigation links (NavigationAction)". |
| OpenIcon | Path to the displayed image starting from the server directory. Will be shown if the state has value 1. |
| ReadyIcon | Path to the displayed image starting from the server directory. Will be shown if the state has value 2. |
| ErrorIcon | Path to the displayed image starting from the server directory. Will be shown if the state has value 3. |
| Color | Background color if no valid state or state 0 |
| OpenColor | Background color if state = 1 |
| ReadyColor | Background color if state = 2 |
| ErrorColor | Background color if state = 3 |
| TextColor | Font color |
| IsEnabled | Defines if the specified action can be executed. True/False or an expression which returns True/False can be set here.
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True) |
| IsVisible | Defines if the element will be shown. True/False or an expression which returns True/False can be set here.
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True) |
| State | Via the state the background color and the image can be controlled.
0 = no state 1 = open 2 = done/finished 3 = faulty All other values as well as no given query will be interpreted as "no state". |
All entries which are located below level 5. These properties will be evaluated:
| Title | Display text. If not defined name of dimension element will be used. |
| Icon | Path to the displayed image starting from the server directory |
| Style | Currently not implemented |
| NavigationAction | CopLink for the navigation. Information to create this link can be found in the section "Creation of a NavigationLink (NavigationAction)". |
| OpenIcon | Currently not implemented |
| ReadyIcon | Currently not implemented |
| ErrorIcon | Currently not implemented |
| Color | Currently not implemented |
| OpenColor | Currently not implemented |
| ReadyColor | Currently not implemented |
| ErrorColor | Currently not implemented |
| TextColor | Currently not implemented |
| IsEnabled | Defines if the specified action can be executed. True/False or an expression which returns True/False can be set here.
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True) |
| IsVisible | Defines if the element will be shown. True/False or an expression which returns True/False can be set here.
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True) |
| Status | Currently not implemented |
Invoking from Web
@Session_WebAppUrl@/Tiles/?menu=<Level 2 from dimension NavigationTiles>
Example:
https://servername:4444/coplanner/Tiles/?menu=reporting
| Hint If used only in Web no CopNav Links can be used. |
Extended Invocation
- SessionID: Gives the possibility to hand an existing session to the tiles. This is used e.g. in the windows client. Therefore the user don't have to logon on the tiles.
Available from 9.5 HF 2.4:
- hideSessionHeader: Defines if session header will be shown or not (true suppresses Session-Header). Default while opening is false.
Example:
https://servername:4444/coplanner/Tiles/?menu=reporting&hideSessionHeader=true
Updating
If changes in the dimension NavigationTiles occur the user view will be updated immediately. Expressions, for example on state, will only be evaluated if there has been an update in the dimension NavigationTiles directly or the view has been actualized. If, for example a state will be set directly via the tile and the user should see this update immediately it is possible to integrate a dummy-import which overwrites the element "no assignment" in the dimension.
If using a WebAppUrl with http(it is recommended to use https) it is possible that this can not be done automatically because a virus scan blocks this action. The solution is to add an exception to the scanner or the tiles will be reloaded after closing and re-opening the dimension or pressing F5.
For instance, with Kaspersky the actualization will be blocked with http. The URL has to be added to the trustful websites.
If you press CTRL + J in a row mask or input mask you will receive a dialog. Choose "complete coplink (sample)" and click on "build..." Choose your desired action which you want to execute and click ok. The link which will be generated in the grey field needs to be edited as follows (to edit the link it needs to be copied in an editor):
- No __PARAM_NOT_FOUND__ must be included- delete these from the link
- replace cop:// with copNav.html?
- Remove spaces before and after ?
| Hint Links which include "(...)" should not be used as they provoke a red cube
e.g.: copNav.html?name=EM Umsatzerloese (a)&aktion=Matrix Builder Eingabemaske&p1=EM Umsatzerloese Plan&p2=&p3=&p4=&frmlocation=Struktur&bild=&info=&styledefinition=&readonly= |
Example:
Original Link:
cop://name=Name der Aktion & aktion=Matrix Builder Eingabemaske & p1=EM Umsatzerloese Plan & p2= & p3= & p4= & frmlocation=Struktur & bild=__PARAM_NOT_FOUND__ & info=__PARAM_NOT_FOUND__ & styledefinition= & readonly=__PARAM_NOT_FOUND__
Link, which can be used:
copNav.html?name=Name der Aktion&aktion=Matrix Builder Eingabemaske&p1=EM Umsatzerloese Plan&p2=&p3=&p4=&frmlocation=Struktur&bild=&info=&styledefinition=&readonly=
| Hint Invocations which include a / , for instance PC/KST, the / needs to be replaced with %slash%.
e.g.: copNav.html?name=PC%slash%KST&aktion=Dimension&p1=PC%slash%KST&p2=&p3=&p4=&frmlocation=Struktur&bild=&info=&styledefinition=&readonly= |
To use the tiles in the web, links have to be used which are calling the web components directly.
Invocation of macros
Available from 9.5 HF 3.4
macros:<Macroname>:<Context>
Example for an invocation without context handover:
macro:mkr_Transfer_Umsatzerloese_IST_PLAN
Example for an invocation with context handover:
macro:mkr_Transfer_Umsatzerloese_IST_PLAN:"Zeit" eq "2015010101" and "Unternehmen" eq "631835758818687263" and "Produkte" mu "633951975478981696" and "PC/KST" mu "1" and "Regionen/Kunden" mu "1" and "Umsatzerloesarten" eq "1"
Invocation of imports
Available from 9.5 HF 3.4
import:<Importname>:<Context>
Example for an invocation without context handover:
import:Transfer_Umsatzerloese_IST_PLAN
Example for an invocation with context handover:
import:Transfer_Umsatzerloese_IST_PLAN:"Zeit" eq "2015010101" and "Unternehmen" eq "631835758818687263" and "Produkte" mu "633951975478981696" and "PC/KST" mu "1" and "Regionen/Kunden" mu "1" and "Umsatzerloesarten" eq "1"
Invocation of input masks
@Session_WebAppUrl@\pivottable\?pivotform=<Maskenname>&SessionID=@Session_ID@
Additional invocation parameters and information regarding input masks can be found here.
Invocation of row views
@Session_WebAppUrl@\pivottable\?tableform=<Maskenname>&SessionID=@Session_ID@
Additional invocation parameters and information regarding row views can be found here.
Invocation of dimensions
@Session_WebAppUrl@\dimensioneditor\?name=<Dimensionsname>&SessionID=@Session_ID@
Additional information to the dimension maintenance can be found here.
Invocation of scenario manager
@Session_WebAppUrl@\dimensioneditor\?name=Plan&SessionID=@Session_ID@
Additional information to the scenario manager can be found here.
Invocation of application properties
@Session_WebAppUrl@\dimensioneditor\?name=sys_Anwendungseigenschaften&SessionID=@Session_ID@
Additional information to the application properties can be found here.
