Enterprise Edition:CoPlanner Link: Difference between revisions

From CoPlanner 10
Jump to navigationJump to search
Created page with "Opens a CoPlanner Link Command syntax: <center>cop://name=Name & aktion=Aktion & p1=Parameter 1 & p2=Parameter 2 & p3=Parameter 3 & p4=Parameter 4 & bild=Bild.ico & frmlocatio..."
 
No edit summary
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
Opens a CoPlanner Link
CoPlanner-Links (CoP-Links) are links which refer to other CoPlanner objects.
Command syntax:
 
<center>cop://name=Name & aktion=Aktion & p1=Parameter 1 & p2=Parameter 2 & p3=Parameter 3 & p4=Parameter 4 & bild=Bild.ico & frmlocation=Work & info=information text</center>
==Command syntax==
 
CoP-Links consist of different informtion, that are used for opening the CoPlanner object.
<span {{CoPFormel}}>cop://name=Name & aktion=Aktion & p1=Parameter 1 & p2=Parameter 2 & p3=Parameter 3 & p4=Parameter 4 & bild=Bild.ico & frmlocation=Work & info=information text</span>


Description of the individual parameters:
Description of the individual parameters:
Line 40: Line 43:
|-
|-
| Frmlocation
| Frmlocation
| Starting area in which the window ought to open
| Starting area in which the window ought to open  
Possible values
Possible values
:*Work: The window opens in the client area of the CoPlanner  
:*Work: The window opens in the client area of the CoPlanner  
:*Structure: The window opens in the left side of the page of the CoPlanner Yes
:*Structure: The window opens in the left side of the page of the CoPlanner | Yes
|-
|-
| Info
| Info
| Information text which currently is not yet used.
| Information text which currently is not used yet.
| Yes
| Yes
|-
|-
| System definition
| System definition
| Name of the MaskSkins which is to be used for the depiction of the mask.
| Name of the MaskSkins which is used for the depiction of the mask.
| Yes
| Yes
|}
|}
Line 57: Line 60:
{| {{Bausteindesign1}}
{| {{Bausteindesign1}}
|-
|-
| <span style="color: darkblue;">'''Hint'''</span> &nbsp;As of the cop:// the sequence of the parameters does not play any role.
| <span style="color: darkblue;">'''Hint'''</span> &nbsp;As of the cop:// the sequence of the parameters does not matters.
|}
 
 
== CoPlanner-Links generated automatically==
To create a CoPlanner links that will refer to a particular mask, you can use the available auxiliary dialogue '' Context Link Creator ''.
 
Open this dialog using the key combination '' 'Control' '' + '' 'J' '' from the mask for which you want to generate the link.
 
 
[[Image:EE_CopContextLinkDialog.png|thumb|center|Context Link Creator]]
 
====Context Link Creator====
The context Link Creator includes a help dialog which helps you create CoPlanner links.
 
The following functions are defined in that dialog:
 
{| class="wikitable" width="1050px"
|- {{Tabellentitel}}
| Konfiguration
| Description
|-
|'''Context-Adjustments'''
|All adjustments can be configured through the fields located on the left side [[Enterprise_Edition:Context|context based adjustments]]
|-
|'''Include invisible Filter'''
|If that setting is enabled, non-visible filter in the link will be transferred.
|-
|'''complete link'''
|Completes the CoPlanner link so far that it can be inserted as a link in the mask/the report.
|-
|'''build'''
|By clicking on that button, you can set format settings with which the target mask will be opened
|}
 
{| {{Bausteindesign1}}
|-
| <span style="color: darkblue;">'''Hint'''</span> &nbsp;In order to obtaion a correct link, ''complete coplink'' must be enabled.
|}
|}




Examples:
==Call of CoPlanner links==
CoPlanner links can be accessed from the following objects:
:*from masks
:*from reports
:*from the Rribbon


Opening the products dimension via a Cop link:
=== Call CoP-links of a mask===
To open a mask from a CoPlanner link, you have to insert the desired link in a field of '''data type link'''


<center>cop://name=Produkte & aktion=Dimension & p1=Produkte & p2= & p3= & p4= & bild=Dimension.ico & frmlocation=Work & info= </center>
 
[[Image:EE_Datentyp_Link.png|thumb|center|Datentyp Link]]
 
The link can now be copied from that generator in the mask from which the call should occur.
 
[[Image:EE_CopLink_in_Maske.png|thumb|center|Row view, insert CoP-link]]
 
When you click on that field the respective mask will be opened in CoPlanner.
 
 
 
{| {{Bausteindesign1}}
|-
| <span style="color: darkblue;">'''Hint'''</span> &nbsp;You have the possibility to replace links by a symbol [[Image:LinkIcon.png]]. Therefore the size of the property "Column Width" must be defined between 1 to 49 of the correspondig measure.
|}
 
 
===Call CoP-links of reports===
If you want to open a Cop-link out of a report you have to add "'''http://'''" before the Cop-link in that report, so that it can be interpreted correctly.
 
[[Image:ReportViewer_CopLink.png|thumb|center|Report, insert CoP-link]]
 
 
===Call CoP-link of ribbon===
 
CoPlanner-links can be embedded through [[Framework:Navigation Actions#Link|Navigation designer]] into the ribbon.
 
 
==Call of CoPlanner objects through CoP-link==
 
===Open dimension===
Open the dimensione Products through a Cop link:
 
<span {{CoPFormel}}>cop://name=Produkte & aktion=Dimension & p1=Produkte & p2= & p3= & p4= & bild=Dimension.ico & frmlocation=Work & info=</span>


or (without the optional parameters)
or (without the optional parameters)


<center>cop://name=Produkte & aktion=Dimension & p1=Produkte & p2 = & p3= & p4= </center>
<span {{CoPFormel}}>cop://name=Produkte & aktion=Dimension & p1=Produkte & p2 = & p3= & p4= </span>
===Open table===
Open the [[Framework:Tables|Table]]:
 
<span {{CoPFormel}}>cop://name=Umsatzerlöse_Plan & aktion=Tabelle & p1=Umsatzerloese_Jahr_PLAN & p2=MITDEFINITIONSTARTEN & p3=Umsatzerloese_Jahr_msk_PLAN & p4= & frmlocation=Work</span>
===Open macro===
Open the [[Framework:Macros|macro]] TF39_mkr_Makro with a context through a Cop link:
 
<span {{CoPFormel}}>cop://name=Name der Aktion & aktion=Makro & p1=TF39_mkr_Makro & p2= & p3= & p4=ContextFiltersetting:COPSYSID=636195485368033769=0=FilterText=COPSYS_ID & frmlocation=Struktur & bild=__PARAM_NOT_FOUND__ & info=__PARAM_NOT_FOUND__ & styledefinition=Blau Verlauf.maskskin & readonly=__PARAM_NOT_FOUND__</span>
===Open mask===
Open an input mask out of the CoPlanner [[Enterprise_Edition:Work Area|Work area]]:
 
<span {{CoPFormel}}><a href="CopNav.html?name=Umsatzerloese&amp;aktion=Matrix Builder Eingabemaske&amp;p1=EM&nbsp;Umsatzerloese&nbsp;Plan&amp"><img src="image.png" alt="Navaktion" align="right" /></a></span>


Opening of an Agg mask:
or out of an input field with data type link:


<center>cop://name=Umsatzerloese_AggMaske_PLAN & aktion=AggMaske & p1= Umsatzerloese_AggMaske_PLAN & p2=RunMode & p3= & p4= & frmlocation=Work</center>
<span {{CoPFormel}}>cop://name=Name der Aktion & aktion=Matrix Builder Eingabemaske & p1=EM Umsatzerloese Plan & p2= & p3= & p4=ContextFiltersetting:Plan=635530397493272859=0=FilterPlan=Plan|Unternehmen=631835758818687263=2=FilterDim=Unternehmen|Umsatzerloesarten=1=2=FilterDim=Umsatzerloesarten|Vergleichsplan=635326393947795024=0=FilterPlan=Vergleichsplan|Regionen/Kunden=1=2=FilterDim=Regionen/Kunden|PC/KST=1=2=FilterDim=PC/KST|Zeit=2014010101=2=FilterDim=Zeit|Produkte=633970865437351422=2=FilterDim=Produkte & frmlocation=Struktur & bild=__PARAM_NOT_FOUND__ & info=__PARAM_NOT_FOUND__ & styledefinition=Blau Verlauf.maskskin & readonly=__PARAM_NOT_FOUND__</span>
===Open file administration===
Open the dialog for the [[Enterprise_Edition:File administration|File administration]]


Opening of a table:
<span {{CoPFormel}}>cop://name=Umsatzbereich & aktion=Sonstige & p1=FileUpDownLoad & p2=Data & p3=[COPSYS_ID] & p4= & frmlocation=Work</span>
:name= This description will be shown in the dialog '[[Enterprise_Edition:File administration|File administration]]' as headline
:p2= Base directory at CoPlanner Server directory, the sub directories will be created underneath.
:p3= Sub directory(in that case the unique key of the data set is being used).


<center>cop://name=Umsatzerlöse_Plan & aktion=Tabelle & p1=Umsatzerloese_Jahr_PLAN & p2=MITDEFINITIONSTARTEN & p3=Umsatzerloese_Jahr_msk_PLAN & p4= & frmlocation=Work</center>


Opening of the dialogue [[Enterprise_Edition:File administration|File administration]]
__NOEDITSECTION__


<center>cop://name=Umsatzbereich & aktion=Sonstige & p1=FileUpDownLoad & p2=Data & p3=[COPSYS_ID] & p4= & frmlocation=Work</center>
[[Category:Enterprise_Edition|CoPlanner_Link]]
:name= This caption is shown in the dialogue '[[Enterprise_Edition:File administration|File administration]]'as header
[[de:Enterprise_Edition:CoPlanner_Link]]
:p2= Basis direcotry at the CoPlanner server
:p3= Sub directories

Latest revision as of 10:15, 25 January 2017

CoPlanner-Links (CoP-Links) are links which refer to other CoPlanner objects.

Command syntax

CoP-Links consist of different informtion, that are used for opening the CoPlanner object. cop://name=Name & aktion=Aktion & p1=Parameter 1 & p2=Parameter 2 & p3=Parameter 3 & p4=Parameter 4 & bild=Bild.ico & frmlocation=Work & info=information text

Description of the individual parameters:

Parameter Description Optional
Name The name which is displayed in the tool window No
Action The name of the action to be carried out No
Parameter 1 The first of four string parameters for a more detailed command instruction No
Parameter 2 The second of four string parameters for a more detailed command instruction No
Parameter 3 The third of four string parameters for a more detailed command instruction No
Parameter 4 The fourth of four string parameters for a more detailed command instruction No
Image The name of an icon to be used, incl. extension Yes
Frmlocation Starting area in which the window ought to open

Possible values

  • Work: The window opens in the client area of the CoPlanner
  • Structure: The window opens in the left side of the page of the CoPlanner | Yes
Info Information text which currently is not used yet. Yes
System definition Name of the MaskSkins which is used for the depiction of the mask. Yes


Hint  As of the cop:// the sequence of the parameters does not matters.


CoPlanner-Links generated automatically

To create a CoPlanner links that will refer to a particular mask, you can use the available auxiliary dialogue Context Link Creator .

Open this dialog using the key combination 'Control' + 'J' from the mask for which you want to generate the link.


File:EE CopContextLinkDialog.png
Context Link Creator

Context Link Creator

The context Link Creator includes a help dialog which helps you create CoPlanner links.

The following functions are defined in that dialog:

Konfiguration Description
Context-Adjustments All adjustments can be configured through the fields located on the left side context based adjustments
Include invisible Filter If that setting is enabled, non-visible filter in the link will be transferred.
complete link Completes the CoPlanner link so far that it can be inserted as a link in the mask/the report.
build By clicking on that button, you can set format settings with which the target mask will be opened
Hint  In order to obtaion a correct link, complete coplink must be enabled.


Call of CoPlanner links

CoPlanner links can be accessed from the following objects:

  • from masks
  • from reports
  • from the Rribbon

Call CoP-links of a mask

To open a mask from a CoPlanner link, you have to insert the desired link in a field of data type link


File:EE Datentyp Link.png
Datentyp Link

The link can now be copied from that generator in the mask from which the call should occur.

File:EE CopLink in Maske.png
Row view, insert CoP-link

When you click on that field the respective mask will be opened in CoPlanner.


Hint  You have the possibility to replace links by a symbol File:LinkIcon.png. Therefore the size of the property "Column Width" must be defined between 1 to 49 of the correspondig measure.


Call CoP-links of reports

If you want to open a Cop-link out of a report you have to add "http://" before the Cop-link in that report, so that it can be interpreted correctly.

File:ReportViewer CopLink.png
Report, insert CoP-link


Call CoP-link of ribbon

CoPlanner-links can be embedded through Navigation designer into the ribbon.


Call of CoPlanner objects through CoP-link

Open dimension

Open the dimensione Products through a Cop link:

cop://name=Produkte & aktion=Dimension & p1=Produkte & p2= & p3= & p4= & bild=Dimension.ico & frmlocation=Work & info=

or (without the optional parameters)

cop://name=Produkte & aktion=Dimension & p1=Produkte & p2 = & p3= & p4=

Open table

Open the Table:

cop://name=Umsatzerlöse_Plan & aktion=Tabelle & p1=Umsatzerloese_Jahr_PLAN & p2=MITDEFINITIONSTARTEN & p3=Umsatzerloese_Jahr_msk_PLAN & p4= & frmlocation=Work

Open macro

Open the macro TF39_mkr_Makro with a context through a Cop link:

cop://name=Name der Aktion & aktion=Makro & p1=TF39_mkr_Makro & p2= & p3= & p4=ContextFiltersetting:COPSYSID=636195485368033769=0=FilterText=COPSYS_ID & frmlocation=Struktur & bild=__PARAM_NOT_FOUND__ & info=__PARAM_NOT_FOUND__ & styledefinition=Blau Verlauf.maskskin & readonly=__PARAM_NOT_FOUND__

Open mask

Open an input mask out of the CoPlanner Work area:

<a href="CopNav.html?name=Umsatzerloese&aktion=Matrix Builder Eingabemaske&p1=EM Umsatzerloese Plan&amp"><img src="image.png" alt="Navaktion" align="right" /></a>

or out of an input field with data type link:

cop://name=Name der Aktion & aktion=Matrix Builder Eingabemaske & p1=EM Umsatzerloese Plan & p2= & p3= & p4=ContextFiltersetting:Plan=635530397493272859=0=FilterPlan=Plan|Unternehmen=631835758818687263=2=FilterDim=Unternehmen|Umsatzerloesarten=1=2=FilterDim=Umsatzerloesarten|Vergleichsplan=635326393947795024=0=FilterPlan=Vergleichsplan|Regionen/Kunden=1=2=FilterDim=Regionen/Kunden|PC/KST=1=2=FilterDim=PC/KST|Zeit=2014010101=2=FilterDim=Zeit|Produkte=633970865437351422=2=FilterDim=Produkte & frmlocation=Struktur & bild=__PARAM_NOT_FOUND__ & info=__PARAM_NOT_FOUND__ & styledefinition=Blau Verlauf.maskskin & readonly=__PARAM_NOT_FOUND__

Open file administration

Open the dialog for the File administration

cop://name=Umsatzbereich & aktion=Sonstige & p1=FileUpDownLoad & p2=Data & p3=[COPSYS_ID] & p4= & frmlocation=Work

name= This description will be shown in the dialog 'File administration' as headline
p2= Base directory at CoPlanner Server directory, the sub directories will be created underneath.
p3= Sub directory(in that case the unique key of the data set is being used).