Skip to main content
Skip table of contents

Custom Action

The custom action is created with the element <CustomAction/> within <Actions>. With a custom action simple actions without predefined text or predefined icon can be implemented.

In addition to the standard attributes for actions, the element <CustomAction/> can have the following attributes:

Attribute

Description

displayName

Label of the button.

  • Translatable

Possible values: Any string or translation key

externalLink 

Allows the navigation to an external website by defining an external link.

  • Data binding possible

Possible values: String (URL)

Note:

In detail components, the external link can also be provided by a Technical Process. A Technical Process (attribute process) that contains the external link in its response must be linked to the action:

XML
<Ok externalLink="http://www.google.de" />
externalLinkTarget

Defines whether the link (externalLink) is opened within the same tab or a new tab.

Possible values:

  • same: The link is opened within the same tab
  • new: The link is opened in a new tab
validated

Allows validation of the input

Possible values:

  • true: The validation is enabled
    (info) If the validation fails, the button is disabled.
  • false: The validation is not enabled (default)
    (info) If the validation fails, the button will not be disabled.
url

Allows the navigation to an external website by defining an external link.

  • Data Binding

Example

Example action "CustomAction"

XML
<DetailComponent path="Dashboard" displayName="Dashboard" default="true">
	<Actions>
	<CustomAction componentName="CountryList"
    			  displayName="Save custom"
    			  validated="true"
   				  process="/WebApp/Administration/Country/CreateOrUpdateCountry.wrf"/>
	</Actions>
	<FlowLayout>
		…
	</FlowLayout>
</DetailComponent>

The above example creates the custom action Save customer:

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.