WebApps:Tiles: Difference between revisions

From CoPlanner 10
Jump to navigationJump to search
← Older edit
VisualWikitext
No edit summary
No edit summary
 
(15 intermediate revisions by the same user not shown)
Line 3: Line 3:
=System requirements=
=System requirements=


==Supported Browsers==
The requirements can be found [[WebApps:Requirements|here]].
* Internet Explorer 11 or higher
* Edge
* Firefox
* Chrome


The automatic refresh by changes on the tiles is supported from Windows 8 or Windows Server 2012.


==Dimension NavigationTiles==
==Dimension NavigationTiles==


Im Modell muss die Dimension „NavigationTiles“ vorhanden sein. Auf Basis dieser Dimension werden die Kacheln aufgebaut. Dabei müssen folgende Spalten mindestens vorhanden sein:
Dimension "NavigationTiles" has to exist in the model. The tiles are built based on this dimension. These columns have to exist at least:
Dimension "NavigationTiles" has to exist in the model. Based on this dimension the tiles are built. These columns have to exist at least:


{| class="wikitable" width={{{breite|70%}}}
{| class="wikitable" width={{{breite|70%}}}
Line 23: Line 19:
|Icon
|Icon
|Text (any length)
|Text (any length)
|Liefert den Pfad zum anzuzeigenden Bild ausgehend vom Serververzeichnis
|Path to the displayed picture starting from the server directory
|Path to the displayed picture starting vom the server directory
|-
|-
|Style
|Style
|Integer - standard value 0
|Integer - standard value 0
|Liefert die Darstellung des Eintrages. Derzeit sind folgende Möglichkeiten implementiert:
|Representation of the entry. Currently these options are implemented:
|Representation of the entry. Currently these options are implemented:


Line 37: Line 31:
|NavigationAction
|NavigationAction
|Text (any length; a mximum number of 4000 is recommended)
|Text (any length; a mximum number of 4000 is recommended)
|Liefert den CopLink für die Navigation. Informationen zum Erstellen dieses Links finden Sie im Abschnitt "Erstellen der Navigationslinks (NavigationAction)".
|CopLink for navigation. Information for creating this link can be find in the section "Creation of a NavigationLink  (NavigationAction)".
|CopLink for navigation. Information for creating this link can be find in the section "Creation of a navigation link (NavigationAction)".
|-
|-
|OpenIcon
|OpenIcon
|Text (any length)
|Text (any length)
|Liefert den Pfad zum anzuzeigenden Bild ausgehend vom Serververzeichnis. Dieses Icon wird angezeigt, wenn der Status 1 ist.
|Path to the displayed image starting from the server directory. This icon will be shown if the state has value 1.
|Path to the displayed image starting from the server directory. This icon will be shown if the state has value 1.
|-
|-
|ReadyIcon
|ReadyIcon
|Text (any length)
|Text (any length)
|Liefert den Pfad zum anzuzeigenden Bild ausgehend vom Serververzeichnis. Dieses Icon wird angezeigt, wenn der Status 2 ist.
|Path to the displayed image starting from the server directory. This icon will be shown if the state has value 2.
|Path to the displayed image starting from the server directory. This icon will be shown if the state has value 2.
|-
|-
|ErrorIcon
|ErrorIcon
|Text (any length)
|Text (any length)
|Liefert den Pfad zum anzuzeigenden Bild ausgehend vom Serververzeichnis. Dieses Icon wird angezeigt, wenn der Status 3 ist.
|Path to the displayed image starting from the server directory. This icon will be shown if the state has value 3.
|Path to the displayed image starting from the server directory. This icon will be shown if the state has value 3.
|-
|-
|Color
|Color
|Text (any length)
|Text (any length)
|Hintergrundfarbe. Kann angegeben werden als Hex-Wert (einfach eingeben) oder als RGB Wert (Eingabe: rgb(153,180,209)).
|Background color. Can be defined as Hex-Value (just type) or as RGB value (Input: rgb(153,180,209)).
|Background color. Can be defined as Hex-Value (just type) or as RGB value (Input: rgb(153,180,209)).
|-
|-
|OpenColor
|OpenColor
|Text (any length)
|Text (any length)
|Hintergrundfarbe. Kann angegeben werden als Hex-Wert (einfach eingeben) oder als RGB Wert (Eingabe: rgb(153,180,209)). Diese Hintergrundfarbe wird verwendet, wenn der Status 1 ist.
|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.
|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
|ReadyColor
|Text (any length)
|Text (any length)
|Hintergrundfarbe. Kann angegeben werden als Hex-Wert (einfach eingeben) oder als RGB Wert (Eingabe: rgb(153,180,209)). Diese Hintergrundfarbe wird verwendet, wenn der Status 2 ist.
|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.
|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
|ErrorColor
|Text (any length)
|Text (any length)
|Hintergrundfarbe. Kann angegeben werden als Hex-Wert (einfach eingeben) oder als RGB Wert (Eingabe: rgb(153,180,209)). Diese Hintergrundfarbe wird verwendet, wenn der Status 3 ist.
|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.
|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
|TextColor
|Text (any length)
|Text (any length)
|Schriftfarbe. Kann angegeben werden als Hex-Wert (einfach eingeben) oder als RGB Wert (Eingabe: rgb(153,180,209)).
|Font color. Can be defined as Hex-Value (just type) or as RGB value (Input: rgb(153,180,209)).
|font color. Can be defined as Hex-Value (just type) or as RGB value (Input: rgb(153,180,209)).
|-
|-
|IsEnabled
|IsEnabled
|Text (any length)
|Text (any length)
|Gibt an, ob die hinterlegte Aktion ausgeführt werden kann. Es kann hier True/False oder eine Expression stehen, die True oder False liefert.
|Defines if specified action can be executed. True/False or an expression which returns True/False can be set here.
|Defines if specified action can be executed. True/False or an expression which returns True/False can be set here.


z.B.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
|-
|-
|IsVisible
|IsVisible
|Text (any length)
|Text (any length)
|Gibt an, ob das Element angezeigt wird. Es kann hier True/False oder eine Expression stehen, die True oder False liefert.
|Defines if the element will be shown. True/False or an expression which returns True/False can be set here.
|Defines if the element will be shown. True/False or an expression which returns True/False can be set here.


z.B.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
|-
|-
|State
|State
|Text (any length) starting from 9.5 HF 1.9 (before it has been Integer)
|Text (any length) starting from 9.5 HF 1.9 (before it has been Integer)
|Über den Status kann die Hintergrundfarbe und das Bild gesteuert werden.
|Via state the background color and the picture can be defined.  
|Via state the background color of the picture can be defined.  


0 = no state
0 = no state
Line 103: Line 85:
1 = open
1 = open


2 = Done/Finished
2 = done/finished


3 = Faulty
3 = faulty


Alle anderen Werte werden als „Kein Status“ interpretiert, wird keine Abfrage definiert, so ist dies ebenfalls der Fall.
All other values as well as no given query will be interpreted as "no state".
All other values as well as no given query will be interpreted as "no state".
|}
|}
Line 119: Line 100:
[[Image:Struktur_NavigationTiles.JPG|thumb|center|Struktur]]
[[Image:Struktur_NavigationTiles.JPG|thumb|center|Struktur]]


Wenn diese Struktur für den Bereich Enterprise dargestellt wird, erhalten Sie folgende Anzeige
If the structure for the section Enterprise will be displayed, this will be displayed
If the structure for the section Enterprise will be displayed, this will be displayed


[[Image:Anzeige_NavigationTiles.PNG|thumb|center|Anzeige]]
[[Image:Anzeige_NavigationTiles.PNG|thumb|center|Anzeige]]


Dimensionselemente der Ebene 1 werden nicht angezeigt.
Dimension elements oflevel 1 will not be displayed.
Dimension elements oflevel 1 will not be displayed.


Dimensionselemente der Ebene 2 entsprechen Anzeigesichten, über welche die Tiles aufgerufen werden.
Dimension elements of level 2 represent display views which call the tiles.
Dimension elements of level 2 represent display views which call the tiles.


Dimensionselemente der Ebene 3 entsprechen den Gruppen (siehe Modell, Planung, Konsolidierung, …)
Dimension elements of level 3 represent groups (see model, planing, consolidation, ...)
Dimension elements of level 3 represent groups (see model, planning, consolidation, ...)


Dimensionselemente der Ebene 4 entsprechen einfachen Kacheln, welche eine Navaktion auswerten können oder ein Submenü enthalten können.
Dimension elements of level 4 represent simple tiles which can evaluate a navaction or include a submenu.
Dimension elements of level 4 represent simple tiles which can evaluate a navaction of include a submenu.


Dimensionselemente der Ebene 5 entsprechen Sub-Menüs, welche über das Übergeordnete Elemente geöffnet werden. Diese können eine Navaktion auswerten oder ein Submenü enthalten.
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 5 represent submenus which are opened via the superior element. These elements can evaluate a navaction or include a submenu.


Dimensionselemente der Ebene 6 entsprechen einer weiteren Ebene von Sub-Menüs, welche über das Übergeordnete Elemente geöffnet werden.
Dimension elements of level 6 represent another level of submenus which are opened via the superior element.  
Dimension elements of level 6 represent another level of submenus which are opened via the superior element.  


Dimensionselemente weiterer Ebenen werden nicht berücksichtigt.
Dimension elements of further level will not be considered.
Dimension elements of further level will not be considered.


Line 148: Line 121:
===Groups===
===Groups===


Gruppen werden durch die Ebene 3 der Dimension „NavigationTiles“ definiert und definieren eine Sammlung von Menüeinträgen. Die Gruppe selbst kann keine Aktionen auswerten. Folgende Eigenschaften werden auf Gruppen ausgewertet:
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:
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:


Line 154: Line 126:
|-
|-
|Title
|Title
|Anzeigetext. Wenn nicht vergeben zieht der Name des Dimensionselements.
|Display text. If not defined name of dimension element will be used.
|Display text. If not defined name of dimension element will be used.
|-
|-
|Icon
|Icon
|Liefert den Pfad zum anzuzeigenden Bild ausgehend vom Serververzeichnis
|Path to the displayed image starting from the server directory
|Path to the displayed image starting from the server directory
|-
|-
|Style
|Style
|Derzeit keine Funktion
|Currently not implemented
|Currently not implemented
|-
|-
|NavigationAction
|NavigationAction
|Derzeit keine Funktion
|Currently not implemented
|Currently not implemented
|-
|-
|OpenIcon
|OpenIcon
|Derzeit keine Funktion
|Currently not implemented
|Currently not implemented
|-
|-
|ReadyIcon
|ReadyIcon
|Derzeit keine Funktion
|Currently not implemented
|Currently not implemented
|-
|-
|ErrorIcon
|ErrorIcon
|Derzeit keine Funktion
|Currently not implemented
|Currently not implemented
|-
|-
|Color
|Color
|Derzeit keine Funktion
|Currently not implemented
|Currently not implemented
|-
|-
|OpenColor
|OpenColor
|Derzeit keine Funktion
|Currently not implemented
|Currently not implemented
|-
|-
|ReadyColor
|ReadyColor
|Derzeit keine Funktion
|Currently not implemented
|Currently not implemented
|-
|-
|ErrorColor
|ErrorColor
|Derzeit keine Funktion
|Currently not implemented
|Currently not implemented
|-
|-
Line 201: Line 162:
|-
|-
|IsEnabled
|IsEnabled
|Gibt an, ob die hinterlegte Aktion ausgeführt werden kann. Es kann hier True/False oder eine Expression stehen, die True oder False liefert.
|Defines if the specified action can be executed. True/False or an expression which returns True/False can be set here.
|Defines if the specified action can be executed. True/False or an expression which returns True/False can be set here.


z.B.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
|-
|-
|IsVisible
|IsVisible
|Gibt an, ob das Element angezeigt wird. Es kann hier True/False oder eine Expression stehen, die True oder False liefert.
|Defines if the element will be shown. True/False or an expression which returns True/False can be set here.
|Defines if the element will be shown. True/False or an expression which returns True/False can be set here.


z.B.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
|-
|-
|State
|State
Line 219: Line 178:
===Tiles===  
===Tiles===  


Kacheln sind Elemente der Ebene 4 aus der Dimension „NavigationTiles“.
Tiles are elements of level 4 from the "NavigationTiles" dimension.
Tiles are elements of level 4 from the "NavigationTiles" dimension.
Auf Kacheln ist es möglich eine Aktion auszuführen. Dabei werden folgende Eigenschaften ausgewertet:
An action can be executed on tiles. These properties will be evaluated:
An action can be executed on tiles. These properties will be evaluated:


Line 227: Line 184:
|-
|-
|Title
|Title
|Anzeigetext. Wenn nicht vergeben zieht der Name des Dimensionselements.
|Display text. If not specified name of dimension element will be used.  
|Display text. If not specified name of dimension element will be used.  
|-
|-
|Icon
|Icon
|Liefert den Pfad zum anzuzeigenden Bild ausgehend vom Serververzeichnis
|Path to the displayed image starting from the server directory
|Path to the displayed image starting from the server directory
|-
|-
|Style
|Style
|Liefert die Darstellung des Eintrages. Derzeit sind folgende Möglichkeiten implementiert:
|Representation of entry. Currently these options are implemented:
|Representation of entry. Currently these options are implemented:


Line 241: Line 195:


1 = big tile
1 = big tile
|-
|-
|NavigationAction
|NavigationAction
|Liefert den CopLink für die Navigation. Informationen zum Erstellen dieses Links finden Sie im Abschnitt "Erstellen der Navigationslinks (NavigationAction)".
|CopLink for the navigation. Information to create this link can be found in the section "Creation of navigation links (NavigationAction)".
|CopLink for the navigation. Information to create this link can be found in the section "Creation of navigation links (NavigationAction)".
|-
|-
|OpenIcon
|OpenIcon
|Liefert den Pfad zum anzuzeigenden Bild ausgehend vom Serververzeichnis. Wird angezeigt, wenn der Status 1 ist.
|Path to the displayed image starting from the server directory. Will be shown if the state has value 1.
|Path to the displayed image starting from the server directory. Will be shown if the state has value 1.
|-
|-
|ReadyIcon
|ReadyIcon
|Liefert den Pfad zum anzuzeigenden Bild ausgehend vom Serververzeichnis. Wird angezeigt, wenn der Status 2 ist.
|Path to the displayed image starting from the server directory. Will be shown if the state has value 2.
|Path to the displayed image starting from the server directory. Will be shown if the state has value 2.
|-
|-
|ErrorIcon
|ErrorIcon
|Liefert den Pfad zum anzuzeigenden Bild ausgehend vom Serververzeichnis. Wird angezeigt, wenn der Status 3 ist.
|Path to the displayed image starting from the server directory. Will be shown if the state has value 3.
|Path to the displayed image starting from the server directory. Will be shown if the state has value 3.
|-
|-
|Color
|Color
|Hintergrundfarbe, wenn kein gültiger Status oder Status 0
|Background color if no valid state or state 0
|Background color if no valid state or state 0
|-
|-
|OpenColor
|OpenColor
|Hintergrundfarbe, wenn Status = 1
|Background color if state = 1
|Background color if state = 1
|-
|-
|ReadyColor
|ReadyColor
|Hintergrundfarbe, wenn Status = 2
|Background color if state = 2
|Background color if state = 2
|-
|-
|ErrorColor
|ErrorColor
|Hintergrundfarbe, wenn Status = 3
|Background color if state = 3
|Background color if state = 3
|-
|-
|TextColor
|TextColor
|Schriftfarbe
|Font color
|Font color
|-
|-
|IsEnabled
|IsEnabled
|Gibt an, ob die hinterlegte Aktion ausgeführt werden kann. Es kann hier True/False oder eine Expression stehen, die True oder False liefert.
|Defines if the specified action can be executed.  True/False or an expression which returns True/False can be set here.
|Defines if the specified action can be executed.  True/False or an expression which returns True/False can be set here.


z.B.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
|-
|-
|IsVisible
|IsVisible
|Gibt an, ob das Element angezeigt wird. Es kann hier True/False oder eine Expression stehen, die True oder False liefert.
|Defines if the element will be shown. True/False or an expression which returns True/False can be set here.
|Defines if the element will be shown. True/False or an expression which returns True/False can be set here.


z.B.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
|-
|-
|State
|State
|Über den Status kann die Hintergrundfarbe und das Bild gesteuert werden.
|Via the state the background color and the image can be controlled.
|Via the state the background color and the image can be controlled.


Line 298: Line 241:
1 = open
1 = open


2 = Done/Finished
2 = done/finished


3 = Faulty
3 = faulty


Alle anderen Werte werden als „Kein Status“ interpretiert, wird keine Abfrage definiert, so ist dies ebenfalls der Fall.
|}
All other values as well as no given query will be interpreted as "no state".
All other values as well as no given query will be interpreted as "no state".
|}
|}
Line 309: Line 250:
===Submenu===  
===Submenu===  


Sind Alle Einträge welche sich unter der Ebene 5 befinden. Dabei werden folgende Eigenschaften ausgewertet:
All entries which are located below level 5. These properties will be evaluated:
All entries which are located below level 5. These properties will be evaluated:


Line 324: Line 264:
|-
|-
|NavigationAction
|NavigationAction
|Liefert den CopLink für die Navigation. Informationen zum Erstellen dieses Links finden Sie im Abschnitt "Erstellen der Navigationslinks (NavigationAction)".
|CopLink for the navigation. Information to create this link can be found in the section "Creation of a NavigationLink (NavigationAction)".
|CopLink for the navigation. Information to create this link can be found in the section "Creation of a navigation link (NavigationAction)".
|-
|-
|OpenIcon
|OpenIcon
Line 354: Line 293:
|Defines if the specified action can be executed.  True/False or an expression which returns True/False can be set here.
|Defines if the specified action can be executed.  True/False or an expression which returns True/False can be set here.


z.B.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
|-
|-
|IsVisible
|IsVisible
|Gibt an, ob das Element angezeigt wird. Es kann hier True/False oder eine Expression stehen, die True oder False liefert.
|Defines if the element will be shown.  True/False or an expression which returns True/False can be set here.
|Defines if the element will be shown.  True/False or an expression which returns True/False can be set here.


z.B.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
e.g.: Transform=FKT_CIF(@Session_Entity_ID@=1,False,True)
|-
|-
|Status
|Status
Line 380: Line 318:


==Extended Invocation==
==Extended Invocation==
Ab 9.5 HF 2.4:
:* 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.
:* hideSessionHeader: Defines if session header will be shown or not (true suppresses Session-Header). Default while opening is false.
Line 389: Line 329:


=Updating=
=Updating=
Wenn in der Dimension NavigationTiles etwas geändert wird, dann wird die Ansicht beim Benutzer gleich angepasst. Expressions bei z.B. dem Status werden nur ausgewertet, wenn es eine Änderung direkt in der NavigationTiles Dimension gab oder die Ansicht aktualisiert wird. Wird z.B. ein Status über eine Kachel gesetzt und der Benutzer soll die Änderung gleich sehen, so kann man als letzten Schritt hier noch einen Dummy-Import einbauen, der z.B. das Element "Keine Zuordnung" in der Dimension überschreibt.
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 changes in the dimension NavigationTiles occur the users 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.
 
Bei Verwendung einer WebAppUrl mit http (es wird empfohlen https zu verwenden) kann es sein, dass dies nicht automatisch gemacht werden kann, weil ein Virenscanner das verhindert. Entweder muss dann im Virenscanner eine Ausnahme gemacht werden, oder die Kacheln werden erst nach drücken von F5 oder erneutem Öffnen der Kacheln neu geladen.


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.  
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.  
Z.B. bei Kaspersky wird die Aktualisierung blockiert mit http. Damit es hier funktioniert muss die URL zu den Vertrauenswürdigen Webadressen hinzugefügt werden.


For instance, with Kaspersky the actualization will be blocked with http. The URL has to be added to the trustful websites.
For instance, with Kaspersky the actualization will be blocked with http. The URL has to be added to the trustful websites.


=Creation of NavigationLink (NavigationAction) - only possible when called from CoPlanner=
=Creation of NavigationLink (NavigationAction) - only possible when called from CoPlanner=
Wenn Sie auf einer Zeilenmaske oder Eingabemaske Strg + J drücken erhalten Sie einen Dialog.
If you press CTRL + J in a row mask or input mask you will receive a dialog.
Wählen Sie "coplete coplink (sample)" an und klicken Sie auf "build..."
Wählen Sie hier die entsprechende Aktion aus, welche Sie ausführen möchten und klicken Sie ok.
Der Link, der dadurch im grauen Feld entsteht muss wie folgt angepasst werden (um den Link anzupassen muss dieser in einen Editor kopiert werden):
* Es dürfen keine __PARAM_NOT_FOUND__ vorkommen - löschen Sie diese einfach aus dem Link
* ersetzen Sie cop:// durch copNav.html?
* Leerzeichen vor und nach den ? entfernen
 
If you press in a row mask or input mask CTRL + J you will receive a dialog.
Choose "complete coplink (sample)" and click on "build..."
Choose "complete coplink (sample)" and click on "build..."
Choose your desired action which you want to execute and click ok.
Choose your desired action which you want to execute and click ok.
Line 417: Line 343:
* replace cop:// with copNav.html?
* replace cop:// with copNav.html?
* Remove spaces before and after ?  
* Remove spaces before and after ?  
{| {{Bausteindesign1}}
|-
| <span style="color: darkblue;">'''Hint'''</span> &nbsp;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=
|}




Line 434: Line 368:
| <span style="color: darkblue;">'''Hint'''</span> &nbsp;Invocations which include a / , for instance PC/KST, the / needs to be replaced with %slash%.
| <span style="color: darkblue;">'''Hint'''</span> &nbsp;Invocations which include a / , for instance PC/KST, the / needs to be replaced with %slash%.


z.B.: copNav.html?name=PC%slash%KST&aktion=Dimension&p1=PC%slash%KST&p2=&p3=&p4=&frmlocation=Struktur&bild=&info=&styledefinition=&readonly=  
e.g.: copNav.html?name=PC%slash%KST&aktion=Dimension&p1=PC%slash%KST&p2=&p3=&p4=&frmlocation=Struktur&bild=&info=&styledefinition=&readonly=  
|}
|}
=Creation of navigation links for invocation in the web=
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 [[WebApps:Input_Mask|here]].
==Invocation of row views==
@Session_WebAppUrl@\pivottable\?tableform=<Maskenname>&SessionID=@Session_ID@
Additional invocation parameters and information regarding row views can be found [[WebApps:Row_View|here]].
==Invocation of dimensions==
@Session_WebAppUrl@\dimensioneditor\?name=<Dimensionsname>&SessionID=@Session_ID@
Additional information to the dimension maintenance can be found [[WebApps:Dimension_Maintenance|here]].
==Invocation of scenario manager==
@Session_WebAppUrl@\dimensioneditor\?name=Plan&SessionID=@Session_ID@
Additional information to the scenario manager can be found [[WebApps:Scenario_Manager|here]].
==Invocation of application properties==
@Session_WebAppUrl@\dimensioneditor\?name=sys_Anwendungseigenschaften&SessionID=@Session_ID@
Additional information to the application properties can be found [[WebApps:Application_Properties|here]].




Line 441: Line 430:


[[Category:WebApps|Tiles]]
[[Category:WebApps|Tiles]]
[[en:WebApps:Tiles]]
[[de:WebApps:Tiles]]

Latest revision as of 17:27, 5 August 2019

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

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

Struktur

If the structure for the section Enterprise will be displayed, this will be displayed

Error creating thumbnail: File missing
Anzeige

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".

Submenu

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.

Creation of NavigationLink (NavigationAction) - only possible when called from CoPlanner

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=

Creation of navigation links for invocation in the web

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.

Retrieved from "https://copsupport.coplanner.com/help10_en/index.php?title=WebApps:Tiles&oldid=16100"