Handler - ExternalLinkParameters
Handler - ExternalLinkParameters
ExternalLinkParameters handler automatically generates a link to a URL denoted in the attribute metadata. The link opens the default browser and accesses the defined URL.
With metadata settings, you can specify ExternalLinkParameters' behaviour further. You can name the link as you wish and define get parameters with variables for the URL to specify, for instance, the default appearance and contents of the browser window. In addition, with Show in edit metadata you get the link visible also when the data card is in the edit mode.
By default, the link is visible only when the data card is opened for viewing.
In the following picture, the link Click here to open the page is generated with ExternalLinkParameters.
Click here to open the page with ExternalLinkParameters handler:
Clicking the link illustrated in the previous example opens a Google search window. In this example, the search key is pre-defined (q=Efecte) and appears in the Google search field by default when accessing the page. The metadata of the example defined is as follows.
ExternalLinkParameters handler metadata:
ExternalLinkParameters handler is typically used for 3rd party integration and for invoking other applications.
The following tables provide information on the attribute settings as well as required and optional metadata configuration for the ExternalLinkParameters handler.
Table 1. Attribute Settings
| Handler name | Datatype |
|---|---|
ExternalLinkParameters |
String |
Table 2. Required Attribute Metadata
| Name | Value | Description |
|---|---|---|
Target URL |
For example: http://www.google.com/search
|
The base URL of the desired application. Please note that the URL must start with Agent UI (2023) will show a warning message to users if not defined |
Caption for link |
For example: Access Google |
Caption for the link in data card view. If the metadata is not defined, the link will not appear on the data card. Note: Agent UI (2023) now shows the link even if the caption is not defined. |
Table 3. Optional Attribute Metadata
| Name | Value | Description |
|---|---|---|
Popup parameters |
For example: resizable=yes,scrollbars=yes,width=700,height=550
|
The parameters for the javascript window.open function. |
No popup window |
true/false |
If set to true no pop-up windows will be opened. This setting has effect in e14 and data card view in e6 ui. When this setting prevents opening of pop-up windows popup parameters aren't used either. This setting can be used when link will be opened by an external tool and a browser window isn't needed. |
name of the parameter |
any string; attribute codes and macros have special functionality |
In the In the If the value is a code of an attribute, the value of data card will be used as the parameter value. If the value is If the value is If the value value is |
Show in edit |
true/false |
This meta data is obsolete in Efecte 14 and doesn't have any effect. Attribute visibility settings can be used to control visibility in edit mode. If set If the metadata is not defined or the value is set |
Target URL replacement |
true/false; default is false
|
If set to For example, you could append an attribute value to the end of the target URL like this: |
Show if has value |
attribute code | If this metadata is configured, the link will not be shown until the referred attribute contains a value. |
Show if has no value |
attribute code | If this metadata is configured, the link will be shown only, if the referred attribute does not contain a value. |
Table of Contents