Creating custom MER Facility actions

To create a new custom MER Facility action, you must create a CO of type DnqERCustomAction for each OU that is to use the custom action. To help you do this, FTM SWIFT generates, during customization, a script with a name of the form:

deployment_dir/instance/admin/ou_dnqcecoo.cli

where:

deployment_dir

Directory specified in the CDP initialization file.

instance

Name of the instance.

ou

Name of the OU.

This script contains the following commands:

;add -ct DnqERCustomAction -ou DNIvOU -co <Action> -attr Label            -val <Label>
;add -ct DnqERCustomAction -ou DNIvOU -co <Action> -attr UserAction       -val <UserAction>
;add -ct DnqERCustomAction -ou DNIvOU -co <Action> -attr RoutingType      -val <RoutingType>
;add -ct DnqERCustomAction -ou DNIvOU -co <Action> -attr Validate         -val false
;add -ct DnqERCustomAction -ou DNIvOU -co <Action> -attr UserConfirmation -val false
⋮
com -ou DNIvOU

The customization process substitutes the placeholder DNIvOU in the script with the name of the OU. To modify and run the script for the OU you are going to change:

1. Copy the script for the OU to change into your home directory.
2. Copy the commands once for each custom action that is to be created.
3. Ensure that all commands that are to be executed are activated, that is, that they are not preceded by a semicolon character (;).
4. Replace the following items in the copy of the script as required:

   <Action>

   The name of the CO that is used to define the custom action. Use this value in the ActionList attribute of the queues for which the action is to be available. This name can contain only:

   • Characters of the set [A-Za-z0-9]
   • Periods (.)
   • Hyphens (-)
   • Underscore characters (_)

   As with all CO names, do not choose a name that begins with the letters dn in any combination of uppercase and lowercase characters.

   Label <Label>

   The name of the action as it is to be displayed in the user interface. The labels of standard business actions begin with a capital letter, for example, Submit, Accept, and Reject. A label can contain blanks, for example, Save as Draft.

   UserAction <UserAction>

   The name of the custom action as it is known to the routing flows that use it. The prefix custom: is automatically added to this name to make it easier to distinguish the custom action from a standard action. The full name, with the prefix, is passed to the routing flow, and appears in the message history.

   RoutingType <RoutingType>

   The type of routing that is to handle this custom action:

   B

   Business action routing.

   U

   User action routing.

   Validate

   This attribute specifies whether the message is to be validated before the action is executed. If the CO of type DnqERQueue that corresponds to the queue specifies a ValidateRM attribute, the message is to be regarded as valid only if, in addition to passing the validation check, the RMDS contains an authorisation for that message:

   true

   The action is executed only for a message that is valid.

   false

   The action is executed for a message regardless of whether it is valid. This is the default.

   Specify this attribute only for queues of purpose Create or Edit. It is ignored for other queue purposes. If you need a custom action that requires a valid message on Create or Edit queues but is also available for other queue purposes, create two different custom actions with identical Label, UserAction, and RoutingType attributes:

   • For one action, set Validate to true. Use that action for Create and Edit queues.
   • For the other action, do not specify the Validate attribute. Use that action for other queue purposes.

   UserConfirmation

   This attribute specifies whether the user is to confirm the action after it is selected:

   true

   At least one dialog is displayed that prompts the user to confirm the action before it is executed. This is similar to the dialog that is displayed for the standard Delete action.

   false

   The action is executed immediately after it is selected, unless other circumstances require that a dialog is displayed. This is the default.

5. The file ou_dnqcecoo.cli also contains commands to create MER queues and local addresses. As needed, you can either:
   • Customize these commands as described in Creating new queues and Creating local addresses.
   • Deactivate them by placing a comment symbol (;) at the beginning of each line.
6. Run the modified copy of the ou_dnqcecoo.cli script. This requires the access rights provided by the system configuration administrator (DniSA) role:

   dnicli -i instance -ou SYSOU -s DNI_SYSADM -cft ou_dnqcecoo.cli -cp IBM-1047

7. Approve and deploy the changes:

   dnicli -i instance -ou SYSOU -s DNI_SYSADM
   app -ou ou
   dep -ou ou

If dual authorization is enabled, another user with the appropriate access rights must approve the changes before they can be deployed. If dual authorization is disabled, you can skip approving the changes and immediately deploy them.

After you deploy a new custom action:

• Deploy MER routing message flows for processing the custom action.
• Configure the ActionList attribute of the queues where the action should be available.
• Wait for approximately 5 minutes to allow the MER enterprise application to pick up the configuration change.
• Logout and login again the sessions of all users who are to use the new custom action.