Data Director Implementation Guide

10.3

Back Next

Custom Actions

custom action

is an HTTP request invoked in a pop-up browser window.

Custom actions can be configured for the following IDD application areas:

SubjectArea (action definition is placed inside the SubjectArea definition). These custom actions are added in the subject area's More Actions menu (this menu is available in the Data View and Hierarchy View), and in the context menu shown for nodes in the Hierarchy View.

SubjectArea's Search (action definition is placed inside the SubjectArea's Search definition). These custom actions are added in the search results context menu.

One:Many and Many:Many children (action definition is placed inside the child definition). These custom actions are added in the child table context menu.

Hierarchy View (action definition is placed inside the hmConfiguration definition). These custom actions are added to the More Action menu in the Hierarchy View.

Based on the user roles you cannot configure custom actions.

Custom actions are defined using the externalLinkAction element, which has the following attributes:

Attribute	Description
name	Internally used name of this custom action. This name must be unique across all custom actions.
displayName	Text for menu item created for this custom action. The value specified in the configuration XML is used by default, but it can be overridden in the resource bundle.
callback	Attribute should have the value 'true' for the callback action (see below for a description of callback actions).
windowWidth	Width of modal window displaying the result of a callback action. Default value is 700.
windowHeight	Height of the modal window displaying the result of a callback action. Default value is 600.

The externalLinkAction element must contain an externalLink element that defines the custom action URL.

The externalLink element defined for the externalLinkAction supports the same settings as externalLink defined for the externalLinkChild. For more information, see the description of externalLink provided in "Custom Child Tabs" earlier in this document.

As for the custom child tab's externalLink element, externalLink defined for the externalLinkAction supports dynamic parameters substituted at run time. When the action is executed for several records (for example, the IDD application user selects in the search results several records, and executes an action from the search context menu), and action URL has a dynamic parameter substituted with data from the record's columns. The parameter value is constructed from the values of the columns of all selected records, separated by commas. For example, an action is defined for the Organization Search with the following URL definition:

<externalLink name="org_name_google_search_action_link" type="IFRAME" 
         url="http://www.google.com/search">
      <param name="q" bddParamName="C_PARTY|ORGANIZATION_NAME"/>
      <param name="hl" staticValue="en"/>
   </externalLink>

When the IDD application user selects three organizations in the search results with names 'name1', 'name2', 'name3' and executes the action, the action URL will be the following:

http://www.google.com/search?q=name1,name2,name3&hl=en

User Interface Extensions

Standard Custom Action

Custom Action with Callback

Download Guide

Watch

Comments

Communities

Knowledge Base

Success Portal

0 COMMENTS

We’d like to hear from you! Log in to comment.

Rename Saved Search

Table of Contents

Data Director Implementation Guide

Data Director Implementation Guide

Custom Actions

Custom Actions