Configuring Perform Action parameters

The perform action dialog renders the dynamic configured parameters for each defined action for an FTM application. Some existing menu actions, such as accept transmission, reject transmission, accept batch, and reject batch, are included on the dialog box.

You can configure the parameters for the actions by using the configuration data setup utility (DSU) spreadsheet for your application. If an action is not defined in that spreadsheet, the action does not require parameters. The configuration is an XML format that you can load by DSU at the time of initial deployment. This new dialog box is available as an action on each unit-of-work page.

Configuring actions for the perform action dialog box

Follow the steps listed to configure actions for the perform action dialog box.
  1. Create an XML configuration for the actions.
  2. Add the XML to the Perform Action Configuration sheet in the DSU configuration workbook for the required application.
  3. Use a DSU import to load the XML into the database for the code to use to render the dialog box.

Configuring XML

The following example shows a sample XML configuration that you can use to configure parameters for the actions.
<?xml version="1.0" encoding="UTF-8"?>
<ActionParameters xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="ActionParameters.xsd">
  <ActionParameter 
     name="Field1"
     type="date" 
     displayOrder="1" 
     required="true"
     regEx="\d{4}-\d{2}-\d{2}"/>
  <Group name="Tab1 name">
    <ActionParameter 
       name="Field2"
       type="decimal" 
       length="18" 
       displayOrder="1" 
       required="true"
       regEx="^[0-9]{1,15}(?:\.[0-9]{1,2})?$"/>
    <ActionParameter 
       name="Field3"
       type="string" 
       length="3" 
       displayOrder="2" 
       required="true"
       default="SEK"
       choices="SEK,DKK"
       regEx="[A-Z]{3,3}"/>
    <ActionParameter 
       name="Field4"
       type="string" 
       length="11" 
       displayOrder="3" 
       required="true"
       regEx="[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}"/>
    <ActionParameter 
       name="Field5"
       type="string" 
       length="30" 
       displayOrder="4" 
       required="true"
       regEx="[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"/>
  </Group>
  <Group name="Tab2">
    <ActionParameter 
       name="Field6"
       type="decimal" 
       length="18" 
       displayOrder="1" 
       required="true"
       regEx="^[0-9]{1,15}(?:\.[0-9]{1,2})?$"/>
    <ActionParameter 
       name="Field7"
       type="string" 
       length="3" 
       displayOrder="2" 
       required="true"
       default="SEK"
       choices="SEK,DKK"
       regEx="[A-Z]{3,3}"/>
    <ActionParameter 
       name="Field8"
       type="string" 
       length="11" 
       displayOrder="3" 
       required="true"
       regEx="[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}"/>
    <ActionParameter 
       name="Field9"
       type="string" 
       length="11" 
       displayOrder="4" 
       required="true"
       regEx="[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}"/>
    <ActionParameter 
       name="Field10"
       type="string" 
       length="30" 
       displayOrder="5" 
       required="true"
       regEx="[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"/>
  </Group>
</ActionParameters>

Action parameter attributes

This table describes the perform action parameter attributes. The key to retrieve the action parameters are the base application name, action name, base status and, base subtype. The base action parameter which is defined in an ActionParameter element that is not associated with the group, is shown on the Perform Action tab of the dialog box. If any action parameters are associated with the group, they are displayed on the separate tab.
Attribute Description
name The unique name of the parameter.
type The type of the field. The valid one is the XML supported type. For example, integer, decimal, string, date, datetime, Boolean, and so on.
length The optional length field. If the type is either date or datetime, the length is not required since the long representation of the time value is used instead.
displayOrder The optional order of display of fields. If the same order is found, then it resorts based on the name.
required The required indicator.
displayName This attribute is used to specify the text that is displayed for this parameter on the perform action dialog box. It is optional and used only when a National Language Support (NLS) key is not defined to return the display text for this parameter.
description This attribute is used to describe the field of the parameter on the perform action dialog box. It is optional and used only when a National Language Support (NLS) key is not defined to return the display text for this parameter.
regEx The optional validation rule to enforce the validity of the value entered by the client. If no regEx is used, the minimum validation based on the length or type is performed.
Group The optional group name to be used to create an extra tab in the dialog, when too many parameters are required for the selected action.