Friday, February 3, 2017

Message Editor

Purpose
Alliance Message Management includes a form for creating and managing MT, MX, or system messages (APC). The form is referred to as a message editor. The form is also used to edit a template for MT, APC, or MX messages.
The editor used to send and receive FileAct messages differs slightly from the message editor for MT, MX, and APC. For more information about working with FileAct messages, see FileAct Details (Send) Window or FileAct Details (Get) Window.
Note:
The Receiver field for FIN messages and ResponderDn field for MX messages is validated for RMA immediately after it is modified. This on the fly validation allows the field to be immediately highlighted as an error if the RMA validation is not successful.
Message management actions
The management actions that you can perform on a message are controlled through the permissions in your operator profile, and also on the current status of the message in the message lifecycle.
Management actions include:
  • Create a message
  • Validate a message
  • Modify a message
  • Complete a message (that is, specify that a message instance is at the end of its life cycle)
  • Send message to a queue (dispose or route)
  • Verify and approve a message
  • Repair a damaged message



Example of the message editor
The following is an example of a message displayed in the Message Editor:
 

Legend
Item
Explanation
More information
1
The name of message.
Click the name to display the help about the message from the Message Standards.
2
The tabs display the message and information about the message.

3
The Generate button creates a reference for the related field.

4
A repetition add button to include a sequence in a message. Each time you click the add button, the repetition is automatically expanded.
Some messages can have several sequences and subsequences. Within a sequence, some fields are mandatory and some are optional.
5
A repetition remove button to remove a sequence and the values from the fields in the sequence.

6
The expand arrow works when there is something to expand:
  • for a mandatory field
  • an optional field where the checkbox is selected (you want the field to be present in the message)
  • a sequence with a repetition with at least one count

7
A picker to help you enter data in a field.
8
A checkbox to expand an optional field.

9
The value of a field in a message.
Mandatory fields are denoted by a blue colour by default. Fields with invalid values appear in a different colour.
10
The field name and a detailed description of the field name.
11
Buttons that provide access to actions that you can perform on the message.
The buttons that are available depend on the permission in the operator profile that is assigned to you.
Tabs
The message editor displays the information in a message in the following tabs.
For more information about these tabs, see General Message Structure.
  • Header
  • Application Header (for MX messages only)
  • Body
  • Comments
The Validation Report tab appears in the message editor to provide errors and warnings about an action that an operator performed.
If Alliance Message Management detects errors during the various stages of message preparation, then the Validation report outlines the following information:
  • the location of the problem detected (for example, in the header or the body of the message)
  • a description of the error or the warning
Tip:
Orange is the default colour for error messages. For information about how to change the error colour, see Change the Preferences.
Format of values in fields
The values that you enter in a field for a FIN or an MX message must be syntactically correct and compliant with the message standards that are installed.
Some pages show the following icons to the right of a field:
Icon
Purpose
Display the format of a field.
Click the icon to display the expected syntax of the field. For more information about how to interpret the format descriptions, see Help for a FIN Message.
Open a picker to help you enter a value in a field.
For more information about the types of pickers available, and how to use them, see User Assistance.
Where relevant, you can use the drop-down lists to select values for the fields in a message, or type the value directly in the field.
For text fields, the following information is shown:
  • Number of characters already entered in the line on which the cursor is currently positioned
  • Maximum number of characters allowed for the line in which the cursor is currently positioned
If the text field accepts multiple lines of input, then the following information is shown:
  • Number of lines already entered
  • Maximum number of lines allowed in that field
Different types of drop-down lists
Some fields use a drop-down list from which the operator selects a value from the list only. Alliance Access also uses drop-down list that enable an operator to input a specific value that is different from the values that are defined in the message standards schema. This feature is useful to handle intermediate changes in the message standards because you can use new keywords in this way. You can recognise the different types of drop-down lists by the background colour of the field and the background colour of the arrow.
This table shows the different types of drop-down lists, and explains how to recognise when you can type a value that is not in the list:
Usage
Description
Mandatory field icon
Not a mandatory field icon
Select a value from the list only
The drop-down arrow is grey and the background colour of the arrow is different from the colour of the field.

Type a value that is specific for your institution, or select a value from the list.
If you type a value that is not in the list, then Alliance Access does not check that the value is valid. However, a warning appears in the Validation Report tab.
The background colour of the arrow is the same as the colour of the field.








No comments:

Post a Comment